[]
        
(Showing Draft Content)

C1.Web.Mvc.Fluent.FlexGridBaseBuilder-3

FlexGridBaseBuilder<T, TControl, TBuilder> Class

Defines a builder to configurate FlexGridBase<T>.

Inheritance
HideObjectMembers
BaseBuilder<TControl, TBuilder>
ComponentBuilder<TControl, TBuilder>
ControlBuilder<TControl, TBuilder>
ItemsBoundControlBuilder<T, TControl, TBuilder>
FlexGridBaseBuilder<T, TControl, TBuilder>
Implements
Namespace: C1.Web.Mvc.Fluent
Assembly: C1.Web.Mvc.dll
Syntax
public abstract class FlexGridBaseBuilder<T, TControl, TBuilder> : ItemsBoundControlBuilder<T, TControl, TBuilder>, IHtmlString where TControl : FlexGridBase<T> where TBuilder : FlexGridBaseBuilder<T, TControl, TBuilder>
Type Parameters
Name Description
T
TControl
TBuilder

Constructors

Name Description
FlexGridBaseBuilder(TControl)

Creates one FlexGridBaseBuilder<T, TControl, TBuilder> instance to configurate component.

Methods

Name Description
AllowAddNew(bool)

Configurates AllowAddNew. Sets a value that indicates whether the grid should provide a new row template so users can add items to the source collection.

AllowDelete(bool)

Configurates AllowDelete. Sets a value that indicates whether the grid should delete selected rows when the user presses the Delete key.

AllowDragging(AllowDragging)

Configurates AllowDragging. Sets whether users are allowed to drag rows and/or columns with the mouse.

AllowMerging(AllowMerging)

Configurates AllowMerging. Sets which parts of the grid provide cell merging.

AllowResizing(AllowResizing)

Configurates AllowResizing. Sets whether users are allowed to resize rows and/or columns with the mouse.

AlternatingRowStep(int)

Configurates AlternatingRowStep. Sets a value that determines the number of regular rows between 'alternating' rows.

AnchorCursor(bool)

Configurates AnchorCursor. Sets a value that determines whether extending selections with the mouse or keyboard should change the start (cursor) or the end of the current selection.

AriaLabel(string)

Configurates AriaLabel. Sets the aria label property of cells host.

AutoClipboard(bool)

Configurates AutoClipboard. Sets whether the grid should handle clipboard shortcuts.

AutoGenerateColumns(bool)

Configurates AutoGenerateColumns. Sets whether the grid should generate columns automatically based on the itemsSource.

AutoRowHeights(bool)

Configurates AutoRowHeights. Sets a value that determines whether the grid should automatically resize the rows when the data or grid layout change.

AutoScroll(bool)

Configurates AutoScroll. Sets a value that determines whether the grid should automatically scroll its contents while users drag rows or columns into new positions.

AutoSearch(bool)

Configurates AutoSearch. Sets a value that determines whether the grid should search for cells as the users types into read-only cells.

AutoSizeMode(AutoSizeMode)

Configurates AutoSizeMode. Sets which cells should be taken into account when auto-sizing a row or column.

BigCheckboxes(bool)

Configurates BigCheckboxes. Sets a value that determines whether the checkboxes used to edit boolean columns should extend to cover the whole cell width.

BottomLeftCellsTemplate(Action<CellTemplateBuilder>)

Configurates BottomLeftCellsTemplate. Sets the templates applied in bottom left cells.

CaseSensitiveSearch(bool)

Configurates CaseSensitiveSearch. Sets a value that determines whether searches performed while the user types should case-sensitive.

CellsTemplate(Action<CellTemplateBuilder>)

Configurates CellsTemplate. Sets the templates for the content cells.

ChildItemsPath(string)

Configurates ChildItemsPath. Sets the name of the property used to generate child rows in hierarchical grids.

CloneFrozenCells(bool?)

Configurates CloneFrozenCells. Sets a value that determines whether the FlexGrid should clone frozen cells and show them in a separate element to improve perceived performance while scrolling.

ColumnFootersTemplate(Action<CellTemplateBuilder>)

Configurates ColumnFootersTemplate. Sets the templates applied in column footers cells.

ColumnGroups(Action<ListItemFactory<Column, ColumnBuilder>>)

Configure Columns.

ColumnHeadersTemplate(Action<CellTemplateBuilder>)

Configurates ColumnHeadersTemplate. Sets the templates applied in the column header cells.

ColumnLayout(string)

Configurates ColumnLayout. Sets a JSON string that defines the current column layout." remarks="The column layout string represents an array with the columns and their properties. It can be used to persist column layouts defined by users so they are preserved across sessions, and can also be used to implement undo/redo functionality in applications that allow users to modify the column layout.

