Bexel.Api.SelectionSets.SelectionSetCollection Class Reference
Inheritance diagram for Bexel.Api.SelectionSets.SelectionSetCollection:
Public Member Functions | |
| SelectionSet | Add (string name, IEnumerable< Element > elements=null, string description="") |
| Creates a new selection set and adds it to the collection. More... | |
| SelectionSet | Add (string name, string elementQueryExpression, string description="") |
| Creates a new selection set and adds it to the collection. More... | |
| bool | Remove (string name) |
| Removes selection set with the specified name from the collection. More... | |
| bool | Remove (SelectionSet selectionSet) |
| Removes the specified selection set from the collection. More... | |
| void | RemoveRange (IEnumerable< SelectionSet > selectionSets) |
| Removes the specified selection sets from the collection. More... | |
 Public Member Functions inherited from Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection | |
| IEnumerator< SelectionSet > | GetEnumerator () |
| SelectionSet | GetSelectionSetByID (SelectionSetID id) |
| Retrieves the selection set with the specified ID. More... | |
| SelectionSet | GetSelectionSetByID (int internalID) |
| Retrieves the selection set with the specified internal ID. More... | |
| SelectionSet | GetSelectionSetByName (string name) |
| Retrieves the selection set with the specified name. More... | |
| bool | ContainsKey (SelectionSetID id) |
| Determines whether the collection contains the selection set with the specified ID. More... | |
| bool | ContainsKey (int internalID) |
| Determines whether the collection contains the selection set with the specified internal ID. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection | |
| readonly SelectionSetCollectionRef | selectionSetsRef |
| readonly Project | project |
| Properties inherited from Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection | |
| int | Count [get] |
| SelectionSet | this[SelectionSetID id] [get] |
| SelectionSet | this[int internalID] [get] |
| Properties inherited from Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection | |
| SelectionSet | this[SelectionSetID id] [get] |
| Retrieves the selection set with the specified ID. More... | |
| SelectionSet | this[int internalID] [get] |
| Retrieves the selection set with the specified selection set internal ID. More... | |
Detailed Description
Member Function Documentation
◆ Add() [1/2]
| SelectionSet Bexel.Api.SelectionSets.SelectionSetCollection.Add | ( | string | name, |
| IEnumerable< Element > | elements = null, |
||
| string | description = "" |
||
| ) |
Creates a new selection set and adds it to the collection.
- Parameters
-
name Name of the selection set to be added. elements Elements of the selection set to be added. description Description of the selection set to be added.
- Returns
- Newly created selection set.
- Exceptions
-
Bexel.Api.InvalidApiArgumentException The specified name is invalid or selection set with the same name already exists within collection.
Implements Bexel.Api.SelectionSets.ISelectionSetCollection.
◆ Add() [2/2]
| SelectionSet Bexel.Api.SelectionSets.SelectionSetCollection.Add | ( | string | name, |
| string | elementQueryExpression, | ||
| string | description = "" |
||
| ) |
Creates a new selection set and adds it to the collection.
- Parameters
-
name Name of the selection set to be added. elementQueryExpression Query expression to retreive elements. description Description of the selection set to be added.
- Returns
- Newly created selection set.
- Exceptions
-
Bexel.Api.InvalidApiArgumentException The specified name or expression is invalid or selection set with the same name already exists within collection.
Implements Bexel.Api.SelectionSets.ISelectionSetCollection.
◆ Remove() [1/2]
| bool Bexel.Api.SelectionSets.SelectionSetCollection.Remove | ( | string | name | ) |
Removes selection set with the specified name from the collection.
- Parameters
-
name Name of the selection set to be removed.
- Returns
- True if remove is successful, False if no such selection set exists within collection.
This action will also delete selection set from the project.
Implements Bexel.Api.SelectionSets.ISelectionSetCollection.
◆ Remove() [2/2]
| bool Bexel.Api.SelectionSets.SelectionSetCollection.Remove | ( | SelectionSet | selectionSet | ) |
Removes the specified selection set from the collection.
- Parameters
-
selectionSet A reference to selection set to be removed.
- Returns
- True if remove is successful, False if no such selection set exists within collection.
This action will also delete selection set from the project. The specified selection set will become invalid API object after removal.
Implements Bexel.Api.SelectionSets.ISelectionSetCollection.
◆ RemoveRange()
| void Bexel.Api.SelectionSets.SelectionSetCollection.RemoveRange | ( | IEnumerable< SelectionSet > | selectionSets | ) |
Removes the specified selection sets from the collection.
- Parameters
-
selectionSets A reference to selection sets to be removed.
This action will also delete selection set from the project. Only selection sets which belong to this collection will be removed. The specified selection sets will become invalid API objects after removal.
Implements Bexel.Api.SelectionSets.ISelectionSetCollection.
