InkAnalyzerBase.AddStroke メソッド (Int32, array<Int32[], array<Guid[], Int32)

2008-10-28

1 つのストロークのストロークデータをインクアナライザに追加し、特定のカルチャ識別子をストロークに割り当てます。

名前空間 : System.Windows.Ink.AnalysisCore
アセンブリ : IACore (IACore.dll 内)

構文

'宣言
Public Function AddStroke ( _
    strokeId As Integer, _
    strokePacketData As Integer(), _
    strokePacketDescription As Guid(), _
    languageId As Integer _
) As ContextNodeBase
'使用
Dim instance As InkAnalyzerBase
Dim strokeId As Integer
Dim strokePacketData As Integer()
Dim strokePacketDescription As Guid()
Dim languageId As Integer
Dim returnValue As ContextNodeBase

returnValue = instance.AddStroke(strokeId, _
    strokePacketData, strokePacketDescription, _
    languageId)

public ContextNodeBase AddStroke(
    int strokeId,
    int[] strokePacketData,
    Guid[] strokePacketDescription,
    int languageId
)

public:
ContextNodeBase^ AddStroke(
    int strokeId, 
    array<int>^ strokePacketData, 
    array<Guid>^ strokePacketDescription, 
    int languageId
)

public ContextNodeBase AddStroke(
    int strokeId,
    int[] strokePacketData,
    Guid[] strokePacketDescription,
    int languageId
)

public function AddStroke(
    strokeId : int, 
    strokePacketData : int[], 
    strokePacketDescription : Guid[], 
    languageId : int
) : ContextNodeBase

パラメータ

strokeId
型 : System.Int32
ストローク識別子。

strokePacketData
型 : array<System.Int32[]
ストロークのパケットデータが含まれる配列。

strokePacketDescription
型 : array<System.Guid[]
パケットプロパティ識別子が含まれる配列。

languageId
型 : System.Int32
ストロークに割り当てるカルチャ識別子。

戻り値

型 : System.Windows.Ink.AnalysisCore.ContextNodeBase
インクアナライザがストロークを追加したコンテキストノード。

解説

InkAnalyzerBase は、Type プロパティ値が UnclassifiedInk() の ContextNodeBase にストロークを追加します。

インクアナライザは、指定されたカルチャ識別子をストロークに割り当てます。次に、同じカルチャ識別子を持つストロークが含まれるインクアナライザのルートノードの下にある、最初の未分類インクノードにストロークを追加します。インクアナライザが、同じカルチャ識別子を持つノードを検出できない場合、そのルートノードの下に新しい ContextNodeBase を作成し、新しい未分類インクノードにストロークを追加します。

strokePacketData には、ストローク内のすべてのポイントのパケットデータが含まれています。strokePacketDescription には、ストローク内の各ポイントに含まれているパケットデータの型を示すグローバル一意識別子 (GUID) が含まれています。使用可能なパケットプロパティの全一覧については、PacketProperty クラスのトピックを参照してください。

このメソッドは、DirtyRegion を、領域の現在の値と追加されたストロークの境界ボックスの結合に拡張します。

InkAnalyzerBase に、同じ識別子を持つストロークが既に含まれている場合、InkAnalyzerBase は例外をスローします。

例

この例では、Stroke をパケットデータに変換し、ストロークを InkAnalyzerBase に追加して、特定のロケール識別子をストロークに割り当てるメソッドを定義します。このメソッドは、インクアナライザがストロークを追加した ContextNodeBase を返します。

''' <summary>
''' Adds a stroke to an InkAnalyzerBase and assigns a specific
''' culture identifier to the stroke.
''' </summary>
''' <param name="baseInkAnalyzer">
''' The analyzer that receives the stroke.</param>
''' <param name="theStroke">The stroke to add.</param>
''' <param name="languageIdentifier">The culture identifier to assign to
''' the stroke.</param>
''' <returns>The node to which the analyzer added the stroke.</returns>
''' <remarks>
''' This method converts stroke data to packet data for example only.
''' The InkAnalyzerBase is used when your application is handling packet
''' data. If your application uses stroke data from an Ink object, then
''' you would use InkAnalyzer.
''' </remarks>
Public Overloads Shared Function MyAddStroke( _
ByVal baseInkAnalyzer As System.Windows.Ink.AnalysisCore.InkAnalyzerBase, _
ByVal theStroke As Microsoft.Ink.Stroke, _
ByVal languageIdentifier As Integer) _
As System.Windows.Ink.AnalysisCore.ContextNodeBase
    If baseInkAnalyzer Is Nothing Then
        Throw New ArgumentNullException("baseInkAnalyzer")
    End If

    If theStroke Is Nothing Then
        Throw New ArgumentNullException("theStroke")
    End If

    ' Add a single stroke to the InkAnalyzerBase and specify the
    ' stroke's language.
    Dim result As System.Windows.Ink.AnalysisCore.ContextNodeBase = _
        baseInkAnalyzer.AddStroke(theStroke.Id, _
            theStroke.GetPacketData(), theStroke.PacketDescription, _
            languageIdentifier)

    Return result
End Function 'AddStroke

/// <summary>
/// Adds a stroke to an InkAnalyzerBase and assigns a specific
/// culture identifier to the stroke.
/// </summary>
/// <param name="baseInkAnalyzer">
/// The analyzer that receives the stroke.</param>
/// <param name="theStroke">The stroke to add.</param>
/// <param name="languageIdentifier">The culture identifier to assign to
/// the stroke.</param>
/// <returns>The node to which the analyzer added the stroke.</returns>
/// <remarks>
/// This method converts stroke data to packet data for example only.
/// The InkAnalyzerBase is used when your application is handling packet
/// data. If your application uses stroke data from an Ink object, then
/// you would use InkAnalyzer.
/// </remarks>
public static System.Windows.Ink.AnalysisCore.ContextNodeBase MyAddStroke(
System.Windows.Ink.AnalysisCore.InkAnalyzerBase baseInkAnalyzer,
    Microsoft.Ink.Stroke theStroke,
    int languageIdentifier)
{
    if (null == baseInkAnalyzer)
    {
        throw new ArgumentNullException("baseInkAnalyzer");
    }

    if (null == theStroke)
    {
        throw new ArgumentNullException("theStroke");
    }

    // Add a single stroke to the InkAnalyzerBase and specify the
    // stroke's language.
    System.Windows.Ink.AnalysisCore.ContextNodeBase result = baseInkAnalyzer.AddStroke(
        theStroke.Id, theStroke.GetPacketData(),
        theStroke.PacketDescription, languageIdentifier);

    return result;
}