Dgs-dxgridlist

DGS Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxgridlist that you could use.

Main Functions

• dgsSetProperty
• dgsGetProperty

Properties

autoSort

This property determines whether auto sort is enabled. See dgsGridListSetAutoSortEnabled/dgsGridListGetAutoSortEnabled

dgsSetProperty(gridlist,"autoSort",autoSort)

• autoSort: A bool of auto sort state.

backgroundOffset

This property determines the offset between the left border and row background.

dgsSetProperty(gridlist,"backgroundOffset",backgroundOffset)

• backgroundOffset: An integer of the offset between the left border and row background.

bgColor

This property determines the background color of the grid list.

dgsSetProperty(gridlist,"bgColor",bgColor)

• bgColor: An integer of the color that can be converted by tocolor.

bgImage

This property determines the background image of the grid list. To adjust the color of the image, use property bgColor

dgsSetProperty(gridlist,"bgImage",bgImage)

• bgImage: A material element that serves as the background image of the grid list (texture/shader/screen source/renderTarget).

clip

Whether the clip property is enabled or not. Learn More dxDrawText

dgsSetProperty(gridlist,"clip",clip)

• clip: If set to true, the parts of the text that don't fit within the bounding box will be cut off.

columnColor

This property determines the background color of the column of the grid list.

dgsSetProperty(gridlist,"columnColor",columnColor)

• columnColor: An integer of the color that can be converted by tocolor.

columnData

This property stores column data.

dgsSetProperty(gridlist,"columnData",columnData)

• columnData: A table stores all column data.

Data Structure

