Choix de Classe

public class Choice

Héritage

object ← Choice

Membres Hérités

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

Constructeurs

Choice()

public Choice()

Propriétés

FinishReason

La raison pour laquelle le modèle a arrêté de générer des tokens. Cela s’arrêtera si le modèle atteint un point d’arrêt naturel ou une séquence d’arrêt fournie, ou si le nombre maximum de tokens spécifié dans la requête a été atteint.

[JsonProperty("finish_reason")]
public string FinishReason { get; set; }

Valeur de la Propriété

string

Index

L’index du choix dans la liste des choix.

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

Valeur de la Propriété

int

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

Class AddTimestampOptions

[Obsolete("The class will be deleted soon. Please use SignOptions class.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← AddTimestampOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

AddTimestampOptions(Stream, string, string, string)

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

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 du fichier pfx.
• serverUrl string : L’URL du serveur d’horodatage.
• serverBasicAuthCredentials string : Les informations d’authentification basique, le nom d’utilisateur et le mot de passe sont combinés dans une chaîne “username:password”. (Optionnel).

Class ChatCompletion

public class ChatCompletion

Inheritance

object ← ChatCompletion

Inherited Members

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

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

string

Model

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

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

Property Value

string

Object

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

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

Property Value

string

SystemFingerprint

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

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

Property Value

string

Usage

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

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

Property Value

Usage

Class ChatGptConsts

public static class ChatGptConsts

Héritage

object ← ChatGptConsts

Membres hérités

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

Champs

• ApiUrl

Valeur du champ

string

ModelName

public static string ModelName

Valeur du champ

string

SystemRole

public static string SystemRole

Valeur du champ

string

SystemRoleDescription

public static string SystemRoleDescription

Valeur du champ

string

UserRole

public static string UserRole

Valeur du champ

string

Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ChatGptRequestOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

ChatGptRequestOptions()

Initialise une nouvelle instance de l’objet Documentize.ChatGptRequestOptions avec les 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)

Parameters

• 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 sous forme de chaîne envoyée à ChatGPT.

Properties

ApiKey

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

public string ApiKey { get; set; }

Property Value

string

ApiUrl

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

public string ApiUrl { get; set; }

Property Value

string

CancellationToken

Le jeton d’annulation.

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

MaxTokens

Nombre maximum de jetons dans la réponse.
La valeur par défaut est null, ce qui signifie illimité.

public int? MaxTokens { get; set; }

Property Value

int?

Messages

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

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

Property Value

List<Message>

Remarks

Lors de l’ajout de plusieurs messages aux options, l’ordre dans la collection est le suivant :

• Le premier message (le cas échéant) provient de options.Query, précédé du message contenant le texte : « You are a helpful assistant. », et le rôle est « system ».
• 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 message par document avec le rôle « user ». 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; }

Property Value

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Property Value

int

Query

Obtient ou définit la requête sous forme de chaîne envoyée à ChatGPT.
Si elle n’est pas vide, c’est le premier message de la collection qui sera envoyé dans la requête.

public string Query { get; set; }

Property Value

string

Temperature

Température d’échantillonnage utilisée, entre 0 et 2.
Des valeurs plus élevées comme 0,8 rendront la sortie plus aléatoire, tandis que des valeurs plus faibles comme 0,2 la rendront plus ciblée et déterministe.
La valeur par défaut est 1.

public double Temperature { get; set; }

Property Value

double

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← CompressOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

CompressOptions()

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

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← DecryptionOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

DecryptionOptions(string)

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

public DecryptionOptions(string ownerPassword)

Paramètres

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

Propriétés

OwnerPassword

Mot de passe du propriétaire.

public string OwnerPassword { get; set; }

Valeur de propriété

string

Class DecryptOptions

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← DecryptOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

DecryptOptions(string)

Initialise une nouvelle instance de l’objet Documentize.DecryptOptions avec les 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é

string

Class DirectoryData

public sealed class DirectoryData : IData

Héritage

object ← DirectoryData

Implémente

• IData

Membres hérités

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

Constructeurs

DirectoryData(string)

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

public DirectoryData(string path)

Paramètres

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

Propriétés

DataType

Type de source de données.

public DataType DataType { get; }

Valeur de la propriété

DataType

Path

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

public string Path { get; }

Valeur de la propriété

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Héritage

object ← DirectoryDataSource

Implémente

• IDataSource

Membres hérités

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

Constructeurs

DirectoryDataSource(string)

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

public DirectoryDataSource(string path)

Paramètres

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

Propriétés

DataType

Type de source de données.

public DataType DataType { get; }

Valeur de la propriété

DataType

Path

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

public string Path { get; }

Valeur de la propriété

string

Class DocConverter

[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

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

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

ArgumentException

Si les options ne sont pas définies.

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← EncryptionOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

EncryptionOptions(string, string)

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

public EncryptionOptions(string ownerPassword, string userPassword)

Paramètres

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

Propriétés

OwnerPassword

Mot de passe du propriétaire.

public string OwnerPassword { get; set; }

Valeur de la propriété

string

UserPassword

Mot de passe de l’utilisateur.

public string UserPassword { get; set; }

Valeur de la propriété

string

Class EncryptOptions

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← EncryptOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

EncryptOptions(string, string)

Initialise une nouvelle instance de l’objet Documentize.EncryptOptions avec les 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 la propriété

string

UserPassword

Mot de passe de l’utilisateur.

public string UserPassword { get; set; }

Valeur de la propriété

string

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

ExtractFormDataToDsvOptions(char, bool)

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

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

Paramètres

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

Propriétés

AddFieldName

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

public bool AddFieldName { get; set; }

Valeur de la propriété

bool

Delimiter

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

public char Delimiter { get; set; }

Valeur de la propriété

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractImagesOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

ExtractImagesOptions()

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

public ExtractImagesOptions()

Class ExtractPropertiesOptions

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Héritage

object ← OptionsWithInput ← ExtractPropertiesOptions

Implémente

• IHaveInput

Membres hérités

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

Constructeurs

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

Initialise une nouvelle instance de l’objet Documentize.ExtractPropertiesOptions avec les données spécifiées.

public ExtractPropertiesOptions(IData data)

Parameters

• data IData: Les données d’entrée.

ExtractPropertiesOptions(string)

Initialise une nouvelle instance de l’objet Documentize.ExtractPropertiesOptions avec le fichier spécifié.

public ExtractPropertiesOptions(string file)

Parameters

• file string: Le chemin du fichier d’entrée.

ExtractPropertiesOptions(Stream)

Initialise une nouvelle instance de l’objet Documentize.ExtractPropertiesOptions avec le flux spécifié.

public ExtractPropertiesOptions(Stream stream)

Parameters

• stream Stream: Le flux d’entrée.

Propriétés

Input

Obtient ou définit les données d’entrée.

public override IData Input { get; set; }

Valeur de la propriété

IData

Class ExtractTextOptions

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Héritage

object ← OptionsWithInput ← ExtractTextOptions

Implémente

• IHaveInput

Membres hérités

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

Constructeurs

ExtractTextOptions(TextFormattingMode)

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

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Paramètres

• formattingMode TextFormattingMode : La valeur du mode de formatage du texte.

ExtractTextOptions(IData, TextFormattingMode)

Initialise une nouvelle instance de l’objet Documentize.ExtractTextOptions avec les données spécifiées.

public ExtractTextOptions(IData data, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Paramètres

• data IData : Les données d’entrée.
• formattingMode TextFormattingMode : La valeur du mode de formatage du texte.

ExtractTextOptions(string, TextFormattingMode)

Initialise une nouvelle instance de l’objet Documentize.ExtractTextOptions avec le fichier spécifié.

public ExtractTextOptions(string file, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Paramètres

• file string : Le chemin du fichier d’entrée.
• formattingMode TextFormattingMode : La valeur du mode de formatage du texte.

ExtractTextOptions(Stream, TextFormattingMode)

Initialise une nouvelle instance de l’objet Documentize.ExtractTextOptions avec le flux spécifié.

public ExtractTextOptions(Stream stream, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Paramètres

• stream Stream : Le flux d’entrée.
• formattingMode TextFormattingMode : La valeur du mode de formatage du texte.

Propriétés

FormattingMode

Obtient ou définit le mode de formatage.

public TextFormattingMode FormattingMode { get; set; }

Valeur de la propriété

TextFormattingMode

Input

Obtient ou définit les données d’entrée.

public override IData Input { get; set; }

Valeur de la propriété

IData

Class FileData

public sealed class FileData : IData

Héritage

object ← FileData

Implémente

• IData

Membres hérités

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

Constructeurs

FileData(string)

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

public FileData(string path)

Paramètres

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

Propriétés

DataType

Type de la source de données.

public DataType DataType { get; }

Valeur de la propriété

DataType

Path

Obtient le chemin du fichier des données actuelles.

public string Path { get; }

Valeur de la propriété

string

Class FileDataSource

public sealed class FileDataSource : IDataSource

Héritage

object ← FileDataSource

Implémente

• IDataSource

Membres hérités

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

Constructeurs

FileDataSource(string)

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

public FileDataSource(string path)

Paramètres

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

Propriétés

DataType

Type de source de données.

public DataType DataType { get; }

Valeur de la propriété

DataType

Path

Obtient le chemin du fichier des données actuelles.

public string Path { get; }

Valeur de la propriété

string

Class FileResult

public sealed class FileResult : IOperationResult

Héritage

object ← FileResult

Implémente

• IOperationResult

Membres hérités

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

Propriétés

Data

Obtient les données brutes.

public object Data { get; }

Valeur de la propriété

object

IsFile

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

public bool IsFile { get; }

Valeur de la propriété

bool

IsStream

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

public bool IsStream { get; }

Valeur de la propriété

bool

IsString

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

public bool IsString { get; }

Valeur de la propriété

bool

Méthodes

ToFile()

Essaie de convertir le résultat en fichier.

public string ToFile()

Renvoie

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

ToStream()

Essaie de convertir le résultat en objet flux.

public Stream ToStream()

Renvoie

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

Class FlattenFieldsOptions

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← FlattenFieldsOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Properties

SkipFields

La liste des champs qui ne seront pas aplatis.

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

Property Value

List<string>

Class FormExporter

[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

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

Méthodes

Process(ExtractFormDataToDsvOptions)

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

ArgumentException

Si options n’est pas défini.

Class FormExportToDsvOptions

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FormExportToDsvOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

FormExportToDsvOptions(char, bool)

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

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

Paramètres

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

Propriétés

AddFieldName

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

public bool AddFieldName { get; set; }

Valeur de la propriété

bool

Delimeter

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

public char Delimeter { get; set; }

Valeur de la propriété

char

Class FormFlattener

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

Héritage

object ← FormFlattener

Membres hérités

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

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 vers le document PDF.

Retourne

List<string>

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.

Retourne

List<string>

Liste des noms dans le document PDF.

Process(FlattenFieldsOptions) : Aplatisse les champs de 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.

Retourne

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FormFlattenerOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

FormFlattenerOptions()

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

public FormFlattenerOptions()

Propriétés

SkipFields

La liste des champs qui ne seront pas aplatis.

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

Valeur de la propriété

List<string>

Class GetFieldNamesOptions

public class GetFieldNamesOptions

Héritage

object ← GetFieldNamesOptions

Membres hérités

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

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.

Class HtmlConverter

[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

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

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

ArgumentException

Si les options ne sont pas définies.

Process(HtmlToPdfOptions)

Convertit des documents HTML en format PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Paramètres

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

Retourne

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← HtmlToPdfOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

HtmlToPdfOptions()

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

public HtmlToPdfOptions()

Properties

BasePath

Le chemin de base/URL du fichier HTML.

public string BasePath { get; set; }

Property Value

string

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

Property Value

bool

PageInfo

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

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Class ImageExtractor

[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

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

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

ArgumentException

Si les options ne sont pas définies.

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ImageExtractorOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

ImageExtractorOptions()

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

public ImageExtractorOptions()

Class Info

public static class Info

Inheritance

object ← Info

Inherited Members

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

Fields

• AssemblyVersion Version de l’assembly.

Field Value

string

Product

Nom du produit.

public const string Product = "Documentize"

Field Value

string

Class JpegConverter

[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

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

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

ArgumentException

Si les options ne sont pas définies.

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← MergeOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

MergeOptions()

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

public MergeOptions()

Class Merger

[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

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

Méthodes

Process(MergeOptions)

Fusionner des documents PDF.

public static ResultContainer Process(MergeOptions options)

Paramètres

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

Retours

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Class Message

public class Message

Héritage

object ← Message

Membres Hérités

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

Constructeurs

Message()

public Message()

Propriétés

Contenu

Le contenu du message.

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

Valeur de la Propriété

string

Rôle

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

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

Valeur de la Propriété

Role

Class ObjectResult

public sealed class ObjectResult : IOperationResult

Héritage

object ← ObjectResult

Implémente

• IOperationResult

Membres hérités

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

Propriétés

Data

Obtient des données brutes.

public object Data { get; }

Valeur de la propriété

object

IsFile

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

public bool IsFile { get; }

Valeur de la propriété

bool

IsObject

Indique si le résultat est un objet.

public bool IsObject { get; }

Valeur de la propriété

bool

IsStream

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

public bool IsStream { get; }

Valeur de la propriété

bool

IsString

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

public bool IsString { get; }

Valeur de la propriété

bool

Text

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

public string Text { get; }

Valeur de la propriété

string

Méthodes

ToFile()

Essaie de convertir le résultat en fichier.

public string ToFile()

Renvoie

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

ToStream()

Essaie de convertir le résultat en objet flux.

public Stream ToStream()

Renvoie

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

ToString()

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

public override string ToString()

Renvoie

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

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

OptimizeOptions()

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

• ouvrir la première page le plus rapidement possible ;
• afficher la page suivante ou suivre le lien vers la page suivante le plus rapidement possible ;
• afficher la page progressivement à mesure qu’elle arrive lorsque les données d’une page sont transmises 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 complète n’ait été reçue et affichée.

public OptimizeOptions()

Class Optimizer

[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

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

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.

Class OptionsWithInput

public abstract class OptionsWithInput : IHaveInput

Héritage

object ← OptionsWithInput

Dérivés

• ExtractPropertiesOptions,
• ExtractTextOptions

Implémente

• IHaveInput

Membres hérités

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

Champs

• input

Valeur du champ

IData

Propriétés

Input

Obtient ou définit les données d’entrée.

public virtual IData Input { get; set; }

Valeur de la propriété

IData

Class PageInfo

public class PageInfo : PageSize

Héritage

object ← PageSize ← PageInfo

Membres hérités

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

Constructeurs

PageInfo()

Constructeur de Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Constructeur de Documentize.PageInfo.

public PageInfo(double width, double height)

Paramètres

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

Propriétés

MarginBottom

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

public double MarginBottom { get; set; }

Valeur de propriété

double

MarginLeft

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

public double MarginLeft { get; set; }

Valeur de propriété

double

MarginRight

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

public double MarginRight { get; set; }

Valeur de propriété

double

MarginTop

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

public double MarginTop { get; set; }

Valeur de propriété

double

Class PageSize

public class PageSize

Héritage

object ← PageSize

Dérivé

• PageInfo

Membres hérités

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

Constructeurs

PageSize()

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

public PageSize()

PageSize(double, double)

Constructeur de Documentize.PageSize.

public PageSize(double width, double height)

Paramètres

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

Propriétés

A0

Taille A0 (1189x840 mm).

public static PageSize A0 { get; }

Valeur de la propriété

PageSize

A1

Taille A1 (840x594 mm).

public static PageSize A1 { get; }

Valeur de la propriété

PageSize

A2

Taille A2 (594x420 mm).

public static PageSize A2 { get; }

Valeur de la propriété

PageSize

A3

Taille A3 (420x297 mm).

public static PageSize A3 { get; }

Valeur de la propriété

PageSize

A4

Taille A4 (297x210 mm).

public static PageSize A4 { get; }

Valeur de la propriété

PageSize

A5

Taille A5 (210x148 mm).

public static PageSize A5 { get; }

Valeur de la propriété

PageSize

A6

Taille A6 (148x105 mm).

public static PageSize A6 { get; }

Valeur de la propriété

PageSize

B5

Taille B5 (250x176 mm).

public static PageSize B5 { get; }

Valeur de la propriété

PageSize

Height

Obtient ou définit la hauteur de la page.

public double Height { get; set; }

Valeur de la propriété

double

IsLandscape

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

public bool IsLandscape { get; }

Valeur de la propriété

bool

P11x17

Format 11x17 pouces.

public static PageSize P11x17 { get; }

Valeur de la propriété

PageSize

PageLedger

Taille Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valeur de la propriété

PageSize

PageLegal

Taille Légal (356x216 mm).

public static PageSize PageLegal { get; }

Valeur de la propriété

PageSize

PageLetter

Taille Lettre (279x216 mm).

public static PageSize PageLetter { get; }

Valeur de la propriété

PageSize

Width

Obtient ou définit la largeur de la page.

public double Width { get; set; }

Valeur de la propriété

double

Class PdfAConverter

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

Héritage

object ← PdfAConverter

Membres hérités

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

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

ArgumentException

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

ArgumentException

Si les options ne sont pas définies.

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAConvertOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

PdfAConvertOptions()

public PdfAConvertOptions()

Propriétés

Outputs

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

public List<idatasource> Outputs { get; }

Valeur de la propriété

List<IDataSource>

Méthodes

AddOutput(IDataSource)

Ajoute une nouvelle cible de sauvegarde de résultat.

public void AddOutput(IDataSource dataSource)

Paramètres

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

Class PdfAOptionsBase

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

public abstract class PdfAOptionsBase : IPluginOptions

Héritage

object ← PdfAOptionsBase

Dérivées

• PdfAValidateOptions,
• PdfToPdfAOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

PdfAOptionsBase()

protected PdfAOptionsBase()

Propriétés

AlignText

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

public bool AlignText { get; set; }

Valeur de la propriété

bool

Remarques

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

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Valeur de la propriété

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Valeur de la propriété

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }

Valeur de la propriété

string

Inputs

Obtient la collection de données.

public List<idata> Inputs { get; }

Valeur de la propriété

List<IData>

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Valeur de la propriété

bool

LogOutputSource

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

public IData LogOutputSource { get; set; }

Valeur de la propriété

IData

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Valeur de la propriété

bool

Remarques

Lorsqu’elle est définie sur true, le processus de conversion tentera de minimiser la taille du fichier résultant. Cela peut 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 la propriété

PdfAStandardVersion

Remarques

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

SoftMaskAction

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

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Valeur de la propriété

ConvertSoftMaskAction

Méthodes

AddInput(IData)

Ajoute de nouvelles données à la collection

public void AddInput(IData data)

Paramètres

• data IData: Données d’entrée. :

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAValidateOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Héritage

object ← PdfAValidationResult

Membres hérités

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

Champs

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

Valeur du champ

IData

IsValid

Obtient une valeur indiquant si la validation a réussi.

public readonly bool IsValid

Valeur du champ

bool

StandardVersion

Obtient la version du standard PDF/A utilisée pour la validation.

public readonly PdfAStandardVersion StandardVersion

Valeur du champ

PdfAStandardVersion

Class 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

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

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

ArgumentException : InvalidOperationException

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Héritage

object ← PdfChatGptOptions

Dérivé

• PdfChatGptRequestOptions

Implémente

• IPluginOptions

Membres Hérités

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

Constructeurs

PdfChatGptOptions()

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

public PdfChatGptOptions()

Propriétés

Inputs

public List<idatasource> Inputs { get; }

Valeur de la Propriété

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Valeur de la Propriété

List<IDataSource>

Méthodes

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Paramètres

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

AddOutput(IDataSource)

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

public void AddOutput(IDataSource saveDataSource)

Paramètres

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

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Héritage

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implémente

• IPluginOptions

Membres hérités

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

Constructeurs

PdfChatGptRequestOptions()

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

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

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

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

Paramètres

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

Propriétés

ApiKey

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

public string ApiKey { get; set; }

Valeur de la propriété

string

ApiUrl

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

public string ApiUrl { get; set; }

Valeur de la propriété

string

CancellationToken

Le jeton d’annulation.

public CancellationToken CancellationToken { get; set; }

Valeur de la propriété

CancellationToken

MaxTokens

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

public int? MaxTokens { get; set; }

Valeur de la propriété

int?

Messages

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

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

Valeur de la propriété

List<Message>

Remarques

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

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

Model

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

public string Model { get; set; }

Valeur de la propriété

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Valeur de la propriété

int

Query

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

public string Query { get; set; }

Valeur de la propriété

string

Temperature

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

public double Temperature { get; set; }

Valeur de la propriété

double

Class PdfConverter

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

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

Exemples

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

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

L’exemple montre comment convertir un document PDF au format Doc avec le paramètre Mode.

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

L’exemple montre comment convertir un PDF en document XLSX.

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

L’exemple montre comment convertir un PDF en document XLS.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("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 FileData("path_to_result_xlsx_file.xls"));
// Perform the process
PdfConverter.Convert(options);

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

// 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 FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.html"));
//Perform the process
PdfConverter.Convert(options);

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

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

L’exemple montre comment convertir un document PDF au format JPEG.

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

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

// 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 FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

L’exemple montre comment convertir un document PDF au format JPEG vers des flux.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("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();
}

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

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

L’exemple montre comment convertir 1 page d’un document PDF au format PNG.

// 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 FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

L’exemple montre comment convertir un document PDF au format PNG vers des flux.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("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();
}

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

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

L’exemple montre comment convertir un document PDF au format TIFF avec la personnalisation des pages et du DPI.

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

L’exemple montre comment convertir un document PDF en TIFF multi‑pages.

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

L’exemple montre comment convertir un document PDF au format TIFF avec la personnalisation de la compression et de la profondeur de couleur.

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

L’exemple montre comment convertir un document PDF au format TIFF vers des flux.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input File path
options.AddInput(new FileData("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();
}