Aller au contenu principal

LgGridView<TItem>

Module : Lagoon.UI.GridView
Namespace : Lagoon.UI.Components
Catégorie : Components
Hérite de : LgFrame

Gridview - profiles

Paramètres​

ParamètreTypeDescription
AddItemOnTopbool?Gets or sets if the add line is shown on top or not
AllowCancellationboolGet or set the cancellation behaviour of the LgLoaderView
ColumnsRenderFragment<TItem>Columns content
ConfigureExportColumnAction<GridViewConfigureExportColumnEventArgs>Export event
ControllerQueryArgobjectGets or sets remote data complementary class
ControllerUristringGets or sets remote data url
CurrentPageintGets or sets current page
CurrentPageChangedEventCallback<int>Gets or sets current page binding event
DataErrorTitlestringGets or sets the title of the error message if loading fails.
DefaultGroupCollapsedboolGets or sets if groups are collapsed by default
DefaultPageSizeint?Gets or sets the default number of the row by page when the paging feature is activated.
DefaultShowFiltersbool?Gets or sets if the filters are initially visible. When defined, it overrides the initial value of ShowFilters. A profile holding a filter always shows the filters.
DisplayDefaultTooltipHeaderbool?Force the display of tooltips on the current Gridview headers
DisplayInputPageSelectorbool?Gets or sets if the input page selector is shown
DisplaySuccessSaveMessagebool?Gets or sets if the success message is shown when cell is edited
EditModeGridEditModeGets or sets editing mode
EditRefreshModeGridEventRefreshModeGets or sets refresh after editing
EditingStateGridViewEditingStateGets the add or edit state
EditingStateChangedEventCallback<GridViewEditingState>Gets the add or edit state event
ExportCulturestringGet or set the culture name used for export (will be used for numeric format in CSV for example)
ExportFileNamestringGets or sets the name of the export file
ExportOptionsContentRenderFragment<ExportOptionsContext>Gets or sets the content to be rendered within the export options.
Exportablebool?Gets or sets the export activation
FeaturesGridFeatureDefine allowed options
GridStyleTypeGridStyleTypeDefine grid style
GridViewDataCounterGridViewDataCounterGets count of displayed rows
GridViewDataCounterChangedEventCallback<GridViewDataCounter>Gets or sets event for binding count
GroupBystringGets or sets fields names for the grouping Separator is ,
GroupHeaderContentRenderFragment<GridGroupData<TItem>>Gets or sets group header content
HiddenExportListstringGets or sets the list of provider IDs (separated by commas) to hide from the user. Example : "xlsx,csv"
ItemModelTItemInstance of TItem used to build columns structure.
ItemsICollection<TItem>Gets or sets list of the data
KeyFieldstringGets or sets the name of the property identifying an item: the key of the selection and of the row reload (GridEventRefreshMode.ReloadRow). Selected items are compared on this property, so the selection survives a reload of the items, and a reloaded row is found again from its value.
LayoutModeGridLayoutModeGets or sets Auto resize column at startup.
MaxSortedColumnsint?Gets or sets the maximum number of columns sorted at the same time. When the user sorts one more column, the lowest priority sort is removed. 0 means no limit. If undefined, the GridViewBehaviour.Options.MaxSortedColumns value is used (4 by default).
NewItemFunc<TItem>Method called to create a new item when adding a new line.
NewItemAsyncFunc<Task<TItem>>Asynchronous method called to create a new item when adding a new line.
NoDataDescriptionstringGets or sets the message desccription if no data is returned.
NoDataTitlestringGets or sets the message title if no data is returned.
OnAfterAddEventCallback<GridViewAfterActionEventArgs<TItem>>After add data event
OnAfterDeleteEventCallback<GridViewAfterActionEventArgs<TItem>>After delete data event
OnAfterUpdateEventCallback<GridViewAfterActionEventArgs<TItem>>After update data event
OnCellClickEventCallback<GridViewCellClickEventArgs<TItem>>Cell click event
OnCellValueChangedEventCallback<GridViewCellValueChangedEventArgs<TItem>>Called after a cell value was changed in the GridEditMode.Cell edit mode, whether it is valid or not, after the saving of a valid value. The handler can declare the linked items to validate again with GridViewCellValueChangedEventArgs{TItem}.RevalidateItems(Func{TItem, bool}).
OnCommandClickEventCallback<GridViewCommandClickEventArgs<TItem>>Command click event
OnDeleteEventCallback<GridViewSelectionActionEventArgs<TItem>>Delete selected item(s) event
OnExportEventCallback<GridViewExportEventArgs>Export event
OnFilterChangedEventCallback<GridViewFilterChangedEventArgs>Gets or sets event indicate filters has changed
OnLoadExportProvidersAction<ExportProviderManager>Method called to initialise the export providers.
OnProfileLoadingAsyncFunc<GridViewProfileLoadingEventArgs, Task>Gets or sets the callback raised just before a profile is applied to the grid (initialization, selection by the user, default profile after the removal of the current one): it can exclude profile elements from the loading and choose whether the excluded elements keep their current state or get their default value. If it throws, the exception is shown and the whole profile is loaded.
OnRowSelectionEventCallback<GridViewSelectionEventArgs<TItem>>Gets or sets event rised when selection has changed
OnRowStateChangedEventCallback<GridViewRowStateChangedEventArgs<TItem>>Row state change event
OnRowUpdateEventCallback<GridViewItemActionEventArgs<TItem>>Row update data event
OnSortChangedEventCallback<GridViewSortEventArgs>Gets or sets the event raised when the user changes the sort (column header) or when a profile is applied. Not raised by the initial load.
OnValueAddEventCallback<GridViewItemActionEventArgs<TItem>>Add data event
OnValueChangingAsyncFunc<GridViewValueChangingEventArgs<TItem>, Task>Called when a cell value is changing.
PagerOnTopbool?Gets or sets if the pager is shown on top or not
PaginationButtonCountintGets or sets number of pagination buttons
PaginationSizeSelectorint[]Gets or sets the allowed number of the row by page when the paging feature is activated.
ProfileFeaturesGridFeature?Gets or sets the elements saved in and loaded from the profiles: GridFeature.Filter, GridFeature.Sort, GridFeature.Move (column order), GridFeature.Visibility, GridFeature.Freeze, GridFeature.Resize (column width), GridFeature.Group and GridFeature.Paging (page size); the other flags are ignored. GridFeature.Move and GridFeature.Freeze go together (the frozen columns are the first ones of the column order): excluding one excludes the other. Unlike Features, an excluded element stays available to the user: it's left out of the profiles and, when a profile is loaded, keeps its current state (unless OnProfileLoadingAsync asks for the default value). If undefined, the GridViewBehaviour.Options.ProfileFeatures value is used (all the elements by default).
ProfileIdstringGets or sets gridview profile Id.
ProfileSaveModeGridViewProfileSave?Gets or sets profile save mode
RowCanEditSelectorFunc<TItem, bool>Gets or sets a selector deciding whether a whole row can be edited, from its bound item. A row for which the selector returns false cannot enter edit mode; combine with the column LgGridBaseColumn{TItem}.CanEditSelector for per-column control. null means every row can be edited.
RowCssClassSelectorFunc<int, TItem, string>Gets or sets the row CSS class selector callback.
SelectableRowsboolGets or sets weither rows are selectable or not (Default is false)
SelectionICollection<TItem>Gets or sets list of the selected items
SharedProfileAdministratorPolicystringPolicy required to add and edit shared profile
SharedProfileFilterGridViewSharedProfileFilterManage shared profile access
ShowFiltersboolGets or sets if the filters are visible (two-way binding). Hiding the filters clears them.
ShowFiltersChangedEventCallback<bool>Gets or sets the event raised when the filters visibility changes (two-way binding of ShowFilters).
ShowFiltersSummarybool?Gets or sets the show filters summary activation
StateIdstringGets or sets unique identifiant to keep grid state.
StorageModeGridViewProfileStorage?Profile storage
ToolbarSelectionRenderFragmentGets or sets the additionnal actions for the toolbar (bottom)
Virtualizebool?Gets or sets if the body rows are virtualized (only the visible rows are rendered). If undefined, the GridViewBehaviour.Options.Virtualize value is used. Not applied when the grid uses grouping.
VirtualizeItemSizefloat?Gets or sets the estimated height (in pixels) of a row used by the virtualization. If undefined, the GridViewBehaviour.Options.VirtualizeItemSize value is used.
VisibleExportListstringGets or sets the list of provider IDs (separated by commas) that are disabled by default and should be enabled. Example : "xlsx,csv"
WrapContentboolGets or sets wrapping of the content. (Default is false)

Paramètres en cascade​

ParamètreTypeDescription
ParentPolicyLgAuthorizeViewPotential policies defined by an ancestor

Paramètres hérités de LgFrame​

ParamètreTypeDescription
AdditionalAttributesIReadOnlyDictionary<string, object>Gets or sets a collection of additional attributes that will be applied to the created element.
ButtonSizeButtonSize?Gets or sets the size of the toolbar buttons. When omitted, the application default (Application.ApplicationBehavior.FrameToolbarButtonSize) is used.
ChildContentRenderFragmentGets or sets the content (render)
ChildCssClassstringGets or sets the child content class
CollapsableboolGets or sets if the frame can be collapsed
CollapsedboolGets or sets the frame state (true for collapsed)
CollapsedChangedEventCallback<bool>Handle the binding of the frame collapsed.
CssClassstringGets or sets the frame css class
DefaultCollapsedbool?Gets or sets the default collapsed value for the frame
FooterContentRenderFragmentGets or sets the footer(render)
HeaderContentRenderFragmentGets or sets the header (render)
HeaderCssClassstringGets or sets the header class
IconNamestringGets or sets the frame icon name
KindKindGets or sets the kind of the frame
OnCommandEventCallback<CommandEventArgs>Gets or sets the method to call when a command is received.
OnToggleEventCallback<ToggleFrameEventArgs>Event callable on toggle frame for client app
ShowHeaderboolGets or sets the frame collapsable value
SummaryContentRenderFragmentGets or sets the summmary content (render)
TitlestringGets or sets the frame title
TitleContentRenderFragmentGets or sets the title content.
ToolbarRenderFragmentGets or sets the frame toolbar

Paramètres hérités de LgAriaComponentBase​

ParamètreTypeDescription
AriaLabelstringGets or sets aria label
AriaLabelledBystringGets or sets id of component for aria label