{
	{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
	{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
	{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
	...
}

columnHeight

This property determines the column height of the grid list.

dgsSetProperty(gridlist,"columnHeight",columnHeight)

• columnHeight: An integer of column height of the grid list.

columnImage

This property determines the background image of the column of the grid list.

dgsSetProperty(gridlist,"columnImage",columnImage)

• columnImage: A material element that serves as the background image of the column of the grid list (texture/shader/screen source/renderTarget).

columnMoveOffset

This property stores the move offset of column that is used to render.

dgsSetProperty(gridlist,"columnMoveOffset",columnMoveOffset)

• columnMoveOffset: A float stores the move offset of column that is used to render.

columnOffset

This property determines the global offset between the left border and column text.

dgsSetProperty(gridlist,"columnOffset",columnOffset)

• columnOffset: An integer of offset of the column.

columnRelative

This property determines whether the column length is relative or not. See dgsGridListSetColumnRelative/dgsGridListGetColumnRelative

dgsSetProperty(gridlist,"columnRelative",columnRelative)

• columnRelative: A bool of the relative state of the column length.

columnShadow

The shadow text of the column.

dgsSetProperty(gridlist,"columnShadow",{offsetX,offsetY,color})

• offsetX: A float of the 2D X offset of the shadow text of the column.
• offsetY: A float of the 2D Y offset of the shadow text of the column.
• color: An integer of the color of the shadow text of the column.

columnTextColor

This property determines the color of the column text of the grid list.

dgsSetProperty(gridlist,"columnTextColor",columnTextColor)

• columnTextColor: An integer of the color that can be converted by tocolor.

columnTextPosOffset

This property adjusts the offset of the text of the column, which can solve text misplacing caused by font.

dgsSetProperty(gridlist,"columnTextPosOffset",{offsetX,offsetY})

• offsetX: A float of the 2D X offset of the text of the column.
• offsetY: A float of the 2D Y offset of the text of the column.

columnTextSize

This property determines the scale of the column text of the grid list.

dgsSetProperty(gridlist,"columnTextSize",{scaleX,scaleY})

• scaleX: A float of the 2D X scale of the text of the column.
• scaleY: A float of the 2D Y scale of the text of the column.

columnWordBreak

This property determines whether word break property for column is enabled or not. Learn More dxDrawText

dgsSetProperty(gridlist,"columnWordBreak",columnWordBreak)

• columnWordBreak: A bool indicates whether the word break is enabled.

colorCoded

Whether the color code is enabled or not. Learn More dxDrawText

dgsSetProperty(gridlist,"colorCoded",colorCoded)

• colorCoded: Set to true to enable embedded #FFFFFF color codes.

defaultColumnOffset

This property determines offset of normal row column (is different from but works with columnOffset). See dgsGridListSetRowAsSection

dgsSetProperty(gridlist,"defaultColumnOffset",defaultColumnOffset)

• defaultColumnOffset: An integer of the offset of normal row column.

defaultSortFunctions

This property determines the default sort function of grid list when clicking column.

dgsSetProperty(gridlist,"defaultSortFunctions",{lowerSortFunction,upperSortFunction})

• lowerSortFunction: A string of the lower sort function name.
• upperSortFunction: A string of the upper sort function name.

Here are three groups can be use:

• greaterLower/greaterUpper: Sorting directly with string.
• numGreaterLowerNumFirst/numGreaterUpperNumFirst: Sorting support number order with number first.
• numGreaterLowerStrFirst/numGreaterUpperStrFirst: Sorting support number order with string first.
• longerLower/longerUpper: Sorting according to the utf8 length of the string.

defaultSortIcons

This property determines the icons of the default sort function.

dgsSetProperty(gridlist,"defaultSortIcons",{iconA,iconB})

• iconA: A string of the lower sort icon (▲ By default).
• iconB: A string of the upper sort icon (▼ By default).

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText

dgsSetProperty(gridlist,"font",font)

• font: A dx font element of the default text font of the gridlist.

leading

This property determines the space between rows.

dgsSetProperty(gridlist,"leading",leading)

• leading: How many pixels between rows

multiSelection

This property determines whether multi selection is enabled or not. See dgsGridListSetMultiSelectionEnabled/dgsGridListGetMultiSelectionEnabled

dgsSetProperty(gridlist,"multiSelection",multiSelection)

• multiSelection: A bool of the state of the multi selection.

mode

This property determines the render mode of grid list.

dgsSetProperty(gridlist,"mode",mode)

• mode: A bool of the state of render mode. Detail:
  • true: No render target mode (Crappy and have a lot of bugs but doesn't take video memory)
  • false: Render target mode (Great quality but takes video memory)

mouseSelectButton

This property allows which button on the mouse can select items of grid list.

dgsSetProperty(gridlist,"mouseSelectButton",{canLeftButton,canMiddleButton,canRightButton})

• canLeftButton: A bool of whether left mouse button can select the grid list (default is true)
• canMiddleButton: A bool of whether middle mouse button can select the grid list (default is false)
• canRightButton: A bool of whether right mouse button can select the grid list (default is false)

moveHardness

This property determines how hard will the grid list moves when scrolling.

dgsSetProperty(gridlist,"moveHardness",{scrollHardness,dragHardness})

• scrollHardness: A float determins how hard will the grid list moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
• dragHardness: A float determins how hard will the grid list moves when dragging with mouse ( should be larger than 0, lower than 1 ).

preSelect

This property stores the item id the cursor is hovering on.

dgsSetProperty(gridlist,"preSelect",{rowIndex,columnIndex})

• rowIndex: Row Index
• columnIndex: Column Index

rowColor

This property determines the default 3 states' colors of row. See dgsGridListSetRowBackGroundColor/dgsGridListGetRowBackGroundColor

dgsSetProperty(gridlist,"rowColor",{colorDefault,colorHoving,colorSelected})

• colorDefault: An integer of the color of the row (Default State).
• colorHoving: An integer of the color of the row (Hoving State).
• colorSelected: An integer of the color of the row (Selected State).

rowData

This property stores row data.

dgsSetProperty(gridlist,"rowData",rowData)

• rowData: A table stores all row data.

Data Structure

{

	[1] = {
		[-4] = columnOffset,				--column offset
		[-3] = {normal,hovering,selected},		--background image
		[-2] = true/false,				--selectable
		[-1] = true/false,				--clickable
		[0] = {normal,hovering,selected},		--background color
		[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 1
		[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 2
		...
	},		--Row 1
	[2] = {
		[-4] = columnOffset,				--column offset
		[-3] = {normal,hovering,selected},		--background image
		[-2] = true/false,				--selectable
		[-1] = true/false,				--clickable
		[0] = {normal,hovering,selected},		--background color
		[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 1
		[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 2
		...
	},		--Row 2
}

rowHeight

This property determines the row height of the grid list.

dgsSetProperty(gridlist,"rowHeight",rowHeight)

• rowHeight: An integer of row height of the grid list.

rowImage

This property determines the default 3 states' background image of row. See dgsGridListGetRowBackGroundImage/dgsGridListSetRowBackGroundImage

dgsSetProperty(gridlist,"rowImage",{normalImage,hoveringImage,selectedImage})

• normalImage: A texture of the image of the row (Normal State).
• hoveringImage: A texture of the image of the row (Hoving State).
• selectedImage: A texture of the image of the row (Selected State).

rowMoveOffset

This property stores the move offset of row that is used to render.

dgsSetProperty(gridlist,"rowMoveOffset",rowMoveOffset)

• rowMoveOffset: A float stores the move offset of row that is used to render.

rowSelect

This property stores the selected rows.

dgsSetProperty(gridlist,"rowSelect",data)

• data: the data.

Data Structure

{
	[Column1] = {
		Row1,
		Row2,
		...
	},
	[Column2] = {
		Row1,
		Row2,
		...
	},
	...
}

rowShadow

The shadow text of the row.

dgsSetProperty(gridlist,"rowShadow",{offsetX,offsetY,color})

• offsetX: A float of the 2D X offset of the shadow text of the row.
• offsetY: A float of the 2D Y offset of the shadow text of the row.
• color: An integer of the color of the shadow text of the row.

rowShowUnclippedOnly

This property will force the grid list only show those unclipped row

dgsSetProperty(gridlist,"rowShowUnclippedOnly",rowShowUnclippedOnly)

• rowShowUnclippedOnly: A bool indicates if the only the unclipped rows will be shown in grid list.

rowTextColor

This property determines the default color of the row text of the grid list.

dgsSetProperty(gridlist,"rowTextColor",rowTextColor)

• rowTextColor: An integer of the color of the row text that can be converted by tocolor.

dgsSetProperty(gridlist,"rowTextColor",{normalColor,hoveringColor,selectedColor})

• normalColor: A integer of the color of the row text that can be converted by tocolor(Normal State).
• hoveringColor: A integer of the color of the row text that can be converted by tocolor(Hoving State).
• selectedColor: A integer of the color of the row text that can be converted by tocolor(Selected State).

rowTextPosOffset

This property adjusts the offset of the text of the row, which can solve text misplacing caused by font.

dgsSetProperty(gridlist,"rowTextPosOffset",{offsetX,offsetY})

• offsetX: A float of the 2D X offset of the text of the row.
• offsetY: A float of the 2D Y offset of the text of the row.

rowTextSize

This property determines the default scale of the row text of the grid list.

dgsSetProperty(gridlist,"rowTextSize",{scaleX,scaleY})

• scaleX: A float of the 2D X scale of the text of the row.
• scaleY: A float of the 2D Y scale of the text of the row.

rowWordBreak

This property determines whether word break property for row is enabled or not. Learn More dxDrawText

dgsSetProperty(gridlist,"rowWordBreak",rowWordBreak)

• rowWordBreak: A bool indicates whether the word break is enabled.

scrollBarState

This property forces the visibility of scroll bar. See dgsGridListSetScrollBarState/dgsGridListGetScrollBarState

dgsSetProperty(gridlist,"scrollBarState",{vertical,horizontal})

• vertical: A bool of the state of the vertical scroll bar.
• horizontal: A bool of the state of the horizontal scroll bar.
  • true: Force to be visible
  • false: Force to be invisible
  • nil: Auto

scrollBarThick

This property determines the thickness of scroll bar.

dgsSetProperty(gridlist,"scrollBarThick",scrollBarThick)

• scrollBarThick: An integer of the thickness of scroll bar.

sectionColumnOffset

This property determines offset of section row column (is different from but works with columnOffset). See dgsGridListSetRowAsSection

dgsSetProperty(gridlist,"sectionColumnOffset",sectionColumnOffset)

• sectionColumnOffset: An integer of the offset of section row column.

sectionFont

This property determines the font of the text of which row is in section mode. Learn More dxDrawText

dgsSetProperty(gridlist,"sectionFont",sectionFont)

• sectionFont: A dx font element of the text of which row is in section mode.

selectionMode

This property stores current selection mode of grid list. See dgsGridListSetSelectionMode/dgsGridListGetSelectionMode

dgsSetProperty(gridlist,"selectionMode",selectionMode)

• selectionMode: The mode of the selection. Can be the following values:
  • 1: row selection
  • 2: column selection
  • 3: cell selection

selectedColumn

This property stores the index of which column the cursor is hovering. See dgsGridListGetEnterColumn

dgsSetProperty(gridlist,"selectedColumn",selectedColumn)

• columnHeight: Column Index.

sortColumn

This property determines target sort column. See dgsGridListSetSortColumn

dgsSetProperty(gridlist,"sortColumn",sortColumn)

• sortColumn: An integer of the specific column to be sorted by.

sortEnabled

This property determines whether sort is enabled. See dgsGridListSetSortEnabled/dgsGridListGetSortEnabled

dgsSetProperty(gridlist,"sortEnabled",sortEnabled)

• sortEnabled: A bool of sort state.

See Also

General Properties

• DGS General Basic Properties

Unique Properties For DGS Core Elements

• dgs-dx3dinterface
• dgs-dx3dimage
• dgs-dx3dtext
• dgs-dx3dline
• dgs-dxbutton
• dgs-dxcheckbox
• dgs-dxcombobox
• dgs-dxdetectarea
• dgs-dxedit
• dgs-dxgridlist
• dgs-dximage
• dgs-dxlabel
• dgs-dxline
• dgs-dxmemo
• dgs-dxprogressbar
• dgs-dxradiobutton
• dgs-dxscrollbar
• dgs-dxscrollpane
• dgs-dxselector
• dgs-dxswitchbutton
• dgs-dxtabpanel
• dgs-dxtab
• dgs-dxwindow