ITextFont2::GetProperty method

Gets the value of the specified property.

Syntax


HRESULT GetProperty(
  [in]   long Type,
  [out]  long *pValue
);

Parameters

Type [in]

Type: long

The property ID of the value to return. See Remarks.

pValue [out]

Type: long*

The property value.

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

Property IDs are defined by the Text Object Model (TOM). Here are how some of the TOM values are obtained:

tomFontPropAlign

The alignment property of an operator in a math zone:

  • Value 0 implies no special alignment.
  • Values 1 through 127 align the operator with the (n – 1)st operator on the first line of an equation.
  • Value 128 identifies operators to be vertically aligned with respect to one another ("Align at =").
  • Other values are not valid.
tomFontPropTeXStyle

The TeX style, which can have the following values:

tomDecSize
tomDecDecSize
tomIncIncSize
tomIncSize
tomStyleDefault
tomStyleDisplay
tomStyleDisplayCramped
tomStyleScript
tomStyleScriptCramped
tomStyleScriptScript
tomStyleScriptScriptCramped
tomStyleText
tomStyleTextCramped
tomFontStyle

The font style:

tomFontStyleItalic
tomFontStyleOblique
tomFontStyleUpright
tomFontStretch

The font stretch, which can have one of the following values:

tomFontStretchCondensed
tomFontStretchDefault
tomFontStretchExpanded
tomFontStretchExtraCondensed
tomFontStretchExtraExpanded
tomFontStretchNormal
tomFontStretchSemiCondensed
tomFontStretchSemiExpanded
tomFontStretchUltraCondensed
tomFontStretchUltraExpanded

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

ITextFont2
ITextFont2::SetProperty

 

 

Community Additions

ADD
Show:
© 2014 Microsoft