TPdfStore Class Reference

This object is the place where PDF files are stored. More...

List of all members.

Public Member Functions
Integer	Add (const WideString FileName)
	Adds a new PDF file in the PDF Store.
	Delete (Integer ItemID)
	Deletes an entry from the store.
	Update (Integer ItemID, const WideString FileName)
	Updates a PDF file in the PDF Store.
Public Attributes
IPdfFile	Item
	Returns the PDF file object at index ItemIndex.
IPdfFile	ItemByID
	Returns the PDF file object whose ID is ItemID.
integer	Count
	Number of PDF files in the collection.

---

Detailed Description

This object is the place where PDF files are stored.

The PDF files act as page repositories for documents. A single PDF can hold pages for one or more documents. Once all the documents linked to a PDF file are deleted, the PDF is deleted from the store as well.

---

Member Function Documentation

Integer TPdfStore::Add

(

const WideString

FileName

)

Adds a new PDF file in the PDF Store.

The file is copied whole in the database and an original remains in its current location.

Parameters:

FileName

Complete path and file name of the PDF file to add to the database.

Returns:

Item ID of the new entry.

TPdfStore::Delete

(

Integer

ItemID

)

Deletes an entry from the store.

Parameters:

ItemID

ID of the item to delete.

Exceptions:

EOleException

The item cannot be found.

TPdfStore::Update	(	Integer	ItemID,
		const WideString	FileName
	)

Updates a PDF file in the PDF Store.

The file in the database is overwritten and its previous content is lost.

Parameters:

ItemID	ID of the PDF to update.
FileName	Complete path and file name of the PDF file to add to the database.

---

Member Data Documentation

integer TPdfStore::Count

Number of PDF files in the collection.

IPdfFile TPdfStore::Item

Returns the PDF file object at index ItemIndex.

Note:

The index of a PDF file within a PDF Store can change over time. Do not rely on the index once the item has been retrieved; use its Item ID instead.

Parameters:

ItemIndex

Index of the PdfFile object to retrieve.

See also:

TPdfFile

IPdfFile TPdfStore::ItemByID

Returns the PDF file object whose ID is ItemID.

Parameters:

ItemID

ID of the PdfFile object to retrieve.

See also:

TPdfFile