Editing Components

The Edit Component window enables you to configure component attributes.

To access the Edit Component window:

1.Select button_select00037.png from the Edit Mode toolbar.

2.Double-click the component you want to edit.

Tip: The components are hierarchical. As you hover over the panel, an outline appears to show which component would be selected if you were to click.

The Edit Component window appears.

The contents of the Edit Component window vary depending on the type of component you are editing.

The Edit Component window consists of six areas:

EditCompsCall.jpg 

Figure 1.24  - Edit Component WIndow

1.Title Area

The title area indicates the type of component you are editing.

2.Insert Tag Area

This area consists of buttons that enable you to add items to the component tree. The buttons represent items which cannot be added through the graphic interface of PanelBuilder. For more information, see Component Tree .

3.Component Tree

This area shows component information for the entire CustomPanel, presented in a hierarchy. Use the component tree to select which item you want to edit. The current item is highlighted blue.

Tip: You can scroll through components by using the up and down keys

4.Attribute Editor

The attribute editor area consists of tabs listing editable attributes of the selected component. Which tabs are shown depends on the type of component you are editing.

5.Preview Area

This area shows the component you are editing. If you apply changes, the preview area updates.

6.Apply Buttons

Use the various Apply buttons to commit any changes you have made:

Apply Changes — Applies the changes and keeps the Edit Component window open afterwards.

Apply and Close — Applies the changes and closes the Edit Component window.

Close — Closes the Edit Component window without applying any changes.

Component Tree

This area shows component information for the entire CustomPanel, presented in a hierarchy. Use the component tree to select which item you want to edit. The current item is highlighted blue.

While most items in the tree are created by using the graphical interface of PanelBuilder, some cannot be created this way. They are created by inserting metadata tags into the tree, by clicking buttons in the Insert Tags area above the tree.

When you click a button, the tag is added to the tree, within a <meta> tag. After you add a tag, select it in the tree and then use the tabs in the Attribute Editor area to customize it.

You can insert the following types of tags:

<listener/> — Creates a listener object, which enables DashBoard to receive messages and data from external devices over the network.

For information about specifying listener attributes, see Listener Attributes Tab.

<style/> — Creates a style definition. You can create named style definitions which can be applied to objects within the same container object. This is useful for creating common visual themes across components. By changing a setting in the style definition, you can change that setting for all components that reference the style definition.

Tip: A style preset is available only to objects within its parent container object. To create a set of style presets for the entire panel, create them immediately below the top level container object (typically abs).

To apply a style definition to an object, select the style name from the Defined Style list on the Style tab for the object.

Tip: Predefined style settings can be overridden individually for a given object.

For information about specifying style attributes, see Style Tab.

<color/> — Creates a color definition. You can create named color definitions which can be referenced from anywhere. This is useful for creating common visual themes across components. By changing settings in the color definition, you can change that setting for all components that reference that color definition.

For information about specifying color attributes, see Color Attributes Tab.

<lookup/> — Creates a data lookup table, which can be read using ogScript functions.

For information about specifying lookup attributes, see Lookup Attributes Tab.

<ogscript/> — Creates a named section of ogScript code, which can be referenced. You can also associate the ogScript with an action and a UI element, so that the ogScript is executed when the action is performed on the UI element. For example, you can make the ogScript run when the user drags the mouse (ondrag).

For information about specifying ogScript attributes, see ogScript Attributes Tab.

<api/> — Creates an Application Program Interface (API) section of ogScript code. You can set the API to execute immediately when the panel is loaded, or not. Functions within the <api/> tag have global scope, which enables them to be called from anywhere else in the panel.

For information about specifying API attributes, see Api Attributes Tab.

Attribute Editor Tabs

The attribute editor area of the Edit Component window consists of tabs listing editable attributes of the selected component. Which tabs are shown depends on the type of component you are editing. To edit component attributes, specify values and then apply the changes. If you want to use the default value, click the delete.jpg next to the attribute name.

The Source tab is present for every component. It shows the underlying XML source code that defines the selected component. You can edit the XML code directly in the Source tab, or paste XML code into it. To view or edit the XML source for the entire CustomPanel, select the top element in the component tree and then view its Source tab.

Tip: To quickly view the source for a component, press and hold the Shift key, and double-click. The View Source window appears. The XML source cannot be edited in this window.

Some tabs are divided into two areas: Current Attributes and Unused Attributes. The Current Attributes area shows the attribute values currently applied to the selected component. Only attributes that have been edited appear here. The Unused Attributes area shows attributes for which default values apply. For example, in the following Style tab, only the border and background attributes have been defined:

CurrUnusedAtts.bmp 

Figure 1.25  - Current and Unused Attributes

When you edit values in the Unused Attributes area and then apply the changes, those attributes move up to the Current Attributes area.

The attribute editor area includes a subset of the following tabs, depending on the type of component you are editing:

Abs Attributes Tab 

Api Attributes Tab 

Basic Attributes Tab 

Browser Attributes Tab 

Button Attributes Tab 

Color Attributes Tab 

Container Attributes Tab 

Dropspot Attributes Tab 

Editor Attributes Tab 

Flow Attributes Tab 

Label Attributes Tab 

Listener Attributes Tab 

Lookup Attributes Tab 

Meta Attributes Tab 

Ndi Attributes Tab 

ogScript Attributes Tab 

Param Attributes Tab

Position/Stretch Attributes Tab 

Simplegrid Attributes Tab 

Source Tab 

Split Attributes Tab 

Statuscombo Attributes Tab 

Style Tab 

Tab Attributes Tab

Table Attributes Tab 

Table Cell Attributes Tab 

Tag Attributes Tab 

Task Attributes Tab

Timer Attributes Tab 

Timertask Attributes Tab

Tr Attributes Tab 

TreeElement Attributes Tab 

Widget Attributes Tab 

Abs Attributes Tab

Abs Attributes apply to the following types of components:

Basic Canvases

Image Canvases

Attribute

Description

General Attributes

Name

Type a name or description for the Abs canvas.

This name is used as a reference in the Component Tree. It does not appear in the CustomPanel interface.

ID

Type a scripting ID for the Abs canvas.

Virtual Width

Enter or select a width in pixels for the virtual width of the canvas.

This determines how wide the workspace canvas is. For example, if using a large monitor, you might want to use a high number of pixels to accommodate a greater number of components. Conversely, if using a smaller monitor, you might want to use a lower number of pixels.

Select the default check box to use the default virtual width of 1,079 pixels.

Virtual Height

Enter or select a height in pixels for the virtual height of the canvas.

This determines how tall the workspace canvas is. For example, if using a large monitor, you might want to use a high number of pixels to accommodate a greater number of components. Conversely, if using a smaller monitor, you might want to use a lower number of pixels.

Select the default check box to use the default virtual height of 931 pixels.

Lock Contents (widget root)

Select this check box to disable the selection of sub-elements in the canvas. This allows for easy selection, copy, and paste of a component.

Elements under the widget root can only be selected by selecting the item node in the tree. Users can not add to, or directly modify, the contents of a widget, move a widget, or resize a widget. This allows the block of code for the widget to be self-contained and able to be dragged and dropped elsewhere with ease.

Scrolling

Click the menu and select an option for adding scroll bars to the Abs canvas:

True — use vertical and/or horizontal scroll bar, if needed.

False — do not use scroll bars for the Abs canvas.

Vertical — add a vertical scroll bar to the Abs canvas.

Horizontal — add a horizontal scroll bar to the Abs canvas.

Always — always use vertical and horizontal scroll bars for the Abs canvas.

Data Source/Device Control

openGear or XPression DataLinq

 

or

 

NK Series Routers

Select a device for context:

openGear or XPression DataLinq — this option opens the Select Device for Context dialog box, where you can select an openGear card or XPression DataLinq XML file to associate with the panel.

NK Series Routers — this option opens the Select IPS dialog box, where you can select a router node.

Note: If both boxes are clear, the panel is not associated with a device or data source.

XPression DashBoard Linq Port

If you want to stream XML data to an XPression system directly without sharing an XML file, specify the port to use on the DashBoard computer and select Enable Streaming.

Note: You must also set up a DashBoard DataLinq source on the XPression DataLinq server. The DashBoard Linq must point to the IP address and port of the DashBoard computer that hosts the CustomPanel from which you want to stream data.

NK Series Routers

Select the check box to associate the panel with NK Series routers for device control.

Remote Task Triggering

Internal RossTalk GPI Listener

Specifies the TCP/IP port to monitor for RossTalk commands for this container object and its children.

RossTalk GPI commands are formatted as GPI [trigger]:[state].

This setting is available only if this container object has its context attribute set to opengear (contexttype=opengear).

VDCP Task Server Port

Specifies the TCP/IP port to use for publishing all of the current object’s tasks with trigger IDs as VDCP clips.

Tasks can be listed, cued, and played through devices capable of VDCP communication over TCP/IP.

This setting is available only if this container object has its context attribute set to opengear (contexttype=opengear).

HTTP Trigger Server Port

Tasks assigned to this object with trigger IDs are published to a web page hosted at the specified port (http://localhost:[port]/).

Tasks can be triggered by going to http://localhost:[port]/[trigger ID]/[State].

This setting is available only if this container object has its context attribute set to opengear (contexttype=opengear).

Api Attributes Tab

API Attributes apply to <api/> tags in the component tree.

Attribute / Control

Description

General Attributes

Name

Type a name for the API.

This name appears in the Component Tree. It does not appear in the CustomPanel interface.

contentfunction

The optional contentfunction attribute calls the function of the specified name, for example, contentfunction="myFunction".

If that called function returns XML, the <api/> tag renders the provided XML as its UI. This allows you to dynamically generate UIs.

The contentfunction attribute is not shown on the Api Attributes tab, but can be added to the <api/> tag on the Source tab.

Note: If the <api/> tag has the contentfunction attribute set, the <api/> script is executed immediately.

ID

Type a scripting ID for the API.

Script File Location

Optionally, you can specify a file that contains the API code. This enables re-use of APIs across multiple panels.

The file must be a text file containing only properly-formatted ogScript. The file extension can be anything, but we recommend using .ogscript.

If you specify a script file, do not create any code in the ogScript Content section of the Api Attributes tab.

Tip: If your API code is in a separate script file, ‘escaping’ XML characters is not necessary.

Execute Immediately

When selected (immediate="true"), the script in the <api/> tag is evaluated as soon as it is reached, during the panel build process. This allows the script to create global functions that can be called from anywhere in the panel, create new parameters on the fly, and modify constraints of parameters even before they are displayed. If the <api/> tag has the contentfunction attribute set, the script is executed immediately.

When cleared (immediate="false"),the script in the <api/> tag is evaluated onload.

ogScript Content

Visual button

The Visual button changes the ogScript Content area to show the Visual Logic editor, which enables you to created and edit ogScript code segments visually.

For more information about the Visual Logic editor, see DashBoard Visual Logic.

ogScript button

The ogScript button changes the ogScript Content area to show the manual ogScript editor.

For more information about the manual ogScript editor, see Editing ogScript Code.

Basic Attributes Tab

Basic Attributes apply to the following types of components:

Tables

Attribute

Description

General Attributes

Name

Type a name or description for the basic component.

This name is used as a reference in the Component Tree. It does not appear in the CustomPanel interface.

ID

Type a scripting ID for the basic component.

Browser Attributes Tab

Browser Attributes apply to the following types of components:

Web Browser Instances

Attribute

Description

General Attributes

Name

Type a name or description for the browser component.

This name is used as a reference in the Component Tree. It does not appear in the CustomPanel interface.

ID

Type a scripting ID for the browser component.

URL

Type a URL of the website to use for the browser component.

Button Attributes Tab

Button Attributes apply to the following types of components:

Buttons

Attribute

Description

General Attributes

Name

Type a name or description to display on the button.

This name is also used as a reference in the Component Tree.

ID

Type a scripting ID for the button.

Type

Click the menu and select a button type:

Push — select to use a simple one-press button to run tasks. The button has no state.

Toggle — select to use a toggle button. For a toggle button, when the button is clicked, a function is turned on. Clicking it again turns the function off.

Checkbox — select to use a check box for enabling and disabling a function.

Radio — select to use a radio button for enabling and disabling functions.

Flat Look

Select the check box to use a plain, non-stylized button display.

Tasks

Trigger ID

If you want the tasks to run when a GPI listener receives a certain trigger message, type the trigger ID. For more information, see Creating a GPI Trigger.

Tasks List

This list displays the tasks that have been added to a button. Tasks are commands or controls assigned to the component. The tasks run in top to bottom order. Use the buttons to arrange the tasks:

First — click to move a selected task to the top of the Tasks List.

Move Up — click to move a selected task up one position in the Tasks List.

Move Down — click to move a selected task down one position in the Tasks List.

Last — click to move a selected task to the bottom of the Tasks List.

Add

Click the button to open the Add Task dialog box and add tasks to the button. The tasks are added to the Tasks List.

Edit

Click the button to open the Edit Task dialog box and edit a selected task from the Tasks List.

Delete

Click the button to delete a selected task from the Tasks List.

Color Attributes Tab

Color attributes define the characteristics of a named color definition, which can be referenced in ogScript.

Attribute

Description

General Attributes

Name

Type a name of the color definition.

ID

Type a scripting ID for the color definition

Color

Click the dropdown and select a color for the background and modify the Hue, Saturation, Lightness, and Transparency of the selected color.

Use the library located at the bottom of the color dropdown to select a preset color from a color swatch.

Container Attributes Tab

Container Attributes apply to the following types of components:

Attribute

Description

Advanced Table Settings

Max Elements Per Row

Limits the number of table columns, for tables that are populated by a parameter that returns multiple elements, such as a set of buttons.

For example, this option is useful if you want to create a table of buttons, each of which includes a choice as defined in a parameter with nine values. Create a one-cell table and set Max Elements Per Row to 3. Drag the parameter onto the table, setting it as a choice list, with the Keep returned elements together option unselected. The table will have three rows of three buttons, each of which contains one of the nine choices defined in the parameter.

For more information on creating tables with rows of buttons, refer to the section "Buttons".

Position/Stretch Attributes

Anchor Points

Use the menu to specify the location and sizing of the component on the canvas should the panel be resized:

Position1.bmp 

The component remains fixed to the selected location if the panel is resized.

For detailed information on Anchor Points, refer to refer to the section "Anchor Points and Background Alignment".

Top (pixels)

Type or select a number of pixels to offset the component from the top margins of the panel.

Left (pixels)

Type or select a number of pixels to offset the component from the left side margins of the panel.

Bottom (pixels)

Type or select a number of pixels to offset the component from the bottom margins of the panel.

Right (pixels)

Type or select a number of pixels to offset the component from the right side margins of the panel.

Width (pixels)

Enter or select a fixed width in pixels for the component. The component retains these dimensions if the panel is resized.

Select the Use default check box to use the default width for the component.

Height (pixels)

Enter or select a fixed height in pixels for the component. The component retains these dimensions if the panel is resized.

Select the Use default check box to use the default height for the component.

 

 

Dropspot Attributes Tab

Dropspot Attributes apply to the following types of components:

Split Panels

Tables

Attribute

Description

General Attributes

Name

Type a name or description for the dropspot.

This name is used as a reference in the Component Tree. It does not appear in the CustomPanel interface.

ID

Type a scripting ID for the dropspot.

Editor Attributes Tab

Editor Attributes apply to editor nodes in the component tree. Editor nodes appear in the component tree if your panel includes controls for devices that include a device editor.

Attribute

Description

General Attributes

Name

Type a name or description for the editor.

This name is used as a reference in the Component Tree. It does not appear in the CustomPanel interface.

ID

Type a scripting ID for the editor.

Lock Contents (widget root)

Select this check box to disable the selection of sub-elements in the canvas. This allows for easy selection, copy, and paste of a component.

Elements under the widget root can only be selected by selecting the item node in the tree. Users can not add to, or directly modify, the contents of a widget, move a widget, or resize a widget. This allows the block of code for the widget to be self-contained and able to be dragged and dropped elsewhere with ease.

Note: This option is ineffectual for embedded device editors.

Scrolling

Click the menu and select an option for adding scroll bars to the device canvas:

True — use vertical and/or horizontal scroll bars according to the size of the device canvas.

False — do not use scroll bars for the device canvas.

Vertical — add a vertical scroll bar to the device canvas.

Horizontal — add a horizontal scroll bar to the device canvas.

Always — always use vertical and horizontal scroll bars for the device canvas.

Flow Attributes Tab

Flow Attributes apply to the following types of components:

Flow Containers (Wrap Content)

Attribute

Description

General Attributes

Name

Type a name or description for the flow container component.

ID

Type a scripting ID for the flow container component.

Data Source/Device Control

openGear or XPression DataLinq

 

or

 

NK Series Routers

Select a device for context:

openGear or XPression DataLinq — this option opens the Select Device for Context dialog box, where you can select an openGear card or XPression DataLinq XML file to associate with the flow container.

NK Series Routers — this option opens the Select IPS dialog box, where you can select a router node.

Note: If both boxes are clear, the flow container uses the surrounding context.

Horizontal Alignment

If you want the components to be neatly aligned along the right or left edge of the container, or centered within the container, specify the Horizontal Alignment accordingly.

Keep all widths the same

Select this option is you want the widths of all components in the container to be the same.

All component widths will match the width of the widest one.

Keep all heights the same

Select this option is you want the heights of all components in the container to be the same.

All component heights will match the height of the tallest one.

Fill single line if possible

If Keep all widths the same is selected, and you want all the components to fill a single row if possible, select Fill single line if possible.

If the components widths are small enough that the components can all fit on one row with extra space, the widths are expanded to fill the row.

Lock Contents (widget root)

Select this check box to disable the selection of sub-elements in the canvas. This allows for easy selection, copy, and paste of a component.

Elements under the widget root can only be selected by selecting the item node in the tree. Users can not add to, or directly modify, the contents of a widget, move a widget, or resize a widget. This allows the block of code for the widget to be self-contained and able to be dragged and dropped elsewhere with ease.

Scrolling

Click the menu and select an option for adding scroll bars to the flow container component:

True — use vertical and/or horizontal scroll bars according to the size of the flow container component.

False — do not use scroll bars for the flow container component.

Vertical — add a vertical scroll bar to the flow container component.

Horizontal — add a horizontal scroll bar to the flow container component.

Always — always use vertical and horizontal scroll bars for the flow container component.

Label Attributes Tab

Label Attributes apply to the following types of components:

Labels

Links to Device Editors or Other CustomPanels

Attribute

Description

General Attributes

Name

Type the text that you want to display on the label.

ID

Type a scripting ID for the label.

Header

Select the check box to stylize the label as a header.

The appearance can be edited in the Style tab.

Tasks

Trigger ID

If you want the tasks to run when a GPI listener receives a certain trigger message, type the trigger ID. For more information, see Creating a GPI Trigger.

Tasks List

This list displays the tasks that have been added to a label. Tasks are commands or controls assigned to the component. The tasks run in top to bottom order. Use the buttons to arrange the tasks:

First — click to move a selected task to the top of the Tasks List.

Move Up — click to move a selected task up one position in the Tasks List.

Move Down — click to move a selected task down one position in the Tasks List.

Last — click to move a selected task to the bottom of the Tasks List.

Add

Click the button to open the Add Task dialog box and create tasks for the label. The tasks are added to the Tasks List.

Edit

Click the button to open the Edit Task dialog box and edit a selected task from the Tasks List.

Delete

Click the button to delete a selected task from the Tasks List.

Listener Attributes Tab

Listener attributes define the connection information and other properties of listener objects, which enable DashBoard to receive messages and data from external devices over the network.

Attribute

Description

General Attributes

Name

Type a name or description for the listener.

ID

Type a scripting ID for the listener.

Show start/stop toggle button

Select the check box if you want to display a button for starting and stopping the listener.

The button is displayed only if the <listener/> tag appears outside of the <meta/> tag in the source. Normally, <listener/> tags are used within the <meta/> tag.

Start automatically

Select the check box if you want the listener to start automatically.

Tip: Listeners always start automatically if the <listener> tag in the source is within a <meta> tag.

Connection Type/Settings

UDP Listener

Select this option if you want the listener to detect and receive UDP messages. Specify the following:

Port — The port number to listen to.

Max Length (UDP) — Specify the maximum number of bytes allowed in a UDP message. The listener truncates any messages that exceed this length.

Listen as server

Select this option if you want the listener to be the server in the server/client relationship.

Specify the number of the port on which the listener will communicate.

Connect as client

Select this option if you want the listener to be the client in the server/client relationship.

Select an existing server to which the listener connects.

You can also create a custom connection, and add it to the Global List. The connection appears as an entry in the ‘hosts’ lookup.

Delimiter type (TCP)

If communicating over TCP, specify the delimiter type.

The delimiter defines the beginning of a message.

Delimiter value

If communicating over TCP, specify the delimiter data.

This available options depend on the delimiter type:

Bytes — Specify the delimiter byte value in hexadecimal notation.

String — Specify the delimiter string text.

Fixed Length — Specify the message length, in bytes.

Variable Length — Each message starts with data defining the message length. Specify how many bytes are in the length-defining data at the start of the message.

Sync Word (TCP)

If communicating over TCP, type the synchronization word data to be transmitted as a message header at the start of each message.

Command Parsing

Stop all receive/task execution on pause

Select the check box if you want to stop receiving additional messages until all tasks associated with the previous message (including pauses) have finished execution.

If this option is not selected, the listener continues to fetch messages and adds them to the queue while tasks are running. This causes the task to be executed in the network RX thread.

If this option is selected, the task can interact directly with the socket, and possibly read additional bytes from the stream before processing continues.

Tasks

Tasks List

This list displays the tasks that have been added to a listener. Tasks are commands or controls assigned to the component. The tasks run in top to bottom order.

Use the buttons to arrange the tasks:

First — click to move a selected task to the top of the Tasks List.

Move Up — click to move a selected task up one position in the Tasks List.

Move Down — click to move a selected task down one position in the Tasks List.

Last — click to move a selected task to the bottom of the Tasks List.

Add

Click the button to open the Add Task dialog box and add tasks to the listener. The tasks are added to the Tasks List.

Edit

Click the button to open the Edit Task dialog box and edit a selected task from the Tasks List.

Delete

Click the button to delete a selected task from the Tasks List.

Lookup Attributes Tab

The Lookup Attributes tab is used to edit keys and values in lookup tables, including connection entries from the Global List.

Attribute

Description

General Attributes

Name

Type a name or description for the lookup component.

ID

Type a scripting ID for the lookup component.

Support multiline values

Select the check box to allow multiline entries in the Lookup Entries list.

Lookup Entries

This list displays the Key and Value that comprise entries in the lookup table.

Click inside a Key or Value box to edit the lookup entry.

Meta Attributes Tab

The Meta Attributes tab contains a name and OID for a metadata <meta> tag in the component tree.

Attribute

Description

General Attributes

Name

Type a name or description for the metadata.

ID

Type a scripting ID for the metadata.

Ndi Attributes Tab

The Ndi Attributes tab enables you to set properties related to displaying NDI™ video within a CustomPanel. For more information about adding NDI video, see NDI Video Panels.

Attribute

Description

General Attributes

Name

Type a name or description for the NDI™ panel.

ID

Type an ID for NDI™ panel.

Ndi Tag Attributes

Host:Port (optional)

Specify the host name and port number for the source of the video, in the format Host:Port. For example, myComputerName:5961.

Tip: Instead of specifying Host:Port, we recommend you select the source from the Source Name list.

Source Name

Select the video source (NDI channel) from the list.

Quality

Select either low or high.

Tally State

Specify whether you want the panel to report a tally status back to the source, and if so, what status to report. The available options are Off, Preview, Program, and Both.

Show Name

Show or hide the Name of the video display panel, as defined in the video display panel's General Attributes.

Show Source

Show or hide the Source Name or the host name and port number (Host:Port).

Show Timecode

Show or hide the video's timecode data.

Show Image Size

Show or hide the pixel size of the video display panel.

Fill

Specify how the video is positioned within the video display panel. Options are fit, crop, or both.

Sub Window (x,y,w,h)

Specify the origin position and dimensions of a dedicated video display panel.

ogScript Attributes Tab

The ogScript Attributes tab enables you to set the properties of named segments of ogScript code, and to create and edit the code. For more information about using ogScript, see Working with ogScript.

Attribute

Description

General Attributes

Name

Type a name or description for the segment of ogScript.

ID

Type a scripting ID for the segment of ogScript.

Event Type(s)

If you want the ogScript to execute when a specific event occurs in relation to a certain UI element, select the event type from the list. You can select multiple event types.

Target

If you specified one or more event types for triggering execution, select the ID of the corresponding UI element. The ogScript is executed when one of the selected events occurs in relation to the selected target.

ogScript Content

Visual button

The Visual button changes the ogScript Content area to show the Visual Logic editor, which enables you to created and edit ogScript code segments visually.

For more information about the Visual Logic editor, see DashBoard Visual Logic.

ogScript button

The ogScript button changes the ogScript Content area to show the manual ogScript editor.

For more information about the manual ogScript editor, see Editing ogScript Code.

Param Attributes Tab

The Param Attributes tab is used to configure the attributes of any item on the panel that contains a value, whether it is from a device or is a user-created parameter.

This is for both user-created items and for items that have been dragged and dropped into the canvas.

Attribute

Description

General Attributes

Name

Type a name or description for the parameter.

ID

Type a scripting ID for the parameter.

Scripting IDs are helpful because they provide a name for the parameter in the tree.

Parameter Settings

Name (read-only)

The parameter selected for the CustomPanel.

OID (Object Identifier)

Select a parameter from the menu to display its information in the tab and to edit its properties. The currently available parameters are listed according to your current data source. Their assigned OID tags and are available for the selected CustomPanel either from:

an associated data source

as defined via one of the tools in the Edit Mode toolbar.

a component dragged and dropped from a device in the Tree View.

Users will almost never use this field to modify the OID or change the parameter they are controlling. The more useful method is to drag new ones, delete old ones, etc.

Menu

This is a menu identifier.

Constraint

Use the menu to set limitations on the parameter values. These options depend on what has been selected as the Type in the Add/Edit Parameters dialog box.

By default, these values are determined directly from the parameter that is referenced. However, these defaults can be overridden by selecting the Override constraint check box. Overriding the defaults does not modify the constraints for the parameter, only for this particular control in the custom panel.

 

The possible options are as follows:

Unconstrained — select this when using a string, integer, or float type. No limitations are applied to the parameter value. For example, a text field parameter where a user can type any word or mix of letters and numbers.

Range Constraint — select this when using an integer or float type. Use this option to stipulate a range of numbers that the user can select from, such as a minimum and maximum value.

Choice Constraint — select this to provide a specific list of options that the user chooses from where each option is associated with a tag.

Alarm Table — select this to set constraint values for alarm states.

String Choice — select this when using a string type to provide a specific list of strings from which the user chooses.

String Key/Value Constraint — Select this option when using a string type to provide a specific list of options to the user. Each option (Name) is associated with a key (Value). The constraint choices are stored as key/value pairs.

Tip: Constraint values are located in the Constraint Value field.

Precision

Type or select a value:

When used with numbers — This field defines the number of digits following the decimal point displayed for printed numbers. It applies mainly to floating point numbers.

When used with string arrays — This field defines the maximum number of bytes reserved for a single element in the array. If it is 0, the maximum number of bytes in a parameter value are shared arbitrarily amongst all elements in the array.

Constraint Value

Use the Constraint Value area to define the valid set of values for the parameter.

 

For choice constraints, including string choice, do the following once for each valid value:

In the Value column, click [insert value], type a valid value, and then press Enter.

In the Name column, type a name for the value. The name is associated with the parameter value, and appears on labels, etc. The Name column is available only if the parameter is a numeric type, or if the constraint type is String Key/Value Constraint.

For range constraints:

In the Minimum box, type the lowest valid value.

In the Maximum box, type the highest valid value.

In the Step Size column, type the step size. For example, if valid values must be evenly divisible by 10, type 10.

If you plan to use a touch wheel in your panel, select the Loop check box.

For alarm table constraints, do the following once for each valid value:

In the Bit box, type the bit value for the constraint value. For example, you may have two options; 1 and 0. You would have one row for each bit state. The bit must be unique for each constraint value.

In the Severity box, select a severity level.

In the String box, type the alarm message you want associated with this constraint value.

Widget Hint

Select the graphical display hint for the parameter using the menu. The options are as follows:

Default — displays the parameter as defined according to the data source.

Read-only text — displays the parameter as a status text field that can not be altered by the user. A border and background are automatically applied to the field.

Label — displays the parameter as a text field without a border or background.

Text Entry — displays the parameter as a single line text field that is editable by the user. The user must enter one of the values defined using the Constraint Value field.

Multi-Line Text Entry — displays the parameter as a text field with more than one line. The user must enter one of the values defined using the Constraint Value field.

HTML Content — displays the parameter as a field that requires the user to input HTML data.

Editable Dropdown List — displays the parameter as a menu that the user clicks to display an expanded list of values to choose from. These values are determined in the Constraint Value field.

Alarm-Style Colored Dot — displays the parameter as a status indicator, similar to an LED, that updates based on conditions defined in the Constraint Value field.

Select the Get value from parameter box to disable the Widget Hint menu and use a graphical display hint from the parameter.

Force Read Only

Select this check box to use the parameter as read-only.

Keep returned elements together

Select the check box to keep parameters from devices together in the layout of radio buttons, toggle buttons, etc.

Current Value (read-only)

Displays the device that the parameter is used for.

Tasks

Trigger ID

If you want the tasks to run when a GPI listener receives a certain trigger message, type the trigger ID. For more information, see Creating a GPI Trigger.

Tasks List

This list displays the tasks that have been associated with the parameter. When the parameter value changes, the tasks are performed in the order listed. Use the buttons to arrange the order:

First — click to move a selected task to the top of the Tasks List.

Move Up — click to move a selected task up one position in the Tasks List.

Move Down — click to move a selected task down one position in the Tasks List.

Last — click to move a selected task to the bottom of the Tasks List.

Add

Click the button to open the Add Task dialog box and create tasks for the parameter. The tasks are added to the Tasks List.

Edit

Click the button to open the Edit Task dialog box and edit a selected task from the Tasks List.

Delete

Click the button to delete a selected task from the Tasks List.

Run Tasks Onload

When selected, the tasks in the task list run when the parameter is loaded.

Position/Stretch Attributes Tab

Position/Stretch Attributes apply to the following types of components:

Basic Canvases

Tab Groups

Image Canvases

Labels

Links to Device Editors or Other CustomPanels

Buttons

NDI Video Panels

Web Browser Instances

Attribute

Description

Position/Stretch Attributes

Anchor Points

Use the menu to specify the location and sizing of the component on the canvas should the panel be resized:

Position100042.bmp 

The component remains fixed to the selected location if the panel is resized.

For detailed information on Anchor Points, refer to refer to the section "Anchor Points and Background Alignment".

Top (pixels)

Type or select a number of pixels to offset the component from the top margins of the panel.

Left (pixels)

Type or select a number of pixels to offset the component from the left side margins of the panel.

Bottom (pixels)

Type or select a number of pixels to offset the component from the bottom margins of the panel.

Right (pixels)

Type or select a number of pixels to offset the component from the right side margins of the panel.

Width (pixels)

Enter or select a fixed width in pixels for the component. The component retains these dimensions if the panel is resized.

Select the Use default check box to use the default width for the component.

Height (pixels)

Enter or select a fixed height in pixels for the component. The component retains these dimensions if the panel is resized.

Select the Use default check box to use the default height for the component.

Simplegrid Attributes Tab

Simplegrid Attributes apply to the following types of components:

Simple Grids

Attribute

Description

General Attributes

Name

Type a name or description for the simplegrid component.

ID

Type a scripting ID for the simplegrid component.

Data Source/Device Control

openGear or XPression DataLinq

 

or

 

NK Series Routers

Select a device for context:

openGear or XPression DataLinq — this option opens the Select Device for Context dialog box, where you can select an openGear card or XPression DataLinq XML file to associate with the simplegrid.

NK Series Routers — this option opens the Select IPS dialog box, where you can select a router node.

Note: If both boxes are clear, the table uses the surrounding context.

Rows

If you want to specify the maximum number of rows in the simple grid, select Override Default and then specify the number of rows.

By default there is only one row. The grid is divided into as many columns as the number of components you insert.

Columns

If you want to specify the number of columns in the simple grid, select Override Default and then specify the number of columns.

Note: If the simple grid contains more components than there are cells to hold them, additional columns are created.

Lock Contents (widget root)

Select this check box to disable the selection of sub-elements in the canvas. This allows for easy selection, copy, and paste of a component.

Elements under the widget root can only be selected by selecting the item node in the tree. Users can not add to, or directly modify, the contents of a widget, move a widget, or resize a widget. This allows the block of code for the widget to be self-contained and able to be dragged and dropped elsewhere with ease.

Scrolling

Click the menu and select an option for adding scroll bars to the simplegrid component:

True — use vertical and/or horizontal scroll bars according to the size of the simplegrid component.

False — do not use scroll bars for the simplegrid component.

Vertical — add a vertical scroll bar to the simplegrid component.

Horizontal — add a horizontal scroll bar to the simplegrid component.

Always — always use vertical and horizontal scroll bars for the simplegrid component.

Source Tab

In the Edit Component window, the Source tab is present for every component. It shows the underlying XML source code that defines the selected component. You can edit the XML code directly in the Source tab, or paste XML code into it. To view or edit the XML source for the entire CustomPanel, select the top element in the component tree and then view its Source tab.

Tip: To quickly view the source for a component, press and hold the Shift key, and double-click. The View Source window appears. The XML source cannot be edited in this window.

Editor Feature

Description

Line Wrap

Select the check box to enable line wrapping, so all the code is visible without scrolling horizontally.

ogScript Code

When selected, the code display is optimized for editing ogScript.

When cleared, the code display is optimized for editing OGLML (XML).

Tip: Alternatively, you can edit ogScript in the manual ogScript editor or in the Visual Logic editor. For more information, see Working with ogScript.

Search

If you want to find a particular string within your code, type the string in the Search box, and click Find Next.

Tips:

To immediately find the same string again, press Enter.

To move the cursor into the Search box, press Ctrl+f.

Split Attributes Tab

Split Attributes apply to the following types of components:

Split Panels

Attribute

Description

General Attributes

Name

Type a name or description for the split panel component.

ID

Type a scripting ID for the split panel component.

Data Source/Device Control

openGear or XPression DataLinq

 

or

 

NK Series Routers

Select a device for context:

openGear or XPression DataLinq — this option opens the Select Device for Context dialog box, where you can select an openGear card or XPression DataLinq XML file to associate with the split panel.

NK Series Routers — this option opens the Select IPS dialog box, where you can select a router node.

Note: If both boxes are clear, the split panel uses the surrounding context.

XPression DashBoard Linq Port

If you want to stream XML data to an XPression system directly without sharing an XML file, specify the port to use on the DashBoard computer, and select Enable Streaming.

Note: You must also set up a DashBoard DataLinq source on the XPression DataLinq server. The DashBoard Linq must point to the IP address and port of the DashBoard computer that hosts the CustomPanel from which you want to stream data.

NK Series Routers

Select the check box to associate the component with NK Series routers for device control.

Lock Contents (widget root)

Select this check box to disable the selection of sub-elements in the canvas. This allows for easy selection, copy, and paste of a component.

Elements under the widget root can only be selected by selecting the item node in the tree. Users can not add to, or directly modify, the contents of a widget, move a widget, or resize a widget. This allows the block of code for the widget to be self-contained and able to be dragged and dropped elsewhere with ease.

Scrolling

Click the menu and select an option for adding scroll bars to the split panel:

True — use vertical and/or horizontal scroll bars according to the size of the split panel.

False — do not use scroll bars for the split panel.

Vertical — add a vertical scroll bar to the split panel.

Horizontal — add a horizontal scroll bar to the split panel.

Always — always use vertical and horizontal scroll bars for the split panel.

Statuscombo Attributes Tab

Statuscombo Attributes apply to devices in the component tree with status dot indicators. Statuscombo nodes appear in the component tree if your panel includes devices that include a status indicator.

Attribute

Description

General Attributes

Name

Type a name or description for the device.

ID

Type a scripting ID for the device.

Style Tab

In the Edit Component window, the Style tab is present for every component.

If you are setting the style for a checkbox button or toggle button, you can specify separate styles for each button state. The Style tab has a subtab for each state (Default, Toggle On, Toggle Off).

Attribute

Description

Background

Background (URL)

Type a URL or file path to an image to use as the background for the component, or click Browse and use the Open dialog box to locate a file.

Background Alignment

Use the menu to specify where to position the background of the component in relation to the component face:

Position100043.bmp 

The component remains fixed to the selected location if the panel is resized.

For detailed information on Anchor Points and Background Alignment, refer to the section "Anchor Points and Background Alignment".

Background Color

Click the dropdown and select a color for the background and modify the Hue, Saturation, Lightness, and Transparency of the selected color.

Use the library located at the bottom of the color dropdown to select a preset color from a color swatch.

Background Fill

Click the menu and select a fill mode for the background:

Crop — crop the image to fit the canvas.

None — remove the image from the canvas.

Horizontal — stretch the image horizontally on the canvas according to the Background Alignment menu. For example, if the Background Alignment is set to Center, the image will be stretched horizontally in the canvas and centered on the canvas.

Vertical — stretch the image vertically on the canvas according to the Background Alignment menu. For example, if the Background Alignment is set to Center, the image will be stretched vertically in the canvas and centered on the canvas.

Shrink — scale the image to fit the canvas area.

Fit — fit the image to the canvas.

Tile — repeat the image in a grid pattern on the canvas.

Both — resize the image to fit the canvas.

Paint9 — position the image according to nine-box layout within the canvas.

Background Insets

Type a number in pixels for the background inset.

Insets are groups of four numbers (in pixels): top, left, bottom, right. The Background Insets are used to define the corners of a 9-box background. A 9-box is when the corners of the box are a fixed size, the sides have a fixed width, the top and bottom have a fixed height, and the center grows.

For example, for the following image:

bckgndInsets.jpg 

top = red

left = green

bottom = yellow

right = blue

The image is 342 x 155 pixels. The left is 95 pixels and the top is 50 pixels.

Remove Background Image

 

Select the check box to remove the background image from the component.

Border

Border Color

Click the dropdown and select a color for the border and modify the Hue, Saturation, Lightness, and Transparency of the selected color.

Use the library located at the bottom of the color dropdown to select a preset color from a color swatch.

Border Style

Click the menu and select a style for the canvas border:

Shadow — use a dropdown shadow of the edges of the canvas as the border.

None — do not use a border.

Etched — use an engraved appearance as the border for the edges of the canvas.

The border style is mutually exclusive with color.

Font/Text Style

Font

Click the menu and select a font:

Mono — use a typewriter style font.

Default — use the default font. The default font is Arial Bold.

Bold — use a bold font.

Font Size

Click the menu and select a font size for the text ranging from Smallest to Biggest, or enter a font point size in the box.

The text will be truncated if it does not fit on the canvas area.

Foreground Color

Click the dropdown and select a color for the text and modify the Hue, Saturation, Lightness, and Transparency of the selected color.

Use the library located at the bottom of the color dropdown to select a preset color from a color swatch.

Text Alignment

Click the menu and select a position for the alignment of the text on the component canvas:

Posn10.bmp 

select the top option to position the text at the top of the component canvas.

select the left option to position the text to the left side of the component canvas.

select the center option to position the text in the center of the component canvas.

select the right option to position the text to the right side of the component canvas.

select the bottom option to position the text at the bottom of the component canvas.

Text Outline

Click the dropdown and select a color for the border of the text and modify the Hue, Saturation, Lightness, and Transparency of the selected color.

Use the library located at the bottom of the color dropdown to select a preset color from a color swatch.

Icons

Drag Icon (URL)

Type or select the URL of a web page or a file to open when the user drags this icon to the editor area or selects the node and clicks Open.

Dragging only applies if your control provides drag contents.

Select the check box to remove the drag icon.

Hover Icon (URL)

Type or select the URL of a web page or a file to open when the user hovers over this icon or selects the node and clicks Open.

The Hover Icon is only applicable to buttons.

Select the check box to remove the hover icon.

Icon (URL)

Type or select the URL of an image to use as the icon for the node in the DashBoard tree view.

Select the check box to remove the icon.

Other

Defined Style

Click the menu and select a predefined style for the component.

To create a style definition, select a container object in the Component Tree, and then click the <style/> button. Change settings on the Style Attributes tab to define the style, and then click Apply Changes.

Tip: A style preset is available only to objects within its parent container object. To create a set of style presets for the entire panel, create them immediately below the top level abs object.

Tip: Predefined style settings can be overridden individually for a given object.

Insets

Type an inset number in pixels for the defined style.

Insets are groups of four numbers (in pixels): top, left, bottom, right. The Insets are used to define the corners of a 9-box background. A 9-box is when the corners of the box are a fixed size, the sides have a fixed width, the top and bottom have a fixed height, and the center grows. They are used to define the margins around the text/icon of a button widget.

For example, for the following image:

bckgndInsets00046.jpg 

top = red

left = green

bottom = yellow

right = blue

The image is 342 x 155 pixels. The left is 95 pixels and the top is 50 pixels.

Tooltip

Type a tip or any relevant information to display when the cursor is hovered over the component.

Tab Attributes Tab

Tab Attributes apply to the following types of components:

Tab Groups

Attribute

Description

General Attributes

Name

Type a name or description for the tab component.

ID

Type a scripting ID for the tab component.

Lock Contents (widget root)

Select this check box to disable the selection of sub-elements in the canvas. This allows for easy selection, copy, and paste of a component.

Elements under the widget root can only be selected by selecting the item node in the tree. Users can not add to, or directly modify, the contents of a widget, move a widget, or resize a widget. This allows the block of code for the widget to be self-contained and able to be dragged and dropped elsewhere with ease.

Scrolling

Click the menu and select an option for adding scroll bars to the tab component:

True — use vertical and/or horizontal scroll bars according to the size of the tab component.

False — do not use scroll bars for the tab component.

Vertical — add a vertical scroll bar to the tab component.

Horizontal — add a horizontal scroll bar to the tab component.

Always — always use vertical and horizontal scroll bars for the tab component.

Data Source/Device Control

openGear or XPression DataLinq

 

or

 

NK Series Routers

Select a device for context:

openGear or XPression DataLinq — this option opens the Select Device for Context dialog box, where you can select an openGear card or XPression DataLinq XML file to associate with the tab.

NK Series Routers — this option opens the Select IPS dialog box, where you can select a router node.

Note: If both boxes are clear, the table uses the surrounding context.

XPression DashBoard Linq Port

If you want to stream XML data to an XPression system directly without sharing an XML file, specify the port to use on the DashBoard computer, and select Enable Streaming.

Note: You must also set up a DashBoard DataLinq source on the XPression DataLinq server. The DashBoard Linq must point to the IP address and port of the DashBoard computer that hosts the CustomPanel from which you want to stream data.

Advanced Tab Settings

Tab Placement

Click the menu and select a position for the placement of the tabs on the canvas.

The tabs are placed on top of each other without any visual tabs, allowing you to create links to each tab and flip between them.

Remote Task Triggering

Internal RossTalk GPI Listener

Specifies the TCP/IP port to monitor for RossTalk commands for this container object and its children.

RossTalk GPI commands are formatted as GPI [trigger]:[state].

This setting is available only if this container object has its context attribute set to opengear (contexttype=opengear).

VDCP Task Server Port

Specifies the TCP/IP port to use for publishing all of the current object’s tasks with trigger IDs as VDCP clips.

Tasks can be listed, cued, and played through devices capable of VDCP communication over TCP/IP.

This setting is available only if this container object has its context attribute set to opengear (contexttype=opengear).

HTTP Trigger Server Port

Tasks assigned to this object with trigger IDs are published to a web page hosted at the specified port (http://localhost:[port]/).

Tasks can be triggered by going to http://localhost:[port]/[trigger ID]/[State].

This setting is available only if this container object has its context attribute set to opengear (contexttype=opengear).

Table Attributes Tab

Table Attributes apply to the following types of components:

Tables

Attribute

Description

General Attributes

Name

Type a name or description for the table component.

ID

Type a scripting ID for the table component.

Data Source/Device Control

openGear or XPression DataLinq

 

or

 

NK Series Routers

Select a device for context:

openGear or XPression DataLinq — this option opens the Select Device for Context dialog box, where you can select an openGear card or XPression DataLinq XML file to associate with the table.

NK Series Routers — this option opens the Select IPS dialog box, where you can select a router node.

Note: If both boxes are clear, the table uses the surrounding context.

XPression DashBoard Linq Port

If you want to stream XML data to an XPression system directly without sharing an XML file, specify the port to use on the DashBoard computer, and select Enable Streaming.

Note: You must also set up a DashBoard DataLinq source on the XPression DataLinq server. The DashBoard Linq must point to the IP address and port of the DashBoard computer that hosts the CustomPanel from which you want to stream data.

Lock Contents (widget root)

Select this check box to disable the selection of sub-elements in the canvas. This allows for easy selection, copy, and paste of a component.

Elements under the widget root can only be selected by selecting the item node in the tree. Users can not add to, or directly modify, the contents of a widget, move a widget, or resize a widget. This allows the block of code for the widget to be self-contained and able to be dragged and dropped elsewhere with ease.

Scrolling

Click the menu and select an option for adding scroll bars to the table component:

True — use vertical and/or horizontal scroll bars according to the size of the table component.

False — do not use scroll bars for the table component.

Vertical — add a vertical scroll bar to the table component.

Horizontal — add a horizontal scroll bar to the table component.

Always — always use vertical and horizontal scroll bars for the table component.

Table Cell Attributes Tab

Table Cell Attributes apply to the following types of components:

Tables

Table cell attributes can also apply to buttons if a table of buttons is created:

Buttons

Attribute

Description

Table Cell Alignment

Alignment

If a table cell is not set to fill both and the control is smaller than the cell, this controls where the cell's control is anchored in the cell. Use the menu to specify where to position the table cell:

Position100049.bmp 

The table cell remains fixed to the selected location if the table is resized.

Fill

Click the menu and select a fill mode for the table cell:

None — remove the image from the table cell.

Horizontal — stretch the image horizontally in the table cell according to the Alignment menu. For example, if the Alignment is set to Center, the image will be stretched horizontally in the table cell and centered in the table cell.

Vertical — stretch the image vertically in the table cell according to the Alignment menu. For example, if the Alignment is set to Center, the image will be stretched vertically in the table cell and centered in the table cell.

Both — resize the image to fit the table cell.

Horizontal Weight (%)

Use the slide bar to determine the amount of horizontal space in the column for the table cell. The size of a cell is calculated by comparing the relative values of the cells across a column.

DashBoard will use the largest value in the column. If you want to reduce the column size, the weight of all cells in the column need to be shrunk.

Users might find it convenient to have the values across a column add to 100%.

Vertical Weight (%)

Use the slide bar to determine the amount of vertical space in the row for the table cell.The size of a cell is calculated by comparing the relative values of the cells across a row.

DashBoard will use the largest value in the row. If you want to reduce the row size, the weight of all cells in the row need to be shrunk.

Users might find it convenient to have the values across a row add to 100%.

Colspan

Type or select an amount of column cells for the cell to span.

Select the Default check box to use the default column span.

Rowspan

Type or select an amount of row cells for the cell to span.

Select the Default check box to use the default row span.

Width

Type or select an amount of pixels for the width of the cell.

Select the Default check box to use the default cell width. The default is 1.

Height

Type or select an amount of pixels for the height of the cell.

Select the Default check box to use the default cell height. The default is 1.

Insets

Type an inset number for the table cell

Insets are groups of four numbers: top, left, bottom, right. They are used to define the margins around the text/icon of a button widget.

Advanced Attributes

Orientation

If multiple elements are returned, the selected orientation determines if the elements are placed in rows (vertical) or columns (horizontal). Click the menu and select an orientation:

Horizontal — select to orientate the table cell horizontally. Use the Expected # Elements to configure the number of elements to span.

Vertical — select to orientate the table cell vertically. Use the Expected # Elements to configure the number of elements to span.

Expected # Elements

Enter an amount of elements to fill the table if multiple elements are returned. If a small number of elements, or none, are returned, this number of elements will create empty cells in order to maintain the table structure.

Tag Attributes Tab

Tag Attributes apply to the following types of components:

Basic Canvases

Tab Groups

Image Canvases

Split Panels

Tables

Labels

Links to Device Editors or Other CustomPanels

Buttons

Web Browser Instances

Attribute

Description

External Link

All Connections

Select the radio button to specify a device on the network for the link.

Use the menu to select a device from the Basic Tree View.

File Navigator

Select the radio button to specify a *.grid file for the link.

Use the menu to select a file from the File Navigator.

Local File

Select the radio button to specify a file from a local computer or a server for the link.

Click Browse to use the Open dialog box to select a file from a location on a local computer or sever.

Button Style

Select a method for displaying the link for the component:

Button — select to use a button component as the style for the link.

Label — select to use a label component as the style for the link.

General Attributes

Name

Type a name or description for the link.

ID

Type a scripting ID for the link.

Task Attributes Tab

Task Attributes apply to task components.

Attribute

Description

General Attributes

Name

Type a name or description for the task.

ID

Type a scripting ID for the task.

ogScript Content

Visual button

The Visual button changes the ogScript Content area to show the Visual Logic editor, which enables you to created and edit ogScript code segments visually.

For more information about the Visual Logic editor, see DashBoard Visual Logic.

ogScript button

The ogScript button changes the ogScript Content area to show the manual ogScript editor.

For more information about the manual ogScript editor, see Editing ogScript Code.

Timer Attributes Tab

The Timer Attributes apply to Timer widgets:

Timers

Attribute

Description

General Attributes

Name

Type a name or description for the timer.

ID

Type a scripting ID for the timer. The default is Timer ID.

Timer Properties

Timer ID

Type a name for the timer.

Display

Specify the time format for the timer:

Use the list to select the format.

Type the format and then press Enter.

To view descriptions of the time formatting symbols, click miniHelpIcon00050.jpg beside the Display list.

Time Source

Select a radio button to specify the type of timer to use:

Self — starts and stops manually, and is independent of any other timer.

Simple clock — matches the time clock of the local computer.

Time Until — counts down the amount of time remaining until a future date and time.

Other Timer — links this timer to another timer. Starting or stopping the linked timer also starts or stops this timer.

Start

Specify the timer value to begin counting from. Only Self timers use this value.

Stop

Specify the timer value to stop counting at. Only Self and Time Until timers use this value.

Repeat Rate

In the Every box, enter or select an amount of time to control how often the timer tasks are run.

Use the list next to the Every box to select a unit of time for the repeat rate.

For more information about the repeat rate, click miniHelpIcon00053.jpg beside the list used to select a unit of time.

Tasks

Tasks List

This list displays the tasks that have been added to a label. Tasks are commands or controls assigned to the component. Use the buttons to arrange the tasks:

First — click to move a selected task to the top of the Tasks List.

Move Up — click to move a selected task up one position in the Tasks List.

Move Down — click to move a selected task down one position in the Tasks List.

Last — click to move a selected task to the bottom of the Tasks List.

Add

Click the button to open the Add Task dialog box and create tasks for the timer. The tasks are added to the Tasks List.

Edit

Click the button to open the Edit Task dialog box and edit a selected task from the Tasks List.

Delete

Click the button to delete a selected task from the Tasks List.

Timertask Attributes Tab

Timertask Attributes apply to the following types of components:

Timers

Attribute

Description

General Attributes

Name

Type a name or description for the timer task.

ID

Type a scripting ID for the timer task.

ogScript Content

Visual button

The Visual button changes the ogScript Content area to show the Visual Logic editor, which enables you to created and edit ogScript code segments visually.

For more information about the Visual Logic editor, see DashBoard Visual Logic.

ogScript button

The ogScript button changes the ogScript Content area to show the manual ogScript editor.

For more information about the manual ogScript editor, see Editing ogScript Code.

Tr Attributes Tab

TableRow (Tr) Attributes apply to the following types of components:

Tables

Attribute

Description

General Attributes

Name

Type a name or description for the table row.

ID

Type a scripting ID for the table row.

TreeElement Attributes Tab

TreeElement Attributes apply to Statuscombo attributes.

Attribute

Description

General Attributes

Name

Type a name or description for the link.

ID

Type a scripting ID for the link.

Widget Attributes Tab

Widget Attributes apply to pre-built widgets added to a CustomPanel.

Attribute

Description

General Attributes

Name

Type the name of the widget.

ID

Type a scripting ID for the widget.

Other attributes

 The widget may feature any number of additional attributes you can set to affect the widget’s behavior.

Anchor Points and Background Alignment

Anchor Points and Background Alignment determine how an object moves if the user interface is resized for different monitor and window sizes. They are relative to the container in which they are located (for example, a tab, a split pane, etc.). In the Component Tree, they are at very least in the top level of the canvas.

Anchor Points or Background Alignment can be applied in three different ways:

Anchoring to a corner of the canvas

AnchCrnrs.bmp 

Select the top left, top right, bottom left, or bottom right quadrant from the Anchor Points/Background Alignment menu to anchor the component to a corner of the canvas represented by the selected corner quadrant in the menu. When the canvas is expanded or shrunk, the component will remain a fixed distance from the corner edges of the canvas according to the set pixel amounts for the selected quadrant in the menu:

top and left for the top-left quadrant

The component will be anchored to the top-left of the canvas and use a fixed width and height.

top and right for the top-right quadrant

The component will be anchored to the top-right of the canvas and use a fixed width and height.

left and bottom for the bottom-left quadrant

The component will be anchored to the bottom-left of the canvas and use a fixed width and height.

bottom and right for the bottom-right quadrant

The component will be anchored to the bottom-right of the canvas and use a fixed width and height.

For example, the basic canvas component in (Figure 1.26) is anchored to the top left corner of the canvas.

CrnerAnch.bmp 

Figure 1.26  - Component anchored to corner of panel

If the panel is resized, the basic canvas component remains in the same position from the top left edges of the panel and remains the same dimensions as the panel is expanded, as demonstrated in (Figure 1.27).

CrnerAnchrResze.bmp 

Figure 1.27  - Component anchored to corner while panel is expanded

Anchoring to an edge of the canvas

AnchrPtEdgs.bmp 

Select the top, right, bottom, or left quadrant from the Anchor Points/Background Alignment menu to anchor the component to an edge of the canvas represented by the selected edge quadrant in the menu. Depending on the selected quadrant, when the canvas is expanded or shrunk, the component will remain a fixed distance from the top, right, bottom, or left edges of the canvas according to the set pixel amounts, and will expand or shrink:

top, left, and right for the top quadrant

The component will be anchored to the top side of the canvas. Adjust the component horizontally with a fixed offset from the left and right edges of the canvas while using a fixed a height.

top, bottom, and right for the right quadrant

The component will be anchored to the right side of the canvas. Adjust the component vertically with a fixed offset from the top and bottom edges of the canvas while using a fixed a width.

left, bottom, and right for the bottom edge quadrant

The component will be anchored to the bottom side of the canvas. Adjust the component horizontally with a fixed offset from the left and right edges of the canvas while using a fixed a height.

top, left, and bottom for the bottom right quadrant

The component will be anchored to the left side of the canvas. Adjust the component vertically with a fixed offset from the top and bottom edges of the canvas while using a fixed a width.

For example, the basic canvas component in (Figure 1.28) is anchored to the edge of the canvas.

EdgeAnchr.bmp 

Figure 1.28  - Component anchored to edge of panel

If the panel is shrunk in size, the basic canvas component remains the same distance from the left and right edges of the panel while its size is shrunk horizontally but not vertically, as demonstrated in (Figure 1.29).

EdgeAnchrResze.bmp 

Figure 1.29  - Component anchored to edge while panel is expanded

Anchoring to the center of the canvas

AnchrPtCtr.bmp 

Select the center quadrant from the Anchor Points/Background Alignment menu to anchor the component to all four corners of the canvas. When the canvas is expanded or shrunk, the component will remain a fixed distance from the edges and corners of the canvas according to the set pixel amounts for the top, left, bottom, and right. If the canvas size is adjusted vertically or horizontally, the component height and width size will adjust accordingly while maintaining fixed offsets from the top, left, bottom, and right.

For example, the basic canvas component in (Figure 1.30) is anchored to the center of the canvas.

CtrAnchr.bmp 

Figure 1.30  - Component anchored to center of panel

If the panel is resized, the basic canvas component remains in the same position from all edges of the panel but shrinks horizontally and vertically as the panel is shrunk, as demonstrated in (Figure 1.31).

CtrAnchrResze.bmp 

Figure 1.31  - Component anchored to center while panel is expanded