Columns(Action<ListItemFactory<Column, ColumnBuilder>>)

Configure Columns.

CommitEmptyEdits(bool)

Configurates CommitEmptyEdits. Sets a value that indicates how the grid commit empty edits to cell values.

CopyHeaders(CopyHeader)

Configurates CopyHeaders. Sets copied header cells when copying the content to the clipboard.

DefaultColumnSize(int)

Configurates DefaultColumnSize. Sets the default size of columns in the column collection.

DefaultRowSize(int)

Configurates DefaultRowSize. Sets the default size of rows in the row collection.

DefaultTypeWidth(DataType, int)

Static object that defines the default width for auto-generated grid columns based on their types.

DeferResizing(bool)

Configurates DeferResizing. Sets whether row and column resizing should be deferred until.

ErrorTip(Action<ErrorTooltipBuilder>)

Configurates ErrorTip. Sets the error tooltip of FlexGrid.

ExpandSelectionOnCopyPaste(bool)

Configurates ExpandSelectionOnCopyPaste. Sets a value that determines whether the grid should automatically expand the selection to include cells in merged ranges when copying or pasting content to/from the clipboard.

FrozenColumns(int)

Configurates FrozenColumns. Sets the number of frozen columns.

FrozenRows(int)

Configurates FrozenRows. Sets the number of frozen columns.

GroupBy(params string[])

Configure PropertyGroupDescription.

GroupHeaderFormat(string)

Configurates GroupHeaderFormat. Sets the format string used to create the group header content.

GroupSummaryPosition(GroupSummaryPosition)

Configurates GroupSummaryPosition. Sets a value that determines the position of group summary row in the group. This property does not work if ChildItemsPath property is set.

HeaderTemplate(Action<HeaderTemplateBuilder>)

This is the builder for Custom Header Template.

HeadersFocusability(HeadersFocusability)

Configurates HeadersFocusability. Sets a value that determines whether the row and column headers are focusable.

HeadersVisibility(HeadersVisibility)

Configurates HeadersVisibility. Sets a value that determines whether the row and column headers are visible.

ImeEnabled(bool)

Configurates ImeEnabled. Sets a value that determines whether the grid should support Input Method Editors (IME) while not in edit mode.

IsReadOnly(bool)

Configurates IsReadOnly. Sets whether the user can edit the grid cells by typing into them.

ItemFormatter(string)

Configurates ItemFormatter. Sets a formatter function used to customize cells on this grid.

ItemValidator(string)

Configurates ItemValidator. Sets a validator function to determine whether cells contain valid data.

KeyActionEnter(KeyAction)

Configurates KeyActionEnter. Sets the action to perform when the ENTER key is pressed.

KeyActionTab(KeyAction)

Configurates KeyActionTab. Sets the action to perform when the TAB key is pressed.

LazyRender(bool)

Configurates LazyRender. Sets whether the grid should skip rendering cells that were updated in the last render cycle.

NewRowAtTop(bool)

Configurates NewRowAtTop. Sets a value that indicates whether the new row template should be located at the top of the grid or at the bottom.

OnClientAutoSizedColumn(string)

Configurates the OnClientAutoSizedColumn client event. Occurs after the user auto-sizes a column by double-clicking the right edge of a column header cell.

OnClientAutoSizedRow(string)

Configurates the OnClientAutoSizedRow client event. Occurs after the user auto-sizes a row by double-clicking the bottom edge of a row header cell.

OnClientAutoSizingColumn(string)

Configurates the OnClientAutoSizingColumn client event. Occurs before the user auto-sizes a column by double-clicking the right edge of a column header cell.

OnClientAutoSizingRow(string)

Configurates the OnClientAutoSizingRow client event. Occurs before the user auto-sizes a row by double-clicking the bottom edge of a row header cell.

OnClientBeginningEdit(string)

Configurates the OnClientBeginningEdit client event. Occurs before a cell enters edit mode.

OnClientCellEditEnded(string)

Configurates the OnClientCellEditEnded client event. Occurs when a cell edit has been committed or canceled.

OnClientCellEditEnding(string)

Configurates the OnClientCellEditEnding client event. Occurs when a cell edit is ending.

OnClientCopied(string)

Configurates the OnClientCopied client event. Occurs after the user has copied the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

OnClientCopying(string)

Configurates the OnClientCopying client event. Occurs when the user is copying the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

OnClientDeletedRow(string)

Configurates the OnClientDeletedRow client event. Occurs after the user has deleted a row by pressing the Delete key.

OnClientDeletingRow(string)

