Documentize Namespace

Index

L’index du choix dans la liste des choix.

[JsonProperty("index")]
public int Index { get; set; }

Valeur de la Propriété

Message

Un message de complétion de chat généré par le modèle.

[JsonProperty("message")]
public Message Message { get; set; }

Valeur de la Propriété

Message

Namespace: Documentize Assembly: Documentize.dll

Class AddTimestampOptions

Information

Représente les options d’ajout de timestamp pour le plugin Documentize.Timestamp.

[Obsolete("La classe sera bientôt supprimée. Veuillez utiliser la classe SignOptions.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← AddTimestampOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

AddTimestampOptions(Stream, string, string, string)

Initialise une nouvelle instance de l’objet Documentize.AddTimestampOptions avec les 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 pour le fichier pfx.
serverUrl string: L’URL du serveur de timestamp.
serverBasicAuthCredentials string: Les informations d’identification d’authentification de base, le nom d’utilisateur et le mot de passe sont combinés dans une chaîne “username:password”. (Facultatif).

AddTimestampOptions(string, string, string, string)

Initialise une nouvelle instance de l’objet Documentize.AddTimestampOptions avec les 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 pour le fichier pfx.
serverUrl string: L’URL du serveur de timestamp.
serverBasicAuthCredentials string: Les informations d’identification d’authentification de base, le nom d’utilisateur et le mot de passe sont combinés dans une chaîne “username:password”. (Facultatif).

Namespace: Documentize Assembly: Documentize.dll

Class ChatCompletion

Information

Représente une réponse de complétion de chat retournée par le modèle, basée sur l’entrée fournie.

public class ChatCompletion

Inheritance

object ← ChatCompletion

Inherited Members

Constructors

ChatCompletion()

public ChatCompletion()

Properties

Choices

Une liste de choix de complétion de chat. Peut en avoir plus d’un si n est supérieur à 1.

[JsonProperty("choices")]
public List<choice> Choices { get; set; }

Property Value

List<Choice>

Created

L’horodatage Unix (en secondes) de la création de la complétion de chat.

[JsonProperty("created")]
public long Created { get; set; }

Property Value

long

Id

Un identifiant unique pour la complétion de chat.

[JsonProperty("id")]
public string Id { get; set; }

Property Value

Model

Le modèle utilisé pour la complétion de chat.

[JsonProperty("model")]
public string Model { get; set; }

Property Value

Object

Le type d’objet, qui est toujours chat.completion.

[JsonProperty("object")]
public string Object { get; set; }

Property Value

SystemFingerprint

Cette empreinte représente la configuration backend avec laquelle le modèle fonctionne.

[JsonProperty("system_fingerprint")]
public string SystemFingerprint { get; set; }

Property Value

Usage

Statistiques d’utilisation pour la requête de complétion.

[JsonProperty("usage")]
public Usage Usage { get; set; }

Property Value

Usage

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptConsts

Information

Cette classe représente un stockage pour les constantes.

public static class ChatGptConsts

Héritage

object ← ChatGptConsts

Membres hérités

Champs

ApiUrl

Valeur du champ

ModelName

public static string ModelName

Valeur du champ

SystemRole

public static string SystemRole

Valeur du champ

SystemRoleDescription

public static string SystemRoleDescription

Valeur du champ

UserRole

public static string UserRole

Valeur du champ

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptRequestOptions

Information

Représente les options pour le plugin Documentize.PdfManager.

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ChatGptRequestOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

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

public ChatGptRequestOptions(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 string à 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é

ApiUrl

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

public string ApiUrl { get; set; }

Valeur de la propriété

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 null, 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

Lorsque vous ajoutez plusieurs messages aux options, l’ordre dans la collection de messages est le suivant :

Le premier message (s’il y en a un) provient de options.Query, précédé du message contenant : “Vous êtes un assistant utile.”, et le rôle est “système”.
Ensuite (s’il y en a) des messages de la collection options.Messages sont ajoutés.
Les messages provenant de sources de fichiers (s’il y en a) sont ajoutés en dernier, un objet 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é

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é

Query

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

public string Query { get; set; }

Valeur de la propriété

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 concentrée et déterministe. La valeur par défaut est 1.

public double Temperature { get; set; }

Valeur de la propriété

Namespace: Documentize Assembly: Documentize.dll

Class CompressOptions

Information

Représente les options de compression pour le plugin Documentize.PdfManager.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← CompressOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

CompressOptions()

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

public CompressOptions()

Namespace: Documentize Assembly: Documentize.dll

Class DecryptionOptions

Information

Représente les options de déchiffrement pour le plugin Documentize.Security.

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← DecryptionOptions

Implémente

IPluginOptions

Membres hérités

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é

Namespace: Documentize Assembly: Documentize.dll

Class DecryptOptions

Information

Représente les options de décryptage pour le plugin Documentize.PdfSecurity.

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← DecryptOptions

Implemente

IPluginOptions

Membres hérités

Constructeurs

DecryptOptions(string)

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

public DecryptOptions(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é

Namespace: Documentize Assembly: Documentize.dll

Class DirectoryDataSource

Information

Représente les données de répertoire pour les opérations de chargement et de sauvegarde d’un plugin.

public sealed class DirectoryDataSource : IDataSource

Héritage

object ← DirectoryDataSource

Implémente

IDataSource

Membres hérités

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é

Path

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

public string Path { get; }

Valeur de la propriété

Namespace: Documentize Assembly: Documentize.dll

Class DocConverter

Information

Représente le plugin Documentize.DocConverter. Utilisé pour convertir des documents PDF en format DOC/DOCX.

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

Héritage

object ← DocConverter

Membres hérités

Méthodes

Process(PdfToDocOptions)

Convertit le 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.

Renvoie

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class EncryptionOptions

Information

Représente les options de cryptage pour le plugin Documentize.Security.

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← EncryptionOptions

Implémente

IPluginOptions

Membres hérités

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é

UserPassword

Mot de passe de l’utilisateur.

public string UserPassword { get; set; }

Valeur de la propriété

Namespace: Documentize Assembly: Documentize.dll

Class EncryptOptions

Information

Représente les options de cryptage pour le plugin Documentize.PdfSecurity.

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← EncryptOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

EncryptOptions(string, string)

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

public EncryptOptions(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 propriété

UserPassword

Mot de passe de l’utilisateur.

public string UserPassword { get; set; }

Valeur de propriété

Espace de noms : Documentize Assembly : Documentize.dll

Class ExtractFormDataToDsvOptions

Information

Représente les options d’exportation des valeurs des champs pour les plugins Documentize.PdfForm et Documentize.PdfExtractor.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implémentations

IPluginOptions

Membres hérités

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 : 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é

Delimeter

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

public char Delimeter { get; set; }

Valeur de la propriété

char

Espace de noms : Documentize Assemblage : Documentize.dll

Class ExtractImagesOptions

Information

Représente les options d’extraction d’images pour le plugin Documentize.PdfExtractor.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ExtractImagesOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

ExtractImagesOptions()

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

public ExtractImagesOptions()

Namespace: Documentize Assembly: Documentize.dll

Class ExtractTextOptions

Information

Représente les options d’extraction de texte pour le plugin Documentize.PdfExtractor.

public sealed class ExtractTextOptions

Héritage

object ← ExtractTextOptions

Membres hérités

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é

Méthodes

AddInput(IDataSource)

Ajoute de nouvelles données à Inputs.

public void AddInput(IDataSource dataSource)

Paramètres

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

Namespace: Documentize Assembly: Documentize.dll

Class FileDataSource

Information

Représente les données de fichier pour les opérations de chargement et de sauvegarde d’un plugin.

public sealed class FileDataSource : IDataSource

Héritage

object ← FileDataSource

Implémente

IDataSource

Membres hérités

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é

Path

Obtient le chemin du fichier des données actuelles.

public string Path { get; }

Valeur de la propriété

Namespace: Documentize Assembly: Documentize.dll

Class FileResult

Information

Représente le résultat d’une opération sous la forme d’un chemin de fichier en chaîne.

public sealed class FileResult : IOperationResult

Héritage

object ← FileResult

Implémente

IOperationResult

Membres hérités

Propriétés

Data

Obtient les données brutes.

public object Data { get; }

Valeur de la propriété

IsFile

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

public bool IsFile { get; }

Valeur de la propriété

IsStream

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

public bool IsStream { get; }

Valeur de la propriété

IsString

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

public bool IsString { get; }

Valeur de la propriété

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.

Namespace: Documentize Assembly: Documentize.dll

Class FlattenFieldsOptions

Information

Représente les options pour aplatir les champs dans un document via le plugin Documentize.PdfForm.

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FlattenFieldsOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Propriétés

SkipFields

La liste des champs qui ne seront pas aplatis.

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

Valeur de la propriété

Espace de noms : Documentize Assemblage : Documentize.dll

Class FormExporter

Information

Représente le plugin Documentize.FormExporter. Utilisé pour exporter les valeurs de formulaire des documents PDF au format DSV ou CSV.

[Obsolete("The class will be deleted soon. Please use PdfExtractor or PdfForm class.")]
public static class FormExporter

Héritage

object ← FormExporter

Membres hérités

Méthodes

Process(ExtractFormDataToDsvOptions)

Démarre le traitement 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.

Retour

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

Exceptions

Si options n’est pas défini.

Espace de noms : Documentize Assemblage : Documentize.dll

Class FormExportToDsvOptions

Information

Représente les options pour l’exportation des valeurs des champs pour le plugin Documentize.FormExporter.

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FormExportToDsvOptions

Implémente

IPluginOptions

Membres hérités

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é

Delimeter

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

public char Delimeter { get; set; }

Valeur de la propriété

char

Namespace : Documentize Assembly : Documentize.dll

Class FormFlattener

Information

Représente le plugin Documentize.FormFlattener. Utilisé pour aplatir les champs dans les documents PDF.

[Obsolete("The class will be deleted soon. Please use PdfForm class.")]
public static class FormFlattener

Héritage

object ← FormFlattener

Membres hérités

Exemples

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

// Create FormFlattenerOptions object to set instructions
var options = new FormFlattenerOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
FormFlattener.Process(options);

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

// Get Fields Names
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Create FormFlattenerOptions object to set 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"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
FormFlattener.Process(options);

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

// Get Fields Names
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Méthodes

GetFieldNames(string)

Obtient les noms de champs dans le document PDF.

public static List<string> GetFieldNames(string path)

Paramètres

path string: Le chemin du document PDF.

Retour

Liste des noms dans le document PDF.

GetFieldNames(Stream) : Obtient les noms de champs dans le document PDF.

public static List<string> GetFieldNames(Stream stream)

Paramètres

stream Stream: Le flux contenant le document PDF.

Retour

Liste des noms dans le document PDF.

Process(FlattenFieldsOptions) : Aplatisse les champs du formulaire dans le document PDF.

public static ResultContainer Process(FlattenFieldsOptions options)

Paramètres

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

Retour

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

Exceptions

Si les options ne sont pas définies.

Espace de noms: Documentize Assemblage: Documentize.dll

Class FormFlattenerOptions

Information

Représente les options pour aplanir les champs dans le document par le plugin Documentize.FormFlattener.

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FormFlattenerOptions

Implémente

IPluginOptions

Membres hérités

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é

Namespace: Documentize Assembly: Documentize.dll

Class GetFieldNamesOptions

Information

Représente les options pour Get Field Names dans le document par le plugin Documentize.PdfForm.

public class GetFieldNamesOptions

Héritage

object ← GetFieldNamesOptions

Membres hérités

Constructeurs

GetFieldNamesOptions(string)

Constructeur pour les options avec le chemin d’accès au fichier.

public GetFieldNamesOptions(string path)

Paramètres

path string : Chemin d’accès au fichier d’entrée.

GetFieldNamesOptions(Stream)

Constructeur pour les options avec le flux d’entrée.

public GetFieldNamesOptions(Stream stream)

Paramètres

stream Stream : Flux d’entrée.

Espace de noms : Documentize Assemblage : Documentize.dll

Class HtmlConverter

Information

Représente le plugin Documentize.HtmlConverter. Utilisé pour convertir des documents PDF en format HTML et des documents HTML en format PDF.

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

Héritage

object ← HtmlConverter

Membres hérités

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.

Retourne

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

Exceptions

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.

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

Information

Représente les options du convertisseur HTML en PDF pour le plugin Documentize.PdfConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← HtmlToPdfOptions

Implemente

IPluginOptions

Membres hérités

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

HtmlMediaType

Obtient ou définit les types de média possibles utilisés pendant le rendu.

public HtmlMediaType HtmlMediaType { get; set; }

Valeur de propriété

HtmlMediaType

IsRenderToSinglePage

Obtient ou définit le rendu de l’intégralité du document sur une seule page.

public bool IsRenderToSinglePage { get; set; }

Valeur de propriété

PageInfo

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

public PageInfo PageInfo { get; set; }

Valeur de propriété

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Valeur de propriété

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

Information

Représente le plugin Documentize.ImageExtractor. Utilisé pour extraire des images des documents PDF.

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

Héritage

object ← ImageExtractor

Membres hérités

Méthodes

Process(ExtractImagesOptions)

Extraire des images d’un document PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Paramètres

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

Renvoie

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

Exceptions

Si les options ne sont pas définies.

Espace de noms : Documentize Assembly : Documentize.dll

Class ImageExtractorOptions

Information

Représente les options d’extraction d’images pour le plugin Documentize.ImageExtractor.

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ImageExtractorOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

ImageExtractorOptions()

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

public ImageExtractorOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Info

Information

Cette classe fournit des informations sur la version actuelle du produit.

public static class Info

Héritage

object ← Info

Membres hérités

Champs

AssemblyVersion Version de l’assembly.

Valeur du champ

Produit

Nom du produit.

public const string Product = "Documentize"

Valeur du champ

Namespace: Documentize Assembly: Documentize.dll

Class JpegConverter

Information

Représente le plugin Documentize.JpegConverter. Utilisé pour convertir des documents PDF au format JPEG.

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

Héritage

object ← JpegConverter

Membres hérités

Méthodes

Process(PdfToJpegOptions)

Convertit un document PDF au 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

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

Information

Représente les options de fusion pour le plugin Documentize.PdfManager.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← MergeOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

MergeOptions()

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

public MergeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Merger

Information

Représente le plugin Documentize.Merger. Utilisé pour fusionner plusieurs documents PDF en un seul PDF.

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

Héritage

object ← Merger

Membres hérités

Méthodes

Process(MergeOptions)

Fusionner des documents PDF.

public static ResultContainer Process(MergeOptions options)

Paramètres

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

Retours

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class Message

Information

Un message de complétion de chat généré par le modèle.

public class Message

Héritage

object ← Message

Membres Hérités

Constructeurs

Message()

public Message()

Propriétés

Contenu

Le contenu du message.

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

Valeur de la Propriété

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

Namespace : Documentize Assembly : Documentize.dll

Class ObjectResult

Information

Représente le résultat d’une opération sous la forme d’une chaîne.

public sealed class ObjectResult : IOperationResult

Héritage

object ← ObjectResult

Implémente

IOperationResult

Membres hérités

Propriétés

Data

Obtient des données brutes.

public object Data { get; }

Valeur de la propriété

IsFile

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

public bool IsFile { get; }

Valeur de la propriété

IsObject

Indique si le résultat est un objet.

public bool IsObject { get; }

Valeur de la propriété

IsStream

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

public bool IsStream { get; }

Valeur de la propriété

IsString

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

public bool IsString { get; }

Valeur de la propriété

Text

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

public string Text { get; }

Valeur de la propriété

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

Namespace: Documentize Assembly: Documentize.dll

Class OptimizeOptions

Information

Représente les options d’optimisation pour le plugin Documentize.PdfManager.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← OptimizeOptions

Implémente

IPluginOptions

Membres hérités

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

Namespace: Documentize Assembly: Documentize.dll

Class Optimizer

Information

Représente le plugin Documentize.Optimizer. Utilisé pour optimiser, faire pivot, redimensionner, compresser des documents PDF.

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

Héritage

object ← Optimizer

Membres hérités

Méthodes

Process(OptimizeOptions)

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

public static ResultContainer Process(OptimizeOptions options)

Paramètres

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

Retourne

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

Process(RotateOptions)

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

public static ResultContainer Process(RotateOptions options)

Paramètres

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

Retourne

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

Process(ResizeOptions)

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

public static ResultContainer Process(ResizeOptions options)

Paramètres

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

Retourne

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

Process(CompressOptions)

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

public static ResultContainer Process(CompressOptions options)

Paramètres

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

Retourne

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

Namespace: Documentize Assembly: Documentize.dll

Class PageInfo

Information

Représente les informations de la page.

public class PageInfo : PageSize

Héritage

object ← PageSize ← PageInfo

Membres hérités

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é

MarginLeft

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

public double MarginLeft { get; set; }

Valeur de propriété

MarginRight

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

public double MarginRight { get; set; }

Valeur de propriété

MarginTop

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

public double MarginTop { get; set; }

Valeur de propriété

Espace de noms : Documentize Assembly : Documentize.dll

Class PageSize

Information

Classe représentant la taille de la page dans un document PDF.

public class PageSize

Héritage

object ← PageSize

Dérivé

PageInfo

Membres hérités

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é

A1

Taille A1 (840x594 mm).

public static PageSize A1 { get; }

Valeur de la propriété

A2

Taille A2 (594x420 mm).

public static PageSize A2 { get; }

Valeur de la propriété

A3

Taille A3 (420x297 mm).

public static PageSize A3 { get; }

Valeur de la propriété

A4

Taille A4 (297x210 mm).

public static PageSize A4 { get; }

Valeur de la propriété

A5

Taille A5 (210x148 mm).

public static PageSize A5 { get; }

Valeur de la propriété

A6

Taille A6 (148x105 mm).

public static PageSize A6 { get; }

Valeur de la propriété

B5

Taille B5 (250x176 mm).

public static PageSize B5 { get; }

Valeur de la propriété

Height

Obtient ou définit la hauteur de la page.

public double Height { get; set; }

Valeur de la propriété

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é

P11x17

Format 11x17 pouces.

public static PageSize P11x17 { get; }

Valeur de la propriété

PageLedger

Taille Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valeur de la propriété

PageLegal

Taille Légal (356x216 mm).

public static PageSize PageLegal { get; }

Valeur de la propriété

PageLetter

Taille Lettre (279x216 mm).

public static PageSize PageLetter { get; }

Valeur de la propriété

Width

Obtient ou définit la largeur de la page.

public double Width { get; set; }

Valeur de la propriété

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

Information

Représente un plugin pour gérer la conversion de documents PDF au format PDF/A et pour la validation de la conformité au PDF/A.

[Obsolete("La classe sera supprimée prochainement. Veuillez utiliser la classe PdfConverter.")]
public static class PdfAConverter

Héritage

object ← PdfAConverter

Membres hérités

Méthodes

Process(PdfToPdfAOptions)

Convertit un document PDF en format PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Process(PdfAValidateOptions)

Vérifie la conformité du document PDF avec le format PDF/A spécifié.

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

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConvertOptions

Information

Représente les options de conversion des documents PDF au format PDF/A avec le plugin Documentize.PdfAConverter.

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAConvertOptions

Implémente

IPluginOptions

Membres hérités

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é

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

Information

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é

Implémente

IPluginOptions

Membres hérités

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 lors du processus de conversion PDF/A.

public bool AlignText { get; set; }

Valeur de propriété

Remarques

Lorsqu’il est défini sur true, le processus de conversion tentera de restaurer les limites du segment de texte original. Pour la plupart des documents, il n’est pas nécessaire de changer cette propriété de 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 propriété

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Valeur de 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 propriété

Inputs

Obtient une collection de sources de données

public List<idatasource> Inputs { get; }

Valeur de propriété

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Valeur de propriété

LogOutputSource

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

public IDataSource LogOutputSource { get; set; }

Valeur de propriété

IDataSource

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Valeur de propriété

Remarques

Lorsqu’il est défini sur true, le processus de conversion tentera de minimiser la taille du fichier résultant. Cela pourrait affecter les performances 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 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 à la version standard PDF/A-1b.

SoftMaskAction

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

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Valeur de 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:

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidateOptions

Information

Représente les options pour valider la conformité PDF/A des documents PDF avec le plugin Documentize.PdfConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAValidateOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidationResult

Information

Représente le résultat d’un processus de validation PDF/A.

public sealed class PdfAValidationResult

Héritage

object ← PdfAValidationResult

Membres hérités

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

ArgumentException : InvalidOperationException

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Valeur du champ

PdfAStandardVersion

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGpt

Information

Représente le plugin PdfChatGpt.

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

Héritage

object ← PdfChatGpt

Membres hérités

Remarques

Le Documentize.PdfChatGpt est utilisé pour envoyer des requêtes à 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 plutôt la méthode ProcessAsync.

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)

Démarre 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

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

Information

Représente les options pour le plugin Documentize.PdfChatGpt.

public class PdfChatGptOptions : IPluginOptions

Membres Hérités

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é

Outputs

public List<idatasource> Outputs { get; }

Valeur de la Propriété

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptRequestOptions

Information

Représente les options pour le plugin Documentize.PdfChatGpt.

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Héritage

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implémente

IPluginOptions

Membres hérités

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é

ApiUrl

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

public string ApiUrl { get; set; }

Valeur de la propriété

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é

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é

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é

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é

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverter

Information

Représente le plugin Documentize.PdfConverter. Utilisé pour convertir des documents PDF vers d’autres formats tels que DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Permet également d’effectuer une validation PDF/A et de convertir du HTML en PDF.

Represents Documentize.PdfConverter plugin. Used to Convert PDF documents to another formats like DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Also allows you to perform PDF/A Validation and Convert HTML to PDF.

public static class PdfConverter

Inheritance

object ← PdfConverter

Inherited Members

Examples

The example demonstrates how to convert PDF document to Doc format.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Set output file path
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document to Doc format with setting Mode.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Set output file path
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
 // Set Mode
options.Mode = DocConversionMode.Flow;
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF to XLSX document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Set output file path
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xlsx"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF to XLS document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Specify XLS format
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
 // Set output file path
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xls"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF to HTML document.

// Create PdfToHtmlOptions object to set output data type as file with embedded resources
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Add input file path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Set output file path
options.AddOutput(new FileDataSource("path_to_output.html"));
 //Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert HTML to PDF document.

// Create HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_input.html"));
 // Set output file path
options.AddOutput(new FileDataSource("path_to_output.pdf"));
 //Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into JPEG format.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into JPEG format with settings for pages, resolution, quality.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Process only the first page
options.PageList = [1];
 // Set output resolution to 200 DPI
options.OutputResolution = 200;
 // Set output quality to 50
options.Quality = 50;
 // Add input File path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into JPEG format to streams.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

The example demonstrates how to convert PDF document into PNG format.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert 1 page of PDF document into PNG format.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions()
// Process only the first page
options.PageList = [1];
 // Set output resolution to 200 DPI
options.OutputResolution = 200;
 // Add input File path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into PNG format to streams.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

The example demonstrates how to convert PDF document into TIFF format.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF format with Customizing Pages and DPI.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Set Pages
options.PageList = [1, 3];
 // Set result image Resolution
options.OutputResolution = 400;
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF as Multi-Page.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Enable Multi-Page TIFF output
options.MultiPage = true;
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF format with Customizing Compression and ColorDepth.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
 // Set Compression and ColorDepth
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF format to streams.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input File path
options.AddInput(new FileDataSource("path_to_input.pdf"));
 // Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

The example demonstrates how to convert the PDF document in a PDF/A format (PDF/A-3b in this case):

// Create the options class to set up the conversion process
var options = new PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Add the source file
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // replace with your actual file path

// Add the path to save the converted file
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Run the conversion
PdfConverter.Convert(options);

The example demonstrates how to validate the PDF document conformance to PDF/A format (PDF/A-1a in this case):

// Create the options class to set up the validation process
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Add one or more files to be validated
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // replace with your actual file path
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// add more files as needed

// Run the validation and get results
var resultContainer = PdfConverter.Validate(options);

// Check the resultContainer.ResultCollection property for validation results for each file:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for the i-th document
}

Methods

Convert(PdfToDocOptions)

Converts PDF document into DOC/DOCX formats.

public static ResultContainer Convert(PdfToDocOptions options)

Parameters

options PdfToDocOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToXlsOptions)

Converts PDF document into XLSX/XLS/CSV/XLSM/ODS formats.

public static ResultContainer Convert(PdfToXlsOptions options)

Parameters

options PdfToXlsOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToHtmlOptions)

Converts PDF document into HTML format.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parameters

options PdfToHtmlOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(HtmlToPdfOptions)

Converts HTML document into PDF format.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parameters

options HtmlToPdfOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToJpegOptions)

