Class ClearCanvasParameters

The server task parameters for the clear canvas process

Inherits from the item server task parameter which records the id and label of the ICanvas to have its data cleared

Clears all data associated with a canvas
Inheritance
object
SerializedParam
ServerTaskParameter
ItemParameter
ClearCanvasParameters
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Clear Canvas Data", "213E4D11-3C58-433A-A63C-CAE408EB8D32", Description = "Clears all data associated with a canvas.")]
public class ClearCanvasParameters : ItemParameter, ICloneable, INotifyPropertyChanged

Constructors

ClearCanvasParameters()

Creates a new custom object server task process parameter

Declaration
public ClearCanvasParameters()

ClearCanvasParameters(ICanvas)

Creates a new clear canvas server task process parameter for the specified canvas

Declaration
public ClearCanvasParameters(ICanvas item)
Parameters
Type Name Description
ICanvas item

An ICanvas this parameter will make the task run against

Fields

UNIQUE_TASK_ID

The unique id of the custom object server task

Declaration
public const string UNIQUE_TASK_ID = "213E4D11-3C58-433A-A63C-CAE408EB8D32"
Field Value
Type Description
string

Properties

ClearAllDeletedCanvases

Indicates all deleted canvases should also be cleared

Declaration
public bool ClearAllDeletedCanvases { get; set; }
Property Value
Type Description
bool

Methods

Clone()

Declaration
public ClearCanvasParameters Clone()
Returns
Type Description
ClearCanvasParameters

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(ClearCanvasParameters)

Declaration
public void CopyFromSource(ClearCanvasParameters source)
Parameters
Type Name Description
ClearCanvasParameters source

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

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns that this is a clear canvas task against the canvas

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

The server task for processing the clear canvas to the database
Returns
Type Description
string

A string stating that this is a custom object save recalculation task against the custom object
Overrides

Implements

Extension Methods