Classe 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 les options par défaut.

public CompressOptions()  

Classe 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 la propriété

string

Classe DocConverter

public sealed class DocConverter

Héritage

object ← DocConverter

Membres hérités

• object.GetType(),
• 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 Doc.

// créer DocConverter
var plugin = new DocConverter();
// créer un objet PdfToDocOptions pour définir les instructions
var opt = new PdfToDocOptions();
// ajouter le chemin du fichier d'entrée
opt.AddInput(new FileDataSource(inputPath));
// définir le chemin du fichier de sortie
opt.AddOutput(new FileDataSource(outputPath));
// effectuer le processus
plugin.Process(opt);

Constructeurs

DocConverter()

public DocConverter()

Méthodes

Dispose()

Implémentation de IDisposable.

public void Dispose()

Process(PdfToDocOptions)

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

public ResultContainer Process(PdfToDocOptions options)

Paramètres

• options PdfToDocOptions : Un objet d’options contenant des instructions pour le Documentize.DocConverter.

Renvoie

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

Classe 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

Classe 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 la source de données.

public DataType DataType { get; }

Valeur de Propriété

DataType

Path

Obtient le chemin vers le fichier des données actuelles.

public string Path { get; }

Valeur de Propriété

string

Classe 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.

Classe HtmlConverter

public sealed class HtmlConverter : IDisposable

Héritage

object ← HtmlConverter

Implémente

• IDisposable

Membres hérités

• object.GetType(),
• 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 HtmlConverter
var plugin = new HtmlConverter();
// créer un objet PdfToHtmlOptions pour définir le type de données de sortie comme fichier avec ressources intégrées
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// ajouter le chemin du fichier d'entrée
opt.AddInput(new FileDataSource(inputPath));
// définir le chemin du fichier de sortie
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

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

// créer HtmlConverter
var plugin = new HtmlConverter();
// créer HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// ajouter le chemin du fichier d'entrée
opt.AddInput(new FileDataSource(inputPath));
// définir le chemin du fichier de sortie
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Constructeurs

HtmlConverter()

public HtmlConverter()

Méthodes

Dispose()

Implémentation de IDisposable.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Paramètres

• options IPluginOptions: Un objet d’options contenant des instructions pour Documentize.HtmlConverter.

Retourne

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

Classe 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

Classe ImageExtractor

public class ImageExtractor : PdfExtractor, IDisposable

Héritage

object ← PdfExtractor ← ImageExtractor

Implémente

• IDisposable

Membres hérités

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• 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 des images d’un document PDF.

