Interface IWrapper
Indicates this item wraps another entity, held by WrappedItem
This is used for entities that want to display a pivot of options within a grid. The logic for this is all taken care of using this and EntityHasPivotAttribute
See API.Entities.IGLAccount for an exampleNamespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.dll
Syntax
public interface IWrapper
Properties
WrappedItem
The main item that is wrapped by this wrapper
Declaration
IBaseEntity WrappedItem { get; }
Property Value
Type | Description |
---|---|
IBaseEntity |
Methods
Init(Action<object, string>, IEntityUpdater, IBaseEntity, IBaseEntity[], IEnumerable<IBaseEntity>)
Initializes this wrapper instance used in the UI
Declaration
void Init(Action<object, string> onChange, IEntityUpdater updater, IBaseEntity mainItem, IBaseEntity[] headers, IEnumerable<IBaseEntity> pivotValues)
Parameters
Type | Name | Description |
---|---|---|
Action<object, string> | onChange | Indicates a property not on the main item has been updated and the system needs to know about the change |
IEntityUpdater | updater | The updater context that holds the changes made to other entities in the wrapper |
IBaseEntity | mainItem | The main item being wrapper, the one returned by WrappedItem |
IBaseEntity[] | headers | The list of items holding the header columns being wrapped for this entity |
IEnumerable<IBaseEntity> | pivotValues | The optional list of items holding ths values that can be used against the headers |