DocumentSaveOptions class
Options controlling how a PDF document is saved or exported.
Constructors
-
DocumentSaveOptions({String? userPassword, String? ownerPassword, bool? flatten, bool? incremental, bool? excludeAnnotations, bool? saveForPrinting, List<
DocumentPermissions?> ? permissions, PdfVersion? pdfVersion, bool? includeComments, Object? outputFormat, bool? optimize}) -
const
Properties
- excludeAnnotations → bool?
-
Whether to exclude annotations from the saved file.
final
- flatten → bool?
-
Whether to flatten annotations and form fields into the page content.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- includeComments → bool?
-
Whether to include comments in the exported document (server-backed only).
final
- incremental → bool?
-
Whether to use incremental save (appends changes rather than rewriting).
final
- optimize → bool?
-
Whether to optimise the document for web delivery.
final
- outputFormat → Object?
-
Output format override, e.g.
'pdf/a-2b'(web/standalone only).final - ownerPassword → String?
-
Owner (permissions) password for the output PDF.
final
- pdfVersion → PdfVersion?
-
The PDF version to target when saving.
final
-
permissions
→ List<
DocumentPermissions?> ? -
Permissions to set on the document when encrypting.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- saveForPrinting → bool?
-
Whether to optimise the file for printing (standalone only).
final
- userPassword → String?
-
User (open) password for the output PDF.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - Converts options to a JSON map, omitting null values.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited