public class CheckboxField extends Field
Class representing checkbox field
_FileSelect, _Password_disableUpdateAppearance| Constructor and Description |
|---|
CheckboxField()
Create instance of CheckboxField.
|
CheckboxField(IDocument doc)
Constructor to use with Generator.
|
CheckboxField(IDocument doc,
Rectangle rect)
Constructor for CheckboxField class.
|
CheckboxField(Page page,
Rectangle rect)
Constructor for CheckboxField class.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
deepClone()
Clone the checkbox.
|
String |
getActiveState()
Gets current annotation appearance state.
|
List<String> |
getAllowedStates()
Returns list of allowed states.
|
boolean |
getChecked()
Gets state of check box.
|
String |
getExportValue()
Gets or sets export value of CheckBox field.
|
String |
getNormalCaption()
Gets normal caption of the field.
|
String |
getOnState()
Returns name of state which is "Checked" state of checkbox.
|
int |
getStyle()
Gets style of check box.
|
String |
getValue()
Gets value of check box field.
|
void |
setActiveState(String value)
Sets current annotation appearance state.
|
void |
setChecked(boolean value)
Sets state of check box.
|
void |
setExportValue(String value)
Gets or sets export value of CheckBox field.
|
void |
setStyle(int value)
Sets style of check box.
|
void |
setValue(String value)
Sets value of check box field.
|
add, clear, contains, copyTo, copyTo, flatten, get_Item, get_Item, getAlternateName, getAnnotationIndex, getMappingName, getMaxFontSize, getPageIndex, getPartialName, getRect, getSyncRoot, getTabOrder, isFitIntoRectangle, isGroup, isReadOnly, isSharedField, isSynchronized, iterator, recalculate, remove, setAlternateName, setAnnotationIndex, setFitIntoRectangle, setMappingName, setMaxFontSize, setPartialName, setPosition, setRect, setSharedField, setTabOrder, size, updateAppearancesaccept, getAnnotationActions, getAnnotationType, getDefaultAppearance, getExportable, getHighlighting, getOnActivated, getParent, getReadOnly, getRequired, setDefaultAppearance, setExportable, setHighlighting, setOnActivated, setReadOnly, setRequiredcreateAnnotation, getAlignment, getAppearance, getBorder, getCharacteristics, getColor, getContents, getEngineDict, getEngineObj, getFlags, getFullName, getHeight, getHorizontalAlignment_Annotation_New, getModified, getModifiedInternal, getName, getNormalAppearance, getPage, getPageIndex, getPdfActions, getRectangle, getStates, getTextHorizontalAlignment, getWidth, initialize, isUpdateAppearanceOnConvert, isUseFontSubset, setAlignment, setBorder, setColor, setContents, setFlags, setHeight, setHorizontalAlignment_Annotation_New, setModified, setModifiedInternal, setName, setStructParent, setTextHorizontalAlignment, setUpdateAppearanceOnConvert, setUseFontSubset, setWidthgetHorizontalAlignment, getHyperlink, getMargin, getVerticalAlignment, getZIndex, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, setHorizontalAlignment, setHyperlink, setInLineParagraph, setInNewPage, setKeptWithNext, setMargin, setVerticalAlignment, setZIndexequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitforEach, spliteratorpublic CheckboxField(Page page, Rectangle rect)
Constructor for CheckboxField class.
page - Page where check box will be placed.rect - Position and size of the check box.public CheckboxField(IDocument doc, Rectangle rect)
Constructor for CheckboxField class.
doc - Document where will be new field created.rect - Rectangle where new field will be created.public CheckboxField()
Create instance of CheckboxField.
public CheckboxField(IDocument doc)
Constructor to use with Generator.
doc - Document where field will be created.public List<String> getAllowedStates()
Returns list of allowed states.
public String getOnState()
Returns name of state which is "Checked" state of checkbox. This is "Yes" if presents or any other value other then "Off" and "No";
public int getStyle()
Gets style of check box.
BoxStylepublic void setStyle(int value)
Sets style of check box.
value - BoxStyle of check box.BoxStylepublic String getActiveState()
Gets current annotation appearance state.
getActiveState in class Annotationpublic void setActiveState(String value)
Sets current annotation appearance state.
setActiveState in class Annotationvalue - String valuepublic boolean getChecked()
Gets state of check box.
public void setChecked(boolean value)
Sets state of check box.
value - boolean valuepublic String getNormalCaption()
Gets normal caption of the field.
public String getValue()
Gets value of check box field.
public void setValue(String value)
Sets value of check box field.
public Object deepClone()
Clone the checkbox.
deepClone in interface com.aspose.ms.System.ICloneabledeepClone in class BaseParagraphpublic final String getExportValue()
Gets or sets export value of CheckBox field.
public final void setExportValue(String value)
Gets or sets export value of CheckBox field.
value - String value