Component: Grid

 Show all Hide all

Displays data in a grid.

Component mode: Grid

Supported modes: Grid | Editable Grid

Checkboxes (selecteditems)

You can use the grid setting Show checkboxes to enable checkboxes on a menu item.

The grid menu item can pass the ids of its selected rows, for historical reasons commonly referred to as selecteditems via links from the grid to other menu items. These menu items then access these ids as a comma-separated string.

Row Ids

Checkboxes use the values from the first grid column as row ids. Row ids must be unique unless they are NULL. Any row with NULL in the first column will not show a checkbox.

Warning

The row ids that you access through selecteditems are ID values of rows that were valid when the user loaded the grid. No validation is performed to ensure that the ID values are still valid, that their rows would still be visible if the user reloads the grid.

For example, you have a grid of unsent invoices and a top-link "Send all checked invoices". The user checks a few rows and then clicks the top link. Now, the checked invoices are sent, and their rows will no longer appear in the grid, but the grid still remembers the IDs of the checked rows. If the user checks a few more rows and clicks the top link again then the Send-menuitem will receive both the IDs of the invoices already sent and the new IDs. You can avoid this by using the execute component's special column admin_unselectall to clear all checkboxes.

Component settings

Cid nexus
Alters the history of the back button (the cid chain). The second time you open a menuitem that is part of a nexus entries will be deleted from your history so that the history is the same as when you first entered the nexus.
Possible value Description
1 The menuitem forms a nexus with itself as the only member.
-1 The menuitem is not part of a nexus. (default)
1000-1999 The menuitem forms a nexus together with all other menuitems with the same value for Cid nexus.
Enable row caching
Whether grid contents should be cached. Grids faster than a few seconds are never cached.
Excel export format
The format of the generated Excel file. The default value is taken from the ExcelExportDefaultDocType application variable.
Possible value Description
xlsx The document is generated as a Microsoft Excel 2007 (*.xlsx) document. InfoSql and style information will be rendered.
text The document is generated as tab separated text. InfoSql and style information will not be rendered. This mode causes a warning when opened in Microsoft Excel 2007 and later versions.
Number of fields to hide
Hides the specified number of fields, starting with the first.
Number of rows per page
The number of rows to show per page. The default value is taken from the RowRetrieve application variable.
Number of visible row links
The maximum number of links to show per row. Any additional links are made available in the Navigator.

SQL

SQL Call: Retrieve grid data (mandatory)

Call made to retrieve the data to display in the grid.
Supports custom errors: No
May modify database: No

Parameters:

@IsForExcelExport optional bit
Is set to 1 when procedure is called to retrieve grid data for Excel-export.
@OrderBy mandatory string
Comma separated list of columns to sort the result by. Is only set when "Sort in procedure" is activated.

Resultset: Grid data

The data to display in the grid.

The contents of the first column returned is required to be unique for each row when used together with {selecteditems}.
Repeat mode: repeated exactly once
Row count: zero or more rows

Columns:

<colname> optional string
Column to display in the grid.
<colname>_DisplayValue optional any
When present, the value in this column is displayed instead of the value in <colname> in the grid. This is most useful for Editable Grid, where you'd for example want the StatusId column to be edited as an integer with the status id, but displayed as the status name.

If present, this column is used when sorting <colname> unless the <colname>_SortOrder column is also present.
<colname>_SortOrder optional any
If present, this column is used when sorting <colname>. This column is not shown in the grid, and can be of any type.
<colname>_Tooltip optional string
Sets the tooltip in the <colname> cell.
<colname>_MenuItemId optional int
Creates a link to the specified menu item in the <colname> cell.
<colname>_PassingFields optional string
Querystring when used in conjunction with <colname>_MenuItemId.
<colname>_Color optional string
Sets the text color of <colname> to the specified color using #RRGGBB color code or HTML color name. If using color names then you must use American spellling (for example gray, not grey).

In general using well picked color codes will give better results than color names, as for example the colors "red" and "green" are too bright for a good user experience.
<colname>_Style optional string
Sets the CSS style for the <colname> cell.
<colname>_Icon optional string
The name of the system icon to show in the <colname> cell.

Use the menu item "Admin>Theme>System icons" to register system icons.
<colname>_IconColor optional string
Color in #RRGGBB format to use for the icon specified in <colname>_Icon.
Row_Color optional string
Sets the text color of the entire row to the specified color using #RRGGBB color code or HTML color name. If using color names then you must use American spellling (for example gray, not grey).
Row_Style optional string
Sets the CSS style for the entire row.
<colname>_LinkId optional int
Creates a link with the specified linkid for the <colname> cell.
Row_ExtraHtml optional string
Layouted HTML shown below the current row.

