Class DocumentSaveParameter
A standard parameter for saving document binary data.
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Save document binary data", "E272734E-EEDC-4C9A-8F54-0832F522D904", DefaultForHasSaveProcessingTask = typeof(IDocument), Description = "Saves document binary data to the database, or a custom file share or storage account.")]
public class DocumentSaveParameter : ItemParameter, ICloneable, INotifyPropertyChangedConstructors
DocumentSaveParameter(IDocument)
Declaration
public DocumentSaveParameter(IDocument item)Parameters
| Type | Name | Description |
|---|---|---|
| IDocument | item |
Fields
UNIQUE_TASK_ID
The unique id of the document save server task
Declaration
public const string UNIQUE_TASK_ID = "E272734E-EEDC-4C9A-8F54-0832F522D904"Field Value
| Type | Description |
|---|---|
| string |
Methods
CreateNewParam()
Must be implemented by inheriting classes to provide a new instance of the current class type.
Used when cloning this SerializedParam to create a new instance of the same type
Declaration
protected override SerializedParam CreateNewParam()Returns
| Type | Description |
|---|---|
| SerializedParam | A new instance of the current SerializedParam type |
Overrides
DisplayUserParamOnSave(IHasSaveProcessingTask, IEntityUpdater)
Indicates when this item is being saved from the client UI that the system should display the parameters for the task being created for user modification
This allows the automatic integration of save popups with parameters relating to the item being saved
Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item, IEntityUpdater context)Parameters
| Type | Name | Description |
|---|---|---|
| IHasSaveProcessingTask | item | The item being saved from the client UI |
| IEntityUpdater | context |
Returns
| Type | Description |
|---|---|
| bool | True (the default) if the specified item should have the parameters for the task it automatically creates displayed to the user during the save |
Overrides
GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)
Returns a user friendly string for the type of task being processed that these parameters work against
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | An instance of a task that these parameters work for |
Returns
| Type | Description |
|---|---|
| string | A user friendly string for the type of task being processed that these parameters work against |