Open topic with navigation

Format.Encryption Property

ClosedDescription

Sets or returns the encryption key of the active document.

ClosedSyntax

Application.Encryption = Index

Where Index is an integer representing the encryption key that is used.

ClosedRequirements

Version

BarTender 9.1 or higher

Edition

Automation, Enterprise

ClosedRemarks

The Format.Encryption property sets or returns the encryption key flag. If Index is 0, the document is not encrypted. All other values specify the index of encryption key that is set, and the document is saved with the specified encryption key.

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

'Encrypt the document

btFormat.Encryption = 1

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

// Encrypt the document

btFormat.Encryption = 1;

// End the BarTender process

btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);