ITextPara2::SetSnapToGrid method (tom.h)
Sets whether paragraph lines snap to a vertical grid that could be defined for the whole document.
Syntax
HRESULT SetSnapToGrid(
[in] long Value
);
Parameters
[in] Value
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. |
tomToggle | Toggle the SnapToGrid property. |
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 |