Custom properties for the SQLDataGrid graphic

Authentication

Designates whether database user authentication is SQL Server or Windows.

Writable at Run Time: Yes

Default: Windows

AutoRefresh

Automatically refreshes data appearing in the SQLDataGrid. When True, the query that repopulates the SQLDataGrid runs after the AutoRefreshDuration time elapses.

Writable at Run Time: Yes

Default: False

AutoRefreshDuration

Designates the requested time interval in seconds for AutoRefresh.
The actual refresh rate can be slower than the specified rate.

Writable at Run Time: Yes

Default: 60

ButtonPanelHide

Hides grid buttons when the value is True.

Writable at Run Time: Yes

Default: False

CmdCancel

Cancels the last database query.

Writable at Run Time: Yes

Default: False

CmdClear

Clears the contents of the SQLDataGrid.

Writable at Run Time: Yes

Default: False

CmdCopy

When True, copies the current selection to the clipboard.

Writable at Run Time: Yes

Default: False

CmdLogDiagnostics

Writes the current DCM diagnostic values to the logger.

Writable at Run Time: Yes

Default: False

CmdPageFirst

Moves the SQLDataGrid display to the first row.

Writable at Run Time: Yes

Default: False

CmdPageLast

Moves the SQLDataGrid display to the last row.

Writable at Run Time: Yes

Default: False

CmdPageNext

Moves the SQLDataGrid display down one page.

Writable at Run Time: Yes

Default: False

CmdPagePrev

Moves the SQLDataGrid display up one page.

Writable at Run Time: Yes

Default: False

CmdPaste

When True, pastes the current text contained on the clipboard to the grid.

Writable at Run Time: Yes

Default: False

CmdRefresh

Refreshes the current SQL query data. Any pending changes are discarded.

Writable at Run Time: Yes

Default: False

CmdResetDiagnostics

Resets the current DCM diagnostic values and clears the message and event counters.

Writable at Run Time: Yes

Default: False

CmdRetrieve

Loads the selected table, view, or query to the SQLDataGrid. Any changes to a previous dataset are discarded.

Writable at Run Time: Yes

Default: False

CmdTestConnection

Tests the database connection for the specified server, database, security type; and if applicable, user name and password.

The result is placed in the Error panel.

Writable at Run Time: Yes

Default: False

CmdWrite

Submits changes made in the SQLDataGrid to the database.

Writable at Run Time: Yes

Default: False

ColumnAggregateEnable

Specifies whether the column aggregate feature is exposed by default.

Writable at Run Time: Yes

Default: True.

ColumnFiltering

Enables column filtering and provides a row with the progressive filtering entry field.

Writable at Run Time: Yes

Default: False

ColumnGroupingEnable

Specifies whether the column grouping feature of the SQLDataGrid is exposed by default.

Writable at Run Time: Yes

Default: False

ComboBoxListReadOnly

If False, you can make changes to the edit box above the combo list box.

Writable at Run Time: Yes

Default: False

ComboBoxListString

Enables a list of table or view names, separated by semicolons to be viewable in the Runtime combo box.

Writable at Run Time: Yes

Default: Blank

ComboBoxPanelHide

Hides the combo box and panel.

Writable at Run Time: Yes

Default: False

CommandTimeout

The number of seconds that the SQLDataGrid waits for a pending command to run before timing out.

Writable at Run Time: Yes

Default: 30

ConfiguredDatabase

The name of the database that connects to the SQLDataGrid.

Writable at Run Time: Yes

Default: Blank

ConfiguredDomain

The domain to use with impersonation if the authentication mode is Windows.

Writable at Run Time: Yes

Default: Blank

ConfiguredPassword

SQL Server domain if the security type is Windows.

Writable at Run Time: Yes

Default: ********

ConfiguredReadOnly

Prevents the SQLDataGrid from making changes to the database.

Writable at Run Time: Yes

Default: True

ConfiguredServer

The name of the computer hosting the database.

