skip to main content
OpenEdge Development: ADM Reference
Toolbar Objects and Their Methods and Properties : Toolbar object properties
 
Toolbar object properties
Toolbar Object properties provide information about toolbar objects and their classes. This information can include whether an object is enabled, the contents of the object and so on. You can read property values and in many instances you can change property values. To read a property value, you use a get function, and to change a property value, you use a set function.
These functions conform to the following conventions:
*get — Uses the form getpropname and returns the current value of the property.
Note: This function accepts no arguments.
*set — Uses the form setpropname. The set function accepts a single argument—the new value for the property—and returns TRUE/FALSE depending on whether the value change succeeds.
For more information about getting and setting property values, see Chapter 1, “ADM2 SmartObject API Reference.”
AvailMenuActions
Actions that are available in the menu of the toolbar object. Updated internally from insertMenu. The Instance Property dialog shows these and AvailToolbarActions. The actions selected are saved as ActionGroups.
Data type: CHARACTER
Note: Read and Write.
AvailToolbarActions
List of actions available in the menu of this toolbar. The Instance Properties dialog shows these and AvailMenuActions. The actions selected are saved as ActionGroups.
Data type: CHARACTER
Note: Read and Write.
AvailToolbarBands
Comma-separated list of the available toolbar bands for this toolbar master. Assembles the list by looping through the temp-table.
Data type: CHARACTER
Note: Read only.
BoxRectangle
Handle to the rectangle, if any, around the buttons in the Panel used by resizeObject.
Data type: HANDLE
Note: Read only.
BoxRectangle2
Used for bottom rectangle on toolbars where ToolbarAutosize is TRUE.
Data type: HANDLE
Note: Read and Write.
ButtonCount
Number of buttons in a SmartPanel. Used by resizeObject.
Data type: INTEGER
Note: Read only.
DeactivateTargetOnHide
Property used to control whether or not a target should be deactivated immediately on hide. If TRUE, the target should be deactivated.
Data type: Logical
Notes:  
*Read and Write.
*If TRUE, the received event is returned to the linkStateHandler of the source procedure along with the handle of the toolbar so that it can activate or deactivate the link accordingly.
*If FALSE, an inactive state is ignored and an active event is used to pass inactive to the linkstateHandler procedure for all the targets that are not the source of the publish and active is passed to the source for activation.
DisabledActions
Comma-separated list of disabled actions. Placing actions in this list immediately disables them and calls to enableActions have no effect on them while they are listed. That makes it possible to permanently disable actions regardless of state changes. Removing actions from this list with modifyDisabledActions allows enableActions to enable them again.
Data type: CHARACTER
Note: Read and Write.
EdgePixels
Value of EdgePixels.
Data type: INTEGER
Note: Read and Write.
HiddenActions
Comma separated list of hidden actions.
Data type: CHARACTER
Note: Read and Write.
HiddenMenuBands
Comma-separated list of hidden menu bands.
Data type: CHARACTER
Note: Read and Write.
HiddenToolbarBands
Comma-separated list of hidden toolbar bands.
Data type: CHARACTER
Note: Read and Write.
Image
Name of the button of interest or button-image number.
Data type: LOGICAL
Note: Write only.
ImagePath
Path to the images in the file system.
Data type: LOGICAL
Note: Read and Write.
MarginPixels
Number of pixels to reserve for the Panel margin used by resizeObject.
Data type: INTEGER
Note: Read only.
Menu
Determines whether or not to generate a menu. TRUE if a menu is to be generated.
Data type: LOGICAL
Note: Read and Write.
MenuMergeOrder
Determines the order in which menus are merged with other toolbar instances.
Data type: INTEGER
Note: Read and Write.
MinHeight
Determines the minimum height.
Data type: DECIMAL
Note: This property is Read only in toolbar.p and Read and Write in visual.p.
MinWidth
Determines the minimum width.
Data type: DECIMAL
Note: Read only.
NavigationTargetEvents
Comma-separated list of the events this object wants to subscribe to in its NavigationTarget.
Data type: CHARACTER
Note: Read only.
NavigationTargetName
Object name of the Data Object to be navigated by this panel. This is set if the Navigation-Target is an SBO or other Container with DataObjects.
Data type: CHARACTER
Note: Read and Write.
PanelFrame
Frame handle of the SmartPanel, for resizeObject.
Data type: HANDLE
Note: Read only.
PanelLabel
Handle of the label for the Panel, if any.
Data type: HANDLE
Note: Read only.
PanelState
Current state of the SmartPanel.
Data type: CHARACTER
Note: Read and Write.
PanelType
Type of SmartPanel (Update, Navigation, and so on).
Data type: CHARACTER
Note: Read and Write.
SecuredTokens
Comma-separated list of secured tokens available from the container.
Data type: CHARACTER
Note: Read and Write.
ShowBorder
Determines whether or not a three-dimensional border is to be used around the buttons and as a delimiter when RULE is specified in createToolbar. TRUE if a three-dimensional border is to be used around.
Data type: LOGICAL
Note: Read and Write.
StaticPrefix
Prefix used before the action name in static definitions. Needed for use with the Repository.
Data type: CHARACTER
Note: Read and Write.
TableIOTarget
List of the handles, in character format, of the TableIO Targets of an object.
Data type: CHARACTER
Note: Read and Write.
TableIOTargetEvents
Comma-separated list of the events to which this object wants to subscribe to in its TableIO Target.
Data type: CHARACTER
Note: Read and Write.
TableIOType
Comma-separated list in CHARACTER format of the object’s TableIO-Target handles.
TableIO-specific values of PanelType, if any, so that resetTabelio can handle panels similar to toolbar.
Data type: CHARACTER
Note: Read and Write.
Toolbar
Determines whether or not to create a toolbar. TRUE if the toolbar is to be created.
Data type: LOGICAL
Note: Read and Write.
ToolbarAutoSize
Determines whether or not the toolbar should be auto-sized to the width of the window at runtime. TRUE if the toolbar should be auto-sized.
Data type: LOGICAL
Note: Read and Write.
ToolbarBands
List of the toolbar bands selected in the Instance Properties.
Data type: CHARACTER
Note: Read and Write.
ToolbarDrawDirection
Draw direction: horizontal or vertical of the toolbar.
Data type: CHARACTER
Note: Read and Write.
ToolbarHeightPxl
Calculates and returns the toolbar height in pixels from the three properties: ToolHeightPXL, ToolbarMarginPxl, and ShowBorder.
Data type: INTEGER
Note: Read only.
ToolbarInitialState
State selected in the Instance Properties. Used to view or hide buttons and menus according to state.
Data type: CHARACTER
Note: Read and Write.
ToolbarTargetEvents
List of events to which this object wants to subscribe in the Toolbar-Target.
Data type: CHARACTER
Note: Read and Write.
ToolbarWidthPxl
Calculates and returns the toolbar width: ToolMarginPxl, ToolWidthPxl, and ToolMaxWidthPxl.
Data type: INTEGER
Note: Read only.
ToolMarginPxl
Returns a constant zero.
Data type: INTEGER
Note: Read and Write.