DS Server

RibbonPermissionsTab Object

Object|Introduced in 25.0

Description

The type of the ribbonPermissionsTab property. The RibbonPermissionsTab object provides properties which can be used to configure the beahviour of the "Permissions" ribbon tab.

Syntax

{
   allowAdditionalUserNames: <boolean>,
   registeredUserNames: <string[]>
}

Examples

The following example demonstrates RibbonPermissionsTab in a practical document-editing workflow. The type of the ribbonPermissionsTab property. The RibbonPermissionsTab object provides properties which can be used to configure the beahviour of the "Permissions" ribbon tab.

function inspectRibbonPermissionsTab(ribbonPermissionsTab) {
    console.log("allow additional user names:", ribbonPermissionsTab.allowAdditionalUserNames);
    console.log("registered user names:", ribbonPermissionsTab.registeredUserNames);
}

Members

Properties

PropertyDescription
allowAdditionalUserNamesGets or sets a value indicating whether the user can add user names by the RibbonPermissionsTab's Add Users dialog that are not represented by the registeredUserNames property. The default value is true.
registeredUserNamesGets or sets an array of strings that represents those registered user names that can be added by the "Permissions" ribbon tab's Add Users dialog. The default value is an empty array.