Share via


AnalysisHintNode.Factoid Property

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)

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);
}
public function get Factoid () : String 
public function set Factoid (value : String)

Property Value

Type: System.String
The string name of the factoid used by the InkAnalyzer to analyze ink within the current 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.

Examples

This example creates an AnalysisHintNode (named theAnalysisHint) for the InkAnalyzer (named 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 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

AnalysisHintNode Class

AnalysisHintNode Members

System.Windows.Ink Namespace