Converts PDF document into JPEG format.

public static ResultContainer Convert(PdfToJpegOptions options)

Parameters

options PdfToJpegOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToPngOptions)

Converts PDF document into PNG format.

public static ResultContainer Convert(PdfToPngOptions options)

Parameters

options PdfToPngOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToTiffOptions)

Converts PDF document into TIFF format.

public static ResultContainer Convert(PdfToTiffOptions options)

Parameters

options PdfToTiffOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToPdfAOptions)

Converts PDF document into PDF/A format.

public static ResultContainer Convert(PdfToPdfAOptions options)

Parameters

options PdfToPdfAOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Validate(PdfAValidateOptions)

Check PDF document for compliance with specified format PDF/A.

public static ResultContainer Validate(PdfAValidateOptions options)

Parameters

options PdfAValidateOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverterOptions

Information

Représente les options pour les plugins de conversion PDF.

public abstract class PdfConverterOptions : IPluginOptions

Héritage

object ← PdfConverterOptions

Dérivé

PdfToXlsOptions

Implémente

IPluginOptions

Membres hérités

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfExtractor

Information

Représente le plugin Documentize.PdfExtractor. Utilisé pour extraire du texte, des images, des données de formulaire à partir de documents PDF.

public static class PdfExtractor

Inheritance

