XFRXListener class

Properties:

AppendToFile  


 Specifies whether the generated document will be appended to an existing file. This parameter can be either logical, numeric or a string, with the following meaning:

Type

Value

Meaning

Logical

.F.

An existing document will be overwritten

 

.T.

The generated report will be appended at the end of the existing document

Numeric

0

An existing document will be overwritten

 

<page No.>

The generated report will be inserted to the existing document at the given page number.

String

“R<page No.>”

The page will be replaced with the generated report.

 

“R<from>:<to>”

The page range will be replaced with the generated report.


Examples:

Parameter

Meaning

.T.

The generated report will be appended to the end of the existing document.

1

The generated report will be inserted at the beginning of the existing document.

5

The generated report will be inserted to the existing document, between pages 4 and 5.

“R5”

The generated report will be inserted between pages 4 and 6, replacing page 5.

“R4:8”

The generated report will be inserting between pages 3 and 9, replacing pages 4,5,6,7 and 8.

.F. or 0

The existing document will be overwritten.

This property applies to PDF documents only.

CodePage  

 

 

The code page of the output document.

 

DoNotOpenViewer  

 

 

If set to .T., documents won't be opened after the generation.

Default value = .F.

 

lAlwaysWholePage 

 

For backward compatibility with previous XFRX versions.  If set to .T., XFRX do not change left and top position of some objects.

Default value = .F.

NewViewerSession  

 

 

By default, Word and HTML documents will be open in the current instance of the application, if exists. If this parameter is set to .T., the document will always be open in a new Word / Web browser instance.

Default value = .F.

 

QuietMode  

 

 

This is a property of the ReportListener class. If set to .T., no message will be printed during the report generation process.

 

targetFileName  


 

The name of the file to be generated.

 

targetType  

 

 

The output type to be generated. One of the values listed at XFRX Output Target Types (above).

 

TMPFolder  

 Folder where temporary files will be created. If blank, the temporary files will be created in Visual FoxPro Temporary Path 

 

Methods:

The common methods are described at Properties and methods common in XFRXListener and XFRXSession classes (above).

zipDocument()  

 

 

Specifies that the generated document should be added to a zip archive.

Syntax:

zipDocument(ArchiveName, AddToArchive, DeleteSourceDocument)

Return values: none

Parameters: 

ArchiveName (char) is the file name of the zip archive

AddToArchive (logical) specifies, if the file should be added to existing archive (.T.) or if a new archive should be created (.F.)

DeleteSourceDocument (logical) if set to .T., the source document will be deleted after adding to the archive.


You can send these three parameters to XFRX either via this method or as the last three parameters of the SetParams method. This method is available for your convenience of you prefer to fill in XFRXListener properties and call SetParams without parameters.