version

Link List

This component is not suitable for users who require assistive technologies.

Displays a list of links to menu items and/or custom URLs. These links may optionally be grouped and span multiple columns.

Component modes: Link list | Menu group | Link cards

Component mode: Link list

SQL

SQL Call: Get items and groups (mandatory)

May modify database: No

Resultset: Groups (optional)

Return definitions of groups to show in the component.

Table count: repeated zero or one time

Row count: zero or more rows

Columns

ColumnIndex optional int

Index of column to show group in

GroupId mandatory int

Identifier of the group

GroupLabel optional string

Heading

Resultset: Items

Returns the items to show in the component.

Table count: repeated exactly once

Row count: zero or more rows

Columns

<unspecified column> optional string

Any column with no other specific meaning will be sent as a passing field with the link.

CustomUrl optional string

Custom url to open on click. Only one of ItemLink, ItemLinkId and CustomUrl can be used at the same time.

GroupId optional int

Group to show the item in.

ItemDate optional date

Date to display above the item.

ItemIcon optional string

The name of the system icon to use. This is an alternative to using ItemIconId.

Use the menu item "Admin>Theme>System icons" to register system icons.

ItemIconBadgeId optional int

Override icon badge from menuitem.

ItemIconId optional int

Deprecated, use ItemIcon instead.

The icon that should be displayed for the item.

ItemIsUnread optional bit

Visually indicates that this item is new.

ItemLabel optional string

Label for the item.

ItemLink optional string

Alias for the link to follow on click. Only one of ItemLink, ItemLinkId and CustomUrl can be used at the same time.

ItemLinkId optional int

Link to follow on click. Only one of ItemLink, ItemLinkId and CustomUrl can be used at the same time.

ItemTooltip optional string

Tooltip for the item.

SQL Call: Validate parameters

Allows you to validate the SQL parameters before any other SQL is run in the component. This call is only made if 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

See the InfoSQL documentation for details.

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.

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.