open (verb)Open a collection if none is open, or open one or more icons in an open collection. (from Standard Suite)
The open command serves two purposes:
- Open a collection if none is already open.
- Open icons within an already opened collection.
To open a collection, you pass an alias to the file. (Passing a file reference or a string returns an error.) Along with the alias, you can also pass one or more of the four optional parameters. If the collection has a master password, the text passed in that parameter is used to bypass the dialog. (If the password parameter is omitted, Helix presents the standard dialog for entering the collection password.) In like manner, passing a user name (with or without a user password) avoids as much of the manual process as possible. That is, if there is a password for the supplied user, but no password is supplied, Helix presents a dialog asking for just the password. If neither is supplied, the standard user loging dialog is presented.
Once a collection is open, the
open command can be used to windows for the various Helix icons that use editor windows. You can pass icons by name:
open relation "Global", by index:
open view 3, or by object id:
open object id 15.
- When opening a collection, if a list of aliases is supplied, the list is searched for the first collection that can be opened with the specified optional parameters. All other items in the list are ignored.
- When opening a collection, the target must be the application level. When opening an icon, the target must be in the direct hierarchy to the icon(s) to open. (Targeting
collection 1 allows you to open icons from various relations, assuming the reference can be resolved logically. That is, telling the collection to
open view 1 will not work, as there are no views at the collection level. In that case, you must either
open view 1 of relation 1 or
tell relation 1 to open view 1.
or list of windowWhen opening a collection, the reply is empty (null); when opening an icon, a reference to the resulting window (or an error if unsuccessful) is returned.
||alias, list of alias, helix icon or list of helix icon
||Direct parameter is an alias (if there is no collection open) or one or more icon icons (if a collection is open).
||The collection password
||Open the collection in user mode (true) or design mode (false). Omit this to open in whatever mode the specified user is in.
||The name of the user icon with which to open the collection
||The password for the specified user
The following classes respond to the open