Class FolderDatasetShortcutsController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class FolderDatasetShortcutsController : BaseGridRelatedCollectionController<IFolder, IDatasetShortcut>, ICollectionExportable, INewGridItemImplementor<IDatasetShortcut>, ICopyGridItemImplementor<IDatasetShortcut>, IDeleteGridItemImplementor<IDatasetShortcut>, ISearchController, IFolderItemsController, IBaseGridController, IGrid, IModelViewControllerConstructors
FolderDatasetShortcutsController(IBaseGridRelatedCollection<IFolder, IDatasetShortcut>)
Declaration
public FolderDatasetShortcutsController(IBaseGridRelatedCollection<IFolder, IDatasetShortcut> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<IFolder, IDatasetShortcut> | view |
Properties
AllowOpenCommand
Indicates that by default selected entities can be opened by the user with the open command
Declaration
public override bool AllowOpenCommand { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
AutoOpenNewItemInTab
Indicates when creating a new item in the grid that it should automatically be opened in a new tab as well
The default is true if the type IDatasetShortcut is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
CollectionRelationshipColumnName
This is the property on the IDatasetShortcut entities that holds a relationship value that points to the SingleItem type
This controller will automatically use that to filter the correct entities for the grid in AlterQuery(QueryableExecuter<TCollection>)
Declaration
public override string CollectionRelationshipColumnName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
DefaultSearchColumn
The name of the column to use in the default search of text in the grid
Declaration
protected override string DefaultSearchColumn { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
DisplayIfNull
Indicates that even if the item is null the view should still update and display a null value. Default value is false.
Declaration
public override bool DisplayIfNull { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
ViewAllFolders
Declaration
public bool ViewAllFolders { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
AlterQuery(QueryableExecuter<IDatasetShortcut>)
Additionally alters the base query alteration by ensuring all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID
This is achieved via AddRelationshipJoin(QueryableExecuter<TCollection>) which can be overidden to customise how the entities of type IDatasetShortcut are precisely related to the SingleItem if not directly through that join
Declaration
protected override QueryableExecuter<IDatasetShortcut> AlterQuery(QueryableExecuter<IDatasetShortcut> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<IDatasetShortcut> | query | The existing query to return all the results that will populate the grid |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<IDatasetShortcut> | An altered query that also ensures all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID |
Overrides
ColumnNames()
A list of all the columns to be dynamically created in the IBaseGrid<T>
This is used by the system to create the actual ControlDisplayInfo classes required from the Columns() property
You can override this to provide a simple definition of each column (combined with AlterControlInfo(ControlDisplayInfo) for more detail), or you can just override Columns() and ignore thisDeclaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()Returns
| Type | Description |
|---|---|
| IEnumerable<ControlDisplayInfoLight> | A list of all the columns to be dynamically created in the IBaseGrid<T> |
Overrides
DisplayUI()
Initializes the grid, and creates every ControlDisplayInfo in the defined Columns() and creates them on the grid
Then loads the data for the grid accounting for all view sorting, filtering, searching and paging, and loads the results into the grid as an observable collection
Declaration
public override Task DisplayUI()Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |
Overrides
GetCanWrite(object)
Declaration
protected override Task<bool> GetCanWrite(object item)Parameters
| Type | Name | Description |
|---|---|---|
| object | item |
Returns
| Type | Description |
|---|---|
| Task<bool> |
Overrides
InitCommands(IList<ViewCommand>)
Adds the following commands, if the associated AllowXXXCommand property returns true: A public toggle, multi-select row, open, column visiblitiy, transfer visible, search, view cancelled, view system, export, new, copy, move up/down, xml export, and delete commands
Declaration
protected override void InitCommands(IList<ViewCommand> commands)Parameters
| Type | Name | Description |
|---|---|---|
| IList<ViewCommand> | commands | The initial set of commands for this view |
Overrides
UpdateNewItem(IDatasetShortcut)
Updates any new item created in this grid to also have the CollectionRelationshipColumnName property hold the value of the SingleItem ID
Declaration
protected override Task UpdateNewItem(IDatasetShortcut item)Parameters
| Type | Name | Description |
|---|---|---|
| IDatasetShortcut | item | The new item created for this grid |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |