SubMenu
Overview
Represents an sub menu item that can be displayed in the MenuBar or Toolbar.
Location
- Reference: RemObjects.Hydra.dll
- Namespace: RemObjects.Hydra.Actions
- Ancestry: MenuItem | SubMenu
constructor
Creates a new instance of the class.
constructor
SubMenu()
init()
Sub New()
constructor (String, String)
constructor(aName: String; aCaption: String)
SubMenu(String aName, String aCaption)
init(_ aName: String, _ aCaption: String)
Sub New(aName As String, aCaption As String)
Parameters:
- aName:
- aCaption:
constructor (String, String, Int32)
constructor(aName: String; aCaption: String; aImageIndex: Int32)
SubMenu(String aName, String aCaption, Int32 aImageIndex)
init(_ aName: String, _ aCaption: String, _ aImageIndex: Int32)
Sub New(aName As String, aCaption As String, aImageIndex As Int32)
Parameters:
- aName:
- aCaption:
- aImageIndex:
constructor (String, String, Int32, Action)
constructor(aName: String; aCaption: String; aImageIndex: Int32; aAction: Action)
SubMenu(String aName, String aCaption, Int32 aImageIndex, Action aAction)
init(_ aName: String, _ aCaption: String, _ aImageIndex: Int32, _ aAction: Action)
Sub New(aName As String, aCaption As String, aImageIndex As Int32, aAction As Action)
Parameters:
- aName:
- aCaption:
- aImageIndex:
- aAction:
Action (declared in MenuItem)
Gets or sets the action that is associated with this menu item.
property Action: Action read write;
Action Action { get; set; }
var Action: Action { get{} set{} }
Property Action() As Action
Add
Adds specified MenuItem elements to the list of child menu items.
method Add(aMenuItem: MenuItem)
void Add(MenuItem aMenuItem)
func Add(_ aMenuItem: MenuItem)
Sub Add(aMenuItem As MenuItem)
Parameters:
- aMenuItem: Reference to the menu item.
Assign
Assigns all the properties of the specified MenuItem object to the current MenuItem.
method Assign(Src: Object)
void Assign(Object Src)
func Assign(_ Src: Object)
Sub Assign(Src As Object)
Parameters:
- Src: Source object.
Caption (declared in MenuItem)
Gets or sets the caption of the menu item.
property Caption: String read write;
String Caption { get; set; }
var Caption: String { get{} set{} }
Property Caption() As String
Count
Gets the number of the child menu items.
property Count: Int32 read;
Int32 Count { get; }
var Count: Int32 { get{} }
ReadOnly Property Count() As Int32
GetMenuItemAsSubMenuAt
Gets the child MenuItem element in the specified position as a SubMenu element.
method GetMenuItemAsSubMenuAt(aIndex: Int32): SubMenu
SubMenu GetMenuItemAsSubMenuAt(Int32 aIndex)
func GetMenuItemAsSubMenuAt(_ aIndex: Int32) -> SubMenu
Function GetMenuItemAsSubMenuAt(aIndex As Int32) As SubMenu
Parameters:
- aIndex: Index of the menu item.
GetMenuItemAt
Gets the child MenuItem element in the specified position.
method GetMenuItemAt(aIndex: Int32): MenuItem
MenuItem GetMenuItemAt(Int32 aIndex)
func GetMenuItemAt(_ aIndex: Int32) -> MenuItem
Function GetMenuItemAt(aIndex As Int32) As MenuItem
Parameters:
- aIndex: Index of the menu item.
ImageIndex (declared in MenuItem)
Gets or sets the index of the image that is associated with this menu item.
property ImageIndex: Int32 read write;
Int32 ImageIndex { get; set; }
var ImageIndex: Int32 { get{} set{} }
Property ImageIndex() As Int32
Initialize protected
This method is called when item is initialized.
method Initialize
void Initialize()
func Initialize()
Sub Initialize()
Items
Gets the list of the child menu items.
property Items: MenuItemList read;
MenuItemList Items { get; }
var Items: MenuItemList { get{} }
ReadOnly Property Items() As MenuItemList
MenuItems
Retuns a menu item in the specified position.
property MenuItems[aIndex: Int32]: MenuItem read write;
MenuItem MenuItems[Int32 aIndex] { get; set; }
subscript MenuItems(_ aIndex: Int32) -> MenuItem { get{} set{} }
Property MenuItems(aIndex As Int32) As MenuItem
Name (declared in MenuItem)
Gets or sets the name of the menu item.
property Name: String read write;
String Name { get; set; }
var Name: String { get{} set{} }
Property Name() As String
OwnerList (declared in MenuItem)
Gets or sets the OwnerList of the parent MenuItem.
property OwnerList: ToolbarList read write;
ToolbarList OwnerList { get; set; }
var OwnerList: ToolbarList { get{} set{} }
Property OwnerList() As ToolbarList
Parent (declared in MenuItem)
Gets the parent MenuItem object to the current MenuItem.
property Parent: MenuItem read write;
MenuItem Parent { get; set; }
var Parent: MenuItem { get{} set{} }
Property Parent() As MenuItem
Remove
Removes specified MenuItem elements from the list.
method Remove(aMenuItem: MenuItem)
void Remove(MenuItem aMenuItem)
func Remove(_ aMenuItem: MenuItem)
Sub Remove(aMenuItem As MenuItem)
Parameters:
- aMenuItem: Reference to a menu item.
Action (declared in MenuItem)
Gets or sets the action that is associated with this menu item.
property Action: Action read write;
Action Action { get; set; }
var Action: Action { get{} set{} }
Property Action() As Action
Caption (declared in MenuItem)
Gets or sets the caption of the menu item.
property Caption: String read write;
String Caption { get; set; }
var Caption: String { get{} set{} }
Property Caption() As String
Count
Gets the number of the child menu items.
property Count: Int32 read;
Int32 Count { get; }
var Count: Int32 { get{} }
ReadOnly Property Count() As Int32
ImageIndex (declared in MenuItem)
Gets or sets the index of the image that is associated with this menu item.
property ImageIndex: Int32 read write;
Int32 ImageIndex { get; set; }
var ImageIndex: Int32 { get{} set{} }
Property ImageIndex() As Int32
Items
Gets the list of the child menu items.
property Items: MenuItemList read;
MenuItemList Items { get; }
var Items: MenuItemList { get{} }
ReadOnly Property Items() As MenuItemList
MenuItems
Retuns a menu item in the specified position.
property MenuItems[aIndex: Int32]: MenuItem read write;
MenuItem MenuItems[Int32 aIndex] { get; set; }
subscript MenuItems(_ aIndex: Int32) -> MenuItem { get{} set{} }
Property MenuItems(aIndex As Int32) As MenuItem
Name (declared in MenuItem)
Gets or sets the name of the menu item.
property Name: String read write;
String Name { get; set; }
var Name: String { get{} set{} }
Property Name() As String
OwnerList (declared in MenuItem)
Gets or sets the OwnerList of the parent MenuItem.
property OwnerList: ToolbarList read write;
ToolbarList OwnerList { get; set; }
var OwnerList: ToolbarList { get{} set{} }
Property OwnerList() As ToolbarList
Parent (declared in MenuItem)
Gets the parent MenuItem object to the current MenuItem.
property Parent: MenuItem read write;
MenuItem Parent { get; set; }
var Parent: MenuItem { get{} set{} }
Property Parent() As MenuItem
constructor
Creates a new instance of the class.
constructor
SubMenu()
init()
Sub New()
constructor (String, String)
constructor(aName: String; aCaption: String)
SubMenu(String aName, String aCaption)
init(_ aName: String, _ aCaption: String)
Sub New(aName As String, aCaption As String)
Parameters:
- aName:
- aCaption:
constructor (String, String, Int32)
constructor(aName: String; aCaption: String; aImageIndex: Int32)
SubMenu(String aName, String aCaption, Int32 aImageIndex)
init(_ aName: String, _ aCaption: String, _ aImageIndex: Int32)
Sub New(aName As String, aCaption As String, aImageIndex As Int32)
Parameters:
- aName:
- aCaption:
- aImageIndex:
constructor (String, String, Int32, Action)
constructor(aName: String; aCaption: String; aImageIndex: Int32; aAction: Action)
SubMenu(String aName, String aCaption, Int32 aImageIndex, Action aAction)
init(_ aName: String, _ aCaption: String, _ aImageIndex: Int32, _ aAction: Action)
Sub New(aName As String, aCaption As String, aImageIndex As Int32, aAction As Action)
Parameters:
- aName:
- aCaption:
- aImageIndex:
- aAction:
Add
Adds specified MenuItem elements to the list of child menu items.
method Add(aMenuItem: MenuItem)
void Add(MenuItem aMenuItem)
func Add(_ aMenuItem: MenuItem)
Sub Add(aMenuItem As MenuItem)
Parameters:
- aMenuItem: Reference to the menu item.
Assign
Assigns all the properties of the specified MenuItem object to the current MenuItem.
method Assign(Src: Object)
void Assign(Object Src)
func Assign(_ Src: Object)
Sub Assign(Src As Object)
Parameters:
- Src: Source object.
GetMenuItemAsSubMenuAt
Gets the child MenuItem element in the specified position as a SubMenu element.
method GetMenuItemAsSubMenuAt(aIndex: Int32): SubMenu
SubMenu GetMenuItemAsSubMenuAt(Int32 aIndex)
func GetMenuItemAsSubMenuAt(_ aIndex: Int32) -> SubMenu
Function GetMenuItemAsSubMenuAt(aIndex As Int32) As SubMenu
Parameters:
- aIndex: Index of the menu item.
GetMenuItemAt
Gets the child MenuItem element in the specified position.
method GetMenuItemAt(aIndex: Int32): MenuItem
MenuItem GetMenuItemAt(Int32 aIndex)
func GetMenuItemAt(_ aIndex: Int32) -> MenuItem
Function GetMenuItemAt(aIndex As Int32) As MenuItem
Parameters:
- aIndex: Index of the menu item.
Initialize protected
This method is called when item is initialized.
method Initialize
void Initialize()
func Initialize()
Sub Initialize()
Remove
Removes specified MenuItem elements from the list.
method Remove(aMenuItem: MenuItem)
void Remove(MenuItem aMenuItem)
func Remove(_ aMenuItem: MenuItem)
Sub Remove(aMenuItem As MenuItem)
Parameters:
- aMenuItem: Reference to a menu item.