Bexel Manager API Documentation
Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection Interface Reference

Represents a read-only collection of Bexel.Api.SelectionSets.SelectionSets. More...

Inheritance diagram for Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection:
IReadOnlyCollection Bexel.Api.SelectionSets.ISelectionSetCollection Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection Bexel.Api.SelectionSets.SelectionSetCollection Bexel.Api.SelectionSets.SelectionSetCollection

Public Member Functions

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...
 

Properties

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

Represents a read-only collection of Bexel.Api.SelectionSets.SelectionSets.

Member Function Documentation

◆ ContainsKey() [1/2]

bool Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection.ContainsKey ( SelectionSetID  id)

Determines whether the collection contains the selection set with the specified ID.

Parameters
idID of the selection set.
Returns
True if selection set with the specified ID exists, False otherwise.

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection.

◆ ContainsKey() [2/2]

bool Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection.ContainsKey ( int  internalID)

Determines whether the collection contains the selection set with the specified internal ID.

Parameters
internalIDInternal ID of the selection set.
Returns
True if selection set with the specified internal ID exists, False otherwise.

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection.

◆ GetSelectionSetByID() [1/2]

SelectionSet Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection.GetSelectionSetByID ( SelectionSetID  id)

Retrieves the selection set with the specified ID.

Parameters
idID of the selection set.
Returns
A selection set with the specified ID, null if no such selection set exists within the collection.

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection.

◆ GetSelectionSetByID() [2/2]

SelectionSet Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection.GetSelectionSetByID ( int  internalID)

Retrieves the selection set with the specified internal ID.

Parameters
internalIDInternal ID of the selection set.
Returns
A selection set with the specified internal ID, null if no such selection set exists within the collection.

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection.

◆ GetSelectionSetByName()

SelectionSet Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection.GetSelectionSetByName ( string  name)

Retrieves the selection set with the specified name.

Parameters
nameThe name of the selection set.
Returns
A selection set with the specified name, null if no such selection set exists within the collection.

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetCollection.

Property Documentation

◆ this[int internalID]

SelectionSet Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection.this[int internalID]
get

Retrieves the selection set with the specified selection set internal ID.

Parameters
internalIDInternal ID of the selection set.
Returns
Selection set with the specified internal ID.
Exceptions
System.Collections.Generic.KeyNotFoundExceptionNo selection set with the specified internal ID exists within the collection.

◆ this[SelectionSetID id]

SelectionSet Bexel.Api.SelectionSets.IReadOnlySelectionSetCollection.this[SelectionSetID id]
get

Retrieves the selection set with the specified ID.

Parameters
idID of the selection set.
Returns
Selection set with the specified ID.
Exceptions
System.Collections.Generic.KeyNotFoundExceptionNo selection set with the specified ID exists within the collection.