InkAnalyzerBase.GetAlternates Method (ContextNodeBaseCollection, Int32)

Článek
10/19/2012

Returns up to the specified number of analysis alternates for the nodes in a specified ContextNodeBaseCollection.

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

Syntax

'Declaration
Public Function GetAlternates ( _
    nodes As ContextNodeBaseCollection, _
    maximumAlternates As Integer _
) As AnalysisAlternateBaseCollection
'Usage
Dim instance As InkAnalyzerBase 
Dim nodes As ContextNodeBaseCollection 
Dim maximumAlternates As Integer 
Dim returnValue As AnalysisAlternateBaseCollection 

returnValue = instance.GetAlternates(nodes, _
    maximumAlternates)

public AnalysisAlternateBaseCollection GetAlternates(
    ContextNodeBaseCollection nodes,
    int maximumAlternates
)

public:
AnalysisAlternateBaseCollection^ GetAlternates(
    ContextNodeBaseCollection^ nodes, 
    int maximumAlternates
)

public function GetAlternates(
    nodes : ContextNodeBaseCollection, 
    maximumAlternates : int
) : AnalysisAlternateBaseCollection

Parameters

nodes
Type: System.Windows.Ink.AnalysisCore.ContextNodeBaseCollection

The context nodes for which to get analysis alternates.

maximumAlternates
Type: System.Int32

The number of analysis alternates to return.

Return Value

Type: System.Windows.Ink.AnalysisCore.AnalysisAlternateBaseCollection
Up to maximumAlternate of the top analysis alternates for nodes.

Remarks

The top alternate is returned as the first alternate of the collection.

The context nodes in nodes do not have to represent adjacent areas of the document.

For each analysis hint in nodes, the InkAnalyzerBase returns only the top alternate.

Examples

The following example gets up to five alternates for the ContextNodeBaseCollection, theContextNodes. In the example, theContextNodes are nodes contained by the InkAnalyzerBase, theInkAnalyzerBase.

' Retrieve 5 alternates for the specified context nodes. 
Dim theAlternates As System.Windows.Ink.AnalysisCore.AnalysisAlternateBaseCollection = _
    theInkAnalyzerBase.GetAlternates(theContextNodes, 5)

// Retrieve 5 alternates for the specified context nodes.
System.Windows.Ink.AnalysisCore.AnalysisAlternateBaseCollection theAlternates =
    theInkAnalyzerBase.GetAlternates(theContextNodes, 5);

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

Sdílet prostřednictvím