Open topic with navigation

Format.UsedNamesSampleData Property

ClosedDescription

Sets or returns the sample data for an object who's source is database field.

ClosedSyntax

Format.UsedNamesSampleData(BtUsedNamesSampleDataType, DatabaseField) = Value

Where

ClosedRequirements

Version

BarTender 7.75 or higher

Edition

Automation, Enterprise Automation

ClosedRemarks

The Format.UsedNamesSampleData property can be used to set (change) the Sample Data for all objects that use the specified database field name as their data source. Alternatively, the property can return Sample Data text for the first object created that uses the specified database field name as its data source.

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

'Set the sample data of a database field

btFormat.UsedNamesSampleData(BarTender.BtUsedNamesSampleDataType.btUsedDatabaseFieldsSampleData, "First Name") = "Sarah"

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

// Set the sample data of a database field

btFormat.set_UsedNamesSampleData(BarTender.BtUsedNamesSampleDataType.btUsedDatabaseFieldsSampleData, "First Name", "Sarah");

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);