Technical Reference > Graphics Builder Automation Interface > Options Functions > OptionSnapToGrid


Simulates the option available on the Graphics Builder Tools menu that automatically snaps objects to a grid. You can use this function to set this option, or you can retrieve its current setting.




TRUE activates the option, FALSE deactivates the option.

Return Value

If retrieving the current setting, TRUE or FALSE. If enabling or disabling the option, 0 (zero) if successful. In both cases, an error is returned if unsuccessful.

Note: For details on handling return and error values, see Error Handling.

Related Functions

OptionDisplayPropertiesOnNew, OptionSnapToGuidelines

Note: This function is implemented in the C++ environment as two separate functions: put_OptionSnapToGrid enables or disables this option, and get_OptionSnapToGrid retrieves the current option setting.