Configurates the OnClientDeletingRow client event. Occurs when the user is deleting a selected row by pressing the Delete key (see the allowDelete property).

OnClientDraggedColumn(string)

Configurates the OnClientDraggedColumn client event. Occurs when the user finishes dragging a column.

OnClientDraggedRow(string)

Configurates the OnClientDraggedRow client event. Occurs when the user finishes dragging a row.

OnClientDraggingColumn(string)

Configurates the OnClientDraggingColumn client event. Occurs when the user starts dragging a column.

OnClientDraggingColumnOver(string)

Configurates the OnClientDraggingColumnOver client event. Occurs as the user drags a column to a new position.

OnClientDraggingRow(string)

Configurates the OnClientDraggingRow client event. Occurs when the user starts dragging a row.

OnClientDraggingRowOver(string)

Configurates the OnClientDraggingRowOver client event. Occurs as the user drags a row to a new position.

OnClientFormatItem(string)

Configurates the OnClientFormatItem client event. Occurs when an element representing a cell has been created.

OnClientGroupCollapsedChanged(string)

Configurates the OnClientGroupCollapsedChanged client event. Occurs after a group has been expanded or collapsed.

OnClientGroupCollapsedChanging(string)

Configurates the OnClientGroupCollapsedChanging client event. Occurs when a group is about to be expanded or collapsed.

OnClientItemsSourceChanged(string)

Configurates the OnClientItemsSourceChanged client event. Occurs after the grid has been bound to a new items source.

OnClientItemsSourceChanging(string)

Configurates the OnClientItemsSourceChanging client event. Occurs after the grid has been bound to a new items source.

OnClientLoadedRows(string)

Configurates the OnClientLoadedRows client event. Occurs after the grid rows have been bound to the data source.

OnClientLoadingRows(string)

Configurates the OnClientLoadingRows client event. Occurs before the grid rows are bound to the data source.

OnClientPasted(string)

Configurates the OnClientPasted client event. Occurs after the user has pasted content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

OnClientPastedCell(string)

Configurates the OnClientPastedCell client event. Occurs after the user has pasted content from the clipboard into a cell.

OnClientPasting(string)

Configurates the OnClientPasting client event. Occurs when the user is pasting content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).

OnClientPastingCell(string)

Configurates the OnClientPastingCell client event. Occurs when the user is pasting content from the clipboard into a cell.

OnClientPinnedColumn(string)

Configurates the OnClientPinnedColumn client event. Occurs as columns are pinned.

OnClientPinningColumn(string)

Configurates the OnClientPinningColumn client event. Occurs as columns are pinning.

OnClientPrepareCellForEdit(string)

Configurates the OnClientPrepareCellForEdit client event. Occurs when an editor cell is created and before it becomes active.

OnClientResizedColumn(string)

Configurates the OnClientResizedColumn client event. Occurs when the user finishes resizing a column.

OnClientResizedRow(string)

Configurates the OnClientResizedRow client event. Occurs when the user finishes resizing rows.

OnClientResizingColumn(string)

Configurates the OnClientResizingColumn client event. Occurs as columns are resized.

OnClientResizingRow(string)

Configurates the OnClientResizingRow client event. Occurs as rows are resized.

OnClientRowAdded(string)

Configurates the OnClientRowAdded client event. Occurs when the user creates a new item by editing the new row template (see the allowAddNew property).

OnClientRowEditEnded(string)

Configurates the OnClientRowEditEnded client event. Occurs when a row edit has been committed or canceled.

OnClientRowEditEnding(string)

Configurates the OnClientRowEditEnding client event. Occurs when a row edit is ending, before the changes are committed or canceled.

OnClientRowEditStarted(string)

Configurates the OnClientRowEditStarted client event. Occurs after a row enters edit mode.

OnClientRowEditStarting(string)

Configurates the OnClientRowEditStarting client event. Occurs before a row enters edit mode.

OnClientScrollPositionChanged(string)

Configurates the OnClientScrollPositionChanged client event. Occurs after the control has scrolled.

OnClientSelectionChanged(string)

Configurates the OnClientSelectionChanged client event. Occurs after selection changes.

OnClientSelectionChanging(string)

Configurates the OnClientSelectionChanging client event. Occurs before selection changes.

OnClientSortedColumn(string)

Configurates the OnClientSortedColumn client event. Occurs after the user applies a sort by clicking on a column header.

OnClientSortingColumn(string)

Configurates the OnClientSortingColumn client event. Occurs before the user applies a sort by clicking on a column header.

OnClientUpdatedLayout(string)

Configurates the OnClientUpdatedLayout client event. Occurs after the grid has updated its internal layout.

