Cell Properties

<< Click to Display Table of Contents >>

Manual > Control Reference > Basics > Grid control >

Cell Properties


common

Cell Property Name

Type

Defaults

explanation

Style

character

""

Specifies the cell style name. The style name will be the 0th index of the style definition array specified by "AddStyle".

CellType

character

""

Specifies the cell type of the cell.

Cell Type

Type designator character

explanation

Label Type

label

Used to display characters.

Edit box type

edit

Used when the user provides input.

Combo Box Type

combo

Used when the user provides input, allowing selection from a list.

Meter Type

meter

Displays the numerical value as a bar meter.

Lamp type

lamp

ON/OFF is displayed by a lamp.

Switch Type

switch

Used when the user sets ON/OFF.

Button type

button

Used to make a cell into a button.

Side button type

sidebutton

Used to place the button on the right edge of the cell.

Image type

image

Used to display image files.

Header Button Type

headerbutton

Used when you want to make a header cell into a sort button, unsort button, etc.

Header Filter Types

headerfilter

Used to make the header cell an edit box for entering a search string for the field filter.

 

FillColor

Colored letters

"@FillColor"

Cell background color.

BlinkFillColor

Colored letters

"@AlarmBlinkColor"

The background color of the cell when it blinks.

Valid when BlinkFill is TRUE.

BlinkFill

Boolean

FALSE

Cell blinking.

TRUE - Blink FALSE - Don't blink

PaddingX

Number

0

The region's x-padding.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

PaddingY

Number

0

The y padding of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

EnablePaste

Boolean

TRUE

When the cell type is an edit box or side button type, it is possible to change the text when pasting.

TRUE - Allows changes by pasting. FALSE - Cannot be changed by pasting.

 

 


Label type (cell type: label)

Cell Property Name

Type

Defaults

explanation

TextColor

Colored letters

"@TextColor"

Text color.

TextAlignX

character

"CENTER"

Horizontal alignment of text.

LEFT

Left justified

CENTER

Centered display

RIGHT

Right justified

 

TextAlignY

character

"CENTER"

Vertical alignment of text.

TOP

Top alignment

CENTER

Centered display

BOTTOM

Bottom alignment

 

 

 


Edit box type (cell type: edit)

Cell Property Name

Type

Defaults

explanation

TextColor

Colored letters

"@TextColor"

Text color.

TextAlignX

character

"CENTER"

Horizontal alignment of text.

LEFT

Left justified

CENTER

Centered display

RIGHT

Right justified

 

TextAlignY

character

"CENTER"

Vertical alignment of text.

TOP

Top alignment

CENTER

Centered display

BOTTOM

Bottom alignment

 

TextType

character

"TEXT"

It is a text type. For details, please refer to Edit box control.

TextFormat

character

""

This is a text format. For details, see Edit box control.

 

 


Combo box type (cell type: combo)

Cell Property Name

Type

Defaults

explanation

TextColor

Colored letters

"@TextColor"

Text color.

TextAlignX

character

"CENTER"

Horizontal alignment of text.

LEFT

Left justified

CENTER

Centered display

RIGHT

Right justified

 

TextAlignY

character

"CENTER"

Vertical alignment of text.

TOP

Top alignment

CENTER

Centered display

BOTTOM

Bottom alignment

 

TextType

character

"TEXT"

It is a text type. For details, please refer to Edit box control.

TextFormat

character

""

This is a text format. For details, see Edit box control.

ComboType

character

"DROPDOWN"

The type of combo box.

DROPDOWN

You can enter text instead of selecting from a list.

DROPDOWNLIST

You cannot enter text, you can only select from the list.

 

TextList

character

""

The text to display when the dropdown is selected. To display multiple texts, enter line breaks.

VisibleRows

Number

5

The number of lines of text that will be displayed when dropped down, and if necessary a scrollbar will be enabled.

SelectedIndex

Number

-1

