API Reference
Class
PdfAttachmentEditSession
Mutable attachment collection used by one existing-document attachment edit.
Inheritance
- Object
- PdfAttachmentEditSession
Usage
Explore 5 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
Accepted by parameters 1
- Method PdfDocumentAttachments.Edit
Methods
public PdfAttachmentEditSession Add(PdfEmbeddedFile attachment) #Returns:
PdfAttachmentEditSessionAdds a uniquely named attachment after admitting its payload against the target collection budget.
Parameters
- attachment OfficeIMO.Pdf.PdfEmbeddedFile
Exceptions
PdfReadLimitException– The target collection exceeds its aggregate attachment-byte limit.
Remove 2 overloads
public PdfAttachmentEditSession Remove(String fileName) #Returns:
PdfAttachmentEditSessionRemoves an attachment by file name.
Parameters
- fileName System.String
public PdfAttachmentEditSession Remove(PdfAttachmentInfo attachment) #Returns:
PdfAttachmentEditSessionRemoves one source attachment by its file-spec and embedded-stream identity.
Parameters
- attachment OfficeIMO.Pdf.PdfAttachmentInfo
public PdfAttachmentEditSession Rename(String fileName, String newFileName) #Returns:
PdfAttachmentEditSessionRenames an attachment while preserving payload and metadata.
Parameters
- fileName System.String
- newFileName System.String
public PdfAttachmentEditSession Replace(String fileName, PdfEmbeddedFile replacement) #Returns:
PdfAttachmentEditSessionReplaces the attachment identified by file name, admitting the net payload before changing the collection.
Parameters
- fileName System.String
- replacement OfficeIMO.Pdf.PdfEmbeddedFile
Exceptions
PdfReadLimitException– The target collection exceeds its aggregate attachment-byte limit.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public IReadOnlyList<PdfEmbeddedFile> Attachments { get; } #Current attachment snapshots in edit order.