-
This component is not suitable for users who require assistive technologies.
-
This component is not suitable for use on mobile devices.
The Magic Box component is used as a planning tool, where users drag & drop boxes between containers.
For example, boxes could represent crates and containers represent delivery trucks, with rows representing fullfilment centers and columns representing shipping dates.
The component is more flexible in its layout than Planner or Calendar, but unlike the more specialized components it offers the end user no filters or date navigation tools out of the box.
Columns, rows, and containers
In its most basic form the component is laid out as a grid, with boxes placed in the cells. You can use the optional Containers table to customize individual cells in the grid, for example to set border or background color.
You can put multiple containers in the same cell, which makes each container a sub-column inside that cell, and then put boxes into the individual containers. You can use row span to make a container span over more than one grid row.
Drop groups
Drop groups are an advanced, optional feature, used when you have boxes that represent incompatible concepts. Boxes can only interact with boxes and containers assigned to the same drop group. For example, you could have different containers representing parking garages and docks, and boxes representing cars and boats, and then use drop groups to prevent users from putting a car in a dock.
The four drop groups are null, 'a', 'b', and 'c', so in the example above you might put cars and garages into the null group and boats and docks in the 'a' group.
Drop groups should only be used when it is immediately obvious to the end user which boxes and containers are incompatible, as the only visual indication they will get is that the cursor will indicate that a drop is not allowed when dragging a box over a container from another drop group.
Security considerations
The procedure must carefully check the values passed to the Drag and drop call.
An attacker can not inject their own id values: only boxes shown in the component can be dragged and they can only be dropped on containers shown in the component. An attacker can however manipulate any boxes that were shown when they opened the menu item, even if they would no longer be returned if the procedure was called again.
An attacker can forge a drag of any box dropped on any container. The CanDrag, CanReorder, CanDrop, and DropGroup columns are not enforced.
SQL
SQL Call: Initial layout (mandatory)
Gets columns, rows, containers, and boxes.
May modify database:
No
Resultset: Settings (optional)
Optional table with settings controlling the view.
Table count:
repeated zero or one time
Row count:
exactly one row
Columns
SyncId optional string
The id to listen for sync events on. Required when the component uses collaborative editing.
SyncTimestamp optional string
Arbitrary timestamp to keep track of the latest client sync moment. Required when the component uses collaborative editing.
BoxHeightMin optional decimal
Minimum height in units for a box.
LabelX optional string
Label on x-axis.
LabelY optional string
Label on y-axis. Only works properly in Internet Explorer.
ScaleX optional decimal
How many pixels to use for 1 width unit.
ScaleY optional decimal
How many pixels to use for 1 height unit.
TableLayout optional string
How boxes flow inside containers.
| Possible value | Description |
|---|---|
| BottomToTop | The first box starts at the bottom of the container, and following boxes are placed above it. |
| TopToBottom | The first box starts at the top of the container, and following boxes are placed below it. |
Resultset: Columns
Table count:
repeated exactly once
Row count:
one or more rows
Columns
BackgroundColor optional string
Default background color for column's containers. See Colors.
CanDrop optional bit
Default droppability for column's containers. If also specified for rows, both row and column must set CanDrop to 1 for a container be droppable.
ColumnID mandatory string
Column ID.
ColumnWidth optional decimal
Default width (in units) for column's containers.
HeadingHTML optional string
Column heading. Styled HTML. Overrides HeadingText column.
HeadingText optional string
Column heading. Plain text. Shown in bold.
LineColor optional string
Default color for column's containers's left and right border. See Colors.
ToolTip optional string
Column header tooltip. Plain text.
Resultset: Rows
Table count:
repeated exactly once
Row count:
one or more rows
Columns
BackgroundColor optional string
Default background color for row's containers. See Colors.
CanDrop optional bit
Default droppability for row's containers. If also specified for columns, both row and column must set CanDrop to 1 for a container be droppable.
HeadingHTML optional string
Row heading. Styled HTML. Overrides HeadingText column.
HeadingText optional string
Row heading. Plain text. Shown in bold.
LineColor optional string
Default color for row's containers's top and bottom border. See Colors.
RowHeight optional decimal
Default height (in units) for row's containers.
RowID mandatory string
Row ID.
ToolTip optional string
Row header tooltip. Plain text.
Resultset: Containers (optional)
Optional table with container information.
Containers are usually mapped to cells on a 1:1 basis, but you can have more than one container in the same cell if you need to.
You do not need to declare containers for every cell, only for those where you want to specify attributes (like heading text or passing fields).
Containers are usually mapped to cells on a 1:1 basis, but you can have more than one container in the same cell if you need to.
You do not need to declare containers for every cell, only for those where you want to specify attributes (like heading text or passing fields).
Table count:
repeated zero or one time
Row count:
zero or more rows
Columns
BackgroundColor optional string
Container's background color. See Colors.
BorderColor optional string
Container's border color. See Colors.
CanDrop optional bit
If boxes can be dropped on container.
ColumnID mandatory string
Column to show container in.
ContainerHeight optional decimal
Container's min height. Containers always expand to contain their boxes.
Container height defaults to the row-table's RowHeight value and there's usually no need to assign an explicit height to a container.
Container height defaults to the row-table's RowHeight value and there's usually no need to assign an explicit height to a container.
ContainerID optional string
Container ID. Useful if you show more than one container in the same cell.
ContainerWidth optional decimal
Container's width.
DropGroup optional string
Only boxes with the same drop group can be dropped into the container. Return NULL or omit the column to use the default drop group. See the section on Drop groups above for details.
HeadingHTML mandatory string
Container's heading. Styled HTML. Overrides HeadingText.
HeadingText mandatory string
Container's heading. Plain text.
RowID mandatory string
Row to show container in.
RowSpan optional int
How many rows the container should span over. If more than one container share the same cell then then all containers in that cell must have the same row span.
When using row span, you must not put any boxes or containers into the rows that you span over. That is, if you in column 1 on row 1 have a container with row span 2, then you can't put any boxes in column 1 on row 2, since that row is "covered" by the container above it.
When using row span, you must not put any boxes or containers into the rows that you span over. That is, if you in column 1 on row 1 have a container with row span 2, then you can't put any boxes in column 1 on row 2, since that row is "covered" by the container above it.
Stripes optional string
Resultset: Boxes
Table count:
repeated exactly once
Row count:
zero or more rows
Columns
BoxID mandatory string
Box ID.
BackgroundColor optional string
Box's background color. See Colors.
BorderColor optional string
Box's border color. See Colors.
BoxHeight mandatory decimal
Box height (in units). If smaller than the specified minimum height for boxes (see the first table) that height is used instead.
BoxHTML optional string
Box's content. Styled HTML. Overrides BoxText.
BoxLayoutedHTML optional string
Box's content. Layouted HTML. Overrides BoxText and BoxHTML.
BoxStyle optional string
CSS declaration. Must be well-formed CSS. Changing border width, padding, etc, will ruin box layout, so don't do it. Never use a string from a user as part of this column for security reasons.
BoxText optional string
Box's content. Plain text.
CanDrag optional bit
If the box can be dragged and dropped on containers where CanDrop = 1.
CanReorder optional bit
If the box can be dragged and reordered with regards to other boxes where CanReorder = 1
ColumnID optional string
Column to show box in. You must specify either RowID and ColumnID or ContainerID.
ContainerID optional string
Row to show box in. You must specify either ContainerID or RowID and ColumnID.
DropGroup optional string
Boxes can only be dropped into containers with the same drop group. Return NULL or omit the column to use the default drop group. See the section on Drop groups above for details.
RowID optional string
Row to show box in. You must specify either RowID and ColumnID or ContainerID.
ShadeBox optional bit
If true, semi-transparent stripes will be drawn above the box's background.
ToolTip optional string
Box's tooltip. Plain text.
SQL Call: Drag and drop
Called when user has dragged and dropped a box.
May modify database:
Yes
Parameters
@BoxIDDrag
string
Box that was dragged.
@BoxIDDrop
string
Box that the dragged box was dropped above/below.
@ColumnIDDrop
string
Column where box was dropped.
@ContainerIDDrop
string
Container where box was dropped.
@DropLocation
int
Where dragged box was dropped, in relation to the box it was dropped on.
| Possible value | Description |
|---|---|
| 1 | Below |
| -1 | Above |
@RowIDDrop
string
Row where box was dropped.
Resultset: Boxes (optional)
If present, a partial update of the page is made using the boxes contained in this table. Otherwise the whole box view is reloaded.
Note that partial updates can't be used together with ADMIN_FORCE. After the user has clicked OK the whole box view is always reloaded.
Table count:
repeated zero or one time
Row count:
zero or more rows
Columns
BoxID mandatory string
Box ID.
BackgroundColor optional string
Box's background color. See Colors.
BorderColor optional string
Box's border color. See Colors.
BoxHeight mandatory decimal
Box height (in units). If smaller than the specified minimum height for boxes (see the first table) that height is used instead.
BoxHTML optional string
Box's content. Styled HTML. Overrides BoxText.
BoxLayoutedHTML optional string
Box's content. Layouted HTML. Overrides BoxText and BoxHTML.
BoxStyle optional string
CSS declaration. Must be well-formed CSS. Changing border width, padding, etc, will ruin box layout, so don't do it. Never use a string from a user as part of this column for security reasons.
BoxText optional string
Box's content. Plain text.
CanDrag optional bit
If the box can be dragged and dropped on containers where CanDrop = 1.
CanReorder optional bit
If the box can be dragged and reordered with regards to other boxes where CanReorder = 1
ColumnID optional string
Column to show box in. You must specify either RowID and ColumnID or ContainerID.
ContainerID optional string
Row to show box in. You must specify either ContainerID or RowID and ColumnID.
DropGroup optional string
Boxes can only be dropped into containers with the same drop group. Return NULL or omit the column to use the default drop group. See the section on Drop groups above for details.
IsDeleted optional bit
Return 1 to remove a box from the page during a partial update.
RowID optional string
Row to show box in. You must specify either RowID and ColumnID or ContainerID.
ShadeBox optional bit
If true, semi-transparent stripes will be drawn above the box's background.
ToolTip optional string
Box's tooltip. Plain text.
Resultset: Raise sync entity (optional)
This SQL call may use SoftadminApi.SyncEntity_RaiseChanged.
Table count:
repeated zero or more times
Row count:
Columns
SQL Call: Client sync
Called when a sync entity change is raised for the entity and id that the component listens to.
May modify database:
No
Parameters
@Action
string
Will be set to 'ClientSync'.
@SyncId
string
The sync id that was retrieved from the initial SQL call.
@SyncTimestamp
string
The sync timestamp from when the component was last synced.
Resultset: Boxes (optional)
If present, a partial update of the page is made using the boxes contained in this table. Otherwise the whole box view is reloaded.
Table count:
repeated zero or one time
Row count:
zero or more rows
Columns
BoxID mandatory string
Box ID.
BackgroundColor optional string
Box's background color. See Colors.
BorderColor optional string
Box's border color. See Colors.
BoxHeight mandatory decimal
Box height (in units). If smaller than the specified minimum height for boxes (see the first table) that height is used instead.
BoxHTML optional string
Box's content. Styled HTML. Overrides BoxText.
BoxLayoutedHTML optional string
Box's content. Layouted HTML. Overrides BoxText and BoxHTML.
BoxStyle optional string
CSS declaration. Must be well-formed CSS. Changing border width, padding, etc, will ruin box layout, so don't do it. Never use a string from a user as part of this column for security reasons.
BoxText optional string
Box's content. Plain text.
CanDrag optional bit
If the box can be dragged and dropped on containers where CanDrop = 1.
CanReorder optional bit
If the box can be dragged and reordered with regards to other boxes where CanReorder = 1
ColumnID optional string
Column to show box in. You must specify either RowID and ColumnID or ContainerID.
ContainerID optional string
Row to show box in. You must specify either ContainerID or RowID and ColumnID.
DropGroup optional string
Boxes can only be dropped into containers with the same drop group. Return NULL or omit the column to use the default drop group. See the section on Drop groups above for details.
IsDeleted optional bit
Return 1 to remove a box from the page during a partial update
RowID optional string
Row to show box in. You must specify either RowID and ColumnID or ContainerID.
ShadeBox optional bit
If true, semi-transparent stripes will be drawn above the box's background.
ToolTip optional string
Box's tooltip. Plain text.
Resultset: Sync Timestamp
Updated sync timestamp that will be sent as a parameter to the next client sync call.
Table count:
repeated exactly once
Row count:
exactly one row
Columns
SyncTimestamp mandatory string
The timestamp.
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.