IInkDisp

。 (IInkDisp)

オブジェクトに含まれる、またはオブジェクトの作成に使用されたストロークのコレクションを取得します。 (IInkDisp.get_Strokes)

このストロークのコレクションは、InkDisp オブジェクトに含まれるストロークのコピーである場合と、そのオブジェクトまたはコレクションの作成に使用されたストロークである場合があります。

オブジェクトに格納されている、アプリケーション定義のデータのコレクションを取得します。 (IInkDisp.get_ExtendedProperties)

アプリケーションは ExtendedProperties プロパティを使用して、オブジェクトに格納されているカスタムデータにアクセスできます。このカスタムデータは、オブジェクトとともに自動的にシリアル化されます。

InkDisp Class オブジェクトのストロークが、インクを最後に保存した時点から変更されているかどうかを示す値を取得または設定します。 (Get)

インクが保存されると、dirty フラグは自動的にクリアされ、このプロパティの値は VARIANT_FALSE になります。インクを保存するには、Save Method メソッドを呼び出します。

InkDisp Class オブジェクトのストロークが、インクを最後に保存した時点から変更されているかどうかを示す値を取得または設定します。 (Put)

インクが保存されると、dirty フラグは自動的にクリアされ、このプロパティの値は VARIANT_FALSE になります。インクを保存するには、Save Method メソッドを呼び出します。

インクとともに永続化されるカスタムストロークのコレクションを取得します。

InkDisp オブジェクト内のすべてのストローク、個々のストローク、または InkStrokes コレクションについて、インク空間座標での境界ボックスを取得します。 (IInkDisp.GetBoundingBox)

このメソッドは次のいずれかの値を返します。

境界ボックスがペンの幅の影響を受ける場合、その幅は InkRenderer のビュー変換に合わせて適切にスケーリングされます。これは、ペンの幅にビュー変換の行列式の平方根を掛けることで行われます。

InkDisp オブジェクトの Strokes コレクションから InkStrokes コレクションを削除します。

このメソッドは次のいずれかの値を返します。

InkStrokes コレクションが渡されなかった場合、このメソッドは InkDisp オブジェクト内のすべてのストロークを削除します。一度に 1 つのストロークだけを削除するには、DeleteStroke メソッドを呼び出します。

削除されたストロークが InkDisp オブジェクトのストロークコレクションの末尾に位置していない場合、InkDisp オブジェクトは InkDisp オブジェクト内に残っているストロークのインデックスを振り直します。

InkDisp オブジェクトから IInkStrokeDisp オブジェクトを削除します。

このメソッドは次のいずれかの値を返します。

このメソッドは 1 つのストロークだけを削除します。ストロークのコレクションを削除するには、DeleteStrokes メソッドを呼び出します。

抽出するストロークを、指定されたストロークのコレクションによって決定し、InkDisp Class から切り取りまたはコピーして新しい InkDisp Class に格納するストロークを指定します。

このメソッドは次のいずれかの値を返します。

          <a href="/windows/desktop/tablet/inkdisp-class">InkDisp Class</a> オブジェクトのクラスが登録されていません。

指定した四角形によって抽出するストロークを決定し、既存の InkDisp オブジェクトからストロークを切り取りまたはコピーして、新しい InkDisp オブジェクトに貼り付けます。

このメソッドは次のいずれかの値を返します。

新しい InkDisp オブジェクトは、元の InkDisp オブジェクトの描画属性、プロパティ、および座標を保持します。

このメソッドは、元のオブジェクトから削除または切り取られたストロークを含まない新しい InkDisp オブジェクトを作成する場合に便利です。

指定したストロークのコレクションからストロークを抽出するには、ExtractStrokes Method を呼び出します。

新しい InkDisp オブジェクトには、四角形の内側にあるストロークの部分だけが追加されます。

extractFlags パラメーターが RemoveFromOriginal または Default の場合、四角形と交差するストロークは分割され、四角形の内側の部分は既存の InkDisp オブジェクトから削除されます。

IInkStrokeDisp オブジェクトまたは InkStrokes コレクションのうち、四角形の外側にある部分を削除します。 (IInkDisp.Clip)

このメソッドは次のいずれかの値を返します。

