Macro Button (DriveWorks Documentation)

Macro Button

The Macro Button displays a button on the user form that when clicked will run a macro.

The name of the macro to launch is set in the Macro Name property.

This must result the name given to a macro that exists in the project; for example:

"MyMacro"

There are 2 options available for writing macros:

Use pre-defined tasks, applied to a Specification Macro.
Consistency settings can be applied when running Specification Macros executed from the Macro Button.
Write the macro using the DriveWorks SDK. See How To: Obtain The DriveWorks SDK.

When the form control is applied the name entered will display as the caption for the form control. This can be changed by selecting the Text property.

Properties

Appearance

Background Color
Specifies the color of the control's background.
Button Background Color
Specifies the background color of buttons in the control.
Button Background Color (Disabled)
Specifies the background color of buttons in the control, when the control is disabled.
Button Background Color (Hover)
Specifies the background color of buttons in the control, when the button is in a hovered state.
Button Background Color (Pressed)
Specifies the background color of buttons in the control, when the button is in a pressed state.
Button Opacity (Disabled)
Specifies the opacity of the button when the control is disabled, between 0 and 100.
Button Padding
Specifies the padding of buttons in the control.
Button Spacing
Specifies the spacing between the button's text and picture. Applies when Picture Style is set to "TextAndPicture".

Appearance - Border

Border Color
Specifies the color of the control's outer border when the 'SingleLine' border style is selected.
Border Color (Disabled)
Specifies the border color of the control when in a disabled state.
Border Color (Hover)
Specifies the color of the controls border when in a hovered state.
Border Color (Pressed)
Specifies the border color of the control when in a pressed state.
Border Radius
Specifies the border radius of the control.
Border Radius (Hover)
Specifies the border radius of the control when in a hovered state.
Border Radius (Pressed)
Specifies the border radius of the control when in a pressed state.
Border Width
Specifies the width of the control's border.
Outline Color (Focus)
Specifies the outline color of the control when in a focused state.

Appearance - Picture

Picture
The default picture to be shown for this control.
Picture (Hover)
The picture to be shown when the control is in a hover state.
Picture (Pressed)
The picture to be shown when the control is in a pressed state.
Picture Border Radius
Specifies the border radius of the picture container inside the button.
Picture Border Radius (Hover)
Specifies the border radius of the picture container inside the button, when the button is hovered.
Picture Border Radius (Pressed)
Specifies the border radius of the picture container inside the button, when the button is pressed.
Picture Height
Specifies the height of the picture container inside the button.
Picture Position
Specifies the position of the picture container inside the button, relative to the text. Applies when Picture Style is set to TextAndPicture.
Picture Size Mode
Controls how the picture will be sized to the control.
Picture Style
Controls how the picture will appear on the control.
Picture Width
Specifies the height of the picture container inside the button.

Appearance - Text

Font
Specifies the font of the text shown in the control.
Text Color
Specifies the color of the control's text.
Text Color (Disabled)
Specifies the color of the control's text when the control is disabled.
Text Color (Hover)
Specifies the color of the control's text when the control is in a hovered state.
Text Color (Pressed)
Specifies the color of the control's text when the control is in a pressed state.
Text Horizontal Alignment
Controls whether the text is horizontally aligned to the left, right or center

Behavior

Enabled
Controls whether the control is enabled (if the result is TRUE) or disabled (if the result is anything other than TRUE, e.g. FALSE).
Error Result
Determines whether the value of the control is in error. The result of this rule is a string containing the error message if the value is in error, otherwise a blank string or the number zero.
Macro Argument
Provides an optional argument to the macro
Macro Name
Determines the name of the macro to fire when the macro button is clicked.
Tab Index
Configures the position of the control in the form tab order.
Text
Specifies the text shown in the control.
Visible
Determines whether the control is visible (TRUE) or hidden (FALSE).

General

(Metadata)
Optional text which can be used to provide information belonging to or about a control. For example, a list of CSS classes which can be parsed and applied to the control using the Integration Theme in DriveWorks Live. This doesn't affect the control's behavior.
(Name)
The name of the control
(Tag)
Optional text which can be used to describe the control, but which doesn't affect the control's behavior.
Tooltip Duration
Controls the duration, in seconds, for which the tooltip will remain visible. Values of 0 and below indicate an infinite duration.
Tooltip Text
Specifies the text to display in a tooltip when hovering over the control.

Layout

Height
Controls the height of the control.
Left
Controls the left position of the control.
Top
Controls the top position of the control.
Width
Controls the width of the control.

A user form control that, when selected, will run a VBA macro.