Grid.SetProperties

Grid.SetProperties (

string ObjectName,

table Properties )

Description

Sets the properties of a grid object.

Parameters

ObjectName

(string) The name of the grid object.

Properties

(table) A table containing the grid object's properties indexed by the following keys:

KEY

TYPE

DESCRIPTION

Rows

number

The number of rows to set in the grid object.

Columns

number

The number of columns to set in the grid object.

FixedRows

number

The number of fixed rows to set in the grid object.

FixedColumns

number

The number of fixed columns to set in the grid object.

TextColor

number

The color value to use for the text. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

TextBackgroundColor

number

The color value to use for the background. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

FixedTextColor

number

The color value to use for fixed text. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

FixedBackgroundColor

number

The color value to use for the fixed background. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

GridLineColor

number

The color value to use for the grid's lines. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

GridBackgroundColor

number

The color value to use for the grid's background. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

TitleTipBackgroundColor

number

The color value to use for the grid tooltip's background. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

TitleTipTextColor

number

The color value to use for the grid tooltip's text. Use GRID_CLR_DEFAULT (4278190080) to set to the default color according to the user's Windows color scheme. You can use the Grid.MakeColorRGB action to create the color value.

Editable

boolean

True to set the grid as editable by the user, or false to not.

Selectable

boolean

True to allow the user to select grid cells with the mouse or keyboard, or false to not.

CellDragAndDrop

boolean

True to allow cells to be dragged and dropped by the user, or false to not.

ResizableRows

boolean

True to allow rows to be resized by the user, or false to not.

ResizableColumns

boolean

True to allow columns to be resized by the user, or false to not.

GridLines

number

A number that tells which grid lines to be displayed in the grid:

CONSTANT

VALUE

DESCRIPTION

GVL_NONE

0

None.

GVL_HORZ

1

Horizontal lines.

GVL_VERT

2

Vertical lines.

GVL_BOTH

3

Both.

FontName

string

The font name to set.

FontSize

number

The font size (in points) to set.

FontStrikeout

boolean

True to set font to strikeout, false to not.

FontUnderline

boolean

True to set font to underline, false to not.

FontAntiAlias

boolean

True to set font to anti-alias, false to not.

FontItalic

boolean

True to set font to italic, false to not.

FontWeight

number

The font weight to use (how 'dark' the text will appear):

CONSTANT

VALUE

DESCRIPTION

FW_DONTCARE

0

Font weight not specified.

FW_THIN

100

Font weight 'thin'.

FW_EXTRALIGHT

200

Font weight 'extra-light'.

FW_LIGHT

300

Font weight 'light'.

FW_NORMAL

400

Font weight 'normal'.

FW_MEDIUM

500

Font weight 'medium'.

FW_SEMIBOLD

600

Font weight 'semi-bold'.

FW_BOLD

700

Font weight 'bold'.

FW_EXTRABOLD

800

Font weight 'extra bold'.

FW_HEAVY

900

Font weight 'heavy'.

FontScript

number

The character set to use by the grid object:

CONSTANT

VALUE

DESCRIPTION

ANSI_CHARSET

0

ANSI character set.

BALTIC_CHARSET

186

Baltic character set.

CHINESEBIG5_CHARSET

136

Chinese character set.

DEFAULT_CHARSET

1

Default character set.

EASTEUROPE_CHARSET

238

Eastern European character set.

GB2312_CHARSET

134

GB2312 character set.

GREEK_CHARSET

161

Greek character set.

HANGUL_CHARSET

129

Hangul character set.

MAC_CHARSET

77

MAC character set.

OEM_CHARSET

255

OEM character set.

RUSSIAN_CHARSET

204

Russian character set.

SHIFTJIS_CHARSET

128

Shiftjis character set.

SYMBOL_CHARSET

2

Symbol character set.

TURKISH_CHARSET

162

Turkish character set.

Enabled

boolean

True to enable the grid object, false to disable it.

Visible

boolean

True to make the grid object visible, false to make it invisible..

X

number

The horizontal position (in pixels) to set the top left corner of the grid object in relation to the current page or dialog.

Note: The top left corner of the current page or dialog has an X value of 0

Y

number

The vertical position (in pixels) to set the top left corner of the grid object in relation to the current page or dialog.

Note: The top left corner of the current page or dialog has a Y value of 0

Width

number

The width (in pixels) to set for the grid object.

Height

number

The height (in pixels) to set for the grid object.

TooltipText

string

The mouseover tooltip to set for the grid object.

ResizeLeft

boolean

True if the left side of the object should move when the application is resized, false if it should not.

ResizeRight

boolean

True if the right side of the object should move when the application is resized, false if it should not.

ResizeTop

boolean

True if the top of the object should move when the application is resized, false if it should not.

ResizeBottom

boolean

True if the bottom of the object should move when the application is resized, false if it should not.

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

See also: Related Actions