Class APIQueryGridController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.ApiConnector.UI.Grids
Assembly: LemonEdge.ApiConnector.UI.dll
Syntax
public class APIQueryGridController : BaseGridRelatedCollectionController<IAPIConnection, IAPIQuery>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IAPIQuery>, ICopyGridItemImplementor<IAPIQuery>, IGrid, IDeleteGridItemImplementor<IAPIQuery>, ISearchController, IModelViewController
Constructors
APIQueryGridController(IBaseGridRelatedCollection<IAPIConnection, IAPIQuery>)
Declaration
public APIQueryGridController(IBaseGridRelatedCollection<IAPIConnection, IAPIQuery> view)
Parameters
Type | Name | Description |
---|---|---|
IBaseGridRelatedCollection<IAPIConnection, IAPIQuery> | 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 IAPIQuery is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
CanCreateNew
Indicates if the user can create new items in the grid
The default implementation is true, allowing specific controller implementations to provide override values
Declaration
public override bool CanCreateNew { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
CollectionRelationshipColumnName
This is the property on the IAPIQuery 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
Methods
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
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 |