DataMemberCaptionTemplate (Dimension Interface)
Note
This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.
The DataMemberCaptionTemplate property of the Dimension interface contains a template string that is used to create captions for system-generated data members.
Applies To:clsAggregationDimension, clsCubeDimension, clsDatabaseDimension, clsPartitionDimension
Data Type
String
Access
Access depends on the value of the ClassType property of the object.
Class type |
Access |
|---|---|
clsDatabaseDimension |
R/W* |
clsCubeDimension |
R |
clsPartitionDimension |
R |
clsAggregationDimension |
R |
*Read/write for objects of ClassType clsDatabaseDimension with a SubClassType of sbclsParentChild or sbclsMining, read-only for all others.
Remarks
This property is used in conjunction with the MembersWithData property. It is used to automatically generate captions for system-generated data members.
The data member captions are generated by substituting the caption of the associated member for the asterisk (*) placeholder character in the property string. The default data member caption template is "(* Data)".
For example, the template "(* Salary)" produces the caption "(John Doe Salary)" for the system-generated data member associated with the member John Doe.
This property is ignored when the MembersWithData property is dataforLeafMembersOnly.
Example
The following code example constructs a template for data members that will supply captions similar to (Subtotals for John Doe):
' Assume the existence of a database dimension named dsoDim.
dsoDim.DataMemberCaptionTemplate = "(Subtotals for *)"