object ← PdfExtractor

Inherited Members

Methods

Extract(ExtractTextOptions)

Extrait le texte d’un document PDF.

public static ResultContainer Extract(ExtractTextOptions options)

Parameters

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

Returns

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

Examples

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

// Create ExtractTextOptions object to set instructions
var options = new ExtractTextOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get the extracted text from the ResultContainer object
var textExtracted = results.ResultCollection[0].ToString();

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

// Create ExtractTextOptions object to set TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get the extracted text from the ResultContainer object
var textExtracted = results.ResultCollection[0].ToString();

Exceptions

Si options n’est pas défini.

Extract(ExtractImagesOptions)

Extrait les images d’un document PDF.

public static ResultContainer Extract(ExtractImagesOptions options)

Parameters

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

Returns

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

Examples

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

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get path to image result
var imageExtracted = results.ResultCollection[0].ToFile();

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

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Not set output - it will write results to streams
// Perform the process
var results = PdfExtractor.Extract(options);
// Get Stream
var ms = results.ResultCollection[0].ToStream();
// Copy data to file for demo
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Exceptions

Si options n’est pas défini.

Extract(ExtractFormDataToDsvOptions)

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

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

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

Returns

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

Examples

L’exemple montre comment exporter les valeurs du formulaire vers un fichier CSV.

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

