Class CommandDescriptorOptionsAttribute

This is the "default" option implementation of that menu item for easy menu item creation. If a menu item has custom parameters, you need to set the ParametersType option to your custom serializedparam class type on the Command attribute against the menu item instance class

Inheritance
object
Attribute
CommandDescriptorOptionsAttribute
Implements
Inherited Members
Namespace: LemonEdge.API.Client
Assembly: LemonEdge.API.dll
Syntax
[AttributeUsage(AttributeTargets.Class, Inherited = false)]
public class CommandDescriptorOptionsAttribute : Attribute, ICommandDescriptor

Constructors

CommandDescriptorOptionsAttribute(Command, Type)

Declaration
public CommandDescriptorOptionsAttribute(Command type, Type paramType = null)
Parameters
Type Name Description
Command type
Type paramType

CommandDescriptorOptionsAttribute(string, string, ImageType, string, ImageType, string, Type)

Declaration
public CommandDescriptorOptionsAttribute(string uniqueCommandID, string title, ImageType customIconID, string description, ImageType customOverlayIconID = ImageType.None, string tooltip = "", Type paramType = null)
Parameters
Type Name Description
string uniqueCommandID
string title
ImageType customIconID
string description
ImageType customOverlayIconID
string tooltip
Type paramType

CommandDescriptorOptionsAttribute(string, string, ImageType, string, ImageType, string, Type, string)

Declaration
public CommandDescriptorOptionsAttribute(string uniqueCommandID, string title, ImageType customIconID, string description, ImageType customOverlayIconID, string tooltip, Type paramType, string helpURL)
Parameters
Type Name Description
string uniqueCommandID
string title
ImageType customIconID
string description
ImageType customOverlayIconID
string tooltip
Type paramType
string helpURL

CommandDescriptorOptionsAttribute(string, string, string, string, string, string, Type)

Declaration
public CommandDescriptorOptionsAttribute(string uniqueCommandID, string title, string customIconID, string description, string customOverlayIconID = "", string tooltip = "", Type paramType = null)
Parameters
Type Name Description
string uniqueCommandID

Globally unique id for this command above
string title
string customIconID
string description
string customOverlayIconID
string tooltip
Type paramType

CommandDescriptorOptionsAttribute(string, string, string, string, string, string, Type, string)

Declaration
public CommandDescriptorOptionsAttribute(string uniqueCommandID, string title, string customIconID, string description, string customOverlayIconID, string tooltip, Type paramType, string helpURL)
Parameters
Type Name Description
string uniqueCommandID
string title
string customIconID
string description
string customOverlayIconID
string tooltip
Type paramType
string helpURL

CommandDescriptorOptionsAttribute(Type, string, Type)

Declaration
public CommandDescriptorOptionsAttribute(Type typeHoldingCommandFieldOptions, string commandID, Type paramType = null)
Parameters
Type Name Description
Type typeHoldingCommandFieldOptions
string commandID
Type paramType

Properties

Description

A user friendly description of this command

Declaration
public string Description { get; }
Property Value
Type Description
string

HelpURL

An optional url for help documentation around this commands function

Declaration
public string HelpURL { get; }
Property Value
Type Description
string

IconID

The image to use for this command, either a ImageType or ImageID

Declaration
public Guid IconID { get; }
Property Value
Type Description
Guid

OverlayIconID

On some clients another image can be overlayed on the bottom right of the main icon (for indicating add, remove, etc)

This optional overlay image can be specified here, either a ImageType or ImageID

Declaration
public Guid? OverlayIconID { get; }
Property Value
Type Description
Guid?

Parameter

Any parameter for this command, deriving from CommandSerializedParam

Declaration
public string Parameter { get; }
Property Value
Type Description
string

ParameterType

Declaration
public Type ParameterType { get; }
Property Value
Type Description
Type

Title

The title of this command

Declaration
public string Title { get; set; }
Property Value
Type Description
string

ToolTip

A user friendly tool tip for this command functionality

Declaration
public string ToolTip { get; }
Property Value
Type Description
string

Type

A globally unique id to identify this command in uniquel in the main menu. Comes from Type if it came from the standard set, but can be any id for custom commands, or Guid.Empty otherwise

Declaration
public Guid Type { get; }
Property Value
Type Description
Guid

Methods

GetDescriptors()

Declaration
public static IEnumerable<(string UserFriendlyName, Guid ID)> GetDescriptors()
Returns
Type Description
IEnumerable<(string UserFriendlyName, Guid ID)>

GetDescriptors(Command)

Declaration
public static IEnumerable<ICommandDescriptor> GetDescriptors(Command type)
Parameters
Type Name Description
Command type
Returns
Type Description
IEnumerable<ICommandDescriptor>

GetDescriptors(Guid)

Declaration
public static IEnumerable<ICommandDescriptor> GetDescriptors(Guid type)
Parameters
Type Name Description
Guid type
Returns
Type Description
IEnumerable<ICommandDescriptor>

Implements

Extension Methods