public class Field extends WidgetAnnotation implements com.aspose.ms.System.Collections.ICollection, Cloneable
Base class for acro form fields.
Modifier and Type | Field and Description |
---|---|
static int |
_FileSelect |
static int |
_Password |
_disableUpdateAppearance
Constructor and Description |
---|
Field(com.aspose.pdf.engine.data.IPdfObject annotation,
IDocument document) |
Modifier and Type | Method and Description |
---|---|
void |
copyTo(com.aspose.ms.System.Array array,
int index)
Copies subfields of this field into array starting from specified index.
|
void |
flatten()
Removes this field and place its value directly on the page.
|
WidgetAnnotation |
get_Item(int index)
Gets subfield contained in this field by index.
|
WidgetAnnotation |
get_Item(String name)
Gets subfield contained in this field by name of the subfield.
|
String |
getAlternateName()
Gets alternate name of the field (An alternate field
name that shall be used in place of the actual field name
wherever the field shall be identified in the user interface).
|
int |
getAnnotationIndex()
Gets index of this anotation on the page.
|
String |
getMappingName()
Gets mapping name of the field that shall be used when exporting interactive form field data from the document.
|
int |
getPageIndex()
Gets index of page which contains annotation.
|
String |
getPartialName()
Gets or sets partial name of the field.
|
Rectangle |
getRect()
Gets or sets the field rectangle.
|
Object |
getSyncRoot()
Synchronization object.
|
String |
getValue()
Gets value of the field.
|
boolean |
isGroup()
Gets s boolean value which indicates is this field non-terminal field i.e. group of fields.
|
boolean |
isSharedField()
Property for Generator support.
|
void |
isSharedField(boolean value) |
boolean |
isSynchronized()
Returns true if dictionary is synchronized.
|
com.aspose.ms.System.Collections.IEnumerator |
iterator()
Returns enumerator of contained fields.
|
void |
recalculate() |
void |
setAlternateName(String value)
Sets alternate name of the field (An alternate field
name that shall be used in place of the actual field name
wherever the field shall be identified in the user interface).
|
void |
setAnnotationIndex(int value)
Sets index of this anotation on the page.
|
void |
setFieldImage(com.aspose.ms.System.IO.Stream image) |
static void |
setFitIntoRectangle(boolean value)
If true then font size will reduced to fit text to specified rectangle.
|
void |
setMappingName(String value)
Sets mapping name of the field that shall be used when exporting interactive form field data from the document.
|
void |
setPartialName(String value) |
void |
setPosition(Point point)
Set position of the field.
|
void |
setRect(Rectangle value) |
void |
setValue(String value) |
int |
size()
Gets number of subfields in this field.
|
void |
updateAppearances() |
accept, getActions, getDefaultAppearance, getExportable, getHighlighting, getOnActivated, getParent, getReadOnly, getRequired, setDefaultAppearance, setExportable, setHighlighting, setOnActivated, setReadOnly, setRequired
createAnnotation, getActiveState, getAlignment, getAppearance, getBorder, getCharacteristics, getColor, getContents, getEngineDict, getEngineObj, getFlags, getFullName, getHeight, getHorizontalAlignment_Annotation_New, getModified, getModifiedInternal, getName, getNormalAppearance, getPage, getPageIndex, getStates, getWidth, initialize, setActiveState, setAlignment, setBorder, setColor, setContents, setFlags, setHeight, setHorizontalAlignment_Annotation_New, setModified, setModifiedInternal, setName, setWidth
deepClone, getMargin, isKeptWithNext, isKeptWithNext, setHorizontalAlignment, setMargin, setVerticalAlignment
public static final int _Password
public static final int _FileSelect
public Field(com.aspose.pdf.engine.data.IPdfObject annotation, IDocument document)
public String getPartialName()
Gets or sets partial name of the field.
public void setPartialName(String value)
public String getAlternateName()
Gets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat.
public void setAlternateName(String value)
Sets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat.
value
- String valuepublic String getMappingName()
Gets mapping name of the field that shall be used when exporting interactive form field data from the document.
public void setMappingName(String value)
Sets mapping name of the field that shall be used when exporting interactive form field data from the document.
value
- String valuepublic void recalculate()
public String getValue()
Gets value of the field.
value
- String valuepublic void setValue(String value)
public boolean isSynchronized()
Returns true if dictionary is synchronized.
isSynchronized
in interface com.aspose.ms.System.Collections.ICollection
public int size()
Gets number of subfields in this field. (For example number of items in radio button field).
size
in interface com.aspose.ms.System.Collections.ICollection
public Object getSyncRoot()
Synchronization object.
getSyncRoot
in interface com.aspose.ms.System.Collections.ICollection
public boolean isGroup()
Gets s boolean value which indicates is this field non-terminal field i.e. group of fields.
public void copyTo(com.aspose.ms.System.Array array, int index)
Copies subfields of this field into array starting from specified index.
copyTo
in interface com.aspose.ms.System.Collections.ICollection
array
- Array where field must be copied.index
- Starting index where fields will be copied.public com.aspose.ms.System.Collections.IEnumerator iterator()
Returns enumerator of contained fields.
public void flatten()
Removes this field and place its value directly on the page.
flatten
in class Annotation
public WidgetAnnotation get_Item(String name)
Gets subfield contained in this field by name of the subfield.
name
- Contained subfield name.public WidgetAnnotation get_Item(int index)
Gets subfield contained in this field by index.
index
- Index of the reuqested subfield.public void setPosition(Point point)
Set position of the field.
point
- Point where field should be positioned.public int getPageIndex()
Annotation
Gets index of page which contains annotation.
getPageIndex
in class Annotation
public void updateAppearances()
public void setFieldImage(com.aspose.ms.System.IO.Stream image)
public int getAnnotationIndex()
Gets index of this anotation on the page.
public void setAnnotationIndex(int value)
Sets index of this anotation on the page.
public Rectangle getRect()
Gets or sets the field rectangle.
getRect
in class Annotation
public void setRect(Rectangle value)
setRect
in class Annotation
public boolean isSharedField()
Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
* @return boolean valuepublic void isSharedField(boolean value)
public static void setFitIntoRectangle(boolean value)
If true then font size will reduced to fit text to specified rectangle.
value
- boolean valueCopyright © 2019 Aspose. All Rights Reserved.