Method Details

• getParent

  Object getParent()

  The parent object, typically IWorksheet. In some cases, the type of this property is IControl.

• getFormControlType

  FormControlType getFormControlType()

  Returns the form control type of this control.

• getEnabled

  boolean getEnabled()

  Gets whether the control is enabled.

  API Note:

  Not supported by the *.ssjson format.

• setEnabled

  void setEnabled(boolean value)

  Sets whether the control is enabled.

  API Note:

  Not supported by the *.ssjson format.

• getHeight

  double getHeight()

  Gets the height of this control.

• setHeight

  void setHeight(double value)

  Sets the height of this control.

• getLeft

  double getLeft()

  Gets the left margin of this control.

• setLeft

  void setLeft(double value)

  Sets the left margin of this control.

• getLocked

  boolean getLocked()

  Gets whether the control is locked.

  API Note:

  Not supported by the *.ssjson format.

• setLocked

  void setLocked(boolean value)

  Sets whether the control is locked.

  API Note:

  Not supported by the *.ssjson format.

• getPlacement

  Placement getPlacement()

  Gets the way a control is attached to its underlying cells.

• setPlacement

  void setPlacement(Placement value)

  Sets the way a control is attached to its underlying cells.

• getPrintObject

  boolean getPrintObject()

  Gets whether the control will be printed.

• setPrintObject

  void setPrintObject(boolean value)

  Sets whether the control will be printed.

• getTop

  double getTop()

  Gets the top margin of this control.

• setTop

  void setTop(double value)

  Sets the top margin of this control.

• getVisible

  boolean getVisible()

  Gets whether the control is visible.

• setVisible

  void setVisible(boolean value)

  Sets whether the control is visible.

• getWidth

  double getWidth()

  Gets the width of this control.

• setWidth

  void setWidth(double value)

  Sets the width of this control.

• getZOrder

  int getZOrder()

  Gets the z-index of this control.

• getShapeRange

  IShapeRange getShapeRange()

  Gets the shapes of this control.

• bringToFront

  boolean bringToFront()

  Change z-index of this control to front.

• delete

  void delete()

  Remove this control from parent.

• sendToBack

  boolean sendToBack()

  Send the Z-Index to back.

  Returns:

  Returns true if succeed.

• getBottomRightCell

  IRange getBottomRightCell()

  Gets the bottom right cell of this control.

• getName

  String getName()

  Gets the name of this control.

• setName

  void setName(String value)

  Sets the name of this control.

• getTopLeftCell

  IRange getTopLeftCell()

  Gets the top left cell of this control.