AnalysisHintNode.Factoid Property

Article
12/12/2007

Gets or sets the string name of the factoid that the InkAnalyzer uses to analyze ink within the current area.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in iawinfx.dll)
XML Namespace: https://schemas.microsoft.com/winfx/2006/xaml/presentation

Syntax

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

value = instance.Factoid

instance.Factoid = value

public string Factoid { get; set; }

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

/** @property */
public String get_Factoid ()

/** @property */
public void set_Factoid (String value)

public function get Factoid () : String

public function set Factoid (value : String)

Not applicable.

Property Value

The string name of the factoid the InkAnalyzer uses to analyze ink within this area. The default is an empty string ("").

Remarks

To remove a factoid, set this property to the empty string. For information about available factoid values, see Using Context to Improve Accuracy.

During analysis, if the ink recognizer applied to the strokes does not support the specified factoid, the ink analyzer generates an AnalysisWarning with its WarningCode property set to the System.Windows.Ink.AnalysisWarningCode value of FactoidNotSupported.

Example

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

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

theAnalysisHint.Factoid = "(!IS_DATE_FULLDATE)"
theAnalysisHint.CoerceToFactoid = True
theAnalysisHint.Name = "Coerce to Factoid"

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

theAnalysisHint.Factoid = "(!IS_DATE_FULLDATE)";
theAnalysisHint.CoerceToFactoid = true;
theAnalysisHint.Name = "Coerce to Factoid";

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