Class Selection

Provides a range of collections containing the TOM objects that are currently selected in the TreeView. Each collection is statically typed, making it very easy to work with the objects in the collection. A handful of convenient methods for adding, deleting, duplicating and changing multiple object's properties at once are also provided.

If one or more Display Folders are selected, their child objects are also considered selected.

Additionally, a range of properties have been provided, to give some overall information about the selection.

Inheritance

object

NamedObjectEditableCollection<ITabularNamedObject>

Selection

Implements

IEnumerable<ITabularNamedObject>

IEnumerable

Inherited Members

NamedObjectEditableCollection<ITabularNamedObject>.ForEach(Action<ITabularNamedObject>)

NamedObjectEditableCollection<ITabularNamedObject>.Where(Func<ITabularNamedObject, bool>)

NamedObjectEditableCollection<ITabularNamedObject>.GetEnumerator()

NamedObjectEditableCollection<ITabularNamedObject>.ReplaceFolder(string, string, Culture)

NamedObjectEditableCollection<ITabularNamedObject>.ReplaceFolder(string, string)

NamedObjectEditableCollection<ITabularNamedObject>.ShowInPerspective(string)

NamedObjectEditableCollection<ITabularNamedObject>.ShowInPerspective(Perspective)

NamedObjectEditableCollection<ITabularNamedObject>.HideInPerspective(string)

NamedObjectEditableCollection<ITabularNamedObject>.HideInPerspective(Perspective)

NamedObjectEditableCollection<ITabularNamedObject>.ShowInAllPerspectives()

NamedObjectEditableCollection<ITabularNamedObject>.HideInAllPerspectives()

NamedObjectEditableCollection<ITabularNamedObject>.Rename(string, string, bool, bool, bool, bool)

NamedObjectEditableCollection<ITabularNamedObject>.Rename(string, string, List<ITabularNamedObject>, bool, bool, bool, bool)

NamedObjectEditableCollection<ITabularNamedObject>.ReplaceExpression(string, string, bool)

NamedObjectEditableCollection<ITabularNamedObject>.ReplaceExpression(ExpressionProperty, string, string, bool)

NamedObjectEditableCollection<ITabularNamedObject>.Delete()

NamedObjectEditableCollection<ITabularNamedObject>.Count

NamedObjectEditableCollection<ITabularNamedObject>.this[string]

NamedObjectEditableCollection<ITabularNamedObject>.DisplayFolder

NamedObjectEditableCollection<ITabularNamedObject>.IsHidden

NamedObjectEditableCollection<ITabularNamedObject>.IsActive

NamedObjectEditableCollection<ITabularNamedObject>.FormatString

NamedObjectEditableCollection<ITabularNamedObject>.Expression

NamedObjectEditableCollection<ITabularNamedObject>.Description

NamedObjectEditableCollection<ITabularNamedObject>.Name

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: TabularEditor.Shared.Interaction

Assembly: TabularEditor3.Shared.dll

Syntax

public class Selection : NamedObjectEditableCollection<ITabularNamedObject>, IEnumerable<ITabularNamedObject>, IEnumerable

Properties

ActiveCulture

The currently selected culture in the dropdown above the explorer tree.

Declaration

public Culture ActiveCulture { get; }

Property Value

Type	Description
Culture

ActivePerspectives

The currently selected perspectives in the dropdown above the explorer tree.

Declaration

public IEnumerable<Perspective> ActivePerspectives { get; }

Property Value

Type	Description
IEnumerable<Perspective>

CalculatedColumn

The currently selected calculated column (if exactly one calculated column is selected in the explorer tree).

Declaration

public CalculatedColumn CalculatedColumn { get; }

Property Value

Type	Description
CalculatedColumn

CalculatedColumns

All currently selected calculated columns (including calculated columns within selected Display Folders).

Declaration

public NamedObjectEditableCollection<CalculatedColumn> CalculatedColumns { get; }

Property Value

Type	Description
NamedObjectEditableCollection<CalculatedColumn>

CalculatedTable

The currently selected calculated table (if exactly one calculated table is selected in the explorer tree).

Declaration

