Uri Property

Summary

Gets the URL to the original document's physical location.

Syntax

C++

Java

public Uri Uri {get;}

Public ReadOnly Property Uri() As System.Uri 
   Get

public:  
   property System::Uri^ Uri 
   { 
      System::Uri^ get() 
   }

public URI getUri()

The URL to the original document physical location.

Remarks

The value of Uri depends on how this document was obtained, as follows:

If this document was loaded using DocumentFactory.LoadFromUri or LoadFromUriAsync, Uri is the same value passed to the method.
If this document was loaded using DocumentFactory.LoadFromFile, then the value of Uri is the same value passed as fileName (formatted using the file:/// protocol).
If this document was created using DocumentFactory.Create, then the value of Uri is null.
If this document was loaded using DocumentFactory.LoadFromStream, then the value of Uri is null.

When this document is saved and re-loaded from the cache using SaveToCache and DocumentFactory.LoadFromCache, then Uri will contain the original value before it was saved.

Example

For an example, refer to LEADDocument.

Requirements