// créer un objet ImageExtractor pour extraire des images
using (var plugin = new ImageExtractor())
{
    // créer ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // ajouter le chemin du fichier d'entrée
    opt.AddInput(new FileDataSource(inputPath));
    // définir le répertoire de sortie
    opt.AddInput(new FileDataSource("D:\\"));

    // effectuer le processus d'extraction
    var resultContainer = plugin.Process(opt);

    // obtenir l'image de l'objet ResultContainer
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

Constructeurs

ImageExtractor()

public ImageExtractor()

Classe ImageExtractorOptions

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions

Héritage

object ← PdfExtractorOptions ← ImageExtractorOptions

Implémente

• IPluginOptions

Membres hérités

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Remarques

Il hérite des fonctions pour ajouter des données (fichiers, flux) représentant des documents PDF en entrée.

Constructeurs

ImageExtractorOptions()

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

public ImageExtractorOptions()

Propriétés

OperationName

Renvoie le nom de l’opération.

public override string OperationName { get; }

Valeur de la propriété

string

Classe JpegConverter

public sealed class JpegConverter

Héritage

object ← JpegConverter

Membres Hérités

• object.GetType(),
• 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 JpegConverter
var plugin = new JpegConverter();
// créer un objet PdfToJpegOptions pour définir les instructions
var opt = new PdfToJpegOptions();
// ajouter le chemin d'entrée
opt.AddInput(new FileDataSource(inputPath));
// définir le chemin de sortie
opt.AddOutput(new DirectoryDataSource(outputPath));
// effectuer le processus
plugin.Process(opt);

Constructeurs

JpegConverter()

public JpegConverter()

Méthodes

Process(PdfToJpegOptions)

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

public ResultContainer Process(PdfToJpegOptions options)

Paramètres

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

Retourne

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

Classe 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()  

Classe 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

Données

Obtient les données brutes.

public object Data { get; }  

Valeur de Propriété

object

IsFile

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

public bool IsFile { get; }  

Valeur de Propriété

bool

IsObject

Indique si le résultat est un objet.

public bool IsObject { get; }  

Valeur de Propriété

bool

IsStream

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

public bool IsStream { get; }  

Valeur de Propriété

bool

IsString

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

public bool IsString { get; }  

Valeur de Propriété

bool

Texte

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

public string Text { get; }  

Valeur de Propriété

string

Méthodes

ToFile()

Tente de convertir le résultat en fichier.

public string ToFile()  

Retourne

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

ToStream()

Tente de convertir le résultat en objet stream.

public Stream ToStream()  

Retourne

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

ToString()

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

public override string ToString()  

Retourne

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

Classe 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 un lien vers la page suivante aussi rapidement que possible ;
• afficher la page de manière incrémentale à mesure qu’elle arrive lorsque les données d’une page sont livrées sur un canal lent (afficher les données les plus utiles en premier) ;
• permettre l’interaction de l’utilisateur, telle que suivre un lien, même avant que la page entière ait été reçue et affichée.

public OptimizeOptions()

Classe PdfAConverter

public sealed class PdfAConverter

Héritage

object ← PdfAConverter

Membres hérités

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

Exemples

L’exemple démontre comment valider la conformité d’un 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 de votre fichier
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// ajoutez d'autres fichiers si nécessaire

// Créer l'instance du plugin
var plugin = new PdfAConverter();

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

// Vérifiez la propriété resultContainer.ResultCollection pour les résultats de validation pour 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
}

L’exemple démontre comment convertir un document PDF au 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 de votre fichier

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

// Créer l'instance du plugin
var plugin = new PdfAConverter();

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

Constructeurs

PdfAConverter()

public PdfAConverter()

Méthodes

Process(IPluginOptions)

Commence un processus de conversion ou de validation PDF/A avec les options données.

public ResultContainer Process(IPluginOptions options)

Paramètres

• options IPluginOptions: Un objet d’options contenant des instructions pour le plugin. Doit être une instance de la classe Documentize.PdfAConvertOptions ou Documentize.PdfAValidateOptions.

Retourne

ResultContainer : Un objet Documentize.ResultContainer contenant le résultat du traitement.

Classe PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAConvertOptions

Implemente

• 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 fichiers ou de flux) pour les résultats des opérations d’enregistrement.

public List<idatasource> Outputs { get; }

Valeur de la propriété

List<IDataSource>

Méthodes

AddOutput(IDataSource)

Ajoute une nouvelle cible d’enregistrement des résultats.

public void AddOutput(IDataSource dataSource)

Paramètres

• dataSource IDataSource: Cible (source de données de fichier ou de flux) pour les résultats des opérations d’enregistrement. :

Classe PdfAOptionsBase

Represents the base class for the Documentize.PdfAConverter plugin options. This class provides properties and methods for configuring the PDF/A conversion and validation process.

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’il est défini sur true, le processus de conversion tentera de rétablir les limites des segments de texte d’origine. Pour la plupart des documents, il n’est pas nécessaire de modifier cette propriété par rapport à la valeur par défaut false, car l’alignement du texte ne change pas pendant 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 à prendre 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 la 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 du 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’il est défini 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 correspond par défaut à la version de norme PDF/A-1b.

SoftMaskAction

Obtient ou définit l’action à prendre lors de 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:

Classe 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()  

Classe 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 réussi.

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

Classe PdfChatGpt

public sealed class PdfChatGpt : IDisposable

Héritage

object ← PdfChatGpt

Implémente

• IDisposable

Membres hérités

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

