Class CommandParameter

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

Inheritance
System.Object
Base
CommandParameter
Implements
Inherited Members
Namespace: FastReport.Data
Assembly: FastReport.OpenSource.dll
Syntax
public class CommandParameter : Base, 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 int DataType { get; set; }
Property Value
Type Description
System.Int32

DefaultValue

Gets or sets a default value for this parameter.

Declaration
public 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.

Expression

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

Declaration
public 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 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

GetExpressions()

Gets all expressions contained in the object.

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

Array of expressions or null if object contains no expressions.
Overrides
Remarks

Do not call this method directly. You may override it if you are developing a new component for FastReport.

This method is called by FastReport each time before run a report. FastReport do this to collect all expressions and compile them. For example, GetExpressions method of the TextObject class parses the text and returns all expressions found in the text.

Serialize(FRWriter)

Serializes the object.

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

Writer object.
Overrides
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll(Base) methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

Implements