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.

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

public static class PdfForm

Inheritance

object ← PdfForm

Inherited Members

Methods

Extract(ExtractFormDataToDsvOptions)

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

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

Returns

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

Examples

L’exemple montre comment exporter les valeurs du formulaire vers un fichier 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);

L’exemple montre comment exporter les valeurs du formulaire vers un fichier TSV et définir les propriétés.

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

Si les options ne sont pas définies.

Flatten(FlattenFieldsOptions)

Aplatit les champs d’un document PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parameters

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

Returns

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

Examples

L’exemple montre comment aplatir les champs d’un fichier 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);

L’exemple montre comment aplatir les champs d’un fichier PDF en sautant le premier champ.

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

Si les options ne sont pas définies.

GetNames(GetFieldNamesOptions)

Obtient les noms des champs dans un document PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Parameters

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

Returns

List<string>

Liste des noms dans le document PDF.

Examples

L’exemple montre comment obtenir les noms des champs d’un fichier PDF.

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

L’exemple montre comment obtenir les noms des champs d’un flux PDF.

// Prepare input stream
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
// Get Field Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions(inputStream));

Remove(RemoveFieldsOptions) : Remove Fields from PDF document.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parameters

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

Returns

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

Examples

L’exemple montre comment supprimer des champs d’un fichier 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);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

 Français