InkDisp オブジェクトの場合、四角形と交差するすべてのストロークは交点で分割されます。四角形の外側にあるストロークの部分はすべて InkDisp オブジェクトから削除されます。このメソッドは、ストロークが四角形と交差する位置に新しい点を追加することがあります。InkDisp オブジェクトに対して Clip メソッドを呼び出した後、InkDisp オブジェクトのストロークコレクション内にあるストロークの ID は一意であることが保証されますが、その他の情報が保持されることは保証されません。

このメソッドは、クリップの際にペンの幅を考慮しません。実際の インク データ (ストロークデータ) のみをクリップします。

IInkStrokeDisp オブジェクトまたは InkStrokes コレクションの場合、Clip メソッドは親の InkDisp オブジェクトを更新します。InkDisp オブジェクトからインクが削除されると、その InkDisp オブジェクトに対して定義されている IInkStrokeDisp オブジェクトや InkStrokes コレクションが無効になる場合があります。

インクデータの詳細については、Ink Data を参照してください。

InkDisp オブジェクトの複製を作成します。

このメソッドは次のいずれかの値を返します。

Clone メソッドは、InkDisp、InkDrawingAttributes、InkRecognizerContext の各オブジェクトに定義されています。Clone メソッドは、元のオブジェクトの完全なコピーを返します。

ほとんどの場合、複製されたオブジェクトは元のオブジェクトの完全なコピーですが、2 つのオブジェクトの間に関連はありません。この例外の詳細については、このトピックの解説セクションを参照してください。

InkDisp オブジェクト: 複製された InkDisp オブジェクトが元のオブジェクトの完全なコピーにならない唯一のケースは、dirty 状態の InkDisp オブジェクトを複製した場合です。この場合、複製された InkDisp オブジェクトの Dirty プロパティは FALSE になります。複製された InkDisp オブジェクトのその他のプロパティはすべて完全なコピーです。

指定した円の内部に完全に含まれるか、その円と交差する InkStrokes コレクションを取得します。

このメソッドは次のいずれかの値を返します。

ストロークが円と交差する場合は、そのストローク全体が返されます。

このメソッドは、ペンの幅全体、ベジエによる平滑化 (存在する場合)、ペン先の形状など、ストロークに適用される描画属性一式を考慮して交差を計算します。

ストロークまたはストロークのコレクションに対して回転またはせん断の変換を行った後は、変換後の x- 座標と y- 座標は元の座標と同心ではなくなります。そのため、radius 引数を x- 座標や y- 座標から計算しないでください。

指定したストロークのどの点がテスト領域と交差するかを判断するには、IInkStrokeDisp オブジェクトの HitTest メソッドを呼び出します。

アプリケーションは、結果として得られるストロークのコレクションを受け取るポインターを常に渡す必要があります。交差がない場合、コレクションの数は 0 になります。

指定した四角形の内部に含まれるストロークを取得します。

このメソッドは次のいずれかの値を返します。

指定したストロークのどの点がテスト領域と交差するかを判断するには、IInkStrokeDisp オブジェクトの GetRectangleIntersections メソッドを呼び出します。このメソッドは、ストロークが指定した四角形と交差する点を取得します。

折れ線で囲まれた選択領域内のストロークを取得します。

このメソッドは次のいずれかの値を返します。

InkDisp オブジェクト内で、指定した点に最も近い IInkStrokeDisp を取得します。必要に応じて、最も近い点のインデックスと、指定した点からストロークまでの距離も返します。

このメソッドは次のいずれかの値を返します。

ストローク線上の位置は 2 つの物理的な座標点の間に来ることがあるため、出力の point パラメーターは浮動小数点数として定義されています。この値を使用して Split メソッドでストロークを分割したり、値を切り上げまたは切り捨ててストローク内のパケットのインデックスとして使用したりできます。

distanceFromPacket パラメーターは、その点からストロークの外形 (エンベロープ) までの距離を表します。これは、2 点間の距離からストロークの幅の半分を引いた値です。

既存の IInkStrokeDisp オブジェクトから新しい InkStrokes コレクションを作成します。

このメソッドは次のいずれかの値を返します。

ids パラメーターが NULL または空の配列の場合、空の InkStrokes コレクションが作成されます。

指定した Strokes コレクションを、指定した四角形の位置でこの InkDisp オブジェクトに追加します。

このメソッドは次のいずれかの値を返します。

挿入時に、ストロークはその境界ボックスから指定した四角形に合わせて拡大縮小されます。

このメソッドは、単一の InkDisp オブジェクト内でストロークをコピーする場合にも使用できます。ソースとなるインクストロークは、別の InkDisp オブジェクトのものである必要はありません。

