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

More...

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

Public Member Functions

IEnumerator< SelectionSetFolderGetEnumerator ()
 
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...
 

Protected Attributes

readonly SelectionSetCollectionRef selectionSetsRef
 
readonly Project project
 

Properties

int Count [get]
 
SelectionSetFolder this[SelectionSetFolderID id] [get]
 
SelectionSetFolder this[int internalID] [get]
 
- 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

Member Function Documentation

◆ ContainsKey() [1/2]

bool Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.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.

Implements Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.

◆ ContainsKey() [2/2]

bool Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.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.

Implements Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.

◆ GetSelectionSetFolderByID() [1/2]

SelectionSetFolder Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.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.

Implements Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.

◆ GetSelectionSetFolderByID() [2/2]

SelectionSetFolder Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.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.

Implements Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.

◆ GetSelectionSetFolderByName()

SelectionSetFolder Bexel.Api.SelectionSets.ReadOnlySelectionSetFolderCollection.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.

Implements Bexel.Api.SelectionSets.IReadOnlySelectionSetFolderCollection.