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

Inheritance diagram for Bexel.Api.SelectionSets.SelectionSetFolder:

Public Member Functions
bool	Equals (SelectionSetFolder other)

void	Move (SelectionSetFolder target)
	Moves selection set folder to the specified target folder. More...

IEnumerable< SelectionSetFolder >	GetAllFolders ()
	Returns a collection of all selection sets folders that are contained within the selection set folder and it's subfolders. More...

IEnumerable< SelectionSetFolder >	GetAllFoldersIncludingSelf ()
	Returns a collection of all selection sets folders that are contained within the selection set folder and it's subfolders, including itself. More...

IEnumerable< SelectionSet >	GetAllSelectionSets ()
	Returns a collection of all selection sets that are contained within the selection set folder and it's subfolders. More...

override bool	Equals (object obj)

override int	GetHashCode ()

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

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

Properties
override bool	IsValid `[get]`

bool	IsRoot `[get]`
	Indicates if the folder is (project) root folder. More...

Project	Project `[get]`
	Returns the project in which the selection set folder resides. More...

SelectionSetFolderID	ID `[get]`
	Returns a unique identifier for the selection set folder within a single project. More...

string	Name `[get, set]`
	Gets or sets the name of the selection set folder. More...

string	Description `[get, set]`
	Gets or sets the description of the selection set folder. More...

SelectionSetFolder	Parent `[get]`
	Returns the parent folder of the selection set folder. More...

SelectionSetFolderElements	Elements `[get]`
	Returns a collection of all elements that are contained within the selection set folder. More...

ISelectionSetFolderCollection	Folders `[get]`
	Returns a collection of all subfolders that are contained within the selection set folder. More...

ISelectionSetCollection	SelectionSets `[get]`
	Returns a collection of all selection sets that are contained within the selection set folder. 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.SelectionSets.SelectionSets.

Member Function Documentation

◆ GetAllFolders()

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

Returns a collection of all selection sets folders that are contained within the selection set folder and it's subfolders.

◆ GetAllFoldersIncludingSelf()

IEnumerable<SelectionSetFolder> Bexel.Api.SelectionSets.SelectionSetFolder.GetAllFoldersIncludingSelf ( )

Returns a collection of all selection sets folders that are contained within the selection set folder and it's subfolders, including itself.

◆ GetAllSelectionSets()

IEnumerable<SelectionSet> Bexel.Api.SelectionSets.SelectionSetFolder.GetAllSelectionSets ( )

Returns a collection of all selection sets that are contained within the selection set folder and it's subfolders.

◆ Move()

void Bexel.Api.SelectionSets.SelectionSetFolder.Move ( SelectionSetFolder target )

Moves selection set folder 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 folder with the same name.

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

Property Documentation

◆ Description

string Bexel.Api.SelectionSets.SelectionSetFolder.Description

getset

Gets or sets the description of the selection set folder.

◆ Elements

SelectionSetFolderElements Bexel.Api.SelectionSets.SelectionSetFolder.Elements

get

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

◆ Folders

ISelectionSetFolderCollection Bexel.Api.SelectionSets.SelectionSetFolder.Folders

get

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

◆ ID

SelectionSetFolderID Bexel.Api.SelectionSets.SelectionSetFolder.ID

get

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

◆ IsRoot

bool Bexel.Api.SelectionSets.SelectionSetFolder.IsRoot

get

Indicates if the folder is (project) root folder.

◆ Name

string Bexel.Api.SelectionSets.SelectionSetFolder.Name

getset

Gets or sets the name of the selection set folder.

Exceptions

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

◆ Parent

SelectionSetFolder Bexel.Api.SelectionSets.SelectionSetFolder.Parent

get

Returns the parent folder of the selection set folder.

◆ Project

Project Bexel.Api.SelectionSets.SelectionSetFolder.Project

get

Returns the project in which the selection set folder resides.

◆ SelectionSets

ISelectionSetCollection Bexel.Api.SelectionSets.SelectionSetFolder.SelectionSets

get

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

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members