A Sandcastle Documented Class Library

# TimeHierarchyMember GetFormattedCaption Method

Gets the caption with the specified format.

Namespace: Dundas.BI.Entities.TimeDimensions
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public string GetFormattedCaption(
    	string format
    )

    Public Function GetFormattedCaption (
    	format As String
    ) As String

    public:
    virtual String^ GetFormattedCaption(
    	String^ format
    ) sealed

    abstract GetFormattedCaption :
            format : string -> string
    override GetFormattedCaption :
            format : string -> string

#### Parameters

format
  Type: System
  String
  The format.

#### Return Value

Type: String
The caption.

#### Implements

IFormattableHierarchyMember
GetFormattedCaption(String)
Remarks
If format is
or empty, the default format will be used.
See Also

#### Reference

TimeHierarchyMember Class
Dundas.BI.Entities.TimeDimensions Namespace