IDLitTool::RegisterFileWriter
Syntax | Arguments | Keywords | Version History
The IDLitTool::RegisterFileWriter procedure method registers a file writer component with the iTool. Once registered, the iTool has the ability to instantiate this type of component when needed.
When a writer class is registered with the system, an object descriptor for this operation class is placed in the iTool's file writer folder. To retrieve this descriptor at a later time, the iTool relative identifier would be FILE WRITERS/identifier, where identifier is the identifier provided to this method.
Syntax
Obj->[IDLitTool::]RegisterFileWriter, Name, ClassName [, /DEFAULT] [, DESCRIPTION=string] [, ICON=string] [, IDENTIFIER=string] [, PROXY=string]
Arguments
Name
A string containing the human readable name of the component 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 component being registered. The iTool object uses this class name to instantiate a component of this type when requested by the system.
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
Set this keyword to specify that the file writer being registered should be the default file writer. When the iTool system picks a writer for a file of the specified type, it will attempt to use the specified file writer first. The file writer will also be displayed at the top of the list of file writers displayed for the user to select from.
Note
If you register more than one file writer with the DEFAULT keyword set, the last file writer registered will appear first in the list of file writers.
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 file writer 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 file writer 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. (See iTool Object Identifiers (iTool Developer's Guide) for a discussion of object descriptors.)
Version History
