PhysicalName (Property)

Applies To:

Topic object, TopicItem object

Description:

Returns the actual name of the topic or topic item. This name cannot be changed through scripting or through the user interface.

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 called MyColumn. The PhysicalName of the column is also MyColumn. To display a different column name, such as MySpecialColumn, use the DisplayName (Property). This enables you to modify the name shown in the Interactive Reporting product suite although at the source, the column retains its original name (MyColumn). Use the Name (Property) to reference Object Model objects. For example, to determine the name of a TextBox object in Dashboards, write 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("Topic Item: "+ myItem.PhysicalName)
}
}