The index of the currently selected row. Valid after TextList is set. If the cell contains text that is not in the list, SelectedIndex will be -1. Setting SelectedIndex to -1 will set the cell to empty text.

ItemSizeX

Number

0

The width of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ItemSizeY

Number

0

The height of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

 

 


Meter type (cell type: meter)

Cell Property Name

Type

Defaults

explanation

ShowText

Boolean

FALSE

Displaying text.

TRUE - Display. FALSE - Do not display.

TextColor

Colored letters

"@TextColor"

Text color.

BorderColor

Colored letters

"@BorderColor"

The color of the meter border.

MeterForeColor

Colored letters

"@SelectColor"

The color of the part that changes depending on the meter value.

MeterBackColor

Colored letters

"@FormColor"

The background color of the meter.

DataType

character

"number"

Data type.

number

Number

powerfactor00r

Power factor data (-0 to 1 to +0)

powerfactor05r

Power factor data (-0.5 to 1 to +0.5)

powerfactor00rp

Power factor data (-0 to 100 to +0) (% conversion)

powerfactor05rp

Power factor data (-50 to 100 to +50) (% conversion)

 

Center

Boolean

FALSE

Whether to display the current value based on the center line.

CenterValue

Boolean

FALSE

Whether to draw the center line. Only effective when Center is TRUE.

CenterLine

Number

0

Value indicating the center line. Only valid when Center is TRUE.

CenterLineColor

Colored letters

"@BorderColor"

The color of the center line. Only effective when Center is TRUE.

Max

Number

100

The maximum value of the meter.

Min

Number

0

The minimum value of the meter.

ItemSizeX

Number

0

The width of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ItemSizeY

Number

0

The height of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

 

 


Lamp type (cell type: lamp)

Cell Property Name

Type

Defaults

explanation

Shape

character

"SQUARE"

Lamp shape.

SQUARE

square

RECTANGLE

Rectangle

CIRCLE

circle

FILL

fill

 

BorderColor

Colored letters

"@BorderColor"

The color of the lamp border.

OnColor

Colored letters

"@SelectColor"

Color when on.

OffColor

Colored letters

"@FillColor"

Color when Off.

Margin

Number

0.3

(Old property for backward compatibility)

Padding in the X and Y directions of the area (0 to 1). It is recommended to use PaddinX/PaddinY/ItemSizeX/ItemSizeY to adjust the size.

For upward compatibility, when PaddinX/PaddinY/ItemSizeX/ItemSizeY are all 0, Margin is used.

MarkColor

Colored letters

"@TextColor"

Mark color.

MarkStyle

character

"NONE"

Mark type.

NONE

Do not display

TICK

check

CROSS

cross

DOT

dot

 

ItemSizeX

Number

0

The width of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ItemSizeY

Number

0

The height of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

 

 


Switch type (cell type: switch)

Cell Property Name

Type

Defaults

explanation

Shape

character

"SQUARE"

Lamp shape.

SQUARE

square

RECTANGLE

Rectangle

CIRCLE

circle

FILL

fill

 

BorderColor

Colored letters

"@BorderColor"

The color of the lamp border.

OnColor

Colored letters

"@SelectColor"

Color when on.

OffColor

Colored letters

"@FillColor"

Color when Off.

Margin

Number

0.3

(Old property for backward compatibility)

Padding in the X and Y directions of the area (0 to 1). It is recommended to use PaddinX/PaddinY/ItemSizeX/ItemSizeY to adjust the size.

For upward compatibility, when PaddinX/PaddinY/ItemSizeX/ItemSizeY are all 0, Margin is used.

MarkColor

Colored letters

"@TextColor"

Mark color.

MarkStyle

character

"TICK"

Mark type.

NONE

Do not display

TICK

check

CROSS

cross

DOT

dot

 

ItemSizeX

Number

0

The width of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ItemSizeY

Number

0

The height of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

 

 


Button type (cell type: button)

Cell Property Name

