Class AddTimestampOptions

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← AddTimestampOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

AddTimestampOptions(Stream, string, string, string)

Initialise une nouvelle instance de l’objet Documentize.AddTimestampOptions avec des options par défaut.

public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Paramètres

• pfx Stream: Le chemin vers le fichier pfx.
• password string: Le mot de passe du fichier pfx.
• serverUrl string: L’URL du serveur de timestamp.
• serverBasicAuthCredentials string: Les identifiants d’authentification de base, le nom d’utilisateur et le mot de passe sont combinés en une chaîne “nom_utilisateur:mot_de_passe”. (Optionnel).

AddTimestampOptions(string, string, string, string)

Initialise une nouvelle instance de l’objet Documentize.AddTimestampOptions avec des options par défaut.

public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Paramètres

• pfx string: Le chemin vers le fichier pfx.
• password string: Le mot de passe du fichier pfx.
• serverUrl string: L’URL du serveur de timestamp.
• serverBasicAuthCredentials string: Les identifiants d’authentification de base, le nom d’utilisateur et le mot de passe sont combinés en une chaîne “nom_utilisateur:mot_de_passe”. (Optionnel).

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← CompressOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

CompressOptions()

Initialise une nouvelle instance de l’objet Documentize.CompressOptions avec des options par défaut.

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← DecryptionOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

DecryptionOptions(string)

Initialise une nouvelle instance de l’objet Documentize.DecryptionOptions avec des options par défaut.

public DecryptionOptions(string ownerPassword)

Paramètres

• ownerPassword string: Mot de passe du propriétaire.

Propriétés

OwnerPassword

Mot de passe du propriétaire.

public string OwnerPassword { get; set; }

Valeur de propriété

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Héritage

object ← DirectoryDataSource

Implémente

• IDataSource

Membres hérités

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

DirectoryDataSource(string)

Initialise de nouvelles données de répertoire avec le chemin spécifié.

public DirectoryDataSource(string path)

Paramètres

• path string : Une chaîne représentant le chemin vers le répertoire.

Propriétés

DataType

Type de source de données.

public DataType DataType { get; }

Valeur de la propriété

DataType

Path

Obtient le chemin vers le répertoire des données actuelles.

public string Path { get; }

Valeur de la propriété

string

Class DocConverter

public static class DocConverter

Héritage

object ← DocConverter

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple démontre comment convertir un document PDF au format Doc.

// Créer un objet PdfToDocOptions pour définir les instructions
var options = new PdfToDocOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Effectuer le processus
DocConverter.Process(options);

L’exemple démontre comment convertir un document PDF au format Doc tout en définissant le Mode.

// Créer un objet PdfToDocOptions pour définir les instructions
var options = new PdfToDocOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Définir le Mode
options.Mode = DocConversionMode.Flow;
// Effectuer le processus
DocConverter.Process(options);

Méthodes

Process(PdfToDocOptions)

Convertit un document PDF en format DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Paramètres

• options PdfToDocOptions : Un objet d’options contenant des instructions pour l’opération.

Retourne

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← EncryptionOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

EncryptionOptions(string, string)

Initialise une nouvelle instance de l’objet Documentize.EncryptionOptions avec des options par défaut.

public EncryptionOptions(string ownerPassword, string userPassword)

Paramètres

• ownerPassword string: Mot de passe du propriétaire.
• userPassword string: Mot de passe de l’utilisateur.

Propriétés

OwnerPassword

Mot de passe du propriétaire.

public string OwnerPassword { get; set; }

Valeur de la propriété

string

UserPassword

Mot de passe de l’utilisateur.

public string UserPassword { get; set; }

Valeur de la propriété

string

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implemente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

ExtractFormDataToDsvOptions(char, bool)

Initialise une nouvelle instance de l’objet Documentize.ExtractFormDataToDsvOptions.

public ExtractFormDataToDsvOptions(char delimeter = ',', bool addFieldNames = false)

Paramètres

• delimeter char : Spécifie le délimiteur à utiliser dans les données exportées entre les valeurs. La valeur par défaut est ‘,’.
• addFieldNames bool : Ajouter le nom du champ avant la valeur. Format : Nom + délimiteur + Valeur + délimiteur.

Propriétés

AddFieldName

Ajouter le nom du champ avant la valeur. Format : Nom + délimiteur + Valeur + délimiteur.

public bool AddFieldName { get; set; }

Valeur de la propriété

bool

Delimeter

Délimiteur utilisé pour les valeurs exportées.

public char Delimeter { get; set; }

Valeur de la propriété

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ExtractImagesOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

ExtractImagesOptions()

Initialise une nouvelle instance de l’objet Documentize.ExtractImagesOptions avec des options par défaut.

public ExtractImagesOptions()

Class ExtractTextOptions

public sealed class ExtractTextOptions

Héritage

object ← ExtractTextOptions

Membres hérités

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

ExtractTextOptions(TextFormattingMode)

Initialise une nouvelle instance de l’objet Documentize.ExtractTextOptions pour le mode de mise en forme de texte spécifié.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Paramètres

• formattingMode TextFormattingMode: Valeur du mode de mise en forme de texte.

Propriétés

FormattingMode

Obtient le mode de mise en forme.

public TextFormattingMode FormattingMode { get; set; }

Valeur de la propriété

TextFormattingMode

Inputs

Renvoie les données d’Inputs pour l’opération.

public List<idatasource> Inputs { get; }

