Grid Config XML

Controls the UI, as well as the features and functions of the grid.  This property is a string represented by XML and is used by specifying the root node value of the grid. It can contain the elements listed below.

Example:

                   <Grid>
                             <Enabled>True</Enabled>
                             <DefaultStyleMode>Standard</DefaultStyleMode>
                   </Grid>

AllowAutoDataCaching

A Boolean value that specifies whether the grid handles data caching automatically.

Default:  True

AllowColumnFreezing

A Boolean value that, when enabled, makes the Freeze Pane option available when the user right-clicks on the grid. It allows users to select a number of columns that remain stationary so they are always in view as the user scrolls across the grid. This element is used with the MaxFrozenColumns element.

Default: False

AllowColumnMove

A Boolean value that controls whether users can move columns during runtime.

Default: True

AllowColumnSizing

A Boolean value that controls whether users can resize grid columns at runtime.

Default: True

AllowContextMenu

A Boolean value that controls whether the Context menu will be available to users.

Default: True

AllowExport

A Boolean value that controls whether Export is enabled.

Default: False

AllowFilter

A Boolean value that controls whether users can filter items in the grid.

Default: True

AllowGrouping

A Boolean value that controls whether grouping is allowed in the grid.

Default: True

AllowSelectColumns

A Boolean value that controls whether users can select grid columns at runtime and drag them to another location in the grid.

Default: True

AllowSorting

A Boolean value that controls whether sorting can be performed at runtime.

Default: True

AlternatingColors

A Boolean value that controls whether grid rows will have alternating colors.

Default: True

AlwaysShowHelpButton

A Boolean value that controls whether the help button is displayed or not.

Default: True

ApplyFiltersKey

The key value used to run a filter on the grid.

Options: ShiftEnter, Enter

Default: ShiftEnter

AutoColMinWidth

A numeric value for the minimum width of a column if AutoFitColumns is enabled.

Default: 100

AutoFilterSuggestion

A Boolean value that controls whether the grid will display filter suggestions in the Context menu.

Default: False

AutoFitColumns

A Boolean value that controls whether the grid’s columns will be auto-sized to fit the width of the grid.

Default: False

BackColor

The HTML color value of the grid.

Default: Empty

BorderColor

The HTML color value of the grid’s borders.

Default: Black

BorderStyle

The style of the grid’s borders.

Options:

Dashed, Dotted, Double, Groove, Inset, Outset, None, Ridge, Solid

Default: Solid

BorderWidth

A numeric value to set the width of the grid’s borders.

Default: 1

CacheServerConnection

Specifies the file server connection string for grid data cache storage.

Default: empty

CellPadding

A numeric value to set the grid’s cell padding, or the amount of space between a cell’s content and cell border, measured in pixels.

Default: 1

CellSpacing

A numeric value to set the grid’s cell spacing, or the amount of each space between each cell.
Default: 0

ColumnFooters

A Boolean value that controls whether column footers are displayed.

Default: False

ColumnHeaders

A Boolean value that controls whether column headers are displayed.

Default: False

DataCacheStorage

Specifies where to store the grid’s cached data.

Options: Session, Page, FileServer

Default: Page

DefaultStyleMode

The style mode the grid will use if UseDefaultStyle is set to true.

Options: Elegant, Standard

Default: Elegant

Enabled

A Boolean value to enable or disable the grid.

Default: True

FilterBarVisible

A Boolean value that controls whether the filter bar is visible on the grid.

Default: True

ForeColor

The HTML color value to control the text color of the grid.

Default: Black

GridLines

Specifies how gridlines are displayed in the grid.

Options: Both, None, Horizontal, Vertical

Default: Both

GridLineColor

The HTML color for the grid’s gridlines.

Default: Blue

GridLineStyle

Sets the style of the grid’s gridlines.

Options: Dashed, Dotted, Double, Groove, Inset, Outset, None, Ridge, Solid

Default: Solid

GroupByBoxVisible

A Boolean value that controls whether the Group By box will be displayed in the grid.

Default: False

