InkAnalyzer.CreateAnalysisHint Method ()

Article
12/12/2007

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

Namespace: System.Windows.Ink
Assembly: IAWinFX (in iawinfx.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 AnalysisHintNode CreateAnalysisHint ()

public function CreateAnalysisHint () : AnalysisHintNode

Not applicable.

Return Value

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 the area of a non-global hint cannot overlap the global hint's area. For more information about the types of context information that a hint can provide, see AnalysisHintNode.

Example

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 AnalysisHintNode = Me.theInkAnalyzerWithHint.CreateAnalysisHint()
theAnalysisHint.Location.MakeInfinite()

theAnalysisHint.AllowPartialDictionaryTerms = True
theAnalysisHint.Name = "Allow Partial Dictionary Terms"

// Add a new, global analysis hint to theInkAnalyzerWithHint.
AnalysisHintNode theAnalysisHint =
    this.theInkAnalyzerWithHint.CreateAnalysisHint();
theAnalysisHint.Location.MakeInfinite();

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

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