Suites: Helix Design Suite, Helix Data Suite, Required Suite, Standard Suite, AppleScript Types

Helix Design Suite

Helix Design Suite Apple events in Helix that control the design elements of a collection. This version of the dictionary was produced from Helix RADE 7.0.4.

Commands

Add

add (verb)Add an existing object or record as an element. Only one of the optional parameters (at or after) may be specified. (from Helix Design Suite)

Function Syntax

Result

index element The added object or record.

Parameters

Parameter
Required
Type
Description
direct parameter required index element, field, abacus, post or menu item The object or record to add. This varies depending on what you are adding to. This needs extensive documentation.
after optional abacus, field or integer Add the new item after the specified value. In a user menu, specify the ordinal position the item is to be inserted after; items below this are pushed down. In an index, specify the icon in the ordering key to put this ordering key after.
at optional integer or location specifier In a user menu, specify the ordinal position where the item is to be inserted; the existing item and all below it are pushed down. In an index, the front is the first sorting key. front is equivalent to 1. Only front, back, and integers are recognized.

Allow incoming connections

allow incoming connections (verb)Controls whether new clients will be accepted. This is valid for Server only. (from Helix Design Suite)

Command Syntax

allow incoming connections boolean

Parameters

Parameter
Required
Type
Description
direct parameter required boolean TRUE to allow clients to connect; FALSE to disallow them.

Check rectangle overlap

check rectangle overlap (verb)Check that rectangles do not overlap. (from Helix Design Suite)

Function Syntax

set theResult to check rectangle overlap template ¬
     stopping on error boolean

Result

list of error record A list of rectangles that overlap

Parameters

Parameter
Required
Type
Description
direct parameter required template Checks for rectangle overlap.
stopping on error optional boolean Optional. If specified as true, any detected error will cause an error return. Default is false, which returns a list of errors as the result of the command.

Check structure

check structure (verb)Check the structure of the entire collection. The function of this command is likely to change in the future, but for now it writes a log file detailing any errors that it finds. (from Helix Design Suite)

Function Syntax

set theResult to check structure collection ¬
     stopping for errors boolean ¬
     fixing errors boolean ¬
     returning list boolean ¬
     displaying progress boolean ¬
     writing log boolean

Result

integer or list of structure check result The maintenance count, unless 'returning list' is true: list of maintenance fixes.

Parameters

Parameter
Required
Type
Description
direct parameter optional collection The collection to check. This is optional because there is only one collection that can be checked.
displaying progress optional boolean If specified as true, a progress dialog is displayed during the structure check, and summary dialog is displayed at its completion. If there are no errors and nothing to fix, the summary dialog is not displayed.
fixing errors optional boolean If not specified or specified as TRUE, fixes any errors. If specified as FALSE, every error will cause an error to be returned.
returning list optional boolean If true, returns a list of errors. If the structure check stops with an error, the error list is returned in the partial result of the catch block, otherwise the error list is returned as the value of the command. Only the first 32767 errors are returned. If a list is not requested, the count of the number of errors corrected is returned instead.
stopping for errors optional boolean If specified as TRUE, any error detected will return an error. If not specified or FALSE, only structure damage will return an error.
writing log optional boolean If false, will not write log file to ~/Library/Logs/Helix/SC_.log

Close

close (verb)Close a window or icon. (To close the collection, see close collection.) (from Helix Design Suite)

Description

A window is simply a representation of an underlying object within Helix. A window may display information about an icon, such as when a relation window displays the contents of that relation. A window may also display other information about the current Helix environment, such as the information displayed in the Collection Information window.

Windows are identified by their index number, which is the front-to-back order of all of the open windows. Using this index number, a window can be closed by specifying its current position, as in close window 1 to close the frontmost window. You can also close an icon’s window by specifying the icon as the direct parameter for the close command, as in close relation "Customers" or close relation 3. You should not attempt to close a window by name, as in close window "Customers" — to close an icon by name, specify the icon itself.

Additional notes:

  • When the direct parameter is omitted, the window of the current target is closed.
  • When an icon editor window is closed, changes made to that icon are automatically committed.
  • Windows are managed by the Helix application, and are not technically part of the collection itself, so when working with windows, the target should be the application itself, not a specific icon within an open collection.
  • If the close command is sent to an icon that is not open, no error is returned. (Sending the command to a non-existent window does return an error.)

Command Syntax

close window , of window , helix icon or list of helix icon

Parameters

Parameter
Required
Type
Description
direct parameter optional window, list of window, helix icon or list of helix icon the window(s) or icon(s) to close.

Classes

The following classes respond to The close command:

Close collection

close collection (verb)Close Collection (from Helix Design Suite)

Command Syntax

close collection collection ¬
     saving save options ¬
     discarding unentered data boolean

Parameters

Parameter
Required
Type
Description
direct parameter optional collection The collection to close. This is ignored since currently Helix can only have one collection open.
discarding unentered data optional boolean Setting this parameter to true discards any unentered records without a dialog asking for permission. Note: when saving is false, this is automatically true.
saving required save options Specify whether to save changes, display dialogs, etc.

Commit

commit (verb)Commit changes made to one or more icons. Returns an error if an icon could not be committed. The partial result property of the error contains a list of objects that prevented the commit. (from Helix Design Suite)

Function Syntax

set theResult to commit helix icon or list of helix icon

Result

list of helix icon List of icons that were changed. On error, the 'partial result' property of the error lists the specific icon(s) that prevented the commit.

Parameters

Parameter
Required
Type
Description
direct parameter required helix icon or list of helix icon The icons to commit

Classes

The following classes respond to The commit command:

Commit all

commit all (verb)Commit all outstanding changes to the collection. Changes to entire collection are committed, no matter which object receives this command. If any icon can not be committed, no icons are committed and an error is returned. (from Helix Design Suite)

Function Syntax

set theResult to commit all

Result

list of helix icon List of icons that were changed. On error, the 'partial result' property of the error lists the specific objects that prevented the commit.

Delete all data

delete all data (verb)This removes all data from a field or relation. Deleting all data can take a long time, so be sure to specify a timeout value in your script. (from Helix Design Suite)

Command Syntax

delete all data field , list of field , relation or list of relation

Parameters

Parameter
Required
Type
Description
direct parameter optional field, list of field, relation or list of relation

Do menu

do menu (verb)Selects the specified menu item, just as if a user had chosen it from the menu. If the menu item leads to a dialog, that dialog will be presented and the script will hang until the dialog is handled by the user. (from Helix Design Suite)

Description

The do menu command is a ‘menu driver’ with no real intelligence of its own. An example of usage: a system administrator can create a launchd task to run script that used ‘do menu’ to invoke a sequence that need to run during off-peak hours. (However, for this particular task, The run sequence command is a better choice.)

do menu searches for the specified menu item beginning in the left-most menu (the Apple menu) and working across to the right. Each menu is checked, and the first instance of a matching menu item found is processed.

If no error is encountered, no reply is returned by do menu. If no matching menu item is found, error 280 is returned; if a matching menu item is found, but is disabled, error 290 is returned.

In Helix RADE do menu works in both Design Mode and User Mode, and is also available in Helix Client and Helix Engine.

Command Syntax

do menu text or list of text

Parameters

Parameter
Required
Type
Description
direct parameter required text or list of text Menu item to choose. When the parameter is a list, only the first item in the list is processed.

Get color index

get color index (verb)Get the RGB color at given index in the Helix color table. (from Helix Design Suite)

Function Syntax

set theResult to get color index color index

Result

RGB color The color at the specified index

Parameters

Parameter
Required
Type
Description
direct parameter required color index The index of the color to get. Must be between 0 and 255.

Get index for color

get index for color (verb)Get index of a color (from Helix Design Suite)

Function Syntax

set theResult to get index for color RGB color ¬
     exact match required boolean

Result

color index Where the color was found in the index table

Parameters

Parameter
Required
Type
Description
direct parameter required RGB color The color to look up in the color index table
exact match required optional boolean If false or omitted, Helix returns the index of the closest entry in the color table. If this is true, Helix returns the the index only if it is an exact match. If there is no exact match, Helix returns an error.

Login

login (verb) Identify the user to protect against unauthorized access to the structure of a collection. (from Helix Design Suite)

Description

In the graphic interface, users are able to see the structure of the collection only when using Helix RADE in Design Mode. AppleScript also allows access to the collection design while using Helix RADE in User Mode, as well as in Helix Engine and Helix Server. To prevent unintended access to the design of a collection (whether for security purposes or to protect proprietary code) the login command is required when an AppleScript attempts to access the structure of the collection. The only exception to this is when the collection is open in Helix RADE Design Mode, as the user already has access to the structure in that situation.

The login command requires one direct parameter: a text string containing the Username of a user icon that has The Design Mode command somewhere within its menus. (You can quickly identify such users by checking the ‘Has Design Mode’ property in the Inspector.) Note that this parameter is a text string, not a reference to a user icon. That is, the proper syntax is login "Fred" and not login user "Fred". Of course, a variable or property may be used in place of a string.

If the user has a password, the password parameter must supply that password, just as you must supply it when logging in via the graphic interface.

The last parameter, modifying allowed, deserves special consideration. When this parameter is omitted (or set to false ) the script may read the structure, but modifications are prohibited. It is important to note that modifications are not allowed at the same time as data access: an error is returned if a script attempts to login with modifying allowed and any Clients are logged in (for Helix Server) or there are any open data access processes (for RADE, Engine, and Server).

When login with modifying allowed is successful, two important things happen:

  1. External access is blocked. Helix Clients are not allowed to connect to a Server and Apple event processes may not be opened. For this reason, it is important that scripts that use login to modify structure also include a logout command to re-enable external access.
  2. The ‘revision level’ of the collection is incremented. Helix Clients will be informed that the structure has been updated the next time they connect to the Server.

The login command, with no parameters at all, is the same as logout.

Command Syntax

login text ¬
     password text ¬
     modifying allowed boolean

Parameters

Parameter
Required
Type
Description
direct parameter required text Username of a user icon with Design Mode access.
modifying allowed optional boolean Whether to access the structure as read only or to also allow modifications. Allowing modifications is only possible when there are no connected Clients (for Helix Server) or open Process IDs. When omitted, modifications are not allowed.
password optional text The user's password.

Logout

logout (verb)Terminate Apple Event access to the collection. (from Helix Design Suite)

Command Syntax

logout

Move

move (verb)Move rectangle to a new ordinal (z-index) value. Only one of the four optional parameters may be specified. In a normalized template, background rectangles appear only at the back of the page rectangle. This command does not enforce that requirement. (See the normalize template command.) (from Helix Design Suite)

Command Syntax

move template rectangle ¬
     after template rectangle ¬
     to location specifier ¬
     forward integer ¬
     backward integer

Parameters

Parameter
Required
Type
Description
direct parameter required template rectangle The rectangle to move.
after optional template rectangle The new ordinal (z-index) value for the object. This can be used to move a rectangle between bounding rectangles (border or repeat rectangles), but not from one template to another. (To do that, make a new rectangle with the same properties.) In a normalized template, all background rectangles are directly in the page rectangle.
backward optional integer Number of rectangles to pass in the backward direction.
forward optional integer Number of rectangles to pass in the forward direction.
to optional location specifier Only 'front' or 'back' is recognized. It moves the rectangle to the named end of the group or repeat rectangle that it is currently in.

Normalize template

normalize template (verb)Deprecated command. This no longer does anything. Templates are always normalized. (from Helix Design Suite)

Command Syntax

normalize template

Rebuild

rebuild (verb)Rebuilds an index (icon or keyword) when records appear out of order, or when a format change invalidates current indexes. (from Helix Design Suite)

Command Syntax

rebuild index or field

Parameters

Parameter
Required
Type
Description
direct parameter required index or field The icon (index or keyword field) to rebuild

Remove

remove (verb)Remove an element. Either the direct object or the at parameter may be specified, but not both. (from Helix Design Suite)

Function Syntax

Result

index element The object or record removed.

Parameters

Parameter
Required
Type
Description
direct parameter optional index element, location specifier, integer, post or menu item The object or record to remove. An integer can also be used to specify the item by its ordinal (z-index) value.

Revert

revert (verb)Forget changes that have been made. Returns an error if a specified icon does not have pending changes. (from Helix Design Suite)

Function Syntax

set theResult to revert helix icon or list of helix icon

Result

list of helix icon List of icons that have had changes discarded

Parameters

Parameter
Required
Type
Description
direct parameter required helix icon or list of helix icon The icon to revert

Classes

The following classes respond to The revert command:

Revert all

