Edit

ITextFont2::GetEffects method (tom.h)

  • Article

Gets the character format effects.

Syntax

HRESULT GetEffects(
  [out] long *pValue,
  [out] long *pMask
);

Parameters

[out] pValue

Type: long*

A combination of the following character format values.

tomAllCaps

tomBold

tomDisabled

tomEmboss

tomHidden

tomImprint

tomInlineObjectStart

tomItalic

tomLinkProtected

tomMathZone

tomMathZoneDisplay

tomMathZoneNoBuildUp

tomMathZoneOrdinary

tomOutline

tomProtected

tomRevised

tomShadow

tomSmallCaps

tomStrikeout

tomUnderline

If the tomInlineObjectStart flag is set, you might want to call GetInlineObject for more inline object properties.

[out] pMask

Type: long*

The differences in these flags over the range. A value of zero indicates that the properties are the same over the range. For an insertion point, this value is always zero.

Return value

Type: HRESULT

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

Requirements

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

See also

ITextFont2

ITextFont2::SetEffects