Click or drag to resize
LaunchBox

IGameMenuItemPlugin Interface

Implement this interface in order to add a game-specific menu item to the right-click menu in LaunchBox and/or the game details menu in Big Box.

Namespace:  Unbroken.LaunchBox.Plugins
Assembly:  Unbroken.LaunchBox.Plugins (in Unbroken.LaunchBox.Plugins.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IGameMenuItemPlugin
Request Example View Source

The IGameMenuItemPlugin type exposes the following members.

Properties
  NameDescription
Public propertyCaption
Gets a value specifying the text to show on the menu item.
Public propertyIconImage
Gets a value specifying the icon image to use for the menu item in LaunchBox. This property is not used in Big Box.
Public propertyShowInBigBox
Gets a value specifying whether or not to show the menu item in the Big Box game details menu.
Public propertyShowInLaunchBox
Gets a value specifying whether or not to show the menu item in the LaunchBox right-click menu.
Public propertySupportsMultipleGames
Gets a value specifying whether or not the menu item should be accessible when multiple games are selected at once.
Top
Methods
  NameDescription
Public methodGetIsValidForGame
Used to determine whether the menu item is valid for the selected game. If not valid, the menu item will be disabled in LaunchBox or hidden in Big Box.
Public methodGetIsValidForGames
Used to determine whether the menu item is valid for the selected games when multiple games are selected. If not valid, the menu item will be disabled in LaunchBox. Multiple selections are currently not used in Big Box.
Public methodOnSelected(IGame)
Called when the menu item is clicked or selected for a particular game.
Public methodOnSelected(IGame)
Called when the menu item is clicked or selected for multiple games.
Top
See Also