Open topic with navigation

Format Object

ClosedDescription

The Format object represents a document saved in BarTender. Format objects hold the data and properties for a document that may or may not be open in BarTender.

ClosedFunctions

Name

Description

CancelPrinting

Cancels the currently running print job.

FlushLog

Forces the Print Log buffer to output its contents to the file.

WriteToLog

Writes a raw string to the log file.

ClosedProperties

Name

Description

BaseName

Returns the base name of the current document without the BTW extension. Read-only.

DbSupportsFieldNames

Returns whether the currently opened database supports field names. Read-only.

Directory

Returns the directory of the current document. Read-only.

FileName

Returns the name of the current document, including the directory path. Read-only.

IdenticalCopiesOfLabel

Returns the number of identical copies to be printed. Read-only.

IsNewRecord

Returns whether the print job has opened a new record. Read-only.

IsPrinting

Returns whether a print job is in progress. Read-only.

IsPrintPreview

Returns whether BarTender is preparing a print preview of the open document. Read-only.

IsPrompting

Returns whether the data entry form is displayed. Read-only.

MeasurementUnits

Sets or returns the units of measurement in the document. See BtUnits for available values.

Note: This property is available only when you are editing script at a document level.

NumberSerializedLabels

Returns the items in a serialized sequence to be printed. Read-only.

Printer

Returns the name of the printer. Read-only.

StartingPosition

Sets or returns the starting position on a page of printer stock with multiple columns and/or rows.

Title

Returns the document portion of the title bar for the current document. Not necessarily the same as the document file name, since a document name will not exist if the document has not yet been saved. Read-only.

Related Topics