revert all (verb)Discard all pending changes to all icons. (from Helix Design Suite)

Function Syntax

set theResult to revert all

Result

list of helix icon List of icons that have had changes discarded

Set color index

set color index (verb)Set an indexed color. DEPRECATED. Indexed color will be removed in a future version of Helix. (from Helix Design Suite)

Command Syntax

set color index color index ¬
color RGB color

Parameters

Parameter
Required
Type
Description
direct parameter required color index The index number of the color to set
color required RGB color The color to set at the given index

Set permissions for

set permissions for (verb)Change allowed operations (from Helix Design Suite)

Command Syntax

set permissions for view ¬
to allowed operations or list of allowed operations

Parameters

Parameter
Required
Type
Description
direct parameter required view The icon to change allowed operations for. This command can be used two different ways: tell <user> to set permissions for <view> to <permissions>, or. tell <view> to set permissions for <user> to <permissions>. Permissions may be examined by looking at the permissions elements of a user (but they cannot be changed there)
to required allowed operations or list of allowed operations Permissions to set for this user/view combination

See Also

Version

version (verb)Returns the version of Helix that is running. DEPRECATED: get the 'version' property of the application instead. (from Helix Design Suite)

Function Syntax

set theResult to version

Result

integer

Classes

Abacus

abacus (noun), pl abaciAn abacus holds a calculation

Properties

Property
Access
Type
Description
answer index get integer The element number containing the root of the calculation tree for the expression represented by this abacus icon. if there are no dangling arrows, or more than one dangling arrow, this property is 0, indicating an invalid abacus.
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
common calculation get/set boolean Retain the result of an abacus calculation in memory.
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
data type get/set data types Specific type of data this field stores, or this abacus produces. The default data type for a new field is text. For an abacus, the data type is read only.
data icon
editor open get boolean Is the editor window for this icon currently open?
helix icon
expression get/set text The entire abacus expression in a single line
format get/set date format, fixed point format, number format, flag format, text format or missing value Characteristics used to display the data. The type of format must be matched to the 'data type' property.
data icon
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
includes form tile get boolean There is a form tile somewhere in this calculation.
includes form time tile get boolean There is a form time tile somewhere in this calculation.
includes inert field get boolean There is an inert field somewhere in this calculation.
includes lookup tile get boolean There is a lookup tile somewhere in this calculation.
includes post time tile get boolean There is a post time tile somewhere in this calculation.
includes statistics tile get boolean There is a statistics tile somewhere in this calculation.
includes today tile get boolean There is a today tile somewhere in this calculation.
includes unique tile get boolean There is a unique tile somewhere in this calculation.
includes use from tile get boolean There is a use from tile somewhere in this calculation.
includes user name tile get boolean There is a user name tile somewhere in this calculation.
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
summary calculation get boolean This is some kind of summary calculation.
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Elements

Element
Access
Key Forms
Description
abacus element get/ make/ delete by index
One piece of the abacus calculation. Typically, this is a tile, but it may also be an icon when the abacus is improperly constructed.

Commands

The abacus class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.)
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The abacus class inherits elements and properties from data icon.

Where Used

The abacus class is used in the following ways:

element of relation

direct parameter to the add

abacus icon property of the data rectangle

after parameter of the add

calculated label property of the command rectangle

calculation property of the conditional style item

dangler property of the abacus element

display value property of the dynamic popup

host link icon property of the subform linkage

iteration value property of the conditional sequence item

parent property of the tile

sorting icon property of the index element

source query property of the dynamic popup

stored value property of the dynamic popup

subform link icon property of the subform linkage

subform query property of the subform linkage

validation calculation property of the field

view query property of the view

Abacus element

abacus element (noun), pl abacus elementsTiles and icons that appear on the surface of the abacus window.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
dangler get/set tile, abacus, field, template or relation The object that is not in any other tile.
location get/set point The upper left corner of icon or the upper left corner of a box around the dangling arrow.
properties get record A record with all the properties of the item.
item

Superclass

The abacus element class inherits elements and properties from item.

Where Used

The abacus element class is used in the following ways:

element of abacus

Application

application (noun)The application's top-level scripting object.

Properties

Property
Access
Type
Description
apple event maximum add get/set integer Preference HxAppleEventMaxAdd. The maximum number of records to add in one Apple Event.
apple event maximum delete get/set integer Preference HxAppleEventMaxDel. The maximum number of records to delete in one Apple Event.
apple event maximum get get/set integer Preference HxAppleEventMaxGet. The maximum number of records to get in one Apple Event.
check structure on open get/set boolean Preference HxCheckStructureOnOpen. Check structure when opening collection.
check structure on save get/set boolean Preference HxCheckStructureOnSave. Check structure when saving collection.
class get type class The class of the object
item
current apple event processes
[synonyms: current processes ]
get integer The number of Apple event processes currently open.
current users get integer The number of clients currently logged into Server. For RADE or Engine, the result is always 1.
frontmost get boolean Is this the frontmost (active) application?
maximum apple event processes
[synonyms: maximum processes ]
get integer The limit on the number of Apple event processes that can be open at one time.
maximum users get integer The limit on the number of users this program is licensed for. In Server, this is the number clients that can connect at the same time. In RADE, this is the number of copies of the program that can run at the same time.
name get text The name of the application.
properties get record A record with all the properties of the item.
item
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
version get text The version of the application.

Elements

Element
Access
Key Forms
Description
collection get by name
by index
by unique ID
A Helix database structure, created with Helix RADE. A collection contains all the internally stored data and structures that have been created, entered and saved.
window get by name
by index
by range
relative to others
by whose/where
by unique ID
A graphic interface element that shows the contents of an icon.

Commands

The application class responds to the following commands:
Command
Description
open Open a collection if none is open, or open one or more icons in an open collection.
print Print a document.
quit Quit application

Superclass

The application class inherits elements and properties from item.

Collection

collection (noun), pl collections[synonyms: col ] This outermost structural object of a Helix collection. Contains relation, sequence, and user elements.

Properties

Property
Access
Type
Description
active user get user The user icon that is currently active. This may be a primary (top level), secondary (submenu) or administrator user type. Not available in Server.
autosave get/set autosave parameters The parameters for AutoSave, including the boolean to turn it on and off.
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
client idle timeout get/set integer Minutes of idle before a client is automatically logged out. 0 for no timeout, -1 to use preference (if specified) or timeout specified in the collection.
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
collection password set text A password that is required to open the collection.
columns get/set list of icon list columns A list of up to eight column names, indicating the order of the columns
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
current users get integer The number of clients currently logged into Server.
custom name get/set text The custom name of the icon
helix icon
display mode get/set display modes The display mode
display order get/set list of icon list columns or list of directions A list of up to three icon list columns indicating which columns to sort on, and up to 3 directions (ascending or descending), indicating which direction to sort the corresponding column. The Content column cannot be used for sorting.
dividers get/set list of integer Up to eight integers in ascending order, indicating the left edge (in pixels) of the up to eight named columns in the window.
editor open get boolean Is the editor window for this icon currently open?
helix icon
file get alias The disk path to the collection as an alias.
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
modified get boolean Has the document been modified since the last save?
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
primary user get user The user icon that is currently active, excluding secondary users. That is, the top level or login user, which is the user that the user name tile returns. Not available in Server.
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
session data log get text Path to the Session Data Log file.
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode get/set boolean Is the GUI in user mode (true) or design mode (false). Change this value to change between user mode and design mode. When changing to user mode, this changes the menus to those of the user that is the current user in the GUI, not the user that "logged in" via AppleScript. This can only be changed in RADE; other programs alway report "true".
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
user name security get/set boolean Is user name security on?
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Elements

Element
Access
Key Forms
Description
helix icon get by name
by index
by unique ID
Any of the following
relation get/ make/ delete by name
by index
by unique ID
A related group of data items and structures.
sequence get/ make/ delete by name
by index
by unique ID
A series of actions that can be activated with a single command. Sequences can contain user, view, and sequence icons, most menu commands, and some specialized sequence commands.
user get/ make/ delete by name
by index
by unique ID
A personalized set of menus, with commands, forms (with customizable permissions) and command key equivalents. Users may have passwords to provide data security.

Commands

The collection class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The collection class inherits elements and properties from helix icon.

Where Used

The collection class is used in the following ways:

direct parameter to the save

element of application

direct parameter to the check structure

direct parameter to the close collection

parent property of the helix icon

Command rectangle

command rectangle (noun), pl command rectangles[synonyms: crec ] A rectangle that appears as a button and initiates a sequence when triggered.

Description

Command rectangle creates a clickable button on a view. When clicked, a command rectangle executes one or more sequences. There must be at least one sequence (the command property) in each command rectangle or the entire template is invalid.

The name of the button as it appears on the view is taken from the command label or calculated label property, depending on the value of The use calculated label property.

A button is disabled when there is a calculated label icon whose output is undefined, or when the first command in the primary sequence is invalid in the current environment, e.g. a copy command when no data is selected.

A disabled button is dimmed or made invisible, depending on the value of the hide when disabled property. For a dimmed button, the button name is taken from the first defined value found in these properties, in this order: 1) disabled label, 2) command or calculated label, 3) sequence name.

Only icons that output text are eligible for use as a calculated label.

See this technotefor more on button naming.

Properties

Property
Access
Type
Description
allow print get/set boolean The rectangle prints.
styled rectangle
background color get/set RGB color or color index Color of background of rectangle.
styled rectangle
calculated label get/set abacus or field A text output field or abacus that controls button behavior. If "calculated button label" is true, the output is used as the button's label text. If the icon output is undefined, the button is disabled.
class get type class The class of the object
item
command get/set sequence The primary sequence for this button.
command label get/set text or picture The label of the button: picture or text. When "use calculated label" is true, this is ignored. When "use calculated label" is false and this is undefined, the sequence name is used. For a transparent button, set this text to a single space.
conditional sequences get/set list of conditional sequence item Additional sequences that are run conditionally.
default button get/set boolean This button is triggered on any enter event. (Enter key, menu selection, etc.) There can be only one default button on a template; attempting to assign more than one returns an error.
disabled label get/set text Text to use as the name when the button is disabled. If empty, the "command label" or "calculated label" is used.
font get/set font style or list of font style run Font style to use, if there is only one, or an ordered list of font style runs
styled rectangle
frame color get/set RGB color or color index Color of frame of rectangle.
styled rectangle
framed get/set boolean Does the rectangle have a visible frame?
template rectangle
has large picture get boolean The rectangle content is a picture larger than 32K. This is a Classic optimization property that may or may not be maintained in macOS.
has local label get boolean Deprecated: Classic flag signaling the presence of a local label, as opposed to one derived from the main sequence name.
has picture get boolean The rectangle content is a picture.
hide disabled button get/set boolean Make the button invisible when the sequence is invalid, or when the "calculated label" output is undefined. False by default, meaning the button is dimmed when disabled.
id get integer ID is unique within each collection
object
justification
[synonyms: alignment ]
get/set justification options Text justification direction
styled rectangle
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
template rectangle
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
template rectangle
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
template rectangle
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
template rectangle
properties get record A record with all the properties of the item.
item
scale picture get/set boolean The picture should be scaled to fit in the rectangle. Meaningful only if the rectangle holds a picture.
styled rectangle
transparency get boolean The command label is a single space. Deprecated. macOS ignores this property, calculating transparency regardless of the texts origins.
use calculated label get/set boolean Whether to use "calculated label" or "command label" for the button name.
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
template rectangle
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
template rectangle
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?
template rectangle

Superclass

The command rectangle class inherits elements and properties from styled rectangle.

Constant

constant (noun), pl constantsA value typed directly into a socket in a tile. This object is completely read-only. To use a different constant, make a new constant object.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
data type get data types Interpret the value as this type of data.
id get integer ID is unique within each collection
object
properties get record A record with all the properties of the item.
item
value get text The constant value

Superclass

The constant class inherits elements and properties from object.

Data icon

data icon (noun), pl data iconsAn icon that handles data and can be used in a calculation. (That is, a field or abacus.)

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
data type get/set data types Specific type of data this field stores, or this abacus produces. The default data type for a new field is text. For an abacus, the data type is read only.
editor open get boolean Is the editor window for this icon currently open?
helix icon
format get/set date format, fixed point format, number format, flag format, text format or missing value Characteristics used to display the data. The type of format must be matched to the 'data type' property.
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Commands

The data icon class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The data icon class inherits elements and properties from helix icon.

Subclasses

The abacus and field classes inherit the elements and properties of the data icon class.

Where Used

The data icon class is used in the following ways:

