Edit

ITextFont::SetSubscript method (tom.h)

  • Article

Sets whether characters are displayed as subscript.

Syntax

HRESULT SetSubscript(
  [in] long Value
);

Parameters

[in] Value

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.
tomToggle Toggle the state of the Subscript property.
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
E_INVALIDARG
 Invalid argument.
CO_E_RELEASED
 The font object is attached to a range that has been deleted.
E_ACCESSDENIED
 Write access is denied.
E_OUTOFMEMORY
 Insufficient memory.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

Conceptual

GetSubscript

ITextFont

Reference

Text Object Model