com.aspose.cells

Class CheckBox

java.lang.Object

com.aspose.cells.Shape

com.aspose.cells.CheckBox

public class CheckBox
extends Shape

Represents a check box object in a worksheet.

Example

 
         //Instantiate a new Workbook.
         Workbook excel = new Workbook();
 
         int index = excel.getWorksheets().get(0).getCheckBoxes().add(15, 15, 20, 100);
         CheckBox checkBox = excel.getWorksheets().get(0).getCheckBoxes().get(index);
         checkBox.setText("Check Box 1");
 
         //Save the excel file.
         excel.save("checkBox.xlsx");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	getCheckedValue() Gets checkbox' value.
int	getCheckValue() Deprecated. Use CheckBox.CheckValueType property instead.
boolean	getShadow() Indicates whether the combobox has 3-D shading.
boolean	getValue() Indicates if the checkbox is checked or not.
void	setCheckedValue(int value) Sets checkbox' value.
void	setCheckValue(int value) Deprecated. Use CheckBox.CheckValueType property instead.
void	setShadow(boolean value) Indicates whether the combobox has 3-D shading.
void	setValue(boolean value) Indicates if the checkbox is checked or not.

Methods inherited from class com.aspose.cells.Shape

addHyperlink, alignTopRightCorner, calculateTextSize, characters, fitToTextSize, formatCharacters, getActiveXControl, getActualBox, getActualLowerRightRow, getAlternativeText, getAnchorType, getAutoShapeType, getBottom, getCharacters, getConnectionPoints, getControlData, getCreateId, getFill, getFillFormat, getFont, getFormatPicture, getGeometry, getGlow, getGroup, getHeight, getHeightCM, getHeightInch, getHeightInShape, getHeightPt, getHeightScale, getHtmlText, getHyperlink, getId, getInputRange, getInputRange, getLeft, getLeftCM, getLeftInch, getLeftInShape, getLeftToCorner, getLine, getLineFormat, getLinkedCell, getLinkedCell, getLockedProperty, getLowerDeltaX, getLowerDeltaY, getLowerRightColumn, getLowerRightRow, getMacroName, getMsoDrawingType, getName, getPaths, getPlacement, getReflection, getRelativeToOriginalPictureSize, getResultOfSmartArt, getRichFormattings, getRight, getRotationAngle, getShadowEffect, getSoftEdges, getSpid, getSpt, getText, getTextBody, getTextBoxOptions, getTextDirection, getTextEffect, getTextHorizontalAlignment, getTextHorizontalOverflow, getTextOptions, getTextOrientationType, getTextShapeType, getTextVerticalAlignment, getTextVerticalOverflow, getThreeDFormat, getTitle, getTop, getTopCM, getTopInch, getTopInShape, getTopToCorner, getType, getUpperDeltaX, getUpperDeltaY, getUpperLeftColumn, getUpperLeftRow, getWidth, getWidthCM, getWidthInch, getWidthInShape, getWidthPt, getWidthScale, getWorksheet, getX, getY, getZOrderPosition, hasLine, isAspectRatioLocked, isDecorative, isEquation, isFilled, isFlippedHorizontally, isFlippedVertically, isGroup, isHidden, isInGroup, isLockAspectRatio, isLocked, isPrintable, isRichText, isSameSetting, isSmartArt, isTextWrapped, isWordArt, moveToRange, removeActiveXControl, removeHyperlink, setAlternativeText, setAnchorType, setAspectRatioLocked, setAutoShapeType, setBottom, setCreateId, setDecorative, setFilled, setFlippedHorizontally, setFlippedVertically, setFont, setHasLine, setHeight, setHeightCM, setHeightInch, setHeightInShape, setHeightPt, setHeightScale, setHidden, setHtmlText, setInputRange, setInputRange, setLeft, setLeftCM, setLeftInch, setLeftInShape, setLeftToCorner, setLinkedCell, setLinkedCell, setLockAspectRatio, setLocked, setLockedProperty, setLowerDeltaX, setLowerDeltaY, setLowerRightColumn, setLowerRightRow, setMacroName, setName, setPlacement, setPrintable, setRelativeToOriginalPictureSize, setRight, setRotationAngle, setSoftEdges, setText, setTextDirection, setTextHorizontalAlignment, setTextHorizontalOverflow, setTextOptions, setTextOrientationType, setTextShapeType, setTextVerticalAlignment, setTextVerticalOverflow, setTextWrapped, setTitle, setTop, setTopCM, setTopInch, setTopInShape, setTopToCorner, setUpperDeltaX, setUpperDeltaY, setUpperLeftColumn, setUpperLeftRow, setWidth, setWidthCM, setWidthInch, setWidthInShape, setWidthPt, setWidthScale, setX, setY, setZOrderPosition, toFrontOrBack, toImage, toImage, toImage, updateSelectedValue

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public boolean getValue()

Indicates if the checkbox is checked or not.

setValue

public void setValue(boolean value)

Indicates if the checkbox is checked or not.

getCheckValue

public int getCheckValue()

Deprecated. Use CheckBox.CheckValueType property instead.

Gets checkbox' value.

See CheckValueType.

Remarks

NOTE: This member is now obsolete. Instead, please use CheckBox.CheckValueType property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

setCheckValue

public void setCheckValue(int value)

Deprecated. Use CheckBox.CheckValueType property instead.

Sets checkbox' value.

See CheckValueType.

Remarks

NOTE: This member is now obsolete. Instead, please use CheckBox.CheckValueType property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getCheckedValue

public int getCheckedValue()

Gets checkbox' value.

See CheckValueType.

setCheckedValue

public void setCheckedValue(int value)

Sets checkbox' value.

See CheckValueType.

getShadow

public boolean getShadow()

Indicates whether the combobox has 3-D shading.

setShadow

public void setShadow(boolean value)

Indicates whether the combobox has 3-D shading.