Valeur de la propriété

List<IDataSource>

Méthodes

AddInput(IDataSource)

Ajoute de nouvelles données à Inputs.

public void AddInput(IDataSource dataSource)

Paramètres

• dataSource IDataSource: Source de données à ajouter. :

Class FileDataSource

public sealed class FileDataSource : IDataSource

Héritage

object ← FileDataSource

Implémente

• IDataSource

Membres hérités

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

FileDataSource(string)

Initialise une nouvelle source de données de fichier avec le chemin spécifié.

public FileDataSource(string path)

Paramètres

• path string : Une chaîne représentant le chemin vers le fichier source.

Propriétés

DataType

Type de source de données.

public DataType DataType { get; }

Valeur de la propriété

DataType

Path

Obtient le chemin du fichier des données actuelles.

public string Path { get; }

Valeur de la propriété

string

Class FileResult

public sealed class FileResult : IOperationResult

Héritage

object ← FileResult

Implémente

• IOperationResult

Membres hérités

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Propriétés

Data

Obtient les données brutes.

public object Data { get; }

Valeur de la propriété

object

IsFile

Indique si le résultat est un chemin vers un fichier de sortie.

public bool IsFile { get; }

Valeur de la propriété

bool

IsStream

Indique si le résultat est un flux de sortie.

public bool IsStream { get; }

Valeur de la propriété

bool

IsString

Indique si le résultat est une chaîne de texte.

public bool IsString { get; }

Valeur de la propriété

bool

Méthodes

ToFile()

Essaie de convertir le résultat en fichier.

public string ToFile()

Renvoie

string : Une chaîne représentant le chemin vers le fichier de sortie si le résultat est un fichier ; sinon null.

ToStream()

Essaie de convertir le résultat en objet flux.

public Stream ToStream()

Renvoie

Stream : Un objet flux représentant les données de sortie si le résultat est un flux ; sinon null.

Class FormExporter

[Obsolete("Veuillez utiliser la classe PdfExtractor. La classe sera bientôt supprimée.")]
public static class FormExporter

Héritage

object ← FormExporter

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Méthodes

Process(ExtractFormDataToDsvOptions)

Démarre le traitement de Documentize.FormExporter avec les paramètres spécifiés.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Paramètres

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

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class FormExportToDsvOptions

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FormExportToDsvOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

FormExportToDsvOptions(char, bool)

Initialise une nouvelle instance de l’objet Documentize.FormExportToDsvOptions.

public FormExportToDsvOptions(char delimeter = ',', bool addFieldNames = false)

Paramètres

• delimeter char: Spécifie le délimiteur à utiliser dans les données exportées entre les valeurs. La valeur par défaut est ‘,’.
• addFieldNames bool: Ajoute le nom du champ avant la valeur. Format : Nom + délimiteur + Valeur + délimiteur.

Propriétés

AddFieldName

Ajoute le nom du champ avant la valeur. Format : Nom + délimiteur + Valeur + délimiteur.

public bool AddFieldName { get; set; }

Valeur de la propriété

bool

Delimeter

Délimiteur utilisé pour les valeurs exportées.

public char Delimeter { get; set; }

Valeur de la propriété

char

Class FormFlattener

public static class FormFlattener

Héritage

object ← FormFlattener

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple démontre comment aplatir les champs dans un fichier PDF.

// Créer un objet FormFlattenerOptions pour définir les instructions
var options = new FormFlattenerOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
FormFlattener.Process(options);

L’exemple démontre comment aplatir les champs dans un fichier PDF et ignorer le premier champ.

// Obtenir les noms des champs
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Créer un objet FormFlattenerOptions pour définir les instructions
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Ignorer 1 champ.
options.SkipFields.Add(fieldNames[0]);
// Effectuer le processus
FormFlattener.Process(options);

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

// Obtenir les noms des champs
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Méthodes

GetFieldNames(string)

Obtenir les noms des champs dans le document PDF.

public static List<string> GetFieldNames(string path)

Paramètres

• path string: Le chemin vers le document PDF.

Renvoie

List<string>

Liste des noms dans le document PDF.

GetFieldNames(Stream) : Obtenir les noms des champs dans le document PDF.

public static List<string> GetFieldNames(Stream stream)

Paramètres

• stream Stream: Le flux contenant le document PDF.

Renvoie

List<string>

Liste des noms dans le document PDF.

Process(FormFlattenerOptions) : Aplatir les champs de formulaire dans le document PDF.

public static ResultContainer Process(FormFlattenerOptions options)

Paramètres

• options FormFlattenerOptions: Un objet d’options contenant des instructions pour l’opération.

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FormFlattenerOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

FormFlattenerOptions()

Initialise une nouvelle instance de l’objet Documentize.FormFlattenerOptions avec des options par défaut.

public FormFlattenerOptions()

Propriétés

SkipFields

La liste des champs qui ne seront pas aplatis.

public List<string> SkipFields { get; set; }

Valeur de la propriété

List<string>

Class HtmlConverter

public static class HtmlConverter

Héritage

object ← HtmlConverter

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple démontre comment convertir un PDF en document HTML.

// Créer un objet PdfToHtmlOptions pour définir le type de données de sortie comme fichier avec ressources embarquées
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_output.html"));
// Effectuer le processus
HtmlConverter.Process(options);

L’exemple démontre comment convertir un document HTML en PDF.

// Créer HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_input.html"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Effectuer le processus
HtmlConverter.Process(options);