public CalculatedTable CalculatedTable { get; }

Property Value

Type	Description
CalculatedTable

CalculatedTableColumns

All currently selected calculated table columns (including calculated table columns within selected Display Folders).

Declaration

public NamedObjectEditableCollection<CalculatedTableColumn> CalculatedTableColumns { get; }

Property Value

Type	Description
NamedObjectEditableCollection<CalculatedTableColumn>

CalculatedTables

All currently selected calculated tables.

Declaration

public NamedObjectEditableCollection<CalculatedTable> CalculatedTables { get; }

Property Value

Type	Description
NamedObjectEditableCollection<CalculatedTable>

CalculationGroup

The currently selected calculation group (if exactly one calculation group is selected in the explorer tree.)

Declaration

public CalculationGroupTable CalculationGroup { get; }

Property Value

Type	Description
CalculationGroupTable

CalculationGroups

All currently selected calculation groups.

Declaration

public NamedObjectEditableCollection<CalculationGroupTable> CalculationGroups { get; }

Property Value

Type	Description
NamedObjectEditableCollection<CalculationGroupTable>

CalculationItem

The currently selected calculation item (if exactly one calculation item is selected in the explorer tree.)

Declaration

public CalculationItem CalculationItem { get; }

Property Value

Type	Description
CalculationItem

CalculationItems

All currently selected calculation items.

Declaration

public NamedObjectEditableCollection<CalculationItem> CalculationItems { get; }

Property Value

Type	Description
NamedObjectEditableCollection<CalculationItem>

Column

The currently selected column (if exactly one column is selected in the explorer tree).

Declaration

public Column Column { get; }

Property Value

Type	Description
Column

Columns

All currently selected columns (including columns within selected Display Folders).

Declaration

