ITextPara2::GetSnapToGrid method (tom.h)

Gets whether paragraph lines snap to a vertical grid that could be defined for the whole document.

Syntax

HRESULT GetSnapToGrid(
  [out, retval] long *pValue
);

Parameters

[out, retval] pValue

Type: long*

A tomBool value that can be one of the following.

Value Meaning
tomTrue Paragraph lines snap to a vertical grid.
tomFalse Paragraph lines do not snap to a grid.
tomUndefined The SnapToGrid property is undefined.

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

ITextPara2

ITextPara2::SetSnapToGrid