PageSetup.LabelHole Property

ClosedDescription

Returns and sets whether the printer stock has a hole.

ClosedSyntax

PageSetup.LabelHole = true|false

If true, the stock has a hole.

ClosedRequirements

Version

BarTender 7.00 or higher

Edition

Automation, Enterprise Automation

ClosedRemarks

The LabelHole property is only valid when the PageSetup.LabelShape property is set to btEllipse.

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 template shape as an ellipse

btPageSetup.LabelShape = BarTender.BtShape.btEllipse

'Tell BarTender that the item has a hole

btPageSetup.LabelHole = True

'Set the diameter of the hole in millimeters

btPageSetup.LabelHoleDiameter(BarTender.BtUnits.btUnitsMillimeters) = 20

'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 template shape as an ellipse

btPageSetup.LabelShape = BarTender.BtShape.btEllipse;

// Tell BarTender that the item has a hole

btPageSetup.LabelHole = true;

// Set the diameter of the hole in millimeters

btPageSetup.set_LabelHoleDiameter(BarTender.BtUnits.btUnitsMillimeters, 20.2f);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);