Namespace: Consultingwerk.Windows.ListAndLabel
Class 
LlReport Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:LlReport
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Oct 14 19:57:02 CEST 2012
Purpose: Returns the handle of the dataset that provides the data for the
report
Notes:



Top Method Summary
Options Name Purpose
# DefineBufferFields (integer, ReportBuffer, logical) Defines Buffer Fields as List & Label Variables
# DefineBufferVariables (integer, ReportBuffer, logical) Defines Buffer Fields as List & Label Variables
# DefineFieldsAndVariables (integer, logical) Starts the List & Label Designer
# InitializeSampleImage () Initializes the path to the sample image
# OutputDataset (integer) Outputs the Dataset
# LOGICAL OutputDatasetQuery (integer, handle) Outputs a Dataset Query
# OutputDatasetVariables (integer) Outputs the Dataset Variables
+ INTEGER PrintBufferFields (integer, ReportBuffer, logical) Prints a buffer as fields
+ INTEGER PrintBufferVariables (integer, ReportBuffer, logical) Prints a buffer as fields
+ StartExport (character, logical, ILlExportModule) Starts the Report Output with an optional export module
+ StartReport (character, logical) Starts the Report Output
+ StartReportDesigner (character) Starts the List & Label Report Designer
+ StartReportDesigner (character, logical) Starts the List & Label Report Designer
# ValidateReportBuffers (ReportDefinition, handle) Validates the Report Buffer Definition

Top Constructor Summary
Options Name Purpose
+ LlReport (ReportDefinition, handle) Constructor for the LlReport class

Top Property Summary
Options Name Purpose
+ HANDLE DatasetHandle
+ CHARACTER DesignerTitle
+ INTEGER ParentWindow
+ INTEGER RecordsPrinted
+ Consultingwerk.Windows.ListAndLabel.ReportDefinition ReportDefinition
+ CHARACTER SampleImagePath


Method Detail
Top

PROTECTED DefineBufferFields (integer, ReportBuffer, logical)

Purpose: Defines Buffer Fields as List & Label Variables
Notes:

Parameters:
piJob INTEGER
The List And Label Job Handle
poReportBuffer Consultingwerk.Windows.ListAndLabel.ReportBuffer
The ReportBuffer Definition
plAllFields LOGICAL
If true all fields will be defined, if false only those fields that are used
Top

PROTECTED DefineBufferVariables (integer, ReportBuffer, logical)

Purpose: Defines Buffer Fields as List & Label Variables
Notes:

Parameters:
piJob INTEGER
The List And Label Job Handle
poReportBuffer Consultingwerk.Windows.ListAndLabel.ReportBuffer
The ReportBuffer Definition
plAllFields LOGICAL
If true all fields will be defined, if false only those fields that are used
Top

PROTECTED DefineFieldsAndVariables (integer, logical)

Purpose: Starts the List & Label Designer
Notes:

Parameters:
piJob INTEGER
The List And Label Job Handle
plAllFields LOGICAL
If true all fields will be defined, if false only those fields that are used
Top

PROTECTED InitializeSampleImage ()

Purpose: Initializes the path to the sample image
Notes:

Top

PROTECTED OutputDataset (integer)

Purpose: Outputs the Dataset
Notes:

Parameters:
piJob INTEGER
The List & Label Job handle
Top

PROTECTED LOGICAL OutputDatasetQuery (integer, handle)

Purpose: Outputs a Dataset Query
Notes:

Parameters:
piJob INTEGER
The List & Label Job handle
phQuery HANDLE
The query to iterate
Returns LOGICAL
Logical value indicating if the user pressed Cancel
Top

PROTECTED OutputDatasetVariables (integer)

Purpose: Outputs the Dataset Variables
Notes:

Parameters:
piJob INTEGER
The List & Label Job handle
Top

PUBLIC INTEGER PrintBufferFields (integer, ReportBuffer, logical)

Purpose: Prints a buffer as fields
Notes:

Parameters:
piJob INTEGER
The List And Label Job Handle
poReportBuffer Consultingwerk.Windows.ListAndLabel.ReportBuffer
The ReportBuffer Definition
plAllFields LOGICAL
If true all fields will be defined, if false only those fields that are used
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintBufferVariables (integer, ReportBuffer, logical)

Purpose: Prints a buffer as fields
Notes:

Parameters:
piJob INTEGER
The List And Label Job Handle
poReportBuffer Consultingwerk.Windows.ListAndLabel.ReportBuffer
The ReportBuffer Definition
plAllFields LOGICAL
If true all fields will be defined, if false only those fields that are used
Returns INTEGER
Error code
Top

PUBLIC StartExport (character, logical, ILlExportModule)

Purpose: Starts the Report Output with an optional export module
Notes:

Parameters:
pcReportDefinitionFile CHARACTER
The .lst file with the report definition, when ? the user will be prompted for a file
plPromptFileName LOGICAL
Logical value indicating if the routine should prompf for a report file name
poExportModule Consultingwerk.Windows.ListAndLabel.ILlExportModule
The ILlExportModule with the settings for the Export Module
Top

PUBLIC StartReport (character, logical)

Purpose: Starts the Report Output
Notes:

Parameters:
pcReportDefinitionFile CHARACTER
The .lst file with the report definition, when ? the user will be prompted for a file
plPromptFileName LOGICAL
Logical value indicating if the routine should prompf for a report file name
Top

PUBLIC StartReportDesigner (character)

Purpose: Starts the List & Label Report Designer
Notes: Does not prompt for the file name

Parameters:
pcDesignerFileName CHARACTER
The name of the Report design file (.lst)
Top

PUBLIC StartReportDesigner (character, logical)

Purpose: Starts the List & Label Report Designer
Notes:

Parameters:
pcDesignerFileName CHARACTER
The name of the Report design file (.lst)
plPromptFileName LOGICAL
Logical value indicating if the routine should prompf for a report file name
Top

PROTECTED ValidateReportBuffers (ReportDefinition, handle)

Purpose: Validates the Report Buffer Definition
Notes:

Parameters:
poReportDefinition Consultingwerk.Windows.ListAndLabel.ReportDefinition
The ReportDefinition object that defines the relations for this report
phDataset HANDLE
The handle of the Dataset that provides the data for the report


Constructor Detail
Top

PUBLIC LlReport (ReportDefinition, handle)

Purpose: Constructor for the LlReport class
Notes:

Parameters:
poReportDefinition Consultingwerk.Windows.ListAndLabel.ReportDefinition
The ReportDefinition object that defines the relations for this report
phDataset HANDLE
The handle of the Dataset that provides the data for the report


Property Detail
Top

PUBLIC HANDLE DatasetHandle


Returns HANDLE
Top

PUBLIC CHARACTER DesignerTitle


Returns CHARACTER
Top

PUBLIC INTEGER ParentWindow


Returns INTEGER
Top

PUBLIC INTEGER RecordsPrinted


Returns INTEGER
Top

PUBLIC Consultingwerk.Windows.ListAndLabel.ReportDefinition ReportDefinition


Returns Consultingwerk.Windows.ListAndLabel.ReportDefinition
Top

PUBLIC CHARACTER SampleImagePath


Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:25:14