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


Simulates the option available on the Graphics Builder Tools menu that automatically snaps objects to guidelines. 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, OptionSnapToGrid

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