Class KeyFigure

Represents a key figure.

Inheritance
object
KeyFigure
Syntax
public class KeyFigure : IKeyFigure, ISortableInfoObject, IPositionableInfoObject<IKeyFigure>, IComparable<IKeyFigure>, IFilterableInfoObject, IInfoObject

Constructors

KeyFigure(IKeyFigure)

Copy constructor.

Declaration
public KeyFigure(IKeyFigure keyFigure)
Parameters
Type Name Description
IKeyFigure keyFigure

The key figure.

KeyFigure(string)

Initializes a new instance of the KeyFigure class.

Declaration
public KeyFigure(string id)
Parameters
Type Name Description
string id

The id.

Properties

Aggregation

Gets or sets the aggregation.

Declaration
public KeyFigureAggregation Aggregation { get; set; }

AlertLevels

Gets the alert levels.

Declaration
public IList<IAlertLevel> AlertLevels { get; }

CalculationTime

Gets or sets the calulcation time.

Declaration
public KeyFigureCalculationTime CalculationTime { get; set; }

DataType

Gets or sets the data type.

Declaration
public InfoObjectDataType DataType { get; set; }

Decimals

Gets or sets the decimals.

Declaration
public int Decimals { get; set; }
Property Value
Type Description
int

Filters

Gets the filters.

Declaration
public IList<IFilter> Filters { get; }

Formula

Gets or sets the formula.

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

Id

Gets the id.

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

Iobjnm

Gets the iobjnm.

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

IsHidden

Gets or sets whether the key figure is hidden.

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

Name

Gets or sets the name.

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

Position

Gets or sets the position.

Declaration
public int Position { get; set; }
Property Value
Type Description
int

Prefix

Gets or sets the prefix.

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

Scaling

Gets or sets the scaling.

Declaration
public int Scaling { get; set; }
Property Value
Type Description
int

SortMode

Gets or sets the sort mode.

Declaration
public InfoObjectSortMode SortMode { get; set; }

SortTuples

Gets the sort tuples.

Declaration
public IList<ISortTuple> SortTuples { get; }

Suffix

Gets or sets the suffix.

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

Methods

CompareTo(IKeyFigure?)

Declaration
public int CompareTo(IKeyFigure? other)
Parameters
Type Name Description
IKeyFigure other

The other key figure.
Returns
Type Description
int

ToString()

Declaration
public override string? ToString()
Returns
Type Description
string

Implements

Extension Methods