Interface ICustomCommand
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.CustomCommand, "dbo.LT_CustomCommands", "CustomCommand", IsStandingDataEntity = true, LabelColumn = "Name")]
[DefaultEntityIcon(ImageType.Button)]
public interface ICustomCommand : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier, IHasVersion
Properties
CanCommandBeExecutedSnippetID
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.CodeSnippet, "ID", SingleJoinType.ZeroToOne, "Can Execute Snippet", "Command Execution Guards", DeleteWithRelationship = true, LinkToItemInSet = true)]
[EntityDescription("Indicates a snippet that returns true or false indicating if this command can be executed. If no snippet is provided than the command is always executable.")]
Guid? CanCommandBeExecutedSnippetID { get; set; }
Property Value
CommandExecutionSnippetID
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.CodeSnippet, "ID", SingleJoinType.ZeroToOne, "Execution Snippet", "Command Executions", DeleteWithRelationship = true, LinkToItemInSet = true)]
[EntityDescription("The snippet that is executed from this command.")]
[RequiredNoDefaultIDValidation]
Guid CommandExecutionSnippetID { get; set; }
Property Value
CommandHelpURL
An optional url for help documentation around this commands function
Declaration
[EntityProperty(SQLType.NVarChar, 1000, true)]
[EntityDescription("An optional url for help documentation around this command function")]
string CommandHelpURL { get; set; }
Property Value
CommandIconID
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The image to use for this command")]
Guid CommandIconID { get; set; }
Property Value
CommandIsQuickAccess
Indicates if the command should also be available on a quick access menu
Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if the command should also be available on a quick access menu")]
bool CommandIsQuickAccess { get; set; }
Property Value
CommandParameter
An optional parameter for executing this command. For views that run against queries/charts/etc the name of the query can be a parameter limiting the button to only appearing against that query. You can hardcode parameter values for the code snippet using @paramvalue=value. All parameters should be seperated by a new line.
Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("An optional parameter for executing this command. For views that run against queries/charts/etc the name of the query can be a parameter limiting the button to only appearing against that query. You can hardcode parameter values for the code snippet using @paramvalue=value. All parameters should be seperated by a new line.")]
string CommandParameter { get; set; }
Property Value
CommandTitle
The title of this command
Declaration
[EntityProperty(SQLType.NVarChar, 500, false, "''")]
[EntityDescription("A title for this custom command")]
string CommandTitle { get; set; }
Property Value
A user friendly tool tip for this command functionality
Declaration
[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("An optional user friendly tooltip for this command")]
string CommandToolTip { get; set; }
Property Value
Description
A user friendly description of this command
Declaration
[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A description for this custom command")]
string Description { get; set; }
Property Value
EntityTypeID
The type this collection or single view button is executed against
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type this collection or single view button is executed against")]
Guid? EntityTypeID { get; set; }
Property Value
The related type this collection view button is against
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The related type this collection view button is against")]
Guid? EntityTypeRelatedID { get; set; }
Property Value
IsEnabled
Indicates if this command is enabled and available in the UI
Declaration
[EntityProperty(SQLType.Bit, false, "1")]
[EntityDescription("Indicates if this command is enabled and available in the UI")]
bool IsEnabled { get; set; }
Property Value
Name
Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this custom command")]
[Unique]
string Name { get; set; }
Property Value
RunForEachSelectedRow
If this command is against a collection, this indicates the command should be run individually against each selected item.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("If this command is against a collection, this indicates the command should be run individually against each selected item.")]
bool RunForEachSelectedRow { get; set; }
Property Value
UIPlacement
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The standard placement of this custom command in the standard views")]
CustomCommandUIPlacement UIPlacement { get; set; }
Property Value
Extension Methods