Share via


InkDisp Class

InkDisp Class

Represents the collected strokes of ink within an ink space.

Members

Enumeration Description
InkBoundingBoxMode Defines values that specify which characteristics of a stroke, such as drawing attributes, are used to calculate the bounding box of the ink.
InkClipboardFormats Defines values that specify the format of ink that is stored on the Clipboard.
InkClipboardModes Defines values that specify the copy options of the Clipboard.
InkExtractFlags Defines values that determine what part of a stroke to remove from an InkDisp object.
CompressionMode Defines values for the compression modes that are used to save the InkDisp object to a serialized format.
InkPersistenceFormat Defines values that specify how ink is persisted.
Event Description
InkAdded Occurs when a stroke is added to the InkDisp object.
InkDeleted Occurs when a stroke is deleted from the InkDisp object.
Method Description
AddStrokesAtRectangle Inserts a stroke collection into the InkDisp object at the specified rectangle.
CanPaste Indicates whether data (either on the Clipboard Leave Site, or as an IDataObject Leave Site) can be converted to an InkDisp object.
Clip Removes portions of a stroke or collection of strokes that are outside a rectangle.
ClipboardCopy Copies InkDisp or InkStrokes to the Clipboard Leave Site.
ClipboardCopyWithRectangle Copies InkStrokes that are contained in the specified rectangle to the Clipboard Leave Site.
ClipboardPaste Pastes an IDataObject Leave Site, either specified or from the Clipboard Leave Site, to this InkDisp object.
Clone Creates a duplicate InkDisp object.
CreateStroke Creates a stroke from points or packet data.
CreateStrokes Creates an InkStrokes collection for this InkDisp object.
DeleteStroke Deletes a stroke from the InkDisp object.
DeleteStrokes Deletes strokes from the InkDisp object.
ExtractStrokes() Extracts strokes from the InkDisp object and returns a new InkDisp object containing the extracted strokes.
ExtractStrokes(Rectangle) Extracts strokes from the InkDisp object within the specified rectangle and returns a new InkDisp object containing the extracted strokes.
GetBoundingBox Retrieves the bounding box of all of the strokes in the InkDisp object.
HitTest(Point, Single) Retrieves the collection of strokes that are either completely inside or intersected by a known circle.
HitTest(Point[], Single) Retrieves the strokes that are contained within a polyline selection area.
HitTest(Rectangle, Single) Retrieves the strokes that are contained within a known rectangle.
Load Populates a new InkDisp object with known binary data.
NearestPoint Retrieves the IInkStrokeDisp within the InkDisp object that is nearest to a known point, optionally providing additional information.
Save Converts the ink to a specified format and returns the binary data.
Property Description
CustomStrokes Gets the IInkCustomStrokes collection to be persisted with the ink.
Dirty Gets or sets the value that indicates whether an InkDisp object has been modified since the last time the ink was saved.
ExtendedProperties Gets the collection of application-defined data.
Strokes Gets the InkStrokes collection contained in the InkDisp object.

Remarks

This object can be instantiated by calling the CoCreateInstance method in C++ or by using the New keyword in Microsoft® Visual Basic® 6.0.

An InkDisp object is a container of stroke (point) data. The stroke data, or the points collected by the pen, are put into an InkDisp object. The Strokes property contains the data for all strokes within the InkDisp object.

The InkCollector object, InkOverlay object, and InkPicture control collects points from the input device and puts them into an InkDisp object. These objects essentially act as the source that distributes ink into one or many different InkDisp objects, which act as containers that hold the distributed ink.

The ink space is a virtual coordinate space to which the coordinates of the tablet context are mapped. This space is fixed to a HIMETRIC coordinate system. In ink space coordinates, a move from 0 to 1 equals 1 HIMETRIC unit. This mapping makes it easy to relate multiple InkDisp objects.

The InkRenderer object manages the mappings between ink and the display window.

COM Implementation

This object implements the IInkDisp COM interface.