Rapid-Q Documentation by William Yu (c)1999-2000 | Appendix A: CLIPBOARD

# CLIPBOARD Component

  This object is global, and need not be created.
  ClipBoard Properties

  Field | Type | R/W | Default

  Format | ARRAY of WORD | RW |
  | Format is a list of all the format the Clipboard contains. There are too may formats to fit on this page, not to mention all the custom formats you may have registered. Check your WinAPI help file for a list.
  FormatCount | INTEGER | R |
  | FormatCount contains the number of formats in the Format array.
  Text | STRING | RW |
  | Text specifies the current contents of the Clipboard as a string.

  ClipBoard Methods

  Method | Type | Description | Params

  Clear | SUB | Clear clipboard | 0
  | Deletes contents of the Clipboard.
  Close | SUB | Free clipboard for other processes | 0
  | Closes the Clipboard if it is open. The Clipboard can be opened multiple times, so the Clipboard will remain opened until it has been closed the same number of times it has been opened.
  GetAsHandle | FUNCTION (Format AS WORD) AS LONG | Returns handle of specified format | 1
  | GetAsHandle returns the data from the Clipboard in a raw Windows handle for the specified format.
  GetAsText | FUNCTION (length%) AS STRING | Returns text of length% | 1
  | GetAsText returns the text contents of the Clipboard. See also Text property.
  HasFormat | FUNCTION (Format AS WORD) AS SHORT | Returns true or false if the format exists or not | 1
  | HasFormat indicates if the Clipboard object contains a particular format. Returns 0 if format is absent, non-zero otherwise if format is present.
  Open | SUB | Begin critcal section | 0
  | Opens the Clipboard and prevents other applications from changing its contents until the Clipboard is closed.
  SetAsHandle | SUB (Format AS WORD, Handle AS LONG) | Set handle and format | 2
  | SetAsHandle places the data in the given format as a Windows handle.
  SetAsText | SUB (Text$) | Set text of clipboard | 1
  | SetAsText sets the text contents of the Clipboard. See also Text property.

  ClipBoard Examples

      ClipBoard.Open
      PRINT ClipBoard.Text
      ClipBoard.Close

  Prev Component | Contents | Next Component