Aspose::Pdf::Facades::Form класс

Form class

Класс, представляющий объект Acro-формы.

class Form : public Aspose::Pdf::Facades::SaveableFacade

Nested classes

Class FormImportResult

Enums

Перечисление	Описание
ImportStatus	Состояние импортированного поля.

Методы

Метод	Описание
Close() override	Закрывает открытые файлы без каких-либо изменений.
ExportFdf(const System::SharedPtr<System::IO::Stream>&)	Экспортирует содержимое полей PDF в поток FDF.
ExportXfdf(const System::SharedPtr<System::IO::Stream>&)	Экспортирует содержимое полей PDF в XML‑поток. Значение поля кнопки не будет экспортировано.
ExportXml(const System::SharedPtr<System::IO::Stream>&)	Экспортирует содержимое полей PDF в XML‑поток. Значение поля кнопки не будет экспортировано.
ExtractXfaData(const System::SharedPtr<System::IO::Stream>&)	Извлекает пакет данных XFA.
FillBarcodeField(const System::String&, const System::String&)	Заполняет поле штрих‑кода согласно его полностью квалифицированному имени поля.
FillField(const System::String&, const System::String&)	Заполняет поле допустимым значением согласно полностью квалифицированному имени поля. Перед заполнением полей необходимо знать все имена полей и их соответствующие допустимые значения. И имена полей, и значения чувствительны к регистру. Обратите внимание, что Aspose.Pdf.Facades поддерживает только полные имена полей и не работает с частичными именами, в отличие от Aspose.Pdf.Kit; например, если у поля полное имя “Form.Subform.TextField”, следует указывать полное имя, а не “TextField”. Вы можете использовать свойство FieldNames для изучения существующих имен полей и поиска требуемого поля по его частичному имени.
FillField(const System::String&, int32_t)	Заполняет поле радиокнопки допустимым индексным значением согласно полностью квалифицированному имени поля. Перед заполнением полей необходимо знать только имя поля. Значение может быть указано по его индексу. Примечание: применяется только к полям Radio Box, Combo Box и List Box. Обратите внимание, что Aspose.Pdf.Facades поддерживает только полные имена полей и не работает с частичными именами, в отличие от Aspose.Pdf.Kit; например, если у поля полное имя “Form.Subform.ListBoxField”, следует указывать полное имя, а не “ListBoxField”. Вы можете использовать свойство FieldNames для изучения существующих имен полей и поиска требуемого поля по его частичному имени.
FillField(const System::String&, bool)	Заполняет поле флажка булевым значением. Примечание: применяется только к полю Check Box. Обратите внимание, что Aspose.Pdf.Facades поддерживает только полные имена полей и не работает с частичными именами, в отличие от Aspose.Pdf.Kit; например, если у поля полное имя “Form.Subform.CheckBoxField”, следует указывать полное имя, а не “CheckBoxField”. Вы можете использовать свойство FieldNames для изучения существующих имен полей и поиска требуемого поля по его частичному имени.
FillField(const System::String&, const System::ArrayPtr<System::String>&)	Заполняет поле несколькими выборами. Примечание: только для поля AcroForm List Box.
FillField(const System::String&, const System::String&, bool)	Заполняет поле указанным значением.
FillFields(const System::ArrayPtr<System::String>&, const System::ArrayPtr<System::String>&, System::SharedPtr<System::IO::Stream>&)	Заполняет поля текстовых полей текстовыми значениями и сохраняет документ. Актуально для подписанных документов. Примечание: применяется только к Text Box. И имена полей, и значения чувствительны к регистру.
FillImageField(const System::String&, const System::String&)	Вставляет изображение в существующее поле кнопки в качестве его внешнего вида согласно полностью квалифицированному имени поля.
FillImageField(const System::String&, const System::SharedPtr<System::IO::Stream>&)	Перегружает функцию FillImageField. Входные данные — поток изображения.
FlattenAllFields()	Преобразует все поля в плоские.
FlattenField(const System::String&)	Преобразует в плоское указанное поле по полностью квалифицированному имени. Все остальные поля останутся неизменными. Если fieldName недействительно, все поля останутся неизменными.
Form(const System::SharedPtr<System::IO::Stream>&, const System::SharedPtr<System::IO::Stream>&)	Конструктор Form с двумя параметрами‑потоками. Укажите одинаковый исходный и целевой поток для инкрементного обновления.
Form()	Конструктор Form без параметров.
Form(const System::String&)	Конструктор Form.
Form(const System::SharedPtr<System::IO::Stream>&)	Конструктор формы.
Form(const System::String&, const System::String&)	Конструктор класса Form. Укажите одинаковое имя исходного и целевого файла для выполнения инкрементного обновления.
Form(const System::String&, const System::SharedPtr<System::IO::Stream>&)	Конструктор Form.
Form(const System::SharedPtr<System::IO::Stream>&, const System::String&)	Конструктор Form.
Form(const System::SharedPtr<Aspose::Pdf::Document>&)	Инициализирует новый объект Form на основе document .
Form(const System::SharedPtr<Aspose::Pdf::Document>&, const System::String&)	Инициализирует новый объект Form на основе document .
Form(const System::SharedPtr<Aspose::Pdf::Document>&, const System::SharedPtr<System::IO::Stream>&)	Инициализирует новый объект Form на основе document .
Form(const System::SharedPtr<System::IO::Stream>&, const System::SharedPtr<System::Web::HttpResponse>&)	Создаёт форму, которая сохранит результат в объект HttpResponse.
Form(const System::String&, const System::SharedPtr<System::Web::HttpResponse>&)	Создаёт форму, которая сохранит результат в объект HttpResponse.
get_AttachmentName() const	Получает имя вложения, когда результат операции сохраняется в объекты HttpResponse в виде вложения.
get_ContentDisposition() const	Получает способ хранения содержимого, когда результат операции сохраняется в объект HttpResponse. Возможные значения: inline / attachment. По умолчанию: inline.
get_DestFileName() const	Получает имя файла назначения.
get_DestStream() const	Получает целевой поток.
get_FieldNames()	Получает список имён полей в форме.
get_FormSubmitButtonNames()	Получает все имена кнопок отправки формы.
get_ImportResult()	Результат последней операции импорта. Массив объектов, описывающих результат импорта для каждого поля.
get_Response() const	Получает объект Response, в котором будет сохранён результат операции.
get_SaveOptions() const	Получает параметры сохранения, когда результат сохраняется как HttpResponse. Значение по умолчанию: PdfSaveOptions.
get_SrcFileName() const	Получает имя исходного файла.
get_SrcStream() const	Получает исходный поток.
GetButtonOptionCurrentValue(const System::String&)	Возвращает текущее значение для полей вариантов радиокнопок.
GetButtonOptionValues(const System::String&)	Получает поля вариантов радиокнопок и связанные значения на основе имени поля. Этот метод имеет смысл для групп радиокнопок.
GetField(const System::String&)	Получает значение поля согласно его имени.
GetFieldFacade(const System::String&)	Возвращает объект FrofmFieldFacade, содержащий все атрибуты отображения.
GetFieldFlag(const System::String&)	Возвращает флаги поля.
GetFieldLimit(const System::String&)	Получить ограничение текстового поля.
GetFieldType(const System::String&)	Возвращает тип поля.
GetFullFieldName(const System::String&)	Получает полное имя поля согласно его короткому имени.
GetRichText(const System::String&)	Получить значение поля Rich Text, включая информацию о форматировании каждого символа.
GetSubmitFlags(const System::String&)	Возвращает флаги отправки кнопки submit.
ImportFdf(const System::SharedPtr<System::IO::Stream>&)	Импортирует содержимое полей из файла fdf и помещает их в новый pdf.
ImportXfdf(const System::SharedPtr<System::IO::Stream>&)	Импортирует содержимое полей из файла xfdf(xml) и помещает их в новый pdf.
ImportXml(const System::SharedPtr<System::IO::Stream>&)	Импортирует содержимое полей из файла xml и помещает их в новый pdf.
ImportXml(const System::SharedPtr<System::IO::Stream>&, bool)	Импортирует содержимое полей из файла xml и помещает их в новый pdf.
IsRequiredField(const System::String&)	Определяет, является ли поле обязательным.
RenameField(const System::String&, const System::String&)	Переименовывает поле. Подходит как поле AcroForm, так и поле XFA.
Save()	Сохраняет значение заполненных полей и закрывает открытый документ Pdf.
Save(System::String) override	Сохраняет документ в указанный файл.
Save(System::SharedPtr<System::IO::Stream>) override	Сохраняет документ в указанный поток.
set_AttachmentName(const System::String&)	Устанавливает имя вложения, когда результат операции сохраняется в объекты HttpResponse в виде вложения.
set_ContentDisposition(Aspose::Pdf::ContentDisposition)	Устанавливает способ хранения содержимого, когда результат операции сохраняется в объект HttpResponse. Возможные значения: inline / attachment. По умолчанию: inline.
set_ConvertTo(PdfFormat)	Устанавливает формат PDF‑файла. Результирующий файл будет сохранён в указанном формате. Если это свойство не указано, файл будет сохранён в формате PDF по умолчанию без конвертации.
set_DestFileName(const System::String&)	Устанавливает имя файла назначения.
set_DestStream(const System::SharedPtr<System::IO::Stream>&)	Устанавливает целевой поток.
set_Response(const System::SharedPtr<System::Web::HttpResponse>&)	Устанавливает объект Response, в котором будет сохранён результат операции.
set_SaveOptions(const System::SharedPtr<Aspose::Pdf::SaveOptions>&)	Устанавливает параметры сохранения, когда результат сохраняется как HttpResponse. Значение по умолчанию: PdfSaveOptions.
set_SrcFileName(const System::String&)	Устанавливает имя исходного файла.
set_SrcStream(const System::SharedPtr<System::IO::Stream>&)	Устанавливает исходный поток.
SetXfaData(const System::SharedPtr<System::IO::Stream>&)	Заменяет данные XFA указанным пакетом данных. Пакет данных может быть извлечён с помощью ExtractXfaData.

См. также

Aspose::Pdf::Facades::FontColor class Aspose::Pdf::Facades::FormattedText класс