permanent items property of the power query

reference items property of the power query

searchable items property of the power query

source data property of the post triplet

source value property of the post parameters

target value property of the post parameters

Data rectangle

data rectangle (noun), pl data rectangles[synonyms: drec ] A rectangle that holds a field or abacus icon. (Or one of each.)

Properties

Property
Access
Type
Description
abacus icon get/set abacus or null object The abacus that calculates the default value (if a field is present) or the displayed value (if a field is absent). Setting this also sets the format of the rectangle to the format of the abacus.
allow click get/set boolean Clicking to focus on the rectangle is allowed.
allow edit get/set boolean Data in the rectangle may be changed.
allow print get/set boolean The rectangle prints.
styled rectangle
allow query get/set boolean The field in the rectangle may be queried in a quick query or form query.
allow tab get/set boolean Tabbing to focus on the rectangle is allowed.
background color get/set RGB color or color index Color of background of rectangle.
styled rectangle
class get type class The class of the object
item
conditional style get/set list of conditional style item List of conditional styles, in priority order
enable horizontal scrollbar get/set boolean Include a horizontal scrollbar when necessary to show text. Ignored in macOS Helix due to conflict with word wrap.
enable vertical scrollbar get/set boolean Include a vertical scrollbar when necessary to show text.
field icon get/set field or null object The field icon that holds the data values. Setting this also sets the format of the rectangle to the format of the field icon.
font get/set font style or list of font style run Font style to use, if there is only one, or an ordered list of font style runs
styled rectangle
format get/set date format, fixed point format, number format, flag format, text format or missing value The characteristics used to display the data. Different properties are required for different data types, so be sure to set the data type before setting the format.
frame color get/set RGB color or color index Color of frame of rectangle.
styled rectangle
framed get/set boolean Does the rectangle have a visible frame?
template rectangle
id get integer ID is unique within each collection
object
justification
[synonyms: alignment ]
get/set justification options Text justification direction
styled rectangle
keep value get/set boolean Use current data value as default value for the next new record.
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
template rectangle
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
template rectangle
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
template rectangle
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
template rectangle
properties get record A record with all the properties of the item.
item
rotation get/set integer Number of degrees to rotate the rectangle. -180.00 to 180.00. Positive is clockwise.
scale picture get/set boolean The picture should be scaled to fit in the rectangle. Meaningful only if the rectangle holds a picture.
styled rectangle
spell check get/set boolean Use the macOS spell checker on data typed into the rectangle.
use custom format get/set boolean Use the format specified in the rectangle, overriding the format defined for the icon.
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
template rectangle
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
template rectangle
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?
template rectangle
word wrap get/set boolean Wrap words only on return or linefeed. Set to false to wrap text according to the rectangle width.

Superclass

The data rectangle class inherits elements and properties from styled rectangle.

Field

field (noun), pl fieldsA field is an icon that holds data

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
data type get/set data types Specific type of data this field stores, or this abacus produces. The default data type for a new field is text. For an abacus, the data type is read only.
data icon
editor open get boolean Is the editor window for this icon currently open?
helix icon
datakey get integer Move along. Nothing to see here.
format get/set date format, fixed point format, number format, flag format, text format or missing value Characteristics used to display the data. The type of format must be matched to the 'data type' property.
data icon
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
ignore words get/set list of text Words to ignore when building keyword index. [keyword fields only]
index object get integer, index or missing value Keyword index object ID [keyword fields only]
inert get/set boolean Field is not stored in data base
invisible get/set boolean Is the window for this icon invisible?
helix icon
keep versions get/set boolean keep versions [document type only]
keyword get/set boolean keyword field [text type only]
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
record count get integer The number of records in the relation with a value for this field defined
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
storage type get/set document storage types Store documents internally, externally, or let the user choose.
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
validation calculation get/set abacus or missing value The validation criteria, whether from a built-in tile or user-defined abacus. To use an abacus validation, set this property to the validating abacus.
validation tile get/set tile validation or missing value When this value is set, the validation is created using the built-in validation tiles. The resulting validation is stored in the 'validation calculation' property.
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Commands

The field class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
commit Commit changes made to one or more icons. Returns an error if an icon could not be committed. The partial result property of the error contains a list of objects that prevented the commit.
open Open a collection if none is open, or open one or more icons in an open collection. helix icon
revert Forget changes that have been made. Returns an error if a specified icon does not have pending changes.

Superclass

The field class inherits elements and properties from data icon.

Where Used

The field class is used in the following ways:

element of relation

direct parameter to the add

direct parameter to the delete all data

direct parameter to the rebuild

after parameter of the add

calculated label property of the command rectangle

dangler property of the abacus element

display value property of the dynamic popup

field icon property of the data rectangle

host link icon property of the subform linkage

iteration value property of the conditional sequence item

quick query field property of the quick query expression

sorting icon property of the index element

stored value property of the dynamic popup

subform link icon property of the subform linkage

target field property of the post triplet

Form query

form query (noun), pl form queriesA form query selects a subset of the records in a relation using template driven criteria

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
editor open get boolean Is the editor window for this icon currently open?
helix icon
expression get text The entire form query expression in a single line
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
search template get/set template The template to use for the query
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Commands

The form query class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The form query class inherits elements and properties from helix icon.

Where Used

The form query class is used in the following ways:

element of relation

source query property of the dynamic popup

subform query property of the subform linkage

view query property of the view

Group rectangle

group rectangle (noun), pl group rectangles[synonyms: grec ] A rectangle that defines an area of the template. As page rectangle, it determines the size of the template. Within a template, useful to control tab order: rectangles within a group are all visited before the rectangle is exited.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
frame color get/set RGB color or color index Color of the frame of the rectangle. This property is not shown on screen, but is used when printing.
frame width get/set integer Width of the rectangle frame. This property is not shown on screen, but is used when printing.
framed get/set boolean Does the rectangle have a visible frame?
template rectangle
id get integer ID is unique within each collection
object
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
template rectangle
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
template rectangle
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
template rectangle
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
template rectangle
properties get record A record with all the properties of the item.
item
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
template rectangle
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
template rectangle
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?
template rectangle

Elements

Element
Access
Key Forms
Description
template rectangle get/ make/ delete by index
by unique ID
All rectangles contained within the borders of this rectangle.

Superclass

The group rectangle class inherits elements and properties from template rectangle.

Subclasses

The repeat rectangle class inherits the elements and properties of The group rectangle class.

Where Used

The group rectangle class is used in the following ways:

page rectangle property of the template

Helix icon

helix icon (noun), pl helix iconsIcons are the elements of a Helix collection that are nameable and appear in the collection or relation window.

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
comment get/set text The comment on the icon
creation date get date The date and time this icon was created.
custom name get/set text The custom name of the icon
editor open get boolean Is the editor window for this icon currently open?
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
modification date get date The date and time this icon was most recently modified.
name get/set text The name of the icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
used by get list of helix icon List of icons that refer to this icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
zoomable get/set boolean Does the window for this icon have a zoom button?

Commands

The helix icon class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.)
open Open a collection if none is open, or open one or more icons in an open collection.

Superclass

The helix icon class inherits elements and properties from object.

Subclasses

The collection, data icon, form query, index, post, power query, relation, sequence, template, user, and view classes inherit the elements and properties of The helix icon class.

Where Used

The helix icon class is used in the following ways:

direct parameter to the duplicate

direct parameter to the open

element of collection

element of relation

direct parameter to the close

result of commit

direct parameter to the commit

result of commit all

result of revert

direct parameter to the revert

result of revert all

backlinks property of the helix icon

selection property of the application

selection property of the window

selection property of the helix icon

used by property of the helix icon

Index

index (noun), pl indexesAn index defines an ordering of the data

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
editor open get boolean Is the editor window for this icon currently open?
helix icon
FVI index get integer Index in FVItable where last found. Useful for collection repair only.
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
index ID get integer The internal index ID. Index IDs are assigned sequentially as indexes are created, starting with Index ID 2. (Index ID 1 is the master index for the relation.)
invisible get/set boolean Is the window for this icon invisible?
helix icon
is valid get boolean The index is currently valid, i.e: does not need to be rebuilt.
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Elements

Element
Access
Key Forms
Description
index element get/ make/ delete by index
Each key is an index element. The first is the most significant key. If two records have the same value for the first key, ties are broken by the second key, etc. A new key may be added with the "add" command; a key may be removed with the "remove" command.

Commands

The index class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The index class inherits elements and properties from helix icon.

Where Used

The index class is used in the following ways:

element of relation

direct parameter to the rebuild

current index property of the dynamic popup

default index property of the view

index object property of the field

order index property of the subform linkage

order index property of the view

selectable indexes property of the view

Index element

index element (noun), pl index elementsAn element in an index definition.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
order get/set directions The direction to sort
properties get record A record with all the properties of the item.
item
sorting icon get/set abacus or field The values that are sorted

Superclass

The index element class inherits elements and properties from item.

Where Used

The index element class is used in the following ways:

element of index

result of add

direct parameter to the add

result of remove

direct parameter to the remove

Item

item (noun), pl itemsThe root superclass. Every object has these properties

Properties

Property
Access
Type
Description
class get type class The class of the object
properties get record A record with all the properties of the item.

Subclasses

The abacus element, application, index element, menu item, object, permissions element, post parameters, post triplet, retrieved data record, and window classes inherit the elements and properties of The item class.

Label rectangle

label rectangle (noun), pl label rectangles[synonyms: lrec ] A rectangle containing text or a picture.

Properties

Property
Access
Type
Description
allow print get/set boolean The rectangle prints.
styled rectangle
background get/set boolean A rectangle that is behind all of the data rectangles.
background color get/set RGB color or color index Color of background of rectangle.
styled rectangle
class get type class The class of the object
item
content get/set picture or text The label (text or picture) being displayed.
font get/set font style or list of font style run Font style to use, if there is only one, or an ordered list of font style runs
styled rectangle
frame color get/set RGB color or color index Color of frame of rectangle.
styled rectangle
framed get/set boolean Does the rectangle have a visible frame?
template rectangle
has large picture get boolean The rectangle content is a picture larger than 32K. This is a Classic optimization property that may or may not be maintained in macOS.
has picture get boolean The rectangle content is a picture.
id get integer ID is unique within each collection
object
justification
[synonyms: alignment ]
get/set justification options Text justification direction
styled rectangle
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
template rectangle
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
template rectangle
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
template rectangle
page numbering get/set boolean Display instances of P# as the page number.
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
template rectangle
properties get record A record with all the properties of the item.
item
rotation get/set integer Number of degrees to rotate the rectangle. -180.00 to 180.00. Positive is clockwise.
scale picture get/set boolean The picture should be scaled to fit in the rectangle. Meaningful only if the rectangle holds a picture.
styled rectangle
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
template rectangle
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
template rectangle
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?
template rectangle

Superclass

The label rectangle class inherits elements and properties from styled rectangle.

Menu item

menu item (noun), pl menu itemsA single menu item that appears in the user menu it is part of. Each menu item has a 'command' property; the presence of other properties is determined by the specific 'user menu command' stored in the 'command' property.

Description

A menu item is an item that appears on the user menu it is part of. (For example: Undo is a menu item found in the Edit user menu.) Each menu item contains at the very least a command property, which is always one of the commands listed in The user menu commands enumeration. All user menu commands (with three exceptions, noted below) end with the word command to differentiate between them and the actual commands, some of which may be executed directly in AppleScript.

A menu item can also have a key binding (also known as a command key equivalent ), enabling the user to activate that menu item by pressing keys on the keyboard. When defining a key binding, both The modifier keys and key properties must be defined. Defining one without the other is illegal and results in an AppleScript runtime error.

The three exceptional user menu commands are: invoke icon, menu, and separator. These three user menu commands provide special capabilities and may require or prohibit additional properties to create a valid menu item:

  • invoke icon : When the command property contains the invoke icon command, The icon property must also contain one of the valid menu item icons: view, sequence or user. The hierarchical menu property must not be defined, and the key binding properties (see above) are optional. When a view is stored in The icon property, three additional properties: location, open window and permissions, may also be defined. (Including any of these three properties with any other command or icon type is illegal and results in an AppleScript runtime error.)
  • menu : When The command property contains the menu command, The hierarchical menu property is a read only property of that item. A hierarchical menu is a user menu inserted within a menu item, instead of in the menu bar. When creating a hierarchical menu, you first add menu items to (code: add {command:menu, name:"name"} ) (and remove menu items from) the menu item.
  • separator : When The command property contains the separator command, a standard Macintosh menu item separator is inserted in the menu. Separators are provided for organizational or decorative purposes, and serve no other function. Separators have no additional properties, and specifying any of them for a separator is illegal and results in an AppleScript runtime error.

