Class ModifyCanvasItemsParameter

The server task parameters for promoting or deleteing canvas items in bulk

Inheritance
object
SerializedParam
ServerTaskParameter
ModifyCanvasItemsParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Modify Canvas Items", "30DB446A-08E3-4F18-8466-CB943273AFB4", Description = "Bulk promotes, or removes, all changes in a canvas according to a specified filted.")]
public class ModifyCanvasItemsParameter : ServerTaskParameter, ICloneable, INotifyPropertyChanged

Constructors

ModifyCanvasItemsParameter()

Declaration
public ModifyCanvasItemsParameter()

Fields

UNIQUE_TASK_ID

The unique id of the server task

Declaration
public const string UNIQUE_TASK_ID = "30DB446A-08E3-4F18-8466-CB943273AFB4"
Field Value
Type Description
string

Properties

Base64SerializedQueryExecuter

A serialized instance of a QueryableExecuter<T, TT> for ICanvasItem

Declaration
public string Base64SerializedQueryExecuter { get; set; }
Property Value
Type Description
string

CanvasID

The type of canvas to modify items in

Declaration
public Guid CanvasID { get; set; }
Property Value
Type Description
Guid

CanvasID_Label

The type of canvas to modify items in

Declaration
public string CanvasID_Label { get; set; }
Property Value
Type Description
string

Type

The type of modication to make

Declaration
public ModifyCanvasItemsParameter.ModificationType Type { get; set; }
Property Value
Type Description
ModifyCanvasItemsParameter.ModificationType

Methods

Clone()

Declaration
public ModifyCanvasItemsParameter Clone()
Returns
Type Description
ModifyCanvasItemsParameter

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(ModifyCanvasItemsParameter)

Declaration
public void CopyFromSource(ModifyCanvasItemsParameter source)
Parameters
Type Name Description
ModifyCanvasItemsParameter 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 canvas modification task type

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

The server task for processing
Returns
Type Description
string

A string stating that this is a canvas modification server task
Overrides

OnPropChanged(string)

Declaration
protected void OnPropChanged(string propName)
Parameters
Type Name Description
string propName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods