Class DatasetQueryableItemsController

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

Constructors

DatasetQueryableItemsController(IBaseTreeView<IDatasetQueryableItem>, IQueryableTypeFactory)

Declaration
public DatasetQueryableItemsController(IBaseTreeView<IDatasetQueryableItem> view, IQueryableTypeFactory queryableTypeFactory)
Parameters
Type Name Description
IBaseTreeView<IDatasetQueryableItem> view
IQueryableTypeFactory queryableTypeFactory

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.IDatasetQueryableItem>.AutoExpandAll

AutoPromptForLabelOnNew

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

CommandCopyAllow

Indicates if copying should be allowed in this view

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

CommandNewAllowMultipleRoots

If true indicates the user can create multiple top level (root) nodes in the tree view. False otherwise

Default is true

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

CommandOpenAllow

Indicates if the view should show the Open command - default is false

Declaration
public override bool CommandOpenAllow { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>.CommandOpenAllow

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 IDatasetQueryableItem that holds the relationship to the parent instance of type IDatasetQueryableItem too

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

GetRelationPropName

The name of the property on the entity type IDatasetQueryableItem 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.IDatasetQueryableItem>.GetRelationPropName

GetTreeNodeColorPropertyName

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

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

GetTreeNodeLabelPropertyName

Returns the property on the entity type IDatasetQueryableItem 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.IDatasetQueryableItem>.GetTreeNodeLabelPropertyName

Methods

CreateNewItem()

Creates a new entity of type IDatasetQueryableItem

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

DisplayUI()

Loads all the entities of type IDatasetQueryableItem 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.IDatasetQueryableItem>.DisplayUI()

ForceColumnUpdate()

Declaration
protected Task ForceColumnUpdate()
Returns
Type Description
Task

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<IDatasetQueryableItem>> LoadItems()
Returns
Type Description
Task<IEnumerable<IDatasetQueryableItem>>

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

OnDeleteItem(IDatasetQueryableItem)

Removes the specified item from the internal tree node collection.

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

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

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

OnItemMovedUpOrDown(IDatasetQueryableItem, bool)

Declaration
protected override void OnItemMovedUpOrDown(IDatasetQueryableItem item, bool movedUp)
Parameters
Type Name Description
IDatasetQueryableItem item
bool movedUp
Overrides

OnNodeMoved(TreeNode<IDatasetQueryableItem>, TreeNode<IDatasetQueryableItem>, TreeNode<IDatasetQueryableItem>)

Called when a tree node has been moved to allow any modifications to the old/new parent and sub items of the moved tree node

Declaration
public override void OnNodeMoved(TreeNode<IDatasetQueryableItem> oldParent, TreeNode<IDatasetQueryableItem> newParent, TreeNode<IDatasetQueryableItem> movedItem)
Parameters
Type Name Description
TreeNode<IDatasetQueryableItem> oldParent

The old parent of this tree node
TreeNode<IDatasetQueryableItem> newParent

The new parent for this tree node
TreeNode<IDatasetQueryableItem> movedItem

The tree node that was mvoed
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>.OnNodeMoved(LemonEdge.Utils.TreeNode<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>, LemonEdge.Utils.TreeNode<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>, LemonEdge.Utils.TreeNode<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>)

OpenItem(IDatasetQueryableItem)

Opens the specified entity in a new IModelLayoutDisplayer

Declaration
public override Task OpenItem(IDatasetQueryableItem item)
Parameters
Type Name Description
IDatasetQueryableItem item

The item in the tree view to open
Returns
Type Description
Task

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

UpdateRootCopiedNode(TreeNode<IDatasetQueryableItem>, TreeNode<IDatasetQueryableItem>)

Declaration
protected override Task UpdateRootCopiedNode(TreeNode<IDatasetQueryableItem> original, TreeNode<IDatasetQueryableItem> item)
Parameters
Type Name Description
TreeNode<IDatasetQueryableItem> original
TreeNode<IDatasetQueryableItem> item
Returns
Type Description
Task
Overrides
LemonEdge.Client.Core.Views.Core.BaseTreeViewAnyController<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>.UpdateRootCopiedNode(LemonEdge.Utils.TreeNode<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>, LemonEdge.Utils.TreeNode<LemonEdge.API.Entities.Reporting.IDatasetQueryableItem>)

Implements

Extension Methods