Share via


Measure Class

Definition

Represents a value that is calculated based on an expression. It is a child of a Table object.

public sealed class Measure : Microsoft.AnalysisServices.Tabular.NamedMetadataObject, Microsoft.AnalysisServices.Tabular.IMetadataObjectWithLineage
type Measure = class
    inherit NamedMetadataObject
    interface IMetadataObjectWithLineage
Public NotInheritable Class Measure
Inherits NamedMetadataObject
Implements IMetadataObjectWithLineage
Inheritance
Implements

Constructors

Measure()

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

Properties

Annotations

Gets the collection object of all annotations in the current Measure.

ChangedProperties

Gets the collection object of all changedproperties in the current Measure.

DataCategory

Specifies the type of data contained in the measure so that you can add custom behaviors based on measure type.

DataType

Describes the type of data contained in the column. Possible values are as follows. String (2). Int64 (6). Double (8). DateTime (9). Decimal (10). Boolean (11). Binary (17). Unknown (19) A measure in an error state. Variant (20) A measure with varying data type.

Description

The description of the measure, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.

DetailRowsDefinition

A reference to a DetailRowsDefinition object that is owned by this Measure.

DisplayFolder

Defines the display folder for the Measure, for use by clients.

ErrorMessage

The string that explains the error state associated with the current object. It is set by the engine only when the state of the object is one of these three values: SemanticError, DependencyError or EvaluationError.

Expression

The DAX expression that is evaluated for the calculated measure.

ExtendedProperties

Gets the collection object of all extendedproperties in the current Measure.

FormatString

A string that specifies the format of the measure contents. For

FormatStringDefinition

A reference to a FormatStringDefinition object owned by this Measure.

IsHidden

A boolean value that indicates whether the measure is treated as hidden by client visualization tools. True if the measure is treated as hidden by client visualization tools; otherwise false.

IsRemoved

A Boolean specifying whether this object was removed from an object tree.

(Inherited from MetadataObject)
IsSimpleMeasure

A boolean value that indicates whether the measure is an implicit measure that is automatically created by client tools to aggregate a field. Client applications can hide measures that have this flag set.

KPI

A reference to a KPI object that is owned by this Measure.

LineageTag

A tag that represents the lineage of the object.

Model

Gets the Tabular model that contains this object.

(Inherited from MetadataObject)
ModifiedTime

The time that the object was last modified.

Name

Gets or Sets the Name of this object.

ObjectType

Gets the type of the object.

Parent

Parent object, null for Model objects.

SourceLineageTag

A tag that represents the lineage of the source for the object.

State

Provides information on the state of the measure. Possible values and their interpretation are as follows. Ready (1) The measure is queryable and has up-to-date data. NoData (3) Not applicable to Measure. CalculationNeeded (4) Not applicable to Measure. SemanticError (5) The measure expression has a semantic error. EvaluationError (6) Not applicable to Measure. DependencyError (7) A dependency associated with this measure is in an error state (SemanticError, EvaluationError, or DependencyError). Incomplete (8) Not applicable to Measure. SyntaxError (9) The measure has a syntax error in its expression.

StructureModifiedTime

The time that the structure of the object was last modified.

Table

A reference to a Table object that owns this Measure.

Methods

Clone()

Creates a new, full copy of a Measure object.

CopyFrom(Measure)
Obsolete.

Deprecated. Use CopyTo method instead.

CopyTo(Measure)

Copies a Measure object to the specified object.

Rename(String)
Obsolete.

Deprecated. Use RequestRename method instead.

RequestRename(String)

Request rename of this 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)

Applies to