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

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

Inheritance diagram for Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection:
IReadOnlyCollection Bexel.Api.SelectionSets.ISelectionSetFolderCollection Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection Bexel.Api.SelectionSets.SelectionSetFolderCollection Bexel.Api.SelectionSets.SelectionSetFolderCollection

Public Member Functions

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

Properties

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 read-only collection of Bexel.Api.SelectionSets.SelectionSetFolders.

Member Function Documentation

◆ ContainsKey() [1/2]

bool Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.ContainsKey ( SelectionSetFolderID  id)

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

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

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.

◆ ContainsKey() [2/2]

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

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

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

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.

◆ GetSelectionSetFolderByID() [1/2]

SelectionSetFolder Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.GetSelectionSetFolderByID ( SelectionSetFolderID  id)

Retrieves the selection set folder with the specified ID.

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

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.

◆ GetSelectionSetFolderByID() [2/2]

SelectionSetFolder Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.GetSelectionSetFolderByID ( int  internalID)

Retrieves the selection set folder with the specified internal ID.

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

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.

◆ GetSelectionSetFolderByName()

SelectionSetFolder Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.GetSelectionSetFolderByName ( string  name)

Retrieves the selection set folder with the specified name.

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

Implemented in Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.

Property Documentation

◆ this[int internalID]

SelectionSetFolder Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.this[int internalID]
get

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

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

◆ this[SelectionSetFolderID id]

SelectionSetFolder Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.this[SelectionSetFolderID id]
get

Retrieves the selection set folder with the specified ID.

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