←Select platform

LEADDocument Class Members

Summary

The following tables list the members exposed by LEADDocument.

Protected Constructors

Name Description
Protected Constructor LEADDocument Initializes a new instance of LEADDocument.

Public Methods

Name Description
Public Method Clone Clones this document in the specified cache.
Public Method CreateCacheItemPolicy Create a new policy to be used when items of this document is cached.
Public Method CreateDocumentDescriptor Creates a descritpor object that can be used to re-create this document.
Public Method Decrypt Decrypt this document using the specified password.
Public Method static | Shared in VB DocumentToPixels Converts a value from document units to pixels.
Public Method GetAnnotationsFileName Path to the file holding the original annotations.
Public Method GetAnnotationsStream Stream containing the data of the original annotations.
Public Method GetCache Gets the cache object used with by this document.
Public Method GetCacheKeys Get the cache keys used by this document.
Public Method GetDocumentFileName Path to the file holding the original document.
Public Method GetDocumentStream Stream containing the data of the original document.
Public Method GetEditableContent Gets the document in an editable form.
Public Method static | Shared in VB GetRotateFlip Extracts the rotation and flips value of the specified view perspective of this page.
Public Method static | Shared in VB GetViewPerspectiveTransform Helper method to calculate the matrix to use when applying a view perspective.
Public Method LoadDocumentAttachment Loads an attachment as a LEADDocument object.
Public Method LockStreams Lock the document and annotation streams to be used by the current thread only.
Public Method static | Shared in VB PixelsToDocument Converts a value from pixels to document units.
Public Method PointToDocument Converts a point from pixels to document units.
Public Method PointToPixels Converts a point from document units to pixels.
Public Method RectToDocument Converts a rectangle from pixels to document units.
Public Method RectToPixels Converts a rectangle from document units to pixels.
Public Method SaveAttachmentToCache Saves the specified attachment to the cache.
Public Method SaveToCache Saves the document to the cache.
Public Method SaveToFile Exports this document to the specified file using the specified format.
Public Method SaveToUri Exports this document to the specified remote URL using the specified format.
Public Method SetEditableContent Receives editable contents that was properly edited, and reflects changes to the LEADDocument.
Public Method SizeToDocument Converts a size from pixels to document units.
Public Method SizeToPixels Converts a size from document units to pixels.
Public Method UnlockStreams Unlock the document and annotation streams from the current thread.
Public Method UpdateFromDocumentDescriptor Update this document from a descriptor.

Protected Methods

Name Description
Protected Method Dispose Releases all resources used by this LEADDocument.
Protected Method Finalize This method overrides System.Object.Finalize

Public Properties

Name Description
Public Property Annotations Object that manages the annotations of the document.
Public Property Attachments Gets the Object that manages the attachments of the document.
Public Property AutoDeleteAttachmentsFromCache Controls what happens to the external attachment documents when the owner document is deleted from the cache.
Public Property AutoDeleteFromCache Indicates whether to delete all the entries that belong to this document from the cache when it is disposed.
Public Property AutoDisposeDocuments Indicates whether to automatically dispose any child documents.
Public Property AutoDisposeStream Indicates whether LEADDocument should dispose of the stream passed to DocumentFactory.LoadFromStream.
Public Property AutoSaveToCache Indicates whether to automatically save the document to the cache before it is disposed.
Public Property Barcodes Object that manages the barcodes of the document.
Public Property CacheName The name of the cache owner of this document.
Public Property CacheOptions Determines which part of the document will be stored in the cache.
Public Property CacheStatus The cache status of this document.
Public Property CacheUri The URL to the original document's image data if it was stored in the cache.
Public Property DataType Data type of this LEADDocument.
Public Property DocumentId Unique identifier of this document.
Public Property Documents Object that manages the children of this document.
Public Property DocumentType Document type.
Public Property FileLength Length of the original document file or URL.
Public Property Format Gets the LEADTOOLS raster image format identifier for this document.
Public Property FormFields Object that manages the form fields of the document.
Public Property HasAnnotationsStream Indicates that the document has a valid stream containing the data of the original annotations.
Public Property HasCache Indicates whether this LEADDocument is using the cache.
Public Property HasDocuments Determine whether this document has children.
Public Property HasStream Indicates that the document has a valid stream containing the data of the original document.
Public Property History Object that manages the history tracking of this LEADDocument.
Public Property Images Object that manages the raster and SVG image settings of the document.
Public Property InternalObject Internal LEADTOOLS object used with the document.
Public Property IsAnyCacheStatusNotSynced Checks if the cache status of this document or any of its children is not synced.
Public Property IsDecrypted Gets a value that indicates whether this document has been decrypted.
Public Property IsDownloaded Indicates if this document was downloaded.
Public Property IsEncrypted Gets a value that indicates whether this document is encrypted.
Public Property IsLocal Indicate that this document has been created by the user.
Public Property IsReadOnly Indicates that this document is read-only and cannot be modified.
Public Property IsStructureSupported Gets a value that determines whether the document structure is supported.
Public Property LastCacheSyncTime Timestamp of when the document was last saved to the cache sucessfully.
Public Property LoadDuration Time it took the library to load this document in milliseconds.
Public Property Metadata Object that manages the metadata of the document.
Public Property MimeType MIME type of the document.
Public Property Name Name of the document.
Public Property Pages Object that manages the pages of the document.
Public Property RasterCodecs Object that is used to load or save raster images and SVG documents.
Public Property Stream Gets the original document stream.
Public Property Structure Object that manages the structure and table of content of the document.
Public Property Text Object that manages the text and OCR recognition settings of the document.
Public Property Uri Gets the URL to the original document's physical location.
Public Property UserData The user-defined data associated with this document.
Public Property UserId User ID associated with this document.
Public Property UserToken User token associated with the document.
Public Property ViewOptions Optional initial view options of this LEADDocument.

Public Fields

Name Description
Public Field MetadataKey_IsLinearized "IsLinearized" metadata key constant.
Public Field MetadataKey_IsPortfolio Metadata key constant.
Public Field PostUpload_LinearizePdfMinimumLength "PostUpload_LinearizePdfMinimumLength" post upload operation constant.
Public Field UnitsPerInch Number of units per inch used for document coordinates.

See Also

LEADDocument Class

Leadtools.Document Namespace

Help Version 22.0.2023.4.21
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly
Introduction
Getting Started
Namespaces
Leadtools.Document Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.