[]
        
(Showing Draft Content)

C1.Web.Mvc.TagHelpers.FlexGridBaseTagHelper-2

FlexGridBaseTagHelper<T, TControl> Class

ITagHelper implementation for FlexGridBase<T>.

Inheritance
BaseTagHelper<TControl>
FlexGridBaseTagHelper<T, TControl>
Namespace: C1.Web.Mvc.TagHelpers
Assembly: C1.AspNetCore.Mvc.dll
Syntax
public abstract class FlexGridBaseTagHelper<T, TControl> : ItemsBoundControlTagHelper<T, TControl>, ITagHelper, ITagHelperComponent, ITemplateTagHelper where TControl : FlexGridBase<T>
Type Parameters
Name Description
T
TControl

Constructors

Name Description
FlexGridBaseTagHelper()

Properties

Name Description
AllowAddNew

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

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

AllowDragging

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

AllowMerging

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

AllowResizing

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

AlternatingRowStep

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

AnchorCursor

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

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

AutoClipboard

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

AutoGenerateColumns

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

AutoRowHeights

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

AutoScroll

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

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

AutoSizeMode

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

AutoSizedColumn

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

AutoSizedRow

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

AutoSizingColumn

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

AutoSizingRow

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

BeginningEdit

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

BigCheckboxes

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

CaseSensitiveSearch

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

CellEditEnded

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

CellEditEnding

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

ChildItemsPath

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

CloneFrozenCells

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.

ColumnFootersRowHeaderText

Configurates ColumnFootersRowHeaderText. Sets the text for the group row header in the column footers panel.

ColumnLayout

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.

CommitEmptyEdits

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

Copied

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).

CopyHeaders

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

Copying

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).

DefaultColumnSize

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

DefaultRowSize

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

DefaultTypeWidth

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

DeferResizing

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

DeletedRow

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

DeletingRow

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

DraggedColumn

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

DraggedRow

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

DraggingColumn

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

DraggingColumnOver

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

DraggingRow

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

DraggingRowOver

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

ExpandSelectionOnCopyPaste

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.

FormatItem

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

FrozenCells

Configurates FrozenCells. Specifies the frozen options for FlexGrid based controls.

FrozenColumns

Configurates FrozenColumns. Sets the number of frozen columns.

FrozenRows

Configurates FrozenRows. Sets the number of frozen columns.

GroupBy

Gets or sets the group descriptions.

GroupCollapsedChanged

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

GroupCollapsedChanging

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

GroupHeaderFormat

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

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

Configurates HeaderTemplate.

HeadersFocusability

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

HeadersVisibility

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

ImeEnabled

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

IsReadOnly

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

ItemFormatter

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

ItemValidator

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

ItemsSourceChanged

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

ItemsSourceChanging

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

KeyActionEnter

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

KeyActionTab

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

LazyRender

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

LoadedRows

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

LoadingRows

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

NewRowAtTop

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.

OrderBy

Gets or sets the sort expression.

PasteEmptyCells

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

Pasted

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).

PastedCell

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

Pasting

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).

PastingCell

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

PinnedColumn

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

PinningColumn

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

PinningType

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

PrepareCellForEdit

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

PreserveOutlineState

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

PreserveSelectedState

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

PreserveWhiteSpace

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

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

RefreshOnEdit

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

ResizedColumn

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

ResizedRow

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

ResizingColumn

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

ResizingRow

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

RowAdded

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

RowEditEnded

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

RowEditEnding

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

RowEditStarted

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

RowEditStarting

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

RowHeaderPath

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

ScrollPosition

Configurates ScrollPosition. Sets the position of the grid's scrollbars.

ScrollPositionChanged

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

Selection

Configurates Selection. Sets the current selection.

SelectionChanged

Configurates the OnClientSelectionChanged client event. Occurs after selection changes.

SelectionChanging

Configurates the OnClientSelectionChanging client event. Occurs before selection changes.

SelectionMode

Configurates SelectionMode. Sets the current selection mode.

ShowAlternatingRows

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

ShowColumnFooters

Configurates ShowColumnFooters. Sets a bool value which indicates whether to show a group row to display the aggregates in the column footers panel.

ShowDropDown

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

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

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

ShowMarquee

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

ShowPlaceholders

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

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

ShowSort

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

SkipMerged

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

SortRowIndex

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

SortedColumn

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

SortingColumn

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

SortingType

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

StickyHeaders

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

TreeIndent

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

UpdatedLayout

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

UpdatedView

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

UpdatingLayout

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

UpdatingView

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

ValidateEdits

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

Gets or sets the minimum number of rows and/or columns required to enable virtualization.