Méthodes

Process(PdfToHtmlOptions)

Convertit des documents PDF en format HTML.

public static ResultContainer Process(PdfToHtmlOptions options)

Paramètres

• options PdfToHtmlOptions : Un objet d’options contenant des instructions pour l’opération.

Retours

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Process(HtmlToPdfOptions)

Convertit des documents HTML en format PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Paramètres

• options HtmlToPdfOptions : Un objet d’options contenant des instructions pour l’opération.

Retours

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← HtmlToPdfOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

HtmlToPdfOptions()

Initialise une nouvelle instance de l’objet Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Propriétés

BasePath

Le chemin/url de base pour le fichier html.

public string BasePath { get; set; }

Valeur de la propriété

string

HtmlMediaType

Obtient ou définit les types de médias possibles utilisés lors du rendu.

public HtmlMediaType HtmlMediaType { get; set; }

Valeur de la propriété

HtmlMediaType

IsRenderToSinglePage

Obtient ou définit le rendu de tout le document sur une seule page.

public bool IsRenderToSinglePage { get; set; }

Valeur de la propriété

bool

PageInfo

Obtient ou définit les informations de page du document.

public PageInfo PageInfo { get; set; }

Valeur de la propriété

PageInfo

PageLayoutOption

Obtient ou définit l’option de mise en page.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Valeur de la propriété

HtmlPageLayoutOption

Class ImageExtractor

[Obsolete("Veuillez utiliser la classe PdfExtractor. La classe sera bientôt supprimée.")]
public static class ImageExtractor

Inheritance

object ← ImageExtractor

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Methods

Process(ExtractImagesOptions)

Extraire des images d’un document PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Parameters

• options ExtractImagesOptions: Un objet d’options contenant des instructions pour l’opération.

Returns

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ImageExtractorOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

ImageExtractorOptions()

Initialise une nouvelle instance de l’objet Documentize.ImageExtractorOptions avec des options par défaut.

public ImageExtractorOptions()

Class Info

public static class Info

Héritage

object ← Info

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Champs

• AssemblyVersion Version de l’assemblage.

Valeur du champ

string

Produit

Nom du produit.

public const string Product = "Documentize"

Valeur du champ

string

Class JpegConverter

public static class JpegConverter

Héritage

object ← JpegConverter

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple démontre comment convertir un document PDF en format JPEG.

// Créer un objet PdfToJpegOptions pour définir les instructions
var options = new PdfToJpegOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Définir le chemin du répertoire de sortie
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Effectuer le processus
JpegConverter.Process(options);

L’exemple démontre comment convertir un document PDF en format JPEG avec des paramètres pour les pages, la résolution, la qualité.

// Créer un objet PdfToJpegOptions pour définir les instructions
var options = new PdfToJpegOptions();
// Traiter uniquement la première page
options.PageList = [1];
// Définir la résolution de sortie à 200 DPI
options.OutputResolution = 200;
// Définir la qualité de sortie à 50
options.Quality = 50;
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Définir le chemin du répertoire de sortie
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Effectuer le processus
JpegConverter.Process(options);

L’exemple démontre comment convertir un document PDF en format JPEG vers des flux.

// Créer un objet PdfToJpegOptions pour définir les instructions
var options = new PdfToJpegOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Effectuer le processus
var results = JpegConverter.Process(options);
// Obtenir les résultats sous forme de flux
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Méthodes

Process(PdfToJpegOptions)

Convertit un document PDF en format JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Paramètres

• options PdfToJpegOptions: Un objet d’options contenant des instructions pour le Documentize.JpegConverter.

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← MergeOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

MergeOptions()

Initialise une nouvelle instance de l’objet Documentize.MergeOptions avec des options par défaut.

public MergeOptions()

Class Merger

[Obsolete("Veuillez utiliser la classe PdfManager. La classe sera supprimée bientôt.")]
public static class Merger

Héritage

object ← Merger

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Méthodes

Process(MergeOptions)

Fusionner des documents PDF.

public static ResultContainer Process(MergeOptions options)

Paramètres

• options MergeOptions : Un objet d’options contenant des instructions pour l’opération.

Retourne

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class Message

public class Message

Héritage

object ← Message

Membres Hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

Message()

public Message()

Propriétés

Contenu

Le contenu du message.

[JsonProperty("content")]
public string Content { get; set; }

Valeur de la Propriété

string

Rôle

Définit ou obtient le rôle de l’auteur de ce message.

[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }

Valeur de la Propriété

Role

Class ObjectResult

public sealed class ObjectResult : IOperationResult

Héritage

object ← ObjectResult

Implémente

• IOperationResult

Membres hérités

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Propriétés

Data

Obtient des données brutes.

public object Data { get; }

Valeur de la propriété

object

IsFile

Indique si le résultat est un chemin vers un fichier de sortie.

public bool IsFile { get; }

Valeur de la propriété

bool

IsObject

Indique si le résultat est un objet.

public bool IsObject { get; }

Valeur de la propriété

bool

IsStream

Indique si le résultat est un chemin vers un fichier de sortie.

public bool IsStream { get; }

Valeur de la propriété

bool

IsString

Indique si le résultat est une chaîne.

public bool IsString { get; }

Valeur de la propriété

bool

Text

Renvoie la représentation sous forme de chaîne du résultat.

public string Text { get; }

Valeur de la propriété

string

Méthodes

ToFile()

