2.2.5.31 FormatStringDefinition Object

  • Article

The FormatStringDefinition object represents a value that is calculated based on an expression. It is a child of a CalculationItem object or a Measure object. As a child of a CalculationItem object, it requires compatibility level 1500 or higher. As a child of a Measure object, it requires compatibility level 1601 or higher.<85>

The FormatStringDefinition object has the following properties.

Name

Type

Description

ID

unsignedLong

A reference to the object.

ObjectID

unsignedLong

An ID-based reference to a Measure or CalculationItem object.

ObjectType

int

The data type of the object specified by ObjectID. The possible values are as follows:

  • TM_TYPEID_Measure (8)

  • TM_TYPEID_CalculationItem (47)

Expression

string

The DAX dynamic format string expression.

ModifiedTime

dateTime

The time that the object was last modified.

State

enumeration

A value that provides information about the state of the parent object or the container object. The possible values are as follows:

  • Ready (1) - The object expression is queryable and has up-to-date data.

  • NoData (3) - Not applicable to FormatStringDefinition.

  • CalculationNeeded (4) - Not applicable to FormatStringDefinition.

  • SemanticError (5) - The object expression has a semantic error.

  • EvaluationError (6) - Not applicable to FormatStringDefinition.

  • DependencyError (7) - A dependency associated with the FormatStringDefinition object is in an error state (SemanticError, EvaluationError, or DependencyError).

  • Incomplete (8) - Not applicable to FormatStringDefinition.

  • SyntaxError (9) - The calculation item has a syntax error in its expression.

ErrorMessage

string

A string that explains the error state that is associated with the FormatStringDefinition object. The ErrorMessage property is set by the engine only when the state of the object is one of these three values: SemanticError, DependencyError, or SyntaxError.