Package com.grapecity.documents.excel.forms

Interface IOptionButton

All Superinterfaces:

ICellLinkControl, ICellLinkControlT<Boolean>, IContentControl, IControl, IControlT<IOptionButton>

public interface IOptionButton
extends IControlT<IOptionButton>, IContentControl, ICellLinkControlT<Boolean>

The option button control.

Method Summary

Modifier and Type	Method	Description
IGroupBox	getGroupBox()	Gets the first group box that contains the option button.
boolean	getIsChecked()	Gets whether the IOptionButton is checked.
void	setIsChecked(boolean value)	Sets whether the IOptionButton is checked.

Methods inherited from interface com.grapecity.documents.excel.forms.ICellLinkControl

getDisplay3DShading, getLinkedCell, setDisplay3DShading, setLinkedCell

Methods inherited from interface com.grapecity.documents.excel.forms.ICellLinkControlT

getValue, setValue

Methods inherited from interface com.grapecity.documents.excel.forms.IContentControl

getLockedText, getText, setLockedText, setText

Methods inherited from interface com.grapecity.documents.excel.forms.IControl

bringToFront, delete, getBottomRightCell, getEnabled, getFormControlType, getHeight, getLeft, getLocked, getName, getParent, getPlacement, getPrintObject, getShapeRange, getTop, getTopLeftCell, getVisible, getWidth, getZOrder, sendToBack, setEnabled, setHeight, setLeft, setLocked, setName, setPlacement, setPrintObject, setTop, setVisible, setWidth

Methods inherited from interface com.grapecity.documents.excel.forms.IControlT

copy, cut, duplicate

Method Details

getGroupBox

IGroupBox getGroupBox()

Gets the first group box that contains the option button.

Option buttons in the same group box are in the same group.

If the value is null, the option button is in the default group.

Option buttons in the same group will share the value of ICellLinkControl.LinkedCell property.

They will also affect the selection state of other option buttons in the same group.

Returns:

The first group box that contains the option button.The value is nullif the option button is in the default group.

API Note:

It's heavy to maintain the state of this property.We don't recommend putting too many group boxes and option buttons in the same worksheet.

getIsChecked

boolean getIsChecked()

Gets whether the IOptionButton is checked.

Returns:

False - Unchecked, true - Checked.

setIsChecked

void setIsChecked(boolean value)

Sets whether the IOptionButton is checked.

Parameters:

value - False - Unchecked, true - Checked.