ScBar_AddDexForm()

Examples


The ScBar_AddDexForm() function adds a Dexterity-based form from the specified dictionary to the Shortcut Bar.

Syntax

ScBar_AddDexForm(type, name, parent_ID, shortcut_display_name, resource_ID, product_ID)

Parameters

type – An integer indicating whether the shortcut is being added for a specific user or for a specific user class. Use one of the following constants (which are part of the syScBarObj form):

[spacer]

Constant

Description

scgPERSONAL

The shortcut is being added for a specific user.

scgUSERCLASS

The shortcut is being added for a specific user class.


name – A string specifying the user name or user class to which the shortcut is being added.

parent_ID – An integer indicating the parent node to which the shortcut will be added. The value 0 indicates the root level.

shortcut_display_name – A string containing the text that will be used for the shortcut.

resource_ID – A integer specifying the resource ID of the form for which the shortcut is being added. You can use the Resource_GetID() function in Dexterity to retrieve the ID of a specific form in your dictionary.

product_ID – The product ID of the dictionary that contains the form for which the shortcut is being created.

Return value

A boolean. True indicates the shortcut was successfully added, while false indicates it was not.


Documentation Feedback