When working with existing menu items, always test the command property before assuming the presence of other properties. Determining which user menu command is present will identify which additional properties may be present and which are prohibited. For example, attempting to get the icon property of a separator results in an AppleScript runtime error, because no icon property exists for a separator menu item.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
command get/set user menu commands The command to execute. May be 'invoke icon', 'menu', 'separator', or any command permitted on user menus.
hierarchical menu get user menu A menu inserted into another menu. To create a new hierarchical menu, 'tell' a user menu to 'add' a menu item containing a 'menu' command.
icon get/set view, user or sequence The icon (view, sequence or user) to invoke. Menu items containing an icon may optionally include a keyboard shortcut (key + key modifiers properties) and, for views, the location, permissions, and open window properties.
key get/set text or integer The keyboard shortcut key. A single character as text type. To assign a function key (Fkey) specify a value between 1 and 19 as integer type. When specifing a non-function key, the modifier keys property must also be defined. Not all combinations are supported at this time; incompatible combinations return an error.
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar. Only present when the 'icon' property contains a view.
modifier keys get/set key modifiers Modifier keys for the keyboard shortcut. When specified, the key property must also be defined.
open window get/set boolean Window is initially open when user logs in. Only present when the 'icon' property contains a view.
permissions get/set allowed operations or list of allowed operations Operations allowed on the view. Only present when the 'icon' property contains a view. 'all' means all permissions are enabled; 'none' means all permissions are disabled.
properties get record A record with all the properties of the item.
item

Superclass

The menu item class inherits elements and properties from item.

Where Used

The menu item class is used in the following ways:

element of user menu

direct parameter to the add

direct parameter to the remove

See Also

Null object

null object (noun), pl null objectsA space-holder indicating that there is no object for this purpose. In many cases, supplying a null object is equivalent to not supplying any object.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
id get integer ID is unique within each collection
object
properties get record A record with all the properties of the item.
item

Superclass

The null object class inherits elements and properties from object.

Where Used

The null object class is used in the following ways:

abacus icon property of the data rectangle

default index property of the view

field icon property of the data rectangle

order index property of the view

subform query property of the subform linkage

view query property of the view

Object

object (noun), pl objectsAn object in the collection

Properties

Property
Access
Type
Description
class get type class The class of the object
item
id get integer ID is unique within each collection
properties get record A record with all the properties of the item.
item

Superclass

The object class inherits elements and properties from item.

Subclasses

The constant, helix icon, null object, step, subform linkage, template rectangle, tile, and user menu classes inherit the elements and properties of The object class.

Where Used

The object class is used in the following ways:

result of delete

direct parameter to the delete

element of tile

element of styled tile

icon property of the window

partial result property of the error record

Permissions element

permissions element (noun)View permissions for a user. Each element is for a single view.

Description

Permissions are separate from menu items because it is necessary to set permissions for views that are not present directly on the user menus, as is the case with views that are opened via sequences.

When a view is found on the user’s menu, the permissions can be found and modified by examining the properties of that menu item. However, there is a much simpler way:

tell user "User"
  set permissions elements to {icon: aView, permissions: {add record, replace record} } end tell

Using this syntax, Helix handles the permissions regardless of where they are stored for that view, and it is not necessary to retrieve the list of existing permissions elements in order to add or remove an entry for a specific view; only the view specified by the icon property is changed.

For a view where the user has no permissions restrictions (i.e: permissions = all ) there is no entry in the permissions element list, so setting the permissions for a view to all deletes that view from the list, if it exists.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
icon get/set view The related icon
permissions get/set allowed operations or list of allowed operations Operations allowed on the window
properties get record A record with all the properties of the item.
item

Superclass

The permissions element class inherits elements and properties from item.

Where Used

The permissions element class is used in the following ways:

element of user

See Also

Post

post (noun), pl postsA post icon controls the automatic movement of data within a collection. Posts are attached to views, with triggers for these events: enter, replace, delete, import, export, post, print; Apple event store and retrieve.

Description

The post icon lets application designers set up forms in which certain form operations make modifications to data not viewed on the screen. For example, a window that generates an invoice can automatically subtract the quantity of each item sold from the appropriate inventory records through the use of posting.

All data manipulation in Helix RADE is ultimately form-based. Ordinarily, when you put data onto a form and store it, Helix creates a record in the relation where the entry form resides. Posting, however, lets records other than the one being manipulated on the screen by a user be changed or created at the same time. The records affected by the post may be in the same relation, or in any other relation in the collection.

Properties

Property
Access
Type
Description
auto open view get/set view From the relation to which data is being posted, a view that opens during the posting process to facilitate manual input. The specified view opens only if the post parameters fail to locate a record containing a matching target value. Valid only in Options 2, 3 and 4 posts.
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
configuration get/set post parameters The option (0-4), source and target icons, and post first/every setting.
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
editor open get boolean Is the editor window for this icon currently open?
helix icon
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Elements

Element
Access
Key Forms
Description
post triplet get/ make/ delete by index
A three-part entity comprised of source data, operator and target field.

Commands

The post class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The post class inherits elements and properties from helix icon.

Where Used

The post class is used in the following ways:

element of relation

direct parameter to the add

direct parameter to the remove

demand posts property of the view

edit posts property of the view

export posts property of the view

print posts property of the view

Post parameters

post parameters (noun)The post parameters specify the source and target icons, as well as the Option (0-4) and the Post First/Post Every settings.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
post every get/set boolean If true, post to every record that matches. If false, only post to the first record found that matches.
post option get/set integer 0 to 4. For Option 0, other properties are ignored. For Option 1, all other properties must be defined. For Options 2-4, the target relation is required; other parameters are optional.
properties get record A record with all the properties of the item.
item
source value get/set data icon The abacus or field in the source relation to match to find records
target relation get/set relation The target relation
target value get/set data icon The abacus or field in the target relation to match to find records

Superclass

The post parameters class inherits elements and properties from item.

Where Used

The post parameters class is used in the following ways:

configuration property of the post

Post triplet

post triplet (noun), pl post tripletsA three-part entity comprised of source data, operator and target field that determines the operation to be performed on the target field.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
post operator get/set post operators The method by which source data will be posted into the target field
properties get record A record with all the properties of the item.
item
source data get/set data icon The field or abacus data to be posted
target field get/set field The field into which the source data will post

Superclass

The post triplet class inherits elements and properties from item.

Where Used

The post triplet class is used in the following ways:

element of post

Power query

power query (noun), pl power queriesA power query selects a subset of the records in a relation with arbitrary criteria

Properties

Property
Access
Type
Description
background color get/set RGB coloror color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
editor open get boolean Is the editor window for this icon currently open?
helix icon
expression get text The entire abacus expression in a single line
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collectionor relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
permanent items get/set list of data icon Icons that are always part of a power query and cannot be removed by the user. These icons must be of type flag.
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
reference items get/set list of data icon Icons that may be incorporated into a power query as the right-hand side of a query term.
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
searchable items get/set list of data icon Icons that may be incorporated into a power query as the left-hand side of a query term.
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Commands

The power query class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The power query class inherits elements and properties from helix icon.

Where Used

The power query class is used in the following ways:

element of relation

subform query property of the subform linkage

view query property of the view

Relation

relation (noun), pl relations[synonyms: rel ] A relation is an icon in a Helix collection that holds all of the information about a single table in the database. The elements in a Helix relation are field, abacus, template, view, form query, power query, index, and post.

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
columns get/set list of icon list columns A list of up to eight column names, indicating the order of the columns
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
datakey get integer Move along. Nothing to see here.
display mode get/set display modes The display mode
display order get/set list of icon list columns or boolean A list of up to 3 icon list columns indicating which columns to sort on, and up to 3 booleans, indicating that the corresponding column should be sorted from high to low. The Content column cannot be used for sorting.
dividers get/set list of integer Up to eight integers in ascending order, indicating the left edge (in pixels) of the eight named columns in the window.
editor open get boolean Is the editor window for this icon currently open?
helix icon
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
record count get integer The number of records in the relation
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Elements

Element
Access
Key Forms
Description
abacus get/ make/ delete by name
by index
by unique ID
A calculation to be performed on data. An abacus defines a calculation using tiles, fields, literal values (constants) and other abaci.
field get/ make/ delete by name
by index
by unique ID
A column of data in a relation. Fields can be of various data types and storage capabilities (inert or normal), and can be formatted and validated to ensure consistent data entry.
form query get/ make/ delete by name
by index
by unique ID
Defines a query to restrict the data contained within a relation to a subset for display or calculation. Uses a template to provide the interface to the queriable items. Queries are joined using <i>and</i> logic.
helix icon get by name
by index
by unique ID
Includes all of the others
index get/ make/ delete by name
by index
by unique ID
An index defines an order for the data (field or abacus) within a relation. Data searches (queries, lookup tiles, summarization tiles) can be made significantly faster by indexing the data. Attach to a view to control the order records are displayed.
post get/ make/ delete by name
by index
by unique ID
Automatic data manipulation. A post can automatically change, enter, replace and delete data in the same or a different relation as the result of actions taken on a view.
power query get/ make/ delete by name
by index
by unique ID
Defines a query to restrict the data contained within a relation to a subset for display or calculation. Uses a defined list of icons to provide the interface to the queriable items. Queries can be joined using <i>and</i>, <i>or</i> and <i>not</i> logic.
template get/ make/ delete by name
by index
by unique ID
A "blueprint" used by a view or form query to specify the look and function of the form. Add template rectangles of various types to create a layout for the form.
view get/ make/ delete by name
by index
by unique ID
A form for accessing the data within a relation. From a view, data can be added, modified, deleted, printed, posted, imported, exported and more.

Commands

The relation class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The relation class inherits elements and properties from helix icon.

Where Used

The relation class is used in the following ways:

element of collection

direct parameter to the delete all data

dangler property of the abacus element

host relation property of the subform linkage

parent property of the helix icon

source relation property of the dynamic popup

target relation property of the post parameters

Repeat rectangle

repeat rectangle (noun), pl repeat rectangles[synonyms: rrec ] A rectangle that encloses rectangles to be presented as a list of records. A template with a repeat rectangle may be used as a list or a subform. There can be only one repeat rectangle on a template.

Properties

Property
Access
Type
Description
autoclose linked form get/set boolean Automatically close the entry form that is opened by double-clicking this rectangle when the record is edited.
class get type class The class of the object
item
frame color get/set RGB coloror color index Color of the frame of the rectangle. This property is not shown on screen, but is used when printing.
group rectangle
frame width get/set integer Width of the rectangle frame. This property is not shown on screen, but is used when printing.
group rectangle
framed get/set boolean Does the rectangle have a visible frame?
template rectangle
id get integer ID is unique within each collection
object
linked entry form get/set view Entry view to open when a row is double-clicked
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
template rectangle
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
template rectangle
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
template rectangle
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
template rectangle
properties get record A record with all the properties of the item.
item
repeat direction get/set repeat direction options The list travel. Supports vertical and horizontal repeating, with the option of creating columns when the repeat rectangle is narrow enough to fit multiples within the template.
selectable get/set boolean Allow the user to select from this list
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
template rectangle
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
template rectangle
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?
template rectangle

Elements

Element
Access
Key Forms
Description
template rectangle get/ make/ delete by index
by unique ID
All rectangles contained within the borders of this rectangle.
group rectangle

Superclass

The repeat rectangle class inherits elements and properties from group rectangle.

RGB color

RGB color (noun), pl RGB colorsA list of three unsigned integers 0 - 65535, representing the intensity of the three color components: Red, Green, Blue. {0, 0, 0} is black, while {65535, 65535, 65535} is white.

Where Used

The RGB color class is used in the following ways:

result of get color index

direct parameter to the get index for color

background color property of the conditional style item

background color property of the helix icon

background color property of the styled rectangle

color property of the conditional style item

color property of the font style run

color property of the styled tile

color parameter of the set color index

frame color property of the conditional style item

frame color property of the styled rectangle

frame color property of the group rectangle

Sequence

