Package com.ironsoftware.ironpdf.attachment

Class AttachmentManager

java.lang.Object

com.ironsoftware.ironpdf.attachment.AttachmentManager

public class AttachmentManager
extends Object

Class used to edit attachment to a PdfDocument.

See: PdfDocument.getAttachment()

Constructor Summary

Constructors

Constructor	Description
AttachmentManager(InternalPdfDocument internalPdfDocument)	Please get AttachmentManager by PdfDocument.getAttachment() instead.

Method Summary

Modifier and Type	Method	Description
void	addAttachment(String name, byte[] attachmentData)	Add a new attachment.
byte[]	getAttachmentData(int index)	Gets attachment data from attachment index
byte[]	getAttachmentData(String name)	Gets attachment data from attachment name
List<String>	getAttachments()	A Collection of file attachment names (keys) contained within this PdfDocument.
void	removeAttachment(int index)	Remove an attachment by attachment index
void	removeAttachment(String name)	Remove an attachment by attachment name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentManager

public AttachmentManager(InternalPdfDocument internalPdfDocument)

Please get AttachmentManager by PdfDocument.getAttachment() instead.

Parameters:

internalPdfDocument - the internal pdf document

Method Detail

getAttachments

public final List<String> getAttachments()

A Collection of file attachment names (keys) contained within this PdfDocument.

Returns:

A list of attachments names

addAttachment

public final void addAttachment(String name,
                                byte[] attachmentData)

Add a new attachment.

Parameters:

name - attachment name

attachmentData - attachment data

removeAttachment

public final void removeAttachment(String name)

Remove an attachment by attachment name

Parameters:

name - attachment name

removeAttachment

public final void removeAttachment(int index)

Remove an attachment by attachment index

Parameters:

index - attachment index

getAttachmentData

public final byte[] getAttachmentData(String name)

Gets attachment data from attachment name

Parameters:

name - Attachment name

Returns:

a attachment data

getAttachmentData

public final byte[] getAttachmentData(int index)

Gets attachment data from attachment index

Parameters:

index - Attachment index

Returns:

a attachment data