PdfDocument class
Represents a PDF document and can be used to create a new PDF document from the scratch.
Constructors
-
PdfDocument.new({List<
int> ? inputBytes, PdfConformanceLevel? conformanceLevel, String? password}) - Initialize a new instance of the PdfDocument class from the PDF data as list of bytes
- PdfDocument.fromBase64String(String base64String, {String? password})
- Initialize a new instance of the PdfDocument class from the PDF data as base64 string
Properties
- attachments → PdfAttachmentCollection
-
Gets the attachment collection of the document.
no setter
- bookmarks → PdfBookmarkBase
-
Gets the bookmark collection of the document.
no setter
- colorSpace ↔ PdfColorSpace
-
Gets the color space of the document.
This property can be used to create PDF document in RGB,
Grayscale or CMYK color spaces.
getter/setter pair
- compressionLevel ↔ PdfCompressionLevel?
-
Gets or sets the PDF document compression level.
getter/setter pair
- documentInformation → PdfDocumentInformation
-
Gets document's information and properties such as document's title, subject, keyword etc.
no setter
- fileStructure ↔ PdfFileStructure
-
Gets the internal structure of the PDF document.
getter/setter pair
- form → PdfForm
-
Gets the interactive form of the document.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- layers → PdfLayerCollection
-
Gets the collection of PdfLayer from the PDF document.
no setter
- namedDestinationCollection → PdfNamedDestinationCollection
-
Gets the named destination collection of the document.
no setter
- onPdfPassword ↔ PdfPasswordCallback?
-
The event raised on Pdf password.
getter/setter pair
- pages → PdfPageCollection
-
Gets the collection of pages in the document.
no setter
- pageSettings ↔ PdfPageSettings
-
Gets the document's page setting.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sections → PdfSectionCollection?
-
Gets the collection of the sections in the document.
no setter
- security → PdfSecurity
-
Gets the security features of the document like encryption.
no setter
- template ↔ PdfDocumentTemplate
-
Gets a template to all pages in the document.
getter/setter pair
Methods
-
dispose(
) → void - Releases all the resources used by document instances.
-
exportAnnotation(
PdfAnnotationDataFormat format, {String? fileName, List< PdfAnnotation> ? exportList, List<PdfAnnotationExportType> ? exportTypes, bool exportAppearance = false}) → List<int> - Export the annotation data to UTF8 bytes with the specific PdfAnnotationDataFormat.
-
importAnnotation(
List< int> data, PdfAnnotationDataFormat format) → void - Import the annotation data from UTF8 bytes with the specific PdfAnnotationDataFormat.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
save(
) → Future< List< int> > - Saves the document and return the saved bytes as future list of int.
-
saveAsBytes(
) → Future< Uint8List> - Saves the document and return the saved bytes as feature Uint8List.
-
saveAsBytesSync(
) → Uint8List - Saves the document and return the saved bytes as Uint8List.
-
saveSync(
) → List< int> - Saves the document and return the saved bytes as list of int.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited