Class DocumentImportExtender
Inheritance
DocumentImportExtender
Assembly: LemonEdge.API.Core.dll
Syntax
public class DocumentImportExtender : IEntityDescriptorImportExtender
Constructors
DocumentImportExtender()
Declaration
public DocumentImportExtender()
Methods
AllowOpen(IBaseEntity)
Indicates if this item should be allowed to be viewed by the user
Declaration
public bool AllowOpen(IBaseEntity item)
Parameters
Returns
GetImportOrder(EntityImportColDefinition)
Indicates the order properties should be updated in. Required if properties need to be set before other properties
can be updated.
Declaration
public short GetImportOrder(EntityImportColDefinition col)
Parameters
Returns
GetValue(string)
Returns the value of the specified property
Declaration
public object GetValue(string propName)
Parameters
| Type |
Name |
Description |
| string |
propName |
|
Returns
Init(IReadOnlyCache, UserInfo, Dictionary<string, Guid>)
Called when extender is created to initialize with cached items
Declaration
public Task Init(IReadOnlyCache cache, UserInfo user, Dictionary<string, Guid> importedContextItemCache)
Parameters
Returns
OnContextChange(IEntityUpdater, IBaseEntity, (bool Loaded, bool SetToNull, bool Ignore, object Value)[], Func<string, int>)
Called whenever the item being imported is created/updated.
Alternatively called whenever SetValue returns true, indicating some property of the imported item has changed
requiring the context to be reloaded
Declaration
public Task OnContextChange(IEntityUpdater updater, IBaseEntity item, (bool Loaded, bool SetToNull, bool Ignore, object Value)[] currentValues, Func<string, int> getCurrentValueIndexFromHeaderName)
Parameters
Returns
SetValue(string, object)
Sets the specified property on the item. returns true if the context needs updating.
Declaration
public Task<bool> SetValue(string propName, object propValue)
Parameters
Returns
Implements
Extension Methods