Grid settings layout object

The grid settings layout object is a type of Basic Layout object. These objects can be used to customize how the grid settings dialog is shown in WorkWith, SubWorkWith, and Grid (WPD) interfaces.

When generating a grid K2BTools uses the grid settings layout object referenced in the work with layout, sub work with layout, or web panel designer layout (depending on the object generated). The grid settings layout is referenced via the "Grid Settings Layout" property.

The contents of this layout will be placed in the final UI in the location indicated in the grid layouts.

Layout contents

GridSettingsLayoutObject
Grid settings layout object

Component Type Control Name Usage
Image/Textblock Toggle This control will be used as the action that shows/hides the grid settings dialog.
Table ContentOuterTable This table will be the one shown/hidden when the grid settings dialog is opened and closed.
Table CustomizationContent This table must contain all the controls associated with the grid customization section: The AttributeContainer (used in the runtime columns selection feature), and the RowsPerPage and OrderBy variables. When none of these features are used in a panel, this section will be removed from the end web form.
Section/Table AttributeContainer This control will be used as a template to include attributes in the runtime columns selection section. This control must contain a variable named IsVisible, and must be inside the CustomizationContent control.
Variable RowsPerPage This variable will be used to implement the Rows Per Page feature if needed. It will be deleted if not necessary in the final panel.
Variable OrderBy This variable will be used to implement the OrderBy feature if needed. It will be deleted if not necessary in the final panel.
Button Save Will be used as the save/apply button for the grid settings customization section. This control should be inside the CustomizationContent table.
Section/Table SavedGridViewContainer

This section is optional.

This section must contain all elements related with the saved grid views feature. If this feature is not enabled, this section will be deleted from the final web form.

If this section is not included in the layout, the saved grid views feature will not be available.

Section/Table NoSavedGridViewsSection This section contains the empty state for the saved grid views list: If no saved grid views exist, this section will be shown instead of that list. This section is optional. If it is not included, nothing will be shown in that case.
Free style grid SavedGridViews

This grid will show the saved grid views in runtime. It must exist if the SavedGridViewContainer is included in the layout.

This grid must contain these controls (included later in this table):

  • DeleteGridView
  • SavedGridViewId
  • SavedGridViewName
  • SavedGridViewNameTB
Image DeleteGridView This image must be included in the SavedGridViews grid. This image will be used as the delete grid view action.
Variable SavedGridViewId This image must be included in the SavedGridViews grid. It should be included in a way that prevents it from being visible in the final form (for example, assigning classes that make it invisible).
Variable SavedGridViewName This variable should be included in the SavedGridViews grid. It will be used to display the saved grid view name to the end user. Either this control or the SavedGridViewNameTB textblock must be included in the layout.
Textblock SavedGridViewNameTB This variable should be included in the SavedGridViews grid. It will be used to display the saved grid view name to the end user. Either this control or the SavedGridViewName variable must be included in the layout.
Variable SavedGridViewDraftName This variable will be used by the end user to enter the name that should be used to create a new view.
Button SaveGridViewAction This button will be the one used to save a new grid view.