Skip to main content
ITextPara2::GetSnapToGrid method

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

pValue [out, retval]

Type: long*

A tomBool value that can be one of the following.

ValueMeaning
tomTrueParagraph lines snap to a vertical grid.
tomFalseParagraph lines do not snap to a grid.
tomUndefinedThe SnapToGrid property is undefined.

 

Return value

Type: HRESULT

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

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

ITextPara2
ITextPara2::SetSnapToGrid