Share via

InkClipboardFormats Enumeration

  • Article

InkClipboardFormats Enumeration

Defines values that specify the format of ink that is stored on the Clipboard.

Declaration

[C++]

typedef enum InkClipboardFormats {
    ICF_None = 0,
    ICF_InkSerializedFormat = 1,
    ICF_SketchInk = 2,
    ICF_TextInk = 6,
    ICF_PasteMask = 7,
    ICF_EnhancedMetafile = 8,
    ICF_Metafile = 32,
    ICF_Bitmap = 64,
    ICF_CopyMask = 127,
    ICF_Default = 127
} InkClipboardFormatFlags;

[Microsoft® Visual Basic® 6.0]

Enum InkClipboardFormats
    ICF_None = 0
    ICF_InkSerializedFormat = 1
    ICF_SketchInk = 2
    ICF_TextInk = 6
    ICF_PasteMask = 7
    ICF_EnhancedMetafile = 8
    ICF_Metafile = 32
    ICF_Bitmap = 64
    ICF_CopyMask = 127
    ICF_Default = 127
End Enum

Members

The following tables list the enumeration values.

Name Description
None Specifies a flag that can be used to verify whether any formats are present by checking against it.
InkSerializedFormat Specifies that ink is encoded in ink serialized format (ISF). This is the most compact persistent representation of ink. Although it often contains only ink data, Ink Serialized Format (ISF) is extensible. Applications can set custom attributes (identified by a globally unique identifier (GUID)) on an InkDisp object, stroke, or point. This allows an application to store any kind of data or metadata that it requires as an attribute in an ISF stream.
SketchInk Specifies that ink is not expected to form words, but rather is interpreted as a picture. This is also useful for representing multiple words.
TextInk Specifies that ink is expected to form words. It allows the ink to be converted to text. The recognized text is either the alternate with the greatest confidence rating or another alternate chosen from a list. This is useful for representing a single word.
PasteMask Specifies the formats that can be used for pasting, including tInk, sInk, and ISF.
EnhancedMetafile Specifies the enhanced metafile to play to create the background. The metafile must remain valid for as long as it is used to render the ink background.
Metafile Specifies that ink is stored as a metafile or a list of commands that can be played back to draw a graphic.
Bitmap Specifies the bitmap to use as the background. The bitmap device context must remain valid for as long as it is used to render the ink background.
CopyMask Specifies the formats that are copied to the Clipboard through ink.

This is the default value.
Default Specifies that ink is stored as a CopyMask.

Remarks

In C++, explicit casting is required when trying to set more than one flag at a time. A compilation error occurs if explicit casting is not used.