Bexel Manager API Documentation
Bexel.Api.Category Class Reference

Represents an Bexel.Api.Element category, such as Wall or Beam. More...

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

Public Member Functions

bool Equals (Category other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

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

Properties

override bool IsValid [get]
 
Project Project [get]
 Returns the project in which the category resides. More...
 
CategoryID ID [get]
 Returns a unique identifier for the category within a single project. More...
 
CategoryType Type [get]
 Returns the type of the category. More...
 
string Name [get]
 Returns the name of the category. More...
 
string NamePlural [get]
 Returns the name of the category in plural form. More...
 
CategoryFamilies Families [get]
 Returns a collection of all families that are contained within the category. More...
 
CategoryElements Elements [get]
 Returns a collection of all elements that are contained within the category. 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 an Bexel.Api.Element category, such as Wall or Beam.

Property Documentation

◆ Elements

CategoryElements Bexel.Api.Category.Elements
get

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

◆ Families

CategoryFamilies Bexel.Api.Category.Families
get

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

◆ ID

CategoryID Bexel.Api.Category.ID
get

Returns a unique identifier for the category within a single project.

◆ Name

string Bexel.Api.Category.Name
get

Returns the name of the category.

◆ NamePlural

string Bexel.Api.Category.NamePlural
get

Returns the name of the category in plural form.

◆ Project

Project Bexel.Api.Category.Project
get

Returns the project in which the category resides.

◆ Type

CategoryType Bexel.Api.Category.Type
get

Returns the type of the category.