Blackbaud Internet Solutions

Technical Reference

Documents Class

Contains methods that can be used to add, update, and delete documents as well as retrieve document and document library information.

Inheritance Hierarchy

SystemObject
BBNCExtensions.API.DocumentsDocuments

Namespace: BBNCExtensions.API.Documents
Assemblies: BBNCExtensions (in BBNCExtensions.dll) Version: 6.10.0.0
BBNCExtensions (in BBNCExtensions.dll) Version: 6.10.0.0

Syntax

C++

Copy

public abstract class Documents

Public MustInherit Class Documents

public ref class Documents abstract

The Documents type exposes the following members.

Methods

	Name	Description
	AddDocument	Add a document to an existing library.
	DeleteDocument	Permanantly removes a document from the site.
	GetDocumentInfo	Retrieve the DocumentInfo object for a given document.
	GetDocumentLibraryInfo	Get the API.Documents.DocumentLibraryInfo object of the Document Library associated with a given Document Part.
	GetDocumentLibraryInfoDirect	Get the API.Documents.DocumentLibraryInfo object of the specified Document Library. This direct approach does not require you have an associated content Part Id to retrieve the Library info, since document libraries may exist which are not explictly associating with a Documents Part.
	GetDocumentURL	Returns the URL for an uploaded document.
	GetLibaryDocuments	Returns info on every Document in a given library associated with a Documents part.
	GetLibaryDocumentsDirect	Returns info on every Document in a given library, accessing the library directly by its id. This direct approach does not require you have an associated content Part Id to retrieve the Library documents, since document libraries may exist which are not explictly associating with a Documents Part.
	UpdateDocument	Replace an existing document.

Reference

BBNCExtensions.API.Documents Namespace