Class GridColumnsVisible
A custom view command of type ColumnSelector
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class GridColumnsVisible : ViewCustomCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptorConstructors
GridColumnsVisible(IRootController, BaseGridController)
Creates a new GridColumnsVisible command
Declaration
public GridColumnsVisible(IRootController root, BaseGridController gridController)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| BaseGridController | gridController | The grid controller this command executes against to show/hide column visibility |
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
IncludeInSimple
By default view commands are included in any simple layout filtering of commands if they are part of the quick access
Declaration
public override bool IncludeInSimple { get; }Property Value
| Type | Description |
|---|---|
| bool |
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
AddManualColumnVisibleChange(string, bool)
Used by the UI specific implementation of showing/hiding columns. Indicates the specified column has been made visible/hidden by the user.
Can be retrieved from IsManualVisible(string)
Declaration
public void AddManualColumnVisibleChange(string bindingPath, bool isVisible)Parameters
| Type | Name | Description |
|---|---|---|
| string | bindingPath | The binding property of the column that was hidden/visible |
| bool | isVisible | Indicates if the user manually hid or showed the column |
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 |
Overrides
IsManualVisible(string)
Indicates if the user has manualy hidden or shown the specified column. Returns null if the user has not set it at all.
Declaration
public bool? IsManualVisible(string bindingPath)Parameters
| Type | Name | Description |
|---|---|---|
| string | bindingPath | The column to check if the user has changed the visibility of |
Returns
| Type | Description |
|---|---|
| bool? | Return if the user has manualy hidden or shown the specified column. Returns null if the user has not set it at all. |