Exceptions

Si options n’est pas défini.

Namespace: Documentize Assembly: Documentize.dll

Class PdfForm

Information

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

public static class PdfForm

Inheritance

object ← PdfForm

Inherited Members

Methods

Extract(ExtractFormDataToDsvOptions)

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

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

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

Returns

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

Examples

L’exemple montre comment exporter les valeurs du formulaire vers un fichier CSV.

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

Exceptions

Si les options ne sont pas définies.

Flatten(FlattenFieldsOptions)

Aplati les champs d’un document PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parameters

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

Returns

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

Examples

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

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

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

// Get Fields Names
var fieldNames = PdfForm.GetFieldNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Create FormFlattenerOptions object to set 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"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
PdfForm.Flatten(options);

Exceptions

Si les options ne sont pas définies.

GetNames(GetFieldNamesOptions)

Récupère les noms des champs dans un document PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Parameters

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

Returns

Liste des noms dans le document PDF.

Examples

L’exemple montre comment récupérer les noms des champs d’un fichier PDF.

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

Remove(RemoveFieldsOptions) : Supprime des champs d’un document PDF.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parameters

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

Returns

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

Examples

L’exemple montre comment supprimer des champs d’un fichier PDF.

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

Information

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 séparées. 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 à un document PDF.

public static class PdfManager

Inheritance

object ← PdfManager

Inherited Members

Examples

The example demonstrates how to Merge two PDF documents.

// Create MergeOptions object to set instructions
var options = new MergeOptions();
// Add input file paths
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Merge(options);

The example demonstrates how to Split PDF document.

// Create SplitOptions object to set instructions
var options = new SplitOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file paths
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// Perform the process
PdfManager.Split(options);

The example demonstrates how to Optimize PDF document.

// Create OptimizeOptions object to set instructions
var options = new OptimizeOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Optimize(options);

The example demonstrates how to Rotate PDF document.

// Create RotateOptions object to set instructions
var options = new RotateOptions();
// Set new Rotation
options.Rotation = Rotation.On90;
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Rotate(options);

The example demonstrates how to Resize PDF document.

// Create ResizeOptions object to set instructions
var options = new ResizeOptions();
// Set new PageSize
options.PageSize = PageSize.A3;
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Resize(options);

The example demonstrates how to Compress PDF document.

// Create CompressOptions object to set instructions
var options = new CompressOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Compress(options);

The example demonstrates how to Add Table to PDF file.

// Configure table options
var options = new TableOptions();
options.InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .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");
// Add input file path
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

The example demonstrates how to add Table of Contents to PDF file.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);

The example demonstrates how to add Table of Contents to PDF file with generating bookmarks.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Generate links in bookmarks
options.GenerateBookmarks = true;
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);

The example demonstrates how to add Table of Contents to PDF file and save as stream.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Perform the process
PdfManager.AddTableOfContents(options);

The example demonstrates how to use ChatGpt by adding messages to the request.

var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request messages.
options.Messages.Add(new Message
{
    Content = "You are a helpful assistant.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "What is the biggest pizza diameter ever made?",
    Role = Role.User
});

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.

The example demonstrates how to use ChatGpt by adding one message to the request.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf")); // Add the output file path.
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "What is the lowest temperature recorded on the Earth?";

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.

The example demonstrates how to use Chat by adding file(s) as the message source(s).

var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));

// Add the PDF text source.
// In case of multiple sources, the text from each document will be added to the request message collection
// as a separate message with the role "user".
options.AddInput(new FileDataSource("TextSource.pdf"));

options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "How many letters in the provided text?";

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.

Methods

AddTable(TableOptions)

Add Table to PDF document.

public static ResultContainer AddTable(TableOptions options)

Parameters

options TableOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

AddTableOfContents(TocOptions)

Add Table of Contents (TOC) to PDF document.

public static ResultContainer AddTableOfContents(TocOptions options)

Parameters

options TocOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Compress(CompressOptions)

Compress PDF document. Try to reduce size of the document.

public static ResultContainer Compress(CompressOptions options)

Parameters

options CompressOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Create PDF document by Reply of ChatGpt. Used to send requests to ChatGPT directly or by adding PDF file sources and save the reply to the output source.

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Parameters

options ChatGptRequestOptions: An options object containing instructions for the operation.

Returns

Task<ResultContainer>

