Form
Наследование: java.lang.Object
Все реализованные интерфейсы: java.lang.Iterable
public final class Form implements Iterable<WidgetAnnotation>
Класс, представляющий объект формы.
Конструкторы
Конструктор | Описание |
---|---|
Form(IDocument document) | Конструктор |
Методы
Метод | Описание |
---|---|
add(Field field) | Добавляет поле в форму. |
add(Field field, int pageNumber) | Добавляет поле в форму. |
add(Field field, String partialName, int pageNumber) | Добавляет новое поле в форму; Если это поле уже размещено на другой или этой форме, создается копия поля. |
add(WidgetAnnotation field) | Добавляет поле в форму. |
addFieldAppearance(Field field, int pageNumber, Rectangle rect) | Добавляет дополнительный вид поля на указанную страницу документа в указанном месте. |
addFieldToAcroForm(Field field) | Добавляет дополнительный вид поля на указанную страницу документа. |
assignXfa(System.Xml.XmlDocument xml) | Устанавливает XFA формы в указанное значение. |
clear() | Удаляет все поля из формы. |
contains(WidgetAnnotation field) | Определяет, представлено ли поле в форме. |
copyTo(Field[] array, int index) | Копирует поля, размещенные на форме, в массив. |
copyTo(WidgetAnnotation[] array, int arrayIndex) | Копирует поля формы в массив. |
delete(Field field) | Удалить поле из формы. |
delete(String fieldName) | Удаляет поле из формы по его имени. |
equals(Object arg0) | |
flatten() | Удаляет все статические поля формы и размещает их значения прямо на странице. |
get(int index) | |
get(String name) | Поиск поля по имени поля. |
getAutoRecalculate() | Если установлено, все поля формы будут пересчитываться при изменении любого поля. |
getAutoRestoreForm() | Если установлено, отсутствующие поля формы будут создаваться автоматически, если они присутствуют в аннотациях. |
getClass() | |
getDefaultAppearance() | Получает внешний вид формы по умолчанию (объект, который описывает шрифт по умолчанию, размер текста и цвет для полей в форме). |
getDefaultResources() | Получает ресурсы по умолчанию, размещенные в этой форме. |
getDocument() | Только для внутреннего использования |
getEmulateRequierdGroups() | Если это свойство истинно, то для необходимых контейнеров элементов Xfa exclGroup будут отрисовываться дополнительные красные граничные прямоугольники. Это свойство было введено из-за отсутствия аналогий для exclGroup при преобразовании Xfa представления форм в стандартное. |
getFields() | Получает список всех полей на самом низком уровне иерархической формы. |
getFieldsInRect(Rectangle rect) | Возвращает поля внутри указанного прямоугольника. |
getIgnoreNeedsRendering() | Если это свойство имеет значение true, значение ключа NeedsRendering будет игнорироваться при преобразовании формы XFA в стандартную форму. |
getRemovePermission() | Если это свойство имеет значение true, то словарь “Perms” будет удален из pdf-документа после преобразования динамических документов в стандартные. |
getSignDependentElementsRenderingModeWhenConverted() | Формы могут содержать информацию для подписи, т.е. могут быть подписаны или не подписаны. |
getSignaturesAppendOnly() | Если установлено, документ содержит подписи, которые могут быть признаны недействительными, если файл сохраняется (записывается) таким образом, что изменяется его предыдущее содержимое, в отличие от добавочного обновления. |
getSignaturesExist() | Если установлено, документ содержит как минимум одно поле для подписи. |
getSyncRoot() | Возвращает объект синхронизации. |
getType() | Получает тип формы. |
getXFA() | Получает данные XFA формы (если есть). |
get_Item(int index) | Получает поле формы по индексу поля. |
get_Item(String name) | Получает поле формы по имени поля. |
get_xfa() | Только для внутреннего использования |
hasField(Field field) | Проверьте, есть ли в форме уже указанное поле. |
hasField(String fieldName) | Определяет, добавлено ли уже поле с указанным именем в форму. |
hasXfa() | Возвращает true, если hasXfa |
hashCode() | |
isReadOnly() | Определяет, доступна ли коллекция только для чтения. |
isSynchronized() | Возвращает true, если объект потокобезопасен. |
iterator() | Получает перечисление полей формы. |
notify() | |
notifyAll() | |
remove(WidgetAnnotation field) | Удаляет поле из формы. |
setAutoRecalculate(boolean value) | Если установлено, все поля формы будут пересчитываться при изменении любого поля. |
setAutoRestoreForm(boolean value) | Если установлено, отсутствующие поля формы будут создаваться автоматически, если они присутствуют в аннотациях. |
setCalculatedFields(List | Позволяет задать порядок расчета полей. |
setDefaultAppearance(DefaultAppearance value) | Задает внешний вид формы по умолчанию (объект, который описывает шрифт по умолчанию, размер текста и цвет для полей формы). |
setEmulateRequierdGroups(boolean value) | Если это свойство истинно, то для необходимых контейнеров элементов Xfa exclGroup будут отрисовываться дополнительные красные граничные прямоугольники. Это свойство было введено из-за отсутствия аналогий для exclGroup при преобразовании Xfa представления форм в стандартное. |
setIgnoreNeedsRendering(boolean value) | Если это свойство имеет значение true, значение ключа NeedsRendering будет игнорироваться при преобразовании формы XFA в стандартную форму. |
setRemovePermission(boolean value) | Если это свойство имеет значение true, то словарь “Perms” будет удален из pdf-документа после преобразования динамических документов в стандартные. |
setSignDependentElementsRenderingModeWhenConverted(int signDependentElementsRenderingModeWhenConverted) | Формы могут содержать информацию для подписи, т.е. могут быть подписаны или не подписаны. |
setSignaturesAppendOnly(boolean value) | Если установлено, документ содержит подписи, которые могут быть признаны недействительными, если файл сохраняется (записывается) таким образом, что изменяется его предыдущее содержимое, в отличие от добавочного обновления. |
setSignaturesExist(boolean value) | Если установлено, документ содержит как минимум одно поле для подписи. |
setType(int value) | Получает тип формы. |
size() | Получает количество полей в этой форме. |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
Form(IDocument document)
public Form(IDocument document)
Конструктор
Параметры:
Параметр | Тип | Описание |
---|---|---|
document | IDocument | Объект IDocument |
add(Field field)
public void add(Field field)
Добавляет поле в форму.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | Field | Поле, которое необходимо добавить. |
add(Field field, int pageNumber)
public void add(Field field, int pageNumber)
Добавляет поле в форму.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | Field | Поле, которое необходимо добавить. |
pageNumber | int | Индекс страницы, где будет размещено добавленное поле. |
add(Field field, String partialName, int pageNumber)
public Field add(Field field, String partialName, int pageNumber)
Добавляет новое поле в форму; Если это поле уже размещено на другой или этой форме, создается копия поля.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | Field | Имя поля. |
partialName | java.lang.String | Название поля в форме. |
pageNumber | int | Номер страницы, на которой будет добавлено поле. |
Возвращает: Field - Добавлено поле возвращено. Если копия поля была создана, она будет возвращена.
add(WidgetAnnotation field)
public boolean add(WidgetAnnotation field)
Добавляет поле в форму.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | WidgetAnnotation | Поле, которое необходимо добавить. |
Возвращает: boolean - логическое значение
addFieldAppearance(Field field, int pageNumber, Rectangle rect)
public void addFieldAppearance(Field field, int pageNumber, Rectangle rect)
Добавляет дополнительный вид поля на указанную страницу документа в указанном месте.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | Field | Поле, внешний вид которого необходимо добавить на форму. |
pageNumber | int | Номер страницы, на которой должно быть размещено поле. |
rect | Rectangle | Прямоугольник, в котором будет размещено поле. |
addFieldToAcroForm(Field field)
public void addFieldToAcroForm(Field field)
Добавляет дополнительный вид поля на указанную страницу документа.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | Field | Полевой объект |
assignXfa(System.Xml.XmlDocument xml)
public void assignXfa(System.Xml.XmlDocument xml)
Устанавливает XFA формы в указанное значение.
Параметры:
Параметр | Тип | Описание |
---|---|---|
xml | com.aspose.ms.System.Xml.XmlDocument | XML-документ, содержащий новые данные XFA. |
clear()
public void clear()
Удаляет все поля из формы. Не поддерживается.
contains(WidgetAnnotation field)
public boolean contains(WidgetAnnotation field)
Определяет, представлено ли поле в форме.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | WidgetAnnotation | Поле для поиска. |
Возвращает: boolean - логическое значение
copyTo(Field[] array, int index)
public void copyTo(Field[] array, int index)
Копирует поля, размещенные на форме, в массив.
Параметры:
Параметр | Тип | Описание |
---|---|---|
array | Field[] | Массив, в котором должны быть размещены поля. |
index | int | Начальный индекс. |
copyTo(WidgetAnnotation[] array, int arrayIndex)
public void copyTo(WidgetAnnotation[] array, int arrayIndex)
Копирует поля формы в массив.
Параметры:
Параметр | Тип | Описание |
---|---|---|
array | WidgetAnnotation[] | Массив для копирования. |
arrayIndex | int | Индекс элемента массива, с которого начинается копирование. |
delete(Field field)
public void delete(Field field)
Удалить поле из формы.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | Field | Поле, которое необходимо удалить. |
delete(String fieldName)
public void delete(String fieldName)
Удаляет поле из формы по его имени.
Параметры:
Параметр | Тип | Описание |
---|---|---|
fieldName | java.lang.String | Имя файла, который необходимо удалить. |
equals(Object arg0)
public boolean equals(Object arg0)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | java.lang.Object |
Возвращает: логический
flatten()
public void flatten()
Удаляет все статические поля формы и размещает их значения прямо на странице.
get(int index)
public WidgetAnnotation get(int index)
Параметры:
Параметр | Тип | Описание |
---|---|---|
index | int |
Возвращает: WidgetAnnotation
get(String name)
public WidgetAnnotation get(String name)
Поиск поля по имени поля. Возвращает null, если поле не найдено.
Параметры:
Параметр | Тип | Описание |
---|---|---|
name | java.lang.String | Имя поля. |
Возвращает: WidgetAnnotation - Полевой объект.
getAutoRecalculate()
public final boolean getAutoRecalculate()
Если установлено, все поля формы будут пересчитываться при изменении любого поля. Значение по умолчанию — истина. Установите значение false, чтобы повысить производительность при заполнении формы с большим количеством вычисляемых полей.
Возвращает: boolean - логическое значение
getAutoRestoreForm()
public final boolean getAutoRestoreForm()
Если установлено, отсутствующие поля формы будут создаваться автоматически, если они присутствуют в аннотациях.
Возвращает: boolean - логическое значение
getClass()
public final native Class<?> getClass()
Возвращает: java.lang.Класс
getDefaultAppearance()
public DefaultAppearance getDefaultAppearance()
Получает внешний вид формы по умолчанию (объект, который описывает шрифт по умолчанию, размер текста и цвет для полей в форме).
Возвращает: DefaultAppearance - Объект DefaultAppearance
getDefaultResources()
public Resources getDefaultResources()
Получает ресурсы по умолчанию, размещенные в этой форме.
Возвращает: Resources - Стоимость ресурсов
getDocument()
public IDocument getDocument()
Только для внутреннего использования
Возвращает: IDocument - Объект IDocument
getEmulateRequierdGroups()
public boolean getEmulateRequierdGroups()
Если это свойство истинно, то для необходимых контейнеров элементов Xfa exclGroup будут отрисовываться дополнительные красные граничные прямоугольники. Это свойство было введено из-за отсутствия аналогий для exclGroup при преобразовании Xfa представления форм в стандартное. По умолчанию это ложь.
Возвращает: boolean - логическое значение
getFields()
public Field[] getFields()
Получает список всех полей на самом низком уровне иерархической формы.
Возвращает: com.aspose.pdf.Поле[] - Массив с найденными полями.
getFieldsInRect(Rectangle rect)
public Field[] getFieldsInRect(Rectangle rect)
Возвращает поля внутри указанного прямоугольника.
Параметры:
Параметр | Тип | Описание |
---|---|---|
rect | Rectangle | Прямоугольник, в котором должны быть найдены поля. |
Возвращает: com.aspose.pdf.Поле[] - Массив с найденными полями.
getIgnoreNeedsRendering()
public boolean getIgnoreNeedsRendering()
Если это свойство имеет значение true, значение ключа NeedsRendering будет игнорироваться при преобразовании формы XFA в стандартную форму. По умолчанию это ложь.
Возвращает: boolean - логическое значение
getRemovePermission()
public boolean getRemovePermission()
Если это свойство имеет значение true, то словарь “Perms” будет удален из pdf-документа после преобразования динамических документов в стандартные. Словарь “Пермь” может содержать правила, препятствующие отображению выделения обязательных полей в программе Adobe Acrobat reader. По умолчанию это ложь.
Возвращает: boolean - логическое значение
getSignDependentElementsRenderingModeWhenConverted()
public int getSignDependentElementsRenderingModeWhenConverted()
Формы могут содержать информацию для подписи, т.е. могут быть подписаны или не подписаны. А вид формы иногда должен зависеть от того, подписана форма или нет. Это свойство сообщает преобразователю формы (например, во время преобразования формы XFA в стандартную форму), должна ли результирующая форма отображаться как подписанная или как беззнаковая.
Возвращает: int — элемент SignDependentElementsRenderingModes
getSignaturesAppendOnly()
public final boolean getSignaturesAppendOnly()
Если установлено, документ содержит подписи, которые могут быть признаны недействительными, если файл сохраняется (записывается) таким образом, что изменяется его предыдущее содержимое, в отличие от добавочного обновления.
Возвращает: boolean - логическое значение
getSignaturesExist()
public final boolean getSignaturesExist()
Если установлено, документ содержит как минимум одно поле для подписи.
Возвращает: boolean - логическое значение
getSyncRoot()
public Object getSyncRoot()
Возвращает объект синхронизации.
Возвращает: java.lang.Object — Объект для синхронизации
getType()
public int getType()
Получает тип формы. Возможные значения: Стандартный, Статический, Динамический.
Возвращает: int - значение типа формы
getXFA()
public XFA getXFA()
Получает данные XFA формы (если есть).
Возвращает: XFA - Значение РФА
get_Item(int index)
public WidgetAnnotation get_Item(int index)
Получает поле формы по индексу поля.
Параметры:
Параметр | Тип | Описание |
---|---|---|
index | int | Индекс поля. |
Возвращает: WidgetAnnotation - Восстановленное поле.
get_Item(String name)
public WidgetAnnotation get_Item(String name)
Получает поле формы по имени поля. Выдает исключение, если поле не найдено.
Параметры:
Параметр | Тип | Описание |
---|---|---|
name | java.lang.String | Имя поля. |
Возвращает: WidgetAnnotation - Восстановленное поле.
get_xfa()
public XFA get_xfa()
Только для внутреннего использования
Возвращает: XFA - XFA-объект
hasField(Field field)
public final boolean hasField(Field field)
Проверьте, есть ли в форме уже указанное поле.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | Field | Поле для проверки. |
Возвращает: boolean - true, если указанное имя поля добавлено в форму; в противном случае ложь.
hasField(String fieldName)
public final boolean hasField(String fieldName)
Определяет, добавлено ли уже поле с указанным именем в форму.
Параметры:
Параметр | Тип | Описание |
---|---|---|
fieldName | java.lang.String | PartialName поля. |
Возвращает: boolean - true, если указанное имя поля добавлено в форму; в противном случае ложь.
hasXfa()
public boolean hasXfa()
Возвращает true, если hasXfa
Возвращает: boolean - логическое значение
hashCode()
public native int hashCode()
Возвращает: инт
isReadOnly()
public boolean isReadOnly()
Определяет, доступна ли коллекция только для чтения. Всегда возвращает ложь.
Возвращает: boolean - логическое значение
isSynchronized()
public boolean isSynchronized()
Возвращает true, если объект потокобезопасен.
Возвращает: boolean - логическое значение
iterator()
public Iterator<WidgetAnnotation> iterator()
Получает перечисление полей формы.
Возвращает: java.util.Iterator<com.aspose.pdf.WidgetAnnotation> — перечислитель полей.
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
remove(WidgetAnnotation field)
public boolean remove(WidgetAnnotation field)
Удаляет поле из формы.
Параметры:
Параметр | Тип | Описание |
---|---|---|
field | WidgetAnnotation | Поле для удаления. |
Возвращает: boolean — Истинно, если поле было удалено. False, если поле не было найдено в форме.
setAutoRecalculate(boolean value)
public final void setAutoRecalculate(boolean value)
Если установлено, все поля формы будут пересчитываться при изменении любого поля. Значение по умолчанию — истина. Установите значение false, чтобы повысить производительность при заполнении формы с большим количеством вычисляемых полей.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setAutoRestoreForm(boolean value)
public final void setAutoRestoreForm(boolean value)
Если установлено, отсутствующие поля формы будут создаваться автоматически, если они присутствуют в аннотациях.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setCalculatedFields(List value)
public void setCalculatedFields(List<Field> value)
Позволяет задать порядок расчета полей.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.util.List<com.aspose.pdf.Field> | объект java.util.List. |
setDefaultAppearance(DefaultAppearance value)
public void setDefaultAppearance(DefaultAppearance value)
Задает внешний вид формы по умолчанию (объект, который описывает шрифт по умолчанию, размер текста и цвет для полей формы).
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | DefaultAppearance | Объект DefaultAppearance |
setEmulateRequierdGroups(boolean value)
public void setEmulateRequierdGroups(boolean value)
Если это свойство истинно, то для необходимых контейнеров элементов Xfa exclGroup будут отрисовываться дополнительные красные граничные прямоугольники. Это свойство было введено из-за отсутствия аналогий для exclGroup при преобразовании Xfa представления форм в стандартное. По умолчанию это ложь.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setIgnoreNeedsRendering(boolean value)
public void setIgnoreNeedsRendering(boolean value)
Если это свойство имеет значение true, значение ключа NeedsRendering будет игнорироваться при преобразовании формы XFA в стандартную форму. По умолчанию это ложь.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setRemovePermission(boolean value)
public void setRemovePermission(boolean value)
Если это свойство имеет значение true, то словарь “Perms” будет удален из pdf-документа после преобразования динамических документов в стандартные. Словарь “Пермь” может содержать правила, препятствующие отображению выделения обязательных полей в программе Adobe Acrobat reader. По умолчанию это ложь.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setSignDependentElementsRenderingModeWhenConverted(int signDependentElementsRenderingModeWhenConverted)
public void setSignDependentElementsRenderingModeWhenConverted(int signDependentElementsRenderingModeWhenConverted)
Формы могут содержать информацию для подписи, т.е. могут быть подписаны или не подписаны. А вид формы иногда должен зависеть от того, подписана форма или нет. Это свойство сообщает преобразователю формы (например, во время преобразования формы XFA в стандартную форму), должна ли результирующая форма отображаться как подписанная или как беззнаковая.
Параметры:
Параметр | Тип | Описание |
---|---|---|
signDependentElementsRenderingModeWhenConverted | int | Элемент SignDependentElementsRenderingModes |
setSignaturesAppendOnly(boolean value)
public final void setSignaturesAppendOnly(boolean value)
Если установлено, документ содержит подписи, которые могут быть признаны недействительными, если файл сохраняется (записывается) таким образом, что изменяется его предыдущее содержимое, в отличие от добавочного обновления.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setSignaturesExist(boolean value)
public final void setSignaturesExist(boolean value)
Если установлено, документ содержит как минимум одно поле для подписи.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setType(int value)
public void setType(int value)
Получает тип формы. Возможные значения: Стандартный, Статический, Динамический.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | Значение типа формы |
size()
public final int size()
Получает количество полей в этой форме.
Возвращает: интервал - целочисленное значение
toString()
public String toString()
Возвращает: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | long | |
arg1 | int |