Class CalculationItemCollection

Collection class for CalculationItem. Provides convenient properties for setting a property on multiple objects at once.

Inheritance
object
TabularObjectCollection<CalculationItem>
CalculationItemCollection
Implements
Inherited Members
Namespace: TabularEditor.TOMWrapper
Assembly: TOMWrapper.dll
Syntax
public sealed class CalculationItemCollection : TabularObjectCollection<CalculationItem>, INotifyCollectionChanged, IReadOnlyList<CalculationItem>, IReadOnlyCollection<CalculationItem>, IEnumerable<CalculationItem>, IEnumerable, ITabularObjectContainer, ITabularTableObject, ITabularNamedObject, ITabularObject, INotifyPropertyChanged, INamedObject

Properties

CalculationGroupTable

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

Count

The number of items in this collection.

Declaration
public override int Count { get; }
Property Value
Type Description
int
Overrides

Description

Sets the Description property of all objects in the collection at once.

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

Expression

Sets the Expression property of all objects in the collection at once.

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

ObjectTypeName

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

PropertyGridCalculationItems

This property points to the CalculationItemCollection itself. It is used only to display a clickable "Calculation Items" property in the Property Grid, which will open the CalculationItemCollectionEditor when clicked.

Declaration
public CalculationItemCollection PropertyGridCalculationItems { get; }
Property Value
Type Description
CalculationItemCollection

Methods

Browsable(string)

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

Editable(string)

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

GetAnnotation(int)

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

GetAnnotation(string)

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

GetAnnotations()

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

GetAnnotationsCount()

Declaration
public int GetAnnotationsCount()
Returns
Type Description
int

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public override IEnumerator<CalculationItem> GetEnumerator()
Returns
Type Description
IEnumerator<CalculationItem>
Overrides

GetNewAnnotationName()

Declaration
public string GetNewAnnotationName()
Returns
Type Description
string

HasAnnotation(string)

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

RemoveAnnotation(string)

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

RemoveAnnotation(string, bool)

Declaration
public void RemoveAnnotation(string name, bool undoable = false)
Parameters
Type Name Description
string name
bool undoable

SetAnnotation(int, string)

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

SetAnnotation(int, string, bool)

Declaration
public void SetAnnotation(int index, string value, bool undoable = false)
Parameters
Type Name Description
int index
string value
bool undoable

SetAnnotation(string, string)

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

SetAnnotation(string, string, bool)

Declaration
public void SetAnnotation(string name, string value, bool undoable = false)
Parameters
Type Name Description
string name
string value
bool undoable

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods