Class CommandDescriptor

A concrete implementation of ICommandDescriptor

Inheritance

object

CommandDescriptor

Implements

ICommandDescriptor

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonEdge.API.Client

Assembly: LemonEdge.API.dll

Syntax

public class CommandDescriptor : ICommandDescriptor

Constructors

CommandDescriptor(string, ImageType, string, ImageType?, string, Command)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration

public CommandDescriptor(string title, ImageType iconID, string description, ImageType? overlayIconID = null, string toolTip = null, Command type = Command.ViewSpecific)

Parameters

Type	Name	Description
string	title	The title of this command
ImageType	iconID	The image used for this command
string	description	A user friendly description of this command
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
string	toolTip	A user friendly tool tip for this command functionality
Command	type	A Type if this command came from the standard set. Guid.Empty otherwise

CommandDescriptor(string, ImageType, string, ImageType?, string, Command, string)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration

public CommandDescriptor(string title, ImageType iconID, string description, ImageType? overlayIconID, string toolTip, Command type, string helpURL)

Parameters

Type	Name	Description
string	title	The title of this command
ImageType	iconID	The image used for this command
string	description	A user friendly description of this command
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
string	toolTip	A user friendly tool tip for this command functionality
Command	type	A Type if this command came from the standard set. Guid.Empty otherwise
string	helpURL	An optional url for help documentation around this commands function

CommandDescriptor(string, string, string, string, string, string)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration

public CommandDescriptor(string title, string customIconID, string description, string customOverlayIconID = null, string toolTip = null, string commandTypeID = "")

Parameters

Type	Name	Description
string	title	The title of this command
string	customIconID	The image used for this command
string	description	A user friendly description of this command
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
string	toolTip	A user friendly tool tip for this command functionality
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

CommandDescriptor(string, string, string, string, string, string, string)

Creates a new implementation of ICommandDescriptor using the specified parameters

Declaration

public CommandDescriptor(string title, string customIconID, string description, string customOverlayIconID, string toolTip, string commandTypeID, string helpURL)

Parameters

Type	Name	Description
string	title	The title of this command
string	customIconID	The image used for this command
string	description	A user friendly description of this command
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
string	toolTip	A user friendly tool tip for this command functionality
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
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
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; set; }

Property Value

Type	Description
string

Title

The title of this command

Declaration

public string Title { get; set; }

Property Value

Type	Description
string

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

Implements

ICommandDescriptor

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)