com.groupdocs.watermark

Interfaces

Classes

Exceptions

com.groupdocs.watermark

Class WordsShape

    • Method Detail

      • getSection

        public final WordsSection getSection()

        Gets the parent section of this WordsShape.

        Returns:
        The parent section of this WordsShape.
      • getHeaderFooter

        public final WordsHeaderFooter getHeaderFooter()

        Gets the parent header/footer of this WordsShape (if presents).

        Returns:
        The parent header/footer of this WordsShape.
      • getShapeType

        public final int getShapeType()

        Gets the shape type.

        Returns:
        The shape type.
      • getWidth

        public final double getWidth()

        Gets the width of this WordsShape in points.

        Specified by:
        getWidth in interface ITwoDObject
        Returns:
        The width of this WordsShape in points.
      • setWidth

        public final void setWidth(double value)

        Sets the width of this WordsShape in points.

        Parameters:
        value - The width of this WordsShape in points.
      • getHeight

        public final double getHeight()

        Gets the height of this WordsShape in points.

        Specified by:
        getHeight in interface ITwoDObject
        Returns:
        The height of this WordsShape in points.
      • setHeight

        public final void setHeight(double value)

        Sets the height of this WordsShape in points.

        Parameters:
        value - The height of this WordsShape in points.
      • isWordArt

        public final boolean isWordArt()

        Gets a value indicating whether this WordsShape is a WordArt object.

        Returns:
        True if the shape is a WordArt object; otherwise, false.
      • getRotateAngle

        public final double getRotateAngle()

        Gets the rotate angle of this WordsShape in degrees.

        Specified by:
        getRotateAngle in interface IRotatableTwoDObject
        Returns:
        The rotate angle of this WordsShape in degrees.
      • setRotateAngle

        public final void setRotateAngle(double value)

        Sets the rotate angle of this WordsShape in degrees.

        Parameters:
        value - The rotate angle of this WordsShape in degrees.
      • getAlternativeText

        public final String getAlternativeText()

        Gets the descriptive (alternative) text associated with this WordsShape.

        Returns:
        The descriptive (alternative) text associated with this WordsShape.
      • setAlternativeText

        public final void setAlternativeText(String value)

        Sets the descriptive (alternative) text associated with this WordsShape.

        Parameters:
        value - The descriptive (alternative) text associated with this WordsShape.
      • getName

        public final String getName()

        Gets the name of this WordsShape.

        Returns:
        The name of this WordsShape.
      • getX

        public final double getX()

        Gets the horizontal offset of this WordsShape from page left border in points.

        Specified by:
        getX in interface ITwoDObject
        Returns:
        The x-coordinate of this WordsShape.
      • setX

        public final void setX(double value)

        Sets the horizontal offset of this WordsShape from page left border in points.

        Parameters:
        value - The x-coordinate of this WordsShape.
      • getY

        public final double getY()

        Gets the vertical offset of this WordsShape from page top border in points.

        Specified by:
        getY in interface ITwoDObject
        Returns:
        The y-coordinate of this WordsShape.
      • setY

        public final void setY(double value)

        Sets the vertical offset of this WordsShape from page top border in points.

        Parameters:
        value - The y-coordinate of this WordsShape.
      • 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.
      • 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.
      • getText

        public final String getText()

        Gets the text of this WordsShape.

        Returns:
        The text of this WordsShape.
      • setText

        public final void setText(String value)

        Sets the text of this WordsShape.

        Parameters:
        value - The text of this WordsShape.
      • getFormattedTextFragments

        public final FormattedTextFragmentCollection getFormattedTextFragments()

        Gets the collection of formatted text fragments of this WordsShape.

        Returns:
        The collection of formatted text fragments of this WordsShape.
      • getImage

        public final WordsWatermarkableImage getImage()

        Gets the image of this WordsShape.

        Returns:
        The image of this WordsShape. Returns null if the shape has no image.
      • setImage

        public final void setImage(WordsWatermarkableImage value)

        Sets the image of this WordsShape.

        Parameters:
        value - The image of this WordsShape. Returns null if the shape has no image.
      • getHorizontalAlignment

        public final int getHorizontalAlignment()

        Gets a value specifying how the shape is positioned horizontally.

        Returns:
        The horizontal alignment value.
      • getVerticalAlignment

        public final int getVerticalAlignment()

        Gets a value specifying how the shape is positioned vertically.

        Returns:
        The vertical alignment value.
      • 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.
      • getHyperlink

        public final String getHyperlink()

        Gets the hyperlink associated with this WordsShape.

        Returns:
        The hyperlink associated with this WordsShape.
      • setHyperlink

        public final void setHyperlink(String value)

        Sets the hyperlink associated with this WordsShape.

        Parameters:
        value - The hyperlink associated with this WordsShape.