SetOtherParams Method

Owned by martinajindrova
Last updated: Nov 19, 2024
3 min read

This method is used to add various output type specific parameters. 

Object.SetOtherParams(tuPar1, tuPar2 [, tuPar3 [, tuPar4 [, tuPar5 
                      [, tuPar6 [, tuPar7 [, tuPar8 
                      [, tuPar9 [, tuPar10]]]]]]]])

Parameters

tuPar1 - tuPar10

  The first parameter is a string value representing the parameter to be set, the second parameter (and other parameters) is the values to be set.


XFRX#INIT specific parameters

NameTypeTypeXFRX version 
SCMMODEString

Split-Crop-Move mode. This mode control overflow of vertical objects.

Value are:

  • (Empty) - vertical objects will be split, but it possibly change behavior of each control within #UR SCMMODE directive.
  • SPLIT - vertical objects will be split.
  • CROP - vertical objects will be crop.
  • MOVE - vertical objects will be move to next page.
  • VFP - images nad rectangles will be split. Lines will be crop.
22.0
PLAINMODEString

Sets PLAIN mode compatiblity. Value are:

  • XFRX - XFRX plain mode
  • VFP - VFP PLAIN mode
22.0

DONTTESTBANDHEIGHT

Boolean

XFRX 18.2.1 fix bug with long bands: Long summary band don't cause page break at using XFRX preview.

But you can disable this fix bug.

loSession=EVALUATE([XFRX("XFRX#INIT")])
loSession.SetOtherParams("DONTTESTBANDHEIGHT", .T.)

XFRX#LISTENER ignore this setting.

18.2.1

DEFAULTTRIMMODE

Number

Default trim mode for report behavior 80 (XFRX#INIT) is "Trim to nearest character" (1).
Default trim mode for report behavior 90 (XFRX#LISTENER) is "Trim to nearest character, append ellipsis" (3).

Because trim mode 4 cause shorted text - uselessly then XFRX 19.0 change default trim mode to 1. But if you need, you can set default trim to some value: 1,2,3,4,5 

  1. Trim to nearest character
  2. Trim to nearest word
  3. Trim to nearest character, append ellipsis
  4. Trim to nearest word, append ellipsis
  5. Filespec: Show inner path as ellipsis


loSession=EVALUATE([XFRX("XFRX#LISTENER")])
loSession.SetOtherParams("DEFAULTTRIMMODE", 3)
19.0.0
TRANSFORM_AUTOPLAINBooleanSets or suppress PLAIN mode for Cell layout at transformation.22.1

HTML specific parameters

Name

Type

Type

XFRX version 

PRINT_BOOKMARKS

Logical, Numeric

You can send two parameters with this option. The first parameter is logical and controls if the bookmark should be displayed (.T.) or not (.F. = default value).

The second parameter specifies what kind of bookmarks should be displayed:

  • Sending 0 will show both page number bookmarks and the ones defined in the report (default)
  • Sending 1 will show only the bookmarks defined in the report
  • Sending 2 will show only the page number bookmarks

CONVERTEMF_TIFFTOPNG Logical 

Default value is .F.
If this parameter is set to .T.,  then EMF/TIFF images will be convert to PNG. 

15.5
INLINEIMAGES Logical  Default value is .F.
If this parameter is set to .T., then images will be inside output file. 		16.0



Plain text specific parameters

Name

Type

Note

PLAIN_CPI_HORIZONTAL

Numeric

Horizontal characters per inch value

PLAIN_CPI_VERTICAL

Numeric

Vertical characters per inch value

PLAIN_SHOW_LINES

Logical

Default value is .T.
This parameter allows for suppressing horizontal lines from the generated file

Please find more information about plain text parameter in Converting reports to plain text chapter on page 41. 


XLS, XLSPLAIN, NATIVE_FXLS, NATIVE_PFXLSX, ODS,FODS, PFODS specific parameters

Name

Type

Note

DISPLAY_GRID_LINES

Logical

Default value = .T.

If this parameter is set to .F., the grid lines in the XLS output will not be visible.

LEAVE_FULL_FIELD_CONTENT

Logical

Default value = .F.

By default, the content of non-stretchable fields is cut according to the size of the field. This option enables to leave the full content of the field in the Excel cell.

NEXT_SHEET_NAME

String

The name of the next sheet to be inserted by next report run.

NEXT_SHEET_NAME_EXPR

String

This expression, if defined, is evaluated at the bottom of each sheet and the result is used as the sheet name.

This parameter takes precedence over the  NEXT_SHEET_NAME parameter.

ADDPAGENUMBERTOSHEETDISPLAYNAMELogical

Default value = .T.

If this parameter set to .F. then XFRX suppresses sheet number in sheet name.
(Since XFRX 15.6)

SHEET_PER_PAGE

Logical

Default value = .F.

By default, the XLS document is generated in “Plain” mode – one long sheet is generated, with the page header at the top and the footer at the bottom.

If this parameter is set to .T., then each report page is generated as a new sheet.

SHEET_PER_NP_GROUP

Logical

Default value = .F.

This option combines the plain mode and the sheet-per-page mode.

If this parameter is set to .T. (and SHEET_PER_PAGE is .F.), then a new sheet is generated for each report group with “Start each group on a new page” flag set to .T.

SHEETPAGEBREAKLogical

Default value = .F.

This option add page breaks in sheet by report pages.

 (Since XFRX 15.7) 

HORIZONTAL_ADJUSTMENT

VERTICAL_ADJUSTMENT

Numeric

The maximal coordinates difference considered as zero.

Please see XLS cells adjustment chapter on page 37 for more information.

XFRX#DRAW specific parameters

NameTypeNoteXFRX version
TABSIZENumberSize TAB char in spaces.19.0
DEFAULTTRIMMODENumberDefault trim mode19.1
FROMNumberSee to "Converting reports to pictures".





21.1
TONumber21.1
BPPNumber21.1
JPEGQUALITYNumber21.1
COPIESNumber21.1
THUMBNAILWIDTHNumber/String21.1
THUMBNAILHEIGHTNumber/String21.1
PAGESPERSHEETNumber21.1
ALLEVENODDNumber21.1
FINDSTRINGArray of String21.1
TRANSPARENTNumber21.1

Remarks

Applies To: XFRX#INIT, XFRX#LISTENER, PDFL#INIT, XFRX#DRAW, XFRX#XML, oXFRX

XFRX version: 24.0 for oXFRX


Examples

To set the next sheet name in the XLS document to “Customer 1”, call:

m.loXFRX=EVALUATE([xfrx("XFRX#INIT")])
m.loXFRX.SetOtherParams("NEXT_SHEET_NAME", "Customer 1")