Essaie de convertir le résultat en fichier.

public string ToFile()

Renvoie

string : Une chaîne représentant le chemin vers le fichier de sortie si le résultat est un fichier ; sinon null.

ToStream()

Essaie de convertir le résultat en objet flux.

public Stream ToStream()

Renvoie

Stream : Un objet flux représentant les données de sortie si le résultat est un flux ; sinon null.

ToString()

Essaie de convertir le résultat en chaîne.

public override string ToString()

Renvoie

string : Une chaîne représentant le contenu textuel si le résultat est une chaîne ; sinon renvoie base.ToString().

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← OptimizeOptions

Implémente

• IPluginOptions

Membres hérités

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

OptimizeOptions()

Initialise une nouvelle instance de l’objet Documentize.OptimizeOptions avec des options par défaut. Linéariser le document afin de

• ouvrir la première page aussi rapidement que possible ;
• afficher la page suivante ou suivre par lien vers la page suivante aussi rapidement que possible ;
• afficher la page de manière incrémentielle à mesure qu’elle arrive lorsque les données d’une page sont livrées sur un canal lent (afficher d’abord les données les plus utiles) ;
• permettre l’interaction de l’utilisateur, comme suivre un lien, même avant que la page entière ait été reçue et affichée.

public OptimizeOptions()

Class Optimizer

[Obsolete("Veuillez utiliser la classe PdfManager. La classe sera bientôt supprimée.")]
public static class Optimizer

Héritage

object ← Optimizer

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Méthodes

Process(OptimizeOptions)

Commence le traitement Documentize.Optimizer avec les paramètres spécifiés.

public static ResultContainer Process(OptimizeOptions options)

Paramètres

• options OptimizeOptions: Un objet options contenant des instructions pour l’opération.

Retourne

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

Process(RotateOptions)

Commence le traitement Documentize.Optimizer avec les paramètres spécifiés.

public static ResultContainer Process(RotateOptions options)

Paramètres

• options RotateOptions: Un objet options contenant des instructions pour l’opération.

Retourne

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

Process(ResizeOptions)

Commence le traitement Documentize.Optimizer avec les paramètres spécifiés.

public static ResultContainer Process(ResizeOptions options)

Paramètres

• options ResizeOptions: Un objet options contenant des instructions pour l’opération.

Retourne

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

Process(CompressOptions)

Commence le traitement Documentize.Optimizer avec les paramètres spécifiés.

public static ResultContainer Process(CompressOptions options)

Paramètres

• options CompressOptions: Un objet options contenant des instructions pour l’opération.

Retourne

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

Class PageInfo

public class PageInfo : PageSize

Héritage

object ← PageSize ← PageInfo

Membres hérités

• PageSize.Width,
• PageSize.Height,
• PageSize.IsLandscape,
• PageSize.A0,
• PageSize.A1,
• PageSize.A2,
• PageSize.A3,
• PageSize.A4,
• PageSize.A5,
• PageSize.A6,
• PageSize.B5,
• PageSize.PageLetter,
• PageSize.PageLegal,
• PageSize.PageLedger,
• PageSize.P11x17,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

PageInfo()

Constructeur de Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Constructeur de Documentize.PageInfo.

public PageInfo(double width, double height)

Paramètres

• width double: Largeur de la page.
• height double: Hauteur de la page.

Propriétés

MarginBottom

Obtient ou définit une valeur qui indique la marge inférieure.

public double MarginBottom { get; set; }

Valeur de propriété

double

MarginLeft

Obtient ou définit une valeur qui indique la marge gauche.

public double MarginLeft { get; set; }

Valeur de propriété

double

MarginRight

Obtient ou définit une valeur qui indique la marge droite.

public double MarginRight { get; set; }

Valeur de propriété

double

MarginTop

Obtient ou définit une valeur qui indique la marge supérieure.

public double MarginTop { get; set; }

Valeur de propriété

double

Class PageSize

public class PageSize

Héritage

object ← PageSize

Dérivé

• PageInfo

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

PageSize()

Constructeur de Documentize.PageSize. Tailles A4 par défaut.

public PageSize()

PageSize(double, double)

Constructeur de Documentize.PageSize.

public PageSize(double width, double height)

Paramètres

• width double: Largeur de la page.
• height double: Hauteur de la page.

Propriétés

A0

Taille A0 (1189x840 mm).

public static PageSize A0 { get; }

Valeur de la propriété

PageSize

A1

Taille A1 (840x594 mm).

public static PageSize A1 { get; }

Valeur de la propriété

PageSize

A2

Taille A2 (594x420 mm).

public static PageSize A2 { get; }

Valeur de la propriété

PageSize

A3

Taille A3 (420x297 mm).

public static PageSize A3 { get; }

Valeur de la propriété

PageSize

A4

Taille A4 (297x210 mm).

public static PageSize A4 { get; }

Valeur de la propriété

PageSize

A5

Taille A5 (210x148 mm).

public static PageSize A5 { get; }

Valeur de la propriété

PageSize

A6

Taille A6 (148x105 mm).

public static PageSize A6 { get; }

Valeur de la propriété

PageSize

B5

Taille B5 (250x176 mm).

public static PageSize B5 { get; }

Valeur de la propriété

PageSize

Height

Obtient ou définit la hauteur de la page.

public double Height { get; set; }

Valeur de la propriété

double

IsLandscape

Obtient l’orientation de la page. Renvoie true si c’est une orientation paysage et false si c’est un portrait.

