Appendix 6: Fax File Formats

About Fax File Formats:

PCX

PCX is a singe-page graphic file format based on bitmaps with R3 compression.

DCX

DCX is a multi-page graphic file format based on the PCX format.

TIFF

TIF is a standard file format for graphics files with many variations.

Text

All servers provide text to fax file processing which will perform automatic word-wrapping to fit the page width and insert pagebreaks to fit the page length. The fonts used for the fax file creation can be changed if required via INI file settings.

Dialogic Only

The margin size, fonts and other formatting in text files can be controlled by special escape codes, listed below.

Dialogic ASCII Escape Codes

The following table lists the features you can control and the ASCII escape sequences.

Format

Selection

Hex

ASCII

Font

10 pitch (default)

1B 46 30

<Esc>F0

17 pitch

1B 46 33

<Esc>F3

Line Spacing

2.4 lines/inch

1B 4C 33

<Esc>L3

3 lines/inch

1B 4C 32

<Esc>L2

4 lines/inch

1B 4C 31

<Esc>L1

6 lines/inch (default)

1B 4C 30

<Esc>L0

8 lines/inch

1B 4C 34

<Esc>L4

Single spacing (font height)

1B 44 32

<Esc>D2

Double spacing (font height)

1B 44 34

<Esc>D4

Triple spacing (font height)

1B 44 36

<Esc>D6

Attributes
(Not recommended for Katakana)

Underline off (default)

1B 55 30

<Esc>U0

Underline on

1B 55 31

<Esc>U1

Boldface off (default)

1B 42 30

<Esc>B0

Boldface on

1B 42 31

<Esc>B1

Line Wrap

Line Wrap off

1B 54 30

<Esc>T0

Line Wrap on (default)

1B 54 31

<Esc>T1

Tabs

Tab stop setting (default: n=8)

1B 09 n

<Esc><Tab>n

Control Characters

New Line

0D

<CR>

0D 0A

<CR><LF>

NewPage

0C

<FF>

0D 0C

<CR><FF>

Tabs

09

<Tab>

End of File

1A

<EOF>

Tab stop setting: n = number of tab stops.

Tabs (number of): fixed tabs defined by parameter n in Tab stop setting. Default at position 1, 9, 17, 25...

Sample sequence to specify bold ASCII characters for the following: Dialogic

<insert ASCII code 27>B1Dialogic<insert ASCII code 27>B0

Note: Follow your ASCII editor instructions to insert ASCII code 27 <Escape>.Use upper case letters with no spaces in the escape sequence.

Server-Specific Fax Support

Dialogic cards differ slightly in their support of VBFax features, in addition to the differences in Fax File Formats.

Fax Format Support

Dialogic Fax

TIFF and text only. The Dialogic text converter supports a range of escape codes for text formatting - see Dialogic ASCII Escape Codes. If a complete path is not specified, the default faxout directory will be used.

PageCount

PagesTotal Property

This property is returned on transmitted faxes. It is not valid from Dialogic cards until the fax transmission has been completed. This also has the side-effect that the total number of pages cannot be displayed on fax cover pages.

Overlay Files

Dialogic does not have built-in support for graphics files embedded in text.

Fax Page Headers

The default fax header is placed at the top of each fax. It can be changed using the PageHeader property of the VBFaxJob object. The header definition can include the following special strings (described below):

<To.Name>

<To.Fax>

<To.Company>

<From.Name>

<From.Fax>

<From.Company>

<Date>

In addition, these server specific features are supported:

Dialogic

Dialogic supports the field %P which is replaced by the page number, %R, which is replaced by the remote fax CSID, if available, and <Date>, which contains the date and time of transmission.

The default Dialogic header is:

<Date> To: <To.Name> Fax: <To.Fax> From: <From.Name> <From.Fax> Pg# %P

Changing the page header at runtime

To change the page header for each fax, modify the page header property of each recipient.

EXAMPLE

If using the SendFax control, use this code in the Enter event:

Sendfax2.CurrentJob(Channel).PageHeader = "my page header"

Cover Page Definition

How to edit and customize the Cover Page template

The default template for the cover page is default.cvr. For Dialogic fax support the file is installed in c:\vbvrel3\faxout by default. This directory can be changed with the Faxout ini setting. The extension CVR stand for cover as in cover page and is a text file. Other cover pages can be selected and used using the CoverPageFile property in the VBFaxJob object, and also with the FaxCoverAlternateFile property in the SendFax control.

