This topic describes the characteristics of a component. A blank component (Blank_component.bqy) is provided and installed with Dashboard Studio. The blank component is used to implement the core of a component. See Dashboard Studio Blank Component.
These properties are used to identify Dashboard Studio frames from other dashboard sections. The FrameType property is the key property that marks a dashboard as the core of a component.
FrameType.Text—A text string used by the framework to identify dashboard sections where JavaScript services and properties for the component are defined. Value = 1020.
txlMe.Text—A text string used by JavaScript routines to set the context of their declarations and definitions. Value = dashboard section name.
VersionInfo.Text—A string separated by a carriage return. Component builders can change the first five elements: the identifiers for VersionMajor, VersionMinor, VersionRevision, VersionBuild, and VersionCheckin. However, some elements are reserved for system and future use and should not be changed.
VersionMajor=x
VersionMinor=x
VersionRevision=x
VersionBuild=x
VersionCheckin=x
InterfaceMajor=2
InterfaceMinor=0
GUID={C1282A7B-9455-48dc-BBBB-46C2EB525AF5}gtxlLanguageStrings.Text—A set of keywords or value pairs that hold language-sensitive values used on buttons and in messages. Loaded by the framework into an associative or hashed array when the document starts up or the language is changed. The array can be accessed using JavaScript of the form:
ActiveDocument.Qiq_harConstants[<keyword>]
where <keyword> is derived from the values in the text label. Examples of two language strings that can be placed in the text label are:
HOME=ENUS~Home|FRFR~Acceuil|DEDE~Homepage FILTERS=ENUS~Filters|FRFR~Filtres|DEDE~Filter
The framework creates two entities in the hashed array indexed by the string values txlMe.Text+”HOME” and txlMe.Text+”FILTERS”, as the keywords to reference the entries in the array. The use of txlMe ensures uniqueness. The language text must be in escaped form if it contains a carriage return (\r\n), equals (=), tilde (~), or pipe (|).
gtxlToolTip.Text—A set of keywords or value pairs used to hold language-sensitive values for floating comments displayed in Help mode. The value must match the control name it describes. gtxlToolTip.Text uses identical syntax to gtxlLanguageStrings.Text. Loaded by the framework into an associative or hashed array when the dashboard starts up or the language is changed. The array can be accessed using JavaScript of the form:
ActiveDocument.Qiq_harToolTip[<keyword>]
where <keyword> is the name of the control that is clicked. For example, txlMe.Text+"TOOLTIP_"+myControlName is used to find a control floating comment. The language text must be in escaped form if it contains a carriage return (\r\n), equals (=), tilde (~), or pipe (|). If a floating comment keyword is not found using this method, the framework calls the component Qiq_initToolTip function to return the correct floating comment.
txlParent.Text—The component name from which features are inherited. Reserved for future use.
PrototypeName.Text—Not used in FrameTypes under 1100.
Implements.Text—Not used in FrameTypes under 1100.
CloneImplements.Text—Not used in FrameTypes under 1100.
See “Template Structure” in the Hyperion Interactive Reporting – Object Model and Dashboard Development Services Developer's Guide, Volume 5: Dashboard Studio.