InkClipboardModes Enumeration

  • Article

InkClipboardModes Enumeration

Defines values that specify the copy options of the Clipboard.

Declaration

[C++]

typedef enum InkClipboardModes {
    ICB_Copy = 0,
    ICB_Default = 0,
    ICB_Cut = 1,
    ICB_DelayedCopy = 32,
    ICB_ExtractOnly = 48
} InkClipboardModes;

[Microsoft® Visual Basic® 6.0]

Enum InkClipboardModes
    ICB_Copy = 0
    ICB_Default = 0
    ICB_Cut = 1
    ICB_DelayedCopy = 32
    ICB_ExtractOnly = 48
End Enum

Members

The following tables list the enumeration values.

Name Description
Copy Copies the ink to the Clipboard.
Default Specifies that the Copy mode is used.
Cut Cuts the ink and copies it to the Clipboard.
DelayedCopy Uses delayed rendering to reduce the amount of data that is stored on the Clipboard. The data is rendered when a paste request is made.
ExtractOnly Does not copy the ink to the Clipboard. Typically, use this option if you want to add something else, such as text, to the ink before you copy it to the Clipboard.

Remarks

You can use the DelayedCopy flag to interact directly with the data object and add additional formats to the clipboard.

Caution: To avoid potential memory leaks as a result of using the DelayedCopy flag, you must call the OleFlushClipboard Leave Site or OleSetClipboard Leave Site method. This must be done before the application exits if the last call to the ClipboardCopy method used the DelayedCopy flag.

To remove the pointer from the clipboard, the parameter for the OleSetClipboard should be NULL (Nothing in Visual Basic 6.0). For the SetDataObject method, the data parameter should be NULL, and the copy parameter should be True.

The OleSetClipboard and SetDateObject methods replace the contents of the clipboard.