Class PdfForm

Информация

Представляет плагин Documentize.PdfForm. Используется для Flatten, Extract Forms Data. Также позволяет получать имена полей.

Представляет плагин Documentize.PdfForm. Используется для Flatten, Extract Forms Data.
Также позволяет получать имена полей.

public static class PdfForm

Inheritance

object ← PdfForm

Inherited Members

Методы

Extract(ExtractFormDataToDsvOptions)

Извлекает данные формы из PDF‑документа.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Параметры

options ExtractFormDataToDsvOptions: Объект параметров, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Примеры

Пример демонстрирует, как экспортировать значения формы в CSV‑файл.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Perform the process
PdfForm.Extract(options);

Пример демонстрирует, как экспортировать значения формы в TSV‑файл и установить свойства.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions();
//Set Delimiter
options.Delimiter = '\t';
//Add Field Names to result
options.AddFieldName = true;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Perform the process
PdfForm.Extract(options);

Исключения

ArgumentException

Если параметры не заданы.

Flatten(FlattenFieldsOptions)

Объединяет (Flatten) поля в PDF‑документе.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Параметры

options FlattenFieldsOptions: Объект параметров, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Примеры

Пример демонстрирует, как объединить поля в PDF‑файле.

// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Flatten(options);

Пример демонстрирует, как объединить поля в PDF‑файле и пропустить первое поле.

// Get Fields Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
PdfForm.Flatten(options);

Исключения

ArgumentException

Если параметры не заданы.

GetNames(GetFieldNamesOptions)

Получает имена полей в PDF‑документе.

public static List<string> GetNames(GetFieldNamesOptions options)

Параметры

options GetFieldNamesOptions: Объект параметров, содержащий инструкции для операции.

Возвращаемое значение

List<string>

Список имён в PDF‑документе.

Примеры

Пример демонстрирует, как получить имена полей из PDF‑файла.

// Get Field Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));

Remove(RemoveFieldsOptions) : Удалить поля из PDF‑документа.

public static ResultContainer Remove(RemoveFieldsOptions options)

Параметры

options RemoveFieldsOptions: Объект параметров, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Примеры

Пример демонстрирует, как удалить поля из PDF‑файла.

// Create RemoveFieldsOptions object to set instructions
var options = new RemoveFieldsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Remove(options);

Исключения

ArgumentException

Если параметры не заданы.

Namespace: Documentize Assembly: Documentize.dll