Class DatasetWhereFiltersController

Inheritance
object
ModelViewController
BaseTreeViewAnyController<IFilterDescriptor>
BaseTreeViewController<IFilterDescriptor>
BaseTreeViewRelatedController<IDataset, IFilterDescriptor>
DatasetWhereFiltersController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class DatasetWhereFiltersController : BaseTreeViewRelatedController<IDataset, IFilterDescriptor>, ICollectionExportable, ISearchController, IModelViewController

Constructors

DatasetWhereFiltersController(IBaseTreeView<IFilterDescriptor>)

Declaration
public DatasetWhereFiltersController(IBaseTreeView<IFilterDescriptor> view)
Parameters
Type Name Description
IBaseTreeView<IFilterDescriptor> view

Properties

AutoExpandAll

Indicates when loaded the system should automatically expand the entire tree view in the ui. Automated if the ui view implements IBaseTreeViewWithExpansion<T>

Default is false

Declaration
protected override bool AutoExpandAll { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.AutoExpandAll

AutoPromptForLabelOnNew

Declaration
protected override bool AutoPromptForLabelOnNew { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.AutoPromptForLabelOnNew

CommandNewCanCreate

Indicates if the view should allow New items to be created - Default is true

Declaration
protected override bool CommandNewCanCreate { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.CommandNewCanCreate

ContextHelpURL

An optional associated url of a help file for the view this controller works with

Declaration
public override string ContextHelpURL { get; }
Property Value
Type Description
string
Overrides

GetParentIDPropertyName

Returns the property on the entity type IFilterDescriptor that holds the relationship to the parent instance of type IFilterDescriptor too

Declaration
protected override string GetParentIDPropertyName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.GetParentIDPropertyName

GetRelationPropName

The name of the property on the entity type IFilterDescriptor that holds the value to the instance of the parent item of type IDataset in this tree view

Declaration
protected override string GetRelationPropName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewRelatedController<LemonEdge.API.Entities.Reporting.IDataset, LemonEdge.API.Entities.Reporting.IFilterDescriptor>.GetRelationPropName

GetTreeNodeLabelPropertyName

Returns the property on the entity type IFilterDescriptor that holds the string that should be shown as the label on the tree node for every item in the tree view control itself

Declaration
public override string GetTreeNodeLabelPropertyName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.GetTreeNodeLabelPropertyName

Methods

CanMoveAsChildOfItem(IFilterDescriptor, IFilterDescriptor)

Indicates this item is allowed to be moved to be a child of the specified parent item

Declaration
public override bool CanMoveAsChildOfItem(IFilterDescriptor moveItem, IFilterDescriptor newParentItem)
Parameters
Type Name Description
IFilterDescriptor moveItem

The item to be moved to be a child of the specified item
IFilterDescriptor newParentItem

The item to become a parent of the item being moved
Returns
Type Description
bool

True if the moveItem can become a chile of the specified newParentItem
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.CanMoveAsChildOfItem(LemonEdge.API.Entities.Reporting.IFilterDescriptor, LemonEdge.API.Entities.Reporting.IFilterDescriptor)

CreateNewItem()

Creates a new entity of type IFilterDescriptor

Declaration
protected override Task<IFilterDescriptor> CreateNewItem()
Returns
Type Description
Task<IFilterDescriptor>
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.CreateNewItem()

DisplayUI()

Loads all the entities of type IFilterDescriptor for this tree view, wraps them in a TreeNode<T> and displays them in the TreeView

Declaration
public override Task DisplayUI()
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.DisplayUI()

GetCurrentQueryableItemRoot()

Declaration
public IDatasetQueryableItem GetCurrentQueryableItemRoot()
Returns
Type Description
IDatasetQueryableItem

InitCommands(IList<ViewCommand>)

Adds the following commands: Open, New, Delete, MoveUp, MoveDown, and Export Data

Declaration
protected override void InitCommands(IList<ViewCommand> commands)
Parameters
Type Name Description
IList<ViewCommand> commands

The initial set of commands
Overrides

LoadItems()

The method used by DisplayUI() to load all the entities for this tree view

Declaration
protected override Task<IEnumerable<IFilterDescriptor>> LoadItems()
Returns
Type Description
Task<IEnumerable<IFilterDescriptor>>

The list of loaded entities to be displayed in the tree view
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.LoadItems()

OnDeleteItem(IFilterDescriptor)

Removes the specified item from the internal tree node collection.

You still have to call RedisplayNode(TreeNode<T>)

Declaration
protected override void OnDeleteItem(IFilterDescriptor newItem)
Parameters
Type Name Description
IFilterDescriptor newItem

The item being deleted from this treenode collection
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IFilterDescriptor>.OnDeleteItem(LemonEdge.API.Entities.Reporting.IFilterDescriptor)

UpdateNewItem(IFilterDescriptor)

Ensures that any new item is also automatically related to the parent single item of type IDataset

Declaration
protected override Task UpdateNewItem(IFilterDescriptor newItem)
Parameters
Type Name Description
IFilterDescriptor newItem

The newly created entity in the tree view
Returns
Type Description
Task
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewRelatedController<LemonEdge.API.Entities.Reporting.IDataset, LemonEdge.API.Entities.Reporting.IFilterDescriptor>.UpdateNewItem(LemonEdge.API.Entities.Reporting.IFilterDescriptor)

Implements

Extension Methods