IDLitTool::RegisterVisualization
Syntax | Arguments | Keywords | Version History
The IDLitTool::RegisterVisualization procedure method registers a visualization component with the iTool. Once registered, the iTool has the ability to instantiate this type of visualization when needed.
When a visualization class is registered with the system, an object descriptor for this visualization class is placed in the iTool's visualization folder. To retrieve this descriptor at a later time, the iTool relative identifier would be: VISUALIZATIONS/identifier where identifier is the identifier provided to this method.
Syntax
Obj->[IDLitTool::]RegisterVisualization, Name, ClassName [, /DEFAULT] [, DESCRIPTION=string] [, ICON=string] [, IDENTIFIER=string] [, PROXY=string]
Arguments
Name
A string containing the human readable name of the visualization type being registered with the iTool.
Note
If the IDENTIFIER keyword is not supplied, the Name argument will be used as the basis for the component's identifier.
ClassName
A string containing the class name of the visualization component being registered. The iTool object uses this class name to instantiate a visualization component of this type when requested.
Keywords
Note
Any keywords provided to this routine but not listed here are treated as property defaults for the registered item and applied to the registered object when it is created.
DEFAULT
If set, this registered item will be treated as the default visualization for this iTool. Only one default visualization can exist at a time.
DESCRIPTION
Set this keyword to a string that provides a brief description of the component being registered.
ICON
Set this keyword to the icon that should be used when displaying the visualization in an iTool browser. See System Resources (iTool Developer's Guide) for additional details.
IDENTIFIER
Set this keyword to the identifier that should be used by the system for this visualization type. If not provided, an identifier is constructed from the provided name value.
While some items registered with an iTool can contain sub-folders that are specified by identifiers, the visualization registration cannot. As such, any nested identifiers that are registered are not visible to the iTool system.
Note
If an item with the specified identifier has already been registered with the iTool system, the existing item will be replaced by the new item.
PROXY
Set this keyword to the identifier of the object that this registered item should utilize instead of providing a new object descriptor. If a proxy is registered, all requests and actions performed on this item are routed to the item specified by the identifier provided for this keyword.
Version History