sequence (noun), pl sequences[synonyms: seq ] A sequence is a series of steps that are executed in specific order. Steps can open views, switch users, run other sequences (aka: nested sequences), or invoke a subset of the commands (see: sequence commands) available in the Helix menus.

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
display message get/set boolean When an error occurs, automatically open the dialog and display the error message.
editor open get boolean Is the editor window for this icon currently open?
helix icon
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
message get/set text When a custom message is displayed, this text is shown.
message option get/set sequence message options When an error occurs, an error message (that can be seen by choosing the Why? menu item of the Help menu) is generated. A sequence can display the standard message, replace it with a custom message, or suppress the message entirely.
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
on error behavior get/set sequence error behavior What to do where there is an error in the sequence
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show dialogs get/set show dialogs options For commands that normally display a dialog (e.g: Print, Import), a sequence can be set to display the dialog always, never, or only when the option key is held down during the sequence. When a sequence does not display dialogs, it relies on previously stored information to supply the needed input. (e.g: pages to print, file to import)
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Elements

Element
Access
Key Forms
Description
step get/ make/ delete by index
by unique ID
A sequential list of view icons, user icons, sequence icons, and sequence commands that are invoked in order.

Commands

The sequence class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.)
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The sequence class inherits elements and properties from helix icon.

Where Used

The sequence class is used in the following ways:

direct parameter to the run

element of collection

command property of the command rectangle

icon property of the menu item

iteration command property of the conditional sequence item

Step

step (noun), pl stepsThis is an element in a sequence. It can be either a view icon, user icon, sequence icon, or a command that is allowed in a sequence.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
id get integer ID is unique within each collection
object
properties get record A record with all the properties of the item.
item

Superclass

The step class inherits elements and properties from object.

Where Used

The step class is used in the following ways:

element of sequence

Styled rectangle

styled rectangle (noun), pl styled rectangles[synonyms: strec ] A template rectangle with style attributes.

Properties

Property
Access
Type
Description
allow print get/set boolean The rectangle prints.
background color get/set RGB color or color index Color of background of rectangle.
class get type class The class of the object
item
font get/set font style or list of font style run Font style to use, if there is only one, or an ordered list of font style runs
frame color get/set RGB color or color index Color of frame of rectangle.
framed get/set boolean Does the rectangle have a visible frame?
template rectangle
id get integer ID is unique within each collection
object
justification
[synonyms: alignment ]
get/set justification options Text justification direction
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
template rectangle
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
template rectangle
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
template rectangle
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
template rectangle
properties get record A record with all the properties of the item.
item
scale picture get/set boolean The picture should be scaled to fit in the rectangle. Meaningful only if the rectangle holds a picture.
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
template rectangle
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
template rectangle
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?
template rectangle

Superclass

The styled rectangle class inherits elements and properties from template rectangle.

Subclasses

The command rectangle, data rectangle, and label rectangle classes inherit the elements and properties of The styled rectangle class.

Styled tile

styled tile (noun), pl styled tilesA tile with style information

Properties

Property
Access
Type
Description
class get type class The class of the object
item
color get/set RGB color The text color
font get/set font style The font family, size, and style output of the tile
hole positions get list of point An array holding the location of the upper left corner of each tile socket, relative to the upper left corner ("location") of the tile.
tile
id get integer ID is unique within each collection
object
jog height get/set integer The y coordinate of the horizontal segment of the arrow
tile
location get/set point Upper left corner of tile
tile
operator get abacus operators The tile name. For a string representation of this, get (operator as text)
tile
parent get abacus The abacus this tile is in.
tile
properties get record A record with all the properties of the item.
item
tile size get point The width and height of the tile
tile

Elements

Element
Access
Key Forms
Description
object get/ make/ delete by index
The contents of the tile sockets. May be an abacus, field, constant, or another tile. Occasionally a template or relation.
tile

Superclass

The styled tile class inherits elements and properties from tile.

Subform linkage

subform linkage (noun), pl subform linkagesinformation required to link a subform to its host form

Properties

Property
Access
Type
Description
class get type class The class of the object
item
deletes records get/set boolean Records shown on the subform are deleted when a delete is done on the host view
host link icon get/set field or abacus The icon in the host relation with the value to match
host relation get relation The host relation, where the host linking icon comes from
id get integer ID is unique within each collection
object
order index get/set index The linking index
properties get record A record with all the properties of the item.
item
subform link get list of subform linkage Links for embedded subforms
subform link icon get field or abacus The first icon in the index. Also the icon in the target relation with the matching value
subform query get/set abacus, form query, power query or null object To select a subset of linked records
subform rectangle get subform rectangle The corresponding rectangle on a template
subform template get template The template it displays

Superclass

The subform linkage class inherits elements and properties from object.

Where Used

The subform linkage class is used in the following ways:

subform link property of the view

subform link property of the subform linkage

Subform rectangle

subform rectangle (noun), pl subform rectangles[synonyms: sfrec ] A template rectangle that holds a subform

Properties

Property
Access
Type
Description
class get type class The class of the object
item
framed get/set boolean Does the rectangle have a visible frame?
template rectangle
id get integer ID is unique within each collection
object
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
template rectangle
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
template rectangle
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
template rectangle
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
template rectangle
properties get record A record with all the properties of the item.
item
subform template get/set template The template used for this subform
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
template rectangle
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
template rectangle
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?
template rectangle

Superclass

The subform rectangle class inherits elements and properties from template rectangle.

Where Used

The subform rectangle class is used in the following ways:

subform rectangle property of the subform linkage

Template

template (noun), pl templates[synonyms: tem ] A template defines the layout of a form

Properties

Property
Access
Type
Description
align to grid get/set boolean When moving rectangles via the GUI, keep rectangles aligned to the grid, which is shown as graph paper.
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
editor open get boolean Is the editor window for this icon currently open?
helix icon
graph paper get/set boolean Show graph paper lines, based on the horizontal and vertical spacing settings.
has default button get boolean There is a default button on this template
has document get boolean There is a document rectangle on this template
has repeat get boolean This template has a repeat rectangle on it. It can be used as a list form or as a subform.
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontal spacing get/set integer Number of pixels between horizontal lines when the graph paper is visible
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
includes document get boolean There is a document rectangle on this template or on a subform
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
page rectangle
[synonyms: prec ]
get group rectangle The container for the rectangles on the template. The 'location' property of this rectangle determines the size of the displayed page.
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
preview get/set boolean Preview
properties get record A record with all the properties of the item.
item
quick form get boolean The contents of this template were created with the Quick Entry or Quick List command
repeat profile get list of integer For a template that has a repeat rectangle, the calculated number of records that can appear on a single page. Returns four values representing the number of records that appear horizontally (columns) and vertically (rows), followed by the width and height of each repeat iteration. Meaningless on an entry view.
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
ruler get/set boolean Show ruler
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
subform count get integer Number of subforms directly on this template
subform templates get list of template A list of templates that are placed directly on this template. Nested templates are found inside the directly references templates.
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertical spacing get/set integer Number of pixels between vertical lines when the graph paper is visible
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Commands

The template class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.)
close Close a window or icon. (To close the collection, see close collection.) helix icon
commit Commit changes made to one or more icons. Returns an error if an icon could not be committed. The partial result property of the error contains a list of objects that prevented the commit.
open Open a collection if none is open, or open one or more icons in an open collection. helix icon
revert Forget changes that have been made. Returns an error if a specified icon does not have pending changes.

Superclass

The template class inherits elements and properties from helix icon.

Where Used

The template class is used in the following ways:

element of relation

direct parameter to the check rectangle overlap

dangler property of the abacus element

search template property of the form query

subform template property of the subform rectangle

subform template property of the subform linkage

subform templates property of the template

view template property of the view

See Also

Template rectangle

template rectangle (noun), pl template rectangles[synonyms: trec ] Superclass for the various types of rectangles that can appear on a template.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
framed get/set boolean Does the rectangle have a visible frame?
id get integer ID is unique within each collection
object
location get/set rectangle The coordinates that define this rectangle. The four points are returned in {left, top, right, bottom} order. Actual size can be calculated using (right - left) and (bottom - top).
name get text The name of the rectangle. Exactly what is returned varies depending on the rectangle. For data rectangles, it is the name of the field (or abacus if there is no field.) For label rectangles, it is its contents. For subform rectangles, it is the name of the subform template. For command rectangles, it is usually what appears in the button. Other rectangle types return an empty string, but there is always a text value returned.
ordinal get integer The tab order position of this rectangle on the page. The first rectangle is at 0.
parent get template rectangle The template rectangle that contains this template rectangle. The parent of a top level rectangle is the page rectangle.
properties get record A record with all the properties of the item.
item
visible on first page get/set boolean Is the rectangle visible on the first page of a multi-page view?
visible on interior page get/set boolean Is the rectangle visible on the interior pages of a multi-page view?
visible on last page get/set boolean Is the rectangle visible on the last page of a multi-page view?

Superclass

The template rectangle class inherits elements and properties from object.

Subclasses

The group rectangle, styled rectangle, and subform rectangle classes inherit the elements and properties of The template rectangle class.

Where Used

The template rectangle class is used in the following ways:

element of group rectangle

element of repeat rectangle

direct parameter to the move

after parameter of the move

at parameter of the make

parent property of the template rectangle

Tile

tile (noun), pl tilesA calculation tile

Properties

Property
Access
Type
Description
class get type class The class of the object
item
data type get data types The specific data type a tile outputs, based in its current inputs. When the output of a specific tile is unknown, returns ‘missing value’
hole positions get list of point An array holding the location of the upper left corner of each tile socket, relative to the upper left corner ("location") of the tile.
id get integer ID is unique within each collection
object
jog height get/set integer The y coordinate of the horizontal segment of the arrow
location get/set point Upper left corner of tile
operator get abacus operators The tile name. For a string representation of this, get (operator as text)
parent get abacus The abacus this tile is in.
potential data types get list of data types A list of data types that the tile can return. If a tile has defined output, a list containing a single data type — the output of that tile — is returned. (Equivalent to the data type property, but within a list.) If the tile output is undefined, a list of all possible data types the tile can produce is returned.
properties get record A record with all the properties of the item.
item
tile size get point The width and height of the tile

Elements

Element
Access
Key Forms
Description
object get/ make/ delete by index
The contents of the tile sockets. May be an abacus, field, constant, or another tile. Occasionally a template or relation.

Superclass

The tile class inherits elements and properties from object.

Subclasses

The styled tile class inherits the elements and properties of The tile class.

Where Used

The tile class is used in the following ways:

dangler property of the abacus element

User

user (noun), pl usersA user is an icon that defines a set of menus on the menu bar and access permissions for each view.

Properties

Property
Access
Type
Description
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
client idle timeout get/set integer Minutes of idle before a client is automatically logged out. 0 for no timeout, -1 to use preference (if specified) or timeout specified in the collection.
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
design mode available get boolean This user has the Design Mode command on a menu.
editor open get boolean Is the editor window for this icon currently open?
helix icon
has password get boolean This user has a password
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
logon limit get/set integer The number of logons allowed
modification date get date The date and time this icon was most recently modified.
helix icon
name get/set text The name of the icon
helix icon
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
password set text The user's password
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
properties get record A record with all the properties of the item.
item
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode get/set boolean This user opens in User Mode at next login.
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
user type get/set user types The type of user
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Elements

Element
Access
Key Forms
Description
permissions element get by index
These are permissions for icons that may open that do not appear on any menus.
user menu get/ make/ delete by name
by index
by unique ID
The menus that appear in the user's menu bar. Hierarchical menus are not included in this list.

Commands

The user class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The user class inherits elements and properties from helix icon.

Where Used

The user class is used in the following ways:

element of collection

active user property of the collection

icon property of the menu item

primary user property of the collection

User menu

user menu (noun), pl user menusA single menu appearing in the users menu bar, or as a hierarchical menu.

Description

A user menu is a single menu that appears in the user’s menu bar, or as a hierarchical menu within another user menu.

To add a user menu, you must first tell the user icon to make new user menu with properties {name: "menu name"} at x, where x is the ordinal of the position where the new menu should appear. If the user has hierarchical menus, the ordinal may not correspond to the visual position within the menu bar. Check the existing user menus by name to determine where to insert the new user menu.

After the new user menu has been created, you can then tell the new menu (be sure to capture the reply of The make command in a variable) to add menu items.

Removing an existing user menu or menu item is done by ‘deleting’ a user menu or ‘removing’ a menu item.

Editing an existing menu item is done by direct manipulation of the properties, or by reading the menu item record into a variable, modifying the properties of the record, and writing the updated record back into the menu item. When editing an existing menu item, be sure to test for the existence of a specific property before attempting to change it: Adding a property that already exists does nothing; Changing a property that does not exist results in an error.

Do not forget to commit changes to the user icon when you are done editing any of its internal objects.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
id get integer ID is unique within each collection
object
name get/set text Menu name. Appears in the menu bar or as the name of the hierarchical menu.
properties get record A record with all the properties of the item.
item

