Bexel Manager API Documentation
Bexel.Api.Scheduling.TaskLinkRules Class Reference

Represents a collection of task link rules. Task link rules define how the task is associated with the elements. More...

Public Member Functions

IEnumerable< SelectionSetFolderGetLinkedSelectionSetFolders ()
 Returns all selection set folders that are linked to the task. More...
 
IEnumerable< SelectionSetGetLinkedSelectionSets ()
 Returns all selection sets that are linked to the task. More...
 
IEnumerable< ElementGetLinkedElements ()
 Returns all elements from all link rules defined on the task. More...
 
void SetLinkRule (SelectionSetFolder selectionSetFolder)
 Sets the specified selection set folder as the link rule. This will replace all existing link rules on the task. More...
 
void SetLinkRule (IEnumerable< SelectionSetFolder > selectionSetFolders)
 Sets the specified selection set folders as the link rule. This will replace all existing link rules on the task. More...
 
void SetLinkRule (IEnumerable< SelectionSet > selectionSets)
 Sets the specified selection sets as the link rule. This will replace all existing link rules on the task. More...
 
void SetLinkRule (SelectionSet selectionSet)
 Sets the specified selection set as the link rule. This will replace all existing link rules on the task. More...
 
void SetLinkRule (IEnumerable< Element > elements)
 Sets the specified elements as the link rule. This will replace all existing link rules on the task. More...
 
void Clear ()
 Clears all link rules on the task. More...
 

Properties

bool HasLinkRules [get]
 Returns a value indicating whether the task has any link rule assigned. More...
 

Detailed Description

Represents a collection of task link rules. Task link rules define how the task is associated with the elements.

Member Function Documentation

◆ Clear()

void Bexel.Api.Scheduling.TaskLinkRules.Clear ( )

Clears all link rules on the task.

Link rule changes will be applied after the schedule update.

◆ GetLinkedElements()

IEnumerable<Element> Bexel.Api.Scheduling.TaskLinkRules.GetLinkedElements ( )

Returns all elements from all link rules defined on the task.

◆ GetLinkedSelectionSetFolders()

IEnumerable<SelectionSetFolder> Bexel.Api.Scheduling.TaskLinkRules.GetLinkedSelectionSetFolders ( )

Returns all selection set folders that are linked to the task.

◆ GetLinkedSelectionSets()

IEnumerable<SelectionSet> Bexel.Api.Scheduling.TaskLinkRules.GetLinkedSelectionSets ( )

Returns all selection sets that are linked to the task.

◆ SetLinkRule() [1/5]

void Bexel.Api.Scheduling.TaskLinkRules.SetLinkRule ( SelectionSetFolder  selectionSetFolder)

Sets the specified selection set folder as the link rule. This will replace all existing link rules on the task.

Parameters
selectionSetFolderSelection set folder to link to the task.

Link rule changes will be applied after the schedule update.

◆ SetLinkRule() [2/5]

void Bexel.Api.Scheduling.TaskLinkRules.SetLinkRule ( IEnumerable< SelectionSetFolder selectionSetFolders)

Sets the specified selection set folders as the link rule. This will replace all existing link rules on the task.

Parameters
selectionSetFoldersSelection set folders to link to the task.

Link rule changes will be applied after the schedule update.

◆ SetLinkRule() [3/5]

void Bexel.Api.Scheduling.TaskLinkRules.SetLinkRule ( IEnumerable< SelectionSet selectionSets)

Sets the specified selection sets as the link rule. This will replace all existing link rules on the task.

Parameters
selectionSetsSelection sets to link to the task.

Link rule changes will be applied after the schedule update.

◆ SetLinkRule() [4/5]

void Bexel.Api.Scheduling.TaskLinkRules.SetLinkRule ( SelectionSet  selectionSet)

Sets the specified selection set as the link rule. This will replace all existing link rules on the task.

Parameters
selectionSetSelection set to link to the task.

Link rule changes will be applied after the schedule update.

◆ SetLinkRule() [5/5]

void Bexel.Api.Scheduling.TaskLinkRules.SetLinkRule ( IEnumerable< Element elements)

Sets the specified elements as the link rule. This will replace all existing link rules on the task.

Parameters
elementsElements to link to the task.

Link rule changes will be applied after the schedule update.

Property Documentation

◆ HasLinkRules

bool Bexel.Api.Scheduling.TaskLinkRules.HasLinkRules
get

Returns a value indicating whether the task has any link rule assigned.