Interface ICommandDescriptor

An interface that holds the description of a command, its parameters, and its appearance for displaying in the UI

Namespace: LemonEdge.API.Client
Assembly: LemonEdge.API.dll
Syntax
public interface ICommandDescriptor

Properties

Description

A user friendly description of this command

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

HelpURL

An optional url for help documentation around this commands function

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

IconID

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

Declaration
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
Guid? OverlayIconID { get; }
Property Value
Type Description
Guid?

Parameter

Any parameter for this command, deriving from CommandSerializedParam

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

Title

The title of this command

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

ToolTip

A user friendly tool tip for this command functionality

Declaration
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
Guid Type { get; }
Property Value
Type Description
Guid

Extension Methods