Exemples

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

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Ajouter 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 tokens à générer dans la complétion de chat.

    // Ajouter les messages de la 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 réalisé ?",
        Role = Role.User
    });

    // Traiter la demande.
    var result = await plugin.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 montre comment utiliser le plugin PdfChatGpt en ajoutant un message à la demande.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Ajouter 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 tokens à générer dans la complétion de chat.

    // Ajouter le message de la 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 requête est "user" par défaut.
    options.Query = "Quelle est la température la plus basse enregistrée sur Terre ?";

    // Traiter la demande.
    var result = await plugin.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 montre comment utiliser le plugin PdfChatGpt en ajoutant des fichiers comme source(s) de message.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Ajouter 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 "user".
    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 tokens à générer dans la complétion de chat.

    // Ajouter le message de la 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 requête est "user" par défaut.
    options.Query = "Combien de lettres dans le texte fourni ?";

    // Traiter la demande.
    var result = await plugin.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

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

Constructeurs

PdfChatGpt()

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

public PdfChatGpt()

Méthodes

Dispose()

Implémentation de IDisposable. En fait, cela n’est pas nécessaire pour PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

La méthode n’a pas de version synchrone. Utilisez plutôt la méthode ProcessAsync.

public ResultContainer Process(IPluginOptions options)

Paramètres

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

Retourne

ResultContainer : #### Exceptions

NotImplementedException

ProcessAsync(IPluginOptions)

Démarre le traitement PdfChatGpt avec les paramètres spécifiés.

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

Paramètres

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

Retourne

Task<ResultContainer>

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

Exceptions

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Définit le jeton d’annulation.

public void SetCancellationToken(CancellationToken cancellationToken)

Paramètres

• cancellationToken CancellationToken: Le jeton d’annulation. :

Classe PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions  

Héritage

object ←
PdfChatGptOptions

Dérivé

• PdfChatGptRequestOptions

Implemente

• 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 enregistrer les résultats des opérations. :

Classe PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

Héritage

object ← PdfConverterOptions

Dérivé

• PdfToDocOptions,
• PdfToHtmlOptions,
• 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

Entrées

Renvoie la collection de données du plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }

Valeur de la propriété

List<IDataSource>

Sorties

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é

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

Classe PdfExtractor

public abstract class PdfExtractor : IDisposable

Héritage

object ← PdfExtractor

Dérivé

• ImageExtractor,
• TextExtractor

Implémente

• IDisposable

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 texte d’un document PDF.

// créer un objet TextExtractor pour extraire le contenu PDF
using (TextExtractor extractor = new TextExtractor())
{
    // créer un objet TextExtractorOptions pour définir les instructions
    textExtractorOptions = new TextExtractorOptions();

    // ajouter le chemin du fichier d'entrée
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // effectuer le processus d'extraction
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

    // obtenir le texte extrait de l'objet ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Remarques

L’objet Documentize.TextExtractor est utilisé pour extraire du texte, ou Documentize.ImageExtractor pour extraire des images.

Constructeurs

PdfExtractor()

protected PdfExtractor()

Méthodes

Dispose()

Implémentation de IDisposable. En réalité, ce n’est pas nécessaire pour PdfExtractor.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

Paramètres

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

Renvoie

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

Classe PdfExtractorOptions

public abstract class PdfExtractorOptions : IPluginOptions

Héritage

object ← PdfExtractorOptions

Dérivé

• ImageExtractorOptions,
• TextExtractorOptions

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()

Remarques

Le Documentize.PdfExtractorOptions contient des fonctions de base pour ajouter des données (fichiers, flux) représentant des documents PDF d’entrée. Veuillez créer Documentize.TextExtractorOptions ou ImageExtractorOptions à la place de cela.

Propriétés

Entrées

Renvoie la collection de données du plugin PdfExtractor.

public List<idatasource> Inputs { get; }

Valeur de la propriété

List<IDataSource>

Nom de l’opération

Renvoie le nom de l’opération

public virtual string OperationName { get; }

Valeur de la propriété

string

Méthodes

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Paramètres

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

Classe PdfToDocOptions

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

Héritage

object ← PdfConverterOptions ← PdfToDocOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

PdfToDocOptions()

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

public PdfToDocOptions()

Classe PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions

Héritage

object ← PdfConverterOptions ← PdfToHtmlOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

PdfToHtmlOptions()

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

public PdfToHtmlOptions()

PdfToHtmlOptions(SaveDataType)

Initialise une nouvelle instance de l’objet Documentize.PdfToHtmlOptions pour le type de données de sortie spécifié.

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)

