OV_Tools
- Description
- A container class to group actions into a tool group. This
class functions like a folder.
- class OV_Tools
{
- Properties:
- string Name;
- Class Methods:
- OV_Tools Create(
- [in] string Caption,
- [in] string ParentName,
- [in, optional] string Name,
- [in, optional] string Description
- );
- OV_Tools Create_Trans(
- [in] string TransId,
- [in] string Caption,
- [in] string ParentName,
- [in, optional] string Name,
- [in, optional] string Description
- );
- void Remove(
- [in] string Name
- );
- void Remove_Trans(
- [in] string TransId,
- [in] string Name
- );
- OV_Tools GetRoot(
- );
- OV_Tools GetRoot_Trans(
- [in] string TransId
- );
- OV_Tools GetByName(
- [in] string Name
- );
- OV_Tools GetByName_Trans(
- [in] string TransId,
- [in] string Name
- );
- OV_Tools GetByHierarchicalPath(
- [in] string Path
- );
- OV_Tools GetByHierarchicalPath_Trans(
- [in] string TransId,
- [in] string Path
- );
- void ChangeName(
- [in] OV_Tools ToolGroup,
- [in, optional] string NewName
- );
- void ChangeName_Trans(
- [in] string TransId,
- [in] OV_Tools ToolGroup,
- [in, optional] string NewName
- );
- Instance Methods:
- void Modify(
- [in] OV_Tools ToolGroup
- );
- void Modify_Trans(
- [in] string TransId,
- [in] OV_Tools ToolGroup
- );
- sint32 GetParents(
- [out] OV_Tools ToolGroups[],
- [in, optional] boolean IncludeAllHierarchicalParents
- );
- sint32 GetParents_Trans(
- [in] string TransId,
- [out] OV_Tools ToolGroups[],
- [in, optional] boolean IncludeAllHierarchicalParents
- );
- boolean IsChildOf(
- [in] string ParentName
- );
- boolean IsChildOf_Trans(
- [in] string TransId,
- [in] string ParentName
- );
- boolean AddAction(
- [in] string ActionName
- );
- boolean AddAction_Trans(
- [in] string TransId,
- [in] string ActionName
- );
- void RemoveAction(
- [in] string ActionName
- );
- void RemoveAction_Trans(
- [in] string TransId,
- [in] string ActionName
- );
- sint32 GetActions(
- [out] OV_Action Actions[],
- [in, optional] boolean IncludeSubGroups
- );
- sint32 GetActions_Trans(
- [in] string TransId,
- [out] OV_Action Actions[],
- [in, optional] boolean IncludeSubGroups
- );
- boolean HasChildAction(
- [in] string ActionName,
- [in, optional] boolean IncludeSubGroups
- );
- boolean HasChildAction_Trans(
- [in] string TransId,
- [in] string ActionName,
- [in, optional] boolean IncludeSubGroups
- );
- boolean AddToolGroup(
- [in] string ToolGroupName
- );
- boolean AddToolGroup_Trans(
- [in] string TransId,
- [in] string ToolGroupName
- );
- void RemoveToolGroup(
- [in] string ToolGroupName
- );
- void RemoveToolGroup_Trans(
- [in] string TransId,
- [in] string ToolGroupName
- );
- sint32 GetChildToolGroups(
- [out] OV_Tools ToolGroups[],
- [in, optional] boolean IncludeSubGroups
- );
- sint32 GetChildToolGroups_Trans(
- [in] string TransId,
- [out] OV_Tools ToolGroups[],
- [in, optional] boolean IncludeSubGroups
- );
- boolean HasChildToolGroup(
- [in] string ToolGroupName,
- [in, optional] boolean IncludeSubGroups
- );
- boolean HasChildToolGroup_Trans(
- [in] string TransId,
- [in] string ToolGroupName,
- [in, optional] boolean IncludeSubGroups
- );
};