Class Variation
- Inheritance
-
Variation
- Implements
-
- Inherited Members
-
- Namespace
- TabularEditor.TOMWrapper
- Assembly
- TOMWrapper.dll
public sealed class Variation : TabularNamedObject, ICustomTypeDescriptor, INotifyPropertyChanging, ITabularNamedObject, INamedObject, IComparable, IDescriptionObject, IAnnotationObject, IExtendedPropertyObject, ITabularObject, INotifyPropertyChanged, IHandlerObject, IClonableObject
- Extension Methods
-
Properties
Annotations
The collection of Annotations on the current Variation.
[Browsable(true)]
public AnnotationCollection Annotations { get; }
Property Value
Column
[TypeConverter(typeof(TableColumnConverter))]
public Column Column { get; }
Property Value
DefaultColumn
[TypeConverter(typeof(ColumnConverter))]
public Column DefaultColumn { get; set; }
Property Value
DefaultHierarchy
[TypeConverter(typeof(AllHierarchyConverter))]
public Hierarchy DefaultHierarchy { get; set; }
Property Value
Description
public string Description { get; set; }
Property Value
ExtendedProperties
The collection of Extended Properties on the current Variation.
public ExtendedPropertyCollection ExtendedProperties { get; }
Property Value
IsDefault
If true, the Variation is the Default one for the Column.
public bool IsDefault { get; set; }
Property Value
Parent
The parent Column of the current Variation.
public Column Parent { get; }
Property Value
Relationship
[TypeConverter(typeof(AllRelationshipConverter))]
public Relationship Relationship { get; set; }
Property Value
Methods
ClearAnnotations()
Removes all annotations from this object.
public void ClearAnnotations()
ClearExtendedProperties()
Removes all Extended Properties from this object.
public void ClearExtendedProperties()
Clone(string, Column)
Creates an exact copy of this Variation object.
public Variation Clone(string newName = null, Column newParent = null)
Parameters
Returns
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.
public static Variation CreateNew(Column parent, string name = null)
Parameters
Returns
GetAnnotation(int)
Gets the value of the annotation with the given index, assuming it exists.
public string GetAnnotation(int index)
Parameters
| Type |
Name |
Description |
| int |
index |
|
Returns
GetAnnotation(string)
Gets the value of the annotation with the given name. Returns null if no such annotation exists.
public string GetAnnotation(string name)
Parameters
| Type |
Name |
Description |
| string |
name |
|
Returns
GetAnnotations()
Gets a collection of all annotation names on the current Variation.
public IEnumerable<string> GetAnnotations()
Returns
GetAnnotationsCount()
Gets the number of annotations on the current Variation.
public int GetAnnotationsCount()
Returns
GetExtendedProperties()
Gets a collection of all ExtendedProperty names on the current object.
public IEnumerable<string> GetExtendedProperties()
Returns
GetExtendedProperty(int)
Gets the value of the ExtendedProperty with the given index, assuming it exists.
public string GetExtendedProperty(int index)
Parameters
| Type |
Name |
Description |
| int |
index |
|
Returns
GetExtendedProperty(string)
Gets the value of the ExtendedProperty with the given name. Returns null if no such ExtendedProperty exists.
public string GetExtendedProperty(string name)
Parameters
| Type |
Name |
Description |
| string |
name |
|
Returns
GetExtendedPropertyCount()
Gets the number of ExtendedProperties on the current object.
public int GetExtendedPropertyCount()
Returns
GetExtendedPropertyType(int)
Gets the type of the ExtendedProperty with the given index, assuming it exists.
public ExtendedPropertyType GetExtendedPropertyType(int index)
Parameters
| Type |
Name |
Description |
| int |
index |
|
Returns
GetExtendedPropertyType(string)
Gets the type of the ExtendedProperty with the given name, assuming it exists.
public ExtendedPropertyType GetExtendedPropertyType(string name)
Parameters
| Type |
Name |
Description |
| string |
name |
|
Returns
GetNewAnnotationName()
Returns a unique name for a new annotation.
public string GetNewAnnotationName()
Returns
GetNewExtendedPropertyName()
Returns a unique name for a new ExtendedProperty.
public string GetNewExtendedPropertyName()
Returns
HasAnnotation(string)
Returns true if an annotation with the given name exists. Otherwise false.
public bool HasAnnotation(string name)
Parameters
| Type |
Name |
Description |
| string |
name |
|
Returns
HasExtendedProperty(string)
Returns true if an ExtendedProperty with the given name exists. Otherwise false.
public bool HasExtendedProperty(string name)
Parameters
| Type |
Name |
Description |
| string |
name |
|
Returns
IsBrowsable(string)
public bool IsBrowsable(string propertyName)
Parameters
| Type |
Name |
Description |
| string |
propertyName |
|
Returns
IsEditable(string)
public bool IsEditable(string propertyName)
Parameters
| Type |
Name |
Description |
| string |
propertyName |
|
Returns
RemoveAnnotation(string)
Remove an annotation by the given name.
public void RemoveAnnotation(string name)
Parameters
| Type |
Name |
Description |
| string |
name |
|
RemoveExtendedProperty(string)
Remove an ExtendedProperty by the given name.
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.
public void SetAnnotation(int index, string value)
Parameters
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.
public void SetAnnotation(string name, string value)
Parameters
SetExtendedProperty(int, string, ExtendedPropertyType)
Sets the value of the ExtendedProperty with the given index, optionally specifiying the type (string or JSON) of the ExtendedProperty.
public void SetExtendedProperty(int index, string value, ExtendedPropertyType type)
Parameters
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.
public void SetExtendedProperty(string name, string value, ExtendedPropertyType type)
Parameters