Represents a collection of all selection sets within the Bexel.Api.Project. More...

Inheritance diagram for Bexel.Api.ProjectSelectionSets:

Public Member Functions
IEnumerator< SelectionSet >	GetEnumerator ()

IEnumerable< SelectionSetFolder >	GetAllFolders ()
	Returns a collection of all selection sets folders that are contained within the project. More...

IEnumerable< SelectionSet >	GetAllSelectionSets ()
	Returns a collection of all selection sets that are contained within the project. More...

SelectionSet	Add (string name, IEnumerable< Element > elements=null, string description="", SelectionSetFolder parent=null)
	Creates a new selection set and adds it to the specified parent's collection. More...

SelectionSet	Add (string name, string elementQueryExpression, string description="", SelectionSetFolder parent=null)
	Creates a new selection set and adds it to the specified parent's collection. More...

SelectionSetFolder	AddFolder (string name, string description="", SelectionSetFolder parent=null)
	Creates a new selection set folder and adds it to the specified parent's collection. More...

void	Remove (SelectionSet selectionSet)
	Removes the specified selection set from the project. More...

void	Remove (SelectionSetFolder folder)
	Removes the specified selection set folder from the project. More...

void	RemoveRange (IEnumerable< SelectionSet > selectionSets)
	Removes the specified selection sets from the project. More...

void	RemoveRange (IEnumerable< SelectionSetFolder > folders)
	Removes the specified selection set folders from the project. More...

Properties
EventHandler< SelectionSetsChangedEventArgs >	Changed
	Occurs when selection sets are modified. More...

SelectionSetFolder	Root `[get]`
	Returns the root selection set folder. More...

Detailed Description

Represents a collection of all selection sets within the Bexel.Api.Project.

Member Function Documentation

◆ Add() [1/2]

SelectionSet Bexel.Api.ProjectSelectionSets.Add	(	string	name,
		IEnumerable< Element >	elements = `null`,
		string	description = `""`,
		SelectionSetFolder	parent = `null`
	)

Creates a new selection set and adds it to the specified parent's collection.

Parameters

name	Name of the selection set to be added.
elements	Elements of the selection set to be added.
description	Description of the selection set to be added.
parent	Parent folder in which the selection set should be added. If no parent is specified, root folder is assumed.

Returns: Newly created selection set.

Exceptions

Bexel.Api.InvalidApiArgumentException The specified name is invalid or selection set with the same name already exists within collection.

◆ Add() [2/2]

SelectionSet Bexel.Api.ProjectSelectionSets.Add	(	string	name,
		string	elementQueryExpression,
		string	description = `""`,
		SelectionSetFolder	parent = `null`
	)

Creates a new selection set and adds it to the specified parent's collection.

Parameters

name	Name of the selection set to be added.
elementQueryExpression	Query expression to retreive elements.
description	Description of the selection set to be added.
parent	Parent folder in which the selection set should be added. If no parent is specified, root folder is assumed.

Returns: Newly created selection set.

Exceptions

Bexel.Api.InvalidApiArgumentException The specified name or expression is invalid or selection set with the same name already exists within collection.

◆ AddFolder()

SelectionSetFolder Bexel.Api.ProjectSelectionSets.AddFolder	(	string	name,
		string	description = `""`,
		SelectionSetFolder	parent = `null`
	)

Creates a new selection set folder and adds it to the specified parent's collection.

Parameters

name	Name of the selection set folder to be added.
description	Description of the selection set folder to be added.
parent	Parent folder in which the selection set folder should be added. If no parent is specified, root folder is assumed.

Returns: Newly created selection set folder.

Exceptions

Bexel.Api.InvalidApiArgumentException The specified name is invalid or selection set folder with the same name already exists within collection.

◆ GetAllFolders()

IEnumerable<SelectionSetFolder> Bexel.Api.ProjectSelectionSets.GetAllFolders ( )

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

◆ GetAllSelectionSets()

IEnumerable<SelectionSet> Bexel.Api.ProjectSelectionSets.GetAllSelectionSets ( )

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

◆ Remove() [1/2]

void Bexel.Api.ProjectSelectionSets.Remove ( SelectionSet selectionSet )

Removes the specified selection set from the project.

Parameters

selectionSet A reference to selection set to be removed.

Returns: True if remove is successful, False if no such selection set exists within collection.

The specified selection set will become invalid API object after removal.

◆ Remove() [2/2]

void Bexel.Api.ProjectSelectionSets.Remove ( SelectionSetFolder folder )

Removes the specified selection set folder from the project.

Parameters

folder A reference to selection set folder to be removed.

Returns: True if remove is successful, False if no such selection set folder exists within collection.

The specified selection set folder will become invalid API object after removal.

◆ RemoveRange() [1/2]

void Bexel.Api.ProjectSelectionSets.RemoveRange ( IEnumerable< SelectionSet > selectionSets )

Removes the specified selection sets from the project.

Parameters

selectionSets A reference to selection sets to be removed.

The specified selection sets will become invalid API objects after removal.

◆ RemoveRange() [2/2]

void Bexel.Api.ProjectSelectionSets.RemoveRange ( IEnumerable< SelectionSetFolder > folders )

Removes the specified selection set folders from the project.

Parameters

folders A reference to selection set folders to be removed.

The specified selection set folders will become invalid API objects after removal.

Property Documentation

◆ Changed

EventHandler<SelectionSetsChangedEventArgs> Bexel.Api.ProjectSelectionSets.Changed

addremove

Occurs when selection sets are modified.

◆ Root

SelectionSetFolder Bexel.Api.ProjectSelectionSets.Root

get

Returns the root selection set folder.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AddFolder()

◆ GetAllFolders()

◆ GetAllSelectionSets()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ RemoveRange() [1/2]

◆ RemoveRange() [2/2]

Property Documentation

◆ Changed

◆ Root