TFORMer SDK - NET 8
Public Member Functions | Properties | List of all members
ComputedField Class Reference

Provides access to a ComputedField which is referenced by a DataSource. More...

Public Member Functions

void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
override string ToString ()
 Returns a string representation of the instance. More...
 

Properties

Aggregation Aggregation [get, set]
 Gets/Sets the aggregation-type of the ComputedField. More...
 
string Comment [get, set]
 Gets/Sets the comment for the ComputedField. More...
 
string Expression [get, set]
 Gets/Sets the aggregation expression of the ComputedField. More...
 
string Filter [get, set]
 Gets/Sets the filter expression of the ComputedField. More...
 
string Name [get, set]
 Gets/Sets the name of the ComputedField. More...
 
ComputedField Next [get]
 Gets the next ComputedField defined in the DataSource. More...
 
long Order [get, set]
 Gets/Sets the evaluation order of the ComputedField. More...
 

Detailed Description

Provides access to a ComputedField which is referenced by a DataSource.

Overview

With the help of ComputedFields computations can be centralized in the DataSource instead of performing the computations in the FormLayout. For example, you might

The result of a ComputedField is available in the DataSource like any other source-field. In the expression of a ComputedField you may refer to multiple fields of the DataSource. It is also possible to use other ComputedFields already defined in the DataSource in the expression.

Aggregation


In addition, ComputedFields support Aggregation (see ComputedField.Aggregation).
Thus it is pretty simple to create serial numbers or to calculate running sums and averages which are not available in a DataSource directly.

Filter Expressions

To exclude specific Records of a DataSource from being considered by the Aggregation use filter expressions.

Member Function Documentation

◆ Dispose()

void Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ ToString()

override string ToString ( )

Returns a string representation of the instance.

Returns
A string representation of the instance

Property Documentation

◆ Aggregation

Gets/Sets the aggregation-type of the ComputedField.

Returns
The aggregation-type of the ComputedField

◆ Comment

string Comment
getset

Gets/Sets the comment for the ComputedField.

Returns
The comment for the ComputedField

◆ Expression

string Expression
getset

Gets/Sets the aggregation expression of the ComputedField.

Returns
The aggregation expression of the ComputedField

◆ Filter

string Filter
getset

Gets/Sets the filter expression of the ComputedField.

Using a filter expression allows to exclude specific Records from aggregation.

Returns
The filter expression of the ComputedField

◆ Name

string Name
getset

Gets/Sets the name of the ComputedField.

Returns
The name of the ComputedField

◆ Next

ComputedField Next
get

Gets the next ComputedField defined in the DataSource.

A DataSource stores a list of ComputedField-objects. To retrieve the first ComputedField in the DataSource see DataSource.FirstComputedField.

Returns
The next ComputedField object in the list or null

◆ Order

long Order
getset

Gets/Sets the evaluation order of the ComputedField.

Returns
The evaluation order of the ComputedField

© 2006-2023 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Thu Dec 28 2023 18:45:19 for TFORMer SDK - NET with doxygen 1.9.4