Class Set
- Inheritance
-
Set
- Implements
-
- Inherited Members
-
- Namespace
- TabularEditor.TOMWrapper
- Assembly
- TOMWrapper.dll
public sealed class Set : TabularNamedObject, ICustomTypeDescriptor, INotifyPropertyChanging, IComparable, IFolderObject, ITabularTableObject, IHideableObject, ITomErrorMessageObject, IDescriptionObject, IExpressionObject, ITabularNamedObject, INamedObject, IAnnotationObject, IExtendedPropertyObject, ITabularObject, INotifyPropertyChanged, IClonableObject
- Extension Methods
-
Properties
Annotations
The collection of Annotations on the current Set.
[Browsable(true)]
public AnnotationCollection Annotations { get; }
Property Value
Description
The description of the set
public string Description { get; set; }
Property Value
DisplayFolder
Defines the display folder for the Measure, for use by clients.
public string DisplayFolder { get; set; }
Property Value
ErrorMessage
The string that explains the error state associated with the current object. It is set by the engine only when the state of the object is one of these three values: SemanticError, DependencyError or EvaluationError.
public string ErrorMessage { get; }
Property Value
Expression
The DAX expression that is evaluated for the calculated set.
public string Expression { get; set; }
Property Value
ExtendedProperties
The collection of Extended Properties on the current Set.
public ExtendedPropertyCollection ExtendedProperties { get; }
Property Value
IsDynamic
Indicates whether the set is static or dynamic
public bool IsDynamic { get; set; }
Property Value
IsHidden
A boolean value that indicates whether the set is treated as hidden by client visualization tools. True if the set is treated as hidden by client visualization tools; otherwise false.
public bool IsHidden { get; set; }
Property Value
Parent
The parent Table of the current Set.
public Table Parent { get; }
Property Value
State
Provides information on the state of the set. Possible values and their interpretation are as follows. Ready (1) The set is queryable and has up-to-date data. NoData (3) Not applicable to Set. CalculationNeeded (4) Not applicable to Set. SemanticError (5) The set expression has a semantic error. EvaluationError (6) Not applicable to Set. DependencyError (7) A dependency associated with this set is in an error state (SemanticError, EvaluationError, or DependencyError). Incomplete (8) Not applicable to Set. SyntaxError (9) The measure has a syntax error in its expression.
public ObjectState State { get; }
Property Value
Table
The parent table of the current Set.
[Browsable(false)]
public Table Table { get; }
Property Value
TranslatedDisplayFolders
Collection of localized Display Folders for the current Set.
[Browsable(true)]
public TranslationIndexer TranslatedDisplayFolders { get; }
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, Table)
Creates an exact copy of this Set object.
public Set Clone(string newName = null, Table newParent = null)
Parameters
Returns
CreateNew(Table, string)
Creates a new Set and adds it to the parent Table.
Also creates the underlying metadataobject and adds it to the TOM tree.
public static Set CreateNew(Table 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 Set.
public IEnumerable<string> GetAnnotations()
Returns
GetAnnotationsCount()
Gets the number of annotations on the current Set.
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
GetMessages()
public IEnumerable<DocumentMessage> GetMessages()
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
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