Briefcase Object

The Briefcase object represents a briefcase file. The Briefcase object is available to the briefcase event procedures and to the current Document object.

ClosedBriefcase Object Properties

The Briefcase object provides the following properties, most of which are read-only. To affect some read-only properties requires user interaction or custom event procedures.

ClosedMailMessage property

An object that represents a mail message for the current Briefcase object.

Syntax

MailMessage As IASMailMessage

Remarks

Not available in PowerWeb.

ClosedPath Property

The path of the current briefcase file.

Syntax

Path As String

Remarks

Not available in PowerWeb.

ClosedProperty Property

The value of a specified briefcase property (String).

Syntax

Property (Name) As String

Remarks

Not available in PowerWeb.

ClosedSkipCurrentDocContent Property

Used by the Global Collaboration Framework.

Syntax

SkipCurrentDocContent As Boolean

Remarks

Not available in PowerWeb.

ClosedTemplateName Property

The name of the template from which the current briefcase was created.

Syntax

TemplateName As String

Remarks

Not available in PowerWeb.

ClosedTransmittal Property

A Document object that has been copied to the briefcase.

Syntax

Transmittal As IASDocument5

Remarks

Not available in PowerWeb.

ClosedBriefcase Object Methods

The Briefcase object methods affect the current Briefcase object. They are described below.

ClosedArchive Method

Builds (or rebuilds) the current briefcase file.

Syntax

Archive()

Parameters

This method accepts no parameters.

Return Value

The briefcase filename.

Remarks

Not available in PowerWeb. The briefcase file is built by the executable specified for the briefcase template.

ClosedGenerateTransmittalSheet Method

Generates a transmittal sheet for the current briefcase file from a specified report template.

Syntax

GenerateTransmittalSheet(TemplateName)
Parameters
Name Description

TemplateName

Name of the report template to make the transmittal sheet.

Remarks

Not available in PowerWeb.

2022 R2