public bool IsLandscape { get; }

Valeur de la propriété

bool

P11x17

Format 11x17 pouces.

public static PageSize P11x17 { get; }

Valeur de la propriété

PageSize

PageLedger

Taille Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valeur de la propriété

PageSize

PageLegal

Taille Légal (356x216 mm).

public static PageSize PageLegal { get; }

Valeur de la propriété

PageSize

PageLetter

Taille Lettre (279x216 mm).

public static PageSize PageLetter { get; }

Valeur de la propriété

PageSize

Width

Obtient ou définit la largeur de la page.

public double Width { get; set; }

Valeur de la propriété

double

Class PdfAConverter

public static class PdfAConverter

Héritage

object ← PdfAConverter

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple montre comment convertir le document PDF en format PDF/A (PDF/A-3b dans ce cas) :

// Créer la classe d'options pour configurer le processus de conversion
var options = new PdfAConvertOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Ajouter le fichier source
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // remplacez par le chemin réel de votre fichier

// Ajouter le chemin pour enregistrer le fichier converti
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Exécuter la conversion
PdfAConverter.Process(options);

L’exemple montre comment valider la conformité du document PDF au format PDF/A (PDF/A-1a dans ce cas) :

// Créer la classe d'options pour configurer le processus de validation
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Ajouter un ou plusieurs fichiers à valider
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // remplacez par le chemin réel de votre fichier
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// ajoutez d'autres fichiers si nécessaire

// Exécuter la validation et obtenir les résultats
var resultContainer = PdfAConverter.Process(options);

// Vérifier la propriété resultContainer.ResultCollection pour les résultats de validation de chaque fichier :
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Résultat de validation pour le i-ème document
}

Méthodes

Process(PdfAConvertOptions)

Convertit un document PDF en format PDF/A.

public static ResultContainer Process(PdfAConvertOptions options)

Paramètres

• options PdfAConvertOptions : Un objet d’options contenant des instructions pour l’opération.

Retourne

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Process(PdfAValidateOptions)

Vérifie la conformité d’un document PDF avec le format spécifié PDF/A.

public static ResultContainer Process(PdfAValidateOptions options)

Paramètres

• options PdfAValidateOptions : Un objet d’options contenant des instructions pour l’opération.

Retourne

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAConvertOptions

Implémente

• IPluginOptions

Membres hérités

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

PdfAConvertOptions()

public PdfAConvertOptions()

Propriétés

Outputs

Obtient la collection des cibles ajoutées (sources de données de fichier ou de flux) pour les résultats de l’opération de sauvegarde.

public List<idatasource> Outputs { get; }

Valeur de la propriété

List<IDataSource>

Méthodes

AddOutput(IDataSource)

Ajoute une nouvelle cible de sauvegarde de résultat.

public void AddOutput(IDataSource dataSource)

Paramètres

• dataSource IDataSource: Cible (source de données de fichier ou de flux) pour les résultats de l’opération de sauvegarde. :

Class PdfAOptionsBase

Représente la classe de base pour les options du plugin Documentize.PdfAConverter. Cette classe fournit des propriétés et des méthodes pour configurer le processus de conversion et de validation PDF/A.

public abstract class PdfAOptionsBase : IPluginOptions

Héritage

object ← PdfAOptionsBase

Dérivé

• PdfAConvertOptions,
• PdfAValidateOptions

Implémente

• IPluginOptions

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

PdfAOptionsBase()

protected PdfAOptionsBase()

Propriétés

AlignText

Obtient ou définit une valeur indiquant si des moyens supplémentaires sont nécessaires pour préserver l’alignement du texte durant le processus de conversion PDF/A.

public bool AlignText { get; set; }

Valeur de la propriété

bool

Remarques

Lorsqu’elle est définie sur true, le processus de conversion tentera de restaurer les limites de segment de texte d’origine. Pour la plupart des documents, il n’est pas nécessaire de modifier cette propriété de la valeur par défaut false, car l’alignement du texte ne change pas durant le processus de conversion par défaut.

CheckDifferentNamesInFontDictionaries

Obtient les indicateurs qui contrôlent la conversion PDF/A pour les cas où le document PDF source ne correspond pas à la spécification PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Valeur de la propriété

bool

ErrorAction

Obtient ou définit l’action à entreprendre pour les objets qui ne peuvent pas être convertis.

public ConvertErrorAction ErrorAction { get; set; }

Valeur de la propriété

ConvertErrorAction

IccProfileFileName

Obtient ou définit le nom de fichier du profil ICC (International Color Consortium) à utiliser pour la conversion PDF/A à la place de celui par défaut.

public string IccProfileFileName { get; set; }

Valeur de la propriété

string

Inputs

Obtient une collection de sources de données

public List<idatasource> Inputs { get; }

Valeur de la propriété

List<IDataSource>

IsLowMemoryMode

Obtient ou définit une valeur indiquant si le mode basse mémoire est activé durant le processus de conversion PDF/A.

public bool IsLowMemoryMode { get; set; }

Valeur de la propriété

bool

LogOutputSource

Obtient ou définit la source de données pour la sortie de journal.

public IDataSource LogOutputSource { get; set; }

Valeur de la propriété

IDataSource

OptimizeFileSize

Obtient ou définit une valeur indiquant s’il faut essayer de réduire la taille du fichier durant le processus de conversion PDF/A.

public bool OptimizeFileSize { get; set; }

Valeur de la propriété

