DisplayName (Property)

Applies To:

DerivedItem object, Limit object, Requests collection, TopicItem object

Description:

Returns or sets the display name of the DerivedItem (Object), Limit (Object), Requests (Collection), and TopicItem (Object). The DisplayName (Property) is the name of the object as viewed by the user when working with the Interactive Reporting product suite.

There are three “name” type properties used in the Object Model, including the:

To determine which name property to use in Object Models, consider this example.

A database table is entitled MyColumn. The PhysicalName of the column is MyColumn. To display another name for MyColumn, such as MySpecialColumn, use the DisplayName (Property). This enables you to modify the column name shown in Interactive Reporting but retain the original name at the source. Use the Name (Property) to reference objects in the Object Model. For example, to determine the name of a TextBox object in Dashboards, use this script:

TextBox1.Name

Action:

Read-write, String

Example:

This example writes the names of all the topics and topic items to the Console window:

var Tcount = ActiveDocument.Sections["Query"].DataModel.Topics.Count
for (j = 1; j <= Tcount ; j ++)
{
var myTopic = ActiveDocument.Sections["Query"].DataModel.Topics[j]
Console.Writeln("Topic : "+myTopic.PhysicalName)
var TICount = ActiveDocument.Sections["Query"].DataModel.Topics[j].TopicItems.Count
	for (k = 1 ; k <= TICount ; k ++)
	{
		var myItem = 	ActiveDocument.Sections["Query"].DataModel. 			                    Topics[j].TopicItems[k]
		Console.Writeln(" Item: "+ myItem.DisplayName)
	}
}