Represents a collection of Bexel.Api.SelectionSets.SelectionSetFolders. More...
Public Member Functions | |
| SelectionSetFolder | Add (string name, string description="") |
| Creates a new selection set folder and adds it to the collection. More... | |
| bool | Remove (string name) |
| Removes selection set folder with the specified name from the collection. More... | |
| bool | Remove (SelectionSetFolder folder) |
| Removes the specified selection set folder from the collection. More... | |
| void | RemoveRange (IEnumerable< SelectionSetFolder > folders) |
| Removes the specified selection set folders from the collection. More... | |
 Public Member Functions inherited from Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection | |
| SelectionSetFolder | GetSelectionSetFolderByID (SelectionSetFolderID id) |
| Retrieves the selection set folder with the specified ID. More... | |
| SelectionSetFolder | GetSelectionSetFolderByID (int internalID) |
| Retrieves the selection set folder with the specified internal ID. More... | |
| SelectionSetFolder | GetSelectionSetFolderByName (string name) |
| Retrieves the selection set folder with the specified name. More... | |
| bool | ContainsKey (SelectionSetFolderID id) |
| Determines whether the collection contains the selection set folder with the specified ID. More... | |
| bool | ContainsKey (int internalID) |
| Determines whether the collection contains the selection set folder with the specified internal ID. More... | |
Additional Inherited Members | |
| Properties inherited from Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection | |
| SelectionSetFolder | this[SelectionSetFolderID id] [get] |
| Retrieves the selection set folder with the specified ID. More... | |
| SelectionSetFolder | this[int internalID] [get] |
| Retrieves the selection set folder with the specified selection set folder internal ID. More... | |
Detailed Description
Represents a collection of Bexel.Api.SelectionSets.SelectionSetFolders.
Member Function Documentation
◆ Add()
| SelectionSetFolder Bexel.Api.SelectionSets.ISelectionSetFolderCollection.Add | ( | string | name, |
| string | description = "" |
||
| ) |
Creates a new selection set folder and adds it to the collection.
- Parameters
-
name Name of the selection set folder to be added. description Description of the selection set folder to be added.
- Returns
- Newly created selection set folder.
- Exceptions
-
Bexel.Api.InvalidApiArgumentException The specified name is invalid or selection set folder with the same name already exists within collection.
Implemented in Bexel.Api.SelectionSets.SelectionSetFolderCollection.
◆ Remove() [1/2]
| bool Bexel.Api.SelectionSets.ISelectionSetFolderCollection.Remove | ( | string | name | ) |
Removes selection set folder with the specified name from the collection.
- Parameters
-
name Name of the selection set folder to be removed.
- Returns
- True if remove is successful, False if no such selection set folder exists within collection.
This action will also delete selection set folder from the project.
Implemented in Bexel.Api.SelectionSets.SelectionSetFolderCollection.
◆ Remove() [2/2]
| bool Bexel.Api.SelectionSets.ISelectionSetFolderCollection.Remove | ( | SelectionSetFolder | folder | ) |
Removes the specified selection set folder from the collection.
- Parameters
-
folder A reference to selection set folder to be removed.
- Returns
- True if remove is successful, False if no such selection set folder exists within collection.
This action will also delete selection set folder from the project. The specified selection set folder will become invalid API object after removal.
Implemented in Bexel.Api.SelectionSets.SelectionSetFolderCollection.
◆ RemoveRange()
| void Bexel.Api.SelectionSets.ISelectionSetFolderCollection.RemoveRange | ( | IEnumerable< SelectionSetFolder > | folders | ) |
Removes the specified selection set folders from the collection.
- Parameters
-
folders A reference to selection set folders to be removed.
This action will also delete selection set folder from the project. Only selection set folders which belong to this collection will be removed. The specified selection set folders will become invalid API objects after removal.
Implemented in Bexel.Api.SelectionSets.SelectionSetFolderCollection.
