InkAnalyzer.GetAnalysisHints Method

Article
2012-10-19

Returns all of the AnalysisHintNode objects that are attached to the InkAnalyzer.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in Microsoft.Ink.Analysis.dll)

Syntax

'Declaration
Public Function GetAnalysisHints As ContextNodeCollection
'Usage
Dim instance As InkAnalyzer 
Dim returnValue As ContextNodeCollection 

returnValue = instance.GetAnalysisHints()

public ContextNodeCollection GetAnalysisHints()

public:
ContextNodeCollection^ GetAnalysisHints()

public function GetAnalysisHints() : ContextNodeCollection

Return Value

Type: Microsoft.Ink.ContextNodeCollection
All of the AnalysisHintNode objects that are attached to the InkAnalyzer.

Remarks

This method returns an empty ContextNodeCollection if no AnalysisHintNode objects are attached.

Examples

This example creates a System.Text.StringBuilder, notes. It then adds the globally unique identifier (GUID) and name of each analysis hint currently attached to the InkAnalyzer, theInkAnalyzer.

' Create a string builder for information about the hints. 
Dim notes As New System.Text.StringBuilder()
notes.AppendLine("List of all the current AnalysisHintNodes:")

Dim theHint As Microsoft.Ink.AnalysisHintNode
For Each theHint In Me.theInkAnalyzer.GetAnalysisHints()
    notes.AppendLine(String.Format( _
        "  Hint {0}, name '{1}'", theHint.Id, theHint.Name))
Next theHint

// Create a string builder for information about the hints.
System.Text.StringBuilder notes = new System.Text.StringBuilder();
notes.AppendLine("List of all the current AnalysisHintNodes:");

foreach (Microsoft.Ink.AnalysisHintNode theHint
    in this.theInkAnalyzer.GetAnalysisHints())
{
    notes.AppendLine(string.Format("  Hint {0}, name '{1}'",
        theHint.Id, theHint.Name));
}

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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