bool

Remarques

Lorsqu’elle est définie sur true, le processus de conversion tentera de minimiser la taille du fichier résultant. Cela pourrait affecter la performance du processus de conversion.

PdfAVersion

Obtient ou définit la version de la norme PDF/A à utiliser pour la validation ou la conversion.

public PdfAStandardVersion PdfAVersion { get; set; }

Valeur de la propriété

PdfAStandardVersion

Remarques

La version de la norme PDF/A est utilisée pour déterminer le niveau de conformité pour la validation et la conversion PDF/A. Si la version est définie sur Documentize.PdfAStandardVersion.Auto, le système déterminera automatiquement la version appropriée de la norme PDF/A pour la validation en fonction des métadonnées du document. Pour le processus de conversion PDF/A, Documentize.PdfAStandardVersion.Auto par défaut est la version standard PDF/A-1b.

SoftMaskAction

Obtient ou définit l’action à entreprendre durant la conversion d’images avec des masques doux.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Valeur de la propriété

ConvertSoftMaskAction

Méthodes

AddInput(IDataSource)

Ajoute une nouvelle source de données à la collection

public void AddInput(IDataSource dataSource)

Paramètres

• dataSource IDataSource:

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAValidateOptions

Implémente

• IPluginOptions

Membres hérités

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Héritage

object ← PdfAValidationResult

Membres hérités

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Champs

• DataSource Obtient la source de données qui a été validée.

Valeur du champ

IDataSource

IsValid

Obtient une valeur indiquant si la validation a été réussie.

public readonly bool IsValid

Valeur du champ

bool

StandardVersion

Obtient la version de la norme PDF/A utilisée pour la validation.

public readonly PdfAStandardVersion StandardVersion

Valeur du champ

PdfAStandardVersion

Class PdfChatGpt

public static class PdfChatGpt

Héritage

object ← PdfChatGpt

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple démontre comment utiliser le plugin PdfChatGpt en ajoutant des messages à la demande.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Ajoutez le chemin du fichier de sortie.
options.ApiKey = "Votre clé API."; // Vous devez fournir la clé pour accéder à l'API.
options.MaxTokens = 1000; // Le nombre maximum de jetons à générer dans la complétion de chat.

// Ajouter les messages de demande.
options.Messages.Add(new Message
{
    Content = "Vous êtes un assistant utile.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "Quel est le plus grand diamètre de pizza jamais fabriqué?",
    Role = Role.User
});

// Traiter la demande.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // L'objet de complétion de chat de l'API ChatGPT.

L’exemple démontre comment utiliser le plugin PdfChatGpt en ajoutant un message à la demande.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Ajoutez le chemin du fichier de sortie.
options.ApiKey = "Votre clé API."; // Vous devez fournir la clé pour accéder à l'API.
options.MaxTokens = 1000; // Le nombre maximum de jetons à générer dans la complétion de chat.

// Ajouter le message de demande.
// Dans ce cas, le message système avec Content = "Vous êtes un assistant utile." est ajouté par défaut.
// Le rôle du message de demande est "utilisateur" par défaut.
options.Query = "Quelle est la température la plus basse enregistrée sur Terre ?";

// Traiter la demande.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // L'objet de complétion de chat de l'API ChatGPT.

L’exemple démontre comment utiliser le plugin PdfChatGpt en ajoutant des fichiers comme source(s) de message.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Ajoutez le chemin du fichier de sortie.

// Ajouter la source de texte PDF.
// En cas de sources multiples, le texte de chaque document sera ajouté à la collection de messages de demande
// en tant que message séparé avec le rôle "utilisateur".
options.AddInput(new FileDataSource("TextSource.pdf"));

options.ApiKey = "Votre clé API."; // Vous devez fournir la clé pour accéder à l'API.
options.MaxTokens = 1000; // Le nombre maximum de jetons à générer dans la complétion de chat.

// Ajouter le message de demande.
// Dans ce cas, le message système avec Content = "Vous êtes un assistant utile." est ajouté par défaut.
// Le rôle du message de demande est "utilisateur" par défaut.
options.Query = "Combien de lettres dans le texte fourni ?";

// Traiter la demande.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // L'objet de complétion de chat de l'API ChatGPT.

Remarques

Le Documentize.PdfChatGpt est utilisé pour envoyer des demandes à ChatGPT directement ou en ajoutant des sources de fichiers PDF et enregistrer la réponse dans la source de sortie.

Méthodes

Process(IPluginOptions)

La méthode n’a pas de version synchrone. Utilisez la méthode ProcessAsync à la place.

public static ResultContainer Process(IPluginOptions options)

Paramètres

• options IPluginOptions: Un objet d’options contenant des instructions pour le PdfChatGpt.

Retours

ResultContainer : #### Exceptions

NotImplementedException

ProcessAsync(IPluginOptions)

Commence le traitement de PdfChatGpt avec les paramètres spécifiés.

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

Paramètres

• options IPluginOptions: Un objet d’options contenant des instructions pour le PdfChatGpt.

Retours

Task<ResultContainer>

L’objet tâche représentant l’opération asynchrone.

Exceptions

ArgumentException : InvalidOperationException

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Héritage

object ← PdfChatGptOptions

Dérivé

• PdfChatGptRequestOptions

Implémente

• IPluginOptions

Membres Hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

PdfChatGptOptions()

Initialise une nouvelle instance de l’objet Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Propriétés

Inputs

