Class SearchGrid
A custom view command of type Search
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class SearchGrid : ViewCustomCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor
Constructors
SearchGrid(IRootController, ISearchController)
Creates a new SearchGrid command
Declaration
public SearchGrid(IRootController root, ISearchController gridController)
Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| ISearchController | gridController | The grid controller this command executes against to search for data within it |
Properties
Description
A user friendly description of this command
Declaration
public override string Description { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
IconID
Declaration
public override Guid IconID { get; }
Property Value
| Type | Description |
|---|---|
| Guid |
Overrides
Title
The title of this command
Declaration
public override string Title { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
ToolTip
A user friendly tool tip for this command functionality, by default the Description
Declaration
public override string ToolTip { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
ViewController
The grid controller this command operates against
Declaration
public override ModelViewController ViewController { get; }
Property Value
| Type | Description |
|---|---|
| ModelViewController |
Overrides
Methods
InternalCanExecute(object)
Returns if this command can be executed or not from the client application UI
You must override InternalCanExecute(object?) or InternalCanExecuteAsync(object?) in order to implement if it can be executed
Declaration
public override bool InternalCanExecute(object parameter)
Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| bool | If this command can be executed or not from the client application UI |
Overrides
InternalExecuteAsync(object)
Does not actually execute any command, as this has to be specifically executed in the client application through a custom approach depending on the UI itself
Declaration
public override Task InternalExecuteAsync(object parameter)
Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| Task | Returns immediately |