pdfcpu: github.com/pdfcpu/pdfcpu/pkg/api Index | Examples | Files

package api

import "github.com/pdfcpu/pdfcpu/pkg/api"

Package api lets you integrate pdfcpu's operations into your Go backend.

There are two api layers supporting all pdfcpu operations: 

1) The file based layer (used by pdfcpu's cli)
2) The io.ReadSeeker/io.Writer based layer for backend integration.

For any pdfcpu command there are two functions.

The file based function always calls the io.ReadSeeker/io.Writer based function: 

func CommandFile(inFile, outFile string, conf *pdf.Configuration) error
func Command(rs io.ReadSeeker, w io.Writer, conf *pdf.Configuration) error

eg. for optimization: 

func OptimizeFile(inFile, outFile string, conf *pdf.Configuration) error
func Optimize(rs io.ReadSeeker, w io.Writer, conf *pdf.Configuration) error

Index

Examples

Package Files

api.go attach.go boxes.go collect.go create.go crypto.go extract.go fonts.go importImage.go info.go keywords.go merge.go nup.go optimize.go pages.go permissions.go properties.go rotate.go selectPages.go split.go stamp.go trim.go validate.go

func AddAttachments Uses

❖
func AddAttachments(rs io.ReadSeeker, w io.Writer, files []string, coll bool, conf *pdfcpu.Configuration) error

AddAttachments embeds files into a PDF context read from rs and writes the result to w. file is either a file name or a file name and a description separated by a comma.

func AddAttachmentsFile Uses

❖
func AddAttachmentsFile(inFile, outFile string, files []string, coll bool, conf *pdfcpu.Configuration) (err error)

AddAttachmentsFile embeds files into a PDF context read from inFile and writes the result to outFile.

Example

Code: 


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

func AddBoxes Uses

❖
func AddBoxes(rs io.ReadSeeker, w io.Writer, selectedPages []string, pb *pdfcpu.PageBoundaries, conf *pdfcpu.Configuration) error

AddBoxes adds page boundaries for selected pages of rs and writes result to w.

func AddBoxesFile Uses

❖
func AddBoxesFile(inFile, outFile string, selectedPages []string, pb *pdfcpu.PageBoundaries, conf *pdfcpu.Configuration) error

AddBoxesFile adds page boundaries for selected pages of inFile and writes result to outFile.

func AddImageWatermarksFile Uses

❖
func AddImageWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *pdfcpu.Configuration) error

AddImageWatermarksFile adds image stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func AddKeywords Uses

❖
func AddKeywords(rs io.ReadSeeker, w io.Writer, files []string, conf *pdf.Configuration) error

AddKeywords embeds files into a PDF context read from rs and writes the result to w.

func AddKeywordsFile Uses

❖
func AddKeywordsFile(inFile, outFile string, files []string, conf *pdf.Configuration) (err error)

AddKeywordsFile embeds files into a PDF context read from inFile and writes the result to outFile.

func AddPDFWatermarksFile Uses

❖
func AddPDFWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *pdfcpu.Configuration) error

AddPDFWatermarksFile adds PDF stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func AddProperties Uses

❖
func AddProperties(rs io.ReadSeeker, w io.Writer, properties map[string]string, conf *pdf.Configuration) error

AddProperties embeds files into a PDF context read from rs and writes the result to w.

func AddPropertiesFile Uses

❖
func AddPropertiesFile(inFile, outFile string, properties map[string]string, conf *pdf.Configuration) (err error)

AddPropertiesFile embeds files into a PDF context read from inFile and writes the result to outFile.

func AddTextWatermarksFile Uses

❖
func AddTextWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, text, desc string, conf *pdfcpu.Configuration) error

AddTextWatermarksFile adds text stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func AddWatermarks Uses

❖
func AddWatermarks(rs io.ReadSeeker, w io.Writer, selectedPages []string, wm *pdfcpu.Watermark, conf *pdfcpu.Configuration) error