public List<idatasource> Inputs { get; }

Valeur de la Propriété

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Valeur de la Propriété

List<IDataSource>

Méthodes

AddInput(IDataSource)

Ajoute une nouvelle source de données à la collection de données du plugin PdfChatGpt.

public void AddInput(IDataSource dataSource)

Paramètres

• dataSource IDataSource: Source de données (fichier ou flux) à ajouter.

AddOutput(IDataSource)

Ajoute une nouvelle source de données de sauvegarde à la collection de données du plugin PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Paramètres

• saveDataSource IDataSource: Source de données (fichier ou flux) pour sauvegarder les résultats des opérations. :

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Héritage

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implémente

• IPluginOptions

Membres hérités

• PdfChatGptOptions.AddInput(IDataSource),
• PdfChatGptOptions.AddOutput(IDataSource),
• PdfChatGptOptions.Inputs,
• PdfChatGptOptions.Outputs,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructeurs

PdfChatGptRequestOptions()

Initialise une nouvelle instance de l’objet Documentize.PdfChatGptRequestOptions avec des options par défaut.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

Initialise une nouvelle instance de l’objet Documentize.PdfChatGptRequestOptions avec des options.

public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Paramètres

• apiKey string: La clé d’accès à l’API ChatGPT.
• model string: Le nom du modèle ChatGPT. Le modèle par défaut est : gpt-3.5-turbo-1106.
• apiUrl string: L’URL de l’API ChatGPT. L’URL par défaut est : https://api.openai.com/v1/chat/completions.
• query string: La requête texte à ChatGPT.

Propriétés

ApiKey

Obtient ou définit la clé d’accès à l’API ChatGPT.

public string ApiKey { get; set; }

Valeur de la propriété

string

ApiUrl

Obtient ou définit l’URL de l’API ChatGPT.

public string ApiUrl { get; set; }

Valeur de la propriété

string

CancellationToken

Le jeton d’annulation.

public CancellationToken CancellationToken { get; set; }

Valeur de la propriété

CancellationToken

MaxTokens

Nombre maximum de tokens dans la réponse. La valeur par défaut est nulle, ce qui signifie l’infini.

public int? MaxTokens { get; set; }

Valeur de la propriété

int?

Messages

Obtient ou définit une collection des objets Documentize.Message.

public List<message> Messages { get; set; }

Valeur de la propriété

List<Message>

Remarques

Lors de l’ajout de plusieurs messages aux options, l’ordre dans lequel les messages sont collectés est le suivant :

• Le premier message (le cas échéant) provient de options.Query, précédé par le message contenant : “Vous êtes un assistant utile.”, et le rôle est “système”.
• Ensuite (le cas échéant) les messages de la collection options.Messages sont ajoutés.
• Les messages provenant de sources de fichiers (le cas échéant) sont ajoutés en dernier, un objet de message pour chaque document avec le rôle “utilisateur”. Si aucun message n’est fourni, une ArgumentException est levée.

Model

Définit ou obtient l’ID du modèle à utiliser.

public string Model { get; set; }

Valeur de la propriété

string

NumberOfChoices

Combien de choix de complétion de chat générer pour chaque message d’entrée.

public int NumberOfChoices { get; set; }

Valeur de la propriété

int

Query

Obtient ou définit la requête texte à ChatGPT. Si elle n’est pas vide, cela sera le premier message dans la collection, qui sera envoyé dans la requête.

public string Query { get; set; }

Valeur de la propriété

string

Temperature

Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0.8 rendront la sortie plus aléatoire, tandis que des valeurs plus basses comme 0.2 la rendront plus focalisée et déterministe. La valeur par défaut est 1.

public double Temperature { get; set; }

Valeur de la propriété

double

Class PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

Héritage

object ← PdfConverterOptions

Dérivé

• PdfToXlsOptions

Implémente

• IPluginOptions

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Propriétés

Inputs

Renvoie la collection de données du plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }

Valeur de la propriété

Liste<IDataSource>

Outputs

Obtient la collection des cibles ajoutées pour les résultats d’opération de sauvegarde.

public List<idatasource> Outputs { get; }

Valeur de la propriété

Liste<IDataSource>

Méthodes

AddInput(IDataSource)

Ajoute une nouvelle source de données à la collection de données du plugin PdfConverter.

public void AddInput(IDataSource dataSource)

Paramètres

• dataSource IDataSource: Source de données à ajouter.

AddOutput(IDataSource)

Ajoute une nouvelle source de données à la collection de données du plugin PdfToXLSXConverterOptions.

public void AddOutput(IDataSource saveDataSource)

Paramètres

• saveDataSource IDataSource: Source de données (fichier ou flux) pour les résultats d’opération de sauvegarde.

Exceptions

NotImplementedException

Class PdfExtractor

public static class PdfExtractor

Héritage

object ← PdfExtractor

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple démontre comment extraire le contenu textuel d’un document PDF.

// Créer un objet ExtractTextOptions pour définir les instructions
var options = new ExtractTextOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Effectuer le processus
var results = PdfExtractor.ExtractText(options);
// Obtenir le texte extrait de l'objet ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

L’exemple démontre comment extraire le contenu textuel d’un document PDF avec TextFormattingMode.

// Créer un objet ExtractTextOptions pour définir TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Effectuer le processus
var results = PdfExtractor.ExtractText(options);
// Obtenir le texte extrait de l'objet ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

L’exemple démontre comment extraire des images d’un document PDF.

