Application Object

ClosedDescription

Top-level object for BarTender, which is used to access and set top-level attributes and to get the rest of BarTender object model.

User Interface Representation: BarTender Application and all its open formats.

For more information, refer to Using the Application Object.

ClosedRequirements

Version

BarTender 6.00 or higher

Edition

Automation, Enterprise

ClosedMethods

Name

Description

CommandLine

Runs a command-line command.

Quit

Exits the BarTender application.

Save

Saves all opened documents.

SpecifyPrintOnlyPassword

Specifies a password for the Print-Only Password Setup dialog.

XMLScript

Passes a BarTender XML script to the application.

ClosedProperties

Name

Description

ActiveFormat

Activates a document as the active window.

BuildNumber

Returns the build number.

Edition

Returns the BarTender edition.

Formats

Returns a reference to the Formats collection object.

FullVersion

Returns the version of the BarTender application, including any applicable service release numbers.

IsPrinting

Returns the state of document printing.

IsProcessingCommandLine

Returns the state of command-line processing.

LicenseServer

Returns a reference to the LicenseServer object.

ParentWindow

Sets or returns the window handle (HWND) of the control that will be the parent of the BarTender application window.

ProcessID

Returns the Process Identifier number by which Windows recognizes the BarTender process.

SAPIDocDefinitionFile

Sets and returns the SAP IDoc configuration file name.

TopMost

Sets or returns whether the BarTender application window is the topmost window on the screen.

Version

Returns the version of the BarTender application.

Visible

Sets and returns whether the BarTender application will be visible when it runs.

VisibleWindows

Sets and returns the visible state of the BarTender application components.

Window

Returns the Window object.

ClosedEvents

Name

Description

OnCommandLineCompleted

Occurs when a command-line command that is sent by using the CommandLine method finishes.

OnNewPrintJob

Occurs when a new print job is created.

ClosedCollections

Name

Description

Formats

Manages the list of open documents in BarTender. Used to create and open BarTender documents.