Specification Host (DriveWorks Documentation)

Specification Host

The Specification Host allows you to host a Specification or child specification in your form.

The properties on the control do not determine what specification is shown. The Specification Host control is a placeholder for where the specification is going to be shown.

The Specification Host control receives what specification to show from a Specification Macro called Set Specification Host Control. With this Specification Macro you can create new specifications or edit existing ones.

Dialog Forms, launched from Item Lists, Dialog or Macro Buttons, are not supported inside of a Specification Host Control.

Passing Data

Data is passed to the specification through the Input Values property on the Specification Host Control. The data is passed to the control as an array. The array is structured as Name and Value, where Name is the name of the Control or Constant to store the value in.

These will be continuously synchronized between the host specification and the hosted specification. This means that values can be passed from the host to the hosted specification seamlessly.

Values can also be passed back to the host specification through the return value of the Specification Host Control. The return value of the control is an Array containing Specification Details and Specification Properties that the specification can store.

Through the use on Input Values and the controls Return value, you can pass data from a Specification to another specification and back again.

Running Specification Macros

Specification Macros can be ran in the hosted specification by the host specification. And likewise, the hosted specification can run Specification Macros in the host specification.

This is achieved using two Specification Macros tasks. These are called Run Macro in Hosted Specification and Run Macro in Host Specification. These tasks allow you to run macros between the Specifications you have open. This allows you to interact with the host and hosted Specifications and run macros in each of them.

Return Value

The return value from the Specification Host Control is an array of data that contains the hosted specifications Specification Properties. Specification Id, Specification Name, Specification State, and any other custom Specification Properties.

This control does not have a caption. Consider adding a label control if a caption is required.

Properties

Appearance

Opacity

Specifies the opacity of the control.

Requires a value between 0 (not visible) and 100 (fully visible).

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).
Horizontal Scroll Visibility
Controls the visibility behavior of the horizontal scroll bar for this frame control's content.
Input Values
Optional table of values to drive into the specification. This should be a table with 2 columns: ""Name"" and ""Value"". Names can be constants or controls etc.
Tab Index
Configures the position of the control in the form tab order.
Vertical Scroll Visibility
Controls the visibility behavior of the vertical scroll bar for this frame control's content.
Visible
Determines whether the control is visible (TRUE) or hidden (FALSE).

Events

On Cancelled Macro Name
The name of a macro to execute when the hosted specification has been cancelled.
On Transitioned Macro Name
The name of a macro to execute when the hosted specification has finished transitioning (moved to a different state).

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.

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.

DriveWorks Pro 24
Specification Host