AddWatermarks adds watermarks to all pages selected in rs and writes the result to w.

func AddWatermarksFile Uses

❖
func AddWatermarksFile(inFile, outFile string, selectedPages []string, wm *pdfcpu.Watermark, conf *pdfcpu.Configuration) (err error)

AddWatermarksFile adds watermarks to all selected pages of inFile and writes the result to outFile.

Example

Code: 


// Unique abbreviations are accepted for all watermark descriptor parameters.
// eg. sc = scalefactor or rot = rotation

// Add a "Demo" watermark to all pages of in.pdf along the diagonal running from lower left to upper right.
onTop := false
update := false
wm, _ := TextWatermark("Demo", "", onTop, update, pdfcpu.POINTS)
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 and an absolute scalefactor of 1.0.
onTop = true
wm, _ = TextWatermark("Confidential", "font:Courier, points:48, col: 1 0 0, rot:45, sc:1 abs, ", onTop, update, pdfcpu.POINTS)
AddWatermarksFile("in.pdf", "", []string{"odd"}, wm, nil)

// Add image stamps to in.pdf using absolute scaling and a negative rotation of 90 degrees.
wm, _ = ImageWatermark("image.png", "scalefactor:.5 a, rot:-90", onTop, update, pdfcpu.POINTS)
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.
wm, _ = PDFWatermark("stamp.pdf:2", "sc:.5 abs, diagonal:2", onTop, update, pdfcpu.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

func AddWatermarksMap Uses

❖
func AddWatermarksMap(rs io.ReadSeeker, w io.Writer, m map[int]*pdfcpu.Watermark, conf *pdfcpu.Configuration) error

AddWatermarksMap adds watermarks in m to corresponding pages in rs and writes the result to w.

func AddWatermarksMapFile Uses

❖
func AddWatermarksMapFile(inFile, outFile string, m map[int]*pdfcpu.Watermark, conf *pdfcpu.Configuration) (err error)

AddWatermarksMapFile adds watermarks to corresponding pages in m of inFile and writes the result to outFile.

func Box Uses

❖
func Box(s string, u pdfcpu.DisplayUnit) (*pdfcpu.Box, error)

Box parses a box definition.

func ChangeOwnerPasswordFile Uses

❖
func ChangeOwnerPasswordFile(inFile, outFile string, pwOld, pwNew string, conf *pdfcpu.Configuration) error

ChangeOwnerPasswordFile reads inFile, changes the user password and writes the result to outFile. A configuration containing the current passwords is required.

Example

Code: 


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

func ChangeUserPasswordFile Uses

❖
func ChangeUserPasswordFile(inFile, outFile string, pwOld, pwNew string, conf *pdfcpu.Configuration) error

ChangeUserPasswordFile reads inFile, changes the user password and writes the result to outFile. A configuration containing the current passwords is required.

Example

Code: 


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

func Collect Uses

❖
func Collect(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *pdfcpu.Configuration) error

Collect creates a custom PDF page sequence for selected pages of rs and writes the result to w.

func CollectFile Uses

❖
func CollectFile(inFile, outFile string, selectedPages []string, conf *pdfcpu.Configuration) (err error)

CollectFile creates a custom PDF page sequence for inFile and writes the result to outFile.

func CreateCheatSheetsUserFonts Uses

❖
func CreateCheatSheetsUserFonts(fontNames []string) error

CreateCheatSheetsUserFonts creates single page PDF cheat sheets for installed user fonts.

func CreatePDFFile Uses

❖
func CreatePDFFile(xRefTable *pdf.XRefTable, outFile string, conf *pdf.Configuration) error

CreatePDFFile creates a PDF file for an xRefTable and writes it to outFile.

func CreateUserFontDemoFiles Uses

❖
func CreateUserFontDemoFiles(dir, fn string) error

CreateUserFontDemoFiles creates single page PDF for each Unicode plane covered.

func Crop Uses

❖
func Crop(rs io.ReadSeeker, w io.Writer, selectedPages []string, b *pdfcpu.Box, conf *pdfcpu.Configuration) error

Crop adds crop boxes for selected pages of rs and writes result to w.

func CropFile Uses

❖
func CropFile(inFile, outFile string, selectedPages []string, b *pdfcpu.Box, conf *pdfcpu.Configuration) error

CropFile adds crop boxes for selected pages of inFile and writes result to outFile.

func DecryptFile Uses

❖
func DecryptFile(inFile, outFile string, conf *pdfcpu.Configuration) error

DecryptFile decrypts inFile and writes the result to outFile. A configuration containing the current passwords is required.

Example

Code: 


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

func DisableConfigDir Uses

❖
func DisableConfigDir()

DisableConfigDir disables the configuration directory. Any needed default configuration will be loaded from configuration.go Since the config dir also contains the user font dir, this also limits font usage to the default core font set No user fonts will be available.

func EncryptFile Uses

❖
func EncryptFile(inFile, outFile string, conf *pdfcpu.Configuration) error

EncryptFile encrypts inFile and writes the result to outFile. A configuration containing the current passwords is required.

Example

Code: 


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

func EnsureDefaultConfigAt Uses

❖
func EnsureDefaultConfigAt(path string) error

EnsureDefaultConfigAt switches to the pdfcpu config dir located at path. If path/pdfcpu is not existent, it will be created including config.yml

func ExtractAttachments Uses

❖
func ExtractAttachments(rs io.ReadSeeker, outDir string, fileNames []string, conf *pdfcpu.Configuration) error

ExtractAttachments extracts embedded files from a PDF context read from rs into outDir.

func ExtractAttachmentsFile Uses

❖
func ExtractAttachmentsFile(inFile, outDir string, files []string, conf *pdfcpu.Configuration) error

ExtractAttachmentsFile extracts embedded files from a PDF context read from inFile into outDir.

Example

Code: 


// 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)

func ExtractContent Uses

❖
func ExtractContent(rs io.ReadSeeker, outDir, fileName string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractContent dumps "PDF source" files from rs into outDir for selected pages.

func ExtractContentFile Uses

❖
func ExtractContentFile(inFile, outDir string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractContentFile dumps "PDF source" files from inFile into outDir for selected pages.

Example

Code: 


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

func ExtractFonts Uses

❖
func ExtractFonts(rs io.ReadSeeker, outDir, fileName string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractFonts dumps embedded fontfiles from rs into outDir for selected pages.

func ExtractFontsFile Uses

❖
func ExtractFontsFile(inFile, outDir string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractFontsFile dumps embedded fontfiles from inFile into outDir for selected pages.

Example

Code: 


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

func ExtractImages Uses

❖
func ExtractImages(rs io.ReadSeeker, outDir, fileName string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractImages dumps embedded image resources from rs into outDir for selected pages.

func ExtractImagesFile Uses

❖
func ExtractImagesFile(inFile, outDir string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractImagesFile dumps embedded image resources from inFile into outDir for selected pages.

Example

Code: 


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

func ExtractMetadata Uses

❖
func ExtractMetadata(rs io.ReadSeeker, outDir, fileName string, conf *pdfcpu.Configuration) error

ExtractMetadata dumps all metadata dict entries for rs into outDir.

func ExtractMetadataFile Uses

❖
func ExtractMetadataFile(inFile, outDir string, conf *pdfcpu.Configuration) error

ExtractMetadataFile dumps all metadata dict entries for inFile into outDir.

Example

Code: 


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

func ExtractPages Uses

❖
func ExtractPages(rs io.ReadSeeker, outDir, fileName string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractPages generates single page PDF files from rs in outDir for selected pages.

func ExtractPagesFile Uses

❖
func ExtractPagesFile(inFile, outDir string, selectedPages []string, conf *pdfcpu.Configuration) error

ExtractPagesFile generates single page PDF files from inFile in outDir for selected pages.

Example

Code: 


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

func GetPermissions Uses

❖
func GetPermissions(rs io.ReadSeeker, conf *pdfcpu.Configuration) (*int16, error)

GetPermissions returns the permissions for rs.

func GetPermissionsFile Uses

❖
func GetPermissionsFile(inFile string, conf *pdfcpu.Configuration) (*int16, error)

GetPermissionsFile returns the permissions for inFile.

func HasWatermarks Uses

❖
func HasWatermarks(rs io.ReadSeeker, conf *pdfcpu.Configuration) (bool, error)

HasWatermarks checks rs for watermarks.

func HasWatermarksFile Uses

❖
func HasWatermarksFile(inFile string, conf *pdfcpu.Configuration) (bool, error)

HasWatermarksFile checks inFile for watermarks.

func ImageGrid Uses

❖
func ImageGrid(rows, cols int, desc string) (*pdfcpu.NUp, error)

ImageGrid returns a grid configuration for Nup-ing image files.

func ImageNUp Uses

❖
func ImageNUp(val int, desc string) (*pdfcpu.NUp, error)

ImageNUp returns an NUp configuration for Nup-ing image files.

func ImageWatermark Uses

❖
func ImageWatermark(fileName, desc string, onTop, update bool, u pdfcpu.DisplayUnit) (*pdfcpu.Watermark, error)

ImageWatermark returns an image watermark configuration.

func Import Uses

❖
func Import(s string, u pdfcpu.DisplayUnit) (*pdfcpu.Import, error)

Import parses an Import command string into an internal structure.

func ImportImages Uses

❖
func ImportImages(rs io.ReadSeeker, w io.Writer, imgs []io.Reader, imp *pdfcpu.Import, conf *pdfcpu.Configuration) error

ImportImages appends PDF pages containing images to rs and writes the result to w. If rs == nil a new PDF file will be written to w.

func ImportImagesFile Uses

❖
func ImportImagesFile(imgFiles []string, outFile string, imp *pdfcpu.Import, conf *pdfcpu.Configuration) (err error)

ImportImagesFile appends PDF pages containing images to outFile which will be created if necessary.

Example

Code: 


// 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, _ := Import("form:A3, pos:c, s:1.0", pdfcpu.POINTS)
ImportImagesFile([]string{"a1.png", "a2.jpg", "a3.tiff"}, "out.pdf", imp, nil)

func Info Uses

❖
func Info(rs io.ReadSeeker, selectedPages []string, conf *pdfcpu.Configuration) ([]string, error)

Info returns information about rs.

func InfoFile Uses

❖
func InfoFile(inFile string, selectedPages []string, conf *pdfcpu.Configuration) ([]string, error)

InfoFile returns information about inFile.

func InsertPages Uses

❖
func InsertPages(rs io.ReadSeeker, w io.Writer, selectedPages []string, before bool, conf *pdfcpu.Configuration) error

InsertPages inserts a blank page before or after every page selected of rs and writes the result to w.

func InsertPagesFile Uses

❖
func InsertPagesFile(inFile, outFile string, selectedPages []string, before bool, conf *pdfcpu.Configuration) (err error)

InsertPagesFile inserts a blank page before or after every inFile page selected and writes the result to w.

Example

Code: 


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

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

func InstallFonts Uses

❖
func InstallFonts(fileNames []string) error

InstallFonts installs true type fonts for embedding.

func ListAttachments Uses

❖
func ListAttachments(rs io.ReadSeeker, conf *pdfcpu.Configuration) ([]string, error)

ListAttachments returns a list of embedded file attachments of rs.

func ListAttachmentsFile Uses

❖
func ListAttachmentsFile(inFile string, conf *pdfcpu.Configuration) ([]string, error)

ListAttachmentsFile returns a list of embedded file attachments of inFile.

Example

Code: 


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

func ListBoxes Uses

❖
func ListBoxes(rs io.ReadSeeker, selectedPages []string, pb *pdfcpu.PageBoundaries, conf *pdfcpu.Configuration) ([]string, error)

ListBoxes returns a list of page boundaries for selected pages of rs.

func ListBoxesFile Uses

❖
func ListBoxesFile(inFile string, selectedPages []string, pb *pdfcpu.PageBoundaries, conf *pdfcpu.Configuration) ([]string, error)

ListBoxesFile returns a list of page boundaries for selected pages of inFile.

func ListFonts Uses

❖
func ListFonts() ([]string, error)

ListFonts returns a list of supported fonts.

func ListKeywords Uses

❖
func ListKeywords(rs io.ReadSeeker, conf *pdf.Configuration) ([]string, error)

ListKeywords returns the keyword list of rs.

func ListKeywordsFile Uses

❖
func ListKeywordsFile(inFile string, conf *pdf.Configuration) ([]string, error)

ListKeywordsFile returns the keyword list of inFile.

func ListPermissions Uses

❖
func ListPermissions(rs io.ReadSeeker, conf *pdfcpu.Configuration) ([]string, error)

ListPermissions returns a list of user access permissions.

func ListPermissionsFile Uses

❖
func ListPermissionsFile(inFile string, conf *pdfcpu.Configuration) ([]string, error)

ListPermissionsFile returns a list of user access permissions for inFile.

Example

Code: 


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

func ListProperties Uses

❖
func ListProperties(rs io.ReadSeeker, conf *pdf.Configuration) ([]string, error)

ListProperties returns the property list of rs.

func ListPropertiesFile Uses

❖
func ListPropertiesFile(inFile string, conf *pdf.Configuration) ([]string, error)

ListPropertiesFile returns the property list of inFile.

func LoadConfiguration Uses

❖
func LoadConfiguration()

LoadConfiguration locates and loads the default configuration and also loads installed user fonts.

func Merge Uses

❖
func Merge(rsc []io.ReadSeeker, w io.Writer, conf *pdfcpu.Configuration) error

Merge merges a sequence of PDF streams and writes the result to w.

func MergeAppendFile Uses

❖
func MergeAppendFile(inFiles []string, outFile string, conf *pdfcpu.Configuration) (err error)

MergeAppendFile merges a sequence of inFiles and writes the result to outFile. This operation corresponds to file concatenation in the order specified by inFiles. If outFile already exists, inFiles will be appended.

Example

Code: 


// Merge inFiles by concatenation in the order specified and write the result to out.pdf.
// If out.pdf already exists it will be preserved and serves as the beginning of the merge result.
inFiles := []string{"in1.pdf", "in2.pdf"}
MergeAppendFile(inFiles, "out.pdf", nil)

func MergeCreateFile Uses

❖
func MergeCreateFile(inFiles []string, outFile string, conf *pdfcpu.Configuration) error

MergeCreateFile merges a sequence of inFiles and writes the result to outFile. This operation corresponds to file concatenation in the order specified by inFiles. The first entry of inFiles serves as the destination context where all remaining files get merged into.

Example

Code: 


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

func NUp Uses

❖
func NUp(rs io.ReadSeeker, w io.Writer, imgFiles, selectedPages []string, nup *pdfcpu.NUp, conf *pdfcpu.Configuration) error

NUp rearranges PDF pages or images into page grids and writes the result to w. Either rs or imgFiles will be used.

func NUpFile Uses

❖
func NUpFile(inFiles []string, outFile string, selectedPages []string, nup *pdfcpu.NUp, conf *pdfcpu.Configuration) (err error)

NUpFile rearranges PDF pages or images into page grids and writes the result to outFile.

Example

Code: 


// 4-Up in.pdf and write result to out.pdf.
nup, _ := PDFNUp(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, _ = ImageNUp(9, "f:Tabloid, b:off, m:0")
inFiles = []string{"in1.png", "in2.jpg", "in3.tiff"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

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

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

func NUpFromImage Uses

❖
func NUpFromImage(conf *pdfcpu.Configuration, imageFileNames []string, nup *pdfcpu.NUp) (*pdfcpu.Context, error)

NUpFromImage creates a single page n-up PDF for one image or a sequence of n-up pages for more than one image.

func Optimize Uses

❖
func Optimize(rs io.ReadSeeker, w io.Writer, conf *pdfcpu.Configuration) error

Optimize reads a PDF stream from rs and writes the optimized PDF stream to w.

func OptimizeContext Uses

❖
func OptimizeContext(ctx *pdfcpu.Context) error

OptimizeContext optimizes a PDF context.

func OptimizeFile Uses

❖
func OptimizeFile(inFile, outFile string, conf *pdfcpu.Configuration) (err error)

OptimizeFile reads inFile and writes the optimized PDF to outFile. If outFile is not provided then inFile gets overwritten which leads to the same result as when inFile equals outFile.

Example

Code: 


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)

func PDFGrid Uses

❖
func PDFGrid(rows, cols int, desc string) (*pdfcpu.NUp, error)

PDFGrid returns a grid configuration for Nup-ing PDF files.

func PDFNUp Uses

❖
func PDFNUp(val int, desc string) (*pdfcpu.NUp, error)

PDFNUp returns an NUp configuration for Nup-ing PDF files.

func PDFWatermark Uses

❖
func PDFWatermark(fileName, desc string, onTop, update bool, u pdfcpu.DisplayUnit) (*pdfcpu.Watermark, error)

PDFWatermark returns a PDF watermark configuration.

func PageBoundaries Uses

❖
func PageBoundaries(s string, unit pdfcpu.DisplayUnit) (*pdfcpu.PageBoundaries, error)

PageBoundaries parses a list of box definitions and assignments.

func PageBoundariesFromBoxList Uses

❖
func PageBoundariesFromBoxList(s string) (*pdfcpu.PageBoundaries, error)

PageBoundariesFromBoxList parses a list of box types.

func PageCount Uses

❖
func PageCount(rs io.ReadSeeker, conf *pdfcpu.Configuration) (int, error)

PageCount returns rs's page count.

func PageCountFile Uses

❖
func PageCountFile(inFile string) (int, error)

PageCountFile returns inFile's page count.

func PageDims Uses

❖
func PageDims(rs io.ReadSeeker, conf *pdfcpu.Configuration) ([]pdfcpu.Dim, error)

PageDims returns a sorted slice of mediaBox dimensions for rs.

func PageDimsFile Uses

❖
func PageDimsFile(inFile string) ([]pdfcpu.Dim, error)

PageDimsFile returns a sorted slice of mediaBox dimensions for inFile.

func PagesForPageCollection Uses

❖
func PagesForPageCollection(pageCount int, pageSelection []string) ([]int, error)

PagesForPageCollection returns a slice of page numbers for a page collection. Any page number in any order any number of times allowed.

func PagesForPageRange Uses

❖
func PagesForPageRange(from, thru int) []int

PagesForPageRange returns a slice of page numbers for a page range.

func PagesForPageSelection Uses

❖
func PagesForPageSelection(pageCount int, pageSelection []string, ensureAllforNone bool) (pdf.IntSet, error)

PagesForPageSelection ensures a set of page numbers for an ascending page sequence where each page number may appear only once.

func ParsePageSelection Uses

❖
func ParsePageSelection(s string) ([]string, error)

ParsePageSelection ensures a correct page selection expression.

func ReadContext Uses

❖
func ReadContext(rs io.ReadSeeker, conf *pdfcpu.Configuration) (*pdfcpu.Context, error)

ReadContext uses an io.ReadSeeker to build an internal structure holding its cross reference table aka the Context.

func ReadContextFile Uses

❖
func ReadContextFile(inFile string) (*pdfcpu.Context, error)

ReadContextFile returns inFile's validated context.

func RemoveAttachments Uses

❖
func RemoveAttachments(rs io.ReadSeeker, w io.Writer, files []string, conf *pdfcpu.Configuration) error

RemoveAttachments deletes embedded files from a PDF context read from rs and writes the result to w.

func RemoveAttachmentsFile Uses

❖
func RemoveAttachmentsFile(inFile, outFile string, files []string, conf *pdfcpu.Configuration) (err error)

RemoveAttachmentsFile deletes embedded files from a PDF context read from inFile and writes the result to outFile.

Example

Code: 


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

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

func RemoveBoxes Uses

❖
func RemoveBoxes(rs io.ReadSeeker, w io.Writer, selectedPages []string, pb *pdfcpu.PageBoundaries, conf *pdfcpu.Configuration) error

RemoveBoxes removes page boundaries as specified in pb for selected pages of rs and writes result to w.

func RemoveBoxesFile Uses

❖
func RemoveBoxesFile(inFile, outFile string, selectedPages []string, pb *pdfcpu.PageBoundaries, conf *pdfcpu.Configuration) error

RemoveBoxesFile removes page boundaries as specified in pb for selected pages of inFile and writes result to outFile.

func RemoveKeywords Uses

❖
func RemoveKeywords(rs io.ReadSeeker, w io.Writer, keywords []string, conf *pdf.Configuration) error

RemoveKeywords deletes embedded files from a PDF context read from rs and writes the result to w.

func RemoveKeywordsFile Uses

❖
func RemoveKeywordsFile(inFile, outFile string, keywords []string, conf *pdf.Configuration) (err error)

RemoveKeywordsFile deletes embedded files from a PDF context read from inFile and writes the result to outFile.

func RemovePages Uses

❖
func RemovePages(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *pdfcpu.Configuration) error

RemovePages removes selected pages from rs and writes the result to w.

func RemovePagesFile Uses

❖
func RemovePagesFile(inFile, outFile string, selectedPages []string, conf *pdfcpu.Configuration) (err error)

RemovePagesFile removes selected inFile pages and writes the result to outFile..

Example

Code: 


// 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)

func RemoveProperties Uses

❖
func RemoveProperties(rs io.ReadSeeker, w io.Writer, properties []string, conf *pdf.Configuration) error

RemoveProperties deletes embedded files from a PDF context read from rs and writes the result to w.

func RemovePropertiesFile Uses

❖
func RemovePropertiesFile(inFile, outFile string, properties []string, conf *pdf.Configuration) (err error)

RemovePropertiesFile deletes embedded files from a PDF context read from inFile and writes the result to outFile.

func RemoveWatermarks Uses

❖
func RemoveWatermarks(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *pdfcpu.Configuration) error

RemoveWatermarks removes watermarks from all pages selected in rs and writes the result to w.

func RemoveWatermarksFile Uses

❖
func RemoveWatermarksFile(inFile, outFile string, selectedPages []string, conf *pdfcpu.Configuration) (err error)

RemoveWatermarksFile removes watermarks from all selected pages of inFile and writes the result to outFile.

Example

Code: 


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

// Update stamp for correction:
update = true
wm, _ = TextWatermark("Confidential", "", onTop, update, pdfcpu.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Add another watermark on top of page 1
wm, _ = TextWatermark("Footer stamp", "c:.5 1 1, pos:bc", onTop, update, pdfcpu.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Remove watermark on page 1
RemoveWatermarksFile("in.pdf", "", []string{"1"}, nil)

// Remove all watermarks
RemoveWatermarksFile("in.pdf", "", nil, nil)

func Rotate Uses

❖
func Rotate(rs io.ReadSeeker, w io.Writer, rotation int, selectedPages []string, conf *pdfcpu.Configuration) error

Rotate rotates selected pages of rs clockwise by rotation degrees and writes the result to w.

func RotateFile Uses

❖
func RotateFile(inFile, outFile string, rotation int, selectedPages []string, conf *pdfcpu.Configuration) (err error)

RotateFile rotates selected pages of inFile clockwise by rotation degrees and writes the result to outFile.

Example

Code: 


// 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)

func SetPermissions Uses

❖
func SetPermissions(rs io.ReadSeeker, w io.Writer, conf *pdfcpu.Configuration) error

SetPermissions sets user access permissions. inFile has to be encrypted. A configuration containing the current passwords is required.

func SetPermissionsFile Uses

❖
func SetPermissionsFile(inFile, outFile string, conf *pdfcpu.Configuration) (err error)

SetPermissionsFile sets inFile's user access permissions. inFile has to be encrypted. A configuration containing the current passwords is required.

Example

Code: 


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

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

func Split Uses

❖
func Split(rs io.ReadSeeker, outDir, fileName string, span int, conf *pdfcpu.Configuration) error

Split generates a sequence of PDF files in outDir for the PDF stream read from rs obeying given split span. If span == 1 splitting results in single page PDFs. If span == 0 we split along given bookmarks (level 1 only). Default span: 1

func SplitFile Uses

❖
func SplitFile(inFile, outDir string, span int, conf *pdfcpu.Configuration) error

SplitFile generates a sequence of PDF files in outDir for inFile obeying given split span. If span == 1 splitting results in single page PDFs. If span == 0 we split along given bookmarks (level 1 only). Default span: 1

Example

Code: 


// 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)

// Create a sequence of PDFs representing bookmark secions.
SplitFile("in.pdf", "outDir", 0, nil)

func TextWatermark Uses

❖
func TextWatermark(text, desc string, onTop, update bool, u pdfcpu.DisplayUnit) (*pdfcpu.Watermark, error)

TextWatermark returns a text watermark configuration.

func Trim Uses

❖
func Trim(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *pdfcpu.Configuration) error

Trim generates a trimmed version of rs containing all selected pages and writes the result to w.

func TrimFile Uses

❖
func TrimFile(inFile, outFile string, selectedPages []string, conf *pdfcpu.Configuration) (err error)

TrimFile generates a trimmed version of inFile containing all selected pages and writes the result to outFile.

Example

Code: 


// 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)

func UpdateImageWatermarksFile Uses

❖
func UpdateImageWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *pdfcpu.Configuration) error

UpdateImageWatermarksFile adds image stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func UpdatePDFWatermarksFile Uses

❖
func UpdatePDFWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *pdfcpu.Configuration) error

UpdatePDFWatermarksFile adds PDF stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func UpdateTextWatermarksFile Uses

❖
func UpdateTextWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, text, desc string, conf *pdfcpu.Configuration) error

UpdateTextWatermarksFile adds text stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func Validate Uses

❖
func Validate(rs io.ReadSeeker, conf *pdfcpu.Configuration) error

Validate validates a PDF stream read from rs.

func ValidateContext Uses

❖
func ValidateContext(ctx *pdfcpu.Context) error

ValidateContext validates a PDF context.

func ValidateFile Uses

❖
func ValidateFile(inFile string, conf *pdfcpu.Configuration) error

ValidateFile validates inFile.

Example

Code: 


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

func WatermarkContext Uses

❖
func WatermarkContext(ctx *pdfcpu.Context, selectedPages pdfcpu.IntSet, wm *pdfcpu.Watermark) error

WatermarkContext applies wm for selected pages to ctx.

func WriteContext Uses

❖
func WriteContext(ctx *pdfcpu.Context, w io.Writer) error

WriteContext writes a PDF context to w.

func WriteContextFile Uses

❖
func WriteContextFile(ctx *pdfcpu.Context, outFile string) error

WriteContextFile writes a PDF context to outFile.

type ReadSeekerCloser Uses

❖
type ReadSeekerCloser interface {
    io.ReadSeeker
    io.Closer
}

ReadSeekerCloser combines io.ReadSeeker and io.Closer

Package api imports 17 packages (graph) and is imported by 8 packages. Updated 2021-01-08. Refresh now. Tools for package owners.