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
System.Object
System.Attribute
CommandDescriptorOptionsAttribute
Implements
Inherited Members
System.Attribute.Equals(System.Object)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetHashCode()
System.Attribute.IsDefaultAttribute()
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.Module, System.Type)
System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.Match(System.Object)
System.Attribute.TypeId
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Core.Client
Assembly: API.dll
Syntax
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public class CommandDescriptorOptionsAttribute : Attribute, ICommandDescriptor

Constructors

CommandDescriptorOptionsAttribute(Commands, Type)

Declaration
public CommandDescriptorOptionsAttribute(Commands type, Type paramType = null)
Parameters
Type Name Description
Commands type
System.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
System.String uniqueCommandID
System.String title
ImageType customIconID
System.String description
ImageType customOverlayIconID
System.String tooltip
System.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
System.String uniqueCommandID
System.String title
ImageType customIconID
System.String description
ImageType customOverlayIconID
System.String tooltip
System.Type paramType
System.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
System.String uniqueCommandID

Globally unique id for this command above
System.String title
System.String customIconID
System.String description
System.String customOverlayIconID
System.String tooltip
System.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
System.String uniqueCommandID
System.String title
System.String customIconID
System.String description
System.String customOverlayIconID
System.String tooltip
System.Type paramType
System.String helpURL

CommandDescriptorOptionsAttribute(Type, String, Type)

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

Properties

Description

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

HelpURL

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

IconID

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

OverlayIconID

Declaration
public Guid? OverlayIconID { get; }
Property Value
Type Description
System.Nullable<System.Guid>

Parameter

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

ParameterType

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

Title

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

ToolTip

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

Type

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

Methods

GetDescriptors()

Declaration
public static IEnumerable<(string UserFriendlyName, Guid ID)> GetDescriptors()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.ValueTuple<System.String, System.Guid>>

GetDescriptors(Commands)

Declaration
public static IEnumerable<ICommandDescriptor> GetDescriptors(Commands type)
Parameters
Type Name Description
Commands type
Returns
Type Description
System.Collections.Generic.IEnumerable<ICommandDescriptor>

GetDescriptors(Guid)

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

Implements

Extension Methods