StatusItem Method

In This Topic

The base class of status item provides basic value display and related context menu item function.

Syntax

Javascript (Usage)
Javascript (Specification)

var value; // Type: any
value = GC.Spread.Sheets.StatusBar.StatusItem(name,
                                              options,
                                              options.menuContent,
                                              options.align,
                                              options.tipText,
                                              options.visible,
                                              options.showStatusInContexMenu,
                                              options.value);

function StatusItem( 
   name : string,
   options : Object,
   (optional) options.menuContent : string,
   (optional) options.align : string,
   (optional) options.tipText : string,
   (optional) options.visible : boolean,
   (optional) options.showStatusInContexMenu : boolean,
   (optional) options.value : Object
) : any;

Parameters

name: The name is the Unique identifier and needed in context menu and statusbar.
options: The object of status item options.
options.menuContent: The menuContent displayed left on context menu which represent current item.
options.align: Control the item alignment on statusbar. The value is 'left' or 'right'.
options.tipText: The tip text displayed when mouse over the item. Show the description for the item.
options.visible: 1.The visibility of current item on statusbar. 2.The checked status of current item on context menu.
options.showStatusInContexMenu: Whether show the status on right of context menu.
options.value: The value displayed on status bar and on right of context menu to represent the status of current item.

Example

Javascript

let StatusItem = GC.Spread.Sheets.StatusBar.StatusItem;
let labelItem = new StatusItem('labelItem', {menuContent: 'label', value: 'text'});

Reference

StatusBar type

Product Support Forum | Print this page