OnClientUpdatedView(string)

Configurates the OnClientUpdatedView client event. Occurs when the grid finishes creating/updating the elements that make up the current view.

OnClientUpdatingLayout(string)

Configurates the OnClientUpdatingLayout client event. Occurs before the grid updates its internal layout.

OnClientUpdatingView(string)

Configurates the OnClientUpdatingView client event. Occurs when the grid starts creating/updating the elements that make up the current view.

OrderBy(params string[])

Configure SortDescription.

OrderByDescending(params string[])

Configure SortDescription.

PageSize(int)

Make ItemsSource pagable with specified page size. 0 means to disable paging.

PasteEmptyCells(bool)

Configurates PasteEmptyCells. Sets a value that determines whether when pasting, paste all cells or only not empty cells.

PinningType(PinningType)

Configurates PinningType. Sets how the grid pins the column headers by clicking the icons toggles the column's frozen state

PreserveOutlineState(bool)

Configurates PreserveOutlineState. Sets a value that determines whether the grid should preserve the expanded/collapsed state of nodes when the data is refreshed.

PreserveSelectedState(bool)

Configurates PreserveSelectedState. Sets a value that determines whether the grid should preserve the selected state of rows when the data is refreshed.

PreserveWhiteSpace(bool)

Configurates PreserveWhiteSpace. Sets a value that determines whether the grid should keep whitespace in cells as they appear in the data or whether it should collapse the whitespace into a single space character

QuickAutoSize(bool?)

Configurates QuickAutoSize. Sets a value that determines whether the grid should optimize performance over precision when auto-sizing columns.

RefreshOnEdit(bool)

Configurates RefreshOnEdit. Sets whether the grid should refresh all cells after a cell is edited.

RowHeaderPath(string)

Configurates RowHeaderPath. Sets the name of the property used to create row header cells.

RowHeadersTemplate(Action<CellTemplateBuilder>)

Configurates RowHeadersTemplate. Sets the templates applied in row header cells.

ScrollIntoView(int, int)

Scrolls the grid to bring a specific cell into view.

Select(int, int, int?, int?)

Selects a cell range and optionally scrolls it into view.

SelectionMode(SelectionMode)

Configurates SelectionMode. Sets the current selection mode.

ShowAlternatingRows(bool)

Configurates ShowAlternatingRows. Sets a value that determines whether the grid should add the 'wj-alt' class to cells in alternating rows.

ShowColumnFooters(bool, string)

Sets whether to show a group row to display the aggregates in the column footers panel.

ShowDropDown(bool)

Configurates ShowDropDown. Sets a value that indicates whether the grid adds drop-down buttons to the cells in columns that have the ShowDropDown property set to true.

ShowErrors(bool)

Configurates ShowErrors. Sets a value that determines whether the grid should add the 'wj-state-invalid' class to cells that contain validation errors, and tooltips with error descriptions.

ShowGroups(bool)

Configurates ShowGroups. Sets whether the grid should insert group rows to delimit data groups.

ShowMarquee(bool)

Configurates ShowMarquee. Sets a value that indicates whether the grid should display a marquee element around the current selection.

ShowPlaceholders(bool)

Configurates ShowPlaceholders. Sets a value that determines whether the grid should use the column headers as placeholders when editing cells. This property only works with the grid's built-in editor. This property is not useful in IE.

ShowSelectedHeaders(HeadersVisibility)

Configurates ShowSelectedHeaders. Sets a value that indicates whether the grid should add class names to indicate selected header cells.

ShowSort(bool)

Configurates ShowSort. Sets whether the grid should display sort indicators in the column headers.

SkipMerged(bool)

Configurates SkipMerged. Sets a value that determines whether when copying, skip cells that have been merged.

SortRowIndex(int?)

Configurates SortRowIndex. Sets the index of row in the column header panel that shows and changes the current sort.

SortingType(AllowSorting)

Configurates SortingType. Sets how the grid sort columns by clicking the column header cells.

StickyHeaders(bool)

Configurates StickyHeaders. Sets a value that determines whether column headers should remain when the user scrolls the window.

TopLeftCellsTemplate(Action<CellTemplateBuilder>)

Configurates TopLeftCellsTemplate. Sets the templates for the topleft cells.

TreeIndent(int)

Configurates TreeIndent. Sets the indent used to offset row groups of different levels.

ValidateEdits(bool)

Configurates ValidateEdits. Sets a value that determines whether the grid should remain in edit mode when the user tries to commit edits that fail validation.

VirtualizationThresholds(int, int)

Sets the minimum number of rows, columns required to enable virtualization.

Extension Methods