ToggleButtonActiveXControl

Inheritance: java.lang.Object, com.aspose.cells.ActiveXControlBase, com.aspose.cells.ActiveXControl

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");

Methods

Method	Description
equals(Object arg0)
getAccelerator()	Gets the accelerator key for the control.
getBackOleColor()	Gets the ole color of the background.
getCaption()	Gets the descriptive text that appears on a control.
getClass()
getData()	Gets the binary data of the control.
getFont()	Represents the font of the control.
getForeOleColor()	Gets the ole color of the foreground.
getHeight()	Gets the height of the control in unit of points.
getIMEMode()	Gets the default run-time mode of the Input Method Editor for the control as it receives focus.
getLinkedCell()	Gets the linked cell.
getListFillRange()	Gets the list fill range.
getMouseIcon()	Gets a custom icon to display as the mouse pointer for the control.
getMousePointer()	Gets the type of icon displayed as the mouse pointer for the control.
getPicture()	Gets the data of the picture.
getPicturePosition()	Gets the location of the control’s picture relative to its caption.
getShadow()	Indicates whether to show a shadow.
getSpecialEffect()	Gets the special effect of the control.
getTextAlign()	Represents how to align the text used by the control.
getType()	Gets the type of the ActiveX control.
getValue()	Indicates if the control is checked or not.
getWidth()	Gets the width of the control in unit of points.
getWorkbook()	Gets the Workbook object.
hashCode()
isAutoSize()	Indicates whether the control will automatically resize to display its entire contents.
isEnabled()	Indicates whether the control can receive the focus and respond to user-generated events.
isLocked()	Indicates whether data in the control is locked for editing.
isTransparent()	Indicates whether the control is transparent.
isTripleState()	Indicates how the specified control will display Null values.
isVisible()	Indicates whether this control is visible.
notify()
notifyAll()
setAccelerator(char value)	Sets the accelerator key for the control.
setAutoSize(boolean value)	Indicates whether the control will automatically resize to display its entire contents.
setBackOleColor(int value)	Sets the ole color of the background.
setCaption(String value)	Sets the descriptive text that appears on a control.
setEnabled(boolean value)	Indicates whether the control can receive the focus and respond to user-generated events.
setForeOleColor(int value)	Sets the ole color of the foreground.
setHeight(double value)	Sets the height of the control in unit of points.
setIMEMode(int value)	Sets the default run-time mode of the Input Method Editor for the control as it receives focus.
setLinkedCell(String value)	Sets the linked cell.
setListFillRange(String value)	Sets the list fill range.
setLocked(boolean value)	Indicates whether data in the control is locked for editing.
setMouseIcon(byte[] value)	Sets a custom icon to display as the mouse pointer for the control.
setMousePointer(int value)	Sets the type of icon displayed as the mouse pointer for the control.
setPicture(byte[] value)	Sets the data of the picture.
setPicturePosition(int value)	Sets the location of the control’s picture relative to its caption.
setShadow(boolean value)	Indicates whether to show a shadow.
setSpecialEffect(int value)	Sets the special effect of the control.
setTextAlign(int value)	Represents how to align the text used by the control.
setTransparent(boolean value)	Indicates whether the control is transparent.
setTripleState(boolean value)	Indicates how the specified control will display Null values.
setValue(int value)	Indicates if the control is checked or not.
setVisible(boolean value)	Indicates whether this control is visible.
setWidth(double value)	Sets the width of the control in unit of points.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAccelerator()

public char getAccelerator()

Gets the accelerator key for the control.

Example

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

Returns: char

getBackOleColor()

public int getBackOleColor()

Gets the ole color of the background.

Returns: int

getCaption()

public String getCaption()

Gets the descriptive text that appears on a control.

Example

         activeXControl.setCaption("ExampleButton");

Returns: java.lang.String

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getData()

public byte[] getData()

Gets the binary data of the control.

Returns: byte[]

getFont()

public Font getFont()

Represents the font of the control.

Returns: Font

getForeOleColor()

public int getForeOleColor()

Gets the ole color of the foreground.

Remarks

Not applies to Image control.

Returns: int

getHeight()

public double getHeight()

Gets the height of the control in unit of points.

Returns: double

getIMEMode()

public int getIMEMode()

Gets the default run-time mode of the Input Method Editor for the control as it receives focus.

See InputMethodEditorMode.

Returns: int

getLinkedCell()

public String getLinkedCell()

Gets the linked cell.

Returns: java.lang.String

getListFillRange()

public String getListFillRange()

Gets the list fill range.

Returns: java.lang.String

getMouseIcon()

public byte[] getMouseIcon()

Gets a custom icon to display as the mouse pointer for the control.

Returns: byte[]

getMousePointer()

public int getMousePointer()

Gets the type of icon displayed as the mouse pointer for the control.

See ControlMousePointerType.

Returns: int

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);
         }

Returns: byte[]

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);

Returns: int

getShadow()

public boolean getShadow()

