Bexel Manager API
Public Member Functions | Properties | List of all members
Bexel.Api.IReadOnlyElementCollection Interface Reference

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

Inheritance diagram for Bexel.Api.IReadOnlyElementCollection:
Bexel.Api.ReadOnlyElementCollection Bexel.Api.BuildingElements Bexel.Api.BuildingStoreyElements Bexel.Api.CategoryElements Bexel.Api.ElementSourceElements Bexel.Api.ElementSystemElements Bexel.Api.FamilyElements Bexel.Api.ProjectElements Bexel.Api.SelectedElementsCollection Bexel.Api.SelectionSets.SelectionSetElements Bexel.Api.SelectionSets.SelectionSetFolderElements

Public Member Functions

Element GetElementByID (ElementID id)
 Retrieves the element with the specified ID. More...
 
Element GetElementByID (int internalID)
 Retrieves the element with the specified internal ID. More...
 
Element GetElementByID (string uniqueID)
 Retrieves the element with the specified unique ID. More...
 
Element GetElementByID (Guid uniqueID)
 Retrieves the element with the specified unique ID. More...
 
IEnumerable< Element > GetElementsByID (string uniqueID)
 Retrieves the elements with the specified unique ID. More...
 
IEnumerable< Element > GetElementsByID (Guid uniqueID)
 Retrieves the elements with the specified unique ID. More...
 
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

Element this[ElementID id] [get]
 Retrieves the element with the specified ID. More...
 
Element this[int internalID] [get]
 Retrieves the element with the specified internal ID. More...
 

Detailed Description

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

Member Function Documentation

◆ ContainsKey() [1/2]

bool Bexel.Api.IReadOnlyElementCollection.ContainsKey ( ElementID  id)

Determines whether the collection contains the element with the specified ID.

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

Implemented in Bexel.Api.ReadOnlyElementCollection.

◆ ContainsKey() [2/2]

bool Bexel.Api.IReadOnlyElementCollection.ContainsKey ( int  internalID)

Determines whether the collection contains the element with the specified internal ID.

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

Implemented in Bexel.Api.ReadOnlyElementCollection.

◆ GetElementByID() [1/4]

Element Bexel.Api.IReadOnlyElementCollection.GetElementByID ( ElementID  id)

Retrieves the element with the specified ID.

Parameters
idID of the element.
Returns
An element with the specified ID, null if no such element exists within the collection.

Implemented in Bexel.Api.ReadOnlyElementCollection.

◆ GetElementByID() [2/4]

Element Bexel.Api.IReadOnlyElementCollection.GetElementByID ( int  internalID)

Retrieves the element with the specified internal ID.

Parameters
internalIDInternal ID of the element.
Returns
An element with the specified internal ID, null if no such element exists within the collection.

Implemented in Bexel.Api.ReadOnlyElementCollection.

◆ GetElementByID() [3/4]

Element Bexel.Api.IReadOnlyElementCollection.GetElementByID ( string  uniqueID)

Retrieves the element with the specified unique ID.

Parameters
uniqueIDUnique ID of the element.
Returns
An element with the specified unique ID, null if no such element exists within the collection.

If multiple elements with the same unique ID exist, the first element will be returned.

Exceptions
System.ArgumentNullExceptionuniqueID is null.
System.FormatExceptionuniqueID is not a valid GUID format.

Implemented in Bexel.Api.ReadOnlyElementCollection.

◆ GetElementByID() [4/4]

Element Bexel.Api.IReadOnlyElementCollection.GetElementByID ( Guid  uniqueID)

Retrieves the element with the specified unique ID.

Parameters
uniqueIDUnique ID of the element.
Returns
An element with the specified unique ID, null if no such element exists within the collection.

If multiple elements with the same unique ID exist, the first element will be returned.

Implemented in Bexel.Api.ReadOnlyElementCollection.

◆ GetElementsByID() [1/2]

IEnumerable<Element> Bexel.Api.IReadOnlyElementCollection.GetElementsByID ( string  uniqueID)

Retrieves the elements with the specified unique ID.

Parameters
uniqueIDUnique ID of the element.
Returns
All elements with the specified unique ID, empty collection if no such elements exist within the collection.

Implemented in Bexel.Api.ReadOnlyElementCollection.

◆ GetElementsByID() [2/2]

IEnumerable<Element> Bexel.Api.IReadOnlyElementCollection.GetElementsByID ( Guid  uniqueID)

Retrieves the elements with the specified unique ID.

Parameters
uniqueIDUnique ID of the element.
Returns
All elements with the specified unique ID, empty collection if no such elements exist within the collection.

Implemented in Bexel.Api.ReadOnlyElementCollection.

Property Documentation

◆ this[ElementID id]

Element Bexel.Api.IReadOnlyElementCollection.this[ElementID id]
get

Retrieves the element with the specified ID.

Parameters
idID of the element.
Returns
An element with the specified ID.
Exceptions
System.Collections.Generic.KeyNotFoundExceptionNo element with the specified ID exists within the collection.

◆ this[int internalID]

Element Bexel.Api.IReadOnlyElementCollection.this[int internalID]
get

Retrieves the element with the specified internal ID.

Parameters
internalIDInternal ID of the element.
Returns
An element with the specified internal ID.
Exceptions
System.Collections.Generic.KeyNotFoundExceptionNo element with the specified internal ID exists within the collection.