LevelProperty.Caption Property

Article
12/03/2008

Gets the caption of the LevelProperty.

Namespace: Microsoft.AnalysisServices.AdomdServer
Assembly: msmgdsrv (in msmgdsrv.dll)

Syntax

'Declaration
Public ReadOnly Property Caption As String

public string Caption { get; }

public:
property String^ Caption {
    String^ get ();
}

/** @property */
public String get_Caption ()

public function get Caption () : String

Property Value

A String that contains the caption of the LevelProperty.

Remarks

The Caption property should be used when displaying the name of the LevelProperty to the user, such as in user interfaces or reports.

This property differs from the property of the object in that the value of the property can depend on the locale ID of the application using ADOMD.NET.

In Microsoft SQL Server 2005 Analysis Services (SSAS), each dimension attribute can be associated with a translation that returns a language-specific value for the property, depending on the locale ID of the application querying the server. The server searches for a locale ID that matches that of the requesting application. If an exact match cannot be found for a given language, the language closest to the specified locale ID is used. If a similar language cannot be found, the default language for the server is used.

The value of this property is identical to the value of the PROPERTY_CAPTION column of the PROPERTIES schema rowset for the specified level.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms