SpreadsheetShape (GroupDocs.Watermark (26.4) API Reference)

java.lang.Object
- com.groupdocs.watermark.search.ShapeSearchAdapter
- - com.groupdocs.watermark.contents.SpreadsheetShape

All Implemented Interfaces:

IHyperlinkContainer, IRotatableTwoDObject, ITwoDObject
```
public class SpreadsheetShape
extends ShapeSearchAdapter
implements IRotatableTwoDObject, IHyperlinkContainer
```
Represents a drawing shape in an Excel document.

Method Summary

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

Methods inherited from class com.groupdocs.watermark.search.ShapeSearchAdapter
getPageNumber

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAlternativeText
```
public final String getAlternativeText()
```
    Gets the descriptive (alternative) text associated with this SpreadsheetShape.
    
    Returns:
    
    The descriptive (alternative) text associated with this SpreadsheetShape.
  - getAsposeCellsShape
```
public final com.aspose.cells.Shape getAsposeCellsShape()
```
  - getAutoShapeType
```
public final int getAutoShapeType()
```
    Gets the auto shape type.
    
    Returns:
    
    The auto shape type.
  - getFormattedTextFragments
```
public final FormattedTextFragmentCollection getFormattedTextFragments()
```
    Gets the collection of formatted text fragments of this SpreadsheetShape.
    
    Returns:
    
    The collection of formatted text fragments of this SpreadsheetShape.
  - getFormattedTextFragmentsForSearch
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```
    Overrides:
    
    getFormattedTextFragmentsForSearch in class ShapeSearchAdapter
  - getHeight
```
public final double getHeight()
```
    Gets the height of this SpreadsheetShape in points.
    
    Specified by:
    
    getHeight in interface ITwoDObject
    
    Returns:
    
    The height of this SpreadsheetShape in points.
  - getHyperlink
```
public final String getHyperlink()
```
    Gets the hyperlink associated with this SpreadsheetShape.
    
    Specified by:
    
    getHyperlink in interface IHyperlinkContainer
    
    Returns:
    
    The hyperlink associated with this SpreadsheetShape.
  - getId
```
public final int getId()
```
    Gets the identifier of this SpreadsheetShape.
    
    Returns:
    
    The identifier of this SpreadsheetShape.
  - getImage
```
public final SpreadsheetWatermarkableImage getImage()
```
    Gets the image of this SpreadsheetShape.
    
    Returns:
    
    The image of this SpreadsheetShape or null if the shape has no image.
  - getImageFillFormat
```
public final SpreadsheetImageFillFormat getImageFillFormat()
```
    Gets the image fill format settings of this SpreadsheetShape.
    
    Returns:
    
    The image fill format settings of this SpreadsheetShape.
  - getImageForSearch
```
public WatermarkableImage getImageForSearch()
```
    Overrides:
    
    getImageForSearch in class ShapeSearchAdapter
  - getMsoDrawingType
```
public final int getMsoDrawingType()
```
    Gets the mso drawing type.
    
    Returns:
    
    The mso drawing type.
  - getName
```
public final String getName()
```
    Gets the name of this SpreadsheetShape.
    
    Returns:
    
    The name of this SpreadsheetShape.
  - getRotateAngle
```
public final double getRotateAngle()
```
    Gets or sets the rotate angle of this SpreadsheetShape in degrees.
    
    Specified by:
    
    getRotateAngle in interface IRotatableTwoDObject
    
    Returns:
    
    The rotate angle of this SpreadsheetShape in degrees.
  - getText
```
public final String getText()
```
    Gets the text of this SpreadsheetShape.
    
    Returns:
    
    The text of this SpreadsheetShape.
  - getTextForSearch
```
public String getTextForSearch()
```
    Overrides:
    
    getTextForSearch in class ShapeSearchAdapter
  - getWidth
```
public final double getWidth()
```
    Gets the width of this SpreadsheetShape in points.
    
    Specified by:
    
    getWidth in interface ITwoDObject
    
    Returns:
    
    The width of this SpreadsheetShape in points.
  - getWorksheet
```
public final SpreadsheetWorksheet getWorksheet()
```
    Gets the parent worksheet of this SpreadsheetShape.
    
    Returns:
    
    The parent worksheet of this SpreadsheetShape.
  - getX
```
public final double getX()
```
    Gets the horizontal offset of this SpreadsheetShape from worksheet left border in points.
    
    Specified by:
    
    getX in interface ITwoDObject
    
    Returns:
    
    The x-coordinate of this SpreadsheetShape.
  - getY
```
public final double getY()
```
    Gets the vertical offset of this SpreadsheetShape from worksheet top border in points.
    
    Specified by:
    
    getY in interface ITwoDObject
    
    Returns:
    
    The y-coordinate of this SpreadsheetShape.
  - isWordArt
```
public final boolean isWordArt()
```
    Gets a value indicating whether this SpreadsheetShape is a WordArt object.
    
    Returns:
    
    True if the shape is a WordArt object; otherwise, false.
  - setAlternativeText
```
public final void setAlternativeText(String value)
```
    Sets the descriptive (alternative) text associated with this SpreadsheetShape.
    
    Parameters:
    
    value - The descriptive (alternative) text associated with this SpreadsheetShape.
  - setFoundWatermarkImage
```
public void setFoundWatermarkImage(byte[] imageData)
```
    Overrides:
    
    setFoundWatermarkImage in class ShapeSearchAdapter
  - setFoundWatermarkText
```
public void setFoundWatermarkText(String value)
```
    Overrides:
    
    setFoundWatermarkText in class ShapeSearchAdapter
  - setHeight
```
public final void setHeight(double value)
```
    Sets the height of this SpreadsheetShape in points.
    
    Parameters:
    
    value - The height of this SpreadsheetShape in points.
  - setHyperlink
```
public final void setHyperlink(String value)
```
    Sets the hyperlink associated with this SpreadsheetShape.
    
    Specified by:
    
    setHyperlink in interface IHyperlinkContainer
    
    Parameters:
    
    value - The hyperlink associated with this SpreadsheetShape.
  - setImage
```
public final void setImage(SpreadsheetWatermarkableImage value)
```
    Sets the image of this SpreadsheetShape.
    
    Parameters:
    
    value - The image of this SpreadsheetShape or null if the image should be removed.
  - setRotateAngle
```
public final void setRotateAngle(double value)
```
    Gets or sets the rotate angle of this SpreadsheetShape in degrees.
    
    Parameters:
    
    value - The rotate angle of this SpreadsheetShape in degrees.
  - setText
```
public final void setText(String value)
```
    Sets the text of this SpreadsheetShape.
    
    Parameters:
    
    value - The text of this SpreadsheetShape.
  - setWidth
```
public final void setWidth(double value)
```
    Sets the width of this SpreadsheetShape in points.
    
    Parameters:
    
    value - The width of this SpreadsheetShape in points.
  - setX
```
public final void setX(double value)
```
    Sets the horizontal offset of this SpreadsheetShape from worksheet left border in points.
    
    Parameters:
    
    value - The x-coordinate of this SpreadsheetShape.
  - setY
```
public final void setY(double value)
```
    Sets the vertical offset of this SpreadsheetShape from worksheet top border in points.
    
    Parameters:
    
    value - The y-coordinate of this SpreadsheetShape.

Class SpreadsheetShape

Method Summary

Methods inherited from class com.groupdocs.watermark.search.ShapeSearchAdapter

Methods inherited from class java.lang.Object

Method Detail

getAlternativeText

getAsposeCellsShape

getAutoShapeType

getFormattedTextFragments

getFormattedTextFragmentsForSearch

getHeight

getHyperlink

getId

getImage

getImageFillFormat

getImageForSearch

getMsoDrawingType

getName

getRotateAngle

getText

getTextForSearch

getWidth

getWorksheet

getX

getY

isWordArt

setAlternativeText

setFoundWatermarkImage

setFoundWatermarkText

setHeight

setHyperlink

setImage

setRotateAngle

setText

setWidth

setX

setY