PageSetup.LabelWidth Property

ClosedDescription

Sets or returns the template's width in the units that are specified.

ClosedSyntax

PageSetup.LabelWidth(BtUnits)=Value

Where Value specifies the width of the template and BtUnits can be set to any of the following constants:

ClosedRequirements

Version

BarTender 7.00 or higher

Edition

Automation, Enterprise Automation

ClosedRemarks

The PageSetup.LabelWidth property sets or returns the width of each template in the units that are specified. Setting this property also sets the PageSetup.LabelSizeManual property to true. If you do not want this effect, reset the PageSetup.LabelSizeManual property to false immediately after you set the label height.

The value of the PageSetup.LabelWidth property may be changed by BarTender in certain situations. For more information, refer to Automatic Adjustments to Page Setup Values.

ClosedVB.NET Example

'Declare a BarTender application variable

Dim btApp As BarTender.Application

'Declare a BarTender document variable

Dim btFormat As BarTender.Format

'Declare a BarTender page setup variable

Dim btPageSetup As BarTender.PageSetup

'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, "")

'Set the page setup variable

btPageSetup = btFormat.PageSetup

'Set the width in the current units

btPageSetup.LabelWidth(BarTender.BtUnits.btUnitsCurrent) = 4.0

'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;

// Declare a BarTender page setup variable

BarTender.PageSetup btPageSetup;

// 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, "");

// Set the page setup variable

btPageSetup = btFormat.PageSetup;

// Set the width in the current units

btPageSetup.set_LabelWidth(BarTender.BtUnits.btUnitsCurrent, 4.0f);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);