| UID | title | description | helpviewer_keywords | old-location | tech.root | ms.assetid | ms.date | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | req.redist | ms.custom | f1_keywords | dev_langs | topic_type | api_type | api_location | api_name | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:msinkaut.IInkStrokeDisp.Clip |
IInkStrokeDisp::Clip (msinkaut.h) |
Removes portions of an IInkStrokeDisp object or InkStrokes collection that are outside a rectangle. (IInkStrokeDisp.Clip) |
|
tablet\iinkstrokedisp_clip.htm |
tablet |
d3733613-fc8e-41f2-9172-07b61fc133dd |
12/05/2018 |
Clip, Clip method [Tablet PC], Clip method [Tablet PC],IInkStrokeDisp interface, IInkStrokeDisp interface [Tablet PC],Clip method, IInkStrokeDisp.Clip, IInkStrokeDisp::Clip, d3733613-fc8e-41f2-9172-07b61fc133dd, msinkaut/IInkStrokeDisp::Clip, tablet.iinkstrokedisp_clip |
msinkaut.h |
Windows |
Windows XP Tablet PC Edition [desktop apps only] |
None supported |
InkObj.dll |
Windows |
19H1 |
|
|
|
|
|
|
Removes portions of an IInkStrokeDisp object or InkStrokes collection that are outside a rectangle.
Specifies the rectangle outside of which the stroke or strokes are clipped. The rectangle is specified in ink space coordinates.
This method can return one of these values.
| Return code | Description |
|---|---|
|
Success. |
|
A parameter contained an invalid pointer. |
|
The InkDisp object is not registered. |
|
Invalid clip rectangle. |
|
An exception occurred inside the method. |
|
An unspecified error occurred. |
For an InkDisp object, all strokes intersected by the rectangle are split at the intersection points. All portions of strokes outside the rectangle are removed from the InkDisp object. The method may add new points to a stroke at the point where the stroke intersects the rectangle. After you call the Clip method on an InkDisp object, the IDs of the strokes in the InkDisp object's strokes collection are guaranteed to be unique, but not guaranteed to preserve other information.
This method does not take the pen width into account when clipping. It clips only the actual ink or stroke data.
For an IInkStrokeDisp object or InkStrokes collection, the Clip method updates the parent InkDisp object. Whenever ink is removed from an InkDisp object, any IInkStrokeDisp objects or InkStrokes collections defined for that InkDisp object may be invalidated.
For more information on ink data, see Ink Data.