3.31 DocumentLibrary

A document management library.

3.31.1 Properties

The following table lists properties along with their access and descriptions.

Property	Access	Description
Application	R/O	Application. The Application object.
CurrentArchiveBytes	R/O	Long. The number of bytes that the current archive location uses on disk.
CurrentArchiveLocation	R/O	String. The path to the library’s archive.
Description	R/O	String. The description of this library.
Documents	R/O	Documents collection. The collection of documents in this library.
DocumentTypes	R/O	DocumentTypes collection. The collection of document types in this library.
FieldDefinitions	R/O	FieldDefinitions collection. The collection of field definitions for this library.
LibraryID	R/O	String. The unique ID for this library.
MaxArchiveBytes	R/O	Long. The maximum number of bytes that can be archived before a new archive location will be created.
Name	R/O	String. The descriptive display name of this library.
NextDocumentNumber	R/O	Long. The number that will be assigned to the next document added to this library.
Parent	R/O	DocumentLibraries collection. The DocumentLibraries collection that owns this object.
StartingVersionNumber	R/O	Long. The default starting version number for new document versions created in this library.

3.31.2 Methods

Document GetDocument(Long DocumentNumber): Returns the Document object with the specified DocumentNumber.

DocumentVersionEvents GetDocumentVersionEvents(Long DocNumber): Returns the DocumentVersionEvents collection pertaining to the document whose DocumentNumber is equal to DocNumber.

IncrementArchiveLocation()

GroupWise archives documents according to a progressive directory naming scheme. Calling this method will cause the document library to begin archiving documents in the next available directory.

This method is not available in GroupWise Remote.

Refresh(): Forces this DocumentLibrary object and its associated object and collections to reread property values from the message database. The actual reading of a specific property may be postponed until the next time the property is accessed. This "lazy evaluation" is an optimization that avoids unnecessary reading of unaccessed properties.