An object containing the result of the operation.

Exceptions

ArgumentException : If options not set.

Merge(MergeOptions)

Merge PDF documents.

public static ResultContainer Merge(MergeOptions options)

Parameters

options MergeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Optimize(OptimizeOptions)

Optimize PDF document. Linearize the document in order to

open the first page as quickly as possible;
display next page or follow by link to the next page as quickly as possible;
display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first);
permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed.

public static ResultContainer Optimize(OptimizeOptions options)

Parameters

options OptimizeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Resize(ResizeOptions)

Resize Pages of PDF document.

public static ResultContainer Resize(ResizeOptions options)

Parameters

options ResizeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Rotate(RotateOptions)

Rotate Pages of PDF document.

public static ResultContainer Rotate(RotateOptions options)

Parameters

options RotateOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Split(SplitOptions)

Split PDF document by pages.

public static ResultContainer Split(SplitOptions options)

Parameters

options SplitOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Namespace: Documentize Assembly: Documentize.dll

Class PdfSecurity

Information

Représente le plugin Documentize.PdfSecurity. Utilisé pour crypter, décrypter et signer des documents PDF.

public static class PdfSecurity

Héritage

object ← PdfSecurity

Membres hérités

Méthodes

Decrypt(DecryptOptions)

Décrypte le document PDF.

public static ResultContainer Decrypt(DecryptOptions options)

Paramètres

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

Retourne

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

Exemples

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

// Créer un objet DecryptOptions pour définir les instructions
var options = new DecryptOptions("123456");
// 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"));
// Exécuter le processus
PdfSecurity.Decrypt(options);

Exceptions

Si les options ne sont pas définies.

Encrypt(EncryptOptions)

Crypte le document PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Paramètres

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

Retourne

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

Exemples

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

// Créer un objet EncryptOptions pour définir les instructions
var options = new EncryptOptions("123456", "qwerty");
// 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"));
// Exécuter le processus
PdfSecurity.Encrypt(options);

Exceptions

Si les options ne sont pas définies.

Sign(SignOptions)

Signe le document PDF par une signature numérique.

public static ResultContainer Sign(SignOptions options)

Paramètres

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

Retourne

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

Exemples

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

// Créer un objet SignOptions pour définir les instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 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"));
// Exécuter le processus
PdfSecurity.Sign(options);

L’exemple démontre comment signer un document PDF avec un flux de fichier PFX.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Exécuter le processus
PdfSecurity.Sign(options);

L’exemple démontre comment signer un document PDF avec une signature invisible.

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Configurer la signature invisible
signOptions.Visible = false;
// Exécuter le processus
PdfSecurity.Sign(options);

L’exemple démontre comment signer un document PDF avec des options supplémentaires.

// Créer un objet SignOptions pour définir les instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 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"));
// Paramètres optionnels
options.Reason = "ma Raison";
options.Contact = "mon Contact";
options.Location = "ma Localisation";
options.PageNumber = 3;
// Exécuter le processus
PdfSecurity.Sign(options);

L’exemple démontre comment signer un document PDF avec un horodatage.

// Créer un objet SignOptions pour définir les instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// 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"));
// Exécuter le processus
PdfSecurity.Sign(options);

Exceptions

PdfToHtmlOptions.SaveDataType

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

Information

Représente les options de convertisseur PDF en DOC pour le plugin Documentize.PdfConverter.

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToDocOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToDocOptions()

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

public PdfToDocOptions()

Properties

Mode

Permet de contrôler comment un document PDF est converti en document de traitement de texte.

public DocConversionMode Mode { get; set; }

Property Value

DocConversionMode

Remarks

Utilisez le mode Documentize.DocConversionMode.TextBox lorsque le document résultant ne va pas être fortement modifié par la suite. Les zones de texte sont faciles à modifier lorsqu'il n'y a pas beaucoup à faire.

Utilisez le mode Documentize.DocConversionMode.Flow lorsque le document de sortie nécessite des modifications supplémentaires. Les paragraphes et les lignes de texte en mode flux permettent une modification facile du texte, mais les objets de formatage non pris en charge auront l'air pire que dans le mode Documentize.DocConversionMode.TextBox.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToHtmlOptions

Information

Représente les options de convertisseur PDF en HTML pour le plugin Documentize.PdfConverter.

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToHtmlOptions

Implants

IPluginOptions

Membres hérités

Constructeurs

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 = SaveDataType.FileWithExternalResources)

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é

Namespace: Documentize Assembly: Documentize.dll

Class PdfToJpegOptions

Information

Représente les options du convertisseur PDF en JPEG pour le plugin Documentize.PdfConverter.

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToJpegOptions

Implémente

IPluginOptions

Membres hérités

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é

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. Spécifie le niveau de compression pour une image. La plage de valeurs utiles pour la qualité est de 0 à 100. Plus le nombre spécifié est bas, plus la compression est élevée et donc plus la qualité de l’image est basse. Zéro vous donnerait l’image de la plus basse qualité et 100 la plus haute.

public int Quality { get; set; }

Valeur de propriété

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPdfAOptions

Information

Représente les options pour convertir des documents PDF au format PDF/A avec le plugin Documentize.PdfConverter.

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfToPdfAOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToPdfAOptions()

public PdfToPdfAOptions()

Properties

Outputs

Obtient la collection des cibles ajoutées (sources de données de fichiers ou de flux) pour les résultats des opérations de sauvegarde.

public List<idatasource> Outputs { get; }

Property Value

Methods

AddOutput(IDataSource)

Ajoute une nouvelle cible de sauvegarde pour le résultat.

public void AddOutput(IDataSource dataSource)

Parameters

dataSource IDataSource: Cible (source de données de fichier ou de flux) pour la sauvegarde des résultats des opérations. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPngOptions

Information

Représente les options de convertisseur PDF en PNG pour le plugin Documentize.PdfConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToPngOptions

Implémente

IPluginOptions

Membres hérités

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é

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>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToTiffOptions

Information

Représente les options de convertisseur PDF en TIFF pour le plugin Documentize.PdfConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToTiffOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

PdfToTiffOptions()

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

public PdfToTiffOptions()

Propriétés

ColorDepth

Obtient ou définit la profondeur de couleur.

public TiffColorDepth ColorDepth { get; set; }

Valeur de la propriété

TiffColorDepth

Remarques

La valeur par défaut est Documentize.TiffColorDepth.Format32bpp.

Compression

Obtient ou définit le type de compression.

public TiffCompression Compression { get; set; }

Valeur de la propriété

TiffCompression

Remarques

La valeur par défaut est Documentize.TiffCompression.LZW.

MultiPage

Obtient et définit un indicateur qui permet de sauvegarder toutes les pages dans un TIFF multi-pages. La valeur par défaut est false.

public bool MultiPage { get; set; }

Valeur de la propriété

OutputResolution

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

public int OutputResolution { get; set; }

Valeur de la propriété

PdfToXlsOptions.ExcelFormat

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>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

Information

Représente les options du convertisseur PDF vers XLS/XLSX pour le plugin Documentize.PdfConverter.

public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions

Héritage

object ←
PluginBaseOptions ←
PdfToXlsOptions

Implémente

IPluginOptions

Membres hérités

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é

InsertBlankColumnAtFirst

Définissez sur 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 qu’aucune colonne vide ne sera insérée.

public bool InsertBlankColumnAtFirst { get; set; }

Valeur de la propriété

MinimizeTheNumberOfWorksheets

Définissez sur true si vous devez réduire le nombre de feuilles de calcul dans le classeur résultant.
La valeur par défaut est false ; cela signifie que chaque page PDF sera enregistrée comme feuille séparée.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Valeur de la propriété

Espace de noms : Documentize
Assemblage : Documentize.dll

Class PluginBaseOptions

Information

Représente les options de base pour les plugins.

public class PluginBaseOptions : IPluginOptions

Héritage

object ← PluginBaseOptions

Dérivés

Implémente

IPluginOptions

Membres hérités

Propriétés

CloseInputStreams