Paramètres

• outputDataType PdfToHtmlOptions.SaveDataType: Type de données de sortie.

Propriétés

OutputDataType

Obtient le type de données de sortie.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Valeur de la propriété

PdfToHtmlOptions.SaveDataType

Classe PdfToJpegOptions

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToJpegOptions

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

PdfToJpegOptions()

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

public PdfToJpegOptions()

Propriétés

OutputResolution

Obtient ou définit la valeur de résolution des images résultantes.

public int OutputResolution { get; set; }

Valeur de propriété

int

PageList

Obtient ou définit une liste de pages pour le processus.

public List<int> PageList { get; set; }

Valeur de propriété

List<int>

Quality

Obtient et définit la qualité de sortie.

public int Quality { get; set; }

Valeur de propriété

int

Classe PdfToPngOptions

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToPngOptions

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

PdfToPngOptions()

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

public PdfToPngOptions()

Propriétés

OutputResolution

Obtient ou définit la valeur de résolution des images résultantes.

public int OutputResolution { get; set; }

Valeur de la propriété

int

PageList

Obtient ou définit une liste de pages pour le processus.

public List<int> PageList { get; set; }

Valeur de la propriété

List<int>

Classe PdfToTiffOptions

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions  

Héritage

object ←
PluginBaseOptions ←
PdfToTiffOptions

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

PdfToTiffOptions()

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

public PdfToTiffOptions()  

Propriétés

MultiPage

Obtient et définit un indicateur qui permet d’enregistrer toutes les pages dans un TIFF multi-pages.

public bool MultiPage { get; set; }  

Valeur de la propriété

bool

OutputResolution

Obtient ou définit la valeur de résolution des images résultantes.

public int OutputResolution { get; set; }  

Valeur de la propriété

int

PageList

Obtient ou définit une liste de pages pour le processus.

public List<int> PageList { get; set; }  

Valeur de la propriété

List<int>

Classe PdfToXlsOptions

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions  

Héritage

object ←
PdfConverterOptions ←
PdfToXlsOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

PdfToXlsOptions()

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

public PdfToXlsOptions()  

Propriétés

Format

Format de sortie.

public PdfToXlsOptions.ExcelFormat Format { get; set; }  

Valeur de la propriété

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Définir true si vous devez insérer une colonne vide comme première colonne de la feuille de calcul.
La valeur par défaut est false; cela signifie que la colonne vide ne sera pas insérée.

public bool InsertBlankColumnAtFirst { get; set; }  

Valeur de la propriété

bool

MinimizeTheNumberOfWorksheets

Définir true si vous devez minimiser le nombre de feuilles de calcul dans le classeur résultant.
La valeur par défaut est false; cela signifie enregistrer chaque page PDF comme feuille de calcul séparée.

public bool MinimizeTheNumberOfWorksheets { get; set; }  

Valeur de la propriété

bool

Classe PluginBaseOptions

public class PluginBaseOptions : IPluginOptions

Héritage

object ← PluginBaseOptions

Dérivé

• AddTimestampOptions,
• CompressOptions,
• DecryptionOptions,
• EncryptionOptions,
• HtmlToPdfOptions,
• MergeOptions,
• OptimizeOptions,
• PdfToJpegOptions,
• PdfToPngOptions,
• PdfToTiffOptions,
• ResizeOptions,
• RotateOptions,
• SignOptions,
• SplitOptions,
• TableOptions

Implemente

• 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

CloseInputStreams

Ferme les flux d’entrée après la fin de l’opération.

public bool CloseInputStreams { get; set; }

Valeur de la Propriété

bool

CloseOutputStreams

Ferme les flux de sortie après la fin de l’opération.

public bool CloseOutputStreams { get; set; }

Valeur de la Propriété

bool

Inputs

Retourne les données d’entrées pour l’opération.

public List<idatasource> Inputs { get; }

Valeur de la Propriété

List<IDataSource>

Outputs

Retourne les données de sorties pour l’opération.

public List<idatasource> Outputs { get; }

Valeur de la Propriété

List<IDataSource>

Méthodes

AddInput(IDataSource)

