module:nmodule/webEditors/rc/wb/mgr/commands/MgrCommand

module:nmodule/webEditors/rc/wb/mgr/commands/MgrCommand

Description:

  • API Status: Development

    As of Niagara 4.14, applying MgrCommand as a mixin on a regular Command is deprecated. The only
    functionality used is the MgrCommand.flags values, which can be set or unset on a regular
    Command instance.

    Optional mixin type used to extend a bajaux Command with extra functionality used by
    a Manager view. Commands don't need to apply this mixin to be functional in a bajaux
    Manager, this can just provide additional behavior to any Command that requires it.

Source:
See:

API Status: Development

As of Niagara 4.14, applying MgrCommand as a mixin on a regular Command is deprecated. The only
functionality used is the MgrCommand.flags values, which can be set or unset on a regular
Command instance.

Optional mixin type used to extend a bajaux Command with extra functionality used by
a Manager view. Commands don't need to apply this mixin to be functional in a bajaux
Manager, this can just provide additional behavior to any Command that requires it.

Members

(static) flags

Source:
Since:
  • Niagara 4.14

(static) flags.ACTION_BAR :number

Description:

  • Enables the command in the action bar at the bottom of the Manager.

Source:

Enables the command in the action bar at the bottom of the Manager.

Type:
  • number

(static) flags.ALL_BARS :number

Description:

  • Enables the command in all "bars": the action bar at the bottom of the manager,
    the toolbar buttons at the top, and the menu bar (in Workbench, through bajaux interop).

Source:

Enables the command in all "bars": the action bar at the bottom of the manager,
the toolbar buttons at the top, and the menu bar (in Workbench, through bajaux interop).

Type:
  • number

(static) flags.LEARN_CONTEXT_MENU :number

Description:

  • Enables the command in a context menu triggered from the learn table.

Source:

Enables the command in a context menu triggered from the learn table.

Type:
  • number

(static) flags.MAIN_CONTEXT_MENU :number

Description:

  • Enables the command in a context menu triggered from the main database table.

Source:

Enables the command in a context menu triggered from the main database table.

Type:
  • number

Methods

isShownInActionBar() → {Boolean}

Description:

  • Returns a Boolean indicating whether this Command should be shown in the 'action bar'
    at the bottom of the manager view. Defaults to true.

Source:
Deprecated:
  • use flags instead
Returns:
Type
Boolean

setShowInActionBar(show)

Description:

  • Set whether this Command should be shown in the 'action bar' at the bottom of the
    manager view. The default behavior is to show all commands in the manager's command
    group at the bottom of the view. If called, it will typically be with a false argument
    show the command in the tool bar, but not in the main view.

Source:
Deprecated:
  • use flags instead
Parameters:
Name Type Description
show Boolean

true if this instance should be shown in the manager's action bar.