Documentation – Attachments

Python-Net: Add Attachment

Fri, 20 Mar 2026 00:00:00 +0000

File attachments in PDFs allow you to include supplementary documents, images, or other resources directly within the PDF. With PdfContentEditor, you can programmatically attach files to specific pages, set the attachment name, and provide a description.

Create the PdfContentEditor object.
Bind the input PDF.
Open the Attachment file.
Add the Attachment to the PDF.
Save the updated Document.

import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
from io import BytesIO
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_attachment(infile, attachment_file, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add attachment to page 1
    with open(attachment_file, "rb") as attachment_stream:
        content_editor.add_document_attachment(
            attachment_stream,
            path.basename(attachment_file),
            "This is a sample attachment for demonstration purposes.",
        )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Attachment From Path

Fri, 20 Mar 2026 00:00:00 +0000

PDF can include embedded files such as documents, spreadsheets, or images for reference or distribution. The file-path overload of ‘add_document_attachment()’ allows you to add attachments directly from a file path, eliminating the need to open the file manually.

Create the PdfContentEditor object.
Bind the input PDF.
Add the Attachment Using File Path.
Save the updated Document.

import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
from io import BytesIO
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_attachment_from_path(infile, attachment_file, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add attachment using file-path overload
    content_editor.add_document_attachment(
        attachment_file,
        "Attachment added using file path overload.",
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add File Attachment Annotation

Fri, 20 Mar 2026 00:00:00 +0000

File attachment annotations allow you to embed external files as interactive icons on a PDF page. Using the file-path overload, you can attach files directly from disk without manually opening streams. This method also lets you customize the annotation icon and provide a description for users.

Create the PdfContentEditor object.
Bind the input PDF.
Define the Annotation Rectangle.
Add the File Attachment Annotation.
Save the updated Document.

import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
from io import BytesIO
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_file_attachment_annotation(infile, attachment_file, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Create file attachment annotation on page 1
    content_editor.create_file_attachment(
        apd.Rectangle(100, 520, 20, 20),
        "Attachment annotation contents",
        attachment_file,
        1,
        "PushPin",
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add File Attachment Annotation From Stream

Fri, 20 Mar 2026 00:00:00 +0000

File attachment annotations allow embedding files as interactive icons within a PDF page. Using a stream-based approach, you can attach files dynamically without relying on a physical file path. This method also supports customizing the annotation’s appearance, including opacity.

Create the PdfContentEditor object.
Bind the input PDF.
Read the Attachment File as a Stream.
Add the File Attachment Annotation.
Save the updated Document.

import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
from io import BytesIO
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_file_attachment_annotation_from_stream(infile, attachment_file, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)

    with open(attachment_file, "rb") as source_stream:
        attachment_stream = BytesIO(source_stream.read())

    # Create file attachment annotation using stream+opacity overload
    content_editor.create_file_attachment(
        apd.Rectangle(130, 520, 20, 20),
        "Attachment annotation from stream",
        attachment_stream,
        path.basename(attachment_file),
        1,
        "Tag",
        0.75,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Remove Attachments

Fri, 20 Mar 2026 00:00:00 +0000

PDFs may contain attachments such as documents, images, or other files. There are scenarios where you need to clean a PDF of all attachments for security, privacy, or distribution purposes. Using PdfContentEditor, you can programmatically remove all embedded attachments in a document.

Create the PdfContentEditor object.
Bind the input PDF.
Delete All Attachments.
Save the updated Document.

import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
from io import BytesIO
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def remove_attachments(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Remove all attachments from document
    content_editor.delete_attachments()
    # Save updated document
    content_editor.save(outfile)