api

// Attach 3 files to in.pdf.
AddAttachmentsFile("in.pdf", "", []string{"img.jpg", "attach.pdf", "test.zip"}, nil)

Output:

// Add a "Demo" watermark to all pages of in.pdf along the diagonal running from lower left to upper right.
onTop := false
wm, _ := pdfcpu.ParseWatermarkDetails("Demo", onTop)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Stamp all odd pages of in.pdf in red "Confidential" in 48 point Courier using a rotation angle of 45 degrees.
onTop = true
wm, _ = pdfcpu.ParseWatermarkDetails("Confidential, f:Courier, c: 1 0 0, r:45, s:1 abs, p:48", onTop)
AddWatermarksFile("in.pdf", "", []string{"odd"}, wm, nil)

// Add image stamps to in.pdf using absolute scaling and a negative rotation of 90 degrees.
onTop = true
wm, _ = pdfcpu.ParseWatermarkDetails("image.png, s:.5 a, r:-90", onTop)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Add a PDF stamp to all pages of in.pdf using the 2nd page of stamp.pdf, use absolute scaling of 0.5
// and rotate along the 2nd diagonal running from upper left to lower right corner.
onTop = true
wm, _ = pdfcpu.ParseWatermarkDetails("stamp.pdf:2, s:.5 a, d:2", onTop)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

Output:

// Changing the owner password for an AES-256 encrypted file.
conf := pdf.NewAESConfiguration("upw", "opw", 256)
ChangeOwnerPasswordFile("in.pdf", "", "opw", "opwNew", conf)

Output:

// Changing the user password for an AES-256 encrypted file.
conf := pdf.NewAESConfiguration("upw", "opw", 256)
ChangeUserPasswordFile("in.pdf", "", "upw", "upwNew", conf)

Output:

// Decrypting an AES-256 encrypted file.
conf := pdf.NewAESConfiguration("upw", "opw", 256)
DecryptFile("in.pdf", "", conf)

Output:

// Encrypting a file using AES-256.
conf := pdf.NewAESConfiguration("upw", "opw", 256)
EncryptFile("in.pdf", "", conf)

Output:

// Extract 1 attachment from in.pdf into outDir.
ExtractAttachmentsFile("in.pdf", "outDir", []string{"img.jpg"}, nil)

// Extract all attachments from in.pdf into outDir
ExtractAttachmentsFile("in.pdf", "outDir", nil, nil)

Output:

// Extract content for all pages in PDF syntax from in.pdf into outDir.
ExtractContentFile("in.pdf", "outDir", nil, nil)

Output:

// Extract embedded fonts for pages 1-3 from in.pdf into outDir.
ExtractFontsFile("in.pdf", outDir, []string{"1-3"}, nil)

Output:

// Extract embedded images from in.pdf into outDir.
ExtractImagesFile("in.pdf", "outDir", nil, nil)

Output:

// Extract all metadata from in.pdf into outDir.
ExtractMetadataFile("in.pdf", "outDir", nil, nil)

Output:

// Extract all even numbered pages from in.pdf into outDir.
ExtractPagesFile("in.pdf", outDir, []string{"even"}, nil)

Output:

// Convert an image into a single page of out.pdf which will be created if necessary.
// The page dimensions will match the image dimensions.
// If out.pdf already exists, append a new page.
// Use the default import configuration.
ImportImagesFile([]string{"image.png"}, "out.pdf", nil, nil)

// Import images by creating an A3 page for each image.
// Images are page centered with 1.0 relative scaling.
// Import an image as a new page of the existing out.pdf.
imp, _ := pdf.ParseImportDetails("f:A3, p:c, s:1.0")
ImportImagesFile([]string{"a1.png", "a2.jpg", "a3.tiff"}, "out.pdf", imp, nil)

Output:

// Insert a blank page into in.pdf before page #3.
InsertPagesFile("in.pdf", "", []string{"3"}, nil)

// Insert a blank page into in.pdf before every page.
InsertPagesFile("in.pdf", "", nil, nil)

Output:

