Share via


InkAnalyzer.CreateAnalysisHint Method

Adds a new AnalysisHintNode with an empty area to the ink analyzer.

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

Syntax

'Declaration
Public Function CreateAnalysisHint As AnalysisHintNode
'Usage
Dim instance As InkAnalyzer 
Dim returnValue As AnalysisHintNode 

returnValue = instance.CreateAnalysisHint()
public AnalysisHintNode CreateAnalysisHint()
public:
AnalysisHintNode^ CreateAnalysisHint()
public function CreateAnalysisHint() : AnalysisHintNode

Return Value

Type: Microsoft.Ink.AnalysisHintNode
The new AnalysisHintNode added to the ink analyzer.

Remarks

The ink analyzer adds the new AnalysisHintNode as a subnode of the analyzer's RootNode.

Adding an analysis hint does not mark the hint's area for reanalysis. To mark the area within the hint for reanalysis, call the DirtyRegion object's Union method with the hint's Location.

The new AnalysisHintNode represents an empty region until you update its Location property.

If a hint is assigned an infinite area, termed a global hint, the ink analyzer applies the hint's context to all ink that is not within another hint's area. Multiple hints may be attached to a single analyzer. However, only one global hint can be attached to a single ink analyzer, and no non-global hints can overlap. For more information about the types of context information that a hint can provide, see AnalysisHintNode.

Examples

This example creates an AnalysisHintNode, theAnalysisHint, for the InkAnalyzer, theInkAnalyzerWithHint, and makes theAnalysisHint a global hint. It then sets the following properties on the hint:

' Add a new, global analysis hint to theInkAnalyzerWithHint. 
Dim theAnalysisHint As Microsoft.Ink.AnalysisHintNode = _
    Me.theInkAnalyzerWithHint.CreateAnalysisHint()
theAnalysisHint.Location.MakeInfinite()

theAnalysisHint.AllowPartialDictionaryTerms = True
theAnalysisHint.Name = "Allow Partial Dictionary Terms"
// Add a new, global analysis hint to theInkAnalyzerWithHint.
Microsoft.Ink.AnalysisHintNode theAnalysisHint =
    this.theInkAnalyzerWithHint.CreateAnalysisHint();
theAnalysisHint.Location.MakeInfinite();

theAnalysisHint.AllowPartialDictionaryTerms = true;
theAnalysisHint.Name = "Allow Partial Dictionary Terms";

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

See Also

Reference

InkAnalyzer Class

InkAnalyzer Members

CreateAnalysisHint Overload

Microsoft.Ink Namespace

InkAnalyzer.DeleteAnalysisHint

InkAnalyzer.GetAnalysisHints