InkAnalyzer.GetAnalysisHints Method (String)

Artículo
12/12/2007

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

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in microsoft.ink.analysis.dll)

Syntax

'Declaration
Public Function GetAnalysisHints ( _
    hintName As String _
) As ContextNodeCollection
'Usage
Dim instance As InkAnalyzer
Dim hintName As String
Dim returnValue As ContextNodeCollection

returnValue = instance.GetAnalysisHints(hintName)

public ContextNodeCollection GetAnalysisHints (
    string hintName
)

public:
ContextNodeCollection^ GetAnalysisHints (
    String^ hintName
)

public ContextNodeCollection GetAnalysisHints (
    String hintName
)

public function GetAnalysisHints (
    hintName : String
) : ContextNodeCollection

Not applicable.

Parameters

hintName
The name of the analysis hint to return.

Return Value

A collection containing the analysis hints with the specified name, or an empty collection, if no such hint is attached to the ink analyzer.

Remarks

This method can return only analysis hints that have had their Name property set.

Example

This example creates a System.Text.StringBuilder, notes. It then adds information about all analysis hints with the name, theHintName, currently attached to the InkAnalyzer, theInkAnalyzer.

' Create a string builder for information about the hints.
Dim notes As New System.Text.StringBuilder()
notes.AppendLine(String.Format( _
    "List of all the current AnalysisHintNodes named '{0}':", theHintName))

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

// Create a string builder for information about the hints.
System.Text.StringBuilder notes = new System.Text.StringBuilder();
notes.AppendLine(string.Format(
    "List of all the current AnalysisHintNodes named '{0}':",
    theHintName));

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

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Compartir a través de