AnalysisHintNode.GetWordlist Method

Article
10/19/2012

Returns a string array that represents the word list for the current analysis hint.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in IAWinFX.dll)

Syntax

'Declaration
Public Function GetWordlist As String()
'Usage
Dim instance As AnalysisHintNode 
Dim returnValue As String()

returnValue = instance.GetWordlist()

public string[] GetWordlist()

public:
array<String^>^ GetWordlist()

public function GetWordlist() : String[]

Return Value

Type: array<System.String[]
A string array that represents the word list for the current analysis hint, or nulla null reference (Nothing in Visual Basic) if no word list is set.

Remarks

To change the hint's word list, use SetWordlist.

Examples

This example creates a StringBuilder, notes, and adds information about all the hints currently attached to the InkAnalyzer, theInkAnalyzerWithHint. For each hint, the hint's name, word list, and recognized string are added to notes.

Dim notes As New System.Text.StringBuilder()
notes.AppendLine("List of all the current AnalysisHintNodes:")

Dim theHint As AnalysisHintNode
For Each theHint In   Me.theInkAnalyzerWithHint.GetAnalysisHints()
    notes.AppendLine(" Hint Name: " + theHint.Name)

    If 0 < theHint.GetWordlist().Length Then
        notes.Append(" - WordList: ")
        Dim first As Boolean = True 
        Dim theWord As String 
        For Each theWord In  theHint.GetWordlist()
            If Not first Then
                notes.Append(", ")
            Else
                first = False 
            End If
            notes.AppendFormat("'{0}'", theWord)
        Next theWord
        notes.AppendLine()
    Else
        notes.AppendLine(" - No WordList specified")
    End If 

    If String.Empty <> theHint.GetRecognizedString() Then
        notes.AppendLine(" - Recognized string: " + theHint.GetRecognizedString())
    Else
        notes.AppendLine(" - No recognized string.")
    End If

    notes.AppendLine()
Next theHint

System.Text.StringBuilder notes = new System.Text.StringBuilder();
notes.AppendLine("List of all the current AnalysisHintNodes:");

foreach (AnalysisHintNode theHint
    in this.theInkAnalyzerWithHint.GetAnalysisHints())
{
    notes.AppendLine(" Hint Name: " + theHint.Name);

    if (0 < theHint.GetWordlist().Length)
    {
        notes.Append(" - WordList: ");
        bool first = true;
        foreach (String theWord in theHint.GetWordlist())
        {
            if (!first)
            {
                notes.Append(", ");
            }
            else
            {
                first = false;
            }
            notes.AppendFormat("'{0}'", theWord);
        }
        notes.AppendLine();
    }
    else
    {
        notes.AppendLine(" - No WordList specified");
    }

    if (string.Empty != theHint.GetRecognizedString())
    {
        notes.AppendLine(" - Recognized string: "
            + theHint.GetRecognizedString());
    }
    else
    {
        notes.AppendLine(" - No recognized string.");
    }

    notes.AppendLine();
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via