Modifier and Type | Class and Description |
---|---|
static class |
Form.SignDependentElementsRenderingModes
Forms can contain signing information and can be signed or unsigned.
|
Modifier and Type | Field and Description |
---|---|
int |
SignDependentElementsRenderingModeWhenConverted
Forms can contain signing information, i.e.
|
Modifier and Type | Method and Description |
---|---|
void |
add(Field field)
Adds field on the form.
|
void |
add(Field field,
int pageNumber)
Adds field on the form.
|
Field |
add(Field field,
String partialName,
int pageNumber)
Adds new field to the form; If this field is already placed on other or this form, the copy
of field is created.
|
void |
addFieldAppearance(Field field,
int pageNumber,
Rectangle rect)
Adds additional appearance of the field to specified page of the document in the specified
location.
|
void |
addFieldToAcroForm(Field field)
Adds additional appearance of the field to specified page of the document.
|
void |
assignXfa(com.aspose.ms.System.Xml.XmlDocument xml)
Sets XFA of the form to specified value.
|
void |
copyTo(com.aspose.ms.System.Array array,
int index)
Copies fields placed on the form into array.
|
void |
delete(Field field)
Delete field from the form.
|
void |
delete(String fieldName)
Deletes field from the form by its name.
|
void |
flatten()
Removes all static form fields and place their values directly on the page.
|
WidgetAnnotation |
get_Item(int index)
Gets field of the form by field index.
|
WidgetAnnotation |
get_Item(String name)
Gets field of the form by field name.
|
XFA |
get_xfa()
For internal usage only
|
WidgetAnnotation |
get(String name)
Searches field by field name.
|
DefaultAppearance |
getDefaultAppearance()
Gets default appearance of the form (object which describes default font, text size and color
for fields on the form).
|
Resources |
getDefaultResources()
Gets default resources placed on this form.
|
IDocument |
getDocument()
For internal usage only
|
Field[] |
getFields()
Gets list of all fields in lowest level of hierarhical form.
|
Field[] |
getFieldsInRect(Rectangle rect)
Returns fields inside of specified rectangle.
|
Object |
getSyncRoot()
Returns synchronization object.
|
int |
getType()
Gets type of the form.
|
XFA |
getXFA()
Gets XFA data of the form (if presents).
|
boolean |
hasXfa()
Returns true if hasXfa
|
boolean |
isSynchronized()
Returns true if object is thread-safe.
|
com.aspose.ms.System.Collections.IEnumerator |
iterator()
Gets enumeration of form fields.
|
void |
setDefaultAppearance(DefaultAppearance value)
Sets default appearance of the form (object which describes default font, text size and color
for fields on the form).
|
void |
setType(int value)
Gets type of the form.
|
int |
size()
Gets number of the fields on this form.
|
public int SignDependentElementsRenderingModeWhenConverted
Forms can contain signing information, i.e. can be signed or unsigned. And form's view sometimes must depend on whether form is signed or not. This property tells to form's converter (f.e. during conversion XFA form to Standard form) whether result form must be rendered as signed or as unsigned.
public Form(IDocument document)
document
- IDocument objectpublic IDocument getDocument()
public XFA get_xfa()
public boolean isSynchronized()
Returns true if object is thread-safe.
isSynchronized
in interface com.aspose.ms.System.Collections.ICollection
public Object getSyncRoot()
Returns synchronization object.
getSyncRoot
in interface com.aspose.ms.System.Collections.ICollection
public int size()
Gets number of the fields on this form.
size
in interface com.aspose.ms.System.Collections.ICollection
public Resources getDefaultResources()
Gets default resources placed on this form.
public DefaultAppearance getDefaultAppearance()
Gets default appearance of the form (object which describes default font, text size and color for fields on the form).
public void setDefaultAppearance(DefaultAppearance value)
Sets default appearance of the form (object which describes default font, text size and color for fields on the form).
value
- DefaultAppearance objectpublic XFA getXFA()
Gets XFA data of the form (if presents).
public int getType()
Gets type of the form. Possible values are: Standard, Static, Dynamic.
FormType
public void setType(int value)
Gets type of the form. Possible values are: Standard, Static, Dynamic.
value
- FormType valueFormType
public void copyTo(com.aspose.ms.System.Array array, int index)
Copies fields placed on the form into array.
copyTo
in interface com.aspose.ms.System.Collections.ICollection
array
- Array where fields must be placed.index
- Starting index.public com.aspose.ms.System.Collections.IEnumerator iterator()
Gets enumeration of form fields.
public WidgetAnnotation get(String name)
Searches field by field name. Returns null if field was not found.
name
- Field name.public void add(Field field, int pageNumber)
Adds field on the form.
field
- Field which must be added.pageNumber
- Page index where added field will be placed.public void add(Field field)
Adds field on the form.
field
- Field which must be added.public void delete(Field field)
Delete field from the form.
field
- Field which must be deleted.public void delete(String fieldName)
Deletes field from the form by its name.
fieldName
- Name of the filed which must be deleted.public void flatten()
Removes all static form fields and place their values directly on the page.
public WidgetAnnotation get_Item(String name)
Gets field of the form by field name. Throws excpetion if the field was not found.
name
- Name of the field.public WidgetAnnotation get_Item(int index)
Gets field of the form by field index.
index
- Index of the field.public Field add(Field field, String partialName, int pageNumber)
Adds new field to the form; If this field is already placed on other or this form, the copy of field is created.
field
- Field name.partialName
- Name of field on the form.pageNumber
- Page number where field will be added.public void addFieldAppearance(Field field, int pageNumber, Rectangle rect)
Adds additional appearance of the field to specified page of the document in the specified location.
field
- Field which appearance should be added on form.pageNumber
- Number of the page where field must be placed.rect
- Rectangle where field will be placed.public void addFieldToAcroForm(Field field)
Adds additional appearance of the field to specified page of the document.
field
- Field objectpublic boolean hasXfa()
public void assignXfa(com.aspose.ms.System.Xml.XmlDocument xml)
Sets XFA of the form to specified value.
xml
- Xml document which concains new XFA data.public Field[] getFields()
Gets list of all fields in lowest level of hierarhical form.
Copyright © 2016 Aspose. All Rights Reserved.