Displays data in a grid.
Component mode: Grid
Appearance
Overview
Excel export
The excel export button is in the upper right corner. It is shown by default, but can be hidden by grid settings.
Row links
Row links are clickable icons that are displayed on each row. If there are more rowlinks than the maximum available space (adjustable by a setting), the ...-button is displayed which gives access to the rest of the rowlinks. If a row link is not relevant on every row, you can hide it on a per-row basis.
Checkboxes
You can choose to display a column of checkboxes. These allow for operations on multiple rows at once. In this example, the top button "Set tax status" is used to set the tax status of the cars that the user has checked.
Order
To sort by a column, you click it's heading. To reverse the order you click it again.
Grouping
The user can choose one column to group by. The column will then be removed from the grid, and it's values will instead appear as headings. In this example the "Fuel" column has been choosen. You can specify a default grouping in the grid settings.
Paging
The total number of rows is always shown (384 in this example). If it's too many to display at once, the grid will divide the results into pages. The default page size is 50 rows, but it can be customized. In this example the page size has been set to six rows. Hence the total number of pages is 384/6 = 64.
To navigate, there are clickable arrows for previous/next page, and a textbox where you can type an arbitrary page number (after the word "Page" in the screenshot). You can also use the PgUp/PgDown keys move to previous/next page, and Home/End for the first/last page.
Sums and other aggregates
You can choose to display a sum below any numerical column, which will be automatically computed by the platform. If you need other forms of aggregation (other than simple addition) you can provide the aggregate values manually.
Color and style
You can set the color for specific rows and cells. In this example the cells in the Brand column are given different colors for different brands, while the whole row is grayed out for cars with status = Sold. In addition to color you can set arbitrary css-style attributes for whole rows as well as individual cells. Using these attributes you can make quite remarkable changes to the grids appearance. Artistic restraint is advised.
Tooltip
You can set the tooltip text for individual cells, row links and columns headings. In this example the user gets additional information about the model by hoovering the mouse over the Model cell.
Extra text
You can provide extra text about a row in the grid, that shows up on demand. Existence of extra text is indicated by a down-arrow that appears in it's own column.
When you click the arrow, the text appears inserted below the corresponding row like this:
The extra text can include html formatting if needed.
Column groups
The columns of a grid can be assigned column groups. This can save horizontal space (in this example, the words "Owner" and "Previous owner" don't have to be repeated for each column).
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
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.
May modify database:
No
Parameters
@IsForExcelExport
bit
Is set to 1 when procedure is called to retrieve grid data for Excel-export.
@OrderBy
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}.
The contents of the first column returned is required to be unique for each row when used together with {selecteditems}.
Table count:
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.
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.
At most one of _Tooltip and _TooltipHtml can be set for the same cell.
At most one of _Tooltip and _TooltipHtml can be set for the same cell.
<colname>_TooltipHtml optional string
Same as <colname>_Tooltip, but will convert HTML into plain text.
<br> will become a newline, and HTML encoding will be translated ("ä" will become "ä" for example). All other HTML styling will be ignored.
At most one of _Tooltip and _TooltipHtml can be set for the same cell.
<br> will become a newline, and HTML encoding will be translated ("ä" will become "ä" for example). All other HTML styling will be ignored.
At most one of _Tooltip and _TooltipHtml can be set for the same cell.
<colname>_MenuItemId optional int
Legacy don't use this for new development. Create a cell link connected to a column instead. If dynamic columns are being used use <colname>_LinkId instead.
<colname>_LinkId optional int
If possible you should create a cell link connected to a column instead. If dynamic columns are being used use this column.
Creates a link with the specified LinkId for the <colname> cell.
Creates a link with the specified LinkId for 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. See Colors.
<colname>_Style optional string
Sets the CSS style for the <colname> cell. Never use a string from a user as part of this column for security reasons.
<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.
Use the menu item "Admin>Theme>System icons" to register system icons.
<colname>_IconColor optional string
Color to use for the icon specified in <colname>_Icon. See Colors.
Row_Color optional string
Sets the text color of the entire row. See Colors.
Row_Style optional string
Sets the CSS style for the entire row. Never use a string from a user as part of this column for security reasons.
<colname>_IsEditable optional bit
Can be used to prevent editing of a grid cell in a column that would normally be editable. Use the Row_IsEditable column instead if you want to disable all cells on the row.
"Editable" must be set for the the field info, otherwise this column has no effect.
Row_CheckboxDisabledReason optional string
Sets the tooltip of a disabled checkbox.
Can only be set when Row_EnableCheckbox is set to 0.
Can only be set when Row_EnableCheckbox is set to 0.
Row_EnableCheckbox optional bit
Determines if a checkbox will be enabled/disabled for the row. Only grids with show checkboxes enabled can enable/disable checkboxes. Combine with Row_CheckBoxDisabledReason to clarify the reason the checkbox is disabled.
It is not allowed to explicitly set this to 0 or 1 if the grid has show checkboxes disabled, even if it has been done dynamically.
It is not allowed to explicitly set this to 0 or 1 if the grid has show checkboxes disabled, even if it has been done dynamically.
Default: By default checkboxes will be enabled if show checkboxes is enabled.
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 and not null for each row when using Row_ExtraHtml.
At most one of Row_ExtraText and Row_ExtraHtml can be set for the same row.
The HTML starts hidden. The user can toggle the visibility.
The contents of the first column returned is required to be unique and not null 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 and not null for each row when using Row_ExtraText.
At most one of Row_ExtraText and Row_ExtraHtml can be set for the same row.
The text starts hidden. The user can toggle the visibility.
The contents of the first column returned is required to be unique and not null 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. Use the <colname>_IsEditable column if you need to control the editability of a single cell instead.
Default: By default all rows are editable.
Row_IsEditing optional bit
If set to 1 the grid will start in edit mode with the first control of this row focused.
Row_ListViewHtml optional string
Specifies the body for a custom row description for the list grid (that is, the mobile grid). Can be used together with Row_ListViewTitle or by iteslf. Mutually exclusive with Row_ListViewText.
Row_ListViewText optional string
Specifies the body for a custom row description for the list grid (that is, the mobile grid). Usually used together with Row_ListViewTitle. Mutually exclusive with Row_ListViewHtml.
Row_ListViewTitle optional string
Specifies a custom row title for the list grid (that is, the mobile grid). If you do not specify at least one of Row_ListViewTitle, Row_ListViewText or Row_ListViewHtml then the first visible column will become the row title.
Row_ShowCheckbox optional bit
Determines if a checkbox will be shown for the row. Only grids with show checkboxes enabled can show checkboxes.
It is not allowed to explicitly set this to 1 if the grid has show checkboxes disabled, even if it has been done dynamically.
It is not allowed to explicitly set this to 1 if the grid has show checkboxes disabled, even if it has been done dynamically.
Default: By default checkboxes will be shown if show checkboxes is enabled.
Resultset: Number of rows (optional)
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.
Table count:
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 (optional)
Makes it possible to add rows with aggregate information below the main rows.
Table count:
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 (optional)
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.
NOTE: This must be the third resultset or later. You must return a row count resultset in order to use this feature.
Table count:
repeated zero or more times
Row count:
zero or more rows
Columns
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.
AllowHtml optional bit
Allow HTML.
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.
DefaultValueSql optional string
SQL that evaluates default value for field. Can contain other fields for value dependency.
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. It is usually recommended to use FieldInfoId instead unless the column is used to make fields hidden or uneditable.
| Possible value | Description |
|---|---|
| boolean checkbox | Legacy alias. Use "checkbox" instead. |
| boolean dropdown | |
| chart | |
| checkbox | |
| Checkbox tree | |
| colorpicker | |
| date | |
| datetime | |
| dropdown | |
| file | |
| heading | |
| heading with checkbox | |
| hidden | |
| html | |
| info text | |
| listbox | |
| multi-listbox | |
| multi-picker | |
| multirow | |
| password | |
| picture | |
| radio buttons | |
| textarea | |
| textbox | |
| textbox with autosearch | |
| textbox with autosuggest | |
| textbox with dropdown | |
| textbox with popup | |
| time | |
| uneditable text |
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 |
|---|---|
| Default | Inherit layout from menu item. |
| LabelAbove | Full width, label above. |
| LabelLeft | Label to the left. |
| NoLabel | Full width, no label. |
| Standard | Deprecated. Use LabelLeft instead. |
IsEditable optional bit
Controls whether the control is editable in Editable Grid/Editable Info Boxes.
MandatoryJavaScript optional string
JavaScript that controls the mandatory status of the field, this overwrites nullchoice if set. This is only available to control types for which the mandatory JavaScript field is visible in the user interface.
MaxDate optional date
Only applicable to the Date and Datetime controls.
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.
MinDate optional date
Only applicable to the Date and Datetime controls.
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.
TimePickerFrom optional string
Only applicable to the Time and Datetime controls.
TimePickerTo optional string
Only applicable to the Time and Datetime controls.
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 (optional)
Table count:
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.
May modify database:
No
Parameters
@Force
bit
Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.
@ValidateParams
bit
Set to 1 when this call is made.
Resultset: Messages (optional)
Table count:
repeated zero or one time
Row count:
zero or one row
Columns
ADMIN_Force optional string
Message asking the end user to confirm their parameters.
ADMIN_Message optional string
Message explaining why the parameters are rejected.
InfoSQL
SQL Call: InfoSQL
SQL that can have several resultsets that are displayed at top of component.
May modify database:
No
Parameters
@IsParameterPage
bit
Will be set to 1 when the call is made for the parameter page.
Resultset: Main title
Specifies the main title, which usually is the name of the entity being shown or edited by the menu item.
Table count:
repeated exactly once
Row count:
exactly one row
Columns
maintitle optional string
The main title.
Resultset: Box (optional)
Defines one or more boxes to display.
Table count:
repeated zero or more times
Row count:
one or more rows
Columns
Title optional string
The title of the box.
TitleIcon optional string
The name of a system icon to display next to the box title.
TitleIconId optional int
Deprecated. Use TitleIcon instead.
Displays an icon next to the box title.
Displays an icon next to the box title.
TitleIconBadgeId optional int
Deprecated. Avoid using badge icons.
Override menu item badge.
Override menu item 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.
BoxLink optional string
Displays the link with the specified alias in the title row of the box.
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>.
Only one BoxLink per box can be used.
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>.
Only one BoxLink per box can be used.
LinkId optional int
Deprecated. Use TopLink/BoxLink instead.
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>.
Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.
Multiple LinkId columns may appear in a single resultset.
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>.
Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.
Multiple LinkId columns may appear in a single resultset.
TopLink optional string
Displays the link with the specified alias among the top links.
Multiple TopLink columns may appear in a single resultset.
Multiple TopLink columns may appear in a single resultset.
IsPrimaryTopLink optional bit
Used in conjunction with "TopLink" to mark it as a primary link. Only one link may be marked as primary.
TopLinkDisabledReason optional string
If not null the the top link will be disabled with the tooltip of the disabled button set to the content of the column.
Default: null, enabled.
MenuItem optional string
Recommended to use TopLink/BoxLink instead for better tracking of links.
Displays a link to the menu item with this alias 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.
Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.
Multiple MenuItem columns may appear in a single resultset.
Displays a link to the menu item with this alias 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.
Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.
Multiple MenuItem columns may appear in a single resultset.
MenuItemId optional int
Deprecated. Use TopLink/BoxLink instead.
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.
Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.
Multiple MenuItemId columns may appear in a single resultset.
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.
Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.
Multiple MenuItemId columns may appear in a single resultset.
NavigatorLinkText optional string
Deprecated. Use TopLink with a link label instead.
Used in combination with menuitem/menuitemid to give the navigator link a text that differs from the name of the menu item.
Used in combination with menuitem/menuitemid to give the navigator link a text that differs from the name of the menu item.
PassingFields optional string
Additional information to menuitem/menuitemid, appends values to querystring (supports simple Softadmin® parameters).
If multiple passingfield columns exists, only the first one is used and the others are disregarded.
If multiple passingfield columns exists, only the first one is used and the others are disregarded.
<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. See Colors.
<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.
Use the menu item "Admin>Theme>System icons" to register system icons.
<colname>_IconColor optional string
Color to use for the icon specified in <colname>_Icon. See Colors.
<colname>_CellLink optional string
Displays the link with the specified alias as a cell link for the <colname> cell.
PassingField_<xxx> columns can be referenced from the link.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
PassingField_<xxx> columns can be referenced from the link.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_LinkId optional int
Deprecated. Use <colname>_CellLink instead.
Creates a cell link with the specified link id for the <colname> cell.
PassingField_<xxx> columns can be referenced from the link.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
Creates a cell link with the specified link id for the <colname> cell.
PassingField_<xxx> columns can be referenced from the link.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_MenuItem optional string
Recommended to use <colname>_CellLink instead for better tracking of links.
Supplies a link to the menu item with the specified alias when used in conjunction with <colname>.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
Supplies a link to the menu item with the specified alias when used in conjunction with <colname>.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_MenuItemId optional int
Deprecated. Use <colname>_CellLink or <colname>_MenuItem instead.
Supplies a link to the menu item with the specified menuitemid when used in conjunction with <colname>.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
Supplies a link to the menu item with the specified menuitemid when used in conjunction with <colname>.
Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_PassingFields optional string
Supplies the querystring when used in conjunction with <colname>_MenuItemId.
<colname>_Style optional string
Sets the CSS style for <colname>. Never use a string from a user as part of this column for security reasons.
<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.
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.
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.
The SafeHtml column is less restrictive than the Html column. Use it only when you need it.
WarningSuccess optional string
The text will be at the top of the menu item and displayed in green.
WarningInfo optional string
The text will be at the top of the menu item and displayed in blue.
Warning optional string
The text will be at the top of the menu item and displayed in yellow. This will match any column prefixed with Warning that is not WarningSuccess, WarningInfo, and WarningError.
WarningError optional string
The text will be at the top of the menu item and displayed in red.
WarningLink optional string
Displays the link with the specified alias inside the warning.
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>.
Requires that the row only contains one warning.
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>.
Requires that the row only contains one warning.
StartExpanded optional bit
Whether the infobox should start expanded or collapsed. NULL/Omitted means default behavior, where all boxes are expanded on big screens, and only the first box is expanded on small screens.
ExternalEmbedHeight optional int
Used together with the ExternalEmbedUrl column to set the height (in pixels) of the generated frame.
ExternalEmbedUrl optional string
Embeds content from an external server as an iframe in the infobox. The URL must be an absolute URL.
Kpi optional string
Json to generate a kpi. See the documentation for the Detailview component for more details.
Meter optional string
Json to generate a row of meters. See the documentation for the Detailview component for more details.
PassingField_<xxx> optional string
Not shown in InfoSQL. The corresponding link should be of link type "Top link (InfoSQL)", "InfoSQL cell link" or "InfoSQL warning link", and one of its passing fields should have a value matching <xxx>, and be of type "Column value".
QrCode optional string
A QR Code will be rendered containing the text in the column.
To generate Swiss QR Code for digital payments, return an XML with the root attribute Type="Swiss". See example-XML in the documentation for the RTF Document component.
To generate Swiss QR Code for digital payments, return an XML with the root attribute Type="Swiss". See example-XML in the documentation for the RTF Document component.
Resultset: Dynamic field information (optional)
Specify extra properties for fields in the InfoSql.
Table count:
repeated zero or more times
Row count:
zero or more rows
Columns
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.
AllowHtml optional bit
Allow HTML.
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.
DefaultValueSql optional string
SQL that evaluates default value for field. Can contain other fields for value dependency.
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. It is usually recommended to use FieldInfoId instead unless the column is used to make fields hidden or uneditable.
| Possible value | Description |
|---|---|
| boolean checkbox | Legacy alias. Use "checkbox" instead. |
| boolean dropdown | |
| chart | |
| checkbox | |
| Checkbox tree | |
| colorpicker | |
| date | |
| datetime | |
| dropdown | |
| file | |
| heading | |
| heading with checkbox | |
| hidden | |
| html | |
| info text | |
| listbox | |
| multi-listbox | |
| multi-picker | |
| multirow | |
| password | |
| picture | |
| radio buttons | |
| textarea | |
| textbox | |
| textbox with autosearch | |
| textbox with autosuggest | |
| textbox with dropdown | |
| textbox with popup | |
| time | |
| uneditable text |
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 |
|---|---|
| Default | Inherit layout from menu item. |
| LabelAbove | Full width, label above. |
| LabelLeft | Label to the left. |
| NoLabel | Full width, no label. |
| Standard | Deprecated. Use LabelLeft instead. |
MandatoryJavaScript optional string
JavaScript that controls the mandatory status of the field, this overwrites nullchoice if set. This is only available to control types for which the mandatory JavaScript field is visible in the user interface.
MaxDate optional date
Only applicable to the Date and Datetime controls.
MinDate optional date
Only applicable to the Date and Datetime controls.
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.
TimePickerFrom optional string
Only applicable to the Time and Datetime controls.
TimePickerTo optional string
Only applicable to the Time and Datetime controls.
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 (optional)
Defines one or more links to be shown among the top links.
Table count:
repeated zero or more times
Row count:
zero or more rows
Columns
BoxLink optional string
See the "Box" resultset for documentation.
IsPrimaryTopLink optional bit
See the "Box" resultset for documentation.
LinkId optional int
Deprecated, Use TopLink instead.
See the "Box" resultset for documentation.
See the "Box" resultset for documentation.
MenuItem optional string
Deprecated. Use TopLink for better tracking of links.
Displays a link to the menu item with this alias among the top links. The title of the box will also turn into a link when the user hovers the mouse.
Displays a link to the menu item with this alias among the top links. The title of the box will also turn into a link when the user hovers the mouse.
MenuItemId optional int
Deprecated. Use MenuItem instead, or better yet, use TopLink 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.
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).
TopLink optional string
See the "Box" resultset for documentation.
TopLinkDisabledReason optional string
See the "Box" resultset for documentation.
Resultset: JavaScripts (optional)
InfoSQL can declare JavaScript used by the menu item.
Example
SELECT
'thirdPartyApi.showMap(street, city, country)' AS JavaScript,
StreetAddress AS street,
CityName AS city,
CountryName AS country
FROM
...
Table count:
repeated zero or more times
Row count:
zero or more rows
Columns
JavaScript optional string
A piece of JavaScript to execute as the page loads, or containing one or more function declarations that can be called by other scripts on the page.
LocalJavaScriptUrl optional string
An URL, relative to the system's admin/customization folder, specifying a JavaScript file that should be imported.
ExternalJavaScriptUrl optional string
An URL specifying a JavaScript file on another server that should be imported. Take care to use an URL that is reachable by the end user's web browser.
<parameterName> optional any
Any additional columns will become parameters with the same name made available to the JavaScript. The column name must start with a lowercase letter and may only contain letters, digits, or underscores.
The parameter columns must come after the JavaScript column.
The parameter columns must come after the JavaScript column.
Resultset: Timeline (optional)
Displays a timeline to visualize the current state of a process.
Each row represents one step in the timeline.
Each row represents one step in the timeline.
Table count:
repeated zero or one time
Row count:
one or more rows
Columns
Timeline mandatory any
The value of this column is not used and it's only purpose is to mark this as a timeline table.
StepStatus mandatory string
Specifies how the step will be visualized.
| Possible value | Description |
|---|---|
| Current | This is the current step. |
| Done | This step has been completed successfully. |
| Failed | Something went wrong in this step. |
| Future | This step is later on in the process. |
StepDescription optional string
Description of the step.
StepTitle optional string
Title of the step.
StepTooltip optional string
Tooltip of the step.
StepLink optional string
Alias of the link that the step leads to.
<xxx> optional any
Any other column will be sent as a passing field to the link.
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'.
May modify database:
Yes
Resultset: Access permissions
Return whether the user is allowed to visit the menu item with the current parameters.
Table count:
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.
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.
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.