Class ExecuteReportParameter

The server task parameters for executing a Report

This task executes the IReport

Inheritance
object
SerializedParam
ServerTaskParameter
ExecuteReportParameter
ExecuteDevExpressReportParameter
ExecuteExpressReportParameter
ExecuteSSRSReportParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Execute Report", "4297EE27-DE35-4AB0-9129-112095882C00", Description = "Executes the specifed report and stores the generated file.")]
public abstract class ExecuteReportParameter : ServerTaskParameter, ICloneable, ICloneable<ExecuteReportParameter>, INotifyPropertyChanged

Constructors

ExecuteReportParameter()

Declaration
protected ExecuteReportParameter()

Fields

UNIQUE_TASK_ID

The unique id of the ssrs report executer server task

Declaration
public const string UNIQUE_TASK_ID = "4297EE27-DE35-4AB0-9129-112095882C00"
Field Value
Type Description
string

Properties

Base64SerializedParameters

This holds a Dictionary of string, string holding parameter names, and values for executing the specified custom report

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

ReportID

The id of a IReport that should be used to execute

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

ReportID_Label

The name of a IReport that should be used to execute

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

Methods

Clone()

Creates a new instance of this class (of type ExecuteReportParameter) with all the same property values as this instance

Declaration
public ExecuteReportParameter Clone()
Returns
Type Description
ExecuteReportParameter

A new instance of this class with all the same property values as this instance

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

Updates all properties in this item to have the same properties as the source object.

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

The source object to copy all values from.

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns that this is a execute report task against the specified IReportSSRS

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

The server task for processing the ssrs report task
Returns
Type Description
string

A string stating that this is a report task against the specified IReportSSRS
Overrides

Initialize(IReportBase)

When this parameter is created for the first time, this provides the ability to initialize the parameters from values against the report this is running for

Declaration
public abstract Task Initialize(IReportBase forReport)
Parameters
Type Name Description
IReportBase forReport

The report this parameter is being created to run for
Returns
Type Description
Task

OnPropertyChanged(string)

Indicates the specified property has changed value

Declaration
protected void OnPropertyChanged(string properyName)
Parameters
Type Name Description
string properyName

The name of the property that changed value

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods