Class CalculationGroup
Represents a collection of Calculation Items.
Inheritance
CalculationGroup
Assembly: TOMWrapper.dll
Syntax
[TypeConverter(typeof(DynamicPropertyConverter))]
public sealed class CalculationGroup : TabularObject, INotifyPropertyChanging, IDescriptionObject, IAnnotationObject, ITabularObject, INotifyPropertyChanged
Properties
Annotations
The collection of Annotations on the current Calculation Group.
Declaration
[Browsable(true)]
public AnnotationCollection Annotations { get; }
Property Value
CalculationItems
The collection of CalculationItem objects on this CalculationGroup.
Declaration
[Browsable(false)]
public CalculationItemCollection CalculationItems { get; }
Property Value
Description
The description of the CalculationGroup, 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
Precedence
Defines an evaluation order of CalculationGroup objects.
Declaration
public int Precedence { get; set; }
Property Value
Table
The parent table of the current Calculation Group.
Declaration
[Browsable(false)]
public Table Table { get; }
Property Value
Methods
ClearAnnotations()
Removes all annotations from this object.
Declaration
public void ClearAnnotations()
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
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
GetAnnotations()
Gets a collection of all annotation names on the current Calculation Group.
Declaration
public IEnumerable<string> GetAnnotations()
Returns
GetAnnotationsCount()
Gets the number of annotations on the current Calculation Group.
Declaration
public int GetAnnotationsCount()
Returns
GetNewAnnotationName()
Returns a unique name for a new annotation.
Declaration
public string GetNewAnnotationName()
Returns
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
RemoveAnnotation(string)
Remove an annotation by the given name.
Declaration
public void RemoveAnnotation(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
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
ToString()
Declaration
public override string ToString()
Returns
Overrides
Implements
Extension Methods