Interface IAimpMenuItem

AIMP menu item interface. Implements the IAimpActionEvent Implements the IAimpObject

Inherited Members
Namespace: AIMP.SDK.MenuManager
Assembly: AIMP.SDK.dll
Syntax
public interface IAimpMenuItem : IAimpActionEvent, IAimpObject

Properties

Action

Provides an ability to set the IAimpAction for menu item. Menu item will inherits the Name, Enabled, OnExecute event from the action.

Declaration
IAimpAction Action { get; set; }

Checked

Gets or sets a value indicating whether this IAimpMenuItem is checked. Actual only for CheckBox and RadioBox style.

Declaration
bool Checked { get; set; }

Custom

This is a user data parameter. It allow you to bind custom data to the interface.

Declaration
string Custom { get; set; }

Enabled

Gets or sets a value indicating whether this IAimpMenuItem is enabled.

Declaration
bool Enabled { get; set; }

Glyph

Menu item glyph (optional). Note that image must be 32-bit with correct alpha channel.

Declaration
Bitmap Glyph { get; set; }

Id

Gets or sets the identifier. Must be unique for all plugins.

Declaration
string Id { get; set; }

IsDefault

Gets or sets a value indicating whether this instance is default. Each level of menu can contains only one default item. Default item uses bold font for the text.

Declaration
bool IsDefault { get; set; }

Name

Gets or sets the menu item display name. Support the automatic localization.

Declaration
string Name { get; set; }

Parent

Gets or sets the parent menu item.

Declaration
IAimpMenuItem Parent { get; set; }

Shortcut

Local hotkey for menu item. Cannot be customized by end user. Refer to the MakeHotkey(ModifierKeys, UInt32). Refer to the IAimpAction.

Declaration
int Shortcut { get; set; }

Style

Gets or sets the MenuItemStyle.

Declaration
MenuItemStyle Style { get; set; }

Visible

Gets or sets a value indicating whether this IAimpMenuItem is visible.

Declaration
bool Visible { get; set; }

Methods

DeleteChildren()

Deletes the children.

Declaration
AimpActionResult DeleteChildren()

Events

OnShow

Occurs when [on show].

Declaration
event EventHandler OnShow
Event Type
Type Description
System.EventHandler

See Also