FormatStringDefinition Class

Definition

Namespace:

Microsoft.AnalysisServices.Tabular

Assembly:

Microsoft.AnalysisServices.Tabular.dll

Package:

Microsoft.AnalysisServices.retail.amd64 v19.79.0

Represents a FormatStringDefinition object. It is a child of either a Measure or a CalculationItem.

public sealed class FormatStringDefinition : Microsoft.AnalysisServices.Tabular.MetadataObject

type FormatStringDefinition = class
    inherit MetadataObject

Public NotInheritable Class FormatStringDefinition
Inherits MetadataObject

Inheritance

Object

MetadataObject

FormatStringDefinition

Remarks

This metadata object is only supported when the compatibility level of the database is at 1470 or above.

Constructors

FormatStringDefinition()

Create a new instance of the FormatStringDefinition class with default settings.

Properties

ErrorMessage	The string that explains the error state associated with the FormatStringDefinition. It is set by the engine only when the state of the Expression is one of these three values: SemanticError, DependencyError or SyntaxError.
Expression	DAX expression that specifies the format of the cell content.
IsRemoved	A Boolean specifying whether this object was removed from an object tree. (Inherited from MetadataObject)
Model	Gets the Tabular model that contains this object. (Inherited from MetadataObject)
ModifiedTime	The time that the object was last modified.
Object	A reference to a Measure or a CalculationItem object that owns this FormatString.
ObjectType	Gets the type of the object.
Parent	Parent object, null for Model objects.
State	Provides information on the state of the Expression. Possible values and their interpretation are as follows. Ready (1) The Expression is queryable and has up-to-date data. SemanticError (5) The Expression has a semantic error. DependencyError (7) A dependency associated with this Expression is in an error state (SemanticError, EvaluationError, or DependencyError). SyntaxError (9) The Expression has a syntax error.

Methods

Clone()	Creates a new, full copy of a FormatStringDefinition object.
CopyFrom(FormatStringDefinition)	Obsolete. Deprecated. Use CopyTo method instead.
CopyTo(FormatStringDefinition)	Copies a FormatStringDefinition object to the specified object.
Validate()	This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only. (Inherited from MetadataObject)