AnalysisHintNode.Name Property

Article
2012-10-19

Gets or sets the name of this analysis hint node.

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

Syntax

'Declaration
Public Property Name As String
'Usage
Dim instance As AnalysisHintNode 
Dim value As String 

value = instance.Name

instance.Name = value

public string Name { get; set; }

public:
property String^ Name {
    String^ get ();
    void set (String^ value);
}

public function get Name () : String 
public function set Name (value : String)

Property Value

Type: System.String
A name for this AnalysisHintNode. The default is an empty string ("").

Remarks

To search an InkAnalyzer for an existing hint by name, use InkAnalyzer.GetAnalysisHints(String). The name of a hint has no effect upon ink analysis.

To remove a name from a hint, set Name to nulla null reference (Nothing in Visual Basic).

Examples

This example creates an AnalysisHintNode, theAnalysisHint, for the InkAnalyzer, theInkAnalyzerWithHint, and makes theAnalysisHint a global hint. It then sets the AllowPartialDictionaryTerms and Name 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

Share via