DS Server

Ribbon Object

Object|Introduced in 24.0

Description

The type of the ribbon property of the TXTextControl object. Provides functions and properties for manipulating the control's ribbon bar.

Syntax

{
   selectedTab: <string>,
   minimize: <function>,
   expand: <function>
}

Examples

The following example demonstrates Ribbon in a practical document-editing workflow. The type of the ribbon property of the TXTextControl object. Provides functions and properties for manipulating the control's ribbon bar.

function inspectRibbon(ribbon) {
    console.log("selected tab:", ribbon.selectedTab);
    console.log("minimize:", ribbon.minimize);
    console.log("expand:", ribbon.expand);
}

Members

Properties

PropertyDescription
selectedTabGets or sets the currently selected ribbon tab name. Possible values are: "tabDefault", "tabInsert", "tabPageLayout", "tabMailings", "tabView", "tabTableLayout", "tabObjectFormat", "tabShapeFormat", "tabPermissions", "tabFormula" and "tabChartFormatting".

Methods

MethodDescription
expandExpands the ribbon bar if it is currently minimized.
minimizeMinimizes the ribbon bar so that only the tab names stay visible.