WordProcessingShape (GroupDocs.Watermark (26.4) API Reference)

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

All Implemented Interfaces:

IHyperlinkContainer, IRotatableTwoDObject, ITwoDObject
```
public class WordProcessingShape
extends ShapeSearchAdapter
implements IRotatableTwoDObject, IHyperlinkContainer
```
Represents a drawing shape in a Word 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 `WordProcessingShape`.
`com.aspose.words.Shape`	`getAsposeWordsShape()`
`boolean`	`getBehindText()` Gets a value indicating whether the shape is over or behind the text.
`FormattedTextFragmentCollection`	`getFormattedTextFragments()` Gets the collection of formatted text fragments of this `WordProcessingShape`.
`FormattedTextFragmentCollection`	`getFormattedTextFragmentsForSearch()`
`WordProcessingHeaderFooter`	`getHeaderFooter()` Gets the parent header/footer of this `WordProcessingShape` (if presents).
`double`	`getHeight()` Gets the height of this `WordProcessingShape` in points.
`int`	`getHorizontalAlignment()` Gets a value specifying how the shape is positioned horizontally.
`String`	`getHyperlink()` Gets the hyperlink associated with this `WordProcessingShape`.
`WordProcessingWatermarkableImage`	`getImage()` Gets the image of this `WordProcessingShape`.
`WordProcessingImageFillFormat`	`getImageFillFormat()`
`WatermarkableImage`	`getImageForSearch()`
`String`	`getName()` Gets the name of this `WordProcessingShape`.
`int`	`getRelativeHorizontalPosition()` Gets a value specifying to what the shape is positioned horizontally.
`int`	`getRelativeVerticalPosition()` Gets a value specifying to what the shape is positioned vertically.
`double`	`getRotateAngle()` Gets the rotate angle of this `WordProcessingShape` in degrees.
`WordProcessingSection`	`getSection()` Gets the parent section of this `WordProcessingShape`.
`int`	`getShapeType()` Gets the shape type.
`String`	`getText()` Gets the text of this `WordProcessingShape`.
`String`	`getTextForSearch()`
`int`	`getVerticalAlignment()` Gets a value specifying how the shape is positioned vertically.
`double`	`getWidth()` Gets the width of this `WordProcessingShape` in points.
`double`	`getX()` Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points.
`double`	`getY()` Gets the vertical offset of this `WordProcessingShape` from page top border in points.
`boolean`	`isWordArt()` Gets a value indicating whether this `WordProcessingShape` is a WordArt object.
`void`	`setAlternativeText(String value)` Sets the descriptive (alternative) text associated with this `WordProcessingShape`.
`void`	`setBehindText(boolean value)` Sets a value indicating whether the shape is over or behind the text.
`void`	`setFoundWatermarkImage(byte[] imageData)`
`void`	`setFoundWatermarkText(String value)`
`void`	`setHeight(double value)` Sets the height of this `WordProcessingShape` in points.
`void`	`setHyperlink(String value)` Sets the hyperlink associated with this `WordProcessingShape`.
`void`	`setImage(WordProcessingWatermarkableImage value)` Sets the image of this `WordProcessingShape`.
`void`	`setRotateAngle(double value)` Sets the rotate angle of this `WordProcessingShape` in degrees.
`void`	`setText(String value)` Sets the text of this `WordProcessingShape`.
`void`	`setWidth(double value)` Sets the width of this `WordProcessingShape` in points.
`void`	`setX(double value)` Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points.
`void`	`setY(double value)` Sets the vertical offset of this `WordProcessingShape` from page 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 WordProcessingShape.
    
    Returns:
    
    The descriptive (alternative) text associated with this WordProcessingShape.
  - getAsposeWordsShape
```
public final com.aspose.words.Shape getAsposeWordsShape()
```
  - getBehindText
```
public final boolean getBehindText()
```
    Gets a value indicating whether the shape is over or behind the text.
    
    Returns:
    
    The value indicating whether the shape is over or behind the text. True if the shape is behind the text; otherwise, false.
  - getFormattedTextFragments