インクを指定した InkPersistenceFormat に変換し、指定した InkPersistenceCompressionMode を使用して保存して、バイナリデータをバイト配列で返します。

このメソッドは次のいずれかの値を返します。

空の InkDisp オブジェクトを GIF 形式で保存しようとすると、エラーが発生します。

指定したバイナリデータを使用して、新しい InkDisp オブジェクトにデータを設定します。

このメソッドは次のいずれかの値を返します。

インクを読み込めるのは、新しく空の InkDisp オブジェクト (ストロークを一度も収集しておらず、プロパティも関連付けられていないもの) だけです。ストロークを収集済み、またはプロパティが関連付けられている InkDisp オブジェクトにインクを読み込もうとすると、たとえそのストロークやプロパティが InkDisp オブジェクトから削除済みであっても、例外がスローされます。これは、ストローク ID の割り当て方法によるものです。ストロークには一意の ID が割り当てられ、この ID は、そのストロークが Ink オブジェクトから削除された後でも再利用されません。つまり、InkDisp オブジェクトに ID が 1 のストロークが含まれていて、そのストロークを削除した後に別の InkDisp オブジェクトをこの InkDisp オブジェクトに読み込むと、ストローク ID は 2 から始まることになります。これは混乱を招くため、許可されていません。

パケットデータの入力値の配列から IInkStrokeDisp オブジェクトを作成します。

このメソッドは次のいずれかの値を返します。

点の配列に含まれる各点の最小値と最大値は、それぞれ LONG_MIN と LONG_MAX です。ただし、これらの点が定義するインク空間の四角形は、幅または高さの最大値が LONG_MAX を超えることはできません。そのため、x 座標の最小値と最大値の差、および y 座標の最小値と最大値の差は、LONG_MAX を超えることはできません。

指定した四角形の内部に含まれる IInkStrokeDisp オブジェクトをクリップボードにコピーします。

このメソッドは次のいずれかの値を返します。

四角形によってストロークがクリップされる場合、コピーされたデータ内でもそれらのストロークはクリップされます。

InkDisp オブジェクトのプロパティだけをコピーしたい場合は、InkDisp オブジェクトをクリップボードにコピーすると便利なことがあります。InkDisp オブジェクトをクリップボードにコピーするには、strokes パラメーターに NULL を設定して ClipboardCopy メソッドを呼び出します。

また、InkAdded イベントと InkDeleted イベントは、ストロークのインデックスに基づいて生成されます。たとえば、インデックス 0、1、3、5、6 のストロークを削除する場合、2 つのイベントが生成されます。1 つはインデックス 0、1、3 のストローク用、もう 1 つはインデックス 5 と 6 のストローク用です。つまり、連続する組ごとに 1 つのイベントが生成されます。

これは InkAdded イベントにも当てはまります。ストロークコレクション内で新しく追加されたストロークのインデックスは内部アルゴリズムによって決定され、これが上記のような InkAdded イベントの発生のしかたに影響します。

イベントハンドラー内でストロークの数を照会した場合、その結果は、まだイベントが生成されていないストロークも含めて、操作全体で追加されたストロークの総数になります。

InkStrokes コレクションをクリップボードにコピーします。

このメソッドは次のいずれかの値を返します。

このメソッドは、認識結果を含むストロークのすべてのプロパティをコピーします。strokes パラメーターに NULL を設定すると、CustomStrokes プロパティを含む InkDisp オブジェクトがクリップボードにコピーされ、InkDisp オブジェクトの IInkCustomStrokes コレクション内のストロークの認識結果も保持されます。

空の InkStrokes コレクションが渡された場合、このメソッドは NULL を返し、クリップボードの内容は変更されません。

IDataObject を InkDisp オブジェクトに変換できるかどうかを示します。

このメソッドは次のいずれかの値を返します。

指定した IDataObject が NULL の場合は、クリップボード上のデータオブジェクトが使用されます。

クリップボードから IDataObject を InkDisp オブジェクトにコピーします。

このメソッドは次のいずれかの値を返します。

Clipboard へのアクセス中に予期しないエラーが発生した場合は、エラーが返されます。エラーが発生しなくても、クリップボードに インク として貼り付けられる形式 (ink serialized format (ISF) または text ink object (tInk)) が含まれていない場合は、NULL が返され、例外はスローされません。