Elements

Element
Access
Key Forms
Description
menu item get/ make/ delete by index
An item appearing in a user menu. Can be a view, sequence, user, separator, or a hierarchical menu. Views, sequences and users can have optional command key equivalents. Use the 'add' and 'remove' commands to add/remove menu items.

Superclass

The user menu class inherits elements and properties from object.

Where Used

The user menu class is used in the following ways:

element of user

hierarchical menu property of the menu item

View

view (noun), pl viewsA view icon allows data entry and display

Properties

Property
Access
Type
Description
abacus query lock get/set boolean Do not allow User Mode to change the "Also Use" option when a quick query is open
active quick query get boolean Whether or not the quick query panel is displayed when the view opens
background color get/set RGB color or color index The background color of the window that displays this icon. Meaningful only for view windows.
helix icon
backlinks get list of helix icon List of some of the icons that refer to this icon. This list is used internally to optimize inter-icon updating, and is not very useful.
helix icon
class get type class The class of the object
item
closeable get/set boolean Does the window for this icon have a close button?
helix icon
cold form get/set boolean (Formerly Keep Current) A cold form does not refresh when data changes would cause it to be updated. This property is meaningful only for view icons.
helix icon
combined query expression get text The form query, power query, or abacus query combined with the quick query, giving the query actually being used for the search.
comment get/set text The comment on the icon
helix icon
creation date get date The date and time this icon was created.
helix icon
custom name get/set text The custom name of the icon
helix icon
default index get/set index or null object The default index
default values highlighted get/set boolean Are rectangles with default values drawn with a distinctive background?
delete host record get/set boolean On a view containing a subform, delete the host record when a delete is done
demand posts get/set list of post Posting icons used with the "Post All", "Find and Post All", and "Post Selected Records" commands
document location get/set document export options Where to export documents
edit posts get/set list of post Posting icons used when adding, replacing, or deleting data
editor open get boolean Is the editor window for this icon currently open?
helix icon
existing control file get/set existing document handling What to do if the control file already exists at the specified location
existing documents get/set existing document handling What to do if a document being exported already exists at the specified location
export file path get/set text The complete path to be used when exporting a text file, in HFS style.
export posts get/set list of post Posting icons used when exporting data
field delimiter get/set text or missing value The ASCII character to use as the field delimiter
fit to page get/set boolean Scale printing to fit into a single page
has status box get/set boolean Does the view show the status box? (This is a Classic-only feature, and will be removed at some point.
helix icon
horizontally scrollable get/set boolean Does the window for this icon have a horizontal scroll bar?
helix icon
id get integer ID is unique within each collection
object
import file path get/set text The complete path to be used when importing a text file, in HFS style.
include icon names get/set boolean Export the name of the icon in each data rectangle as the first line of the export file
include outer data get/set boolean Export data in rectangles outside the repeat rectangle?
invalid fields highlighted get/set boolean Are rectangles with invalid values drawn with a distinctive background?
invisible get/set boolean Is the window for this icon invisible?
helix icon
location get/set rectangle Coordinates of the window that opens when this icon is opened, including the title bar.
helix icon
locked get/set boolean Can the icon be modified? Note: Locking does not prevent all changes to an icon; some changes are still possible.
helix icon
modification date get date The date and time this icon was most recently modified.
helix icon
moving forward get/set boolean Was the last find (and therefore the next automatic find) in the forward direction?
name get/set text The name of the icon
helix icon
notify on change get/set boolean Is there a signal when a change to this view occurs?
on import error get/set import error handling What to do when an error occurs during import
order index get/set index or null object The index to use to specify the order of the records displayed.
parent get collection or relation The icon that contains this icon. For example: a fields parent is the relation it is in.
helix icon
position get/set point The relative position of an icon when the collection or relation is in "View by Icon" mode. These are not fixed values, but represent an offset (in pixels) from the current center point of the icons. Minimum/Maximum values are ±32767.
helix icon
print posts get/set list of post Posting icons used when printing
properties get record A record with all the properties of the item.
item
quick query get/set quick query expression The quick query expression.
quick query lock get/set boolean Do not allow User Mode to change the status of the quick query
record delimiter get/set text or missing value The ASCII character to use as the record delimiter
resizeable get/set boolean Does the window for this icon have a resize widget?
helix icon
selectable indexes get/set list of index Indexes available in the Sort Order popup.
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.
helix icon
show page boundaries get/set boolean Does the window for this icon show page separation lines? Meaningful only for views.
helix icon
showing record get boolean Is a record visible on the open form?
start character get/set text or missing value The ASCII character to use as the start character.
starting page number get/set integer The starting page number used for page numbering. Used in conjunction with the 'has page number' property of the label rectangle
strip field delimiters get/set boolean Remove any field delimiter characters found in the data
strip record delimiters get/set boolean Remove any record delimiter characters found in the data
strip return characters get/set boolean Remove any carriage return (ASCII 13) characters found in the data
subform link get list of subform linkage Links for embedded subforms
use specified document path get/set boolean When true, documents are exported to the location specified in the stored path. When false, documents are exported to the location of the control (export) file DEPRECATED. Use "Document Location"
used by get list of helix icon List of icons that refer to this icon
helix icon
user mode name get text The user mode name of the icon. (Custom name if it exists, otherwise the name.)
helix icon
vertically scrollable get/set boolean Does the window for this icon have a vertical scroll bar?
helix icon
view mode get/set view mode options The visible aspect (form mode or setup mode) of the view
view query get/set abacus, form query, power query or null object The abacus, form, or power query to use to select records to view.
view template get/set template The template to use to define the form.
window type get/set window types The type of window used when this icon is opened. Meaningful only for views.
helix icon
zoomable get/set boolean Does the window for this icon have a zoom button?
helix icon

Commands

The view class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.) helix icon
open Open a collection if none is open, or open one or more icons in an open collection. helix icon

Superclass

The view class inherits elements and properties from helix icon.

Where Used

The view class is used in the following ways:

element of relation

direct parameter to the set permissions for

auto open view property of the post

icon property of the permissions element

icon property of the menu item

linked entry form property of the repeat rectangle

Window

window (noun), pl windowsA window.

Properties

Property
Access
Type
Description
class get type class The class of the object
item
icon get object The helix icon associated with the window.
id get integer The unique identifier of the window. This is not equivalent to the index order.
name get text The full title of the window.
properties get record A record with all the properties of the item.
item
selection get/set list of helix icon The objects selected in the front window. If the window does not support object selection, missing value is returned.

Commands

The window class responds to the following commands:
Command
Description
close Close a window or icon. (To close the collection, see close collection.)

Superclass

The window class inherits elements and properties from item.

Where Used

The window class is used in the following ways:

result of open

element of application

direct parameter to the close

Enumerations

Abacus operators

abacus operators (enumeration)Abacus tiles

Constants

Constant
Description
absolute value tile Absolute value [Abs o]
add tile Addition [o + o]
and tile Both true [o And o]
annuity rate tile Annuity rate [Annuity rate o o times]
arc tangent tile Arc tangent [Atan o]
average for tile Average for [Average o for o]
average tile Average [Average o]
change modification date tile Change modification date [Change o mod. date to o]
change name tile Change name [Change o name to o]
change path tile Change path [Change o path to o]
change type tile Change type [Change o type to o]
compound interest tile Compound interest [Compound rate o o times]
contains tile contains [o contains o]
cosine tile Cosine [Cos o]
count for tile Count for [Count for o]
count tile Count [Count]
date tile Convert to date [Date o]
date time tile Make date-time [Date o Time o]
day of month tile Day of month (1 - 31) [Day o]
day of week tile Day of the week (sunday = 0) [Day of Week o]
defined tile Defined [Defined o]
delta days tile Change in days [o ∆ days o]
delta hours tile Change in hours [o ∆ hours o]
delta minutes tile Change in minutes [o ∆ minutes o]
delta seconds tile Change in seconds [o ∆ seconds o]
delta weeks tile Change in weeks [o ∆ weeks o]
delta years tile Change in years [o ∆ years o]
display tile Display [o]
divide tile Division [o / o]
document creation date tile Document creation date [Doc. Create Date o]
document modification date tile Document modification date [Doc. Modify Date o]
document name tile Document name [Doc. Name o]
document path tile Document path [Doc. Path o]
document size tile Document size [Doc. Size o]
document storage tile Document storage [Doc. Storage o]
document type tile Document type [Doc. Type o]
ends with tile Ends with [o ends with o]
equals tile Equals [o = o]
extract text tile Extract [Extract o through o from o]
fixed point tile Convert to fixed point [Fixed Point o]
flag tile Convert to flag [Flag o]
followed by tile Concatenate text [o followed by o], undefined if either text input is undefined
followed or tile Concatenate text [o followed/or o], use other text input if either text input is undefined
form average for tile Queried average for tile [Form Average o for o]
form average tile Queried average [Form Average o]
form count for tile Queried count for [Form Count for o]
form count tile Queried count [Form Count]
form maximum for tile Queried maximum for [Form Max o for o]
form maximum tile Queried maximum [Form Max o]
form minimum for tile Queried minimum for [Form Min o for o]
form minimum tile Queried minimum [Form Min o]
form previous tile Previous, using form index and query [Form Previous o]
form time tile Form time [Form Time]
form total for tile Queried total for [Form Total o for o]
form total tile Queried total [Form Total o]
fraction tile Decimal [Fraction o]
greater than or equals tile Greater than or equal to [o ≥ o]
greater than tile Greater than [o > o]
hour minute second tile Make time [Hour o Minute o Second o]
hour tile Hour [Hour o]
if then else tile Conditional tile [If o Then o Else o]
integer part tile Truncate [Integer o]
larger tile Larger [Larger of o o]
length tile Text length [Length o]
less than less than or equals tile Less than, less than or equals [o < o ≤ o]
less than less than tile Less than, less than [o < o < o]
less than or equals less than or equals tile Less than or equals, less than or equals [o ≤ o ≤ o]
less than or equals less than tile Less than or equals, less than [o ≤ o < ]
less than or equals tile Less than or equals [o ≤ o]
less than tile Less than [o < o]
locate text tile Locate [Locate o starting at o in o]
log tile Decimal logarithm [Log o]
lookup summary tile Lookup summary [Lookup o Summary in o]
lookup tile Relational lookup [Lookup o for o = o in o]
lower case tile Convert to lower case [Lower Case o]
maximum for tile Maximum for [Max o for o]
maximum tile Maximum [Max o]
minimum for tile Minimum for [Min o for o]
minute tile Minute [Minute o]
mixed case tile Convert to mixed case [Mixed Case o]
month day year tile Make date [Month o Day o Year o]
month tile Month [Month o]
multiply tile Multiplication [o * o]
natural log tile Natural logarithm [Ln o]
negation tile Unary minus [- o]
new line tile New line [New Line]
not equals tile Not equal to [o ≠ o]
not tile Complement [Not o]
number tile Convert to number [Number o]
or tile Either true [o Or o]
picture tile Convert to picture [Picture o]
post time tile Post time [Post Time]
previous for tile Queried previous [Previous o for o]
previous tile Previous [Previous o]
raise to power tile Raise to power [o to power o]
round tile Round [Round o]
round to nearest tile Round to nearest [Round o to nearest o]
second tile Second [Second o]
sine tile Sine [Sin o]
smaller tile Smaller [Smaller of o o]
square root tile Square root [√ o]
starts with tile Starts with [o starts with o]
styled text tile Convert to styled text [Styled Text o]
sub average for tile Relational average [Sub-Average o for o = o in o]
sub count for tile Relational count [Sub-Count for o = o in o]
sub maximum tile Relational maximum [Sub-Max o for o = o in o]
sub minimum tile Relational minimum [Sub-Min o for o = o in o]
sub total for tile Relational total [Sub-Total o for o = o in o]
subtract tile Subtraction [o - o]
tangent tile Tangent [Tan o]
text tile Convert to text [Text o]
today tile Today's date [Today]
total for tile Total for [Total o for o]
total tile Total [Total o]
undefined becomes tile Undefined becomes [Undefined o becomes o] Output first text input if defined, otherwise output second text input
undefined tile Undefined [Undefined o]
unique tile Unique [Unique o]
upper case tile Convert to upper case [Upper Case o]
use from tile Use from [Use o from o] Get a value from another relation (or template in that relation) which must be part of the active view
user name tile User Name [UserName]
word equals tile Word equals [o word = o]
word starts with tile Word starts with [o word starts with o]
year tile Year [Year o]

Where Used

