←Select platform

GetDocumentFileName Method (Document)

Summary

Path to the file holding the original document.

Syntax

Java

C++

public string GetDocumentFileName()

Public Function GetDocumentFileName() As String

public:  
   String^ GetDocumentFileName()

public String getDocumentFileName()

Return Value

The path to the file holding the original document.

Remarks

When a document is created using DocumentFactory.LoadFromUri or DocumentFactory.LoadFromUriAsync, the framework will download the original file and store it in the cache if it is used or a temporary file on the system otherwise. In these cases, the value of IsDownloaded will be true and GetDocumentFileName will return the path to this file (in the cache directly or the temporary one created). Uri will point to the original file or URL used to download the document. If the cache does not support disk access (external resource), the the document data is still stored in the cache and can be retrieved using GetDocumentStream.

If the document is created using DocumentFactory.LoadFromFile then the framework will not download the original file, instead, use it as is. In this case, the value of IsDownloaded will be false and GetDocumentFileName will return the path to the original file used to load the document. Uri will return the same value as GetDocumentFileName in this situation.

If the document is created using DocumentFactory.LoadFromStream then the framework will not download the original file, instead, use the Stream as is. In this case, the value of IsDownloaded will be false and GetDocumentFileName and Uri will return null as well. If the document is then saved into the cache and re-loaded (using SaveToCache and DocumentFactory.LoadFromCache) then the document is treated as it was loaded from a file.

For more information, refer to Loading Using LEADTOOLS Documents Library.

Example

For an example, refer to Document.

Requirements

Target Platforms

See Also