Class Variation

Variation object.

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

This metadata object is only supported for Pbi server, at database compatibility level of 1400 or above for Box server, at database compatibility level of 1400 or above for Excel server.

Properties

Annotations

The collection of Annotations on the current Variation.

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

Column

Missing comment

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

DefaultColumn

Missing comment

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

DefaultHierarchy

Missing comment

Declaration
[TypeConverter(typeof(AllHierarchyConverter))]
public Hierarchy DefaultHierarchy { get; set; }
Property Value
Type Description
Hierarchy

Description

Missing comment

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

ExtendedProperties

The collection of Extended Properties on the current Variation.

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

IsDefault

If true, the Variation is the Default one for the Column.

Declaration
public bool IsDefault { get; set; }
Property Value
Type Description
bool

Parent

The parent Column of the current Variation.

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

Relationship

Missing comment

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

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, Column)

Creates an exact copy of this Variation object.

Declaration
public Variation Clone(string newName = null, Column newParent = null)
Parameters
Type Name Description
string newName
Column newParent
Returns
Type Description
Variation

CreateNew(Column, string)

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

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

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 Variation.

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

GetAnnotationsCount()

Gets the number of annotations on the current Variation.

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

IsBrowsable(string)

Declaration
public bool IsBrowsable(string propertyName)
Parameters
Type Name Description
string propertyName
Returns
Type Description
bool

IsEditable(string)

Declaration
public bool IsEditable(string propertyName)
Parameters
Type Name Description
string propertyName
Returns
Type Description
bool

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