Ajoute de nouvelles données aux entrées.

public void AddInput(IDataSource dataSource)

Paramètres

• dataSource IDataSource: Données à ajouter.

AddOutput(IDataSource)

Ajoute de nouvelles données aux sorties.

public void AddOutput(IDataSource saveDataSource)

Paramètres

• saveDataSource IDataSource: Données à ajouter. :

Classe PngConverter

public sealed class PngConverter

Hérédité

object ← PngConverter

Membres hérités

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

Exemples

L’exemple montre comment convertir un document PDF en format PNG.

// créer PngConverter
var plugin = new PngConverter();
// créer un objet PdfToPngOptions pour définir les instructions
var opt = new PdfToPngOptions();
// ajouter le chemin du fichier d'entrée
opt.AddInput(new FileDataSource(inputPath));
// définir le chemin du fichier de sortie
opt.AddOutput(new DirectoryDataSource(outputPath));
// effectuer le processus
plugin.Process(opt);

Constructeurs

PngConverter()

public PngConverter()

Méthodes

Process(PdfToPngOptions)

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

public ResultContainer Process(PdfToPngOptions options)

Paramètres

• options PdfToPngOptions: Un objet d’options contenant des instructions pour le Documentize.PngConverter.

Renvoie

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

Classe Rectangle

public class Rectangle  

Héritage

object ←
Rectangle

Membres hérités

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

Constructeurs

Rectangle(double, double, double, double)

Constructeur de Rectangle.

public Rectangle(double llx, double lly, double urx, double ury)  

Paramètres

• llx double: X du coin inférieur gauche.
• lly double: Y du coin inférieur gauche.
• urx double: X du coin supérieur droit.
• ury double: Y du coin supérieur droit.

Classe ResultContainer

public class ResultContainer

Héritage

object ← ResultContainer

Membres hérites

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

Propriétés

ResultCollection

Obtient la collection des résultats de l’opération

public List<ioperationresult> ResultCollection { get; }

Valeur de la propriété

List<IOperationResult>

Classe StreamDataSource

public sealed class StreamDataSource : IDataSource

Héritage

object ← StreamDataSource

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

StreamDataSource(Stream)

Initialise une nouvelle source de données de flux avec l’objet de flux spécifié.

public StreamDataSource(Stream data)

Paramètres

• data Stream: Objet de flux

Propriétés

Data

Obtient l’objet de flux de la source de données actuelle.

public Stream Data { get; }

Valeur de la Propriété

Stream

DataType

Type de source de données (flux).

public DataType DataType { get; }

Valeur de la Propriété

DataType

Classe StringResult

public sealed class StringResult : IOperationResult  

Héritage

object ←
StringResult

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

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

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

public string Text { get; }  

Valeur de la propriété

string

Méthodes

ToFile()

Tente 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()

Tente de convertir le résultat en objet de flux.

public Stream ToStream()  

Renvoie

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

ToString()

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

public override string ToString()  

Renvoie

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

Classe TableCellBuilder

public class TableCellBuilder : TableRowBuilder

Héritage

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Membres hérités

• TableRowBuilder.AddCell(),
• TableRowBuilder.AddRow(),
• TableBuilder.AddRow(),
• TableBuilder.AddTable(),
• TableBuilder.InsertPageAfter(int),
• TableBuilder.InsertPageBefore(int),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Méthodes

AddCell()

Ajouter une cellule à la table.

public override TableCellBuilder AddCell()

Retours

TableCellBuilder : Instance de l’actuel Documentize.TableCellBuilder.

AddParagraph(params string[])

Ajouter des paragraphes à la cellule de la table.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Paramètres

• paragraphs string[]: Texte pour les Paragraphes.

Retours

TableCellBuilder : Instance de l’actuel Documentize.TableCellBuilder.

Classe TableGenerator

public sealed class TableGenerator

Héritage

object ← TableGenerator

Membres hérité

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

Exemples

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

// créer TableGenerator
var plugin = new TableGenerator();
// créer un objet TableOptions pour définir les instructions
TableOptions opt = 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
opt.AddInput(new FileDataSource(inputPath1));
// définir le chemin du fichier de sortie
opt.AddOutput(new FileDataSource(outputPath));
// effectuer le processus
plugin.Process(opt);