GroupRowInfoDefaultFormat

Specifies the string format to apply to the grid’s group row.

Default: Empty

HeaderClickAction

Specifies how the columns will be sorted.

Options: SortSingle, SortMulti, Non

Default: SortMulti

Height

The height of the grid.

Default:  350

HideColumnsWhenGrouped

A Boolean value that controls whether columns are displayed if they are being grouped on.

Default: True

Hierarchical

A Boolean value that controls whether the grid will display hierarchical data.

Default: False

HierarchicalMode

A balue that controls the operational mode if Hierarchical is enabled.

Options: LoadOnDemand, PreLoad

Default: LoadOnDemand

Initial View (Not Yet Used)

Controls the intial view of the grid.

Options: Both, PivotChartView, PivotChartExclusive, GridView

Default: GridView

InProgressUIBehavior

Controls the action that occurs while the grid is busy.

Options: Message, HourGlass

Default: Message

Language

Sets the language options for the grid.

Options: UseDefault, Custom, Culture

Default:  UseDefault

MaxFrozenColumns

Specifies the maximum number of columns that can be frozen by the user, so up to that number of columns remain stationary as the user scrolls across the grid. Used with the AllowColumnFreezing element.

Default: 0

MenuCssFile

Contains the name of the css file that contains the context menu.

PagingDetectPartialGroupRows

A Boolean value that controls whther the grid will detect partial rows when classic paging is enabled.

Default: False

PagingExportMode

Controls whether the grid will export the entire set of rows when classic paging is enabled.

Options: CurrentPage, ExportAllData

Default: CurrentPage

PagingLatencyOnSlide

A numeric value that controls the amount of time in milliseconds to fetch data when paging is being changed. Only applies when classic paging is enabled and PagingStyleUI is set to slider.

Default: 500

PagingMode

Controls the style of paging.

Options: ClassicPaging, VirtualLoad, None

Default: VirtualLoad

PagingSize

A numeric value that controls the number of rows to display when paging is enabled.

Default: 25

PagingSliderWidth

A numeric value that controls the slider bar width when classic paging is enabled and PagingStyleUI is set to Slider.

Default: 100

PagingStyleUI

Controls the style of paging.

Options: SimpleDropDown, Slider, PrevNext

Default: PrevNext

RowHeaders

A Boolean value that controls whether row headers are displayed in the grid.

Default: False

RowHeightDefault

A numeric value that controls the default height of the rows in the grid.

Default: 20

RowHeaderWidth

A numeric value that controls the width of the row headers, if enabled.

Default: 18

RowHighlightType

Sets the highlight type when a row is selected.

Options: BackgroundOnly, EntireRow

Default: EntireRow

ShowFilterStatus

A Boolean value that controls whether the filter status is displayed in the grid’s status bar.

Default: False

ShowRefreshButton

A Boolean value that controls whether the Refresh button is displayed in the grid’s status bar.

Default: True

StateRestorationLevel

Specifies the state level value that the grid uses to restore itself. This determines the amount of information that is restored when the page is created and posted back. Page size is affected by the StateRestorationLevel, but CorasWorks recommends keeping the default of "High."

Options: Low, Medium, High

Default: High

StatusBarVisible

A Boolean value that controls whether the status bar is displayed.

Default: True

TreeLines

A Boolean value that controls whether tree lines are visible when hierarchical mode is enabled.

Default: False

UseDefaultStyle

A Boolean value that enables the grid to use the default-built in styling. Enabling this improves rendering performance.

Default: True

ViewStateServerConnection

Specifies the connection string for file-based viewstate storage.

ViewStateStorage

Specifies where the grid will store its viewstate information.

Options: Client, None, Session, Page, FileServer

Default: Page

VirtualLoadMode

Controls the grid’s load mechanism when retrieving and displaying data.

Options: LargeData, Default

Default: Default

VirtualPageSize

A numeric value that controls the number of rows to load when the paging mode is set to VirtualLoad.

Default: 50

Width

The width of the grid.

Default: Gets width from the parent container

Back to Top