IInkDisp::Clip メソッド (msinkaut.h)
四角形の外側にある IInkStrokeDisp オブジェクトまたは InkStrokes コレクションの 一部を削除します。
構文
HRESULT Clip(
[in] IInkRectangle *Rectangle
);
パラメーター
[in] Rectangle
ストロークまたはストロークをクリップする外側の四角形を指定します。 四角形は、インク空間座標で指定されます。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
| リターン コード | 説明 |
|---|---|
|
正常終了しました。 |
|
パラメーターに無効なポインターが含まれていました。 |
|
InkDisp オブジェクトは登録されていません。 |
|
クリップの四角形が無効です。 |
|
メソッド内で例外が発生しました。 |
|
未指定のエラーが発生しました。 |
解説
InkDisp オブジェクトの場合、四角形と交差するすべてのストロークが交点で分割されます。 四角形の外側にあるストロークのすべての部分が InkDisp オブジェクトから削除されます。 メソッドは、ストロークが四角形と交差する点で、ストロークに新しいポイントを追加できます。 InkDisp オブジェクトで Clip メソッドを呼び出すと、InkDisp オブジェクトの strokes コレクション内のストロークの ID は一意であることが保証されますが、他の情報を保持する保証はありません。
このメソッドは、クリッピング時にペンの幅を考慮しません。 実際の インク またはストローク データのみをクリップします。
IInkStrokeDisp オブジェクトまたは InkStrokes コレクションの場合、Clip メソッドは親 InkDisp オブジェクトを更新します。 InkDisp オブジェクトからインクが削除されるたびに、その InkDisp オブジェクトに対して定義されている IInkStrokeDisp オブジェクトまたは InkStrokes コレクションが無効になる可能性があります。
インク データの詳細については、「 Ink Data」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP Tablet PC Edition [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | サポートなし |
| 対象プラットフォーム | Windows |
| ヘッダー | msinkaut.h |
| Library | InkObj.dll |