Class Level

Represents a level in a hierarchy that provides a logical hierarchical drilldown path for client applications. It is a child of a Hierarchy object. The level is based on the values in a column.

Inheritance
object
DynamicPropertyObject
TabularObject
TabularNamedObject
Level
Implements
Inherited Members
Namespace: TabularEditor.TOMWrapper
Assembly: TOMWrapper.dll
Syntax
public sealed class Level : TabularNamedObject, ICustomTypeDescriptor, INotifyPropertyChanging, IComparable, IDescriptionObject, ILineageTagObject, IExtendedPropertyObject, ITranslatableObject, IAnnotationObject, ISynonymObject, IClonableObject, ITabularTableObject, ITabularNamedObject, ITabularObject, INotifyPropertyChanged, INamedObject

Properties

Annotations

The collection of Annotations on the current Level.

Declaration
[Browsable(true)]
public AnnotationCollection Annotations { get; }
Property Value
Type Description
AnnotationCollection

Column

A reference to a Column object associated with this Level.

Declaration
[TypeConverter(typeof(HierarchyColumnConverter))]
public Column Column { get; set; }
Property Value
Type Description
Column

Description

The description of the level, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.

Declaration
public string Description { get; set; }
Property Value
Type Description
string

ExtendedProperties

The collection of Extended Properties on the current Level.

Declaration
public ExtendedPropertyCollection ExtendedProperties { get; }
Property Value
Type Description
ExtendedPropertyCollection

Hierarchy

A reference to a Hierarchy object that owns this level.

Declaration
[Browsable(false)]
public Hierarchy Hierarchy { get; }
Property Value
Type Description
Hierarchy

LineageTag

A tag that represents the lineage of the object.

Declaration
public string LineageTag { get; set; }
Property Value
Type Description
string
Remarks

This property is only supported when the compatibility level of the database is at 1540 or above.

Ordinal

The position of the level within the hierarchy. The levels in the hierarchy must be properly ordered, starting with 1 and increasing monotonically.

Declaration
public int Ordinal { get; set; }
Property Value
Type Description
int

Parent

The parent Hierarchy of the current Level.

Declaration
public Hierarchy Parent { get; }
Property Value
Type Description
Hierarchy

SourceLineageTag

A tag that represents the lineage of the source for the object.

Declaration
public string SourceLineageTag { get; set; }
Property Value
Type Description
string
Remarks

This property is only supported when the compatibility level of the database is at 1550 or above.

Synonyms

Collection of localized synonyms for this Level.

Declaration
[Browsable(true)]
public SynonymIndexer Synonyms { get; }
Property Value
Type Description
SynonymIndexer

Table

Declaration
[Browsable(false)]
public Table Table { get; }
Property Value
Type Description
Table

TranslatedDescriptions

Collection of localized descriptions for this Level.

Declaration
[Browsable(true)]
public TranslationIndexer TranslatedDescriptions { get; }
Property Value
Type Description
TranslationIndexer

TranslatedNames

Collection of localized names for this Level.

Declaration
[Browsable(true)]
public TranslationIndexer TranslatedNames { get; }
Property Value
Type Description
TranslationIndexer

Methods

ClearAnnotations()

Removes all annotations from this object.

Declaration
public void ClearAnnotations()

ClearExtendedProperties()

Removes all Extended Properties from this object.

Declaration
public void ClearExtendedProperties()

Clone(string, bool, Hierarchy)

Creates an exact copy of this Level object.

Declaration
public Level Clone(string newName = null, bool includeTranslations = true, Hierarchy newParent = null)
Parameters
Type Name Description
string newName
bool includeTranslations
Hierarchy newParent
Returns
Type Description
Level

CreateNew(Hierarchy, string)

Creates a new Level and adds it to the parent Hierarchy. Also creates the underlying metadataobject and adds it to the TOM tree.

Declaration
public static Level CreateNew(Hierarchy parent, string name = null)
Parameters
Type Name Description
Hierarchy parent
string name
Returns
Type Description
Level

GetAnnotation(int)

Gets the value of the annotation with the given index, assuming it exists.

Declaration
public string GetAnnotation(int index)
Parameters
Type Name Description
int index
Returns
Type Description
string

GetAnnotation(string)

Gets the value of the annotation with the given name. Returns null if no such annotation exists.

