Class CommandDecriptor

A concrete implementation of ICommandDescriptor

Inheritance
System.Object
CommandDecriptor
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Core.Client
Assembly: API.dll
Syntax
public class CommandDecriptor : ICommandDescriptor

Constructors

CommandDecriptor(String, ImageType, String, Nullable<ImageType>, String, Commands)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration
public CommandDecriptor(string title, ImageType iconID, string description, ImageType? overlayIconID = default(ImageType? ), string toolTip = null, Commands type = Commands.ViewSpecific)
Parameters
Type Name Description
System.String title

The title of this command
ImageType iconID

The image used for this command
System.String description

A user friendly description of this command
System.Nullable<ImageType> overlayIconID

On some clients another image can be overlayed on the bottom right of the main icon (for indicating add, remove, etc). This is the optional overlay image id
System.String toolTip

A user friendly tool tip for this command functionality
Commands type

A Type if this command came from the standard set. Guid.Empty otherwise

CommandDecriptor(String, ImageType, String, Nullable<ImageType>, String, Commands, String)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration
public CommandDecriptor(string title, ImageType iconID, string description, ImageType? overlayIconID, string toolTip, Commands type, string helpURL)
Parameters
Type Name Description
System.String title

The title of this command
ImageType iconID

The image used for this command
System.String description

A user friendly description of this command
System.Nullable<ImageType> overlayIconID

On some clients another image can be overlayed on the bottom right of the main icon (for indicating add, remove, etc). This is the optional overlay image id
System.String toolTip

A user friendly tool tip for this command functionality
Commands type

A Type if this command came from the standard set. Guid.Empty otherwise
System.String helpURL

An optional url for help documentation around this commands function

CommandDecriptor(String, String, String, String, String, String)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration
public CommandDecriptor(string title, string customIconID, string description, string customOverlayIconID = null, string toolTip = null, string commandTypeID = "")
Parameters
Type Name Description
System.String title

The title of this command
System.String customIconID

The image used for this command
System.String description

A user friendly description of this command
System.String customOverlayIconID

On some clients another image can be overlayed on the bottom right of the main icon (for indicating add, remove, etc). This is the optional overlay image id
System.String toolTip

A user friendly tool tip for this command functionality
System.String commandTypeID

A globally unique ID of this command for the main menu. Comes from Type if this command came from the standard set, or can be custom, Guid.Empty otherwise

CommandDecriptor(String, String, String, String, String, String, String)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration
public CommandDecriptor(string title, string customIconID, string description, string customOverlayIconID, string toolTip, string commandTypeID, string helpURL)
Parameters
Type Name Description
System.String title

The title of this command
System.String customIconID

The image used for this command
System.String description

A user friendly description of this command
System.String customOverlayIconID

On some clients another image can be overlayed on the bottom right of the main icon (for indicating add, remove, etc). This is the optional overlay image id
System.String toolTip

A user friendly tool tip for this command functionality
System.String commandTypeID

A globally unique ID of this command for the main menu. Comes from Type if this command came from the standard set, or can be custom, Guid.Empty otherwise
System.String helpURL

An optional url for help documentation around this commands function

Properties

Description

A user friendly description of this command

Declaration
public string Description { get; }
Property Value
Type Description
System.String

HelpURL

An optional url for help documentation around this commands function

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

IconID

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

Declaration
public Guid IconID { get; }
Property Value
Type Description
System.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
System.Nullable<System.Guid>

Parameter

Any parameter for this command, deriving from CommandSerializedParam

Declaration
public string Parameter { get; set; }
Property Value
Type Description
System.String

Title

The title of this command

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

ToolTip

A user friendly tool tip for this command functionality

Declaration
public string ToolTip { get; }
Property Value
Type Description
System.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
System.Guid

Implements

Extension Methods