Differences
This shows you the differences between two versions of the page.
|
resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:updateproperties [25 Jun 2020 08:01] Krithika Manchale created |
resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:updateproperties [15 Nov 2021 11:20] Nikhin Shetty |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| =====Update Properties===== | =====Update Properties===== | ||
| - | This action allows the user to update a specific property of a given plugin. Return type is a success/failure message in the form of list of strings. The function call takes in 4 arguments. | + | This action allows the user to update a specific property of a given plugin. The function call takes in 4 arguments. Return type is a SSPResult which contains a IsSuccess flag for success/failure and Message in the form of list of strings. |
| \\ | \\ | ||
| ===API=== | ===API=== | ||
| <code> | <code> | ||
| - | list<string> UpdateProperties(1: string elementUid, 2: string propertyName, 3: string propertyType, 4: string propertyValue) | + | SSPResult UpdateProperties(string elementUid, string propertyName, string propertyType, string propertyValue) |
| </code> | </code> | ||
| \\ | \\ | ||
| Line 14: | Line 14: | ||
| - elementUid - Uid of shape whose property must be updated. | - elementUid - Uid of shape whose property must be updated. | ||
| - propertyName - Name of the property to be updated. | - propertyName - Name of the property to be updated. | ||
| - | - propertyType -Data type of the property’s value | + | - propertyType - Data type of the property’s value |
| - | - propertyValue -New value for the property | + | - propertyValue - New value for the property |
| \\ | \\ | ||
| ===Result=== | ===Result=== | ||
| - | “Updated property Successfully”.\\ | + | SSPResult contains 'IsSuccess' flag and 'Message' information of the UpdateProperties action. |
| + | -IsSuccess is 'True' if the property updated successful, else 'False'. | ||
| + | -Message contains the Success/Failure information in the form of list of string. | ||
| + | \\ | ||
| \\ | \\ | ||
| - | ===Error==== | ||
| - | Error message sent out by the server application | ||
| - | |||
resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updateproperties.txt · Last modified: 15 Nov 2021 11:20 by Nikhin Shetty