Constructeurs

TableGenerator()

public TableGenerator()

Méthodes

Process(TableOptions)

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

public ResultContainer Process(TableOptions options)

Paramètres

• options TableOptions : Un objet d’options contenant des instructions pour Documentize.TableGenerator.

Retourne

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

Classe TableRowBuilder

public class TableRowBuilder : TableBuilder  

Héritage

object ←
TableBuilder ←
TableRowBuilder

Dérivé

• TableCellBuilder

Membres hérités

• TableBuilder.AddRow(),
• TableBuilder.AddTable(),
• TableBuilder.InsertPageAfter(int),
• TableBuilder.InsertPageBefore(int),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Méthodes

AddCell()

Ajouter une cellule à la ligne de table.

public virtual TableCellBuilder AddCell()  

Renvoie

TableCellBuilder : Instance de Documentize.TableCellBuilder créée.

AddRow()

Surcharge de AddRow.

public override TableRowBuilder AddRow()  

Renvoie

TableRowBuilder : Instance de Documentize.TableRowBuilder actuelle.

Classe TextExtractor

public class TextExtractor : PdfExtractor, IDisposable  

Héritage

object ←
PdfExtractor ←
TextExtractor

Implémente

• IDisposable

Membres hérités

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• 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 texte d’un document PDF.

// créer un objet TextExtractor pour extraire le texte dans le contenu PDF  
using (var plugin = new TextExtractor())  
{  
    // créer TextExtractorOptions  
    var opt = new TextExtractorOptions();  

    // ajouter le chemin du fichier d'entrée  
    opt.AddInput(new FileDataSource(inputPath));  

    // effectuer le processus d'extraction  
    var resultContainer = plugin.Process(opt);  

    // obtenir le texte extrait de l'objet ResultContainer  
    var textExtracted = resultContainer.ResultCollection[0].ToString();  
}  

Constructeurs

TextExtractor()

public TextExtractor()  

Classe TextExtractorOptions

public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions

Héritage

object ← PdfExtractorOptions ← TextExtractorOptions

Implémente

• IPluginOptions

Membres hérités

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• 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 TextExtractor pour extraire le contenu PDF
using (TextExtractor extractor = new TextExtractor())
{
    // créer un objet TextExtractorOptions pour définir TextFormattingMode (Pure, ou Raw - par défaut)
    extractorOptions = new TextExtractorOptions(TextExtractorOptions.TextFormattingMode.Pure);

    // ajouter le chemin du fichier d'entrée aux sources de données
    extractorOptions.AddInput(new FileDataSource(inputPath));

    // effectuer le processus d'extraction
    ResultContainer resultContainer = extractor.Process(extractorOptions);

    // obtenir le texte extrait de l'objet ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Remarques

L’objet Documentize.TextExtractorOptions est utilisé pour définir Documentize.TextExtractorOptions.TextFormattingMode et d’autres options pour l’opération d’extraction de texte. De plus, il hérite des fonctions pour ajouter des données (fichiers, flux) représentant des documents PDF d’entrée.

Constructeurs

TextExtractorOptions(TextFormattingMode)

Initialise une nouvelle instance de l’objet Documentize.TextExtractorOptions pour le mode de formatage de texte spécifié.

public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)

Paramètres

• formattingMode TextExtractorOptions.TextFormattingMode: Valeur du mode de formatage de texte.

TextExtractorOptions()

Initialise une nouvelle instance de l’objet Documentize.TextExtractorOptions avec le mode de formatage de texte ‘Raw’ (par défaut).

public TextExtractorOptions()

Propriétés

FormattingMode

Obtient le mode de formatage.

public TextExtractorOptions.TextFormattingMode FormattingMode { get; }

Valeur de la propriété

TextExtractorOptions.TextFormattingMode

OperationName

Renvoie le nom de l’opération.

public override string OperationName { get; }

Valeur de la propriété

string

Classe TiffConverter

public sealed class TiffConverter

Héritage

objet ← TiffConverter

Membres hérités

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

Exemples

L’exemple montre comment convertir un document PDF en format TIFF.

