Bexel Manager API Documentation
Bexel.Api.Family Class Reference

Represents a family (type) of an Bexel.Api.Element. More...

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

Public Member Functions

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

Static Public Member Functions

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

Properties

override bool IsValid [get]
 
Project Project [get]
 Returns the project in which the family resides. More...
 
FamilyID ID [get]
 Returns a unique identifier for the family within a single project. More...
 
string Name [get]
 Returns the name of the family. More...
 
Category Category [get]
 Returns the category of the family. More...
 
FamilyElements Elements [get]
 Returns a collection of all elements that are contained within the family. More...
 
FamilyMaterials Materials [get]
 Returns a collection of all materials that are contained within the family. More...
 
FamilyMaterialLayers Layers [get]
 Returns a collection of all material layers that are contained within the family. More...
 
FamilyProperties Properties [get]
 Returns a collection of all properties that are contained within the family. 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 family (type) of an Bexel.Api.Element.

Property Documentation

◆ Category

Category Bexel.Api.Family.Category
get

Returns the category of the family.

◆ Elements

FamilyElements Bexel.Api.Family.Elements
get

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

◆ ID

FamilyID Bexel.Api.Family.ID
get

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

◆ Layers

FamilyMaterialLayers Bexel.Api.Family.Layers
get

Returns a collection of all material layers that are contained within the family.

◆ Materials

FamilyMaterials Bexel.Api.Family.Materials
get

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

◆ Name

string Bexel.Api.Family.Name
get

Returns the name of the family.

◆ Project

Project Bexel.Api.Family.Project
get

Returns the project in which the family resides.

◆ Properties

FamilyProperties Bexel.Api.Family.Properties
get

Returns a collection of all properties that are contained within the family.