BrcEvent_BeforeInclude event


	BlueCielo TeamWork 2012 VBScript API Reference \| BlueCielo ECM Solutions

You are here: Understanding TeamWork event procedures > About the briefcase events > BrcEvent_BeforeInclude event

BrcEvent_BeforeInclude event

Occurs before each document in the current batch is added to the briefcase.

Syntax

BrcEvent_BeforeInclude(Batch, Briefcase, CheckOut)

Parameters
Name	Description
Batch	An object that represents the batch of documents the user has selected.
Briefcase	An object that represents the briefcase file.
CheckOut	True when the user has selected to check the document out to the briefcase. Read-only.

Remarks

The value of CheckOut can be changed in this event procedure. If it is set to False, the document will only be included in the briefcase (even if the user has selected to check it out). If it is set to True, the document will be checked out to the briefcase.

Related concepts

About the briefcase events