The HTML starts hidden. The user can toggle the visibility.

The contents of the first column returned is required to be unique for each row when using Row_ExtraHtml.
At most one of Row_ExtraText and Row_ExtraHtml can be set for the same row.
Row_ExtraText optional string
Text shown below the current row.

The text starts hidden. The user can toggle the visibility.

The contents of the first column returned is required to be unique for each row when using Row_ExtraText.
At most one of Row_ExtraText and Row_ExtraHtml can be set for the same row.
Row_IsEditable optional bit
Determines if the row is editable in editable grid mode.
By default all rows are editable.

Resultset: Number of rows

Mandatory when the grid data is sorted in the procedure (with @OrderBy). Should not be returned when the grid data is sorted in the application.
Repeat mode: repeated zero or one time
Row count: exactly one row

Columns:

<column with ordinal 1> mandatory int
The number of rows returned by the query.

Resultset: Aggregate rows

Makes it possible to add rows with aggregate information below the main rows.
Repeat mode: repeated zero or one time
Row count: one or more rows

Columns:

<colname> optional string
Value to show in column <colname> if it exists.
<colname>_Tooltip mandatory string
Sets the tooltip in the <colname> cell.
ADMINAggregate mandatory string
The caption to use for this row.
ADMINPhraseID optional string
Phrase ID to use for caption.

Resultset: Dynamic field information

Specify extra properties for fields in the grid.

NOTE: This must be the third resultset or later. You must return a row count resultset in order to use this feature.
Repeat mode:
Row count:

Columns:

<xxx> optional string
Set property <xxx> for the field specified in adminfieldname. If set to null the value will not be applied.
AdminFieldName mandatory string
The name of the field to apply the information to. The presence of this column indicates that the resultset specifies field information.
ButtonJavaScript<xxx> optional string
Inserts a button next to the control that is used to execute the JavaScript supplied here. <xxx> is an arbitrary text that can be empty if only one button is required.
ButtonJavaScript<xxx>_Label optional string
The label for the JavaScript button <xxx>.
CellAlignment optional string
Specifies the alignment of the text in the field.
Possible value Description
Center Center aligned.
Left Left aligned.
Right Right aligned.
ColumnTooltip optional string
Sets the tooltip on the column title. Only supported by the Grid component.
DefaultValue optional string
The default value for the control or if prefixed by 'SQL:' the sql to run to determine the default value.
Description optional string
The description for the field.
EnabledJavaScript optional string
Javascript that controls the enabled status of the field. The control is only enabled if the expression specified here evaluates to true. The expression is evaluated every time the value of a dependent control is changed. This is only available to control types for which the enabled javascript field is visible in the user interface.
FieldGroupId optional int
The field group to use.
FieldInfoId optional int
ID of field information to base the dynamic field on. All properties not explicitly overridden by dynamic field information will be copied from this field. The referenced field must be found in the menu item's field tables.
FieldLabel optional string
If present the field label is used as the heading for fields instead of the field name.
FieldType optional string
The name of the control type to use.
Height optional int
The height of the control.
IgnoreOnSave optional bit
Do not pass the field value to the insert/update procedure.
InfoSqlLayout optional string
Where the label is shown in relation to the contents in InfoSQL.
Possible value Description
LabelAbove Full width, label above.
NoLabel Full width, no label.
Standard Label to the left.
IsEditable optional bit
Controls whether the control is editable in Editable Grid/Editable Info Boxes.
MaxDate optional date
For date controls, the latest date that the user can enter.
MinDate optional date
For date controls, the earliest date that the user can enter.
MultipleFiles optional bit
For file upload controls, determines whether they allow multiple or a single file.
NullChoice optional bit
Specifies whether the control allows null values.
NumberOfDecimals optional int
The number of decimals to display for numeric values.
OnChangeJavaScript optional string
Javascript run when the value of the control has changed.
OutputFormat optional string
Special formatting to be applied when the field is displayed.
Possible value Description
Hyperlink
MailToLink
PhoneLink
Placeholder optional string
Text shown when the field is empty.
Sql optional string
The SQL that determines the control's behavior. (Refer to control documentation for more information)
TempTableName optional sysname
For multirow and multicontrol, changes the nameof the temp table used when saving its contents. Does nothing when UseTempTable=0 or for other control types.
ThousandDelimiter optional string
The thousand grouping delimiter for numeric values.
Width optional int
The width of the control.
VisibleJavaScript optional string
JavaScript that controls the visibility of the field. The control is only visible if the expression specified here evaluates to true. The expression is evaluated every time the value of a dependent control is changed.

Resultset: File name

Repeat mode: repeated zero or one time
Row count: zero or one row

Columns:

ADMINFilename optional string
Name to use if the grid is exported to Excel. Should not end with a file extension.

SQL Call: Validate parameters

Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and 'Validate parameters' is checked.
Supports custom errors: No
May modify database: No

Parameters:

@force optional bit
@validateparams mandatory bit
This parameter is set to 1 by Softadmin® when this call is made.

Info SQL

SQL Call: InfoSql (2008)

SQL that can have several resultsets that are displayed at top of component.
Supports custom errors: No
May modify database: No

Resultset: Main title

Specifies the main title.
Repeat mode: repeated exactly once
Row count: exactly one row

Columns:

maintitle optional string
The main title.

Resultset: Box

Defines one or more boxes to display.
Repeat mode: repeated zero or more times
Row count: one or more rows

Columns:

Title optional string
The title of the box.
TitleIconId optional int
Displays an icon next to the box title.
TitleIconBadgeId optional int
Override menuitem badge.
ColumnSpan optional int
Specifies the column span for the box. If this is above one the box will be displayed on a separate row.
LinkId optional int
Displays the specified link among the top links and in the title row of the box. The link will only appear in the title row if no ordinary columns lie before it in the resultset.

Columns named PassingField_<xxx> will not be shown in the box and can be referenced from the link as a Column value with name <xxx>.

LinkId and MenuItemId can not be used at the same time.

Multiple LinkId columns may appear in a single resultset.
MenuItemId optional int
Recomended to use LinkId instead for better tracking of links.

Displays a link to the menu item with this id among the top links and in the title row of the box. The link will only appear in the title row if no ordinary columns lie before it in the resultset.

LinkId and MenuItemId can not be used at the same time.

Multiple MenuItemId columns may appear in a single resultset.
NavigatorLinkText optional string
Used in combination with menuitemid to give the navigator link a text that differs from the name of the menu item.

If explicitly set to NULL the link will not be shown in the navigator but may still appear as a link in the title of a box.
PassingFields optional string
Additional information to 'menuitemid', appends values to querystring (supports simple Softadmin® parameters).

Multiple passingfield columns may appear in a single resultset. Passingfields will normally be connected with the closest preceeding menuitemid column, but see the note below regarding the title link.

NOTE: The first passingfield column will be used for the title link regardless of whether there is another menuitemid column in between.
<colname> optional string
Value displayed in the box with heading defined by field information or column name.
<colname>_Color optional string
Sets the text color of <colname> to the specified color using #RRGGBB color code or HTML color name. If using color names then you must use American spellling (for example gray, not grey).
<colname>_Icon optional string
The name of the system icon to show before the <colname> value.

Use the menu item "Admin>Theme>System icons" to register system icons.
<colname>_IconColor optional string
Color in #RRGGBB format to use for the icon specified in <colname>_Icon.
<colname>_LinkId optional int
Creates a cell link with the specified link id for the <colname> cell.

PassingField_<xxx> columns can be referenced from the link.

<colname>_LinkId and <colname>_MenuItemId can not be used at the same time.
<colname>_MenuItemId optional int
Supplies a link to the menu item with the specified menuitemid when used in conjunction with <colname>.
<colname>_PassingFields optional string
Supplies the querystring when used in conjunction with <colname>_MenuItemId.
<colname>_Style optional string
Sets the CSS style for <colname>.
<colname>_Tooltip optional string
Sets the tooltip for <colname>.
PlaintextFull, PlaintextLeft, PlaintextRight optional string
These columns are deprecated. Use either PlainText, Html or SafeHtml instead, depending on what behavior you need.

The content of this column will be treated as Html, but line breaks and non-breaking spaces will be converted to br-tags. In future versions this column will be escaped.
PlainText optional string
Displays plain text without a column title, i.e. occupies the entire vertical space available in the box. Any HTML in the text will be escaped.
Html optional string
Displays HTML without a column title, i.e. occupies the entire vertical space available in the box. Uses the Layouted HTML level to determine allowed elements and attributes.

If the Html-column is too restrictive for your needs then use the SafeHtml-column instead.
SafeHtml optional string
Displays HTML without a column title, i.e. occupies the entire vertical space available in the box. Uses the Safe HTML level to determine allowed elements and attributes.