Type

Defaults

explanation

Enabled

Boolean

TRUE

Switch between enabled and disabled.

When it is FALSE, it will be in the disabled state. When it is disabled, the button cannot be pressed.

TextColor

Colored letters

"@TextColor"

Text color.

ButtonFill

Boolean

TRUE

Whether the button should be filled.

ButtonFillColor

Colored letters

"@GridButtonColor"

Button color.

ButtonBorderStyle

character

"@BorderStyleX"

Border style.

FLAT

flat

3D_FRAME

3D

3D_RAISE1

3D (convex)

3D_RAISE2

3D (high convex)

@BorderStyleX

Thematic Settings

 

ItemSizeX

Number

0

The width of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ItemSizeY

Number

0

The height of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ButtonBorder

Boolean

TRUE

Whether to show the border.

ButtonBorderColor

Colored letters

"@BorderColor"

Border color. Only effective when BorderStyle is set to FLAT.

ButtonBorderLine

character

"SOLID"

Border style. Only effective when BorderWidth is 1.

ButtonBorderWidth

Number

1

Border thickness. Effective only when BorderStyle is FLAT or 3D_FRAME.

ButtonBorderRound

Number

0

The radius of the rounded corners of the rectangle.

 

 


Side button type (cell type: sidebutton)

Cell Property Name

Type

Defaults

explanation

Enabled

Boolean

TRUE

When disabled, the button cannot be pressed.

Editabled

Boolean

FALSE

Whether the text can be edited.

TextColor

Colored letters

"@TextColor"

Text color.

TextAlignX

character

"CENTER"

Horizontal alignment of text.

LEFT

Left justified

CENTER

Centered display

RIGHT

Right justified

 

TextAlignY

character

"CENTER"

Vertical alignment of text.

TOP

Top alignment

CENTER

Centered display

BOTTOM

Bottom alignment

 

TextType

character

"TEXT"

It is a text type. For details, please refer to Edit box control.

TextFormat

character

""

This is a text format. For details, see Edit box control.

ShowButton

Boolean

TRUE

Whether to show the button.

ButtonFill

Boolean

TRUE

Whether the button should be filled.

ButtonText

character

""

The text to display on the button.

ButtonWidth

Number

20

Side button width.

ButtonFillColor

Colored letters

"@GridButtonColor"

Button color.

ButtonBorderStyle

character

'"@BorderStyleX"

Border style.

FLAT

flat

3D_FRAME

3D

3D_RAISE1

3D (convex)

3D_RAISE2

3D (high convex)

@BorderStyleX

Thematic Settings

 

ButtonText

character

"..."

The text to display on the button.

ButtonTextColor

Colored letters

"@TextColor"

The color of the text displayed on the button.

ButtonWidth

Number

20

The width of the button in pixels.

ItemSizeX

Number

0

The width of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ItemSizeY

Number

0

The height of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ButtonBorder

Boolean

TRUE

Whether to show the border.

ButtonBorderColor

Colored letters

"@BorderColor"

Border color. Only effective when BorderStyle is set to FLAT.

ButtonBorderLine

character

"SOLID"

Border style. Only effective when BorderWidth is 1.

ButtonBorderWidth

Number

1

Border thickness. Effective only when BorderStyle is FLAT or 3D_FRAME.

ButtonBorderRound

Number

0

The radius of the rounded corners of the rectangle.

File

character

""

The path to the image file name to display as the button.

ImageSizeX

Number

0

Image display width

0: Maximum size

1 or more: Specify the size in pixels

ImageSizeY

Number

0

Image display height

0: Maximum size

1 or more: Specify the size in pixels

 

 


Image type (cell type: image)

Cell Property Name

Type

Defaults

explanation

Enabled

Boolean

TRUE

When disabled, the button cannot be pressed.

File

character

""

The path to the image filename to display.

ItemSizeX

Number

0

The width of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

ItemSizeY

Number

