InkAnalyzer.ModifyTopAlternate Method (AnalysisAlternate, Boolean)

Article
10/19/2012

Changes the current top alternate to the specified AnalysisAlternate.

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

Syntax

'Declaration
Public Function ModifyTopAlternate ( _
    alternate As AnalysisAlternate, _
    confirmAutomatically As Boolean _
) As Boolean
'Usage
Dim instance As InkAnalyzer 
Dim alternate As AnalysisAlternate 
Dim confirmAutomatically As Boolean 
Dim returnValue As Boolean 

returnValue = instance.ModifyTopAlternate(alternate, _
    confirmAutomatically)

public bool ModifyTopAlternate(
    AnalysisAlternate alternate,
    bool confirmAutomatically
)

public:
bool ModifyTopAlternate(
    AnalysisAlternate^ alternate, 
    bool confirmAutomatically
)

public function ModifyTopAlternate(
    alternate : AnalysisAlternate, 
    confirmAutomatically : boolean
) : boolean

Parameters

alternate
Type: Microsoft.Ink.AnalysisAlternate

The alternate to set as the top alternate.

confirmAutomatically
Type: System.Boolean

true to leave the confirmation type of affected context nodes unchanged; otherwise, false.

Return Value

Type: System.Boolean

Remarks

To get analysis alternates, use GetAlternates. To get the context nodes associated with an analysis alternate, use AnalysisAlternate.AlternateNodes.

To change the confirmation type for a context node, use ContextNode.Confirm.

Examples

This example modifies the top alternate for the InkAnalyzer, theInkAnalyzer, to the AnalysisAlternate, theAnalysisAlternate. It calls ModifyTopAlternate with confirmAutomatically set to true, so that the analyzer does not change the confirmation type of the context nodes associated with the alternate.

' Modify the top alternate. This does not change the confirmation 
' type for the associated context nodes. 
Me.theInkAnalyzer.ModifyTopAlternate(theAnalysisAlternate, True)

// Modify the top alternate. This does not change the confirmation 
// type for the associated context nodes. 
this.theInkAnalyzer.ModifyTopAlternate(theAnalysisAlternate, true);

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