Class ModifyCanvasItemsParameter

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

Inheritance
System.Object
SerializedParam
ServerTaskParameter
ModifyCanvasItemsParameter
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: 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()

Creates a new task process parameter

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
System.String

Properties

Base64SerializedQueryExecuter

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

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

CanvasID

The type of canvas to modify items in

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

CanvasID_Label

The type of canvas to modify items in

Declaration
public string CanvasID_Label { get; set; }
Property Value
Type Description
System.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)

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

CopyFromSource(ModifyCanvasItemsParameter)

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

CreateNewParam()

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam
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
System.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
System.String propName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods