Class CommandParameter

This class represents a single parameter to use in the "select" command.

Inheritance
System.Object
Base
CommandParameter
ProcedureParameter
Implements
Inherited Members
Namespace: FastReport.Data
Assembly: FastReport.Base.dll
Syntax
public class CommandParameter : Base, IDisposable, IFRSerializable

Constructors

CommandParameter()

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

Declaration
public CommandParameter()

Properties

DataType

Gets or sets the parameter's data type.

Declaration
public virtual int DataType { get; set; }
Property Value
Type Description
System.Int32

DefaultValue

Gets or sets a default value for this parameter.

Declaration
public virtual string DefaultValue { get; set; }
Property Value
Type Description
System.String
Remarks

This value is used when you designing a report. Also it is used when report is running in case if you don't provide a value for the Expression property.

Direction

Gets or set type of parameter.

Declaration
public virtual ParameterDirection Direction { get; set; }
Property Value
Type Description
ParameterDirection

Expression

Gets or sets an expression that returns the parameter's value.

Declaration
public virtual string Expression { get; set; }
Property Value
Type Description
System.String
Remarks

If this property is not set, the DefaultValue property will be used to obtain a parameter's value.

Restrictions

This property is not relevant to this class.

Declaration
public Restrictions Restrictions { get; set; }
Property Value
Type Description
Restrictions

Size

Gets or sets the size of parameter's data.

Declaration
public virtual int Size { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property is used if the DataType property is set to String.

Value

Gets or sets the parameter's value.

Declaration
public object Value { get; set; }
Property Value
Type Description
System.Object

Methods

Assign(Base)

Declaration
public override void Assign(Base source)
Parameters
Type Name Description
Base source
Overrides

GetExpressions()

Declaration
public override string[] GetExpressions()
Returns
Type Description
System.String[]
Overrides

Serialize(FRWriter)

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer
Overrides

Implements