The abacus operators enumeration is used in the following ways:

operator property of the tile

Allowed operations

allowed operations (enumeration)Operations allowed in a view. When Helix returns allowed operations, it returns either 'all', 'none', or a list of operations. Helix accepts either 'all', 'none', a single operation, or a list of these operations not including 'all' or 'none'.

Constants

Constant
Description
add record
all
delete record
export record
find record
import record
none
print record
replace record

Where Used

The allowed operations enumeration is used in the following ways:

permissions property of the permissions element

permissions property of the menu item

to parameter of the set permissions for

Case options

case options (enumeration)Case option for formats

Constants

Constant
Description
lower case Display the values using all lower case character.
mixed case Display the values using mixed case. For a custom label, mixed case means exactly as defined by the custom labels list.
upper case Display the values using all caps.

Where Used

The case options enumeration is used in the following ways:

case property of the flag format

Data types

data types (enumeration)A classification that defines the specific type of input that a field accepts.

Description

In Helix, information is stored in fields which are found within relations. Fields are classified by data type: a storage format that is limited to a specific type or range of values. Specifying a data type is done to enforce appropriate user input as well as to facilitate specific operations, such as mathematical operations on number type data.

For an abacus, the data type signifies its output, which is determined by the types of tiles used as well as the source data type.

Helix uses strict (or strong) data typing, meaning that data is never implicitly changed (coerced) from one type to another. To coerce data of one type into another, use the appropriate data type tile.

The default data type for a newly created field is text type.

Constants

Constant
Description
date time type date and/or time
document type document
fixed point type fixed range integer or decimal number
flag type True or False/On or Off
number type floating point number
picture type picture
styled text type text with colors and styles that change within the text
text type characters

Where Used

The data types enumeration is used in the following ways:

data type property of the data icon

data type property of the constant

Date styles

date styles (enumeration)How to present a date

Constants

Constant
Description
long form Long form: December 31, 1999
omit No date
short form Short form: Dec 31, 1999
with dashes With dashes: 12-31-99
with slashes With slashes: 12/31/99

Where Used

The date styles enumeration is used in the following ways:

date style property of the date format

Directions

directions (enumeration)The direction to sort

Constants

Constant
Description
ascending Values go up (A-Z order)
descending Values go down (Z-A order)

Where Used

The directions enumeration is used in the following ways:

display order property of the collection

order property of the index element

Disabled button options

disabled button options (enumeration)Disabled button options

Constants

Constant
Description
dim button with disabled name Dim button and display disabled button name
hide button

Display modes

display modes (enumeration)The various modes in which a collection or relation window can be displayed.

Constants

Constant
Description
icon view
list view

Where Used

The display modes enumeration is used in the following ways:

display mode property of the collection

display mode property of the relation

Document export options

document export options (enumeration)Options for where documents go when exporting records

Constants

Constant
Description
use stored path Documents export to the original stored path
with control file Documents export to the same folder as the control file

Where Used

The document export options enumeration is used in the following ways:

document location property of the view

Document storage types

document storage types (enumeration)Document storage types

Constants

Constant
Description
default internal storage internal storage, but may be changed by user
external storage
internal storage

Where Used

The document storage types enumeration is used in the following ways:

storage type property of the field

Existing document handling

existing document handling (enumeration)What to do if a document being exported already exists at the specified location

Constants

Constant
Description
ask Ask the user
replace Replace existing document
skip Continue without changing the disk file
stop Stop processing

Where Used

The existing document handling enumeration is used in the following ways:

existing documents property of the view

Flag display styles

flag display styles (enumeration)How to present a flag. Flags can be plain text, with the format controlled by the 'labels' (and 'custom labels') property, or as a control, with the format controlled by the 'style' property.

Constants

Constant
Description
checkbox Display as a single checkbox
dynamic popup Display as dynamic popup
radio buttons Display as radio buttons
static popup Display as static popup
text box Display as text

Where Used

The flag display styles enumeration is used in the following ways:

style property of the flag format

Flag value labels

flag value labels (enumeration)Names for flag values

Constants

Constant
Description
onezero 1/0
other Use custom values for true, false and (optionally) undefined. Values are defined in the 'custom labels' property.
tf t/f
truefalse true/false
yesno yes/no
yn y/n

Where Used

The flag value labels enumeration is used in the following ways:

labels property of the flag format

Icon list columns

icon list columns (enumeration)The properties of icons displayed in the collection and relation windows

Constants

Constant
Description
comments column The comments on the icon
creation date column The date and time the icon was created
custom name column The custom name of the icon
icon kind column The kind of the icon
icon name column The actual name of the icon
modification date column The date and time the icon was last modified
summary column A summary of the content of the icon
user mode name column The name of the icon in user mode (custom name if there is one, otherwise the actual name)

Where Used

The icon list columns enumeration is used in the following ways:

columns property of the collection

columns property of the relation

display order property of the collection

display order property of the relation

Import error handling

import error handling (enumeration)What to about a data error while importing

Constants

Constant
Description
skip field
skip record
stop Stop processing

Where Used

The import error handling enumeration is used in the following ways:

on import error property of the view

Justification options

justification options (enumeration)Text justification

Constants

Constant
Description
center justified
left justified
right justified

Where Used

The justification options enumeration is used in the following ways:

justification property of the styled rectangle

Key modifiers

key modifiers (enumeration)Modifier key combinations for a menu item command.

Constants

Constant
Description
command key command-. Key may be any single printable character.
command option command-option-. Key must be between 'A' and 'Z'.
command option shift command-option-shift-. Key must be between 'A' and 'Z'.
command shift command-shift-. Key must be between 'A' and 'Z'.
function key Function key. Key must be a number between 1 and 16.

Where Used

The key modifiers enumeration is used in the following ways:

modifier keys property of the menu item

Number of button options

number of button options (enumeration)number of radio buttons to use

Constants

Constant
Description
three buttons True, False, and Undefined
two buttons True and False only

Where Used

The number of button options enumeration is used in the following ways:

number of buttons property of the flag format

Orientation options

orientation options (enumeration)Which direction?

Constant
Description
horizontal
vertical

Where Used

The orientation options enumeration is used in the following ways:

orientation property of the flag format

Post operators

post operators (enumeration)The operations that may be performed by posting

Constant
Description
add value Add the source data to the target field
decrement value Decrement the target field by the source data
increment value Increment the target field by the source data
insert always Insert source data in target field when a record is created or modified
insert on create Insert source data in target field only when a record is modified
subtract value Subtract the source data from the target field

Where Used

The post operators enumeration is used in the following ways:

post operator property of the post triplet

Quick query operators

quick query operators (enumeration)Operators valid in a quick query

Constant
Description
contains tile contains [[field] contains o]
ends with tile Ends with [[field] ends with o]
equals tile Equals [[field] = o]
greater than or equals tile Greater than or equal to [[field] ≥ o]
greater than tile Greater than [[field] > o]
is found within tile is found within [o contains [field]] (reverse contains)
less than or equals tile less than or equals [[field] ≤ o]
less than tile less than [[field] < o]
not equals tile Not equal to [[field] ≠ o]
starts with tile Starts with [[field] starts with o]
word equals tile Word equals [[field] word = o]
word starts with tile Word starts with [[field] word starts with o]

Where Used

The quick query operators enumeration is used in the following ways:

quick query operator property of the quick query expression

Repeat direction options

repeat direction options (enumeration)The order of the directions for repeat rectangles to repeat.

Constant
Description
across
across then down
down
down then across

Where Used

The repeat direction options enumeration is used in the following ways:

repeat direction property of the repeat rectangle

Sequence commands

sequence commands (enumeration)Commands that can be put into a sequence

Constant
Description
beep command Beep
clear command Clear
clear form command Clear Form
clear selection command Clear Selection
client info command Client Info...
close all command Close All
close command Close
copy command Copy
copy from volume command Copy From Volume
copy paste record options command Copy/Paste Record Options...
copy record command Copy Record | Copy All Records
copy selected records command Copy Selected Records
copy to volume command Copy to Volume...
cut command Cut
delete all command Delete All
delete all originals command Delete All Originals
delete command Delete
delete original command Delete Original
delete selected records command Delete Selected Records
draw screen command Draw Screen
enter command Enter | Replace
enter override command Enter Override
export command Export All...
export form command Export Form...
export selected records command Export Selected Records
find and print all command Find and Print All...
find and update all command Find and Update All
find first command Find First
find last command Find Last
find next command Find Next
find previous command Find Previous
home command Home
import command Import
keypress enter command Keypress: Enter
move into collection command Move Into Collection
null command Null
open command Open
open copy command Open Copy
open original command Open Original
open query command Open Query
page setup command Page Setup...
paste command Paste
paste record command Paste Record | Paste All Records
pause command Pause
post all command Post All | Find and Post All
post selected records command Post Selected Records
print document command Print Document
print form command Print Form...
quick query command Quick Query
refresh command Refresh
revert command Revert
save and clear cache command Save and Clear Caches DEPRECATED
save command Save
select all command Select All
select all records command Select All Records
server info command Server Info...
show clipboard command Show Clipboard
show fonts command Show Fonts...
sort order command Sort Order...
starting page number command Starting Page #...
static enter command Static Enter
static enter override command Static Enter Override
tab field command Tab Field
time stamp command Time Stamp
top menu command Top Menu
transfer original command Transfer Original
update all command Update All
update document command Update Document
user command User...
user name security command User Name Security...
work on copy command Work on Copy...
work on original command Work on Original

Sequence error behavior

sequence error behavior (enumeration)How to respond when an error is encountered during a sequence.

Constant
Description
sequence continues Any error terminates only the step in which it occurs. Subsequent steps in the sequence execute, as do any subsequent conditional sequences. If the error occurs in a conditional sequence, subsequent iterations of that sequence execute. This is the behavior most similar to Helix Express 4.5.5 and earlier.
sequence returns Any error terminates the sequence in which it occurs. If the error occurs in a nested sequence, the top level sequence continues. If the error occurs in a conditional sequence, that conditional sequence (and any subsequent iterations of that sequence) stops and exectution continues with the next conditional sequence. This is the behavior of Helix 5.3 through 6.2, and the current default behavior.
sequences stop Any error immediately terminates the sequence in which it occurs and all subsequent sequences, whether conditional, nested, or top-level. This is the behavior of Helix 5.0 through 5.2.

Where Used

The sequence error behavior enumeration is used in the following ways:

on error behavior property of the sequence

Sequence message options

sequence message options (enumeration)When an error occurs in a sequence, an error message (that can be seen by choosing the Why? menu item of the Help menu) is generated. The options are to display the standard message, a custom message, or no message at all.

Constant
Description
custom Display the custom error message
none Do not display an error
standard Display the error and where it occurred

Where Used

The sequence message options enumeration is used in the following ways:

message option property of the sequence

Show dialogs options

show dialogs options (enumeration)show dialogs while a sequence is running

Constant
Description
always Always show dialogs
never Never show dialogs
optionally Show dialogs if the option key is down

Where Used

The show dialogs options enumeration is used in the following ways:

show dialogs property of the sequence

Time styles

time styles (enumeration)How to present a time

Constant
Description
military format Military format: 13:50:25
omit No time component
short format Short form: 1:50 PM

Where Used

The time styles enumeration is used in the following ways:

time style property of the date format

User menu commands

user menu commands (enumeration)Menu items that can be put on a user menu.

Constant
Description
about helix command About Helix
autosave command AutoSave...
check for updates command Check For Updates
clear command Clear
clear form command Clear Form
clear selection command Clear Selection
client info command Client Info...
close all command Close All
close collection command Close Collection
close command Close
collection password command Collection Password...
copy command Copy
copy from volume command Copy From Volume
copy paste record options command Copy/Paste Record Options...
copy record command Copy Record | Copy All Records
copy selected records command Copy Selected Records
copy to volume command Copy to Volume...
custom help command Custom Help
cut command Cut
delete all command Delete All
delete all originals command Delete All Originals
delete command Delete
delete original command Delete Original
delete selected records command Delete Selected Records
design mode command Design Mode
edit users command Edit Username List...
enter command Enter | Replace
enter override command Enter Override
export command Export All...
export form command Export Form...
export selected records command Export Selected Records
find and print all command Find and Print All...
find and update all command Find and Update All
find first command Find First
find last command Find Last
find next command Find Next
find previous command Find Previous
import command Import
invoke icon A menu item that opens a view, runs a sequence, or switches to another user. The 'icon' property of the menu item contains the view, sequence, or user icon that is invoked.
menu A placeholder for a hierarchical menu. When you 'add' a menu to a menu, a hierarchical menu is created and is accessed via the 'hierarchical menu' property.
move into collection command Move Into Collection
open command Open
open copy command Open Copy
open original command Open Original
open query command Open Query
page setup command Page Setup...
paste command Paste
paste record command Paste Record | Paste All Records
post all command Post All | Find and Post All
post selected records command Post Selected Records
preferences command Preferences...
print document command Print Document
print form command Print Form...
quick query command Quick Query
quit command Quit
refresh command Refresh
revert command Revert
revert to saved command Revert to Saved...
save and log command Save and Log...
save as command Save As...
save command Save
select all command Select All
select all records command Select All Records
separator A separator line
server info command Server Info...
show clipboard command Show Clipboard
show fonts command Show Fonts...
sort order command Sort Order...
starting page number command Starting Page #...
static enter command Static Enter
static enter override command Static Enter Override
time stamp command Time Stamp
top menu command Top Menu
transfer original command Transfer Original
undo command Undo
update all command Update All
update document command Update Document
user command User...
user name security command User Name Security...
user password command User Password...
why command Why?
work on copy command Work on Copy...
work on original command Work on Original

