SaveAs - TPdf - PDFiumPas

Component: TPdf · Unit: PDFium

Saves the copy of PDF document to the specified stream. If PdfVersion is pv13 through pv17, the saved output is normalised and validated for that target version, including existing catalog /Version overrides in incremental output. The validator covers the full PDF 1.1–1.7 / ISO 32000-1 feature timeline: filters (FlateDecode, JBIG2Decode, JPXDecode), object & xref streams, transparency (SMask, ca/CA, blend modes), Tagged PDF (StructTreeRoot, MarkInfo), colour spaces (ICCBased, DeviceN), page boxes (BleedBox/TrimBox/ArtBox), output intents, optional content, AcroForm, CID/Type 0 and OpenType fonts, AES & AES-256 encryption (CFM AESV2/AESV3), all version-restricted annotation subtypes (Widget, Sound, Movie, FreeText, Line, Square, Circle, Highlight, Underline, StrikeOut, Stamp, Ink, Popup, FileAttachment, TrapNet, Squiggly, PrinterMark, Polygon, PolyLine, Caret, Screen, Watermark, 3D, Redact), version-restricted action types (SubmitForm, ResetForm, ImportData, Hide, Named, JavaScript, Trans, SetState, Rendition, GoToE, GoTo3DView), and catalog entries (Perms, Legal, Collection, Requirements, NeedsRendering). Anything that exceeds the chosen target version raises EPdfError. If the document has no existing OpenAction and the target version supports it, the saved PDF opens on the first page with Fit Height zoom. Trial builds apply the trial watermark during save.

Syntax

function SaveAs(Stream: TStream; Option: TSaveOption = saNone; PdfVersion: TPdfVersion = pvUnknown): Boolean;

Stream	TStream value that receives the PDF data
Option	TSaveOption. Save option: `saNone` for a normal save, `saIncremental` for an incremental update, `saNoIncremental` to force a full rewrite, or `saRemoveSecurity` to remove security while saving
PdfVersion	TPdfVersion target; use `pvUnknown` to preserve the current version

function SaveAs(const FileName: string; Option: TSaveOption = saNone; PdfVersion: TPdfVersion = pvUnknown): Boolean;

FileName	string. The output file path. A sibling temporary file is completed first, then atomically replaces the destination
Option	TSaveOption. Save option: `saNone`, `saIncremental`, `saNoIncremental`, or `saRemoveSecurity`
PdfVersion	TPdfVersion target; use `pvUnknown` to preserve the current version

Return Value

Returns True if the document was saved successfully, or False on failure.

Description

Saves the current document to a file path or a TStream. The Option parameter controls the save mode: soNone performs a complete file rewrite, while soIncremental appends only the changes made since the document was last saved (smaller output, but grows over repeated saves).

The PdfVersion parameter specifies the output PDF version; pass pvUnknown to keep the document's existing version.

The Compressed property controls whether object-stream compression is applied during the save.

Conformance behaviour

pv13 normalizes inherited page resources, canonicalizes /ProcSet and removes only default transparency-state entries
pv13 rejects active metadata streams because /Type /Metadata and XMP component metadata require PDF 1.4 or newer
pv13 rejects document /EmbeddedFiles name trees while retaining older embedded-file stream references that do not use the PDF 1.4 name-tree entry
pv13 rejects the document catalog /Lang entry because document-level natural-language identification requires PDF 1.4 or newer
pv14 and older targets reject document catalog /PageLayout /TwoPageLeft and /TwoPageRight values because two-page layouts require PDF 1.5 or newer
pv14 and older targets reject image XObjects with /BitsPerComponent 16 because 16-bit image components require PDF 1.5 or newer
pv14 and older targets reject image XObject /SMaskInData entries because embedded JPEG 2000 soft-mask channels require PDF 1.5 or newer
pv13 with saIncremental raises EPdfError because normalization cannot preserve signed prior revisions
Any encrypted explicit-version output raises EPdfError; callers must remove security before requesting a core-version target
Developer-extension dictionaries are validated independently from the effective core version, including escaped PDF names and strict integer levels
PRC 3D streams require an /ADBE developer extension with /BaseVersion /1.7 and /ExtensionLevel 1 or newer; a bare PDF 1.7 declaration is insufficient
RichMedia annotations and RichMediaExecute actions require an /ADBE developer extension with /BaseVersion /1.7 and /ExtensionLevel 3 or newer
Geospatial /Type /Measure /Subtype /GEO dictionaries and Projection annotations require an /ADBE developer extension with /BaseVersion /1.7 and /ExtensionLevel 3 or newer
Every direct or indirect annotation dictionary reached through a Page /Annots entry must contain the required /Subtype and /Rect entries
Catalog /OCProperties validation requires array /OCGs, dictionary /D, valid default /BaseState /ON and /Intent /View values when present, and array-valued /Configs, /ON, /OFF, /AS, and /Order entries
File saves use a same-directory temporary file and replace the destination only after post-processing succeeds

Example

// Save to file
Pdf.SaveAs('output.pdf');

// Save to stream
var MS: TMemoryStream;
MS := TMemoryStream.Create;
try
  Pdf.SaveAs(MS);
  MS.SaveToFile('output.pdf');
finally
  MS.Free;
end;

SaveAs method