Open topic with navigation

SubString.Rollover Property

ClosedDescription

Sets and returns whether or not serialization will rollover when it reaches a specified value.

ClosedSyntax

SubString.Rollover = true|false

If true, serialization will begin again when the specified value is reached. The value can be set using the SubString.RolloverLimit property.

ClosedRequirements

Version

BarTender 10.0 or higher

Edition

Automation, Enterprise

ClosedRemarks

The SubString.Rollover property is used to determine whether serialization will restart when it reaches the upper or lower bounds of a sequence. If you are decrementing the contents of a data source, this is also known as the rollunder option in the BarTender user interface. When using the ActiveX interface, both the rollover and rollunder features are enabled using the SubString.Rollover property.

ClosedVB.NET Example

'Declare a BarTender application variable

Dim btApp As BarTender.Application

'Declare a BarTender document variable

Dim btFormat As New BarTender.Format

'Declare a BarTender data source variable

Dim btSubString As BarTender.SubString

'Declare a BarTender print setup variable

Dim btPrintSetup As BarTender.PrintSetup

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

'Select the data source

btSubString = btFormat.NamedSubStrings.GetSubString(1)

'Set to rollover when serialization reaches 999

btSubString.Rollover = True

btSubString.RolloverLimit = 999

'Select the print setup variable property

btPrintSetup = btFormat.PrintSetup

'Set the number of serialized items

btPrintSetup.NumberSerializedLabels = 10

'Print the document

btFormat.PrintOut(False, False)

'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 data source variable

BarTender.SubString btSubString;

// Declare a BarTender print setup variable

BarTender.PrintSetup btPrintSetup;

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

// Select the data source

btSubString = btFormat.NamedSubStrings.GetSubString(1);

// Set to rollover when serialization reaches 999

btSubString.Rollover = true;

btSubString.RolloverLimit = 999;

// Select the print setup variable property

btPrintSetup = btFormat.PrintSetup;

// Set the number of serialized items

btPrintSetup.NumberSerializedLabels = 10;

// Print the document

btFormat.PrintOut(false, false);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);

Related Topics