The SafeHtml-column is less restrictive than the Html-column. Use it only when you need it.
WarningInfo optional string
The text will be at the top of the menuitem and displayed in blue.
Warning optional string
The text will be at the top of the menuitem and displayed in yellow.
WarningError optional string
The text will be at the top of the menuitem and displayed in red.
Javascript optional string
The column is hidden from the user and treated as a javascript to be included in the HTML.
StartExpanded optional bit
Whether the infobox should start expanded or collapsed. NULL/Ommited means default behavior, all expanded on big screens, only first expanded on small screens.
PassingField_<xxx> optional string
Can be used by links referenced by <colname>_LinkId or LinkId columns. Not shown in InfoSQL.
QrCode optional string
A QR Code will be rendered containing the text in the column.

Resultset: Dynamic field information

Specify extra properties for fields in the InfoSql.
Repeat mode:
Row count:

Columns:

<xxx> optional string
Set property <xxx> for the field specified in adminfieldname. If set to null the value will not be applied.
AdminFieldName mandatory string
The name of the field to apply the information to. The presence of this column indicates that the resultset specifies field information.
ButtonJavaScript<xxx> optional string
Inserts a button next to the control that is used to execute the JavaScript supplied here. <xxx> is an arbitrary text that can be empty if only one button is required.
ButtonJavaScript<xxx>_Label optional string
The label for the JavaScript button <xxx>.
CellAlignment optional string
Specifies the alignment of the text in the field.
Possible value Description
Center Center aligned.
Left Left aligned.
Right Right aligned.
ColumnTooltip optional string
Sets the tooltip on the column title. Only supported by the Grid component.
DefaultValue optional string
The default value for the control or if prefixed by 'SQL:' the sql to run to determine the default value.
Description optional string
The description for the field.
EnabledJavaScript optional string
Javascript that controls the enabled status of the field. The control is only enabled if the expression specified here evaluates to true. The expression is evaluated every time the value of a dependent control is changed. This is only available to control types for which the enabled javascript field is visible in the user interface.
FieldGroupId optional int
The field group to use.
FieldInfoId optional int
ID of field information to base the dynamic field on. All properties not explicitly overridden by dynamic field information will be copied from this field. The referenced field must be found in the menu item's field tables.
FieldLabel optional string
If present the field label is used as the heading for fields instead of the field name.
FieldType optional string
The name of the control type to use.
Height optional int
The height of the control.
IgnoreOnSave optional bit
Do not pass the field value to the insert/update procedure.
InfoSqlLayout optional string
Where the label is shown in relation to the contents in InfoSQL.
Possible value Description
LabelAbove Full width, label above.
NoLabel Full width, no label.
Standard Label to the left.
NullChoice optional bit
Specifies whether the control allows null values.
NumberOfDecimals optional int
The number of decimals to display for numeric values.
OnChangeJavaScript optional string
Javascript run when the value of the control has changed.
OutputFormat optional string
Special formatting to be applied when the field is displayed.
Possible value Description
Hyperlink
MailToLink
PhoneLink
Placeholder optional string
Text shown when the field is empty.
Sql optional string
The SQL that determines the control's behavior. (Refer to control documentation for more information)
ThousandDelimiter optional string
The thousand grouping delimiter for numeric values.
Width optional int
The width of the control.
VisibleJavaScript optional string
JavaScript that controls the visibility of the field. The control is only visible if the expression specified here evaluates to true. The expression is evaluated every time the value of a dependent control is changed.

Resultset: Dynamic top links

Defines one or more links to be shown among the top links.
Repeat mode: repeated zero or more times
Row count: zero or more rows

Columns:

LinkId optional int
See the "Box" resultset documentation.
MenuItemId mandatory int
Recomended to use LinkId instead for better tracking of links.

Displays a link to the menu item with this id among the top links. The title of the box will also turn into a link when the user hovers the mouse.
NavigatorLinkIconBadgeId optional int
Used in combination with menuitemid or LinkId to give the navigator link an icon that differs from the icon badge of the menu item.
NavigatorLinkIconId optional int
Used in combination with menuitemid or LinkId to give the navigator link an icon that differs from the icon of the menu item. Only one of navigatorlinkiconid and navigatorlinkiconname can have a value.
NavigatorLinkText optional string
Used in combination with menuitemid to give the navigator link a text that differs from the name of the menu item.
PassingField_<xxx> optional string
See the "Box" resultset documentation.
PassingFields optional string
Additional information to 'menuitemid', appends values to querystring (supports simple Softadmin® parameters).

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.
Supports custom errors: No
May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.
Repeat mode: repeated exactly once
Row count: exactly one row

Columns:

GrantAccess mandatory bit
1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.

URL

Querystring parameters

menuitemheading optional
String that replaces the menu item name when the menu item is loaded. It does not replace the name before that (like for example in the navigator). It is ignored if the menu item is displayed as a part in a multipart in which case the name can be set from the multipart procedure.