Class Param

A report parameter prompted from the user, carrying its typed value, localized descriptions/hints/error messages, validation rule and optional list, lookup or search dataset that supplies selectable values.

Inheritance

object

ReportItem

Param

Implements

IDisposable

ICloneable

Inherited Members

ReportItem.SetReport(BaseReport)

ReportItem.Dispose()

ReportItem.Name

ReportItem.Report

ReportItem.ClassName

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Reportman.Reporting

Assembly: Reportman.Reporting.dll

Syntax

public class Param : ReportItem, IDisposable, ICloneable

Constructors

Param()

Declaration

public Param()

Fields

Alias

Declaration

public string Alias

Field Value

Type	Description
string

AllowNulls

Declaration

public bool AllowNulls

Field Value

Type	Description
bool

Datasets

Declaration

public Strings Datasets

Field Value

Type	Description
Strings

Descriptions

Declaration

[JsonConverter(typeof(NewlineDelimitedStringConverter))]
public string Descriptions

Field Value

Type	Description
string

ErrorMessages

Declaration

[JsonConverter(typeof(NewlineDelimitedStringConverter))]
public string ErrorMessages

Field Value

Type	Description
string

Hints

Declaration

[JsonConverter(typeof(NewlineDelimitedStringConverter))]
public string Hints

Field Value

Type	Description
string

IsReadOnly

Declaration

public bool IsReadOnly

Field Value

Type	Description
bool

Items

Declaration

public Strings Items

Field Value

Type	Description
Strings

LookupDataset

Declaration

public string LookupDataset

Field Value

Type	Description
string

NeverVisible

Declaration

public bool NeverVisible

Field Value

Type	Description
bool

ParamType

Declaration

public ParamType ParamType

Field Value

Type	Description
ParamType

Search

Declaration

public string Search

Field Value

Type	Description
string

SearchDataset

Declaration

public string SearchDataset

Field Value

Type	Description
string

SearchParam

Declaration

public string SearchParam

Field Value

Type	Description
string

Selected

Declaration

public Strings Selected

Field Value

Type	Description
Strings

Validation

Declaration

public string Validation

Field Value

Type	Description
string

Values

Declaration

public Strings Values

Field Value

Type	Description
Strings

Visible

Declaration

public bool Visible

Field Value

Type	Description
bool

Properties

Description

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

ErrorMessage

Declaration

public string ErrorMessage { get; set; }

Property Value

Type	Description
string

Hint

Declaration

public string Hint { get; set; }

Property Value

Type	Description
string

LastValue

Declaration

public Variant LastValue { get; set; }

Property Value

Type	Description
Variant

ListValue

Declaration

public Variant ListValue { get; }

Property Value

Type	Description
Variant

UserVisible

Declaration

public bool UserVisible { get; }

Property Value

Type	Description
bool

Value

Declaration

public Variant Value { get; set; }

Property Value

Type	Description
Variant

Methods

Clone()

Declaration

public object Clone()

Returns

Type	Description
object

GetClassName()

Internal function to determine the object type name

Declaration

protected override string GetClassName()

Returns

Type	Description
string	Object type name

Overrides

ReportItem.GetClassName()

GetDbType()

Declaration

public DbType GetDbType()

Returns

Type	Description
DbType

GetMultiValue()

Declaration

public string GetMultiValue()

Returns

Type	Description
string

GetSubExpreValue()

Declaration

public string GetSubExpreValue()

Returns

Type	Description
string

SelectAllValues()

Declaration

public void SelectAllValues()

UpdateLookupValues()

Declaration

public void UpdateLookupValues()

Implements

IDisposable

ICloneable