RecognitionAlternate.AlternatesWithConstantPropertyValues Method

RecognitionAlternate.AlternatesWithConstantPropertyValues Method

Returns a RecognitionAlternates collection that is made of a division of the RecognitionAlternate object on which this method is called.

Definition

Visual Basic .NET Public Function AlternatesWithConstantPropertyValues( _
ByVal g As Guid _
) As RecognitionAlternates
C# public RecognitionAlternates AlternatesWithConstantPropertyValues(
Guid g
);
Managed C++ public: RecognitionAlternates* AlternatesWithConstantPropertyValues(
Guid *g
);

Parameters

g System.Guid. The Guid Leave Site identifier for the RecognitionProperty type for which each returned RecognitionAlternate in the collection has the same constant value.

Return Value

Microsoft.Ink.RecognitionAlternates. Returns a RecognitionAlternates collection that is made of a division of the RecognitionAlternate object on which this method is called.

Exceptions

COMException Leave Site:

Remarks

Each RecognitionAlternate object in the RecognitionAlternates collection contains adjacent recognition segments, which have the same property value for the g property passed into the method.

For example, you can return alternates that divide the original alternate by:

  • Level of confidence boundaries—whether strong, intermediate, or poor—in the recognition result.
  • Line boundaries.
  • Segment boundaries.

For a complete list of property types, see the RecognitionProperty object.

Note: The recognizer determines the segmentation of strokes into the recognition segments. Some recognition segments, such as spaces, may correspond to an empty Strokes collection.

Note: The recognizer determines the ordering of the recognition segments. Therefore, adjacent recognition segments may be based on the order in which the ink was drawn or based on location, such as whether ink is positioned left-to-right, positioned top-to-bottom, and so on.

The ConfidenceAlternates property is an alternative to the AlternatesWithConstantPropertyValues method, where the ConfidenceLevel property is the RecognitionProperty that separates the alternates in the returned RecognitionAlternates collection.

The LineAlternates property is an alternative to the AlternatesWithConstantPropertyValues method, where the LineNumber property is the RecognitionProperty that separates the alternates in the returned RecognitionAlternates collection.

Note: The AlternatesWithConstantPropertyValues method, the LineAlternates property, and the ConfidenceAlternates property of the RecognitionAlternate object function differently than the GetAlternatesFromSelection method of the RecognitionResult object. The GetAlternatesFromSelection method returns a RecognitionAlternates collection for the requested segments of the recognition result.

See Also