Please enable JavaScript to view this site.

R:BASE 11 Help

Navigation: Command Index > G > GATEWAY > EXPORT

RTF (Rich Text Format)

Scroll Prev Top Next More

Syntax:

 

GATEWAY EXPORT RTF filename.rtf +

SELECT clause +

OPTION TITLE value +

|COL_NAMES value +

|LAYOUT value +

|STYLE value +

|SHOW_PROGRESS value +

|MESSAGES value +

|ACTION value +

|BLANK_IF_NULL value +

|BLANK_IF_ZERO value +

|SPECIFICATION_FILE_NAME filename +

|DATASET_FIELD_ORDER value +

|NO_UNICODE_CONVERSION value +

|ADD_UTF8_BOM value

 

filename.rtf

This parameter defines the file name of the target file with exported data using the Rich Text Format. The file extension must be rtf.

 

SELECT clause

Use the SELECT command to identify rows of data from a table or view.

 

OPTION

 

ACTION

Defines the default action which will be processed after export is complete, for example, to open the target export file in view/edit mode or send this exported file by email as attachment. Available Parameter: OPENVIEW

 

ADD_UTF8_BOM

Specifies whether to add a UTF8 BOM to an exported UTF8 string. Available Parameters: ON / OFF

 

BLANK_IF_NULL

If ON, will export NULL values as blank values. If OFF, will export NULL values as the database NULL setting. The default is set to OFF. Available Parameters: ON / OFF

 

BLANK_IF_ZERO

If ON, will export zero values as blank values. If OFF, will export zero values as zero. The default is set to OFF. Available Parameters: ON / OFF

 

COL_NAMES

If ON, will add a first row with column names. If OFF, will only export data. Available Parameters: ON / OFF

 

DATASET_FIELD_ORDER

Specifies the export will follow the SELECT clause column order, rather than the field order in the specification file, when a specification file is used as an OPTION parameter. The default is set to OFF. Available Parameters: ON / OFF

 

LAYOUT

Specifies the layout in which the exported data is arranged. The columnar option arranges columns across the top. Reversed columnar arranges columns along the left side. The tabular option arranges data that looks like a table. Available Parameters: COLUMNAR / REVERSED_COLUMNAR / TABULAR

 

MESSAGES

If ON, during export process some messages will be displayed such as -ERROR- messages, if any. If OFF, the entire export process will be in "silent" mode. Available Parameters: ON / OFF

 

NO_UNICODE_CONVERSION

Exports Unicode data as a UTF8 string to fit in the target field, ensuring no data is lost. If OFF, the Unicode data will be converted to ANSI and characters from source that is higher than 0x127 will become ‘?’. As not all target formats support Unicode and this field is for cases when source is Unicode and destination is normal text field. Available Parameters: ON / OFF

 

SHOW_PROGRESS

Indicates whether to display status dialog during export process. Set SHOW_PROGRESS to ON if you wish to show an animated status dialog during the export process. Set SHOW_PROGRESS to OFF if you wish to export data without animated status dialog. Available Parameters: ON / OFF

 

SPECIFICATION_FILE_NAME

This parameter is used to load a prepared specification with all pre-defined settings for exporting. The export must be performed once using the graphic user interface "Export Wizard" and saved using the "Specifications.." button. The specifications will be stored in a file with the .RGW file extension. The .RGW file acts as a set of default values. Any value in the .RGW file will be overwritten by the same parameter specifically assigned by an OPTION parameter. Since the input file name is required in the GATEWAY command, the input file name in the .RGW will always be overwritten.

 

STYLE

This option adds background color to exported data.

 

Available Parameters:

NORMAL

PRICELIST

MSMONEY

BRICK

DESERT

EGGPLANT

LILAC

MAPLE

MARINE

ROSE

SPRUCE

WHEAT

ZEBRA

 

TITLE

If defined, will be the page header on each page of the document.

 

Examples:

 

GATEWAY EXPORT RTF D:\TEMP\Employee.RTF +

SELECT * FROM Employee WHERE EmpStatus = 'Active' +

OPTION TITLE 'Employee List' |COL_NAMES ON +

|SHOW_PROGRESS ON |ACTION OPENVIEW

 

GATEWAY EXPORT RTF G:\Durgin.RTF +

SELECT * FROM QuoteTable +

OPTION COL_NAME ON

 

GATEWAY EXPORT RTF D:\DataStore\Contacts.RTF +

SELECT * FROM Contacts +

OPTION BLANK_IF_ZERO ON|MESSAGES OFF|STYLE SPRUCE