ITextPara2::GetEffects method (tom.h)

Article
02/22/2024

Gets the paragraph format effects.

Syntax

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

Parameters

[out] pValue

Type: long*

The paragraph effects. This value can be a combination of the following flags.

tomParaEffectRTL

tomParaEffectKeep

tomParaEffectKeepNext

tomParaEffectPageBreakBefore

tomParaEffectNoLineNumber

tomParaEffectNoWidowControl

tomParaEffectDoNotHyphen

tomParaEffectSideBySide

tomParaEffectCollapsed

tomParaEffectOutlineLevel

tomParaEffectBox

tomParaEffectTableRowDelimiter

tomParaEffectTable

[out] pMask

Type: long*

The differences in the flags over the range. A value of 1 indicates that the corresponding effect is the same over the range. For an insertion point, the values equal 1 for all defined effects.

Return value

Type: HRESULT

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

Remarks

If the tomTable flag is set, you can use the ITextRange2::GetTable method to get more table properties.

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

Share via