Where Used

The user menu commands enumeration is used in the following ways:

command property of the menu item

User types

user types (enumeration)Legal user types. The primary user is the standard user type; a secondary user is what the Classic GUI calls a submenu user.

Constant
Description
administrator A primary user in all respects, except that it does not appear in the Edit Usernames dialog, limiting the end users ability to edit the user.
primary A standard user. May be used to log in. May be edited (and duplicated) in the Edit Usernames dialog.
prototype A user that can not be used to log in. A prototype may be duplicated via the Edit Usernames dialog, the duplicate becoming a primary user. You can not assign a password to a prototype user.
secondary A secondary user, used to provide an alternative menu bar and permissions set without changing the primary user. Can not be used to log in; access is only through menu choices and sequences.

Where Used

The user types enumeration is used in the following ways:

user type property of the user

Validation operators

validation operators (enumeration)Tiles that are allowed for build-in (simple) validations.

Constant
Description
contains tile Field contains the value entered in the primary constant. [[field] contains o]
defined tile Field is defined [Defined [field]]
ends with tile Field ends with the value entered in the primary constant. [[field] ends with o]
equals tile Field equals the primary constant. [[field] = o]
greater than or equals tile Field is greater than or equal to the primary constant. [[field] ≥ o]
greater than tile Field is greater than the primary constant. [[field] > o]
less than less than or equals tile Field is greater than the primary constant and less than or equal to the secondary constant. [o < [field] ≤ o]
less than less than tile Field is greater than the primary constant and less than the secondary constant. [o < [field] < o]
less than or equals less than or equals tile Field is greater than or equal to the primary constant and less than or equal to the secondary constant. [o ≤ [field] ≤ o]
less than or equals less than tile Field is greater than or equal to the primary constant and less than the secondary constant. [o ≤ [field] < o]
less than or equals tile Field is less than or equal to the primary constant. [[field] ≤ o]
less than tile Field is less than the primary constant. [[field] < o]
not equals tile Field does not equal the primary constant. [[field] ≠ o]
starts with tile Field starts with the value entered in the primary constant. [[field] starts with o]
undefined tile Field is undefined [Undefined [field]]
unique tile Field is unique [Unique [field]]

Where Used

The validation operators enumeration is used in the following ways:

validation operation property of the tile validation

View mode options

view mode options (enumeration)The mode of the view window

Constant
Description
form mode Showing the form
posting setup mode Showing the posting setup options. DEPRECATED
setup mode Showing the setup options

Where Used

The view mode options enumeration is used in the following ways:

view mode property of the view

Window types

window types (enumeration)The type of a window

Constant
Description
Document Window A document window (includes a title bar)
Plain Window A plain window (without a title bar)

Where Used

The window types enumeration is used in the following ways:

window type property of the helix icon

Records

Autosave parameters

autosave parameters (record)AutoSave parameters

Properties

Property
Access
Type
Description
autosave idle delay get/set integer Number of seconds to wait for inactivity before saving, after the AutoSave interval has elapsed.
autosave interval get/set integer Number of seconds between AutoSaves.
autosave start time get/set integer What time of day (in seconds after midnight) does AutoSave begin?
enabled get/set boolean Is AutoSave enabled?

Where Used

The autosave parameters record is used in the following ways:

autosave property of the collection

Conditional sequence item

conditional sequence item (record)A conditional sequence pair, consisting of a data icon (field or abacus) that supplies the number of times a sequence should run, and the sequence to run.

Properties

Property
Access
Type
Description
iteration command get/set sequence The conditional sequence to execute
iteration value get/set field or abacus The number or fixed point data icon that determines the number of times to execute the sequence

Where Used

The conditional sequence item record is used in the following ways:

conditional sequences property of the command rectangle

Conditional style item

conditional style item (record)A combination of a calculation, color, and font

Properties

Property
Access
Type
Description
background color get/set RGB color The background color, if this condition is true
calculation get/set abacus The conditional calculation
color get/set RGB color The text color, if this condition is true
font get/set font style The font name, size, and attributes, if this condition is true
frame color get/set RGB color The frame color, if this condition is true

Where Used

The conditional style item record is used in the following ways:

conditional style property of the data rectangle

Date format

date format (record)Date format parameters

Properties

Property
Access
Type
Description
date style get/set date styles style to present date, if any
include seconds get/set boolean Include seconds in the time part
leading zero get/set boolean date and time are written with leading zeros to insure that each field has two digits
popup get/set static popup or dynamic popup Popup information. Optional.
time style get/set time styles style to present time, if any

Where Used

The date format record is used in the following ways:

format property of the data rectangle

format property of the data icon

Dynamic popup

dynamic popup (record)Dynamic popup

Properties

Property
Access
Type
Description
allow typing get/set boolean Also allow the user to type into the field. (i.e: a Combo Box)
allow variable width get/set boolean Allow menu to expand to show long entries.
current index get/set index or missing value The index currently being used to sort the popup. This property can be set by choosing a sort order from the toolbar on a list in macOS. When specifying a view, this property is optional. When omitted, records are displayed in entry order, or in the order dictated by the index used to satisfy an attached query. This specification may change in the future.
display value get/set abacus or field Value to be displayed. Must be in the source relation. Must be renderable as text.
source query get/set abacus, form query or missing value Flag abacus or query to select the values to be displayed in the popup. Must be in relation. Optional. If omitted, all values in the relation are used.
source relation get/set relation The relation to use to obtain values
stored value get/set abacus, field or missing value Value to be stored. Must be in relation. Must be renderable as text. Must be the same type as the field where the value will be stored. Optional. If omitted, the display value is used.

Where Used

The dynamic popup record is used in the following ways:

popup property of the number format

popup property of the date format

popup property of the flag format

popup property of the fixed point format

popup property of the text format

Error record

error record (record)Error Record

Properties

Property
Access
Type
Description
error message get/set text The error message
number get/set integer The number of the error
partial result get/set list of object More information about the error. Often object or objects involved in the error.

Where Used

The error record record is used in the following ways:

Fixed point format

fixed point format (record)fixed point format parameters

Properties

Property
Access
Type
Description
commas get/set boolean Number has commas every three digits
currency mark get/set boolean Number has currency mark. The format for the currency mark is specified by the International Localization data.
decimal places get/set number Number of digits displayed after the decimal point. Maximum 2.
popup get/set static popup or dynamic popup Popup information. Optional.

Where Used

The fixed point format record is used in the following ways:

format property of the data rectangle

format property of the data icon

Flag format

flag format (record)Flag format parameters

Properties

Property
Access
Type
Description
case get/set case options Case
custom labels get/set list of text Two or three text strings, defining alternate values for true, false, and (optionally) undefined. A text field can display the true and false values; a checkbox can display the true value; a radio button can display all three values.
hide labels get/set boolean Hide labels
labels get/set flag value labels labels
number of buttons get/set number of button options Number of radio buttons to use. Radio buttons only.
orientation get/set orientation options Direction to stack elements. Radio buttons and checkboxes only.
popup get/set static popup or dynamic popup Popup information. Optional.
require custom labels get/set boolean When data is being entered by a user, only accept data that conforms to the custom labels, ignoring the standard values.
style get/set flag display styles How to present value

Where Used

The flag format record is used in the following ways:

format property of the data rectangle

format property of the data icon

Font style

font style (record)Font style information, does not include color data

Properties

Property
Access
Type
Description
bold face get/set boolean Bold font face (Optional)
font name get/set text The name of the font family
font size get/set number Point size for the font
italic face get/set boolean Italics font face (Optional)
outline face get/set boolean Outline font face DEPRECATED (Optional)
shadow face get/set boolean Shadow font face DEPRECATED (Optional)
underline face get/set boolean Underline font face DEPRECATED (Optional)

Where Used

The font style record is used in the following ways:

font property of the conditional style item

font property of the font style run

font property of the styled rectangle

font property of the styled tile

Font style run

font style run (record)The font style and color information for a section of styled text

Properties

Property
Access
Type
Description
color get/set RGB color The color of this section of text
font get/set font style The font name, size, and attributes of this section of text
start character index get/set integer The index of the first character of the run, starting at 0. All runs must be in order, and each run ends at the start of the next run. The last run ends at the end of the string.

Where Used

The font style run record is used in the following ways:

font property of the styled rectangle

Number format

number format (record)Numeric format parameters

Properties

Property
Access
Type
Description
commas get/set boolean Number has commas every three digits
currency mark get/set boolean Number has currency mark. The format for the currency mark is specified by the International Localization data.
decimal places get/set number Number of digits after the decimal point
percent sign get/set boolean Number is a percentage
popup get/set static popup or dynamic popup Popup information. Optional.
scientific notation get/set boolean Number is in scientific notation (n.nnn+nnn)

Where Used

The number format record is used in the following ways:

format property of the data rectangle

format property of the data icon

Quick query expression

quick query expression (record)A record containing the discreet objects that form the quick query.

Properties

Property
Access
Type
Description
also use query get/set boolean If the view query should also restrict the records found. Optional. If omitted, it defaults to true.
quick query field get/set field The field in the quick query popup
quick query operator get/set quick query operators Operator to use for the test
quick query value get/set boolean, number, date or text The value in the quick query search field

Where Used

The quick query expression record is used in the following ways:

quick query property of the view

Static popup

static popup (record)Static popup

Properties

Property
Access
Type
Description
allow typing get/set boolean Also allow the user to type into the field. (i.e: a Combo Box)
allow variable width get/set boolean Allow menu to expand to show long entries.
values get/set list of text Default values to display in the popup menu.

Where Used

The static popup record is used in the following ways:

popup property of the number format

popup property of the date format

popup property of the flag format

popup property of the fixed point format

popup property of the text format

Structure check result

structure check result (record)List of data errors (correctable and not) found during structure check

Properties

Property
Access
Type
Description
diagnostic data get integer Diagnostic data.
error code get integer The type of error found
found id get integer For damage, the id of the object found at the point of damage.
found type get integer For damage, the type of object found at the point of damage.
id get integer The id of the object where the error was detected.
type get integer The type of object where the error was detected.

Where Used

The structure check result record is used in the following ways:

result of check structure

Text format

text format (record)Format (Graphic User Interace control type) to use for displaying text datatype. Default is a plain text field.

Properties

Property
Access
Type
Description
popup get/set static popup or dynamic popup Optional property to display field as a popup menu.

Where Used

The text format record is used in the following ways:

format property of the data rectangle

format property of the data icon

Tile validation

tile validation (record)

Properties

Property
Access
Type
Description
message get/set text message to display for failure
primary constant get/set text value for left hand side
secondary constant get/set text value for right hand side
validation operation get/set validation operators test to use with field and constant

Where Used

The tile validation record is used in the following ways:

validation tile property of the field

Types

Color index

color index (type)DEPRECATED. The index of the color in the color table. (0 is white, 1 is black, 2-255 are user defined.)

Where Used

The color index type is used in the following ways:

direct parameter to the get color index

direct parameter to the set color index

result of get index for color

background color property of the helix icon

background color property of the styled rectangle

frame color property of the styled rectangle

frame color property of the group rectangle

Picture

picture (type)

Where Used

The picture type is used in the following ways:

command label property of the command rectangle

content property of the label rectangle

Rectangle

rectangle (type)A list of four numbers, representing the left, top, right and bottom coordinates [ltrb] of a rectangle within a page.

Where Used

The rectangle type is used in the following ways:

location property of the menu item

location property of the helix icon

location property of the template rectangle