DocumentCacheGetOrAddPdf Method

Gets or adds the PDF cache file. This method handles the first step of the conversion: Source -> PDF.

Normally you would not need to call this method directly because calling only PreCacheDocument(FileProvider, DocumentCacheOptions) method handles the conversion chain: Source -> PDF -> XPZ.

Definition

Namespace: GleamTech.DocumentUltimate.Caching
Assembly: GleamTech.DocumentUltimate (in GleamTech.DocumentUltimate.dll) Version: 6.9.8

C#

public FileCacheItem GetOrAddPdf(
	DocumentCacheInfo cacheInfo,
	string attachment = null
)

VB

Public Function GetOrAddPdf ( 
	cacheInfo As DocumentCacheInfo,
	Optional attachment As String = Nothing
) As FileCacheItem

cacheInfo DocumentCacheInfo: The cache info for a document.
attachment String (Optional): The name of the attachment inside PDF Portfolio file to extract and generate PDF for.
The attachment name in a PDF Portfolio file, can have folder information e.g. "Subfolder/File.docx". Also nested attachments can be accessed with "|" separator e.g. "FirstLevel.msg|SecondLevel.docx".

FileCacheItem
A FileCacheItem instance for the cached PDF file, this object contains information like cache key.