0

The height of the region.

0: Not specified

Greater than 0 and less than 1: Specify as a percentage

1 or more: Specify in pixels

 
ImageSizeX

Number

0

The width of the image display.

0: Maximum size

1 or more: Specify the size in pixels

ImageSizeY

Number

0

The height of the image display.

0: Maximum size

1 or more: Specify the size in pixels

ImageAlignX

character

"CENTER"

Horizontal position of the image.

LEFT

Left justified

CENTER

Centered display

RIGHT

Right justified

 

ImageColor

Colored letters

""

Set this when you want to change the color of the image. If no color is specified, the color in the image file will be used as is.

PushType

character

"NONE"

Mouse press effect.

NONE

Do nothing

MOUSE

Perform button press effect when mouse is pressed

 

ImageMarginX1

Number

2

Margin between image and border when ImageAlignX is LEFT or RIGHT.

ImageMarginX2

Number

2

Margin between image and text when ImageAlignX is set to LEFT or RIGHT.

ButtonFill

Boolean

FALSE

Whether the button should be filled.

ButtonFillColor

Colored letters

"@GridButtonColor"

Button fill color.

ButtonBorder

Boolean

FALSE

Whether to show the border.

ButtonBorderStyle

character

"@BorderStyleX"

Button border style.

ButtonBorderColor

Colored letters

"@BorderColor"

Border color. Only effective when BorderStyle is set to FLAT.

ButtonBorderLine

character

"SOLID"

Border style. Only effective when BorderWidth is 1.

ButtonBorderWidth

Number

1

Border thickness. Effective only when BorderStyle is FLAT or 3D_FRAME.

ButtonBorderRound

Number

0

The radius of the rounded corners of the rectangle.

TextColor

Colored letters

"@TextColor"

Text color.

ImageTextPos

character

"NONE"

Text display position.

NONE

Do not display

LEFT

Display on the left

RIGHT

Display on the right

 

 

 


Header button type (cell type: headerbutton)

Cell Property Name

Type

Defaults

explanation

TextColor

Colored letters

"@TextColor"

Text color.

TextAlignX

character

"CENTER"

Horizontal alignment of text.

LEFT

Left justified

CENTER

Centered display

RIGHT

Right justified

 

TextAlignY

character

"CENTER"

Vertical alignment of text.

TOP

Top alignment

CENTER

Centered display

BOTTOM

Bottom alignment

 

PushType

character

"NONE"

Mouse press effect.

NONE

Do nothing

MOUSE

Perform button press effect when mouse is pressed

 

MarkColor

Colored letters

"@BorderColor"

Mark color.

MarkSize

Number

8

The size of the mark.

MarkType

character

"NONE"

Mark type.

NONE

Do not display

CLEARSEARCHFILTER

Clear search filter

CLEARFIELDFILTER

Clear field filters

CLEARSORTFILTER

Clear sort filter

SORT2STATE

2-state (ascending, descending) sorting

SORT3STATE

3-state sorting (ascending, descending, unsorted)

 

ActionType

character

"NONE"

The action to be performed when the button is pressed.

NONE

Do nothing

SORT2STATE

Sorting in two states

SORT3STATE

Sorting in 3 states

CLEARSEARCHFILTER

Cancel the search filter

CLEARFIELDFILTER

Clear the field filter

CLEARSORTFILTER

Clear the sort filter

 

 

 


Header filter type (cell type: headerfilter)

Cell Property Name

Type

Defaults

explanation

TextColor

Colored letters

"@TextColor"

Text color.

TextAlignX

character

"LEFT"

Horizontal alignment of text.

LEFT

Left justified

CENTER

Centered display

RIGHT

Right justified

 

TextAlignY

character

"CENTER"

Vertical alignment of text.

TOP

Top alignment

CENTER

Centered display

BOTTOM

Bottom alignment

 

ButtonTextColor

Colored letters

"@BorderColor"

Search mark color.