Component: Multipart

 Show all Hide all

Displays multiple menu items as a single page.

Each displayed menu item, a.k.a. part is defined by a link of type 'Multipart'. The same link may be used multiple times and may utlilize data supplied from the sql as passing fields.

Parts are layouted in a table like manner. Each part occupies a number of cells in the layout table. The height of rows and widths of columns in the table can be specified or computed automatically.

SQL

SQL Call: Retrieve parts to display (mandatory)

Retrieves a list of parts to display along with meta data describing column and row dimensions.

When rows or column dimensions are not fully specified the component will try to utilize the entire browser window to display the parts. If this is not possible due to the minimum dimensions specified occupy more space than available scrollbars will appear in the browser window.

If the contents of a part occupy more space than specified scrollbars will appear around the contents of the part. No scrollbars will appear around the header of a part, so make sure the minimum width specified is enough to display the entire header for a part.
Supports custom errors: No
May modify database: No

Resultset: Column specifications

Specifies the widths of columns in the component. This result set is optional and columns may be used without being defined here. Columns not defined in this result set will be given the minimum width required to display all parts occupying the column without scrollbars.
Repeat mode: repeated zero or one time
Row count: zero or more rows

Columns:

Col mandatory int
Column number (First column is column one)
Width mandatory string
Specifies the width of the row.
Possible value Description
<min>- The column will receive a final width no less than <min>.
<min>-<max> The column is guaranteed to receive a final width somewhere between the <min> and <max> specification.
<width> The width in pixels
null or empty The width of the column will be the minimum required to display the contents of all parts occupying the column without scrollbars.

Resultset: Row specifications

Specifies the heights of rows in the component. This result set is optional and rows may be used without being defined here. Rows not defined in this result set will be given the minimum height required to display all parts occupying the row without scrollbars.
Repeat mode: repeated zero or one time
Row count: zero or more rows

Columns:

Height mandatory string
Specifies the height of the row
Possible value Description
<height> The height in pixels
<min>- The row will receive a final height no less than <min>.
<min>-<max> The row is guaranteed to receive a final height somewhere between the <min> and <max> specification.
null or empty The height of the row will be the minimum required to display the contents of all parts occupying the row without scrollbars.
Row mandatory int
Row number

Resultset: Part specification

Specifies the parts to display in the component.
Repeat mode: repeated one or more times
Row count: zero or more rows

Columns:

LinkID mandatory int
ID of the link to display. The link must have the multipart menu item as its from menu item and be of type 'Multipart'.

You may also use this column to specify a tag that begins with 'part_'. When you do this you can select the link to display from the UI.
HasHeading optional bit
Specifies whether to display the heading for the menu item in the part
Title optional string
Replaces the menu item title in the part's header.
TitlePhraseID optional int
Language phrase that replaces the menu item title in the part's header.
IconID optional int
Replaces the menu item icon in the part's header.
Col mandatory int
Column number to begin display the part
ColSpan optional int
Number of columnsto display the part in
Row mandatory int
Row number to begin display the part
RowSpan optional int
Number of rows to display the part in
SmallScreenSortOrder optional int
The order in which the parts will be displayed on small screens.
If omitted, parts are ordered first by column and then by row.
<xxx> optional string
All other columns are used as passing fields to the link specified

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.

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 text
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.