[]
        
(Showing Draft Content)

C1.Win.C1DynamicHelp.MapItem

MapItem Class

Class containing a pair consisting of a topic and a user action triggering its display.

Inheritance
MapItem
Namespace: C1.Win.C1DynamicHelp
Assembly: C1.Win.C1DynamicHelp.4.8.dll
Syntax
public class MapItem
Remarks

Objects of this class are stored in the TopicMap dictionary. Map items are created automatically at design time and in authoring mode. You can also create them at run time programmatically. Map items created at design time have their ItemType property set to Static, whereas map items created in authoring mode have their ItemType property set to MapItemType.Dynamic. If you create a map item programmatically, you can set this property to any of the two values.

Constructors

Name Description
MapItem()

Initializes a new of instance of a MapItem

Properties

Name Description
HelpTopic

Gets the HelpTopic object by the Url value.

HelpTopicTrigger

Specifies what triggers the topic display.

ItemType

Gets or sets an item type.

ShowDefaultTopicFirst

Gets or sets a value indicating whether the default topic (the topic associated with the form) should be always displayed when the form is loaded and becomes visible, even if a UI element inside the form got focus and has a topic associated with it.

UIElement

Gets or sets a UI element for which a help topic is displayed.

Url

Gets or sets the URL of a help topic that will be displayed.

UseDefaultTrigger

Gets or sets a value indicating whether a topic will be displayed depending on its own HelpTopicTrigger value or on the DefaultTrigger value of the C1DynamicHelp control.

Methods

Name Description
ToString()

Returns a string representation of a MapItem, which is the topic URL.