Class ExecuteReportParameter
The server task parameters for executing a Report
This task executes the IReport
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: 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
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 |
---|---|
System.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 |
---|---|
System.String |
ReportID
The id of a IReport that should be used to execute
Declaration
public Guid ReportID { get; set; }
Property Value
Type | Description |
---|---|
System.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 |
---|---|
System.String |
Methods
Clone()
Declaration
public ExecuteReportParameter Clone()
Returns
Type | Description |
---|---|
ExecuteReportParameter |
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | source |
Overrides
CopyFromSource(ExecuteReportParameter)
Declaration
public void CopyFromSource(ExecuteReportParameter source)
Parameters
Type | Name | Description |
---|---|---|
ExecuteReportParameter | source |
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 |
---|---|
System.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 |
---|---|
System.Threading.Tasks.Task |
OnPropertyChanged(String)
Indicates the specified property has changed value
Declaration
protected void OnPropertyChanged(string properyName)
Parameters
Type | Name | Description |
---|---|---|
System.String | properyName | The name of the property that changed value |
Events
PropertyChanged
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type | Description |
---|---|
System.ComponentModel.PropertyChangedEventHandler |