// Output a list of attachments of in.pdf.
list, _ := ListAttachmentsFile("in.pdf", nil)
for _, s := range list {
	fmt.Println(s)
}

Output:

// Output the current permissions of in.pdf.
list, _ := ListPermissionsFile("in.pdf", nil)
for _, s := range list {
	fmt.Println(s)
}

Output:

// Merge inFiles by concatenation in the order specified and write the result to out.pdf.
inFiles := []string{"in1.pdf", "in2.pdf"}
MergeFile(inFiles, "out.pdf", nil)

Output:

// 4-Up in.pdf and write result to out.pdf.
nup, _ := pdf.PDFNUpConfig(4, "")
inFiles := []string{"in.pdf"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

// 9-Up a sequence of images using format Tabloid w/o borders and no margins.
nup, _ = pdf.ImageNUpConfig(9, "f:Tabloid, b:off, m:0")
inFiles = []string{"in1.png", "in2.jpg", "in3.tiff"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

// TestGridFromPDF
nup, _ = pdf.PDFGridConfig(1, 3, "f:LegalL")
inFiles = []string{"in.pdf"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

// TestGridFromImages
nup, _ = pdf.ImageGridConfig(4, 2, "d:500 500, m:20, b:off")
inFiles = []string{"in1.png", "in2.jpg", "in3.tiff"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

Output:

conf := pdfcpu.NewDefaultConfiguration()

// Set passwords for encrypted files.
conf.UserPW = "upw"
conf.OwnerPW = "opw"

// Configure end of line sequence for writing.
conf.Eol = pdfcpu.EolLF

// Create an optimized version of in.pdf and write it to out.pdf.
OptimizeFile("in.pdf", "out.pdf", conf)

// Create an optimized version of inFile.
// If you want to modify the original file, pass an empty string for outFile.
// Use nil for a default configuration.
OptimizeFile("in.pdf", "", nil)

Output:

// Remove 1 attachment from in.pdf.
RemoveAttachmentsFile("in.pdf", "", []string{"img.jpg"}, nil)

// Remove all attachments from in.pdf
RemoveAttachmentsFile("in.pdf", "", nil, nil)

Output:

// Remove pages 2 and 8 of in.pdf.
RemovePagesFile("in.pdf", "", []string{"2", "8"}, nil)

// Remove first 2 pages of in.pdf.
RemovePagesFile("in.pdf", "", []string{"-2"}, nil)

// Remove all pages >= 10 of in.pdf.
RemovePagesFile("in.pdf", "", []string{"10-"}, nil)

Output:

// Rotate all pages of in.pdf, clockwise by 90 degrees and write the result to out.pdf.
RotateFile("in.pdf", "out.pdf", 90, nil, nil)

// Rotate the first page of in.pdf by 180 degrees.
// If you want to modify the original file, pass an empty string as outFile.
RotateFile("in.pdf", "", 180, []string{"1"}, nil)

Output:

// Setting all permissions for the AES-256 encrypted in.pdf.
conf := pdf.NewAESConfiguration("upw", "opw", 256)
conf.Permissions = pdfcpu.PermissionsAll
SetPermissionsFile("in.pdf", "", conf)

// Restricting permissions for the AES-256 encrypted in.pdf.
conf = pdf.NewAESConfiguration("upw", "opw", 256)
conf.Permissions = pdfcpu.PermissionsNone
SetPermissionsFile("in.pdf", "", conf)

Output:

// Create single page PDFs for in.pdf in outDir using the default configuration.
SplitFile("in.pdf", "outDir", 1, nil)

// Create dual page PDFs for in.pdf in outDir using the default configuration.
SplitFile("in.pdf", "outDir", 2, nil)

Output:

// Create a trimmed version of in.pdf containing odd page numbers only.
TrimFile("in.pdf", "outFile", []string{"odd"}, nil)

// Create a trimmed version of in.pdf containing the first two pages only.
// If you want to modify the original file, pass an empty string for outFile.
TrimFile("in.pdf", "", []string{"1-2"}, nil)

Output:

// Use the default configuration to validate in.pdf.
ValidateFile("in.pdf", nil)

Output: