ITextFont2::SetEffects method (tom.h)

Sets the character format effects.

Syntax

HRESULT SetEffects(
  [in] long Value,
  [in] long Mask
);

Parameters

[in] Value

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

[in] Mask

Type: long

The desired mask, which can be a combination of the Value flags. Only effects with the corresponding mask flag set are modified.

Return value

Type: HRESULT

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

Remarks

Only effects with the corresponding mask flag set are modified.

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::GetEffects