Class Parameter

Represents a report parameter that is used to pass user data to a report.

Inheritance

System.Object

Base

Parameter

SystemVariable

Implements

IFRSerializable

IParent

Inherited Members

Base.Flags

Base.Parent

Base.BaseName

Base.ClassName

Base.Report

Base.Page

Base.ChildObjects

Base.AllObjects

Base.ZOrder

Base.IsAncestor

Base.IsDesigning

Base.IsPrinting

Base.IsRunning

Base.OriginalComponent

Base.Disposed

Base.SetProp(Base, Base)

Base.FloatDiff(Single, Single)

Base.DeserializeSubItems(FRReader)

Base.ExtractDefaultMacros(String)

Base.Dispose(Boolean)

Base.Dispose()

Base.SetFlags(Flags, Boolean)

Base.SetReport(Report)

Base.SetName(String)

Base.SetParent(Base)

Base.SetParentCore(Base)

Base.FindObject(String)

Base.CreateUniqueName()

Base.Clear()

Base.Deserialize(FRReader)

Base.BaseAssign(Base)

Base.AssignAll(Base)

Base.HasParent(Base)

Base.HasFlag(Flags)

Base.HasRestriction(Restrictions)

Base.InvokeEvent(String, Object)

Base.OnAfterLoad()

Base.GetCustomScript()

Base.ExtractMacros()

Base.IsHaveToConvert(Object)

Base.GetConvertedObjects()

Base.ForEachAllConvectedObjects(Object)

Namespace: FastReport.Data

Assembly: FastReport.Base.dll

Syntax

public class Parameter : Base, IDisposable, IFRSerializable, IParent

Remarks

See Parameters for details about using parameters.

Constructors

Parameter()

Initializes a new instance of the Parameter class with default settings.

Declaration

public Parameter()

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

Remarks

This expression will be calculated each time you access a parameter's Value.

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

Type	Description
ParameterCollection

Remarks

Parameters can have child (nested) parameters. To get or set a nested parameter's value, use the GetParameter(String) method.

Restrictions

This property is not relevant to this class.

Declaration

public Restrictions Restrictions { get; set; }

Property Value

Type	Description
Restrictions

Value

Gets or sets the value of parameter.

Declaration

public virtual object Value { get; set; }

Property Value

Type	Description
System.Object

Remarks

You may specify the static value in this property. Note: if the Expression property is not empty, it will be calculated and its value will be returned.

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

Base.Assign(Base)

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

Type	Name	Description
ObjectCollection	list

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

Base.GetExpressions()

RemoveChild(Base)

Declaration

public void RemoveChild(Base child)

Parameters

Type	Name	Description
Base	child

Serialize(FRWriter)

Declaration

public override void Serialize(FRWriter writer)

Parameters

Type	Name	Description
FRWriter	writer

Overrides

Base.Serialize(FRWriter)

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

IFRSerializable

IParent