Interface IControl
- All Known Subinterfaces:
IButton,ICellLinkControl,ICellLinkControlT<T>,ICheckBox,IContentControl,IControlT<T>,IDropDown,IGroupBox,ILabel,IListBox,IOptionButton,IRangeBase,IScrollBar,ISelector,ISelectorT<T,,TCollection> ISpinner
public interface IControl
The base of form controls.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanChange z-index of this control to front.voiddelete()Remove this control from parent.Gets the bottom right cell of this control.booleanIndicates whether the control is enabled.Returns the form control type of this control.doubleThe height of this control.doublegetLeft()The left margin of this control.booleanIndicates whether the control is locked.getName()Gets the name of this control.The parent object, typicallyIWorksheet.Gets or sets the way a control is attached to its underlying cells.booleanIndicates whether the control will be printed.The shapes of this control.doublegetTop()The top margin of this control.Gets the top left cell of this control.booleanIndicates whether the control is visible.doublegetWidth()The width of this control.intThe z-index of this control.booleanSend the Z-Index to back.voidsetEnabled(boolean value) Indicates whether the control is enabled.voidsetHeight(double value) The height of this control.voidsetLeft(double value) The left margin of this control.voidsetLocked(boolean value) Indicates whether the control is locked.voidSets the name of this control.voidsetPlacement(Placement value) Gets or sets the way a control is attached to its underlying cells.voidsetPrintObject(boolean value) Indicates whether the control will be printed.voidsetTop(double value) The top margin of this control.voidsetVisible(boolean value) Indicates whether the control is visible.voidsetWidth(double value) The height of this control.
-
Method Details
-
getParent
Object getParent()The parent object, typicallyIWorksheet. In some cases, the type of this property isIControl. -
getFormControlType
FormControlType getFormControlType()Returns the form control type of this control. -
getEnabled
boolean getEnabled()Indicates whether the control is enabled.- API Note:
- Not supported by the *.ssjson format.
-
setEnabled
void setEnabled(boolean value) Indicates whether the control is enabled.- API Note:
- Not supported by the *.ssjson format.
-
getHeight
double getHeight()The height of this control. -
setHeight
void setHeight(double value) The height of this control. -
getLeft
double getLeft()The left margin of this control. -
setLeft
void setLeft(double value) The left margin of this control. -
getLocked
boolean getLocked()Indicates whether the control is locked.- API Note:
- Not supported by the *.ssjson format.
-
setLocked
void setLocked(boolean value) Indicates whether the control is locked.- API Note:
- Not supported by the *.ssjson format.
-
getPlacement
Placement getPlacement()Gets or sets the way a control is attached to its underlying cells. -
setPlacement
Gets or sets the way a control is attached to its underlying cells. -
getPrintObject
boolean getPrintObject()Indicates whether the control will be printed. -
setPrintObject
void setPrintObject(boolean value) Indicates whether the control will be printed. -
getTop
double getTop()The top margin of this control. -
setTop
void setTop(double value) The top margin of this control. -
getVisible
boolean getVisible()Indicates whether the control is visible. -
setVisible
void setVisible(boolean value) Indicates whether the control is visible. -
getWidth
double getWidth()The width of this control. -
setWidth
void setWidth(double value) The height of this control. -
getZOrder
int getZOrder()The z-index of this control. -
getShapeRange
IShapeRange getShapeRange()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
Sets the name of this control. -
getTopLeftCell
IRange getTopLeftCell()Gets the top left cell of this control.
-