Wiki

Below is the source of this page. To edit this source as well as other pages on the wiki, you must login.

[[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting|Click here to return back]]

=====Update Boolean Property=====

This action allows the user to update the Boolean property of a given plugin. The function call takes in 3 arguments. Return type is a SSPResult which contains a IsSuccess flag for  success/failure and Message in the form of list of strings.

\\
===API===
<code>
SSPResult UpdateBooleanProperty(string elementUid, string propertyName, bool propertyVal)
</code>
\\
===Arguments====
  - elementUid - Uid of shape whose property must be updated.
  - propertyName - Name of the Boolean property to be updated.
  - propertyVal - New Boolean value (True/False) for the property
\\
===Result===
SSPResult contains 'IsSuccess' flag and 'Message' information of the UpdateBooleanProperty action.
  -IsSuccess is 'True' if the property updated successful, else 'False'.
  -Message contains the Success/Failure information in the form of list of string.
\\
\\

Analog Devices Wiki

Page Tools