Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ITextFont::GetSubscript method

Gets whether characters are displayed as subscript.

Syntax


HRESULT GetSubscript(
  long *pValue
);

Parameters

pValue

Type: long*

A tomBool value that can be one of the following.

ValueMeaning
tomTrueCharacters are displayed as subscript.
tomFalseCharacters are not displayed as subscript.
tomUndefinedThe Subscript property is undefined.

 

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return codeDescription
E_INVALIDARG

Invalid argument.

CO_E_RELEASED

The font object is attached to a range that has been deleted.

 

Remarks

This property corresponds to the CFE_SUBSCRIPT effect described in the CHARFORMAT2 structure.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextFont
SetSubscript
CHARFORMAT2
Conceptual
Text Object Model

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.