skip to main content
OpenEdge Development: ADM Reference
Toolbar Objects and Their Methods and Properties : Action properties for toolbar objects
 
Action properties for toolbar objects
There are a number of action properties that you use to specify actions for the toolbar. All of these properties can be read and some of them can be set using assign. Action properties are class-level properties, and as a result, changing an action property using assignAction<Property> affects all toolbars that are initialized after the change.
Table 6–1 lists and provides a brief description of the action properties for toolbar objects.
 
Table 6–1: Action properties for toolbar objects
Action property
Description
Read
Write
Data type
Accelerator
Accelerator string, if any, for the specified action.
Yes
Yes
CHARACTER
AccessType
Access type, if any, for some action.
Yes
Yes
CHARACTER
AlternateImageRule
TRUE if able to successfully assign some value to the AlternateImageRule for some action.
No
Yes
CHARACTER
Caption
Caption for some action, or the empty string if there is no caption defined.
Yes
Yes
CHARACTER
Category
Category for the action identified in the argument.
Yes
No
CHARACTER
Children
Comma-separated list of all children of a specified action.
Yes
No
CHARACTER
ControlType
Control-type for the action identified in the argument.
Yes
No
CHARACTER
CreateEvent
Creates an event for the specified action.
Yes
No
CHARACTER
Description
Value for the specified action.
Yes
Yes
CHARACTER
Disabled
Value of actionDisabled. TRUE if the action identified in the argument has been disabled.
Yes
No
CHARACTER
DisableRule
Flag indicating whether or not a value can be assigned to DisableRule. TRUE if a value can be assigned.
No
Yes
CHARACTER
EnableRule
The ImageEnableRule for a given action as stored in the repository.
Yes
Yes
CHARACTER
EnableRulex
Query string for the specified argument. Valid values are reset, add, copy, delete, save, cancel, first, prev, next, and last
Yes
No
CHARACTER
Event
Identifies the event to publish on Default-action of the browse. This property defines the persistent trigger that runs defaultAction and also subscribes the source-procedure.
Yes
Yes
CHARACTER
Groups
Identifies the action groups specified by Instance Properties. Instance Properties list the ADM instance properties of the selected SmartObject. See the “InstanceProperties” section for more information.
Yes
Yes
CHARACTER
HideRule
Value of HideRule for the action supplied as the argument.
Yes
Yes
CHARACTER
HideRuleX
A string value depending on the argument. The empty string is returned if the argument is not valid. Valid values are update, txtTableioOk, and txtTableioCancel.
Yes
No
CHARACTER
Image
Value for ActionImage.
Yes
Yes
CHARACTER
ImageAlternate
Value actionImageAlternate.
Yes
No
CHARACTER
ImageAlternateRule
ImageAlternateRule for a given action as stored in the repository. The rules are evaluated in ruleStateChanges.
Yes
Yes
CHARACTER
InitCode
Value of InitCode.
Yes
No
CHARACTER
IsMenu
Flag determines whether or not an action is Menu. TRUE if the action is Menu. Actions defined as a menu are considered to be a constant part of the toolbar and are not selectable. This means that the action is always available. The action needs to be added to a toolbar with createToolbar or insertMenu(). It does not appear as a selectable action in the instance property dialog even if actionIsParent returns a TRUE status.
Yes
No
CHARACTER
IsParent
Indicates whether or not an action is a parent. TRUE if the identified action is a parent.
Yes
No
CHARACTER
Label
Button label for the action button.
Yes
Yes
CHARACTER
Link
Link value for a specified action.
Yes
No
CHARACTER
LogicalObjectName
LogicalObjectName value for a specified action.
Yes
No
CHARACTER
Name
Name value for a specified action.
Yes
Yes
CHARACTER
OnChoose
OnChoose value for a specified action.
Yes
No
CHARACTER
Order
Associates an integer order number with an action.
No
Yes
CHARACTER
Parameter
RunParameter value for a specified action.
Yes
No
CHARACTER
Parent
Parent value for a specified action.
Yes
Yes
CHARACTER
PhysicalObjectName
PhysicalObjectName value for a specified action.
Yes
No
CHARACTER
Refresh
Flag indicating whether or not the specified action can be refreshed. TRUE if the specified action can be refreshed.
Yes
No
CHARACTER
RunAttribute
RunAttribute value for a specified action.
Yes
No
CHARACTER
SecondImage
Image2 value for a specified action. TRUE if able to assign a new value to Image2 for some action.
Yes
Yes
CHARACTER
SecuredToken
SecurityToken value for a specified action.
Yes
No
CHARACTER
SubstituteProperty
SubstituteProperty value for a specified action.
Yes
No
CHARACTER
Tooltip
Value depends on the value of TranslatedActionTooltip for a specified action. The values that might be returned are:
*TranslatedActionMLabel
*TranslatedActionLabel
*Tooltip.
TRUE if able to assign a new value to Tooltip for a specified action.
Yes
Yes
CHARACTER
Type
Type value for a specified action.
Yes
No
CHARACTER