Ferme les flux d’entrée après que l’opération soit terminée.

public bool CloseInputStreams { get; set; }

Valeur de la propriété

CloseOutputStreams

Ferme les flux de sortie après que l’opération soit terminée.

public bool CloseOutputStreams { get; set; }

Valeur de la propriété

Inputs

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

public List<idatasource> Inputs { get; }

Valeur de la propriété

Outputs

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

public List<idatasource> Outputs { get; }

Valeur de la propriété

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

Namespace: Documentize Assembly: Documentize.dll

Class PngConverter

Information

Représente le plugin Documentize.PngConverter. Utilisé pour convertir des documents PDF au format PNG.

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

Héritage

object ← PngConverter

Membres hérités

Méthodes

Process(PdfToPngOptions)

Convertit un document PDF au format PNG.

public static ResultContainer Process(PdfToPngOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

Information

La classe représente un rectangle.

public class Rectangle

Héritage

object ← Rectangle

Membres hérités

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.

Namespace: Documentize Assembly: Documentize.dll

Class RemoveFieldsOptions

Information

Représente les options pour Supprimer des champs dans le document par le plugin Documentize.PdfForm.

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← RemoveFieldsOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

RemoveFieldsOptions()

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

public RemoveFieldsOptions()

Namespace: Documentize Assembly: Documentize.dll

Class ResizeOptions

Information

Représente les options de redimensionnement pour le plugin Documentize.PdfManager.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ResizeOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

ResizeOptions()

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

public ResizeOptions()

Propriétés

PageSize

Obtient ou définit la nouvelle taille de page.

public PageSize PageSize { get; set; }

Valeur de propriété

Namespace: Documentize Assembly: Documentize.dll

Class ResultContainer

Information

Représente un conteneur qui contient la collection des résultats du traitement du plugin.

public class ResultContainer

Héritage

object ← ResultContainer

Membres hérités

Propriétés

ResultCollection

Obtient la collection des résultats d’opération

public List<ioperationresult> ResultCollection { get; }

Valeur de la propriété

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Class RotateOptions

Information

Représente les options de rotation pour le plugin Documentize.PdfManager.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← RotateOptions

Implemente

IPluginOptions

Membres hérités

Constructeurs

RotateOptions()

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

public RotateOptions()

Propriétés

Rotation

Obtient ou définit la rotation des nouvelles pages.

public Rotation Rotation { get; set; }

Valeur de propriété

Rotation

Namespace: Documentize Assembly: Documentize.dll

Class Security

Information

Représente le plugin Documentize.Security. Utilisé pour chiffrer et déchiffrer les documents PDF.

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

Héritage

object ← Security

Membres hérités

Méthodes

Process(EncryptOptions)

Chiffrer le document PDF.

public static ResultContainer Process(EncryptOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Process(DecryptOptions)

Déchiffrer le document PDF.

public static ResultContainer Process(DecryptOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

Information

Représente les options de signature pour le plugin Documentize.PdfSecurity.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← SignOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

SignOptions(string, string)

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

public SignOptions(string pfx, string password)

Paramètres

pfx string: Le chemin du fichier pfx.
password string: Le mot de passe du fichier pfx.

SignOptions(Stream, string)

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

public SignOptions(Stream pfx, string password)

Paramètres

pfx Stream: Le flux avec le fichier pfx.
password string: Le mot de passe du fichier pfx.

Propriétés

Contact

Le contact de la signature.

public string Contact { get; set; }

Valeur de la propriété

Location

L’emplacement de la signature.

public string Location { get; set; }

Valeur de la propriété

Name

Le nom du champ de signature existant. Null pour créer un nouveau champ.

public string Name { get; set; }

Valeur de la propriété

PageNumber

Le numéro de la page sur laquelle la signature est faite.

public int PageNumber { get; set; }

Valeur de la propriété

Reason

La raison de la signature.

public string Reason { get; set; }

Valeur de la propriété

Rectangle

Le rectangle de la signature.

public Rectangle Rectangle { get; set; }

Valeur de la propriété

Rectangle

TimestampOptions

Options de timestamp.

public TimestampOptions TimestampOptions { get; set; }

Valeur de la propriété

TimestampOptions

Visible

La visibilité de la signature.

public bool Visible { get; set; }

Valeur de la propriété

Namespace: Documentize Assembly: Documentize.dll

Class SplitOptions

Information

Représente les options de séparation pour le plugin Documentize.PdfManager.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← SplitOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

SplitOptions()

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

public SplitOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Splitter

Information

Représente le plugin Documentize.Splitter. Utilisé pour diviser les documents PDF en pages séparées.

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

Héritage

object ← Splitter

Membres hérités

Méthodes

Process(SplitOptions)

Divise le document PDF par pages.

public static ResultContainer Process(SplitOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class StreamDataSource

Information

Représente la source de données de flux pour les opérations de chargement et de sauvegarde d’un plugin.

public sealed class StreamDataSource : IDataSource

Héritage

object ← StreamDataSource

Implémente

IDataSource

Membres Hérités

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é

Namespace : Documentize Assembly : Documentize.dll

Class StreamResult

Information

Représente le résultat d’une opération sous la forme d’un Stream.

public sealed class StreamResult : IOperationResult

Héritage

object ← StreamResult

Implémente

IOperationResult

Membres hérités

Propriétés

Data

Obtient les données brutes.

public object Data { get; }

Valeur de la propriété

IsFile

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

public bool IsFile { get; }

Valeur de la propriété

IsStream

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

public bool IsStream { get; }

Valeur de la propriété

IsString

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

public bool IsString { get; }

Valeur de la propriété

Méthodes

ToFile()

Essaye de convertir le résultat en un 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()

Essaye de convertir le résultat en un objet stream.

public Stream ToStream()

Renvoie

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

Namespace: Documentize Assembly: Documentize.dll

Class StringResult

Information

Représente le résultat d’une opération sous forme de chaîne.

public sealed class StringResult : IOperationResult

Héritage

object ← StringResult

Implémente

IOperationResult

Membres hérité

Propriétés

Data

Obtient les données brutes.

public object Data { get; }

Valeur de la Propriété

IsFile

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

public bool IsFile { get; }

Valeur de la Propriété

IsStream

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

public bool IsStream { get; }

Valeur de la Propriété

IsString

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

public bool IsString { get; }

Valeur de la Propriété

Text

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

public string Text { get; }

Valeur de la Propriété

Méthodes

ToFile()

Tente de convertir le résultat en un 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 un 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 une 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().

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Information

La classe représente un constructeur pour un tableau dans une page PDF.

public class TableBuilder

Héritage

object ← TableBuilder

Dérivé

TableRowBuilder

Membres hérités

Méthodes

AddRow()

Ajoute une nouvelle ligne au tableau.

public virtual TableRowBuilder AddRow()

Retourne

TableRowBuilder : Instance de Documentize.TableRowBuilder actuelle.

AddTable()

Ajoute un nouveau tableau au document.

public TableBuilder AddTable()

Retourne

TableBuilder : Instance de Documentize.TableBuilder actuelle.

InsertPageAfter(int)

Insère 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 le tableau.

Retourne

TableOptions : Instance de Documentize.TableOptions actuelle.

InsertPageBefore(int)

Insère 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 le tableau.

Retourne

TableOptions : Instance de Documentize.TableOptions actuelle.

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 Documentize.TableBuilder actuelle.

Retourne

TableOptions : Résultat de la conversion en PdfGeneratorTableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

Information

La classe représente un constructeur pour une cellule de tableau.

public class TableCellBuilder : TableRowBuilder

Héritage

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Membres hérités

Méthodes

AddCell()

Ajouter une cellule au tableau.

public override TableCellBuilder AddCell()

Retourne

TableCellBuilder : Instance du Documentize.TableCellBuilder actuel.

AddParagraph(params string[])

Ajouter des paragraphes à la cellule du tableau.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Paramètres

paragraphs string[]: Texte pour les paragraphes.

Retourne

TableCellBuilder : Instance du Documentize.TableCellBuilder actuel.

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

Information

Représente le plugin Documentize.TableGenerator. Utilisé pour ajouter un tableau à un document PDF.

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

Héritage

object ← TableGenerator

Membres hérités

Exemples

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

// Configurer les options du 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 traitement
TableGenerator.Process(options);

Méthodes

Process(TableOptions)

Ajouter un tableau au document PDF.

public static ResultContainer Process(TableOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

Information

Représente les options pour ajouter une table au document via le plugin Documentize.PdfManager.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← TableOptions

Implémente

IPluginOptions

Membres hérité

Constructeurs

TableOptions()

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

public TableOptions()

Méthodes

AddTable()

Ajout d’une table au document.

public TableBuilder AddTable()

Renvoie

TableBuilder : Nouvelle instance de Documentize.TableBuilder.

Create()

Créer une instance de Documentize.TableOptions.

public static TableOptions Create()

Renvoie

TableOptions : Nouvelle instance de Documentize.TableOptions.

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.

Renvoie

TableOptions : Instance de l’actuelle 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 après laquelle insérer la table.

Renvoie

TableOptions : Instance de l’actuelle Documentize.TableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

Information

La classe représente un constructeur pour une ligne de tableau.

public class TableRowBuilder : TableBuilder

Héritage

object ← TableBuilder ← TableRowBuilder

Dérivé

TableCellBuilder

Membres hérités

Méthodes

AddCell()

Ajoute une cellule à la ligne de tableau.

public virtual TableCellBuilder AddCell()

Retourne

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

AddRow()

Surcharge de AddRow.

public override TableRowBuilder AddRow()

Retourne

TableRowBuilder : Instance actuelle de Documentize.TableRowBuilder.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractor

Information

Représente le plugin Documentize.TextExtractor. Utilisé pour extraire du texte des documents PDF.

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

Héritage

object ← TextExtractor

Membres hérités

Méthodes

Process(ExtractTextOptions)

Extraire le texte du document PDF.

public static ResultContainer Process(ExtractTextOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractorOptions

Information

Représente les options d’extraction de texte pour le plugin Documentize.TextExtractor.

public sealed class TextExtractorOptions

Héritage

object ← TextExtractorOptions

Membres hérités

Constructeurs

TextExtractorOptions(TextFormattingMode)

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

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Paramètres

formattingMode TextFormattingMode : Valeur du mode de formatage de texte.

Propriétés

FormattingMode

Obtient le mode de formatage.

public TextFormattingMode FormattingMode { get; set; }

Valeur de la propriété

TextFormattingMode

Inputs

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

public List<idatasource> Inputs { get; }

Valeur de la propriété

Méthodes

AddInput(IDataSource)

Ajoute de nouvelles données aux Inputs.

public void AddInput(IDataSource dataSource)

Paramètres

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

Namespace : Documentize Assembly : Documentize.dll

Class TiffConverter

Information

Représente le plugin Documentize.TiffConverter. Utilisé pour convertir des documents PDF au format TIFF.

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

Héritage

object ← TiffConverter

Membres hérités

Méthodes

Process(PdfToTiffOptions)

Convertit un document PDF au format TIFF.

public static ResultContainer Process(PdfToTiffOptions options)

Paramètres

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

Renvoie

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class Timestamp

Information

Représente le plugin Documentize.Timestamp. Utilisé pour ajouter un Timestamp à un document.

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

Héritage

object ← Timestamp

Membres hérités

Méthodes

Process(AddTimestampOptions)

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

public static ResultContainer Process(AddTimestampOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class TimestampOptions

public class TimestampOptions

Héritage

object ← TimestampOptions

Membres hérités

Constructeurs

TimestampOptions(string, string)

Initialise une nouvelle instance de la classe Documentize.TimestampOptions.

public TimestampOptions(string serverUrl, string basicAuthCredentials = "")

Paramètres

serverUrl string: L’url du serveur de timestamp.
basicAuthCredentials string: Les identifiants d’authentification de base, le nom d’utilisateur et le mot de passe sont combinés en une chaîne “username:password”.

Propriétés

BasicAuthCredentials

Obtient/definit les identifiants d’authentification de base, le nom d’utilisateur et le mot de passe sont combinés en une chaîne “username:password”.

public string BasicAuthCredentials { get; set; }

Valeur de la propriété

ServerUrl

Obtient/definit l’url du serveur de timestamp.

public string ServerUrl { get; set; }

Valeur de la propriété

Espace de noms : Documentize Assembly : Documentize.dll

Class TocGenerator

Information

Représente le plugin Documentize.TocGenerator. Utilisé pour ajouter une table des matières aux documents PDF.

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

Héritage

object ← TocGenerator

Membres hérités

Exemples

L’exemple démontre 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 Titres
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
TocGenerator.Process(options);

L’exemple démontre comment ajouter une table des matières à un fichier PDF avec 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 Titres
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
TocGenerator.Process(options);

L’exemple démontre comment ajouter une table des matières à un fichier PDF et l’enregistrer sous forme de 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 Titres
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
TocGenerator.Process(options);

Méthodes

Process(TocOptions)

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

public static ResultContainer Process(TocOptions options)

Paramètres

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

Retourne

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

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

Information

Représente les options pour les En-têtes ou Titres de la Table des Matières à documenter par le plugin Documentize.PdfManager.

public class TocHeading

Héritage

object ← TocHeading

Membres hérités

Constructeurs

TocHeading(string, int, bool, int)

Initialise une nouvelle instance de Documentize.TocHeading.

public TocHeading(string text = "", int pageNumber = 1, bool generateNumbering = false, int level = 1)

Paramètres

text string: Le Texte de l’En-tête.
pageNumber int: Numéro de Page pour le lien.
generateNumbering bool: Utiliser la génération de numéros.
level int: Le Niveau.

Propriétés

GenerateNumbering

Utiliser la génération de numéros. Si true, la numérotation doit être effectuée automatiquement ; sinon, la numérotation doit être effectuée manuellement.

public bool GenerateNumbering { get; set; }

Valeur de la Propriété

Level

Le Niveau. Utilisé pour la génération de numéros.

public int Level { get; set; }

Valeur de la Propriété

PageNumber

Le Numéro de Page pour le lien.

public int PageNumber { get; set; }

Valeur de la Propriété

Text

Le Texte du Titre.

public string Text { get; set; }

Valeur de la Propriété

Espace de noms : Documentize Assembly : Documentize.dll

Class TocOptions

Information

Représente les options pour ajouter une table des matières au document via le plugin Documentize.PdfManager.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

Héritage

objet ← PluginBaseOptions ← TocOptions

Implémente

IPluginOptions

Membres hérités

Constructeurs

TocOptions()

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

public TocOptions()

Propriétés

GenerateBookmarks

Utilisation de la génération de signets. Si défini sur true, les signets seront effacés et générés par les titres ; sinon, les signets ne changeront pas.

public bool GenerateBookmarks { get; set; }

Valeur de la propriété

Headings

Titres ou titres de la table des matières.

public List<tocheading> Headings { get; set; }

Valeur de la propriété

List<TocHeading>

Title

Le titre de la table des matières.

public string Title { get; set; }

Valeur de la propriété

Namespace : Documentize Assembly : Documentize.dll

Class XlsConverter

Information

Représente le plugin Documentize.XlsConverter. Utilisé pour convertir des documents PDF en formats XLSX/XLS/CSV/XLSM/ODS.

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

Héritage

object ← XlsConverter

Membres hérités

Méthodes

Process(PdfToXlsOptions)

Convertit un document PDF en formats XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Process(PdfToXlsOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Classe PdfExtractorOptions

Information

Représente les options pour les plugins TextExtractor et ImageExtractor.

public abstract class PdfExtractorOptions : IPluginOptions

Héritage

object ← PdfExtractorOptions

Dérivé

Implémente

IPluginOptions

Membres hérités

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é

Nom de l’opération

Renvoie le nom de l’opération

public virtual string OperationName { get; }

Valeur de la propriété

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

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

Information

Cette classe représente l’action pour les erreurs de conversion.

public enum ConvertErrorAction

Champs

Delete = 0
None = 1

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertSoftMaskAction

Information

Cette action représente des actions pour la conversion d’images avec un masque doux.

public enum ConvertSoftMaskAction

Champs

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

Namespace: Documentize Assembly: Documentize.dll

Enum DataType

Information

Représente les types de données possibles pour le traitement des plugins.

public enum DataType

Champs

Directory = 2 : Le type de données est un répertoire représenté par le chemin qui y mène.
File = 0 : Le type de données est un fichier représenté par le chemin qui y mène.
Stream = 1 : Le type de données est un flux.

Namespace: Documentize Assembly: Documentize.dll

Enum DocConversionMode

Information

Définit le mode de conversion du document de sortie.

public enum DocConversionMode

Champs

Flow = 1: Mode de reconnaissance complet, le moteur effectue un regroupement et une analyse multi-niveaux pour restaurer l’intention originale de l’auteur du document et produire un document le plus modifiable possible. L’inconvénient est que le document de sortie pourrait sembler différent du fichier PDF original.
TextBox = 0: Ce mode est rapide et bon pour préserver au maximum l’apparence originale du fichier PDF, mais l’éditabilité du document résultant pourrait être limitée. Chaque bloc de texte visuellement groupé dans le fichier PDF original est converti en une zone de texte dans le document résultant. Cela permet d’atteindre une ressemblance maximale du document de sortie avec le fichier PDF original. Le document de sortie aura une bonne apparence, mais il sera entièrement composé de zones de texte, ce qui pourrait rendre l’édition ultérieure du document dans Microsoft Word assez difficile. C’est le mode par défaut.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

Information

Spécifie les types de médias possibles utilisés lors du rendu.

public enum HtmlMediaType

Champs

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

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

Information

Spécifie des indicateurs qui, combinés à d’autres options, déterminent les tailles et les mises en page des pages.

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 redimensionné pour s’adapter à la page.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

Information

Spécifie la version de la norme PDF/A pour un document PDF.

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.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToHtmlOptions.SaveDataType

Information

Définit le type de sortie du fichier HTML.

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 fichier avec des ressources intégrées

Espace de noms : Documentize Assembly : Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

Information

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

public enum PdfToXlsOptions.ExcelFormat

Champs

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 activé pour les macros (.xlsm).
XLSX = 1: Format de fichier Office Open XML (.xlsx).
XMLSpreadSheet2003 = 0: Format de fichier Excel 2003 XML (.xls).

Namespace: Documentize Assembly: Documentize.dll

Enum Role

Information

Le rôle de l’auteur des messages.

public enum Role

Champs

Assistant = 2
System = 1
User = 0

Namespace: Documentize Assembly: Documentize.dll

Enum Rotation

Information

Énumération des valeurs de rotation possibles.

public enum Rotation

Champs

None = 0: Non-rotaté.
On180 = 2: Rotaté de 180 degrés.
On270 = 3: Rotaté de 270 degrés dans le sens des aiguilles d’une montre.
On360 = 4: Rotaté de 360 degrés dans le sens des aiguilles d’une montre.
On90 = 1: Rotaté de 90 degrés dans le sens des aiguilles d’une montre.

Namespace: Documentize Assembly: Documentize.dll

Enum TextExtractorOptions.TextFormattingMode

Information

Définit différents modes qui peuvent être utilisés lors de la conversion d’un document PDF en texte. Voir la classe Documentize.TextExtractorOptions.

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.

Namespace: Documentize Assembly: Documentize.dll

Enum TextFormattingMode

Information

Définit différents modes pouvant être utilisés lors de la conversion d’un document PDF en texte. Voir la classe Documentize.ExtractTextOptions.

public enum TextFormattingMode

Champs

Flatten = 2: Représente le contenu PDF avec le positionnement des fragments de texte selon leurs coordonnées. C’est fondamentalement similaire au mode “Raw”. Mais alors que “Raw” se concentre sur la préservation de la structure des fragments de texte (opérateurs) dans un document, “Flatten” se concentre sur le maintien du texte dans l’ordre dans lequel il est lu.
Pure = 0: Représente le contenu texte PDF avec quelques routines de mise en forme. Cela inclut 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 mise en forme.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffColorDepth

Information

Utilisé pour spécifier la profondeur de couleur pour les options Documentize.PdfToTiff.

public enum TiffColorDepth

Champs

Format1bpp = 4: 1 bit par pixel.
Format24bpp = 1: 24 bits par pixel. Rgb.
Format32bpp = 0: 32 bits par pixel. Utilisé par défaut.
Format4bpp = 3: 4 bits par pixel.
Format8bpp = 2: 8 bits par pixel.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffCompression

Information

Utilisé pour spécifier le type de compression pour les Documentize.PdfToTiffOptions.

public enum TiffCompression

Champs

CCITT3 = 2: Spécifie le schéma de compression CCITT3. Peut être passé à l’encodeur CCITT3 en tant que paramètre appartenant à la catégorie Compression.
CCITT4 = 1: Spécifie le schéma de compression CCITT4. Peut être passé à l’encodeur CCITT4 en tant que paramètre appartenant à la catégorie Compression.
LZW = 0: Spécifie le schéma de compression LZW. Peut être passé à l’encodeur Tiff en tant que paramètre appartenant à la catégorie Compression.
None = 4: Spécifie aucune compression. Peut être passé à l’encodeur Tiff en tant que paramètre appartenant à la catégorie compression.
RLE = 3: Spécifie le schéma de compression RLE. Peut être passé à l’encodeur RLE en tant que paramètre appartenant à la catégorie Compression.

Namespace: Documentize Assembly: Documentize.dll

Interface IDataSource

Information

Interface de données générale qui définit les membres communs que les données concrètes doivent implémenter.

public interface IDataSource

Propriétés

DataType

Type de source de données.

DataType DataType { get; }

Valeur de propriété

Namespace : Documentize Assembly : Documentize.dll

Interface IOperationResult

Information

Interface générale de résultat d’opération qui définit des méthodes communes que le résultat d’opération du plugin concret doit implémenter.

public interface IOperationResult

Propriétés

Data

Obtient les données brutes.

object Data { get; }

Valeur de la propriété

IsFile

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

bool IsFile { get; }

Valeur de la propriété

IsStream

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

bool IsStream { get; }

Valeur de la propriété

IsString

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

bool IsString { get; }

Valeur de la propriété

Méthodes

ToFile()

Essaye de convertir le résultat en fichier.

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

Essaye de convertir le résultat en objet flux.

Stream ToStream()

Renvoie

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

Namespace: Documentize Assembly: Documentize.dll

Interface IPluginOptions

Information

Interface générale d’options de plugin qui définit des méthodes communes que les options de plugin concrètes doivent implémenter.

public interface IPluginOptions

Namespace: Documentize Assembly: Documentize.dll

Licence de Classe

Information

Fournit une méthode pour définir la licence.

public static class License

Héritage

object ← License

Membres hérités

Exemples

Montre comment activer une licence.

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

Méthodes

Set(string)

License 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 d’évaluation.

Namespace: Documentize Assembly: Documentize.dll

Signature de Classe

Information

Représente le plugin Documentize.Signature. Utilisé pour signer des documents PDF.

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

Héritage

object ← Signature

Membres Hérités

Méthodes

Process(SignOptions)

Signer un document PDF.

public static ResultContainer Process(SignOptions options)

Paramètres

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

Retourne

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

Exceptions

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Utilisation de la classe

Information

Statistiques d’utilisation pour la demande d’achèvement.

public class Usage

Héritage

object ← Usage

Membres hérités

Constructeurs

Usage()

public Usage()

Propriétés

CompletionTokens

Nombre de tokens dans l’achèvement généré.

[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }

Valeur de propriété

PromptTokens

Nombre de tokens dans l’invite.

[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }

Valeur de propriété

TotalTokens

Nombre total de tokens utilisés dans la demande (invite + achèvement).

[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }

Valeur de propriété