Description
PageSetup.LabelHoleDiameter Property |
Description
Sets or returns the diameter of a circular item's hole in the units that are specified.
SyntaxPageSetup.LabelHoleDiameter(BtUnits)=Value
Where Value specifies the diameter of the hole and BtUnits can be set to any of the following constants:
btUnitsCurrent: Uses the unit of measure that is currently set as standard; has a value of 0.
btUnitsInches: Uses inches as the unit of measure; has a value of 1.
btUnitsCentimeters: Uses centimeters as the unit of measure; has a value of 2.
btUnitsMillimeters: Uses millimeters as the unit of measure; has a value of 3.
Requirements
|
Version |
BarTender 7.00 or higher |
|
Edition |
Automation, Enterprise Automation |
Remarks
The LabelHoleDiameter property is valid only when the PageSetup.LabelHole property is set to true and the PageSetup.LabelShape property is set to btEllipse.
VB.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)
C# 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);