com.groupdocs.watermark.contents

Class SpreadsheetAttachmentCollection

java.lang.Object

com.groupdocs.watermark.common.ReadOnlyListBase<T>

com.groupdocs.watermark.common.RemoveOnlyListBase<SpreadsheetAttachment>

com.groupdocs.watermark.contents.SpreadsheetAttachmentCollection

All Implemented Interfaces:

IReadOnlyList<SpreadsheetAttachment>, Iterable<SpreadsheetAttachment>

public class SpreadsheetAttachmentCollection
extends RemoveOnlyListBase<SpreadsheetAttachment>

Represents a collection of attachments in an Excel document.

This collection contains the items of SpreadsheetAttachment type.

Method Summary

Modifier and Type	Method and Description
void	addAttachment(byte[] fileContent, String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height) Adds an attachment to the SpreadsheetWorksheet.
void	addLink(String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height) Adds an attachment by a link (the document will not contain attached file content).
void	removeFromDocument(SpreadsheetAttachment item)

Methods inherited from class com.groupdocs.watermark.common.RemoveOnlyListBase

clear, isReadOnly, remove, removeAt

Methods inherited from class com.groupdocs.watermark.common.ReadOnlyListBase

addInternally, contains, get_Item, getCount, getInnerList, indexOf, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

addAttachment

public final void addAttachment(byte[] fileContent,
                                String sourceFullName,
                                byte[] previewImageContent,
                                double x,
                                double y,
                                double width,
                                double height)

Adds an attachment to the SpreadsheetWorksheet.

Parameters:

fileContent - The content of the file to be attached.

sourceFullName - The full name of the attached file (The extension is used to determine appropriate application to open the file).

previewImageContent - The attached file preview image as a byte array.

x - The x-coordinate of the attachment frame (in points).

y - The y-coordinate of the attachment frame (in points).

width - The width of the attachment frame in points.

height - The height of the attachment frame in points.

addLink

public final void addLink(String sourceFullName,
                          byte[] previewImageContent,
                          double x,
                          double y,
                          double width,
                          double height)

Adds an attachment by a link (the document will not contain attached file content).

Parameters:

sourceFullName - The linked file path.

previewImageContent - The attached file preview image as a byte array.

x - The x-coordinate of the attachment frame (in points).

y - The y-coordinate of the attachment frame (in points).

width - The width of the attachment frame in points.

height - The height of the attachment frame in points.

removeFromDocument

public void removeFromDocument(SpreadsheetAttachment item)

Overrides:

removeFromDocument in class RemoveOnlyListBase<SpreadsheetAttachment>