RibbonGalleryItems

(Engine-Level Function)

Description: Use to populate a gallery with a collection of items or commands, from which the user may make a selection
Returns:  
Usage: Script Only.
Function Groups: Window
Related to: RibbonCmd | RibbonContextUI | RibbonPersistState | RibbonSetProperty
Format: RibbonGalleryItems(CommandID, GalleryItems);
Parameters:  
CommandID
The unique command identifier of the gallery.
GalleryItems

A structure containing two members:
Categories - A one-dimensional, ordered array of category labels. Each member of the Items array belongs to a category, identifying its category by the index into this array. The categories are displayed as headings within the gallery. If there are no categories, this member must be Invalid.

Items - A one-dimensional, ordered array of RibbonItem structures. Each entry in the array represents an item or command in the gallery. These are displayed in the same order (within their category) as they appear in this array.

RibbonItem structures are described in the comments section.

Comments:

A RibbonItem structure has the following members:

Member Content
Category The category number of the item or command. Mandatory. If the item does not belong to a category you must specify Invalid here. Failure to do this can result in undefined behavior, such as missing items if the gallery is added to the quick access toolbar.
Label The text label to display for the item or command. Optional.
Description The text description to display for list of most recently used (MRU) entries only. This is displayed as the one-line tooltip for an MRU entry. Optional.
Image The image to display for the item or command. Any VTScada-supported image can be supplied as a bitmap value. Optional.
CommandID For command galleries only, the unique command identifier of the command to represent.
CommandType For command galleries only, the type of command. This controls how the command will be represented in the gallery.