IInkRecognitionAlternate::get_Midline method (msinkaut.h)

Gets the midline for a IInkRecognitionAlternate object that represents a single line of text.

This property is read-only.

Syntax

HRESULT get_Midline(
  VARIANT *Midline
);

Parameters

Midline

Return value

None

Remarks

The midline corresponds to an imaginary horizontal line with which the top of the main body of each character, excluding ascender, is aligned. The midline also corresponds to the top of the x-height.

Note  

If the recognition alternate spans more than one recognition segment within a line of text, then this property returns a line parallel to the baseline for the alternate. The distance of the midline above the baseline is determined by the corresponding distance within the first segment.

You can use the AlternatesWithConstantPropertyValues method with the propertyType parameter set to the Segmentation recognition property globally unique identifier (GUID) to get a collection of one segment recognition alternates that correspond to a segmentation of your original alternate.

 
Note  If the recognition alternate spans more than one line, this property generates an E_FAIL error. You can use the LineAlternates property to get a collection of one line recognition alternates that corresponds to a multiple line recognition alternate.
 

Requirements

Requirement Value
Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header msinkaut.h
Library InkObj.dll

See also

AlternatesWithConstantPropertyValues Method

Ascender Property

Baseline Property

Descender Property

IInkRecognitionAlternate Interface

LineAlternates Property