com.aspose.words

Class CheckBoxControl

java.lang.Object

com.aspose.words.OleControl

com.aspose.words.Forms2OleControl

com.aspose.words.MorphDataControl

com.aspose.words.CheckBoxControl

public class CheckBoxControl
extends MorphDataControl

The CheckBox control toggles a value.

Remarks:

It has three possible states: selected, cleared, and neither selected nor cleared, meaning a combination of on and off states.

Examples:

Shows how to change state of the CheckBox control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);
 CheckBoxControl checkBoxControl = (CheckBoxControl)shape.getOleFormat().getOleControl();
 checkBoxControl.setChecked(true);

 Assert.assertEquals(true, checkBoxControl.getChecked());
 Assert.assertEquals(Forms2OleControlType.CHECK_BOX, checkBoxControl.getType());
 
 

Field Summary

Fields inherited from class com.aspose.words.OleControl

CHECK_BOX_CONTROL_CLSID, COMBO_BOX_CONTROL_CLSID, COMMAND_BUTTON_CONTROL_CLSID, FORM_CONTROL_CLSID, FRAME_CONTROL_CLSID, HTML_HIDDEN_CLSID, HTML_SELECT_CLSID, HTML_SUBMIT_BUTTON_CLSID, HTML_TEXT_CLSID, IMAGE_CONTROL_CLSID, LABEL_CONTROL_CLSID, LIST_BOX_CONTROL_CLSID, MULTI_PAGE_CONTROL_CLSID, OPTION_BUTTON_CONTROL_CLSID, SCROLL_BAR_CONTROL_CLSID, SPIN_BUTTON_CONTROL_CLSID, TAB_STRIP_CONTROL_CLSID, TEXT_BOX_CONTROL_CLSID, TOGGLE_BUTTON_CONTROL_CLSID

Method Summary

Modifier and Type	Method and Description
boolean	getChecked() Gets a boolean value indicating either this CheckBoxControl is checked or not.
protected java.lang.String	getClsidVirtual()
int	getType() Gets type of Forms 2.0 control.
void	setChecked(boolean value) Sets a boolean value indicating either this CheckBoxControl is checked or not.

Methods inherited from class com.aspose.words.Forms2OleControl

getBackColor, getCaption, getChildNodes, getEnabled, getForeColor, getGroupName, getHeight, getProgId, getUserType, getValue, getWidth, setBackColor, setCaption, setForeColor, setGroupName, setHeight, setWidth

Methods inherited from class com.aspose.words.OleControl

getClsidInternal, getExtensionForUser, getFileNameForUser, getId, getName, isEmpty, isForms2OleControl, isForms2OleControlInternal, setId, setName

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 type of Forms 2.0 control.

Examples:

Shows how to change state of the CheckBox control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);
 CheckBoxControl checkBoxControl = (CheckBoxControl)shape.getOleFormat().getOleControl();
 checkBoxControl.setChecked(true);

 Assert.assertEquals(true, checkBoxControl.getChecked());
 Assert.assertEquals(Forms2OleControlType.CHECK_BOX, checkBoxControl.getType());
 
 

Specified by:

getType in class Forms2OleControl

Returns:

Type of Forms 2.0 control. The returned value is one of Forms2OleControlType constants.

getChecked

public boolean getChecked()

Gets a boolean value indicating either this CheckBoxControl is checked or not. The default value is false.

Examples:

Shows how to change state of the CheckBox control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);
 CheckBoxControl checkBoxControl = (CheckBoxControl)shape.getOleFormat().getOleControl();
 checkBoxControl.setChecked(true);

 Assert.assertEquals(true, checkBoxControl.getChecked());
 Assert.assertEquals(Forms2OleControlType.CHECK_BOX, checkBoxControl.getType());
 
 

Returns:

A boolean value indicating either this CheckBoxControl is checked or not.

setChecked

public void setChecked(boolean value)

Sets a boolean value indicating either this CheckBoxControl is checked or not. The default value is false.

Examples:

Shows how to change state of the CheckBox control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);
 CheckBoxControl checkBoxControl = (CheckBoxControl)shape.getOleFormat().getOleControl();
 checkBoxControl.setChecked(true);

 Assert.assertEquals(true, checkBoxControl.getChecked());
 Assert.assertEquals(Forms2OleControlType.CHECK_BOX, checkBoxControl.getType());
 
 

Parameters:

value - A boolean value indicating either this CheckBoxControl is checked or not.

getClsidVirtual

protected java.lang.String getClsidVirtual()

Overrides:

getClsidVirtual in class OleControl