SpreadsheetShape

Inheritance: java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter

All Implemented Interfaces: com.groupdocs.watermark.search.IRotatableTwoDObject, com.groupdocs.watermark.search.IHyperlinkContainer

public class SpreadsheetShape extends ShapeSearchAdapter implements IRotatableTwoDObject, IHyperlinkContainer

Represents a drawing shape in an Excel document.

Methods

Method	Description
getWorksheet()	Gets the parent worksheet of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getAutoShapeType()	Gets the auto shape type.
getMsoDrawingType()	Gets the mso drawing type.
getText()	Gets the text of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
setText(String value)	Sets the text of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getFormattedTextFragments()	Gets the collection of formatted text fragments of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getImage()	Gets the image of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
setImage(SpreadsheetWatermarkableImage value)	Sets the image of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getImageFillFormat()	Gets the image fill format settings of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getId()	Gets the identifier of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getAlternativeText()	Gets the descriptive (alternative) text associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
setAlternativeText(String value)	Sets the descriptive (alternative) text associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
isWordArt()	Gets a value indicating whether this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) is a WordArt object.
getName()	Gets the name of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getAsposeCellsShape()
getHyperlink()	Gets the hyperlink associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
setHyperlink(String value)	Sets the hyperlink associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).
getX()	Gets the horizontal offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet left border in points.
setX(double value)	Sets the horizontal offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet left border in points.
getY()	Gets the vertical offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet top border in points.
setY(double value)	Sets the vertical offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet top border in points.
getWidth()	Gets the width of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.
setWidth(double value)	Sets the width of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.
getHeight()	Gets the height of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.
setHeight(double value)	Sets the height of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.
getRotateAngle()	Gets or sets the rotate angle of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in degrees.
setRotateAngle(double value)	Gets or sets the rotate angle of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in degrees.
getImageForSearch()
setFoundWatermarkImage(byte[] imageData)
getFormattedTextFragmentsForSearch()
getTextForSearch()
setFoundWatermarkText(String value)

getWorksheet()

public final SpreadsheetWorksheet getWorksheet()

Gets the parent worksheet of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: SpreadsheetWorksheet - The parent worksheet of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getAutoShapeType()

public final int getAutoShapeType()

Gets the auto shape type.

Returns: int - The auto shape type.

getMsoDrawingType()

public final int getMsoDrawingType()

Gets the mso drawing type.

Returns: int - The mso drawing type.

getText()

public final String getText()

Gets the text of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: java.lang.String - The text of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

setText(String value)

public final void setText(String value)

Sets the text of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Parameters:

Parameter	Type	Description
value	java.lang.String	The text of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getFormattedTextFragments()

public final FormattedTextFragmentCollection getFormattedTextFragments()

Gets the collection of formatted text fragments of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: FormattedTextFragmentCollection - The collection of formatted text fragments of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getImage()

public final SpreadsheetWatermarkableImage getImage()

Gets the image of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: SpreadsheetWatermarkableImage - The image of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) or null if the shape has no image.

setImage(SpreadsheetWatermarkableImage value)

public final void setImage(SpreadsheetWatermarkableImage value)

Sets the image of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Parameters:

Parameter	Type	Description
value	SpreadsheetWatermarkableImage	The image of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) or null if the image should be removed.

getImageFillFormat()

public final SpreadsheetImageFillFormat getImageFillFormat()

Gets the image fill format settings of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: SpreadsheetImageFillFormat - The image fill format settings of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getId()

public final int getId()

Gets the identifier of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: int - The identifier of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getAlternativeText()

public final String getAlternativeText()

Gets the descriptive (alternative) text associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: java.lang.String - The descriptive (alternative) text associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

setAlternativeText(String value)

public final void setAlternativeText(String value)

Sets the descriptive (alternative) text associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Parameters:

Parameter	Type	Description
value	java.lang.String	The descriptive (alternative) text associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

isWordArt()

public final boolean isWordArt()

Gets a value indicating whether this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) is a WordArt object.

Returns: boolean - True if the shape is a WordArt object; otherwise, false.

getName()

public final String getName()

Gets the name of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: java.lang.String - The name of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getAsposeCellsShape()

public final Shape getAsposeCellsShape()

Returns: com.aspose.cells.Shape

getHyperlink()

public final String getHyperlink()

Gets the hyperlink associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Returns: java.lang.String - The hyperlink associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

setHyperlink(String value)

public final void setHyperlink(String value)

Sets the hyperlink associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

Parameters:

Parameter	Type	Description
value	java.lang.String	The hyperlink associated with this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getX()

public final double getX()

Gets the horizontal offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet left border in points.

Returns: double - The x-coordinate of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

setX(double value)

public final void setX(double value)

Sets the horizontal offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet left border in points.

Parameters:

Parameter	Type	Description
value	double	The x-coordinate of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getY()

public final double getY()

Gets the vertical offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet top border in points.

Returns: double - The y-coordinate of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

setY(double value)

public final void setY(double value)

Sets the vertical offset of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) from worksheet top border in points.

Parameters:

Parameter	Type	Description
value	double	The y-coordinate of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape).

getWidth()

public final double getWidth()

Gets the width of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

Returns: double - The width of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

setWidth(double value)

public final void setWidth(double value)

Sets the width of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

Parameters:

Parameter	Type	Description
value	double	The width of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

getHeight()

public final double getHeight()

Gets the height of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

Returns: double - The height of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

setHeight(double value)

public final void setHeight(double value)

Sets the height of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

Parameters:

Parameter	Type	Description
value	double	The height of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in points.

getRotateAngle()

public final double getRotateAngle()

Gets or sets the rotate angle of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in degrees.

Returns: double - The rotate angle of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in degrees.

setRotateAngle(double value)

public final void setRotateAngle(double value)

Gets or sets the rotate angle of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in degrees.

Parameters:

Parameter	Type	Description
value	double	The rotate angle of this [SpreadsheetShape](../../com.groupdocs.watermark.contents/spreadsheetshape) in degrees.

getImageForSearch()

public WatermarkableImage getImageForSearch()

Returns: WatermarkableImage

setFoundWatermarkImage(byte[] imageData)

public void setFoundWatermarkImage(byte[] imageData)

Parameters:

Parameter	Type	Description
imageData	byte[]

getFormattedTextFragmentsForSearch()

public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()

Returns: FormattedTextFragmentCollection

getTextForSearch()

public String getTextForSearch()

Returns: java.lang.String

setFoundWatermarkText(String value)

public void setFoundWatermarkText(String value)

Parameters:

Parameter	Type	Description
value	java.lang.String