Description
Format.UsedNamesSampleData Property |
Description
Sets or returns the sample data for an object who's source is database field.
Syntax
Format.UsedNamesSampleData(BtUsedNamesSampleDataType, DatabaseField) = Value
Where
BtUsedNamesSampleDataType is the constant btUsedDatabaseFieldsSampleData, which has a value of 0.
DatabaseField is the database field to find.
Value is a string containing the data that replaces the sample data
Requirements
|
Version |
BarTender 7.75 or higher |
|
Edition |
Automation, Enterprise |
Remarks
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.
VB.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)
C# 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);