Class PdfForm

Information

Représente le composant Documentize.PdfForm. Utilisé pour aplatir, extraire les données de formulaires. Permet également d’obtenir les noms des champs.

Represents Documentize.PdfForm component. Used to Flatten, Extract Forms Data. Also allows you to Get Fields Names.

public static class PdfForm

Inheritance

object ← PdfForm

Inherited Members

Méthodes

Extract(ExtractFormDataToDsvOptions)

Extrait les données de formulaire d’un document PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Paramètres

Retour

ResultContainer : Un objet contenant le résultat de l’opération.

Exemples

L’exemple montre comment Export Form values to CSV file.

// 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);

L’exemple montre comment Export Form values to TSV file and set Properties.

// 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);

Exceptions

ArgumentException

If options not set.

Flatten(FlattenFieldsOptions)

Aplatit les champs d’un document PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Paramètres

Retour

ResultContainer : Un objet contenant le résultat de l’opération.

Exemples

L’exemple montre comment Flatten fields in PDF file.

// 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);

L’exemple montre comment Flatten fields in PDF file and skip first field.

// 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);

Exceptions

ArgumentException

If options not set.

GetNames(GetFieldNamesOptions)

Obtient les noms des champs dans un document PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Paramètres

Retour

List<string>

Liste des noms dans le document PDF.

Exemples

L’exemple montre comment Get field Names from PDF file.

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

Remove(RemoveFieldsOptions) : Remove Fields from PDF document.

public static ResultContainer Remove(RemoveFieldsOptions options)

Paramètres

  • options RemoveFieldsOptions : Un objet d’options contenant les instructions pour l’opération.

Retour

ResultContainer : Un objet contenant le résultat de l’opération.

Exemples

L’exemple montre comment Remove fields from PDF file.

// 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);

Exceptions

ArgumentException

If options not set.

Espace de noms : Documentize
Assemblage : Documentize.dll

 Français