public class WordProcessingShape extends ShapeSearchAdapter implements IRotatableTwoDObject
Represents a drawing shape in a Word document.
Modifier and Type | Method and Description |
---|---|
String |
getAlternativeText()
Gets the descriptive (alternative) text associated with this
WordProcessingShape . |
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 . |
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 . |
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 . |
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 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 |
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)
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. |
public final WordProcessingSection getSection()
Gets the parent section of this WordProcessingShape
.
WordProcessingShape
.public final WordProcessingHeaderFooter getHeaderFooter()
Gets the parent header/footer of this WordProcessingShape
(if presents).
WordProcessingShape
.public final int getShapeType()
Gets the shape type.
public final boolean isWordArt()
Gets a value indicating whether this WordProcessingShape
is a WordArt object.
public final String getAlternativeText()
Gets the descriptive (alternative) text associated with this WordProcessingShape
.
WordProcessingShape
.public final void setAlternativeText(String value)
Sets the descriptive (alternative) text associated with this WordProcessingShape
.
value
- The descriptive (alternative) text associated with this WordProcessingShape
.public final String getName()
Gets the name of this WordProcessingShape
.
WordProcessingShape
.public final boolean getBehindText()
Gets a value indicating whether the shape is over or behind the text.
public final void setBehindText(boolean value)
Sets a value indicating whether the shape is over or behind the text.
value
- The value indicating whether the shape is over or behind the text.
True if the shape is behind the text; otherwise, false.public final String getText()
Gets the text of this WordProcessingShape
.
WordProcessingShape
.public final void setText(String value)
Sets the text of this WordProcessingShape
.
value
- The text of this WordProcessingShape
.public final FormattedTextFragmentCollection getFormattedTextFragments()
Gets the collection of formatted text fragments of this WordProcessingShape
.
WordProcessingShape
.public final WordProcessingWatermarkableImage getImage()
Gets the image of this WordProcessingShape
.
WordProcessingShape
.
Returns null if the shape has no image.public final void setImage(WordProcessingWatermarkableImage value)
Sets the image of this WordProcessingShape
.
value
- The image of this WordProcessingShape
.
Returns null if the shape has no image.public final int getHorizontalAlignment()
Gets a value specifying how the shape is positioned horizontally.
public final int getVerticalAlignment()
Gets a value specifying how the shape is positioned vertically.
public final int getRelativeHorizontalPosition()
Gets a value specifying to what the shape is positioned horizontally.
public final int getRelativeVerticalPosition()
Gets a value specifying to what the shape is positioned vertically.
public final String getHyperlink()
Gets the hyperlink associated with this WordProcessingShape
.
WordProcessingShape
.public final void setHyperlink(String value)
Sets the hyperlink associated with this WordProcessingShape
.
value
- The hyperlink associated with this WordProcessingShape
.public final double getWidth()
Gets the width of this WordProcessingShape
in points.
getWidth
in interface ITwoDObject
WordProcessingShape
in points.public final void setWidth(double value)
Sets the width of this WordProcessingShape
in points.
value
- The width of this WordProcessingShape
in points.public final double getHeight()
Gets the height of this WordProcessingShape
in points.
getHeight
in interface ITwoDObject
WordProcessingShape
in points.public final void setHeight(double value)
Sets the height of this WordProcessingShape
in points.
value
- The height of this WordProcessingShape
in points.public final double getRotateAngle()
Gets the rotate angle of this WordProcessingShape
in degrees.
getRotateAngle
in interface IRotatableTwoDObject
WordProcessingShape
in degrees.public final void setRotateAngle(double value)
Sets the rotate angle of this WordProcessingShape
in degrees.
value
- The rotate angle of this WordProcessingShape
in degrees.public final double getX()
Gets the horizontal offset of this WordProcessingShape
from page left border in points.
getX
in interface ITwoDObject
WordProcessingShape
.public final void setX(double value)
Sets the horizontal offset of this WordProcessingShape
from page left border in points.
value
- The x-coordinate of this WordProcessingShape
.public final double getY()
Gets the vertical offset of this WordProcessingShape
from page top border in points.
getY
in interface ITwoDObject
WordProcessingShape
.public final void setY(double value)
Sets the vertical offset of this WordProcessingShape
from page top border in points.
value
- The y-coordinate of this WordProcessingShape
.Copyright © 2020. All rights reserved.