Bexel Manager API Documentation
Bexel.Api.SelectionSets.SelectionSetElements Class Reference

Represents a collection of elements within the Bexel.Api.SelectionSets.SelectionSet. More...

Inheritance diagram for Bexel.Api.SelectionSets.SelectionSetElements:
Bexel.Api.ReadOnlyElementCollection< TElement > Bexel.Api.IReadOnlyElementCollection< TElement > IReadOnlyCollection

Public Member Functions

void Add (Element element)
 Adds the specified element to the selection set. More...
 
void AddRange (IEnumerable< Element > elements)
 Adds the specified elements to the selection set. More...
 
void Remove (Element element)
 Removes the specified element from the selection set. More...
 
void Remove (int internalID)
 Removes the element with the specified internal ID from the selection set. More...
 
void RemoveRange (IEnumerable< Element > elements)
 Removes the specified elements from the selection set. More...
 
void RemoveRange (IEnumerable< int > internalIDs)
 Removes the elements with the specified internal ID from the selection set. More...
 
- Public Member Functions inherited from Bexel.Api.ReadOnlyElementCollection< TElement >
TElement GetElementByID (ElementID id)
 Retrieves the element with the specified ID. More...
 
TElement GetElementByID (int internalID)
 Retrieves the element with the specified internal ID. More...
 
TElement GetElementByID (string uniqueID)
 Retrieves the element with the specified unique ID. More...
 
TElement GetElementByID (Guid uniqueID)
 Retrieves the element with the specified unique ID. More...
 
IEnumerable< TElement > GetElementsByID (string uniqueID)
 Retrieves the elements with the specified unique ID. More...
 
IEnumerable< TElement > GetElementsByID (Guid uniqueID)
 Retrieves the elements with the specified unique ID. More...
 
IEnumerator< TElement > GetEnumerator ()
 
bool ContainsKey (ElementID id)
 Determines whether the collection contains the element with the specified ID. More...
 
bool ContainsKey (int internalID)
 Determines whether the collection contains the element with the specified internal ID. More...
 

Properties

override Project Project [get]
 
override IReadOnlyDictionary< int, ProjectInformation.Data.Element > ElementCollectionRef [get]
 
- Properties inherited from Bexel.Api.ReadOnlyElementCollection< TElement >
abstract Project Project [get]
 
abstract IReadOnlyDictionary< int, ElementRef > ElementCollectionRef [get]
 
int Count [get]
 
TElement this[ElementID id] [get]
 
TElement this[int internalID] [get]
 
- Properties inherited from Bexel.Api.IReadOnlyElementCollection< TElement >
TElement this[ElementID id] [get]
 Retrieves the element with the specified ID. More...
 
TElement this[int internalID] [get]
 Retrieves the element with the specified internal ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Bexel.Api.ReadOnlyElementCollection< TElement >
abstract TElement Create (ElementRef elementRef)
 
override Element Create (ElementRef elementRef)
 

Detailed Description

Represents a collection of elements within the Bexel.Api.SelectionSets.SelectionSet.

Member Function Documentation

◆ Add()

void Bexel.Api.SelectionSets.SelectionSetElements.Add ( Element  element)

Adds the specified element to the selection set.

Parameters
elementElement to be added to selection set.

If the specified element is already present in selection set, no action will take place.

◆ AddRange()

void Bexel.Api.SelectionSets.SelectionSetElements.AddRange ( IEnumerable< Element elements)

Adds the specified elements to the selection set.

Parameters
elementsElements to be added to selection set.

Elements which are already present in selection set will be skipped.

◆ Remove() [1/2]

void Bexel.Api.SelectionSets.SelectionSetElements.Remove ( Element  element)

Removes the specified element from the selection set.

Parameters
elementElement to be removed from selection set.

If the specified element is not present in selection set, no action will take place.

◆ Remove() [2/2]

void Bexel.Api.SelectionSets.SelectionSetElements.Remove ( int  internalID)

Removes the element with the specified internal ID from the selection set.

Parameters
internalIDInternal ID of the element to be removed from selection set.

If the element with the specified internal ID is already present in selection set, no action will take place.

◆ RemoveRange() [1/2]

void Bexel.Api.SelectionSets.SelectionSetElements.RemoveRange ( IEnumerable< Element elements)

Removes the specified elements from the selection set.

Parameters
elementsElements to be removed from selection set.

Elements which are not present in selection set will be skipped.

◆ RemoveRange() [2/2]

void Bexel.Api.SelectionSets.SelectionSetElements.RemoveRange ( IEnumerable< int >  internalIDs)

Removes the elements with the specified internal ID from the selection set.

Parameters
internalIDsInternal ID of the elements to be removed from selection set.

Internal IDs of the elements which are not present in selection set will be skipped.