SetGroupLabelAsync Method
Overloads
| SetGroupLabelAsync(String, String, String) |
You can use the SetGroupLabel method with any object that contains an object grouping definition. This method allows you to change the label of an existing group of objects directly. |
|
| SetGroupLabelAsync(AsyncHandle, String, String, String) |
You can use the SetGroupLabel method with any object that contains an object grouping definition. This method allows you to change the label of an existing group of objects directly. |
SetGroupLabelAsync(String, String, String)
You can use the SetGroupLabel method with any object that contains an object grouping definition.
This method allows you to change the label of an existing group of objects directly.
Declaration
Task SetGroupLabelAsync([QixName("qPath")] string path, [QixName("qNewLabel")] string newLabel, [QixName("qTargetGroupId")] string targetGroupId = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path |
Path to the definition of the object to be selected.
For example |
| System.String | newLabel |
New label for the group. A label starting with an '=' will be evaluated as an expression. |
| System.String | targetGroupId |
Id of the group whose label will be set (if not the called object). |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetGroupLabelAsync(AsyncHandle, String, String, String)
You can use the SetGroupLabel method with any object that contains an object grouping definition.
This method allows you to change the label of an existing group of objects directly.
Declaration
Task SetGroupLabelAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qNewLabel")] string newLabel, [QixName("qTargetGroupId")] string targetGroupId = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | path |
Path to the definition of the object to be selected.
For example |
| System.String | newLabel |
New label for the group. A label starting with an '=' will be evaluated as an expression. |
| System.String | targetGroupId |
Id of the group whose label will be set (if not the called object). |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |