Bexel.Api.SelectionSets.SelectionSet Class Reference

Represents a group (collection) of Bexel.Api.Elements. More...

Inheritance diagram for Bexel.Api.SelectionSets.SelectionSet:

Public Member Functions
bool	Equals (SelectionSet other)
override bool	Equals (object obj)
override int	GetHashCode ()
void	Move (SelectionSetFolder target)
	Moves selection set to the specified target folder. More...
void	SetLinkRule (string elementQueryExpression)
	Sets the element query link rule. This will replace all existing link rules on selection set. More...
string	GetElementQueryExpression ()
	Returns an element query expression. More...
void	ClearAllLinkRules ()
	Clears all link rules on selection set. More...

Static Public Member Functions
static bool	operator== (SelectionSet left, SelectionSet right)
static bool	operator!= (SelectionSet left, SelectionSet right)

Properties
override bool	IsValid [get]
Project	Project [get]
	Returns the project in which the selection set resides. More...
SelectionSetID	ID [get]
	Returns a unique identifier for the selection set within a single project. More...
string	Name [get, set]
	Gets or sets the name of the selection set. More...
string	Description [get, set]
	Gets or sets the description of the selection set. More...
SelectionSetFolder	Parent [get]
	Returns the parent folder of the selection set. More...
bool	HasLinkRules [get]
	Determines whether the selection set has any link rules specified. This excludes predefined rules such as Included/Excluded elements. More...
bool	HasNonElementQueryLinkRules [get]
	Determines whether the selection set has any link rules specified other than element query rules. This excludes predefined rules such as Included/Excluded elements. More...
bool	HasFixedElements [get]
	Determines whether the selection set has any predefined rules such as Included/Excluded elements. More...
int	LinkRulesCount [get]
	Returns a number of link rules specified on the selection set. This excludes predefined rules such as Included/Excluded elements. More...
SelectionSetElements	Elements [get]
	Returns a collection of all elements that are contained within the selection set. 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 group (collection) of Bexel.Api.Elements.

Member Function Documentation

ClearAllLinkRules()

void Bexel.Api.SelectionSets.SelectionSet.ClearAllLinkRules

(

)

Clears all link rules on selection set.

This will clear all link rules including predefined ones such as Included/Excluded elements, effectively making selection set empty.

GetElementQueryExpression()

string Bexel.Api.SelectionSets.SelectionSet.GetElementQueryExpression

(

)

Returns an element query expression.

Returns

An element query expression, null if no element query-based link rules are found.

Move()

void Bexel.Api.SelectionSets.SelectionSet.Move

(

SelectionSetFolder

target

)

Moves selection set to the specified target folder.

Parameters

target

A reference to the target selection set folder.

Exceptions

Bexel.Api.InvalidApiOperationException

The specified target folder already contains selection set with the same name.

If the target folder is the same as current parent folder, no action will take place.

SetLinkRule()

void Bexel.Api.SelectionSets.SelectionSet.SetLinkRule

(

string

elementQueryExpression

)

Sets the element query link rule. This will replace all existing link rules on selection set.

Parameters

elementQueryExpression

Query expression to retreive elements.

Exceptions

Bexel.Api.InvalidApiArgumentException

The specified expression is invalid.

Property Documentation

Description

string Bexel.Api.SelectionSets.SelectionSet.Description

getset

Gets or sets the description of the selection set.

Elements

SelectionSetElements Bexel.Api.SelectionSets.SelectionSet.Elements

get

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

HasFixedElements

bool Bexel.Api.SelectionSets.SelectionSet.HasFixedElements

get

Determines whether the selection set has any predefined rules such as Included/Excluded elements.

HasLinkRules

bool Bexel.Api.SelectionSets.SelectionSet.HasLinkRules

get

Determines whether the selection set has any link rules specified. This excludes predefined rules such as Included/Excluded elements.

HasNonElementQueryLinkRules

bool Bexel.Api.SelectionSets.SelectionSet.HasNonElementQueryLinkRules

get

Determines whether the selection set has any link rules specified other than element query rules. This excludes predefined rules such as Included/Excluded elements.

ID

SelectionSetID Bexel.Api.SelectionSets.SelectionSet.ID

get

Returns a unique identifier for the selection set within a single project.

LinkRulesCount

int Bexel.Api.SelectionSets.SelectionSet.LinkRulesCount

get

Returns a number of link rules specified on the selection set. This excludes predefined rules such as Included/Excluded elements.

Name

string Bexel.Api.SelectionSets.SelectionSet.Name

getset

Gets or sets the name of the selection set.

Exceptions

Bexel.Api.InvalidApiArgumentException

The specified name is invalid or selection set with the same name already exists within parent folder.

Parent

SelectionSetFolder Bexel.Api.SelectionSets.SelectionSet.Parent

get

Returns the parent folder of the selection set.

Project

Project Bexel.Api.SelectionSets.SelectionSet.Project

get

Returns the project in which the selection set resides.