This document is archived and information here might be outdated. Recommended version. |
The group into which the edit task is placed.
[Visual Basic .NET]
Public ReadOnly Property GroupName As String
[C#]
public string GroupName {get;}
[C++]
HRESULT get_GroupName(
System.String* Name
);
[C++] Parameters Name [out, retval]
Name is a parameter of type BSTR*
Returns the GroupName of the engine edit task. The GroupName is used by the ControlsEditingTaskToolControl command to group edit tasks under a heading (e.g. Create New Feature, Modify Feature).
A developer can set the GroupName for a new engine edit task that they create to be an existing GroupName (e.g. 'Create New Feature') or a new GroupName (e.g. 'Business Tasks'). If the developer does not set a GroupName for a new engine edit task then it will be given the default GroupName 'Other Tasks'.
Note: It is possible that more than one engine edit task can be created with the same IEngineEditTask::Name. It is recommended that a developer uniquely identifies an engine edit task using a specific GroupName and IEngineEditTask::Name