com.groupdocs.watermark.contents

Class SpreadsheetAttachment

java.lang.Object

com.groupdocs.watermark.common.Attachment

com.groupdocs.watermark.contents.SpreadsheetAttachment

All Implemented Interfaces:

ITwoDObject

public class SpreadsheetAttachment
extends Attachment
implements ITwoDObject

Represents a file attached to an Excel document.

Method Summary

Modifier and Type	Method and Description
void	checkImageType()
String	getAlternativeText() Gets the descriptive (alternative) text associated with the attached file.
com.aspose.cells.OleObject	getAsposeOleObject()
byte[]	getContent() Gets the attached file content.
double	getHeight() Gets the height of the attachment frame in points.
byte[]	getPreviewImageContent() Gets the attached file preview image as a byte array.
String	getSourceFullName() Gets the full name of the attached file.
double	getWidth() Gets the width of the attachment frame in points.
double	getX() Gets the horizontal offset of the attachment frame from worksheet left border in points.
double	getY() Gets the vertical offset of the attachment frame from worksheet top border in points.
boolean	isLink() Gets a value indicating whether the content contains only a link to the file.
void	setAlternativeText(String value) Sets the descriptive (alternative) text associated with the attached file.
void	setContent(byte[] value) Sets the attached file content.
void	setHeight(double value) Sets the height of the attachment frame in points.
void	setPreviewImageContent(byte[] value) Sets the attached file preview image as a byte array.
void	setWidth(double value) Sets the width of the attachment frame in points.
void	setX(double value) Sets the horizontal offset of the attachment frame from worksheet left border in points.
void	setY(double value) Sets the vertical offset of the attachment frame from worksheet top border in points.

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

createWatermarker, createWatermarker, createWatermarker, getContentStream, getDocumentInfo, setContentStream, updateContent

Methods inherited from class java.lang.Object

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

Method Detail

checkImageType

public final void checkImageType()

getAlternativeText

public final String getAlternativeText()

Gets the descriptive (alternative) text associated with the attached file.

Returns:

The descriptive (alternative) text associated with the attached file.

getAsposeOleObject

public final com.aspose.cells.OleObject getAsposeOleObject()

getContent

public byte[] getContent()

Gets the attached file content.

Specified by:

getContent in class Attachment

Returns:

The attached file content.

getHeight

public final double getHeight()

Gets the height of the attachment frame in points.

Specified by:

getHeight in interface ITwoDObject

Returns:

The height of the attachment frame in points.

getPreviewImageContent

public final byte[] getPreviewImageContent()

Gets the attached file preview image as a byte array.

Returns:

The attached file preview image as a byte array.

getSourceFullName

public final String getSourceFullName()

Gets the full name of the attached file.

Returns:

The full name of the attached file.

The extension is used to determine appropriate application to open the file.

getWidth

public final double getWidth()

Gets the width of the attachment frame in points.

Specified by:

getWidth in interface ITwoDObject

Returns:

The width of the attachment frame in points.

getX

public final double getX()

Gets the horizontal offset of the attachment frame from worksheet left border in points.

Specified by:

getX in interface ITwoDObject

Returns:

The x-coordinate of the attachment frame.

getY

public final double getY()

Gets the vertical offset of the attachment frame from worksheet top border in points.

Specified by:

getY in interface ITwoDObject

Returns:

The y-coordinate of the attachment frame.

isLink

public final boolean isLink()

Gets a value indicating whether the content contains only a link to the file.

Returns:

True if the attached file is referenced by a link (the content does not contain attached file content); otherwise, false.

setAlternativeText

public final void setAlternativeText(String value)

Sets the descriptive (alternative) text associated with the attached file.

Parameters:

value - The descriptive (alternative) text associated with the attached file.

setContent

public void setContent(byte[] value)

Sets the attached file content.

Specified by:

setContent in class Attachment

Parameters:

value - The attached file content.

setHeight

public final void setHeight(double value)

Sets the height of the attachment frame in points.

Parameters:

value - The height of the attachment frame in points.

setPreviewImageContent

public final void setPreviewImageContent(byte[] value)

Sets the attached file preview image as a byte array.

Parameters:

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

setWidth

public final void setWidth(double value)

Sets the width of the attachment frame in points.

Parameters:

value - The width of the attachment frame in points.

setX

public final void setX(double value)

Sets the horizontal offset of the attachment frame from worksheet left border in points.

Parameters:

value - The x-coordinate of the attachment frame.

setY

public final void setY(double value)

Sets the vertical offset of the attachment frame from worksheet top border in points.

Parameters:

value - The y-coordinate of the attachment frame.