public NamedObjectEditableCollection<Column> Columns { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Column>

Context

Indicates where in the Explorer Tree the current selection has been made.

Declaration

public Context Context { get; }

Property Value

Type	Description
Context

Culture

The currently selected culture (if exactly one culture is selected in the explorer tree).

Declaration

public Culture Culture { get; }

Property Value

Type	Description
Culture

Cultures

All currently selected cultures.

Declaration

public NamedObjectEditableCollection<Culture> Cultures { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Culture>

CurrentFolder

Gets the current folder of the selection. If multiple folders are selected, the parent folder is returned.

Declaration

public string CurrentFolder { get; }

Property Value

Type	Description
string

DataColumn

The currently selected data column (if exactly one data column is selected in the explorer tree).

Declaration

public DataColumn DataColumn { get; }

Property Value

Type	Description
DataColumn

DataColumns

All currently selected data columns (including data columns within selected Display Folders).

Declaration

public NamedObjectEditableCollection<DataColumn> DataColumns { get; }

Property Value

Type	Description
NamedObjectEditableCollection<DataColumn>

DataSource

The currently selected data source.

Declaration

public DataSource DataSource { get; }

Property Value

Type	Description
DataSource

DataSources

All currently selected data sources.

Declaration

public NamedObjectEditableCollection<DataSource> DataSources { get; }

Property Value

Type	Description
NamedObjectEditableCollection<DataSource>

Direct

A collection of objects (including display folders) that are directly selected in the explorer tree. Does not include child objects.

Declaration

public NamedObjectEditableCollection<ITabularNamedObject> Direct { get; }

Property Value

Type	Description
NamedObjectEditableCollection<ITabularNamedObject>

DirectCount

The number of objects directly selected in the Explorer Tree (not counting any child objects).

Declaration

public int DirectCount { get; }

Property Value

Type	Description
int

Folders

Gets the currently selected display folders in the explorer tree.

Declaration

public IEnumerable<Folder> Folders { get; }

Property Value

Type	Description
IEnumerable<Folder>

Groups

Gets the currently selected object groups in the explorer tree.

Declaration

public IEnumerable<LogicalGroup> Groups { get; }

Property Value

Type	Description
IEnumerable<LogicalGroup>

HasTable

Returns true only when a single table is unambiguously selected (either by direct selection of a single table, or by selecting one or more objects within the same table).

Declaration

public bool HasTable { get; }

Property Value

Type	Description
bool

Hierarchies

All currently selected hierarchies (including hierarchies within selected Display Folders).

Declaration

public NamedObjectEditableCollection<Hierarchy> Hierarchies { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Hierarchy>

Hierarchy

The currently selected hierarchy (if exactly one hierarchy is selected in the explorer tree).

Declaration

public Hierarchy Hierarchy { get; }

Property Value

Type	Description
Hierarchy

KPI

he currently selected KPI.

Declaration

public KPI KPI { get; }

Property Value

Type	Description
KPI

Level

The currently selected level (if exactly one level is selected in the explorer tree).

Declaration

public Level Level { get; }

Property Value

Type	Description
Level

Levels

The currently selected levels.

Declaration

public NamedObjectEditableCollection<Level> Levels { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Level>

Measure

The currently selected measure (if exactly one measure is selected in the explorer tree).

Declaration

public Measure Measure { get; }

Property Value

Type	Description
Measure

Measures

All currently selected measures (including measures within selected Display Folders).

Declaration

public NamedObjectEditableCollection<Measure> Measures { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Measure>

Object

The currently selected object (if exactly one object is selected in the explorer tree).

Declaration

public TabularNamedObject Object { get; }

Property Value

Type	Description
TabularNamedObject

Partition

The currently selected partition (if exactly one partition is selected in the explorer tree).

Declaration

public Partition Partition { get; }

Property Value

Type	Description
Partition

Partitions

All currently selected partitions.

Declaration

public NamedObjectEditableCollection<Partition> Partitions { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Partition>

Perspective

The currently selected perspective (if exactly one perspective is selected in the explorer tree).

Declaration

public Perspective Perspective { get; }

Property Value

Type	Description
Perspective

Perspectives

All currently selected perspectives.

Declaration

public NamedObjectEditableCollection<Perspective> Perspectives { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Perspective>

Roles

All currently selected roles.

Declaration

public NamedObjectEditableCollection<ModelRole> Roles { get; }

Property Value

Type	Description
NamedObjectEditableCollection<ModelRole>

SelectedItems

Declaration

public IReadOnlyList<ITabularNamedObject> SelectedItems { get; }

Property Value

Type	Description
IReadOnlyList<ITabularNamedObject>

SingleColumnRelationships

All currently selected relationships.

Declaration

public NamedObjectEditableCollection<SingleColumnRelationship> SingleColumnRelationships { get; }

Property Value

Type	Description
NamedObjectEditableCollection<SingleColumnRelationship>

Table

The currently selected table (if exactly one table is selected in the explorer tree) or the table of selected child objects.

Declaration

public Table Table { get; }

Property Value

Type	Description
Table

TableGroup

The name of the current table group (if exactly one table group is selected, or if one or more tables within a single table group is selected)

Declaration

public string TableGroup { get; }

Property Value

Type	Description
string

TablePermissions

All currently selected table permissions.

Declaration

public NamedObjectEditableCollection<TablePermission> TablePermissions { get; }

Property Value

Type	Description
NamedObjectEditableCollection<TablePermission>

Tables

The currently selected tables (if one or more tables have been directly selected in the explorer tree).

Declaration

public NamedObjectEditableCollection<Table> Tables { get; }

Property Value

Type	Description
NamedObjectEditableCollection<Table>

Implements

IEnumerable<T>

IEnumerable

Extension Methods

SelectionHelper.Edit<T>(IEnumerable<T>)

SelectionHelper.FindByDAX<T>(IEnumerable<T>, string)

SelectionHelper.Summary(IEnumerable<ITabularNamedObject>, bool, bool)

ScriptHelper.CustomAction(IEnumerable<ITabularNamedObject>, int)

ScriptHelper.CustomAction(IEnumerable<ITabularNamedObject>, string)

ScriptHelper.ExportProperties(IEnumerable<ITabularNamedObject>, string)

ScriptHelper.Macro(IEnumerable<ITabularNamedObject>, int)

ScriptHelper.Macro(IEnumerable<ITabularNamedObject>, string)

ScriptHelper.Output(object)