Pages Collection

The Pages Collection is part of the Page Engine. Use the Page Engine when designing web sites using Active Server Pages, the Crystal Report Engine Automation Server, and the Crystal Design-Time ActiveX Control. Unless you are experienced with the Crystal Report Engine Object Library, you should allow the Crystal Design-Time ActiveX Control to generate VBScript code in your Active Server Pages that controls the Page Engine objects.

The Page Engine generates pages of a report on the web server and sends the pages to client web browsers as they are requested. For example, when a user first requests a report, only the first page is sent to the web browser. If the user pages forward or backward in the report, or requests a specific page, only that page is sent. This limits the resources required by the web server and reduces download time for the client browser.

The Pages Collection is a collection of Page Object (page 72). Access a specific Page Object in the collection using the Item property.

Pages Collection Properties

	Property	Description	Read/Write	Restriction in
				event handler
	Count	Returns the number of page objects in the collection.	Read only	None
	Item	Returns Page Object (page 72), (32-bit only). Item has	Read only	None
		an index parameter that is a numeric, 1-based index
		(that is, Item (1)).
	Parent	Reference to the Parent object (Report Object (page	Read only	None
		93)).

Remarks

Instead of using the Item property as shown, you can reference a page directly, for example, Pages(1).

ParameterFieldDefinition Object

The ParameterFieldDefinition Object represents a parameter field in the report. This object provides properties and methods for retrieving information and setting options for a parameter field in your report (that is, current value, default value, etc.). A ParameterFieldDefinition Object is obtain from the Field property of the Area Object (page 22), when the specified field is a parameter field.

Report Designer Component Object Model

83

ParameterFieldDefinition Object Properties

Property	Description	Read/Write	Restriction in event handler
DisallowEditing	Gets or sets disallowing	Read/Write	Can be written only when
	editing option.		formatting idle.
EditMask	Gets or sets edit mask for	Read/Write	Can be written only when
	string parameter. See		formatting idle.
	Remarks below for
	additional information.
EnableExclusiveGroup	Boolean, used in conjunction	Read/Write	Can be written only when
	with Boolean property		formatting idle.
	PlaceInGroup. If TRUE, Bool
	parameter group can have
	only one value set to TRUE;
	if FALSE, then can have
	multiple values set to TRUE.
EnableMultipleValues	Gets or sets allowing	Read/Write	Can be written only when
	multiple values.		formatting idle.
EnableNullValue	Gets or sets value nullable.	Read/Write	Can be written only when
			formatting idle.
EnableRangeLimit	Gets or sets the option which	Read/Write	Can be written only when
	specifies if this parameter		formatting idle.
	field value should be in the
	specified range.
GroupNumber	Gets or sets boolean group	Read/Write	Can be written only when
	number.		formatting idle.
IsCurrentValueSet	Returns whether the current	Read only	None
	value has been set.
IsDefaultValueSet	Returns whether the default	Read only	None
	value has been set.
Kind	Returns CRFieldKind (see	Read only	None
	table below) which specifies
	what “kind” of field
	(database, summary,
	formula, etc.).

Constant	Value
crDatabaseField	1
crFormulaField	2
crGroupNameField	5

Report Designer Component Object Model

84

Constant	Value
crParameterField	6
crRunningTotalField	7
crSpecialVarField	4
crSQLExpressionField	8
crSummaryField	3

Property	Description	Read/Write	Restriction in event handler
MaximumValue	Gets or sets maximum value.	Read/Write	Can be written only when
	See Remarks below for		formatting idle.
	additional comments.
MinimumValue	Gets or sets minimum value.	Read/Write	Can be written only when
	See Remarks below for		formatting idle.
	additional comments.
Name	Returns the name of the	Read only	None
	parameter field as it appears
	in the Parameter Field list of
	the Parameter Tab in the
	Insert Fields dialog box (i.e.,
	ExampleParameter).
NeedsCurrentValue	Returns the next field value.	Read only	None
NextValue	Returns the next field value.	Read only	Can be read only when top-
			level Report object is form.
NumberOfBytes	Returns the number of bytes	Read only	None
	required to store the field
	data in memory.
NumberOfCurrent	Gets range value number.	Read only	None
Range
NumberOfCurrent	Gets current value number.	Read only	None
Value
NumberOfDefault	Gets number of default	Read only	None
Value	values.
ParameterFieldName	Returns the name of the	Read only	None
	parameter field as it is
	displayed (referenced) in the
	report (i.e.,
	{?ExampleParameter}).
ParameterType	Gets parameter type.	Read only	None

Report Designer Component Object Model

85

Constant	Value
crQueryParameter	1
crReportParameter	0
crStoreProcedureParameter	2

Property	Description	Read/Write	Restriction in event handler
Parent	Reference to the Parent object	Read only	None
	(Report Object (page 93)).
PlaceInGroup	Boolean, used in conjunction	Read/Write	Can be written only when
	with Boolean property		formatting idle.
	EnableExclusiveGroup.
PreviousValue	Gets field previous value.	Read only	Can be read only when top-
			level Report object is form.
Prompt	Returns or sets the parameter	Read/Write	None
	field prompting string.
ReportName	Returns the report name the	Read only	None
	parameter field is in. If it’s a
	main report the ReportName is
	empty.
Value	Returns the current value of	Read only	Can be read only when top-
	the field.		level Report object is form.
ValueRangeKind	Gets or sets value range kind.	Read/Write	Can be written only when
			formatting idle.
	Constant	Value
	crDiscreteValue	0
	crRangeValue	1
Property	Description	Read/Write	Restriction in event handler
ValueType	Returns CRFieldValueType (see	Read only	None
	table below) which specifies
	the “type” of value found in
	the field.
	Constant	Value
	crBitmapField	17
	crBlobField	15
	crBooleanField	9
	crChartField	21

Report Designer Component Object Model

86