[]
        
(Showing Draft Content)

C1.WPF.Document.Parameter

Parameter Class

Represents a user-defined parameter.

Inheritance
OwnedObject
NamedObject
Parameter
Namespace: C1.WPF.Document
Assembly: C1.WPF.Document.4.6.2.dll
Syntax
public class Parameter : NamedObject

Constructors

Name Description
Parameter()

Properties

Name Description
AllowBlank

Gets or sets a value indicating whether the value of this parameter can be an empty string. Ignored unless DataType is String.

AllowedValues
<p>Gets a list of allowed parameter values.</p>
<p>This can be null, which means that the list of allowed values is not supported.</p>
<p>This can also be an empty list, which means that the list of allowed values is empty

(possible if for example the list is filled by a query, and the query returned an empty result).

DataType

Gets or sets the data type of this parameter.

DocumentSource

Gets a C1DocumentSource owning this Parameter object.

Hidden

Gets or sets a value indicating whether this parameter should be hidden from user interface. (Hidden parameters can be used for programmatic control of subreports, drillthrough reports etc.)

MaxLength

Gets or sets the maximum length of a string parameter (0 means unlimited length). This property is ignored for non-string parameters.

MultiValue

Gets or sets a value indicating whether this parameter can be used to pass multiple values.

Nullable

Gets or sets a value indicating whether the value of this parameter can be null. Cannot be true if this is a multi-value parameter.

Owner

Gets a ParameterCollection containing this Parameter object.

Prompt

Gets or sets the prompt shown to the user when asking to enter a value for the parameter.

Value
<p>Gets or sets the parameter value.</p>

If MultiValue is true, the parameter value can be an array, in which case all items in that array must have the same type, and cannot be arrays.

Methods

Name Description
AssignFrom(object)

Assigns all from another object.

CreateSame()

Creates a new instance of the same class as this one.

GetPropsTable()

Gets the C1.WPF.Document.Serialization.IC1PropsTable.

OnPropertyChanged()

Called when property of Parameter is changed.

SelectAllValues()

Assigns all AllowedValues to Value.