Messages.Item Method

ClosedDescription

Returns a reference to a specified Message object.

This method has the same functionality as the GetMessage method.

ClosedSyntax

Messages.Item(Index)

Where Index is either the index of the message object or a string representing the Message.Number property.

ClosedRequirements

Version

BarTender 7.50 or higher

Edition

Automation, Enterprise Automation

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 printer code template variable

Dim btPCT As BarTender.PrinterCodeTemplate

'Declare a BarTender messages variable to hold all messages

Dim btMessages As BarTender.Messages = Nothing

'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 printer code template variable

btPCT = btFormat.PrinterCodeTemplate

'Export the printer code template

btPCT.Export("SAPscript-ITF", BarTender.BtPctExportType.btPctExportSeparate, "c:\Printer Code Templates\FormatTemplate.prn", "c:\Printer Code Templates\DataTemplate.prn", btMessages)

'Get the text of the first message in the collection

MessageBox.Show(btMessages.Item(1).Message)

'Alternatively, you could use the Number property of the message

'MessageBox.Show(btMessages.Item("3367").Message)

'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 printer code template variable

BarTender.PrinterCodeTemplate btPCT;

// Declare a BarTender messages variable to hold all messages

BarTender.Messages btMessages;

// Declare an object variable

System.Object obj = null;

// 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 printer code template variable

btPCT = btFormat.PrinterCodeTemplate;

// Export the printer code template

btPCT.Export("SAPscript-ITF", BarTender.BtPctExportType.btPctExportSeparate, "c:\\Printer Code Templates\\FormatTemplate.prn", "c:\\Printer Code Templates\\DataTemplate.prn", ref obj);

// Set the messages variable to the object

btMessages = obj as BarTender.Messages;

// Declare an index variable and set to the index value of the message

int index = 1;

// Alternatively, if you plan to use the message's number,

// Declare a string variable

// string index = "3367";

// Set the ind object variable to the value of the index variable

ind = index;

// Get the text of the first message in the collection

MessageBox.Show(btMessages.Item(ref ind).Message);

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);