WD97: Sample VB Code to Assign Clipboard Text to String Variable

Last reviewed: February 11, 1998
Article ID: Q158436
The information in this article applies to:

- Microsoft Word 97 for Windows

SUMMARY

This article provides a Microsoft Visual Basic for Applications macro example that uses a custom function, GetClipBoardText(), to retrieve text stored on the Clipboard and assigns the contents to a string variable.

MORE INFORMATION

Microsoft provides examples of Visual Basic for Applications procedures for illustration only, without warranty either expressed or implied, including, but not limited to the implied warranties of merchantability and/or fitness for a particular purpose. The Visual Basic procedures in this article are provided 'as is' and Microsoft does not guarantee that they can be used in all situations. While Microsoft support engineers can help explain the functionality of a particular macro, they will not modify these examples to provide added functionality, nor will they help you construct macros to meet your specific needs. If you have limited programming experience, you may want to consult one of the Microsoft Solution Providers. Solution Providers offer a wide range of fee-based services, including creating custom macros. For more information about Microsoft Solution Providers, call Microsoft Customer Information Service at (800) 426-9400.

The following example uses the custom function, GetClipBoardText(), to retrieve the Clipboard contents.

Function GetClipBoardText()

   Dim MyData As DataObject
   Set MyData = New DataObject
   ' If the clipboard data is text...
   If MyData.GetFormat(1) = True Then
      ' ...get the text from the clipboard...
      MyData.GetFromClipboard
      ' ...and return it to the function.
      GetClipBoardText = MyData.GetText (1)
   End If
End Function

The Clipboard contents, stored in the GetClipBoardText() function, is returned to the variable, MyVar$. The following example shows this routine being called from another function:

Sub MyMainMacro()
  MyVar$ = GetClipBoardText()
End Sub

For information about how to do this in earlier versions of Word, please see the following article(s) in the Microsoft Knowledge Base:

   ARTICLE-ID: Q82111
   TITLE     : WordBasic Macro to Assign Clipboard Text to a String
               Variable


KBCategory: kbmacro
KBSubcategory: kbwordvba kbmacroexample
Additional query words: Word97 8.0 8.0 Word8 vbe vb vba
Keywords : kbwordvba kbmacroexample kbfaq
Version : 97
Platform : WINDOWS


THE INFORMATION PROVIDED IN THE MICROSOFT KNOWLEDGE BASE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL MICROSOFT CORPORATION OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF MICROSOFT CORPORATION OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES SO THE FOREGOING LIMITATION MAY NOT APPLY.

Last reviewed: February 11, 1998
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.