Format.Title Property

ClosedDescription

Returns the title of the BarTender document. Read-only.

ClosedSyntax

Format.Title

ClosedRequirements

Version

BarTender 6.00 or higher

Edition

Automation, Enterprise Automation

ClosedRemarks

The Format.Title property returns the document portion of the title bar for the BarTender document. This value is not necessarily the same as the document's file name because if the document has not yet been saved, no file name will exist.

ClosedVB.NET Example

'Declare a BarTender application variable

Dim btApp As BarTender.Application

'Declare a BarTender document variable

Dim btFormat As BarTender.Format

'Create a new instance of BarTender

btApp = New BarTender.Application

'Set the BarTender application visible

btApp.Visible = True

'Open a BarTender document

btFormat = btApp.Formats.Open("c:\Format1.btw", False, "")

'Display the title for the document

MessageBox.Show(btFormat.Title)

'End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges)

ClosedC# Example

// Declare a BarTender application variable

BarTender.Application btApp;

// Declare a BarTender document variable

BarTender.Format btFormat;

// Create a new instance of BarTender

btApp = new BarTender.Application();

// Set the BarTender application visible

btApp.Visible = true;

// Open a BarTender document

btFormat = btApp.Formats.Open("c:\\Format1.btw", false, "");

// Display the title for the document

MessageBox.Show(btFormat.Title);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics