Generic Grid Control – Properties

The following table lists and describes properties of the Generic Grid Control as they are exposed on the Property Sheet and/or in the tool's script editor. Many of these properties are also exposed on a tool's (OCXProperties) property sheets. A property's name sometimes varies depending on where it appears.

Browse by letter:     [A]     [B]     [C]     [D]     [E]     [F]     [G]     [H]     [L]     [M]     [O]     [R]     [S]     [T]     [V]     [W]

Property Sheet Script Editor X Method Description

AllowManualColumnSorting

AllowManualColumnSorting

Yes

AllowManualColumnSorting enables sorting of grid by clicking on column headers. Script subtype is Boolean.

AlternateRowColors

AlternateRowColors

Yes

AlternateRowColors determines if the rows should alternate colors. Script subtype is Boolean.

Bottom

N/A

No

Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects.

N/A

ColumnCount

No

ColumnCount specifies the number of columns currently in the grid. Script subtype is Integer. This property is read-only.

N/A

ColumnsAutoSizing

No

ColumnsAutoSizing determines how or if the column width is adjusted automatically. Script subtype is Enumerable. Options are:

  • 0 – None (columns are not auto-sized)
  • 1 – FillGrid (columns are sized to fit the size of the grid, relative to the initial sizes of the columns)
  • 2 – SizeToData (columns are adjusted to fit the size of the strings in the cells)

ContextMenuXml

ContextMenuXml

Yes

ContextMenuXml identifies an XML string that defines the contents and Event IDs for the object’s custom context menu. See Custom Context Menus for more information about configuring custom menus for ActiveX Controls.

ActiveX Control Example

The following example includes one new menu item (New Item).

Copy

ContextMenuXML for Event Summary Control

<CustomContextMenu>
    <items>
        <ContextMenuDef>
            <itemsHidden/>
            <items>
                    <MenuItem Disable1="false" Disable2="false" Disable3="false" Description="New Context Menu Item (at bottom)" EventID="NEWID"/>
            </items>
        </ContextMenuDef>
    </items>
</CustomContextMenu>

CAS View Control Example

The CAS View Control includes additional options to hide default menu items. The following example includes one new menu item (New Item) and one hidden item (Suppress…). See CAS View Control.

Copy
ContextMenuXML for CAS View Control
<CustomContextMenu>
    <items>
        <ContextMenuDef>
            <itemsHidden>
                <DefaultMenuItem MenuId="1021" Desc="Suppress..." Type="0"/>
            </itemsHidden>
            <items>
                <MenuItem Disable1="true" Disable2="false" Disable3="false" Description="New Item" EventID="NEWID"/>
            </items>
        </ContextMenuDef>
    </items>
</CustomContextMenu>

Script subtype is String.

CursorPointer

N/A

No

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

  • 1 — Arrow
  • 2 — IBeam
  • 3 — Cross
  • 4 — UpArrow
  • 5 — NoDrop
  • 6 — Help
  • 99 — HotSpot
  • 100 — Timer

Script subtype is long.

DisplayFormatOrientation

DisplayFormatOrientation

Yes

DisplayFormatOrientation determines how the Display Format setting should be applied. Script subtype is Enumerable.

Options are:

  • 0 – ByRow (setting should apply for an entire row)
  • 1 – ByColumn (should apply for an entire column)

Enable

N/A

No

Enable specifies whether the user is able to interact with the object. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If set to 0 — No, the object is still visible but its context menu is disabled.

Other options:

  • Completely hide the object in run mode using the Visible property.
  • Display the object but hide its [DisplayItem] using the [DisplayElement] property.

EnableDynamicGrouping

EnableDynamicGrouping

Yes

EnableDynamicGrouping enables grouping bar to drag columns for group. Script subtype is Boolean.

EnableFilterBar

EnableFilterBar

Yes

EnableFilterBar enables filter row based on cell value at the top of a grid. Script subtype is Boolean.

FlexHorizontal

N/A

No

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

  • 0 — None (no resizing occurs)
  • 1 — Shift (the object is shifted)
  • 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
  • 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

FlexVertical

N/A

No

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

  • 0 — None (no resizing occurs)
  • 1 — Shift (the object is shifted)
  • 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
  • 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

Group

N/A

No

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 — No and 1 — Yes. The default is 0 — No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group.

5. Set Group set to 0 — No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

See also Tabstop.

HelpContextID

N/A

No

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

Layer

N/A

No

Layer identifies the layer on which the object resides. Script subtype is Boolean.

Left

N/A>

No

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object. See Sizing and Positioning Objects.

MultiSelect

MultiSelect

Yes

MultiSelect allows multiple cells or rows to be selected. Script subtype is Boolean.

(ObjectCode)

N/A

No

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

(OCXProperties)

N/A

No

Displays the OCXProperty dialog box unique to the object.

Right

N/A

No

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. See Sizing and Positioning Objects.

N/A

RowCount

No

RowCount specifies the number of rows currently in the grid. Script subtype is Integer. This property is read-only.

N/A

SelectedColumn

Yes

SelectedColumn returns the selected column index. Script subtype is Integer.

N/A

SelectedRow

Yes

SelectedRow returns the selected row index. Script subtype is Integer.

Tabstop

N/A

No

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is long.

See also Group and Tab Order.

Note: To set the tab order, use the Objects option on the Layout menu.

Tag

N/A

No

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

Top

N/A

No

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the top of the object. See Sizing and Positioning Objects.

Visible

N/A

No

Visible secifies whether the object is visible in Run mode. Options are 0 — No or 1 — Yes. Default is 1 — Yes.

Note: Objects are always visible in Edit mode, regardless of how this property value is set.

You can also:

WholeRowSelection

WholeRowSelection

Yes

WholeRowSelection enables seletion of entire row on click. Script subtype is Boolean.

Back to top