You are here: Defining and Organizing Topics > Topic Properties

Topic Properties

By selecting any of the Topics in the right pane, the property pane displays the property settings for that topic.

Behavior Properties

CancelKey

When True, this property disables the AutoKeyword property on a topic by topic basis.

CancelMap

When True, this property disables the AutoContextID property on a topic by topic basis.

CancelTag

When True, this property disables the AutoLink property on a topic by topic basis.

TopicType

Defines a pre-determined collection of attributes to a topic (i.e. what window the Help topic appears in, how the Help topic is accessed, whether it gets a map number).

Display Properties

ButtonLabel

Specifies the text that precedes the subtopic buttons on a topic by topic basis. Set this property to an empty string to suppress the default More: label.

ContentsTitle

Allows for modification of the topic titles in the Help window contents area without changing the actual topic title in the source document.

ContextString

When using context-sensitive and dynamic help with Microsoft Help 2.0, specifies a context string for the topic.

DisplayTitle

Allows for modification of the topic title in respect to Help file searches without changing the actual topic title in the source document.

Miscellaneous Properties

AsciiName

Specifies the ASCII-only string used to identify the topic in situations where non-ASCII characters are not allowed.

Comments

When activated, this property provides an editable textbox to be used for comments by the Help author. These comments are not accessible by the end user.

Condition

For a topic, defines a condition for including this topic in a help target.

ID

Returns a unique numeric identifier assigned to the topic during compilation (read-only).

Parent

Shows the ID number of the related parent topic.

Title

Returns the topic title (read-only).

URL

Specifies the name of the generated .htm file for a topic.

WinHelpMacro

Specifies a macro to run when a Help target, a topic, or secondary window is opened.

Modular Properties

MergeContents

For a placeholder topic in a modular hub project, this property specifies the platform-dependent contents file to be loaded dynamically.

MergeFile

For a placeholder topic in a modular hub project, this property specifies the platform-dependent Help file to be loaded dynamically.

MergeTitle

For a placeholder topic in a modular hub project, this property specifies the text used to clarify like-named topics in keyword search lists.

Natural Search

SearchEnabled

Controls whether ComponentOne Natural Search is enabled for a Help target, document, or topic.

Navigation

RelatedJumps

Controls the order of automatic and/or custom jumps on a topic by topic basis.