InkAnalyzerBase.GetAnalysisHints Method (String)

Article
10/19/2012

Returns all of the analysis hint nodes with the specified name that are attached to the InkAnalyzerBase.

Namespace: System.Windows.Ink.AnalysisCore
Assembly: IACore (in IACore.dll)

Syntax

'Declaration
Public Function GetAnalysisHints ( _
    hintName As String _
) As ContextNodeBaseCollection
'Usage
Dim instance As InkAnalyzerBase 
Dim hintName As String 
Dim returnValue As ContextNodeBaseCollection 

returnValue = instance.GetAnalysisHints(hintName)

public ContextNodeBaseCollection GetAnalysisHints(
    string hintName
)

public:
ContextNodeBaseCollection^ GetAnalysisHints(
    String^ hintName
)

public function GetAnalysisHints(
    hintName : String
) : ContextNodeBaseCollection

Parameters

hintName
Type: System.String

The name of the analysis hint nodes to return.

Return Value

Type: System.Windows.Ink.AnalysisCore.ContextNodeBaseCollection
A collection containing each analysis hint node with the specified name that is attached to the ink analyzer.

Remarks

This method returns an empty collection if no such analysis hint nodes are attached to the ink analyzer.

An analysis hint node is a ContextNodeBase that has a Type property value of AnalysisHint.

To add context information to the hint, use the ContextNodeBase object's AddPropertyData method with the propertyDataId parameter set to one of the globally unique identifiers (GUIDs) in the PropertyGuidsForAnalysisHintsBase class.

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

To find which property values are set on a context node, use GetPropertyDataIds. To find the value of a property, use GetPropertyData.

Examples

The following example retrieves only the analysis hint nodes with the specified name that are currently attached to the InkAnalyzerBase, theInkAnalyzerBase.

Dim theAnalysisHints As System.Windows.Ink.AnalysisCore.ContextNodeBaseCollection = _
    theInkAnalyzerBase.GetAnalysisHints("Allow Partial Dictionary Terms")

System.Windows.Ink.AnalysisCore.ContextNodeBaseCollection theAnalysisHints =
    theInkAnalyzerBase.GetAnalysisHints(
        "Allow Partial Dictionary Terms");

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