RecognizerContext.Guide プロパティ

2008-10-28

インク入力に使用する RecognizerGuide を取得または設定します。

名前空間 : Microsoft.Ink
アセンブリ : Microsoft.Ink (Microsoft.Ink.dll 内)

構文

'宣言
Public Property Guide As RecognizerGuide
'使用
Dim instance As RecognizerContext
Dim value As RecognizerGuide

value = instance.Guide

instance.Guide = value

public RecognizerGuide Guide { get; set; }

public:
property RecognizerGuide Guide {
    RecognizerGuide get ();
    void set (RecognizerGuide value);
}

/** @property */
public RecognizerGuide get_Guide()
/** @property */
public  void set_Guide(RecognizerGuide value)

public function get Guide () : RecognizerGuide
public function set Guide (value : RecognizerGuide)

プロパティ値

型 : Microsoft.Ink.RecognizerGuide
インク入力に使用する RecognizerGuide。

解説

Guide プロパティの設定が成功するのは、Strokes プロパティが nullnull 参照 (Visual Basic では Nothing) の場合のみです。Guide プロパティを設定してから、Strokes コレクションを RecognizerContext の Strokes プロパティに結び付けるか、Strokes プロパティを nullnull 参照 (Visual Basic では Nothing) に設定してから、Guide プロパティを設定する必要があります。

メモ :
後者の方法を使用する場合は、Strokes コレクションを RecognizerContext の Strokes プロパティに再度結び付ける必要があります。

RecognizerCapabilities 列挙体には FreeInput フラグ、LinedInput フラグ、および BoxedInput フラグが含まれます。これらのフラグは、認識エンジンの機能を示します。ただし、フラグは読み取り専用であるため、これらのフラグを直接 Recognizer オブジェクトまたは RecognizerContext オブジェクトで設定する方法はありません。認識エンジンを特定のモードに設定する唯一の方法は、Guide プロパティを使用して認識ガイドを設定することです。

Guide プロパティを設定しない場合、既定の値は FreeInput モードになります (認識エンジンがこのモードを使用できる場合)。

可能な入力モードと、各モードの Columns プロパティと Rows プロパティに設定する値を次の表に示します。

入力の種類	Rows に設定する値	Columns プロパティに設定する値
自由入力	0	0
1 本の縦線の入力	0	1
n 本の縦線の入力	0	n
1 本の横線の入力	1	0
n 本の横線の入力	n	0
1 個のボックス入力	1	1
n 個のボックス入力	n	1
x 行 z 列のボックスで構成されるグリッドのボックス入力	x	z

モードを Recognizer オブジェクトが使用できない値に設定すると、ArgumentException 例外がスローされます。

特定の認識エンジンから使用できる機能またはモードを照会するには、Recognizer オブジェクトの Capabilities プロパティを使用します。Windows Vista では、ラテンスクリプトの認識エンジンは自由入力、ボックス入力、および横線入力をサポートします。東アジア文字の認識エンジンは自由入力とボックス入力をサポートし、ジェスチャ認識エンジンは自由入力だけをサポートします。

例

この例では、RecognizerContext オブジェクトがインスタンス化され、Guide プロパティが割り当てられます。

' create a new RecognizerContext object
mRecognizerContext = New RecognizerContext()
' if the Recognizer supports LinedInput, set the Guide
If (mRecognizerContext.Recognizer.Capabilities And RecognizerCapabilities.LinedInput) <> 0 Then
    ' get the lower right corner in pixel units
    Dim lowerRight As Point = New Point(mInkOverlay.AttachedControl.Width, mInkOverlay.AttachedControl.Height)
    ' convert to ink space units
    mInkOverlay.Renderer.PixelToInkSpace(Me.CreateGraphics(), lowerRight)
    ' create Rectangles
    Dim writingBox As Rectangle = New Rectangle(0, 0, lowerRight.X, lowerRight.Y)
    Dim drawnBox As Rectangle = New Rectangle(0, 0, lowerRight.X, lowerRight.Y)
    ' shrink drawn box relative to writing box
    drawnBox.Inflate(-100, -100)
    ' create Guide with 8 rows, zero columns, and no midline
    Dim guide As RecognizerGuide = New RecognizerGuide(8, 0, 0, writingBox, drawnBox)
    mRecognizerContext.Guide = guide
End If

// create a new RecognizerContext object
mRecognizerContext = new RecognizerContext();
// if the Recognizer supports LinedInput, set the Guide
if ((mRecognizerContext.Recognizer.Capabilities & RecognizerCapabilities.LinedInput) != 0)
{
    // get the lower right corner in pixel units
    Point lowerRight = new Point(mInkOverlay.AttachedControl.Width, mInkOverlay.AttachedControl.Height);
    // convert to ink space units
    mInkOverlay.Renderer.PixelToInkSpace(this.CreateGraphics(), ref lowerRight);
    // create Rectangles
    Rectangle writingBox = new Rectangle(0, 0, lowerRight.X, lowerRight.Y);
    Rectangle drawnBox = new Rectangle(0, 0, lowerRight.X, lowerRight.Y);
    // shrink drawn box relative to writing box
    drawnBox.Inflate(-100, -100);
    // create Guide with 8 rows, zero columns, and no midline
    RecognizerGuide guide = new RecognizerGuide(8, 0, 0, writingBox, drawnBox);
    mRecognizerContext.Guide = guide;
}