Declaration
public string GetAnnotation(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string

GetAnnotations()

Gets a collection of all annotation names on the current Level.

Declaration
public IEnumerable<string> GetAnnotations()
Returns
Type Description
IEnumerable<string>

GetAnnotationsCount()

Gets the number of annotations on the current Level.

Declaration
public int GetAnnotationsCount()
Returns
Type Description
int

GetExtendedProperties()

Gets a collection of all ExtendedProperty names on the current object.

Declaration
public IEnumerable<string> GetExtendedProperties()
Returns
Type Description
IEnumerable<string>

GetExtendedProperty(int)

Gets the value of the ExtendedProperty with the given index, assuming it exists.

Declaration
public string GetExtendedProperty(int index)
Parameters
Type Name Description
int index
Returns
Type Description
string

GetExtendedProperty(string)

Gets the value of the ExtendedProperty with the given name. Returns null if no such ExtendedProperty exists.

Declaration
public string GetExtendedProperty(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string

GetExtendedPropertyCount()

Gets the number of ExtendedProperties on the current object.

Declaration
public int GetExtendedPropertyCount()
Returns
Type Description
int

GetExtendedPropertyType(int)

Gets the type of the ExtendedProperty with the given index, assuming it exists.

Declaration
public ExtendedPropertyType GetExtendedPropertyType(int index)
Parameters
Type Name Description
int index
Returns
Type Description
ExtendedPropertyType

GetExtendedPropertyType(string)

Gets the type of the ExtendedProperty with the given name, assuming it exists.

Declaration
public ExtendedPropertyType GetExtendedPropertyType(string name)
Parameters
Type Name Description
string name
Returns
Type Description
ExtendedPropertyType

GetNewAnnotationName()

Returns a unique name for a new annotation.

Declaration
public string GetNewAnnotationName()
Returns
Type Description
string

GetNewExtendedPropertyName()

Returns a unique name for a new ExtendedProperty.

Declaration
public string GetNewExtendedPropertyName()
Returns
Type Description
string

HasAnnotation(string)

Returns true if an annotation with the given name exists. Otherwise false.

Declaration
public bool HasAnnotation(string name)
Parameters
Type Name Description
string name
Returns
Type Description
bool

HasExtendedProperty(string)

Returns true if an ExtendedProperty with the given name exists. Otherwise false.

Declaration
public bool HasExtendedProperty(string name)
Parameters
Type Name Description
string name
Returns
Type Description
bool

OnPropertyChanged(string, object, object)

Fired after a property is changed

Declaration
protected override void OnPropertyChanged(string propertyName, object oldValue, object newValue)
Parameters
Type Name Description
string propertyName
object oldValue
object newValue
Overrides

OnPropertyChanging(string, object, ref bool, ref bool)

Called before a property is changed on an object. Derived classes can control how the change is handled. Throw ArgumentException within this method, to display an error message in the UI.

Declaration
protected override void OnPropertyChanging(string propertyName, object newValue, ref bool undoable, ref bool cancel)
Parameters
Type Name Description
string propertyName

Name of the changed property.
object newValue

New value assigned to the property.
bool undoable

Return false if automatic undo of the property change is not needed.
bool cancel

Return true if the property change should not apply.
Overrides

RemoveAnnotation(string)

Remove an annotation by the given name.

Declaration
public void RemoveAnnotation(string name)
Parameters
Type Name Description
string name

RemoveExtendedProperty(string)

Remove an ExtendedProperty by the given name.

Declaration
public void RemoveExtendedProperty(string name)
Parameters
Type Name Description
string name

SetAnnotation(int, string)

Sets the value of the annotation with the given index, assuming it exists.

Declaration
public void SetAnnotation(int index, string value)
Parameters
Type Name Description
int index
string value

SetAnnotation(string, string)

Sets the value of the annotation having the given name. If no such annotation exists, it will be created. If value is set to null, the annotation will be removed.

Declaration
public void SetAnnotation(string name, string value)
Parameters
Type Name Description
string name
string value

SetExtendedProperty(int, string, ExtendedPropertyType)

Sets the value of the ExtendedProperty with the given index, optionally specifiying the type (string or JSON) of the ExtendedProperty.

Declaration
public void SetExtendedProperty(int index, string value, ExtendedPropertyType type)
Parameters
Type Name Description
int index
string value
ExtendedPropertyType type

SetExtendedProperty(string, string, ExtendedPropertyType)

Sets the value of the ExtendedProperty having the given name. If no such ExtendedProperty exists, it will be created. If value is set to null, the ExtendedProperty will be removed.

Declaration
public void SetExtendedProperty(string name, string value, ExtendedPropertyType type)
Parameters
Type Name Description
string name
string value
ExtendedPropertyType type

Implements

Extension Methods