Interface ICommandControlCreator
Namespace: LemonEdge.Client.UI.API.Commands.Core
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public interface ICommandControlCreatorMethods
CreateControlCommand(EPCommand, ICommandDescriptor, CommandButtonType, bool, CommandSize)
Creates the actual UI component for the specified command, and detail.
Declaration
object? CreateControlCommand(EPCommand command, ICommandDescriptor descriptor, CommandButtonType type, bool showTitle, CommandSize size)Parameters
| Type | Name | Description |
|---|---|---|
| EPCommand | command | The command to use while creating the UI component for the command |
| ICommandDescriptor | descriptor | A descriptor object for the command containing title, icon, etc |
| CommandButtonType | type | The type of ui component to create for the command |
| bool | showTitle | Indicates if the title should be visible, or to just use an icon |
| CommandSize | size | The size to make the ui component of the command |
Returns
| Type | Description |
|---|---|
| object | The actual UI component for the specified command, and detail. |
CreateMenuItem(EPCommand)
Creates a menu item ui component from a command.
Declaration
object CreateMenuItem(EPCommand command)Parameters
| Type | Name | Description |
|---|---|---|
| EPCommand | command | The command |
Returns
| Type | Description |
|---|---|
| object |
UnlinkButton(object)
Provides the client application the opportunity to unlink a button before it is disposed. This allows the removal of handlers or other cleanup
Declaration
void UnlinkButton(object btn)Parameters
| Type | Name | Description |
|---|---|---|
| object | btn | The ui component to unlink |
UpdateControlCommand(EPCommand, object, ICommandDescriptor, bool, CommandSize)
Updates a provided ui component (btn) to use the specified command and details
Declaration
void UpdateControlCommand(EPCommand command, object btn, ICommandDescriptor descriptor, bool showTitle, CommandSize size)Parameters
| Type | Name | Description |
|---|---|---|
| EPCommand | command | The command to use while updating the UI component for the command |
| object | btn | The ui component to be updated with this command and detail |
| ICommandDescriptor | descriptor | A descriptor object for the command containing title, icon, etc |
| bool | showTitle | Indicates if the title should be visible, or to just use an icon |
| CommandSize | size | The size to make the ui component of the command |
UpdateMenuItem(object, EPCommand, ICommandDescriptor, CommandSize)
Updates a menu item ui component, from a command.
Declaration
void UpdateMenuItem(object menuItem, EPCommand command, ICommandDescriptor descriptor, CommandSize size)Parameters
| Type | Name | Description |
|---|---|---|
| object | menuItem | The ui component to update |
| EPCommand | command | The command |
| ICommandDescriptor | descriptor | The command descriptor |
| CommandSize | size | The command size |