```
public final FormattedTextFragmentCollection getFormattedTextFragments()
```
    Gets the collection of formatted text fragments of this WordProcessingShape.
    
    Returns:
    
    The collection of formatted text fragments of this WordProcessingShape.
  - getFormattedTextFragmentsForSearch
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```
    Overrides:
    
    getFormattedTextFragmentsForSearch in class ShapeSearchAdapter
  - getHeaderFooter
```
public final WordProcessingHeaderFooter getHeaderFooter()
```
    Gets the parent header/footer of this WordProcessingShape (if presents).
    
    Returns:
    
    The parent header/footer of this WordProcessingShape.
  - getHeight
```
public final double getHeight()
```
    Gets the height of this WordProcessingShape in points.
    
    Specified by:
    
    getHeight in interface ITwoDObject
    
    Returns:
    
    The height of this WordProcessingShape in points.
  - getHorizontalAlignment
```
public final int getHorizontalAlignment()
```
    Gets a value specifying how the shape is positioned horizontally.
    
    Returns:
    
    The horizontal alignment value.
  - getHyperlink
```
public final String getHyperlink()
```
    Gets the hyperlink associated with this WordProcessingShape.
    
    Specified by:
    
    getHyperlink in interface IHyperlinkContainer
    
    Returns:
    
    The hyperlink associated with this WordProcessingShape.
  - getImage
```
public final WordProcessingWatermarkableImage getImage()
```
    Gets the image of this WordProcessingShape.
    
    Returns:
    
    The image of this WordProcessingShape or null if the shape has no image.
  - getImageFillFormat
```
public final WordProcessingImageFillFormat getImageFillFormat()
```
  - getImageForSearch
```
public WatermarkableImage getImageForSearch()
```
    Overrides:
    
    getImageForSearch in class ShapeSearchAdapter
  - getName
```
public final String getName()
```
    Gets the name of this WordProcessingShape.
    
    Returns:
    
    The name of this WordProcessingShape.
  - getRelativeHorizontalPosition
```
public final int getRelativeHorizontalPosition()
```
    Gets a value specifying to what the shape is positioned horizontally.
    
    Returns:
    
    The relative horizontal position value.
  - getRelativeVerticalPosition
```
public final int getRelativeVerticalPosition()
```
    Gets a value specifying to what the shape is positioned vertically.
    
    Returns:
    
    The relative vertical position value.
  - getRotateAngle
```
public final double getRotateAngle()
```
    Gets the rotate angle of this WordProcessingShape in degrees.
    
    Specified by:
    
    getRotateAngle in interface IRotatableTwoDObject
    
    Returns:
    
    The rotate angle of this WordProcessingShape in degrees.
  - getSection
```
public final WordProcessingSection getSection()
```
    Gets the parent section of this WordProcessingShape.
    
    Returns:
    
    The parent section of this WordProcessingShape.
  - getShapeType
```
public final int getShapeType()
```
    Gets the shape type.
    
    Returns:
    
    The shape type.
  - getText
```
public final String getText()
```
    Gets the text of this WordProcessingShape.
    
    Returns:
    
    The text of this WordProcessingShape.
  - getTextForSearch
```
public String getTextForSearch()
```
    Overrides:
    
    getTextForSearch in class ShapeSearchAdapter
  - getVerticalAlignment
```
public final int getVerticalAlignment()
```
    Gets a value specifying how the shape is positioned vertically.
    
    Returns:
    
    The vertical alignment value.
  - getWidth
```
public final double getWidth()
```
    Gets the width of this WordProcessingShape in points.
    
    Specified by:
    
    getWidth in interface ITwoDObject
    
    Returns:
    
    The width of this WordProcessingShape in points.
  - getX
```
public final double getX()
```
    Gets or sets the horizontal offset of this WordProcessingShape from page left border in points.
    
    Specified by:
    
    getX in interface ITwoDObject
    
    Returns:
    
    The x-coordinate of this WordProcessingShape.
  - getY
```
public final double getY()
```
    Gets the vertical offset of this WordProcessingShape from page top border in points.
    
    Specified by:
    
    getY in interface ITwoDObject
    
    Returns:
    
    The y-coordinate of this WordProcessingShape.
  - isWordArt
```
public final boolean isWordArt()
```
    Gets a value indicating whether this WordProcessingShape 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 WordProcessingShape.
    
    Parameters:
    
    value - The descriptive (alternative) text associated with this WordProcessingShape.
  - setBehindText
```
public final void setBehindText(boolean value)
```
    Sets a value indicating whether the shape is over or behind the text.
    
    Parameters:
    
    value - The value indicating whether the shape is over or behind the text. True if the shape is behind the text; otherwise, false.
  - 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 WordProcessingShape in points.
    
    Parameters:
    
    value - The height of this WordProcessingShape in points.
  - setHyperlink
```
public final void setHyperlink(String value)
```
    Sets the hyperlink associated with this WordProcessingShape.
    
    Specified by:
    
    setHyperlink in interface IHyperlinkContainer
    
    Parameters:
    
    value - The hyperlink associated with this WordProcessingShape.
  - setImage
```
public final void setImage(WordProcessingWatermarkableImage value)
```
    Sets the image of this WordProcessingShape.
    
    Parameters:
    
    value - The image of this WordProcessingShape or null if the image should be removed.
  - setRotateAngle
```
public final void setRotateAngle(double value)
```
    Sets the rotate angle of this WordProcessingShape in degrees.
    
    Parameters:
    
    value - The rotate angle of this WordProcessingShape in degrees.
  - setText
```
public final void setText(String value)
```
    Sets the text of this WordProcessingShape.
    
    Parameters:
    
    value - The text of this WordProcessingShape.
  - setWidth
```
public final void setWidth(double value)
```
    Sets the width of this WordProcessingShape in points.
    
    Parameters:
    
    value - The width of this WordProcessingShape in points.
  - setX
```
public final void setX(double value)
```
    Gets or sets the horizontal offset of this WordProcessingShape from page left border in points.
    
    Parameters:
    
    value - The x-coordinate of this WordProcessingShape.
  - setY
```
public final void setY(double value)
```
    Sets the vertical offset of this WordProcessingShape from page top border in points.
    
    Parameters:
    
    value - The y-coordinate of this WordProcessingShape.

Class WordProcessingShape

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getAlternativeText

getAsposeWordsShape

getBehindText

getFormattedTextFragments

getFormattedTextFragmentsForSearch

getHeaderFooter

getHeight

getHorizontalAlignment

getHyperlink

getImage

getImageFillFormat

getImageForSearch

getName

getRelativeHorizontalPosition

getRelativeVerticalPosition

getRotateAngle

getSection

getShapeType

getText

getTextForSearch

getVerticalAlignment

getWidth

getX

getY

isWordArt

setAlternativeText

setBehindText

setFoundWatermarkImage

setFoundWatermarkText

setHeight

setHyperlink

setImage

setRotateAngle

setText

setWidth

setX

setY