// Créer ExtractImagesOptions pour définir les instructions
var options = new ExtractImagesOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du répertoire de sortie
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Effectuer le processus
var results = PdfExtractor.ExtractImages(options);
// Obtenir le chemin de l'image résultante
var imageExtracted = results.ResultCollection[0].ToFile();

L’exemple démontre comment extraire des images d’un document PDF vers des flux sans dossier.

// Créer ExtractImagesOptions pour définir les instructions
var options = new ExtractImagesOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Ne pas définir de sortie - cela écrira les résultats dans des flux
// Effectuer le processus
var results = PdfExtractor.ExtractImages(options);
// Obtenir le Stream
var ms = results.ResultCollection[0].ToStream();
// Copier les données dans un fichier pour la démonstration
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

L’exemple démontre comment exporter des valeurs de formulaire vers un fichier CSV.

// Créer un objet ExtractFormDataToDsvOptions pour définir les instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// Effectuer le processus
PdfExtractor.ExtractFormData(options);

Méthodes

ExtractFormData(ExtractFormDataToDsvOptions)

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

public static ResultContainer ExtractFormData(ExtractFormDataToDsvOptions options)

Paramètres

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

Retours

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

ExtractImages(ExtractImagesOptions)

Extraire des images d’un document PDF.

public static ResultContainer ExtractImages(ExtractImagesOptions options)

Paramètres

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

Retours

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

ExtractText(ExtractTextOptions)

Extraire du texte d’un document PDF.

public static ResultContainer ExtractText(ExtractTextOptions options)

Paramètres

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

Retours

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class PdfManager

Représente le plugin Documentize.PdfManager. Utilisé pour fusionner, diviser, optimiser, faire pivoter, redimensionner, compresser des documents PDF et ajouter un tableau, ajouter une table des matières aux documents PDF. Peut fusionner plusieurs documents PDF en un seul PDF. Peut diviser des documents PDF en pages distinctes. Peut optimiser, faire pivoter, redimensionner, compresser des documents PDF. Peut faire pivoter, redimensionner les pages d’un document PDF. Peut ajouter un tableau à un document PDF. Peut ajouter une table des matières aux documents PDF.

public static class PdfManager

Héritage

object ← PdfManager

Membres hérités

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Exemples

L’exemple démontre comment fusionner deux documents PDF.

// Créer un objet MergeOptions pour définir les instructions
var options = new MergeOptions();
// Ajouter les chemins des fichiers d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
PdfManager.Merge(options);

L’exemple démontre comment diviser un document PDF.

// Créer un objet SplitOptions pour définir les instructions
var options = new SplitOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir les chemins des fichiers de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// Effectuer le processus
PdfManager.Split(options);

L’exemple démontre comment optimiser un document PDF.

// Créer un objet OptimizeOptions pour définir les instructions
var options = new OptimizeOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
PdfManager.Optimize(options);

L’exemple démontre comment faire pivoter un document PDF.

// Créer un objet RotateOptions pour définir les instructions
var options = new RotateOptions();
// Définir la nouvelle rotation
options.Rotation = Rotation.On90;
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
PdfManager.Rotate(options);

L’exemple démontre comment redimensionner un document PDF.

// Créer un objet ResizeOptions pour définir les instructions
var options = new ResizeOptions();
// Définir la nouvelle taille de page
options.PageSize = PageSize.A3;
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
PdfManager.Resize(options);

L’exemple démontre comment compresser un document PDF.

// Créer un objet CompressOptions pour définir les instructions
var options = new CompressOptions();
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
PdfManager.Compress(options);

L’exemple démontre comment ajouter un tableau à un fichier PDF.

// Configurer les options de tableau
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Nom")
            .AddCell().AddParagraph("Âge")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Effectuer le processus
PdfManager.AddTable(options);

L’exemple démonstre comment ajouter une table des matières à un fichier PDF.

// Créer un objet TocOptions pour définir les instructions
var options = new TocOptions();
// Définir le titre
options.Title = "Ma Table des Matières";
// Concevoir les en-têtes
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapitre I", 3));
options.Headings.Add(new TocHeading("Chapitre II", 4));
options.Headings.Add(new TocHeading("Chapitre III", 5));
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
PdfManager.AddTableOfContents(options);

L’exemple démontre comment ajouter une table des matières à un fichier PDF avec la génération de signets.

// Créer un objet TocOptions pour définir les instructions
var options = new TocOptions();
// Définir le titre
options.Title = "Ma Table des Matières";
// Générer des liens dans les signets
options.GenerateBookmarks = true;
// Concevoir les en-têtes
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapitre I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapitre II", 4, true, 1));
options.Headings.Add(new TocHeading("Exemple A", 4, true, 2));
options.Headings.Add(new TocHeading("Exemple B", 4, true, 2));
options.Headings.Add(new TocHeading("Exemple C", 4, true, 2));
options.Headings.Add(new TocHeading("Exemple D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapitre III", 5, true, 1));
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Effectuer le processus
PdfManager.AddTableOfContents(options);

L’exemple démontre comment ajouter une table des matières à un fichier PDF et sauvegarder en tant que flux.

// Créer un objet TocOptions pour définir les instructions
var options = new TocOptions();
// Définir le titre
options.Title = "Ma Table des Matières";
// Concevoir les en-têtes
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Définir le flux de sortie 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Effectuer le processus
PdfManager.AddTableOfContents(options);