com.aspose.cells

Class ToggleButtonActiveXControl

java.lang.Object

com.aspose.cells.ActiveXControlBase

com.aspose.cells.ActiveXControl

com.aspose.cells.ToggleButtonActiveXControl

Direct Known Subclasses:

RadioButtonActiveXControl

public class ToggleButtonActiveXControl
extends ActiveXControl

Represents a ToggleButton ActiveX control.

Example

 
         //Initialize a new workbook.
         Workbook book = new Workbook();
 
         //Add a ToggleButtonActiveXControl.
         Shape shape = book.getWorksheets().get(0).getShapes().addActiveXControl(ControlType.TOGGLE_BUTTON, 1, 0, 1, 0, 100, 50);
         ToggleButtonActiveXControl activeXControl = (ToggleButtonActiveXControl)shape.getActiveXControl();
 
         //do your business
 
         //Save the excel file.
         book.save("exmaple.xlsx");
 

Method Summary

Methods

Modifier and Type	Method and Description
char	getAccelerator() Gets the accelerator key for the control.
java.lang.String	getCaption() Gets the descriptive text that appears on a control.
byte[]	getPicture() Gets the data of the picture.
int	getPicturePosition() Gets the location of the control's picture relative to its caption.
int	getSpecialEffect() Gets the special effect of the control.
int	getType() Gets the type of the ActiveX control.
int	getValue() Indicates if the control is checked or not.
boolean	isTripleState() Indicates how the specified control will display Null values.
void	setAccelerator(char value) Sets the accelerator key for the control.
void	setCaption(java.lang.String value) Sets the descriptive text that appears on a control.
void	setPicture(byte[] value) Sets the data of the picture.
void	setPicturePosition(int value) Sets the location of the control's picture relative to its caption.
void	setSpecialEffect(int value) Sets the special effect of the control.
void	setTripleState(boolean value) Indicates how the specified control will display Null values.
void	setValue(int value) Indicates if the control is checked or not.

Methods inherited from class com.aspose.cells.ActiveXControl

getData, getFont, getIMEMode, getTextAlign, isAutoSize, isEnabled, isLocked, isTransparent, setAutoSize, setEnabled, setIMEMode, setLocked, setTextAlign, setTransparent

Methods inherited from class com.aspose.cells.ActiveXControlBase

getBackOleColor, getForeOleColor, getHeight, getLinkedCell, getListFillRange, getMouseIcon, getMousePointer, getShadow, getWidth, getWorkbook, isVisible, setBackOleColor, setForeOleColor, setHeight, setLinkedCell, setListFillRange, setMouseIcon, setMousePointer, setShadow, setVisible, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getType

public int getType()

Gets the type of the ActiveX control.

See ControlType.

Example

 
         /*Aspose.Cells.Drawing.ActiveXControls.ControlType*/int type = activeXControl.getType();
 

Specified by:

getType in class ActiveXControlBase

getCaption

public java.lang.String getCaption()

Gets the descriptive text that appears on a control.

Example

 
         activeXControl.setCaption("ExampleButton");
 

setCaption

public void setCaption(java.lang.String value)

Sets the descriptive text that appears on a control.

getPicturePosition

public int getPicturePosition()

Gets the location of the control's picture relative to its caption.

See ControlPicturePositionType.

Example

 
         activeXControl.setPicturePosition(com.aspose.cells.ControlPicturePositionType.ABOVE_LEFT);
 

setPicturePosition

public void setPicturePosition(int value)

Sets the location of the control's picture relative to its caption.

See ControlPicturePositionType.

getSpecialEffect

public int getSpecialEffect()

Gets the special effect of the control.

See ControlSpecialEffectType.

Example

 
         activeXControl.setSpecialEffect(com.aspose.cells.ControlSpecialEffectType.BUMP);
 

setSpecialEffect

public void setSpecialEffect(int value)

Sets the special effect of the control.

See ControlSpecialEffectType.

getPicture

public byte[] getPicture()

Gets the data of the picture.

Example

 
         //e.g byte[] data = File.ReadAllBytes("image.png");
         byte[] data = null;
         if(activeXControl.getPicture() != null)
         {
             activeXControl.setPicture(data);
         }
 

setPicture

public void setPicture(byte[] value)

Sets the data of the picture.

getAccelerator

public char getAccelerator()

Gets the accelerator key for the control.

Example

 
         if ('' != activeXControl.getAccelerator())
         {
             activeXControl.setAccelerator('');
         }
 

setAccelerator

public void setAccelerator(char value)

Sets the accelerator key for the control.

getValue

public int getValue()

Indicates if the control is checked or not.

See CheckValueType.

Example

 
         if(activeXControl.getValue() == CheckValueType.UN_CHECKED)
         {
             activeXControl.setValue(CheckValueType.CHECKED);
         }
 

setValue

public void setValue(int value)

Indicates if the control is checked or not.

See CheckValueType.

isTripleState

public boolean isTripleState()

Indicates how the specified control will display Null values.

Remarks

Setting	Description
True	The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null.
False	(Default) The control will cycle through states for Yes and No values. Null values display as if they were No values.

Example

 
         activeXControl.setTripleState(false);
 

setTripleState

public void setTripleState(boolean value)

Indicates how the specified control will display Null values.

Remarks

Setting	Description
True	The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null.
False	(Default) The control will cycle through states for Yes and No values. Null values display as if they were No values.