Class ReportParameter

The payroll report parameter client object

Inheritance
object
ModelBase
ReportParameter
Implements
Inherited Members
Namespace: PayrollEngine.Client.Model
Assembly: PayrollEngine.Client.Core.dll
Syntax
public class ReportParameter : ModelBase, IReportParameter, IModel, IAttributeObject, IKeyEquatable<IReportParameter>, IEquatable<IReportParameter>, INameObject

Constructors

ReportParameter()

Initializes a new instance of the ReportParameter class

Declaration
public ReportParameter()

ReportParameter(ReportParameter)

Initializes a new instance of the ReportParameter class

Declaration
public ReportParameter(ReportParameter copySource)
Parameters
Type Name Description
ReportParameter copySource

The copy source.

Properties

Attributes

Declaration
[JsonPropertyOrder(110)]
public Dictionary<string, object> Attributes { get; set; }
Property Value
Type Description
Dictionary<string, object>

Description

The report parameter description

Declaration
[JsonPropertyOrder(102)]
public string Description { get; set; }
Property Value
Type Description
string

DescriptionLocalizations

The localized report parameter descriptions

Declaration
[JsonPropertyOrder(103)]
public Dictionary<string, string> DescriptionLocalizations { get; set; }
Property Value
Type Description
Dictionary<string, string>

Hidden

Hidden parameter

Declaration
[JsonPropertyOrder(105)]
public bool Hidden { get; set; }
Property Value
Type Description
bool

Mandatory

The parameter mandatory state

Declaration
[JsonPropertyOrder(104)]
public bool Mandatory { get; set; }
Property Value
Type Description
bool

Name

The report parameter name

Declaration
[Required]
[StringLength(128)]
[JsonPropertyOrder(100)]
public string Name { get; set; }
Property Value
Type Description
string

NameLocalizations

The localized wage type names

Declaration
[JsonPropertyOrder(101)]
public Dictionary<string, string> NameLocalizations { get; set; }
Property Value
Type Description
Dictionary<string, string>

OverrideType

The override type

Declaration
[JsonPropertyOrder(109)]
public OverrideType OverrideType { get; set; }
Property Value
Type Description
OverrideType

ParameterType

The parameter type

Declaration
[JsonPropertyOrder(108)]
public ReportParameterType ParameterType { get; set; }
Property Value
Type Description
ReportParameterType

Value

The parameter value (JSON)

Declaration
[JsonPropertyOrder(106)]
public string Value { get; set; }
Property Value
Type Description
string

ValueType

The parameter value type

Declaration
[JsonPropertyOrder(107)]
public ValueType ValueType { get; set; }
Property Value
Type Description
ValueType

Methods

EqualKey(IReportParameter)

Test for the same item key

Declaration
public virtual bool EqualKey(IReportParameter compare)
Parameters
Type Name Description
IReportParameter compare
Returns
Type Description
bool

Equals(IReportParameter)

Declaration
public virtual bool Equals(IReportParameter compare)
Parameters
Type Name Description
IReportParameter compare
Returns
Type Description
bool

GetUiString()

The object UI string

Declaration
public override string GetUiString()
Returns
Type Description
string
Overrides

Implements

Extension Methods