Class ReportStartFunction
Report start function
Implements
Inherited Members
Namespace: PayrollEngine.Client.Scripting.Function
Assembly: PayrollEngine.Client.Scripting.dll
Syntax
public class ReportStartFunction : ReportFunction, IDisposable
Constructors
ReportStartFunction(object)
Initializes a new instance with the function runtime
Declaration
public ReportStartFunction(object runtime)
Parameters
| Type | Name | Description |
|---|---|---|
| object | runtime | The runtime |
ReportStartFunction(string)
New function instance without runtime (scripting development)
Declaration
public ReportStartFunction(string sourceFileName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | sourceFileName | The name of the source file |
Methods
GetQuery(string)
Get report query
Declaration
public string GetQuery(string queryName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | queryName | The query name |
Returns
| Type | Description |
|---|---|
| string | The report parameter value as JSON |
HasQuery(string)
Check for existing report query
Declaration
public bool HasQuery(string queryName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | queryName | The query name |
Returns
| Type | Description |
|---|---|
| bool |
SetParameter(string, string)
Set report parameter value
Declaration
public void SetParameter(string parameterName, string value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parameterName | The parameter name |
| string | value | The parameter value as JSON |
SetParameter<T>(string, T)
Set report parameter typed value
Declaration
public void SetParameter<T>(string parameterName, T value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parameterName | The parameter name |
| T | value | The default value |
Type Parameters
| Name | Description |
|---|---|
| T |
SetQuery(string, string)
Set report query value as JSON
Declaration
public void SetQuery(string queryName, string value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | queryName | The query name |
| string | value | The query value as JSON |
Start()
Entry point for the runtime
Declaration
public object Start()
Returns
| Type | Description |
|---|---|
| object |
Remarks
Internal usage only, do not call this method