SQL List Item Properties

Help Contents

Introduction

An SQL List displays the results of an SQL Command on a Graphic Page.

To add an SQL List to a graphic page do one of the following:

The SQL List Properties define how the SQL List appears on a Graphic Page.

When an SQL List is selected, its properties are shown in the Properties Window. To make changes, enter new values for the appropriate property.

Property List

An SQL List supports these properties:

Identification
Label An optional label to attach to the item.
Properties
Comment A place to store notes and information about the item. The comment property has no effect on how the item is displayed or behaves.
Tooltip The text to display in a tooltip. To enter multiple lines of text, Click the Browse button Browse button. A data binding configured in DataBindTooltip will override this property.
Visible The initial visibility in run mode. To dynamically display or hide the item use one of these:
Blink Attributes
Blink Whether the Embedded Plot blinks. A data binding configured in DataBindBlink will override this property.
BlinkSpeed Defines how fast the Embedded Plot blinks when blinking is enabled. The options are: Slow, Medium or Fast. Blinking is enabled using any of these options:
List
BorderColor The color of the border to draw around the SQL List.
BorderWidth The width of the border to draw around the SQL List.
LayoutMode How the list adjusts to different screen orientations:
  • Auto: The list automatically switches between single-line and multi-line mode.
  • Single-Line: Each record in the list is displayed in one line.
  • Multi-Line: Each record in the list is displayed using multiple lines.
List Row Numbers
ShowRowNumbers Whether row numbers are displayed.
RowNumberFontFamily The font family used to draw row numbers.
RowNumberFontSizeSingleLine The size of the row number text when each list row is displayed in one line (Single-Line).
RowNumberFontSizeMultiLine The size of the row number text when each list row is displayed in multiple lines (Multi-Line).
RowNumberColor The color of the row number text.
List Column Headers
ColumnHeaderFontFamily The font family used for column headers.
ColumnHeaderFontSizeSingleLine The size of the column header text when each list row is displayed in one line (Single-Line).
ColumnHeaderFontSizeMultiLine The size of the column header text when each list row is displayed in multiple lines (Multi-Line).
ColumnHeaderColor The color of the column header text.
ColumnHeaderPaddingSingleLine The padding around the column header text when each list row is displayed in one line (Single-Line).
ColumnHeaderPaddingMultiLine The padding around the column header text when each list row is displayed in multiple lines (Multi-Line).
List Data
DataFontFamily The font family used to draw list data.
DataFontSize The size of the data text.
DataPadding The padding around the data text.
SQL List
AutoUpdate Whether the SQL List Item automatically refreshes the SQL Command.

Note: Setting AutoUpdate to True can significantly increase the network bandwidth used by the Graphic Page.

SqlCommand The SQL Command to execute. The results of this command are displayed in the SQL List.
General Data Bindings
DataBindBlink A Data Binding that causes the item to blink. If DataBindBlink evaluates to TRUE, the item will blink.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindDisableActions A Data Binding to disable all actions on the item.
If DataBindDisableActions evaluates to TRUE, actions on the item are disabled.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindTooltip A Data Binding which sets the tooltip to display if a user hovers the cursor over the item. Note: Tooltips are not currently supported in the Android Operator Interface.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindVisible A Data Binding which hides the item.
If DataBindVisible is defined, and evaluates to FALSE, the item is hidden. Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Size Position Data Bindings
ClipRegionHorizontal When the DataBindClipHorizontal data binding is defined, this value sets whether the left or right side of the item is clipped.
ClipRegionVertical When the DataBindClipVertical data binding is defined, this value sets whether the top or bottom of the item is clipped.
DataBindClipHorizontal A Data Binding which sets how much of the item to clip horizontally. A value less than or equal to zero clips the entire item. A value greater than or equal to one does not clip the item. Values between zero and one clip the corresponding portion of the item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindClipVertical A Data Binding which sets how much of the item to clip vertically. A value less than or equal to zero clips the entire item. A value greater than or equal to one does not clip the item. Values between zero and one clip the corresponding portion of the item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindOffsetX A Data Binding which moves the item in the horizontal direction. The offset is in canvas units.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindOffsetY A Data Binding which moves the image in the vertical direction. The offset is in canvas units.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindScaleX A Data Binding which resizes the image in the horizontal direction. A value less than 1.0 shrinks the item horizontally. A value greater than 1.0 expands the item horizontally.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindScaleY A Data Binding which resizes the image in the vertical direction. A value less than 1.0 shrinks the item vertically. A value greater than 1.0 expands the item vertically.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Actions
ActionButtonDown An Operator Action script to run when the operator presses the left mouse button down, or touches the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionButtonShortcut A keyboard shortcut to emulate a button press on the item. Click the Browse button Property browse button to edit the shortcut using the Shortcut Editor.
ActionButtonUp An Operator Action script to run when the operator releases the left mouse button, or removes touch from the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionButtonWhileDown An Operator Action script to run at intervals while the operator holds the left mouse button down, or continuously touches the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionDoubleClick An Operator Action script to run when the operator double-clicks the left mouse button, or double taps the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionContextMenu An Operator Action script to run when the operator clicks the right mouse button, or does a long press on the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionListClickRow An Operator Action script to run when the operator clicks a selected row.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
WhileDownInterval The interval between each execution of the ActionButtonWhileDown script.

Further Information

Add Plot Tool

To learn about the Add Plot Tool.

Data Bindings

For a complete description of all data binding options.

Graphic Editor Toolbar

For the different tools available to edit graphic pages.

Graphic Editor

For information about editing graphic pages in Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.