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.
Value Meaning tomTrue Characters are displayed as subscript. tomFalse Characters are not displayed as subscript. tomUndefined The 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 code | Description |
|---|---|
|
Invalid argument. |
|
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 |
|
|
DLL |
|
See also
- Reference
- ITextFont
- SetSubscript
- CHARFORMAT2
- Conceptual
- Text Object Model
Send comments about this topic to Microsoft
Build date: 10/27/2012
