WordProcessingShape

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

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

public class WordProcessingShape extends ShapeSearchAdapter implements IRotatableTwoDObject, IHyperlinkContainer

Represents a drawing shape in a Word document.

Methods

Method	Description
getSection()	Gets the parent section of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
getHeaderFooter()	Gets the parent header/footer of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) (if presents).
getShapeType()	Gets the shape type.
isWordArt()	Gets a value indicating whether this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) is a WordArt object.
getAlternativeText()	Gets the descriptive (alternative) text associated with this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
setAlternativeText(String value)	Sets the descriptive (alternative) text associated with this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
getName()	Gets the name of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
getBehindText()	Gets a value indicating whether the shape is over or behind the text.
setBehindText(boolean value)	Sets a value indicating whether the shape is over or behind the text.
getText()	Gets the text of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
setText(String value)	Sets the text of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
getFormattedTextFragments()	Gets the collection of formatted text fragments of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
getImage()	Gets the image of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
setImage(WordProcessingWatermarkableImage value)	Sets the image of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
getHorizontalAlignment()	Gets a value specifying how the shape is positioned horizontally.
getVerticalAlignment()	Gets a value specifying how the shape is positioned vertically.
getRelativeHorizontalPosition()	Gets a value specifying to what the shape is positioned horizontally.
getRelativeVerticalPosition()	Gets a value specifying to what the shape is positioned vertically.
getImageFillFormat()
getAsposeWordsShape()
getHyperlink()	Gets the hyperlink associated with this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
setHyperlink(String value)	Sets the hyperlink associated with this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).
getWidth()	Gets the width of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in points.
setWidth(double value)	Sets the width of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in points.
getHeight()	Gets the height of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in points.
setHeight(double value)	Sets the height of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in points.
getRotateAngle()	Gets the rotate angle of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in degrees.
setRotateAngle(double value)	Sets the rotate angle of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in degrees.
getX()	Gets or sets the horizontal offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page left border in points.
setX(double value)	Gets or sets the horizontal offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page left border in points.
getY()	Gets the vertical offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page top border in points.
setY(double value)	Sets the vertical offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page top border in points.
getFormattedTextFragmentsForSearch()
getTextForSearch()
setFoundWatermarkText(String value)
getImageForSearch()
setFoundWatermarkImage(byte[] imageData)

getSection()

public final WordProcessingSection getSection()

Gets the parent section of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

Returns: WordProcessingSection - The parent section of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

getHeaderFooter()

public final WordProcessingHeaderFooter getHeaderFooter()

Gets the parent header/footer of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) (if presents).

Returns: WordProcessingHeaderFooter - The parent header/footer of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

getShapeType()

public final int getShapeType()

Gets the shape type.

Returns: int - The shape type.

isWordArt()

public final boolean isWordArt()

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

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

getAlternativeText()

public final String getAlternativeText()

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

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

setAlternativeText(String value)

public final void setAlternativeText(String value)

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

Parameters:

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

getName()

public final String getName()

Gets the name of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

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

getBehindText()

public final boolean getBehindText()

Gets a value indicating whether the shape is over or behind the text.

Returns: boolean - The value indicating whether the shape is over or behind the text. True if the shape is behind the text; otherwise, false.

setBehindText(boolean value)

public final void setBehindText(boolean value)

Sets a value indicating whether the shape is over or behind the text.

Parameters:

Parameter	Type	Description
value	boolean	The value indicating whether the shape is over or behind the text. True if the shape is behind the text; otherwise, false.

getText()

public final String getText()

Gets the text of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

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

setText(String value)

public final void setText(String value)

Sets the text of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

Parameters:

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

getFormattedTextFragments()

public final FormattedTextFragmentCollection getFormattedTextFragments()

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

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

getImage()

public final WordProcessingWatermarkableImage getImage()

Gets the image of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

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

setImage(WordProcessingWatermarkableImage value)

public final void setImage(WordProcessingWatermarkableImage value)

Sets the image of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape).

Parameters:

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

getHorizontalAlignment()

public final int getHorizontalAlignment()

Gets a value specifying how the shape is positioned horizontally.

Returns: int - The horizontal alignment value.

getVerticalAlignment()

public final int getVerticalAlignment()

Gets a value specifying how the shape is positioned vertically.

Returns: int - The vertical alignment value.

getRelativeHorizontalPosition()

public final int getRelativeHorizontalPosition()

Gets a value specifying to what the shape is positioned horizontally.

Returns: int - The relative horizontal position value.

getRelativeVerticalPosition()

public final int getRelativeVerticalPosition()

Gets a value specifying to what the shape is positioned vertically.

Returns: int - The relative vertical position value.

getImageFillFormat()

public final WordProcessingImageFillFormat getImageFillFormat()

Returns: WordProcessingImageFillFormat

getAsposeWordsShape()

public final Shape getAsposeWordsShape()

Returns: com.aspose.words.Shape

getHyperlink()

public final String getHyperlink()

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

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

setHyperlink(String value)

public final void setHyperlink(String value)

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

Parameters:

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

getWidth()

public final double getWidth()

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

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

setWidth(double value)

public final void setWidth(double value)

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

Parameters:

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

getHeight()

public final double getHeight()

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

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

setHeight(double value)

public final void setHeight(double value)

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

Parameters:

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

getRotateAngle()

public final double getRotateAngle()

Gets the rotate angle of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in degrees.

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

setRotateAngle(double value)

public final void setRotateAngle(double value)

Sets the rotate angle of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) in degrees.

Parameters:

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

getX()

public final double getX()

Gets or sets the horizontal offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page left border in points.

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

setX(double value)

public final void setX(double value)

Gets or sets the horizontal offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page left border in points.

Parameters:

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

getY()

public final double getY()

Gets the vertical offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page top border in points.

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

setY(double value)

public final void setY(double value)

Sets the vertical offset of this [WordProcessingShape](../../com.groupdocs.watermark.contents/wordprocessingshape) from page top border in points.

Parameters:

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

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

getImageForSearch()

public WatermarkableImage getImageForSearch()

Returns: WatermarkableImage

setFoundWatermarkImage(byte[] imageData)

public void setFoundWatermarkImage(byte[] imageData)

Parameters:

Parameter	Type	Description
imageData	byte[]