Package com.grapecity.documents.excel.drawing

Interface ITextFrame

public interface ITextFrame
Represents the text frame in the com.grapecity.documents.excel.IShape object.

  • Method Summary

    Modifier and Type
    Method
    Description
    TextDirection
    getDirection()
    Gets the text direction.
    HorizontalAnchor
    getHorizontalAnchor()
    Gets horizontal anchor for Text frame in the shape
    float
    getMarginBottom()
    Gets the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    float
    getMarginLeft()
    Gets the distance (in points) between the left of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    float
    getMarginRight()
    Gets the distance (in points) between the right of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    float
    getMarginTop()
    Gets the distance (in points) between the top of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    ITextRange
    getTextRange()
    Returns the ITextRange object that represents the text in the object.
    VerticalAnchor
    getVerticalAnchor()
    Gets vertical anchor for Text frame in the shape.
    void
    setDirection(TextDirection value)
    Sets the text direction.
    void
    setHorizontalAnchor(HorizontalAnchor value)
    Sets horizontal anchor for Text frame in the shape
    If you want to set the horizontal alignment of the text, use ITextRange.setTextAlignment(TextAlignmentAnchor textAlignment)
    void
    setMarginBottom(float bottom)
    Sets the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    void
    setMarginLeft(float left)
    Sets the distance (in points) between the left of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    void
    setMarginRight(float right)
    Sets the distance (in points) between the right of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    void
    setMarginTop(float top)
    Sets the distance (in points) between the top of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
    void
    setVerticalAnchor(VerticalAnchor value)
    Sets vertical anchor for Text frame in the shape.

  • Method Details

    • getMarginBottom

      float getMarginBottom()
      Gets the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • setMarginBottom

      void setMarginBottom(float bottom)
      Sets the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • getMarginLeft

      float getMarginLeft()
      Gets the distance (in points) between the left of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • setMarginLeft

      void setMarginLeft(float left)
      Sets the distance (in points) between the left of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • getMarginRight

      float getMarginRight()
      Gets the distance (in points) between the right of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • setMarginRight

      void setMarginRight(float right)
      Sets the distance (in points) between the right of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • getMarginTop

      float getMarginTop()
      Gets the distance (in points) between the top of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • setMarginTop

      void setMarginTop(float top)
      Sets the distance (in points) between the top of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

    • getDirection

      TextDirection getDirection()
      Gets the text direction.

    • setDirection

      void setDirection(TextDirection value)
      Sets the text direction.

    • getTextRange

      ITextRange getTextRange()
      Returns the ITextRange object that represents the text in the object.

    • getHorizontalAnchor

      HorizontalAnchor getHorizontalAnchor()
      Gets horizontal anchor for Text frame in the shape

    • setHorizontalAnchor

      void setHorizontalAnchor(HorizontalAnchor value)
      Sets horizontal anchor for Text frame in the shape
      If you want to set the horizontal alignment of the text, use ITextRange.setTextAlignment(TextAlignmentAnchor textAlignment)

    • getVerticalAnchor

      VerticalAnchor getVerticalAnchor()
      Gets vertical anchor for Text frame in the shape.

    • setVerticalAnchor

      void setVerticalAnchor(VerticalAnchor value)
      Sets vertical anchor for Text frame in the shape.