DocumentInfo Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.signature.domain.documentpreview.IDocumentInfo
public class DocumentInfo implements IDocumentInfo
Defines document description properties.
| Constructor | Description |
|---|---|
| DocumentInfo() | Initializes a new instance of the DocumentInfo class. |
| Method | Description |
|---|---|
| getPageCount() | Document pages count. |
| setPageCount(int value) | Document pages count. |
| getPages() | Collection of document pages descriptions. |
| setPages(List |
Collection of document pages descriptions. |
| getWidthForMaxHeight() | Specifies width for max page height. |
| setWidthForMaxHeight(int value) | Specifies width for max page height. |
| getMaxPageHeight() | Specifies max page height. |
| setMaxPageHeight(int value) | Specifies max page height. |
| getFileType() | File format type. |
| setFileType(FileType value) | File format type. |
| getSize() | Document size in bytes. |
| setSize(long value) | Document size in bytes. |
| addPage(int pageWidth, int pageHeight, int pageIndex) | |
| getTextSignatures() | Collection of document text signatures. |
| getImageSignatures() | Collection of document image signatures added or updated by Signature methods. |
| getDigitalSignatures() | Collection of document digital signatures added or updated by Signature methods. |
| getBarcodeSignatures() | Collection of document barcode signatures added or updated by Signature methods. |
| getQrCodeSignatures() | Collection of document QR-code signatures added or updated by Signature methods. |
| getFormFieldSignatures() | Collection of document Form Field signatures added or updated by Signature methods. |
| getFormFields() | Collection of all existing supported Form Fields in the document. |
| getMetadataSignatures() | Collection of document Metadata signatures. |
| getProcessLogs() | Collection of document history processes like Sign, Update, Delete. |
| getSignatures() | Collection of document all types signatures BaseSignature. |
public DocumentInfo()
Initializes a new instance of the DocumentInfo class.
public final int getPageCount()
Document pages count.
Returns: int
public final void setPageCount(int value)
Document pages count.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final List<PageInfo> getPages()
Collection of document pages descriptions.
Returns: java.util.List<com.groupdocs.signature.domain.PageInfo>
public final void setPages(List<PageInfo> value)
Collection of document pages descriptions.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.List<com.groupdocs.signature.domain.PageInfo> |
public final int getWidthForMaxHeight()
Specifies width for max page height.
Returns: int
public final void setWidthForMaxHeight(int value)
Specifies width for max page height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getMaxPageHeight()
Specifies max page height.
Returns: int
public final void setMaxPageHeight(int value)
Specifies max page height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final FileType getFileType()
File format type.
Returns: FileType
public final void setFileType(FileType value)
File format type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FileType |
public final long getSize()
Document size in bytes.
Returns: long
public final void setSize(long value)
Document size in bytes.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
public final PageInfo addPage(int pageWidth, int pageHeight, int pageIndex)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageWidth | int | |
| pageHeight | int | |
| pageIndex | int |
Returns: PageInfo
public final List<TextSignature> getTextSignatures()
Collection of document text signatures.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.TextSignature>
public final List<ImageSignature> getImageSignatures()
Collection of document image signatures added or updated by Signature methods.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.ImageSignature>
public final List<DigitalSignature> getDigitalSignatures()
Collection of document digital signatures added or updated by Signature methods.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.DigitalSignature>
public final List<BarcodeSignature> getBarcodeSignatures()
Collection of document barcode signatures added or updated by Signature methods.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.BarcodeSignature>
public final List<QrCodeSignature> getQrCodeSignatures()
Collection of document QR-code signatures added or updated by Signature methods.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.QrCodeSignature>
public final List<FormFieldSignature> getFormFieldSignatures()
Collection of document Form Field signatures added or updated by Signature methods.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature>
public final List<FormFieldSignature> getFormFields()
Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature>
public final List<MetadataSignature> getMetadataSignatures()
Collection of document Metadata signatures.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.metadata.MetadataSignature>
public final List<ProcessLog> getProcessLogs()
Collection of document history processes like Sign, Update, Delete.
Returns: java.util.List<com.groupdocs.signature.domain.ProcessLog>
public final List<BaseSignature> getSignatures()
Collection of document all types signatures BaseSignature.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.