Class Parameter
Represents a report parameter that is used to pass user data to a report.
Inheritance
System.Object
Parameter
Assembly: FastReport.Base.dll
Syntax
public class Parameter : Base, IFRSerializable, IParent
Constructors
Parameter()
Initializes a new instance of the Parameter class with default settings.
Declaration
Parameter(String)
Initializes a new instance of the Parameter class with specified name.
Declaration
public Parameter(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Properties
AsString
Gets or sets value of the parameter as a string.
Declaration
public string AsString { get; set; }
Property Value
Type |
Description |
System.String |
|
DataType
Gets or sets the type of parameter.
Declaration
public Type DataType { get; set; }
Property Value
Type |
Description |
System.Type |
|
Description
Gets or sets the description of a parameter.
Declaration
public string Description { get; set; }
Property Value
Type |
Description |
System.String |
|
Expression
Gets or sets an expression of the parameter.
Declaration
public string Expression { get; set; }
Property Value
Type |
Description |
System.String |
|
FullName
Gets the full name of the parameter. This is useful to get the nested parameter's full name.
Declaration
public string FullName { get; }
Property Value
Type |
Description |
System.String |
|
Name
Gets or sets the name of parameter.
Declaration
public string Name { get; set; }
Property Value
Type |
Description |
System.String |
|
Parameters
Gets a collection of nested parameters.
Declaration
public ParameterCollection Parameters { get; }
Property Value
Restrictions
This property is not relevant to this class.
Declaration
public Restrictions Restrictions { get; set; }
Property Value
Value
Gets or sets the value of parameter.
Declaration
public virtual object Value { get; set; }
Property Value
Type |
Description |
System.Object |
|
Methods
AddChild(Base)
Declaration
public void AddChild(Base child)
Parameters
Type |
Name |
Description |
Base |
child |
|
Assign(Base)
Declaration
public override void Assign(Base source)
Parameters
Type |
Name |
Description |
Base |
source |
|
Overrides
CanContain(Base)
Declaration
public virtual bool CanContain(Base child)
Parameters
Type |
Name |
Description |
Base |
child |
|
Returns
Type |
Description |
System.Boolean |
|
GetChildObjects(ObjectCollection)
Declaration
public void GetChildObjects(ObjectCollection list)
Parameters
GetChildOrder(Base)
Declaration
public int GetChildOrder(Base child)
Parameters
Type |
Name |
Description |
Base |
child |
|
Returns
Type |
Description |
System.Int32 |
|
GetExpressions()
Declaration
public override string[] GetExpressions()
Returns
Type |
Description |
System.String[] |
|
Overrides
RemoveChild(Base)
Declaration
public void RemoveChild(Base child)
Parameters
Type |
Name |
Description |
Base |
child |
|
Serialize(FRWriter)
Declaration
public override void Serialize(FRWriter writer)
Parameters
Overrides
SetChildOrder(Base, Int32)
Declaration
public void SetChildOrder(Base child, int order)
Parameters
Type |
Name |
Description |
Base |
child |
|
System.Int32 |
order |
|
UpdateLayout(Single, Single)
Declaration
public void UpdateLayout(float dx, float dy)
Parameters
Type |
Name |
Description |
System.Single |
dx |
|
System.Single |
dy |
|
Implements