Indicates whether to show a shadow.

Returns: boolean

getSpecialEffect()

public int getSpecialEffect()

Gets the special effect of the control.

See ControlSpecialEffectType.

Example

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

Returns: int

getTextAlign()

public int getTextAlign()

Represents how to align the text used by the control.

See TextAlignmentType.

Returns: int

getType()

public int getType()

Gets the type of the ActiveX control.

See ControlType.

Example

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

Returns: int

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);
         }

Returns: int

getWidth()

public double getWidth()

Gets the width of the control in unit of points.

Returns: double

getWorkbook()

public Workbook getWorkbook()

Gets the Workbook object.

Returns: Workbook

hashCode()

public native int hashCode()

Returns: int

isAutoSize()

public boolean isAutoSize()

Indicates whether the control will automatically resize to display its entire contents.

Returns: boolean

isEnabled()

public boolean isEnabled()

Indicates whether the control can receive the focus and respond to user-generated events.

Returns: boolean

isLocked()

public boolean isLocked()

Indicates whether data in the control is locked for editing.

Returns: boolean

isTransparent()

public boolean isTransparent()

Indicates whether the control is transparent.

Returns: boolean

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);

Returns: boolean

isVisible()

public boolean isVisible()

Indicates whether this control is visible.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAccelerator(char value)

public void setAccelerator(char value)

Sets the accelerator key for the control.

Parameters:

Parameter	Type	Description
value	char

setAutoSize(boolean value)

public void setAutoSize(boolean value)

Indicates whether the control will automatically resize to display its entire contents.

Parameters:

Parameter	Type	Description
value	boolean

setBackOleColor(int value)

public void setBackOleColor(int value)

Sets the ole color of the background.

Parameters:

Parameter	Type	Description
value	int

setCaption(String value)

public void setCaption(String value)

Sets the descriptive text that appears on a control.

Parameters:

Parameter	Type	Description
value	java.lang.String

setEnabled(boolean value)

public void setEnabled(boolean value)

Indicates whether the control can receive the focus and respond to user-generated events.

Parameters:

Parameter	Type	Description
value	boolean

setForeOleColor(int value)

public void setForeOleColor(int value)

Sets the ole color of the foreground.

Remarks

Not applies to Image control.

Parameters:

Parameter	Type	Description
value	int

setHeight(double value)

public void setHeight(double value)

Sets the height of the control in unit of points.

Parameters:

Parameter	Type	Description
value	double

setIMEMode(int value)

public void setIMEMode(int value)

Sets the default run-time mode of the Input Method Editor for the control as it receives focus.

See InputMethodEditorMode.

Parameters:

Parameter	Type	Description
value	int

setLinkedCell(String value)

public void setLinkedCell(String value)

Sets the linked cell.

Parameters:

Parameter	Type	Description
value	java.lang.String

setListFillRange(String value)

public void setListFillRange(String value)

Sets the list fill range.

Parameters:

Parameter	Type	Description
value	java.lang.String

setLocked(boolean value)

public void setLocked(boolean value)

Indicates whether data in the control is locked for editing.

Parameters:

Parameter	Type	Description
value	boolean

setMouseIcon(byte[] value)

public void setMouseIcon(byte[] value)

Sets a custom icon to display as the mouse pointer for the control.

Parameters:

Parameter	Type	Description
value	byte[]

setMousePointer(int value)

public void setMousePointer(int value)

Sets the type of icon displayed as the mouse pointer for the control.

See ControlMousePointerType.

Parameters:

Parameter	Type	Description
value	int

setPicture(byte[] value)

public void setPicture(byte[] value)

Sets the data of the picture.

Parameters:

Parameter	Type	Description
value	byte[]

setPicturePosition(int value)

public void setPicturePosition(int value)

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

See ControlPicturePositionType.

Parameters:

Parameter	Type	Description
value	int

setShadow(boolean value)

public void setShadow(boolean value)

Indicates whether to show a shadow.

Parameters:

Parameter	Type	Description
value	boolean

setSpecialEffect(int value)

public void setSpecialEffect(int value)

Sets the special effect of the control.

See ControlSpecialEffectType.

Parameters:

Parameter	Type	Description
value	int

setTextAlign(int value)

public void setTextAlign(int value)

Represents how to align the text used by the control.

See TextAlignmentType.

Parameters:

Parameter	Type	Description
value	int

setTransparent(boolean value)

public void setTransparent(boolean value)

Indicates whether the control is transparent.

Parameters:

Parameter	Type	Description
value	boolean

setTripleState(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setValue(int value)

public void setValue(int value)

Indicates if the control is checked or not.

See CheckValueType.

Parameters:

Parameter	Type	Description
value	int

setVisible(boolean value)

public void setVisible(boolean value)

Indicates whether this control is visible.

Parameters:

Parameter	Type	Description
value	boolean

setWidth(double value)

public void setWidth(double value)

Sets the width of the control in unit of points.

Parameters:

Parameter	Type	Description
value	double

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int