// créer TiffConverter
var plugin = new TiffConverter();
// créer un objet PdfToTiffOptions pour définir les instructions
var opt = new PdfToTiffOptions();
// ajouter le chemin du fichier d'entrée
opt.AddInput(new FileDataSource(inputPath));
// définir le chemin du fichier de sortie
opt.AddOutput(new DirectoryDataSource(outputPath));
// effectuer le processus
plugin.Process(opt);

Constructeurs

TiffConverter()

public TiffConverter()

Méthodes

Process(PdfToTiffOptions)

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

public ResultContainer Process(PdfToTiffOptions options)

Paramètres

• options PdfToTiffOptions : Un objet d’options contenant des instructions pour le Documentize.TiffConverter.

Renvoie

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

Constructeur de Table de Classe

public class TableBuilder

Héritage

object ← TableBuilder

Dérivé

• TableRowBuilder

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

AddRow()

Ajouter une nouvelle ligne à la table.

public virtual TableRowBuilder AddRow()

Retourne

TableRowBuilder : Instance de l’actuel Documentize.TableRowBuilder.

AddTable()

Ajouter une nouvelle table au document.

public TableBuilder AddTable()

Retourne

TableBuilder : Instance de l’actuel Documentize.TableBuilder.

InsertPageAfter(int)

Insérer une page après la page spécifiée.

public TableOptions InsertPageAfter(int page)

Paramètres

• page int : Numéro de la page après laquelle insérer la table.

Retourne

TableOptions : Instance de l’actuel Documentize.TableOptions.

InsertPageBefore(int)

Insérer une page avant la page spécifiée.

public TableOptions InsertPageBefore(int page)

Paramètres

• page int : Numéro de la page avant laquelle insérer la table.

Retourne

TableOptions : Instance de l’actuel Documentize.TableOptions.

Opérateurs

implicit operator TableOptions(TableBuilder)

Convertit le constructeur Documentize.TableBuilder en options Documentize.TableOptions.

public static implicit operator TableOptions(TableBuilder builder)

Paramètres

• builder TableBuilder : Instance de l’actuel Documentize.TableBuilder.

Retourne

TableOptions : Résultat de la conversion en PdfGeneratorTableOptions.

Enum ConvertErrorAction

public enum ConvertErrorAction

Champs

• Delete = 0
• None = 1

Enum ConvertSoftMaskAction

public enum ConvertSoftMaskAction

Champs

• ConvertToStencilMask = 1: Le masque doux sera converti en masque de pochoir.
• Default = 0: Utiliser la stratégie par défaut.

Enum HtmlMediaType

public enum HtmlMediaType

Fields

• Print = 0: Imprimer.
• Screen = 1: Écran.

Enum HtmlPageLayoutOption

public enum HtmlPageLayoutOption

Champs

• FitToWidestContentWidth = 3: Indique que la largeur de la page est déterminée par la taille du contenu elle-même, et non par la largeur de page spécifiée.
• None = 0: Valeur par défaut qui indique que l’HtmlPageLayoutOption n’affectera pas les tailles et les mises en page des pages.
• ScaleToPageWidth = 256: Indique que le contenu du document sera mis à l’échelle pour s’adapter à la page.

Enum PdfAStandardVersion

public enum PdfAStandardVersion

Champs

• Auto = 0: La version de la norme PDF/A est déterminée automatiquement.
• PDF_A_1A = 1: Spécifie la version de la norme PDF/A-1a.
• PDF_A_1B = 2: Spécifie la version de la norme PDF/A-1b.
• PDF_A_2A = 3: Spécifie la version de la norme PDF/A-2a.
• PDF_A_2B = 4: Spécifie la version de la norme PDF/A-2b.
• PDF_A_2U = 5: Spécifie la version de la norme PDF/A-2u.
• PDF_A_3A = 6: Spécifie la version de la norme PDF/A-3a.
• PDF_A_3B = 7: Spécifie la version de la norme PDF/A-3b.
• PDF_A_3U = 8: Spécifie la version de la norme PDF/A-3u.

Enum PdfToHtmlOptions.SaveDataType

public enum PdfToHtmlOptions.SaveDataType

Champs

