Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

OptionSnapToGrid

  • Last UpdatedJul 13, 2023
  • 1 minute read

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.

Syntax

OptionSnapToGrid(OptionValue)

OptionValue:

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.

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.

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in