ITextPara2::SetSnapToGrid method

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

Syntax


HRESULT SetSnapToGrid(
  [in]  long Value
);

Parameters

Value [in]

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.
tomToggleToggle the SnapToGrid property.
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::GetSnapToGrid

 

 

Community Additions

ADD
Show:
© 2014 Microsoft