• FileWithEmbeddedResources = 1: Enregistrer le HTML dans un fichier avec des ressources intégrées
• FileWithExternalResources = 0: Enregistrer le HTML dans un fichier avec des ressources externes
• StreamWithEmbeddedResources = 2: Enregistrer le HTML dans un flux de fichiers avec des ressources intégrées

Enum PdfToXlsOptions.ExcelFormat

Permet de spécifier le format de fichier .xlsx, .xls/xml ou csv. La valeur par défaut est XLSX.

public enum PdfToXlsOptions.ExcelFormat

Fields

• CSV = 2: Un format de fichier de valeurs séparées par des virgules (CSV).
• ODS = 4: Tableur Open Document.
• XLSM = 3: Un format de fichier Office Open XML (.xlsm) activé pour les macros.
• XLSX = 1: Format de fichier Office Open XML (.xlsx).
• XMLSpreadSheet2003 = 0: Format de fichier Excel 2003 XML (.xls).

Enum TextExtractorOptions.TextFormattingMode

public enum TextExtractorOptions.TextFormattingMode

Fields

• Plain = 2: Représente le contenu textuel du PDF en tenant compte de la position relative des fragments de texte mais sans ajouter d’espaces supplémentaires.
• Pure = 0: Représente le contenu textuel du PDF avec quelques routines de formatage. Cela comprend la prise en compte des positions relatives et l’ajout d’espaces supplémentaires pour aligner le texte à la largeur de la page.
• Raw = 1: Représente le contenu PDF tel quel, c’est-à-dire sans formatage.

Fusion de Classes

public sealed class Merger

Héritage

object ← Merger

Membres hérités

• object.GetType(),
• 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 Merger
var plugin = new Merger();
// créer un objet MergeOptions pour définir les instructions
var opt = new MergeOptions();
// ajouter des chemins de fichiers d'entrée
opt.AddInput(new FileDataSource(inputPath1));
opt.AddInput(new FileDataSource(inputPath2));
// définir le chemin du fichier de sortie
opt.AddOutput(new FileDataSource(outputPath));
// effectuer le processus
plugin.Process(opt);

Constructeurs

Merger()

public Merger()

Méthodes

Process(MergeOptions)

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

public ResultContainer Process(MergeOptions options)

Paramètres

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

Retourne

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

Horodatage de classe

public class Timestamp

Héritage

object ← Timestamp

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 ajouter un horodatage au document.

// créer un horodatage
var plugin = new Timestamp();
// créer un objet AddTimestampOptions pour définir les instructions
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// ajouter le chemin du fichier d'entrée
opt.AddInput(new FileDataSource("path_to_pdf"));
// définir le chemin du fichier de sortie
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// effectuer le processus
plugin.Process(opt);

Constructeurs

Timestamp()

public Timestamp()

Méthodes

Process(AddTimestampOptions)

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

public ResultContainer Process(AddTimestampOptions options)

Paramètres

• options AddTimestampOptions : Un objet d’options contenant des instructions pour Documentize.AddTimestampOptions.

Renvoie

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

Infos de la classe

public static class Info

Héritage

objet ← 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

Interface IDataSource

public interface IDataSource

Propriétés

DataType

Type de source de données.

DataType DataType { get; }

Valeur de propriété

DataType

Interface IOperationResult

public interface IOperationResult

Propriétés

Données

Obtient les données brutes.

object Data { get; }

Valeur de propriété

object

IsFile

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

bool IsFile { get; }

Valeur de propriété

bool

IsStream

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

bool IsStream { get; }

Valeur de propriété

bool

IsString

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

bool IsString { get; }

Valeur de propriété

bool

Méthodes

ToFile()

Essaie de convertir le résultat en fichier.

string ToFile()

Retourne

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 stream.

Stream ToStream()

Retourne

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

Interface IPluginOptions

public interface IPluginOptions

Licence de Classe

public static class License

Héritage

object ← License

Membres Hérités

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

Exemples

Montre comment activer une licence.

// Définir la Licence
License.Set("PathToLicense.lic");

Méthodes

Set(string)

Licence le composant.

public static void Set(string licenseName)

Paramètres

• licenseName string: Peut être un nom de fichier complet ou court. Utilisez une chaîne vide pour passer en mode évaluation.

Message de Classe

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