Package com.grapecity.documents.excel.drawing

Interface IShape

All Superinterfaces:
IContainer
All Known Subinterfaces:
IBackgroundPicture
public interface IShape extends IContainer
表示绘图层中的一个对象，例如自动形状、图表或图片。Shape对象是IShapes集合的一个成员。Shapes集合包含幻灯片上的所有形状。

  • Method Details

    • getControl

      IControl getControl()
      获取关联的控制。

      value：关联的控制。如果形状不是一个控制，则为null。

    • ungroup

      IShapeRange ungroup()
      取消指定形状或形状范围内任何分组的形状。分解指定形状或形状范围内的图片和OLE对象。
      Returns:
      代表取消分组的形状的ShapeRange对象。

    • getParent

      IWorksheet getParent()
      获取形状的父工作表。

    • getName

      String getName()
      返回对象的名称。

    • setName

      void setName(String value)
      设置对象的名称。

    • getTopLeftCell

      IRange getTopLeftCell()
      返回表示位于指定对象左上角下方的单元格的 IRange 对象。

    • getBottomRightCell

      IRange getBottomRightCell()
      返回表示位于该对象右下角下方的单元格的IRange对象。

    • getTitle

      String getTitle()
      获取与指定形状相关联的替换文字的标题。此方法适用于图表、形状、图片、链接图片、切片器和组形状对象。
      Returns:
      与指定形状关联的替换文字的标题。

    • setTitle

      void setTitle(String value)
      设置与指定形状关联的替换文字的标题。此方法适用于图表、形状、图片、链接图片、切片器和组形状对象。
      Parameters:
      value - 与指定形状关联的替换文字的标题。

    • getRotation

      double getRotation()
      返回形状的旋转角度（单位：度）。

    • setRotation

      void setRotation(double value)
      设置形状的旋转角度（以度为单位）。

    • getChart

      IChart getChart()
      返回一个代表此形状中包含的 IChart 的对象。

    • getAutoShapeType

      AutoShapeType getAutoShapeType()
      返回指定IShape对象的形状类型，该对象必须表示除线、自由绘图或连接器之外的自动形状。

    • setAutoShapeType

      void setAutoShapeType(AutoShapeType value)
      为指定的IShape对象设置形状类型，该对象必须代表除了线条、自由绘制或连接器之外的自动形状。

    • getAlternativeText

      String getAlternativeText()
      获取指定形状对象的描述性（替换）文字字符串。此方法适用于图表、形状、图片、链接图片、切片器、控件和组形状对象。
      Returns:
      该形状的替换文字字符串。

    • setAlternativeText

      void setAlternativeText(String alternativeText)
      设置指定形状对象的描述性（替换）文字字符串。此方法适用于图表、形状、图片、链接图片、切片器、控件和组形状对象。如果设置了非空字符串，则形状的装饰性将为 false。@param alternativeText 该形状的替换文字字符串。

    • getDecorative

      boolean getDecorative()
      返回指定形状对象的装饰性标志。此方法适用于图表、形状、图片、链接图片、切片器和组形状对象。
      Returns:
      如果指定的形状是装饰性的，则为 true。

    • setDecorative

      void setDecorative(boolean value)
      设置指定形状对象的装饰性标志。此标志适用于图表、形状、图片、链接图片、切片器和组形状对象。如果将此值设置为 true，则形状的替换文字和标题将被清除。
      Parameters:
      value - 如果指定的形状是装饰性的，则为 true。

    • getConnector

      boolean getConnector()
      获取指定的形状是否为连接器。

    • getConnectorFormat

      IConnectorFormat getConnectorFormat()
      返回包含连接器格式属性的 IConnectorFormat 对象。适用于代表连接器的 IShape 对象。

    • getFill

      IFillFormat getFill()
      返回包含指定图表或形状的填充格式属性的IFillFormat对象。

    • getHasChart

      boolean getHasChart()
      返回信息，表示IShape是否包含图表。

    • getLine

      ILineFormat getLine()
      返回包含指定形状的行格式属性的ILineFormat对象。

    • getParentGroup

      IShape getParentGroup()
      返回代表一个子形状或一系列子形状的共同父形状的IShape对象。

    • getGroupItems

      IGroupShapes getGroupItems()
      返回代表指定组中各个形状的 IGroupShapes 对象。使用 IGroupShapes 的索引器从组中返回单个形状。

    • getPictureFormat

      IPictureFormat getPictureFormat()
      返回包含指定形状图片格式属性的IPictureFormat对象。

    • getTextFrame

      ITextFrame getTextFrame()
      返回包含指定形状的文本和字体样式属性的 ITextFrame 对象。

    • getPlacement

      Placement getPlacement()
      返回对象与其下方单元格连接的方式。

    • setPlacement

      void setPlacement(Placement value)
      设置对象与其下方单元格的附着方式。

    • getThreeD

      IThreeDFormat getThreeD()
      返回包含指定形状的3-D效果格式属性的IThreeDFormat对象。

    • getType

      ShapeType getType()
      返回形状类型

    • getVisible

      boolean getVisible()
      获取对象是否可见。

    • setVisible

      void setVisible(boolean value)
      设置对象是否可见。

    • getIsPrintable

      boolean getIsPrintable()
      获取是否应该打印该对象。

    • setIsPrintable

      void setIsPrintable(boolean value)
      设置是否应打印该对象。

    • getLocked

      boolean getLocked()
      获取对象是否已锁定（如果对象已锁定则为True，如果工作表受保护时对象可以修改则为False，读取或写入布尔值）。

    • setLocked

      void setLocked(boolean value)
      设置对象是否锁定（如果对象已锁定则为True，如果工作表受保护时对象可以被修改则为False，读取或写入布尔值）。

    • getZOrderPosition

      int getZOrderPosition()
      获取指定形状在Z序中的位置。

    • getFormula

      String getFormula()
      获取当前形状的公式。
      Returns:
      公式。

    • setFormula

      void setFormula(String formula)
      设置当前形状的公式。
      Parameters:
      formula - 要设置的公式。

    • delete

      void delete()
      删除该对象。

    • duplicate

      IShape duplicate()
      复制形状并返回对新副本的引用。

    • zOrder

      void zOrder(ZOrderType zOrderType)
      移动集合中指定的形状到其他形状的前面或后面（即改变形状在Z轴顺序中的位置）。
      Parameters:
      zOrderType - 必需的 com.grapecity.documents.excel.drawing.ZOrderType。指定相对于其他形状移动指定形状的位置。

    • getAdjustments

      IAdjustments getAdjustments()
      获取指定AutoShape或连接器的一组调整值。

    • getHyperlink

      IHyperlink getHyperlink()
      返回一个代表形状的超链接的Hyperlink对象。

    • toImage

      void toImage(String fileName)
      保存形状到指定的图像文件。
      Parameters:
      fileName - 输出的图像文件。

    • toImage

      void toImage(String fileName, ImageSaveOptions options)
      保存形状到指定的图像文件，使用指定的选项。
      Parameters:
      fileName - 输出的图像文件。
      options - 输出图像的选项。

    • toImage

      void toImage(OutputStream stream, ImageType imageType)
      保存形状到指定的图像流。
      Parameters:
      stream - 输出图像流。
      imageType - 指定要创建的图像类型。

    • toImage

      void toImage(OutputStream stream, ImageType imageType, ImageSaveOptions options)
      保存形状到指定的图像流。
      Parameters:
      stream - 输出图像流。
      imageType - 指定要创建的图像类型。
      options - 输出图像的选项。

    • fromJson

      void fromJson(String json)
      从JSON字符串生成一个新的形状。
      Parameters:
      json - 表示一个形状的JSON字符串。

    • toJson

      String toJson()
      从形状生成一个JSON字符串。
      Returns:
      JSON字符串。