Dialogic

The Dialogic driver also support some special escape codes within the cover page and other text documents. For more information, see Dialogic ASCII Escape Codes.

The default file DEFAULT.CVR can be opened and edited using notepad.exe. The file as installed looks like this:

To:

<To.Name>

Company:

<To.Company>

Voice:

<To.Voice>

Fax:

<To.Fax>

E-mail:
 

<To.Email>
 

From:

<From.Name>

Company:

<From.Company>

Voice:

<From.Voice>

Fax:

<From.Fax>


E-mail:
 


<From.Email>
 

Subject:

<Subject>

Date:

<Date>

Pages:

<Pages> (including this page)


<Message>

Fields available for use in cover pages are:

Fieldname

FaxQueue, SendFax Control Properties

Associated VBFax Object

Property

<To.Company>

RecipientCompany

VBFaxRecipient

Company

<To.Country>

RecipientCountry

VBFaxRecipient

Country

<To.Dept>

RecipientDepartment

VBFaxRecipient

Department

<To.Email>

RecipientEmail

VBFaxRecipient

Email

<To.Fax>

RecipientFax

VBFaxRecipient

Fax

<To.Mail>

RecipientStreetAddress1 RecipientStreetAddress2

VBFaxRecipient

StreetAddress1 StreetAddress2

<To.Name>

RecipientName

VBFaxRecipient

Name

<To.StreetAddress1>

RecipientStreetAddress1 RecipientStreetAddress2

VBFaxRecipient

Postal

<To.State>

RecipientState

VBFaxRecipient

State

<To.Voice>

RecipientVoice

VBFaxRecipient

Voice

<From.Company>

SenderCompany

VBFaxJob.Sender

Company

<From.Country>

SenderCountry

VBFaxJob.Sender

Country

<From.Dept>

SenderDept

VBFaxJob.Sender

Dept

<From.Email>

SenderEmail

VBFaxJob.Sender

Email

<From.Fax>

SenderFax

VBFaxJob.Sender

Fax

<From.Mail>

SenderStreetAddress1 SenderStreetAddress2

VBFaxJob.Sender

Mail

<From.Postal>

SenderPostal

VBFaxJob.Sender

Postal

<From.State>

SenderState

VBFaxJob.Sender

State

<From.StreetAddress1>

SenderStreetAddress1 SenderStreetAddress2

VBFaxJob.Sender

StreetAddress1 StreetAddress2

<From.Voice>

SenderVoice

VBFaxJob.Sender

Voice

<Date>

Current date and time formatted using the DateTimeString setting

<Subject>

FaxSubject

VBFaxJob

Subject

<User1>

None

VBFaxJob

UserData

Custom Cover Pages

If the generated cover page does not meet your cover page requirements, we suggest using a layout/print OCX such as VSVIEW which allows more sophisticated text processing and merging of graphics to create a fax image file. Another way to do this is to use controls on a VB form which can then be printed to the fax print driver using the Visual Basic Print command.

Adding a custom cover page - SendFax control

To add the generated cover page to the fax, set the CoverPage option in the SendFax control to image file. Use a filename that contains the property %channel% e.g. c:\mycover%channel%.tif. Including this field will make each file specific to a channel which will avoid file name conflicts.

Adding a custom cover page - Object Library

If creating a fax using the VBFax object library, add the cover page by creating a new VBFaxDocument object, and adding this as the first document of the fax.

INI Settings

[VBFax]

DateTimeString

A string that defines the format of the <Date> field in fax headers and cover pages. Default is %#c, which represents the format: day mm/dd/yy hh:mm:ss. Components that can be used in this string are:

FaxPathIn

Defines the directory where incoming faxes are stored: default c:\vbvrel3\faxin

FaxPathOut

Defines the default directory for outgoing faxes, if a full path is not specified for the filename: default c:\vbvrel3\faxout

[Dialogic]

RcvFlags

Provides additional flags for the fax receive operation with Dialogic cards. Possible settings are any of the following values:

0x0020

Maximum receive width: 1728 pixels

0x0040

Maximum receive width: 2048 pixels

0x0000

Maximum receive width: 2432 pixels (default)

And/or one of:

0x10000

Maximum receive length: A4 size (approximately 11 inches)

0x20000

Maximum receive length: B4 size (approximately 14 inches)

0x40000

Maximum receive length: unlimited (default)

And/or one of:

0x080000

Store all received data in coarse resolution

0x100000

Store all received data in fine resolution