Writable at Run Time: Yes

Default: Blank

ConfiguredUser

The SQL Server user name if security type is SQL. This property is optional when security type is Windows.

Writable at Run Time: Yes

Default: Blank

ConnectionTimeout

The number of seconds that the SQLDataGrid tries to connect to a database before timing out.

Writable at Run Time: Yes

Default: 15

ContextMenuEnable

When True and you right-click the grid, the context menu appears.

When False and you right-click the grid, the context menu does not appear.

Writable at Run Time: Yes

Default: True

ErrorPanelDisable

Disables the error message display.

Writable at Run Time: Yes

Default: False

ErrorPanelShow

When True, the error panel is visible.

When False, the error panel is hidden.

Writable at Run Time: Yes

Default: False

FeatureButtonsHide

Hides the Aggregate and Group-by buttons.

Writable at Run Time: Yes

Default: False

FontBold

Specifies whether to display the SQLDataGrid font in bold text.

Writable at Run Time: Yes

Default: False

FontName

Specifies the name of the font.

Writable at Run Time: Yes

Default: Arial

FontSize

Specifies the point size of the font.

Writable at Run Time: Yes

Default: 9.0

InstanceName

A name that you choose to identify a specific SQLDataGrid instance. The name appears in the ConnectionName diagnostic.

Writable at Run Time: Yes

Default: Blank

MaxConnections

The number of active connections allowed in the connection pool for a given connection string.

Writable at Run Time: Yes

Default: 100

RowCount

The row count returned in the last successful data request.

Writable at Run Time: No

Default: 0

RowLimit

Modifies the query to return a specified number of records.

To prevent the database query from being modified, set the SQLQueryPassThrough custom property to True.

Writable at Run Time: Yes

Default: 20,000

RowsChanged

If True, one or more rows have been changed in the grid (added, odified, or deleted).

If False, no rows were changed in the grid.

Writable at Run Time: No

Default: False

SelectedRowNumber

The number of the selected grid row.

Writable at Run Time: Yes

Default: 0

SQLQuery

Specifies the SQL query, table, or view data to be retrieved to the SQLDataGrid.

If SQLQueryPassThrough is True, you must add the SELECT statement along with the table or view name. For example, SELECT * FROM person.contact, rather than person.contact.

Writable at Run Time: Yes

Default: Blank

SQLQueryCurrent

Specifies the SQL command that was run to show the current data in the SQLDataGrid.

Writable at Run Time: No

Default: Blank

SQLQueryPassThrough

If True, enables the SQL statement specified in the SQLQuery custom property to be passed directly to the database without modification.

When this property is True and the SQLQuery custom property is set only to a table name or view, the grid does not insert "SELECT * FROM" in front of the table or view name.

Additionally, if this property is True, the top "n" is not inserted into a SELECT statement (where "n" is the value of the RowLimit custom property).

Writable at Run Time: Yes

Default: False

SQLQueryPending

Indicates a pending query.

Writable at Run Time: No

Default: False

StatusDesc

Specifies the error description from the last query. If no error exists, the string is empty.

Writable at Run Time: No

Default: Blank

StatusError

Specifies the error number from the last request.

Writable at Run Time: No

Default: 0

StatusIsError

Indicates whether an error occurred in the last query.

True = Error
False = no error

Writable at Run Time: No

Default: False

SupportThemes

Specifies the SQLDataGrid window is formatted with Windows XP or Vista visual themes. You should always set the value of this custom property to True. This custom property is not yet supported.

Writable at Run Time: No

Default: True

SuppressAuthenticationWarning

If user specifies any values in the ConfiguredUser and ConfiguredPassword properties, then a warning textbox is displayed in runtime. The warning informs the user of the possible security issue of storing the database user credentials locally. If True, hides the textbox regardless of configuration.

Writable at Run Time: No

Default: True

WriteButtonHide

Hides the Write button used to send changes to the database.

Writable at Run Time: Yes

Default: False