Bexel Manager API Documentation
Bexel.Api.Project Class Reference

Represents a single project, the root of all other objects such as buildings, elements, properties, etc. More...

Inheritance diagram for Bexel.Api.Project:
Bexel.Api.ApiObject IEquatable

Public Member Functions

bool Equals (Project other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
IDisposable BeginBatchChange ()
 Initiates a new batch change operation on the project. More...
 

Static Public Member Functions

static bool operator== (Project left, Project right)
 
static bool operator!= (Project left, Project right)
 

Properties

static Project ActiveProject [get]
 Returns the currently active project, or null if no project is opened. More...
 
override bool IsValid [get]
 
ProjectID ID [get]
 Returns a unique identifier for the project. More...
 
string SuperProjectName [get]
 Returns the name of the super project in which the project resides. More...
 
string VersionName [get]
 Returns the version name of the project. More...
 
string FullName [get]
 Returns the full name of the project. More...
 
string Description [get]
 Returns the description of the project. More...
 
DateTime DateCreated [get]
 Returns the date and time the project was created on. More...
 
DateTime DateModified [get]
 Returns the date and time of the last modification to the project. More...
 
ProjectElementSources Sources [get]
 Returns a collection of all element sources that are contained within the project. More...
 
ProjectBuildings Buildings [get]
 Returns a collection of all buildings that are contained within the project. More...
 
ProjectCategories Categories [get]
 Returns a collection of all categories that are contained within the project. More...
 
ProjectFamilies Families [get]
 Returns a collection of all families that are contained within the project. More...
 
ProjectElements Elements [get]
 Returns a collection of all elements that are contained within the project. More...
 
ProjectElementSystems Systems [get]
 Returns a collection of all systems that are contained within the project. More...
 
ProjectElementRelations Relations [get]
 Returns a collection of all relations that are contained within the project. More...
 
ProjectMaterials Materials [get]
 Returns a collection of all materials that are contained within the project. More...
 
ProjectPropertyDefinition PropertyDefinitions [get]
 Returns a collection of all property definitions that are contained within the project. More...
 
ProjectSelectionSets SelectionSets [get]
 Returns a collection of all selection sets that are contained within the project. More...
 
ProjectCost Cost [get]
 Returns an object that represents all cost information contained within the project. More...
 
IProjectSchedules Schedules [get]
 Returns a collection of all schedules that are contained within the project. More...
 
ProjectFileStorage FileStorage [get]
 Returns an object that represents file storage for storing additional files (e.g. add-in inputs, outputs, etc.) within the project. More...
 
- Properties inherited from Bexel.Api.ApiObject
abstract bool IsValid [get]
 Indicates if the API object is valid or not. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Bexel.Api.ApiObject
virtual void CheckValidity ()
 

Detailed Description

Represents a single project, the root of all other objects such as buildings, elements, properties, etc.

One project may aggregate multiple external resources, such as IFC files.

Member Function Documentation

◆ BeginBatchChange()

IDisposable Bexel.Api.Project.BeginBatchChange ( )

Initiates a new batch change operation on the project.

Returns
A disposable object which represents the current batch change operation. This object should be disposed when batch operation is complete in order to finalize the operation.

Batching should be considered when issuing multiple project changes in order to improve performance.

Property Documentation

◆ ActiveProject

Project Bexel.Api.Project.ActiveProject
staticget

Returns the currently active project, or null if no project is opened.

◆ Buildings

ProjectBuildings Bexel.Api.Project.Buildings
get

Returns a collection of all buildings that are contained within the project.

◆ Categories

ProjectCategories Bexel.Api.Project.Categories
get

Returns a collection of all categories that are contained within the project.

◆ Cost

ProjectCost Bexel.Api.Project.Cost
get

Returns an object that represents all cost information contained within the project.

◆ DateCreated

DateTime Bexel.Api.Project.DateCreated
get

Returns the date and time the project was created on.

◆ DateModified

DateTime Bexel.Api.Project.DateModified
get

Returns the date and time of the last modification to the project.

◆ Description

string Bexel.Api.Project.Description
get

Returns the description of the project.

◆ Elements

ProjectElements Bexel.Api.Project.Elements
get

Returns a collection of all elements that are contained within the project.

◆ Families

ProjectFamilies Bexel.Api.Project.Families
get

Returns a collection of all families that are contained within the project.

◆ FileStorage

ProjectFileStorage Bexel.Api.Project.FileStorage
get

Returns an object that represents file storage for storing additional files (e.g. add-in inputs, outputs, etc.) within the project.

◆ FullName

string Bexel.Api.Project.FullName
get

Returns the full name of the project.

◆ ID

ProjectID Bexel.Api.Project.ID
get

Returns a unique identifier for the project.

◆ Materials

ProjectMaterials Bexel.Api.Project.Materials
get

Returns a collection of all materials that are contained within the project.

◆ PropertyDefinitions

ProjectPropertyDefinition Bexel.Api.Project.PropertyDefinitions
get

Returns a collection of all property definitions that are contained within the project.

◆ Relations

ProjectElementRelations Bexel.Api.Project.Relations
get

Returns a collection of all relations that are contained within the project.

◆ Schedules

IProjectSchedules Bexel.Api.Project.Schedules
get

Returns a collection of all schedules that are contained within the project.

◆ SelectionSets

ProjectSelectionSets Bexel.Api.Project.SelectionSets
get

Returns a collection of all selection sets that are contained within the project.

◆ Sources

ProjectElementSources Bexel.Api.Project.Sources
get

Returns a collection of all element sources that are contained within the project.

◆ SuperProjectName

string Bexel.Api.Project.SuperProjectName
get

Returns the name of the super project in which the project resides.

◆ Systems

ProjectElementSystems Bexel.Api.Project.Systems
get

Returns a collection of all systems that are contained within the project.

◆ VersionName

string Bexel.Api.Project.VersionName
get

Returns the version name of the project.