Type: BCS.Sym3.IResourceMenuItem

Represents a menu item Remarks: Available in Operator only

Properties


Action

  • Description: Gets or sets the action for this menu item
  • Type: IBaseAction
  • Access: Read and Write
  • Example:
This example shows you how to create an item, set the text and set the action

            var menu = Project.Menus.New();
            var item1 = menu.NewItem();
            item1.Text = "Test 1";
            item1.Action = Project.ActionService.NewActionInstance("Display Message");
            item1.Action.Text = "My message";
            

IsSeparator

  • Description: Gets or sets a boolean that indicates that the menu item is a separator or not.
  • Type: Boolean
  • Access: Read and Write
  • Example:
This example shows you how to create a separator item

            var menu = Project.Menus.New();
            var item1 = menu.NewItem();
            item1.IsSeparator = true;
            

  • Description: Gets the menu
  • Type: IResourceMenu
  • Access: Read

OnMenuItemClickedEventLogEnabled

  • Description: Gets/Sets a boolean to enable/disable the logging of a event in the database when the menu item is cliked
  • Type: Boolean
  • Access: Read and Write

OnMenuItemClickedEventLogText

  • Description: If log is enabled, this following text will be logged in the database
  • Type: String
  • Access: Read and Write

Permissions

  • Description: Gets a list of permissions assigned to the button
  • Type: ObservableCollection`1
  • Access: Read

Text

  • Description: Gets or sets the display text of the menu item
  • Type: String
  • Access: Read and Write
  • Example:
This example shows you how to create an item and set the text

            var menu = Project.Menus.New();
            var item1 = menu.NewItem();
            item1.Text = "Test 1";
            

Methods


Compare(BCS.Sym3.IResourceMenuItem)

Compare the resource menu item between two project


FromXmlString(BCS.IToolXmlToObjectHelper)

Init object from IToolXmlToObjectHelper. All properties found in the RootElement of IToolXmlToObjectHelper will be set with the value in the rootElement

  • Parameters:
    • xmlHelperObj: xmlHelperObj IToolXmlToObjectHelper

FromXmlString(System.String)

Init object from xml. All properties found in the xml will be set with the value in the xml file

  • Parameters:
    • xmlText: Xml string

FromXmlString(System.Xml.Linq.XElement)

Init object from root element. All properties found in the XElement will be set with the value in the XElement

  • Parameters:
    • objXml: objXml XElement

ToXmlString

Converts the object in an xml string

  • Returns:
    • the string that contains xml version of the object