You are here: Core Reference > Coding > Scripting > DisplayObjectMenu

DisplayObjectMenu

The DisplayObjectMenu function allows a script to display the pick action menu for a specified database item.,

Syntax

DisplayObjectMenu (Object Reference, Options)

Description

Displays the pick action menu for a specified database item.

Arguments

Object Reference {string}

The address of the database item that has the pick action menu that you want the script to display.

Options {string}

You can choose to exclude some of the menu options from the menu. To do this, simply add the relevant No option to the syntax, using & to separate each option that is to be excluded. Any options that are not excluded will be shown in the menu. The No options are:

  • NoView—Excludes the View Status option.
  • NoAlarmView—Excludes the Display Alarm View option.
  • NoHelpView—Excludes the Display Help View option.
  • NoDefaultView—Excludes the Display Default View option.
  • NoNotes—Excludes the Notes option.
  • NoEvents—Excludes the Display Events option.
  • NoAlarms—Excludes the Display Alarms option.
  • NoDisplay—Excludes the Display option.
  • NoQueries—Excludes query based options such as Display Objects
  • NoTrends—Excludes the options for Trends.
  • NoMethods—Excludes the options for Methods.
  • NoErrors—Excludes the Display Errors option.
  • NoRefs—Excludes the Display References option.
  • NoProperties—Excludes the Properties option.
  • NoEdit—Excludes the Edit option.
  • NoLinks—Excludes any link options (link options are added via the Server Configuration Tool, see Link Fields in the ClearSCADA Guide to Server Administration).
  • NoNavSync—Excludes the Locate in Database Explorer option.
  • NoNavSyncTempl—Excludes the Locate Matching Template Object option.
  • NoUserMethods—Excludes any User Methods (that is, custom methods that have been defined on the User Methods tabs on Forms)
  • NoAlarmMethods—Excludes any alarm related options (Acknowledge Alarms, Enable Alarms etc.)
  • NoLocateOPCNavigator—Excludes the Locate in OPC Data Explorer option.

Returns

None.

Example:

DisplayObjectMenu("CentralGroup.DigPoint1", "NoProperties&NoMethods")

This sets the script to display the pick action menu for the 'DigPoint1' point. The pick action menu shows each of the options for the 'DigPoint1' point except the Properties option and the various method options.


ClearSCADA 2015 R2