Documentize Namespace

Classes

Nom de la classeDescription
ChatCompletionReprésente une réponse de complétion de chat renvoyée par le modèle, basée sur l’entrée fournie.
ChatGptConstsCette classe représente un stockage pour les constantes.
ChatGptRequestOptionsReprésente les options pour le plugin Documentize.PdfManager.
ChoiceUn choix de complétion de chat.
CompressOptionsReprésente les options de compression pour le composant Documentize.PdfManager.
DecryptOptionsReprésente les options de décryptage pour le plugin Documentize.PdfSecurity.
DirectoryDataReprésente les données du répertoire pour les opérations de chargement et d’enregistrement.
DocConverterReprésente le plugin Documentize.DocConverter. Utilisé pour convertir les documents PDF en format DOC/DOCX.
EncryptOptionsReprésente les options de chiffrement pour le plugin Documentize.PdfSecurity.
ExtractFormDataToDsvOptionsReprésente les options d’exportation des valeurs des champs pour les composants Documentize.PdfForm et Documentize.PdfExtractor.
ExtractImagesOptionsReprésente les options d’extraction d’images pour le composant Documentize.PdfExtractor.
ExtractPropertiesOptionsReprésente les options d’extraction des propriétés PDF pour le composant Documentize.PdfExtractor.
ExtractTextOptionsReprésente les options d’extraction de texte pour le composant Documentize.PdfExtractor.
FileDataReprésente les données de fichier pour les opérations de chargement et d’enregistrement.
FileResultReprésente le résultat de l’opération sous forme de chemin de fichier sous forme de chaîne.
FlattenFieldsOptionsReprésente les options d’aplatissement des champs dans le document par le composant Documentize.PdfForm.
GetFieldNamesOptionsReprésente les options d’obtention des noms de champs dans le document par le composant Documentize.PdfForm.
HtmlConverterReprésente le plugin Documentize.HtmlConverter. Utilisé pour convertir les documents PDF en HTML et les documents HTML en PDF.
HtmlToPdfOptionsReprésente les options du convertisseur HTML vers PDF pour le plugin Documentize.PdfConverter.
InfoLa classe fournit des informations sur la version actuelle du produit.
JpegConverterReprésente le plugin Documentize.JpegConverter. Utilisé pour convertir les documents PDF en format JPEG.
LicenseFournit une méthode pour définir la licence.
MergeOptionsReprésente les options de fusion pour le plugin Documentize.PdfManager.
MergerReprésente le plugin Documentize.Merger. Utilisé pour fusionner plusieurs documents PDF en un seul PDF.
MessageUn message de complétion de chat généré par le modèle.
ObjectResultReprésente le résultat de l’opération sous forme de chaîne.
OptimizeOptionsReprésente les options d’optimisation pour le plugin Documentize.PdfManager.
OptimizerReprésente le plugin Documentize.Optimizer. Utilisé pour optimiser, faire pivoter, redimensionner et compresser des documents PDF.
OptionsWithInputReprésente les options de base pour les opérations avec 1 donnée d’entrée.
OptionsWithInputAndOutputReprésente les options de base pour les opérations avec 1 donnée d’entrée et 1 donnée de sortie.
PageInfoReprésente les informations de la page.
PageSizeClasse représentant la taille de la page dans un document PDF.
PdfAConverterReprésente un plugin gérant la conversion de documents PDF au format PDF/A et la validation de la conformité PDF/A.
PdfAOptionsBaseReprésente la classe de base pour les options du plugin Documentize.PdfAConverter. Cette classe fournit des propriétés et méthodes pour configurer le processus de conversion et de validation PDF/A.
PdfAValidateOptionsReprésente les options de validation de la conformité PDF/A des documents PDF avec le plugin Documentize.PdfConverter.
PdfAValidationResultReprésente le résultat d’un processus de validation PDF/A.
PdfChatGptReprésente le plugin PdfChatGpt.
PdfConverterReprésente le composant Documentize.PdfConverter. Utilisé pour convertir des documents PDF vers d’autres formats comme DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Permet également la validation PDF/A et la conversion HTML vers PDF.
PdfExtractorReprésente le composant Documentize.PdfExtractor. Utilisé pour extraire du texte, des images, des données de formulaire et des propriétés (méta‑données) des documents PDF.
PdfFormReprésente le composant Documentize.PdfForm. Utilisé pour aplatir et extraire les données des formulaires. Permet également d’obtenir les noms des champs.
PdfManagerReprésente le composant Documentize.PdfManager. Utilisé pour fusionner, diviser, optimiser, faire pivoter, redimensionner, compresser des documents PDF et ajouter des tables ou une table des matières. Peut fusionner plusieurs PDF en un seul, diviser un PDF en pages séparées, optimiser, faire pivoter, redimensionner, compresser des PDF, ajouter une table ou une table des matières.
PdfPropertiesReprésente les propriétés et les méta‑informations d’un document PDF.
PdfSecurityReprésente le composant Documentize.PdfSecurity. Utilisé pour chiffrer, déchiffrer, signer et assainir les documents PDF.
PdfToDocOptionsReprésente les options du convertisseur PDF vers DOC pour le plugin Documentize.PdfConverter.
PdfToHtmlOptionsReprésente les options du convertisseur PDF vers HTML pour le plugin Documentize.PdfConverter.
PdfToJpegOptionsReprésente les options du convertisseur PDF vers JPEG pour le plugin Documentize.PdfConverter.
PdfToPdfAOptionsReprésente les options de conversion de documents PDF au format PDF/A avec le plugin Documentize.PdfConverter.
PdfToPngOptionsReprésente les options du convertisseur PDF vers PNG pour le plugin Documentize.PdfConverter.
PdfToTiffOptionsReprésente les options du convertisseur PDF vers TIFF pour le plugin Documentize.PdfConverter.
PdfToXlsOptionsReprésente les options du convertisseur PDF vers XLS/XLSX pour le plugin Documentize.PdfConverter.
PluginBaseOptionsReprésente les options de base pour les composants.
PngConverterReprésente le plugin Documentize.PngConverter. Utilisé pour convertir des documents PDF en format PNG.
RectangleClasse représentant un rectangle.
RemoveFieldsOptionsReprésente les options de suppression de champs dans le document par le plugin Documentize.PdfForm.
ResizeOptionsReprésente les options de redimensionnement pour le plugin Documentize.PdfManager.
ResultContainerReprésente un conteneur contenant la collection de résultats du traitement du plugin.
RotateOptionsReprésente les options de rotation pour le plugin Documentize.PdfManager.
SanitizeOptionsReprésente les options de configuration pour l’assainissement des données cachées dans un document.
SecurityReprésente le plugin Documentize.Security. Utilisé pour chiffrer et déchiffrer des documents PDF.
SignOptionsReprésente les options de signature pour le composant Documentize.PdfSecurity.
SplitOptionsReprésente les options de division pour le plugin Documentize.PdfManager.
SplitterReprésente le plugin Documentize.Splitter. Utilisé pour diviser les documents PDF en pages séparées.
StreamDataReprésente les données de flux pour les opérations de chargement et d’enregistrement.
StreamResultReprésente le résultat de l’opération sous forme de flux.
StringResultReprésente le résultat de l’opération sous forme de chaîne.
TableBuilderClasse représentant le constructeur d’une table dans une page PDF.
TableCellBuilderClasse représentant le constructeur d’une cellule de table.
TableGeneratorReprésente le plugin Documentize.TableGenerator. Utilisé pour ajouter une table à un document PDF.
TableOptionsReprésente les options d’ajout d’une table au document par le plugin Documentize.PdfManager.
TableRowBuilderClasse représentant le constructeur d’une ligne de table.
TiffConverterReprésente le plugin Documentize.TiffConverter. Utilisé pour convertir des documents PDF en format TIFF.
TimestampOptionsReprésente les options de timbre (timestamp) pour le composant Documentize.PdfSecurity.
TocGeneratorReprésente le plugin Documentize.TocGenerator. Utilisé pour ajouter une table des matières aux documents PDF.
TocHeadingReprésente les options pour les titres ou en-têtes de la table des matières du document par le plugin Documentize.PdfManager.
TocOptionsReprésente les options d’ajout d’une table des matières au document par le plugin Documentize.PdfManager.
UsageStatistiques d’utilisation pour la requête de complétion.
XlsConverterReprésente le plugin Documentize.XlsConverter. Utilisé pour convertir des documents PDF en formats XLSX/XLS/CSV/XLSM/ODS.

Interfaces

Nom de l’interfaceDescription
IDataInterface de données générale définissant les membres communs que les données concrètes doivent implémenter.
IHaveInputInterface de données générale définissant les données d’entrée que les options doivent implémenter.
IOperationResultInterface générale de résultat d’opération définissant les méthodes communes que le résultat d’une opération de composant concret doit implémenter.
IPluginOptionsInterface générale d’options de composant définissant les méthodes communes que les options de composant concrètes doivent implémenter.

Enums

Nom de l’enumDescription
ConvertErrorActionCette classe représente l’action à entreprendre en cas d’erreurs de conversion.
ConvertSoftMaskActionCette action représente les actions pour la conversion d’images avec masque souple.
DataTypeReprésente les types possibles de données pour le traitement du composant.
DocConversionModeDéfinit le mode de conversion du document de sortie.
PdfToXlsOptions.ExcelFormatPermet de spécifier le format de fichier xls/xlsx/xml/csv. La valeur par défaut est XLSX.
HtmlMediaTypeSpécifie les types de médias possibles utilisés lors du rendu.
HtmlPageLayoutOptionSpécifie les drapeaux qui, associés à d’autres options, déterminent les tailles et la disposition des pages.
PdfAStandardVersionSpécifie la version du standard PDF/A pour un document PDF.
RoleLe rôle de l’auteur des messages.
RotationÉnumération des valeurs de rotation possibles.
PdfToHtmlOptions.SaveDataTypeDéfinit le type de sortie du fichier HTML.
TextFormattingModeDéfinit les différents modes pouvant être utilisés lors de la conversion d’un document PDF en texte. Voir la classe Documentize.ExtractTextOptions.
TiffColorDepthUtilisé pour spécifier la profondeur de couleur pour Documentize.PdfToTiffOptions.
TiffCompressionUtilisé pour spécifier le type de compression pour Documentize.PdfToTiffOptions.

Sous-sections de Documentize Namespace

Class AddTimestampOptions

Information

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

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

Héritage

object ← PluginBaseOptions ← AddTimestampOptions

Implémente

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

Namespace: Documentize Assembly: Documentize.dll

Class ChatCompletion

Information

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

public class ChatCompletion

Héritage

object ←
ChatCompletion

Membres hérités

Constructeurs

ChatCompletion()

public ChatCompletion()

Propriétés

Choices

Une liste d’options de complétion de chat. Peut être plus d’une si n est supérieur à 1.

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

Valeur de la propriété

List<Choice>

Created

L’horodatage Unix (en secondes) du moment où la complétion de chat a été créée.

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

Valeur de la propriété

long

Id

Un identifiant unique pour la complétion de chat.

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

Valeur de la propriété

string

Model

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

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

Valeur de la propriété

string

Object

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

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

Valeur de la propriété

string

SystemFingerprint

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

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

Valeur de la propriété

string

Usage

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

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

Valeur de la propriété

Usage

Espace de noms : Documentize
Assemblage : 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

public static string 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

Espace de noms : 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

Membres hérités

Constructeurs

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 les options spécifiées.

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

Paramètres

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 token 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 d’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 la collection est le suivant :

  • Le premier message (le cas échéant) provient de options.Query, précédé du message dont le contenu est : « You are a helpful assistant. », avec le rôle « 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 pour chaque 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; }

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 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; }

Valeur de la propriété

string

Temperature

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

public double Temperature { get; set; }

Valeur de la propriété

double

Espace de noms : Documentize
Assemblage : Documentize.dll

Class Choice

Information

Un choix de complétion de chat.

public class Choice

Héritage

object ← Choice

Membres hérités

Constructeurs

Choice()

public Choice()

Propriétés

FinishReason

La raison pour laquelle le modèle a interrompu la génération de jetons.
Cela sera « stop » si le modèle atteint un point d’arrêt naturel ou une séquence d’arrêt fournie, ou « length » si le nombre maximal de jetons 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

Espace de noms : Documentize
Assemblage : Documentize.dll

Class CompressOptions

Information

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

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← CompressOptions

Implémente

Membres hérités

Constructeurs

CompressOptions()

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

public CompressOptions()

Espace de noms : Documentize
Assemblage : 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

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é

string

Namespace: Documentize Assembly: Documentize.dll

Class DecryptOptions

Information

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

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← DecryptOptions

Implémente

Membres hérités

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 propriétaire.

Propriétés

OwnerPassword

Mot de passe propriétaire.

public string OwnerPassword { get; set; }

Valeur de la propriété

string

Espace de noms : Documentize
Assemblage : Documentize.dll

Class DirectoryData

Information

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

public sealed class DirectoryData : IData

Héritage

object ←
DirectoryData

Implémente

Membres hérités

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

Espace de noms : Documentize
Assemblage : 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

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é

DataType

Path

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

public string Path { get; }

Valeur de la propriété

string

Namespace: Documentize Assembly: Documentize.dll

Class DocConverter

Information

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

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

Héritage

object ← DocConverter

Membres hérités

Méthodes

Process(PdfToDocOptions)

Convertit un document PDF au format DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Paramètres

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

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : 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

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é

string

UserPassword

Mot de passe de l’utilisateur.

public string UserPassword { get; set; }

Valeur de la propriété

string

Namespace: Documentize Assembly: Documentize.dll

Class EncryptOptions

Information

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

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Héritage

object ←
PluginBaseOptions ←
EncryptOptions

Implémente

Membres hérités

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 propriétaire.
  • userPassword string : Mot de passe utilisateur.

Propriétés

OwnerPassword

Mot de passe propriétaire.

public string OwnerPassword { get; set; }

Valeur de la propriété

string

UserPassword

Mot de passe utilisateur.

public string UserPassword { get; set; }

Valeur de la propriété

string

Espace de noms : Documentize
Assemblage : Documentize.dll

Class ExtractFormDataToDsvOptions

Information

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

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implémente

Membres hérités

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Class ExtractImagesOptions

Information

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

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractImagesOptions

Implements

Inherited Members

Constructors

ExtractImagesOptions()

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

public ExtractImagesOptions()

Espace de noms : Documentize
Assemblage : Documentize.dll

Class ExtractPropertiesOptions

Information

Représente les options d’extraction des propriétés PDF pour le composant Documentize.PdfExtractor.

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Héritage

object ← OptionsWithInput ← ExtractPropertiesOptions

Implémente

Membres hérités

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 d’entrée spécifiées.

public ExtractPropertiesOptions(IData inputData)

Paramètres

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

ExtractPropertiesOptions(string)

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

public ExtractPropertiesOptions(string inputFile)

Paramètres

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

ExtractPropertiesOptions(Stream)

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

public ExtractPropertiesOptions(Stream inputStream)

Paramètres

  • inputStream 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

Namespace : Documentize
Assembly : Documentize.dll

Class ExtractTextOptions

Information

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

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Héritage

object ←
OptionsWithInput ←
ExtractTextOptions

Implémente

Membres hérités

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

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Class FileData

Information

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

public sealed class FileData : IData

Héritage

object ← FileData

Implémente

Membres hérités

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

Méthodes

ToString()

Convertit l’instance en System.String.

public override string ToString()

Retour

string : Chemin du fichier.

Espace de noms : 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

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é

DataType

Path

Obtient le chemin du fichier des données actuelles.

public string Path { get; }

Valeur de la propriété

string

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 sous forme de chaîne.

public sealed class FileResult : IOperationResult

Héritage

object ← FileResult

Implémente

Membres hérités

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

Tente de convertir le résultat en fichier.

public string ToFile()

Retourne

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

ToStream()

Tente de convertir le résultat en objet flux.

public Stream ToStream()

Retourne

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

Espace de noms : Documentize
Assembly : Documentize.dll

Class FlattenFieldsOptions

Information

Représente les options pour aplatir les champs du document par le composant Documentize.PdfForm.

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← FlattenFieldsOptions

Implémente

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é

List<string>

Espace de noms : Documentize
Assemblage : Documentize.dll

Class FormExporter

Information

Représente le plugin Documentize.FormExporter. Utilisé pour exporter les valeurs des formulaires des documents PDF vers un fichier 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

Retour

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Namespace: Documentize Assembly: 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

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é

bool

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

Méthodes

GetFieldNames(string)

Obtenir les noms des champs dans le document PDF.

public static List<string> GetFieldNames(string path)

Paramètres

  • path string : Le chemin vers le document PDF.

Renvoie

List<string>

Liste des noms dans le document PDF.

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

public static List<string> GetFieldNames(Stream stream)

Paramètres

  • stream Stream : Le flux contenant le document PDF.

Renvoie

List<string>

Liste des noms dans le document PDF.

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

public static ResultContainer Process(FlattenFieldsOptions options)

Paramètres

Renvoie

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

Exceptions

ArgumentException

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

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é

List<string>

Namespace: Documentize Assembly: Documentize.dll

Class GetFieldNamesOptions

Information

Représente les options pour obtenir les noms de champs dans le document via le composant Documentize.PdfForm.

public class GetFieldNamesOptions : OptionsWithInput, IHaveInput

Héritage

object ← OptionsWithInput ← GetFieldNamesOptions

Implémente

Membres hérités

Constructeurs

GetFieldNamesOptions(string)

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

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.

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Class HtmlConverter

Information

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

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

Héritage

object ← HtmlConverter

Membres hérités

Méthodes

Process(PdfToHtmlOptions)

Convertit des documents PDF au format HTML.

public static ResultContainer Process(PdfToHtmlOptions options)

Paramètres

  • options PdfToHtmlOptions : 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 les options ne sont pas définies.

Process(HtmlToPdfOptions)

Convertit des documents HTML au format PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Paramètres

  • options HtmlToPdfOptions : 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 les options ne sont pas définies.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class HtmlToPdfOptions

Information

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

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← HtmlToPdfOptions

Implémente

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 du fichier HTML.

public string BasePath { get; set; }

Valeur de la propriété

string

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

Valeur de la propriété

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

Valeur de la propriété

bool

PageInfo

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

public PageInfo PageInfo { get; set; }

Valeur de la propriété

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Valeur de la propriété

HtmlPageLayoutOption

Espace de noms : Documentize
Assemblage : Documentize.dll

Class ImageExtractor

Information

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

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

Héritage

object ← ImageExtractor

Membres hérités

Méthodes

Process(ExtractImagesOptions)

Extrait des images d’un document PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Paramètres

Retour

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : Documentize Assemblage : 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

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

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

public const string AssemblyVersion = "26.9.0";

Valeur du champ

string

Product

Nom du produit.

public const string Product = "Documentize";

Valeur du champ

string

Espace de noms: Documentize
Assemblage: Documentize.dll

Class JpegConverter

Information

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

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

Héritage

object ← JpegConverter

Membres hérités

Méthodes

Process(PdfToJpegOptions)

Convertit le document PDF au format JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Paramètres

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

Retour

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class License

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.

// Set License
License.Set("PathToLicense.lic");

Méthodes

Set(string)

Licence le composant.

public static void Set(string licenseName)

Paramètres

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

Espace de noms : Documentize
Assemblage : 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

Membres hérités

Constructeurs

MergeOptions()

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

public MergeOptions()

Espace de noms : Documentize
Assemblage : Documentize.dll

Class Merger

Information

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

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
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 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.

Espace de noms : Documentize
Assemblage : 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

Content

Le contenu du message.

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

Valeur de la propriété

string

Role

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Class ObjectResult

Information

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

public sealed class ObjectResult : IOperationResult

Inheritance

object ← ObjectResult

Implements

Inherited Members

Properties

Data

Obtient les données brutes.

public object Data { get; }

Property Value

object

IsFile

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

public bool IsFile { get; }

Property Value

bool

IsObject

Indique si le résultat est un objet.

public bool IsObject { get; }

Property Value

bool

IsStream

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

public bool IsStream { get; }

Property Value

bool

IsString

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

public bool IsString { get; }

Property Value

bool

Text

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

public string Text { get; }

Property Value

string

Methods

ToFile()

Tente de convertir le résultat en fichier.

public string ToFile()

Returns

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

ToStream()

Tente de convertir le résultat en objet flux.

public Stream ToStream()

Returns

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

ToString()

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

public override string ToString()

Returns

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

Namespace: Documentize
Assembly: Documentize.dll

Class OptimizeOptions

Information

Représente les options d’optimisation pour le plug‑in Documentize.PdfManager.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← OptimizeOptions

Implémente

Membres hérités

Constructeurs

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 de façon incrémentielle à mesure qu’elle arrive lorsque les données d’une page sont transmises via un canal lent (afficher d’abord les données les plus utiles) ;
  • permettre à l’utilisateur d’interagir, par exemple de suivre un lien, même avant que la page entière n’ait été reçue et affichée.
public OptimizeOptions()

Espace de noms : Documentize
Assemblage : Documentize.dll

Class Optimizer

Information

Représente le plugin Documentize.Optimizer. Utilisé pour optimiser, pivoter, redimensionner, compresser les documents PDF.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
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 les instructions pour l’opération.

Retour

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 les instructions pour l’opération.

Retour

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 les instructions pour l’opération.

Retour

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 les instructions pour l’opération.

Retour

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

Espace de noms : Documentize
Assembly : Documentize.dll

Class OptionsWithInput

Information

Représente les Options de base pour des opérations avec 1 donnée d’entrée.

public abstract class OptionsWithInput : IHaveInput

Héritage

object ← OptionsWithInput

Dérivées

Implémente

Membres hérités

Champs

input

protected IData 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

Namespace: Documentize Assembly: Documentize.dll

Class OptionsWithInputAndOutput

Information

Représente les options de base pour les opérations avec 1 donnée d’entrée et 1 donnée de sortie.

public abstract class OptionsWithInputAndOutput : OptionsWithInput, IHaveInput

Héritage

object ← OptionsWithInput ← OptionsWithInputAndOutput

Dérivés

Implémente

Membres hérités

Champs

output

protected IData output;

Valeur du champ

IData

Propriétés

Output

Obtient ou définit les données de sortie.

public virtual IData Output { get; set; }

Valeur de la propriété

IData

Espace de noms : Documentize
Assemblage : 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 la propriété

double

MarginLeft

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

public double MarginLeft { get; set; }

Valeur de la propriété

double

MarginRight

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

public double MarginRight { get; set; }

Valeur de la propriété

double

MarginTop

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

public double MarginTop { get; set; }

Valeur de la propriété

double

Espace de noms : Documentize
Assemblage : 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és

Membres hérités

Constructeurs

PageSize()

Constructeur de Documentize.PageSize. Taille 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 (1189 × 840 mm).

public static PageSize A0 { get; }

Valeur de la propriété

PageSize

A1

Taille A1 (840 × 594 mm).

public static PageSize A1 { get; }

Valeur de la propriété

PageSize

A2

Taille A2 (594 × 420 mm).

public static PageSize A2 { get; }

Valeur de la propriété

PageSize

A3

Taille A3 (420 × 297 mm).

public static PageSize A3 { get; }

Valeur de la propriété

PageSize

A4

Taille A4 (297 × 210 mm).

public static PageSize A4 { get; }

Valeur de la propriété

PageSize

A5

Taille A5 (210 × 148 mm).

public static PageSize A5 { get; }

Valeur de la propriété

PageSize

A6

Taille A6 (148 × 105 mm).

public static PageSize A6 { get; }

Valeur de la propriété

PageSize

B5

Taille B5 (250 × 176 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. Retourne true si l’orientation est paysage et false si elle est portrait.

public bool IsLandscape { get; }

Valeur de la propriété

bool

P11x17

Format 11 × 17 pouces.

public static PageSize P11x17 { get; }

Valeur de la propriété

PageSize

PageLedger

Taille Ledger (432 × 279 mm).

public static PageSize PageLedger { get; }

Valeur de la propriété

PageSize

Taille Legal (356 × 216 mm).

public static PageSize PageLegal { get; }

Valeur de la propriété

PageSize

PageLetter

Taille Letter (279 × 216 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

Namespace : Documentize
Assembly : Documentize.dll

Class PdfAConverter

Information

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

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

Héritage

object ← PdfAConverter

Membres hérités

Méthodes

Process(PdfToPdfAOptions)

Convertit un document PDF au format PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Paramètres

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

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Process(PdfAValidateOptions)

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

public static ResultContainer Process(PdfAValidateOptions options)

Paramètres

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

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : 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

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é

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

Information

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

Représente la classe de base pour les options du plug‑in 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ées

Implémente

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 pendant le processus de conversion PDF/A.

public bool AlignText { get; set; }

Valeur de la propriété

bool

Remarques

Lorsque la valeur est true, le processus de conversion tentera de restaurer les limites d’origine des segments de texte.
Dans la plupart des documents, il n’est pas nécessaire de modifier cette propriété qui est false par défaut, car l’alignement du texte ne change pas durant le processus de conversion standard.

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Valeur de la propriété

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Valeur de la propriété

ConvertErrorAction

IccProfileFileName

Obtient ou définit le nom de fichier du profil ICC (International Color Consortium) à utiliser pour la conversion PDF/A à la place du profil 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 faible consommation de 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 essayer de réduire la taille du fichier pendant la conversion PDF/A.

public bool OptimizeFileSize { get; set; }

Valeur de la propriété

bool

Remarques

Lorsque la valeur est 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 sert à 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 se basant sur les métadonnées du document.
Pour le processus de conversion PDF/A, Documentize.PdfAStandardVersion.Auto correspond par défaut à la version PDF/A‑1b.

SoftMaskAction

Obtient ou définit l’action à entreprendre lors de la conversion d’images contenant 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.

Namespace : Documentize
Assembly : Documentize.dll

Class PdfAValidateOptions

Information

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

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfAValidateOptions

Implémente

Membres hérités

Constructeurs

PdfAValidateOptions()

public PdfAValidateOptions()

Espace de noms : Documentize
Assemblage : Documentize.dll

Class PdfAValidationResult

Information

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

public sealed class PdfAValidationResult

Inheritance

object ←
PdfAValidationResult

Inherited Members

Champs

Data

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

public readonly IData Data;

Field Value

IData

IsValid

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

public readonly bool IsValid;

Field Value

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion;

Field Value

PdfAStandardVersion

Espace de noms : Documentize
Assembly : Documentize.dll

Class PdfChatGpt

Information

Représente le plugin PdfChatGpt.

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

Héritage

object ← PdfChatGpt

Membres hérités

Remarques

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 la méthode ProcessAsync à la place.

public static ResultContainer Process(IPluginOptions options)

Paramètres

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

Retour

ResultContainer

Exceptions

NotImplementedException

ProcessAsync(IPluginOptions)

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

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

Paramètres

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

Retour

Task<ResultContainer>

L’objet task représentant l’opération asynchrone.

Exceptions

ArgumentException : InvalidOperationException

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

Information

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

public class PdfChatGptOptions : IPluginOptions

Héritage

object ← PdfChatGptOptions

Dérivé

Implémente

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é

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

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

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

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverter

Information

Représente le composant Documentize.PdfConverter. Utilisé pour convertir des documents PDF vers d’autres formats comme 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.

Représente le composant Documentize.PdfConverter. Utilisé pour convertir des documents PDF vers d’autres formats comme 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.

public static class PdfConverter

Héritage

object ← PdfConverter

Membres hérités

Méthodes

Convert(PdfToDocOptions)

Convertit un document PDF en formats DOC/DOCX.

public static ResultContainer Convert(PdfToDocOptions options)

Paramètres

  • options PdfToDocOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

// Créez un objet PdfToDocOptions pour définir les instructions
var options = new PdfToDocOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_file.doc"));
// Effectuez le traitement
PdfConverter.Convert(options);

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

// Créez un objet PdfToDocOptions pour définir les instructions
var options = new PdfToDocOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_file.doc"));
// Définissez le Mode
options.Mode = DocConversionMode.Flow;
// Effectuez le traitement
PdfConverter.Convert(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Convert(PdfToXlsOptions)

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

public static ResultContainer Convert(PdfToXlsOptions options)

Paramètres

  • options PdfToXlsOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

// Créez un objet PdfToXlsOptions pour définir les instructions
var options = new PdfToXlsOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_xlsx_file.xlsx"));
// Effectuez le traitement
PdfConverter.Convert(options);

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

// Créez un objet PdfToXlsOptions pour définir les instructions
var options = new PdfToXlsOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Spécifiez le format XLS
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_xlsx_file.xls"));
// Effectuez le traitement
PdfConverter.Convert(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Convert(PdfToHtmlOptions)

Convertit un document PDF en format HTML.

public static ResultContainer Convert(PdfToHtmlOptions options)

Paramètres

  • options PdfToHtmlOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

// Créez un objet PdfToHtmlOptions pour définir le type de données de sortie comme fichier avec ressources intégrées
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_output.html"));
// Effectuez le traitement
PdfConverter.Convert(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Convert(HtmlToPdfOptions)

Convertit un document HTML en format PDF.

public static ResultContainer Convert(HtmlToPdfOptions options)

Paramètres

  • options HtmlToPdfOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

// Créez un HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.html"));
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_output.pdf"));
// Effectuez le traitement
PdfConverter.Convert(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Convert(PdfToJpegOptions)

Convertit un document PDF en format JPEG.

public static ResultContainer Convert(PdfToJpegOptions options)

Paramètres

  • options PdfToJpegOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

// Créez un objet PdfToJpegOptions pour définir les instructions
var options = new PdfToJpegOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Effectuez le traitement
PdfConverter.Convert(options);

L’exemple montre comment convertir un document PDF en JPEG avec paramètres de pages, résolution et qualité.

// Créez un objet PdfToJpegOptions pour définir les instructions
var options = new PdfToJpegOptions();
// Traitez uniquement la première page
options.PageList = [1];
// Définissez la résolution de sortie à 200 DPI
options.OutputResolution = 200;
// Définissez la qualité de sortie à 50
options.Quality = 50;
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Effectuez le traitement
PdfConverter.Convert(options);

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

// Créez un objet PdfToJpegOptions pour définir les instructions
var options = new PdfToJpegOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Effectuez le traitement
var results = PdfConverter.Convert(options);
// Récupérez les flux de résultats
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Exceptions

ArgumentException

Si les options ne sont pas définies.

Convert(PdfToPngOptions)

Convertit un document PDF en format PNG.

public static ResultContainer Convert(PdfToPngOptions options)

Paramètres

  • options PdfToPngOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

// Créez un objet PdfToPngOptions pour définir les instructions
var options = new PdfToPngOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Effectuez le traitement
PdfConverter.Convert(options);

L’exemple montre comment convertir une page de PDF en PNG.

// Créez un objet PdfToPngOptions pour définir les instructions
var options = new PdfToPngOptions();
// Traitez uniquement la première page
options.PageList = [1];
// Définissez la résolution de sortie à 200 DPI
options.OutputResolution = 200;
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Effectuez le traitement
PdfConverter.Convert(options);

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

// Créez un objet PdfToPngOptions pour définir les instructions
var options = new PdfToPngOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Effectuez le traitement
var results = PdfConverter.Convert(options);
// Récupérez les flux de résultats
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Exceptions

ArgumentException

Si les options ne sont pas définies.

Convert(PdfToTiffOptions)

Convertit un document PDF en format TIFF.

public static ResultContainer Convert(PdfToTiffOptions options)

Paramètres

  • options PdfToTiffOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

// Créez un objet PdfToTiffOptions pour définir les instructions
var options = new PdfToTiffOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Effectuez le traitement
PdfConverter.Convert(options);

L’exemple montre comment convertir un document PDF en TIFF avec personnalisation des pages et DPI.

// Créez un objet PdfToTiffOptions pour définir les instructions
var options = new PdfToTiffOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Définissez les pages
options.PageList = [1, 3];
// Définissez la résolution d'image du résultat
options.OutputResolution = 400;
// Effectuez le traitement
PdfConverter.Convert(options);

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

// Créez un objet PdfToTiffOptions pour définir les instructions
var options = new PdfToTiffOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Activez la sortie TIFF multi‑pages
options.MultiPage = true;
// Effectuez le traitement
PdfConverter.Convert(options);

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

// Créez un objet PdfToTiffOptions pour définir les instructions
var options = new PdfToTiffOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Définissez la compression et la profondeur de couleur
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Effectuez le traitement
PdfConverter.Convert(options);

L’exemple montre comment convertir un PDF en TIFF vers des flux.

// Créez un objet PdfToTiffOptions pour définir les instructions
var options = new PdfToTiffOptions();
// Ajoutez le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Effectuez le traitement
var results = PdfConverter.Convert(options);
// Récupérez les flux de résultats
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Exceptions

ArgumentException

Si les options ne sont pas définies.

Convert(PdfToPdfAOptions)

Convertit un document PDF en format PDF/A.

public static ResultContainer Convert(PdfToPdfAOptions options)

Paramètres

  • options PdfToPdfAOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

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

// Ajoutez le fichier source
options.AddInput(new FileData("path_to_your_pdf_file.pdf")); // remplacez par le chemin réel

// Ajoutez le chemin où enregistrer le fichier converti
options.AddOutput(new FileData("path_to_the_converted_file.pdf"));

// Lancez la conversion
PdfConverter.Convert(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Validate(PdfAValidateOptions)

Vérifie qu’un document PDF respecte le format PDF/A spécifié.

public static ResultContainer Validate(PdfAValidateOptions options)

Paramètres

  • options PdfAValidateOptions : un objet d’options contenant les instructions pour l’opération.

Retour

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

Exemples

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

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

// Ajoutez un ou plusieurs fichiers à valider
options.AddInput(new FileData("path_to_your_first_pdf_file.pdf")); // remplacez par le chemin réel
options.AddInput(new FileData("path_to_your_second_pdf_file.pdf"));
// ajoutez d'autres fichiers selon les besoins

// Lancez la validation et récupérez les résultats
var resultContainer = PdfConverter.Validate(options);

// Vérifiez la propriété ResultCollection du resultContainer pour les résultats de validation de chaque fichier :
foreach (var result in resultContainer.ResultCollection)
{
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // résultat de validation du document
}

Exceptions

ArgumentException

Si les options ne sont pas définies.

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é

Implémente

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

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 composant Documentize.PdfExtractor. Utilisé pour extraire du texte, des images, des données de formulaire, des propriétés (Métadonnées) des documents PDF.

public static class PdfExtractor

Héritage

object ←
PdfExtractor

Membres hérités

Méthodes

Extract(ExtractTextOptions)

Extrait le texte d’un document PDF.

public static string Extract(ExtractTextOptions options)

Paramètres

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

Retour

string : Texte extrait.

Exemples

L’exemple montre comment extraire le contenu texte d’un fichier PDF.

// Créez l’objet ExtractTextOptions pour définir le chemin du fichier d’entrée
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Effectuez le processus et récupérez le texte extrait
var textExtracted = PdfExtractor.Extract(options);

L’exemple montre comment extraire le contenu texte d’un flux PDF.

// Créez l’objet ExtractTextOptions pour définir le flux d’entrée
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Effectuez le processus et récupérez le texte extrait
var textExtracted = PdfExtractor.Extract(options);

L’exemple montre comment extraire le texte d’un document PDF en spécifiant le TextFormattingMode.

// Créez l’objet ExtractTextOptions pour définir le chemin du fichier et le TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Effectuez le processus et récupérez le texte extrait
var textExtracted = PdfExtractor.Extract(options);

L’exemple montre comment extraire le texte d’un fichier PDF de la manière la plus concise possible.

// Effectuez le processus et récupérez le texte extrait
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

Exceptions

ArgumentException
Si les options ne sont pas définies.

Extract(ExtractImagesOptions)

Extrait les images d’un document PDF.

public static ResultContainer Extract(ExtractImagesOptions options)

Paramètres

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

Retour

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

Exemples

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

// Créez l’objet ExtractImagesOptions pour définir les instructions
var options = new ExtractImagesOptions();
// Ajoutez le chemin du fichier d’entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du répertoire de sortie
options.AddOutput(new DirectoryData("path_to_results_directory"));
// Effectuez le processus
var results = PdfExtractor.Extract(options);
// Récupérez le chemin de l’image résultante
var imageExtracted = results.ResultCollection[0].ToFile();

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

// Créez l’objet ExtractImagesOptions pour définir les instructions
var options = new ExtractImagesOptions();
// Ajoutez le chemin du fichier d’entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Aucun résultat de sortie défini – les résultats seront écrits dans des flux
// Effectuez le processus
var results = PdfExtractor.Extract(options);
// Récupérez le flux
var ms = results.ResultCollection[0].ToStream();
// Copiez les données dans un fichier à des fins de démonstration
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Exceptions

ArgumentException
Si les options ne sont pas définies.

Extract(ExtractFormDataToDsvOptions)

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

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Paramètres

Retour

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

Exemples

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

// Créez l’objet ExtractFormDataToDsvOptions pour définir les instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Ajoutez le chemin du fichier d’entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Effectuez le processus
PdfExtractor.Extract(options);

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

// Créez l’objet ExtractFormDataToDsvOptions pour définir les instructions
var options = new ExtractFormDataToDsvOptions();
//Définir le délimiteur
options.Delimiter = '\t';
//Ajouter les noms de champ au résultat
options.AddFieldName = true;
// Ajoutez le chemin du fichier d’entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définissez le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Effectuez le processus
PdfExtractor.Extract(options);

Exceptions

ArgumentException
Si les options ne sont pas définies.

Extract(ExtractPropertiesOptions)

Extrait les propriétés d’un document PDF.

public static PdfProperties Extract(ExtractPropertiesOptions options)

Paramètres

Retour

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

Exemples

L’exemple montre comment extraire les propriétés (Nom du fichier, Titre, Auteur, Sujet, Mots‑clés, Date de création, Date de modification, Application, Producteur PDF, Nombre de pages) d’un fichier PDF.

// Créez l’objet ExtractPropertiesOptions pour définir le fichier d’entrée
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Effectuez le processus et récupérez les propriétés
var pdfProperties = PdfExtractor.Extract(options);
var filename = pdfProperties.FileName;
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

L’exemple montre comment extraire les propriétés (Titre, Auteur, Sujet, Mots‑clés, Date de création, Date de modification, Application, Producteur PDF, Nombre de pages) d’un flux PDF.

// Créez l’objet ExtractPropertiesOptions pour définir le flux d’entrée
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Effectuez le processus et récupérez les propriétés
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

L’exemple montre comment extraire les propriétés d’un fichier PDF de la manière la plus concise possible.

// Effectuez le processus et récupérez les propriétés
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

Exceptions

ArgumentException
Si les options ne sont pas définies.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class PdfForm

Information

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

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

public static class PdfForm

Inheritance

object ← PdfForm

Inherited Members

Methods

Extract(ExtractFormDataToDsvOptions)

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

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

Returns

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

Examples

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

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

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

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions();
//Set Delimiter
options.Delimiter = '\t';
//Add Field Names to result
options.AddFieldName = true;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
 // Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Perform the process
PdfForm.Extract(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Flatten(FlattenFieldsOptions)

Aplatit les champs d’un document PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parameters

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

Returns

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

Examples

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

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

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

// Get Fields Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
PdfForm.Flatten(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

GetNames(GetFieldNamesOptions)

Obtient les noms des champs dans un document PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Parameters

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

Returns

List<string>

Liste des noms dans le document PDF.

Examples

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

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

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

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

Remove(RemoveFieldsOptions) : Remove Fields from PDF document.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parameters

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

Returns

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

Examples

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

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

Information

Représente le composant Documentize.PdfManager. Utilisé pour fusionner, scinder, optimiser, 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 scinder des documents PDF en pages séparées. Peut optimiser, pivoter, redimensionner, compresser des documents PDF. Peut 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.

Représente le composant Documentize.PdfManager. Utilisé pour fusionner, scinder, optimiser, 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 scinder des documents PDF en pages séparées.
Peut optimiser, pivoter, redimensionner, compresser des documents PDF.
Peut 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

Héritage

object ← PdfManager

Membres hérités

Méthodes

AddTable(TableOptions)

Ajouter un tableau à un document PDF.

public static ResultContainer AddTable(TableOptions options)

Paramètres

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

Retourne

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

Exemples

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

// Configurer les options du tableau
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");
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_output.pdf"));
// Exécuter le processus
PdfManager.AddTable(options);

L’exemple montre comment ajouter un tableau à un fichier PDF avant la page 2.

// Configurer les options du tableau
var options = new TableOptions();
options.InsertPageBefore(2) // Ajouter le tableau avant la page 2
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age");
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_input.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_output.pdf"));
// Exécuter le processus
PdfManager.AddTable(options);

Exceptions

ArgumentException
Si les options ne sont pas définies.

AddTableOfContents(TocOptions)

Ajouter une table des matières (TOC) à un document PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

Paramètres

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

Retourne

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

Exemples

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

// Créer l'objet TocOptions pour définir les instructions
var options = new TocOptions();
// Définir le titre
options.Title = "My Table of Contents";
// Concevoir les titres
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));
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définir le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Exécuter le processus
PdfManager.AddTableOfContents(options);

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

// Créer l'objet TocOptions pour définir les instructions
var options = new TocOptions();
// Définir le titre
options.Title = "My Table of Contents";
// Générer les liens dans les signets
options.GenerateBookmarks = true;
// Concevoir les titres
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));
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
 // Définir le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Exécuter le processus
PdfManager.AddTableOfContents(options);

L’exemple montre comment ajouter une table des matières à un fichier PDF et l’enregistrer sous forme de flux.

// Créer l'objet TocOptions pour définir les instructions
var options = new TocOptions();
// Définir le titre
options.Title = "My Table of Contents";
// Concevoir les titres
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Ajouter le chemin du fichier d'entrée
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Définir le flux de sortie 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Exécuter le processus
PdfManager.AddTableOfContents(options);

L’exemple montre comment ajouter une table des matières à un fichier PDF avec personnalisation du titre du TOC.

// Créer l'objet TocOptions pour définir les instructions
var heading = new TocHeading();
heading.Text = "Intro";
heading.PageNumber = 5;
heading.GenerateNumbering = true;
heading.Level = 2;
var tocOptions = new TocOptions();
tocOptions.Headings.Add(heading);
// Ajouter les fichiers d'entrée et de sortie
tocOptions.AddInput(new FileData("path_to_your_pdf_file.pdf"));
tocOptions.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Générer le TOC avec les options personnalisées
PdfManager.AddTableOfContents(tocOptions);

Exceptions

ArgumentException
Si les options ne sont pas définies.

Compress(CompressOptions)

Compresser un document PDF. Tente de réduire la taille du document.

public static ResultContainer Compress(CompressOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment compresser un document PDF.

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

Exceptions

ArgumentException
Si les options ne sont pas définies.

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Créer un document PDF à partir de la réponse de ChatGpt.
Utilisé pour envoyer des requêtes directement à ChatGPT ou en ajoutant des sources de fichiers PDF et enregistrer la réponse dans la source de sortie.

public static Task<ResultContainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Paramètres

Retourne

Task<ResultContainer>
Un objet contenant le résultat de l’opération.

Exemples

L’exemple montre comment utiliser ChatGpt en ajoutant des messages à la requête.

var options = new ChatGptRequestOptions();
// Définir le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key."; // Vous devez fournir la clé pour accéder à l'API.
options.MaxTokens = 1000; // Nombre maximal de tokens à générer dans la complétion.

// Ajouter les messages de la requête.
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
});

// Exécuter la requête.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

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

L’exemple montre comment utiliser ChatGpt en ajoutant un seul message à la requête.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); // Ajouter le chemin du fichier de sortie.
options.ApiKey = "Your API key."; // Vous devez fournir la clé pour accéder à l'API.
options.MaxTokens = 1000; // Nombre maximal de tokens à générer dans la complétion.

// Ajouter le message de la requête.
// Dans ce cas, le message système avec Content = "You are a helpful assistant." est ajouté par défaut.
// Le rôle du message de requête est "user" par défaut.
options.Query = "What is the lowest temperature recorded on the Earth?";

// Exécuter la requête.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

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

L’exemple montre comment utiliser le chat en ajoutant des fichier(s) comme source(s) de message.

var options = new ChatGptRequestOptions();
// Définir le chemin du fichier de sortie
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));

// Ajouter la source texte du PDF.
// En cas de sources multiples, le texte de chaque document sera ajouté à la collection de messages de requête
// comme un message distinct avec le rôle "user".
options.AddInput(new FileData("TextSource.pdf"));

options.ApiKey = "Your API key."; // Vous devez fournir la clé pour accéder à l'API.
options.MaxTokens = 1000; // Nombre maximal de tokens à générer dans la complétion.

// Ajouter le message de la requête.
// Dans ce cas, le message système avec Content = "You are a helpful assistant." est ajouté par défaut.
// Le rôle du message de requête est "user" par défaut.
options.Query = "How many letters in the provided text?";

// Exécuter la requête.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

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

Exceptions

ArgumentException : Si les options ne sont pas définies.

Merge(MergeOptions)

Fusionner des documents PDF.

public static ResultContainer Merge(MergeOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment fusionner deux documents PDF.

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

Exceptions

ArgumentException
Si les options ne sont pas définies.

Optimize(OptimizeOptions)

Optimiser un document PDF.
Lineariser 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 de façon incrémentielle dès que les données arrivent sur un canal lent (afficher d’abord les données les plus utiles) ;
  • permettre des interactions utilisateur, comme suivre un lien, avant que la page entière ne soit reçue et affichée.
public static ResultContainer Optimize(OptimizeOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment optimiser un document PDF.

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

Exceptions

ArgumentException
Si les options ne sont pas définies.

Resize(ResizeOptions)

Redimensionner les pages d’un document PDF.

public static ResultContainer Resize(ResizeOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment redimensionner un document PDF.

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

Exceptions

ArgumentException
Si les options ne sont pas définies.

Rotate(RotateOptions)

Pivoter les pages d’un document PDF.

public static ResultContainer Rotate(RotateOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment pivoter un document PDF.

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

Exceptions

ArgumentException
Si les options ne sont pas définies.

Split(SplitOptions)

Scinder un document PDF par pages.

public static ResultContainer Split(SplitOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment scinder un document PDF.

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

Exceptions

ArgumentException
Si les options ne sont pas définies.

Namespace: Documentize
Assembly: Documentize.dll

Class PdfProperties

Information

Représente les propriétés et les métadonnées du document PDF.

public class PdfProperties

Héritage

object ←
PdfProperties

Membres hérités

Constructeurs

PdfProperties()

public PdfProperties()

Propriétés

Application

Obtient ou définit l’application PDF.

public string Application { get; set; }

Valeur de la propriété

string

Author

Obtient ou définit l’auteur du PDF.

public string Author { get; set; }

Valeur de la propriété

string

Created

Obtient ou définit la date de création du PDF.

public DateTime? Created { get; set; }

Valeur de la propriété

DateTime?

FileName

Obtient ou définit le nom de fichier du PDF, si disponible.

public string FileName { get; set; }

Valeur de la propriété

string

Keywords

Obtient ou définit les mots-clés du PDF.

public string Keywords { get; set; }

Valeur de la propriété

string

Modified

Obtient ou définit la date de modification du PDF.

public DateTime? Modified { get; set; }

Valeur de la propriété

DateTime?

NumberOfPages

Obtient ou définit le nombre de pages du PDF.

public int NumberOfPages { get; set; }

Valeur de la propriété

int

PdfProducer

Obtient ou définit le producteur du PDF.

public string PdfProducer { get; set; }

Valeur de la propriété

string

Subject

Obtient ou définit le sujet du PDF.

public string Subject { get; set; }

Valeur de la propriété

string

Title

Obtient ou définit le titre du PDF.

public string Title { get; set; }

Valeur de la propriété

string

Espace de noms : Documentize
Assembly : Documentize.dll

Class PdfSecurity

Information

Représente le composant Documentize.PdfSecurity. Utilisé pour chiffrer, déchiffrer, signer, et assainir les documents PDF.

public static class PdfSecurity

Héritage

object ← PdfSecurity

Membres hérités

Méthodes

Decrypt(DecryptOptions)

Déchiffre un document PDF.

public static ResultContainer Decrypt(DecryptOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment Decrypt un document PDF.

// Create DecryptOptions object to set instructions
var options = new DecryptOptions("123456");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Decrypt(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Encrypt(EncryptOptions)

Chiffre un document PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment Encrypt un document PDF.

// Create EncryptOptions object to set instructions
var options = new EncryptOptions("123456", "qwerty");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Encrypt(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Sanitize(SanitizeOptions)

Assainit les données cachées d’un document PDF, en éliminant ou transformant les informations sensibles ou inutiles telles que les métadonnées, pièces jointes, annotations, scripts Java, formulaires, calques, index de recherche ou contenu privé.

public static ResultContainer Sanitize(SanitizeOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment Sanitize un document PDF.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un PDF d’un flux vers un autre flux.

// Prepare input and output streams
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream = new MemoryStream();
// Create SanitizeOptions object to set input and output streams
var options = new SanitizeOptions(inputStream, outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un PDF d’un fichier vers un flux.

// Prepare output stream
using var outputStream = new MemoryStream();
// Create SanitizeOptions object to set input file and output stream
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un PDF d’un fichier vers un flux avec définition manuelle des propriétés d’entrée et de sortie.

// Prepare output stream
using var outputStream = new MemoryStream();
// Create SanitizeOptions object
var options = new SanitizeOptions();
//Set Input file
options.Input = new FileData("path_to_your_pdf_file.pdf");
//Set Output stream
options.Output = new StreamData(outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un PDF sans supprimer les métadonnées.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveMetadata = false;
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un PDF sans supprimer les pièces jointes.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveAttachments = false;
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un PDF en convertissant toutes les pages en images et en définissant le DPI du résultat.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Turn on conversion and set dpi
options.ConvertPagesToImages = true;
options.ImageDpi = 200;
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un PDF sans supprimer les scripts Java et les actions.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveJavaScriptsAndActions = false;
// Perform the process
PdfSecurity.Sanitize(options);

L’exemple montre comment Sanitize un fichier PDF de la manière la plus concise possible.

PdfSecurity.Sanitize(new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf"));

Exceptions

ArgumentException

Si les options ne sont pas définies.

Sign(SignOptions)

Signe numériquement un document PDF.

public static ResultContainer Sign(SignOptions options)

Paramètres

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

Retourne

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

Exemples

L’exemple montre comment Sign un document PDF.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Perform the process
PdfSecurity.Sign(options);

L’exemple montre comment Sign un document PDF en utilisant des flux.

// Prepare streams
using var pdfStreamInput = File.OpenRead(@"path_to_your_pdf_file.pdf");
using var pfxStreamInput = File.OpenRead(@"path_to_your_pfx_file.pfx");
using var pdfStreamOutput = new MemoryStream();
// Create SignOptions object to set instructions
var options = new SignOptions(pdfStreamInput, pdfStreamOutput, pfxStreamInput, "password_of_your_pfx_file");
// Perform the process
PdfSecurity.Sign(options);

L’exemple montre comment signer un PDF en définissant séparément les paramètres d’entrée et de sortie.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Set input and output file paths
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sign(options);

L’exemple montre comment Sign un 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");
// Set input and output file paths
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sign(options);

L’exemple montre comment Sign un PDF avec une signature invisible.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Configure invisible signature
options.Visible = false;
// Perform the process
PdfSecurity.Sign(options);

L’exemple montre comment Sign un PDF avec des options supplémentaires.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf","path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Optional parameters
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Perform the process
PdfSecurity.Sign(options);

L’exemple montre comment Sign un PDF de la manière la plus concise possible.

PdfSecurity.Sign(new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file"));

L’exemple montre comment Sign un PDF avec un horodatage.

// Create SignOptions object to set Timestamp
var options = new SignOptions(new TimestampOptions("server_url"));
// Set input and output file paths
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sign(options);

Exceptions

ArgumentException

Si les options ne sont pas définies.

Namespace : Documentize Assembly : Documentize.dll

Class PdfToDocOptions

Information

Représente les options du convertisseur PDF vers DOC pour le plugin Documentize.PdfConverter.

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToDocOptions

Implémente

Membres hérités

Constructeurs

PdfToDocOptions()

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

public PdfToDocOptions()

Propriétés

Mode

Permet de contrôler la façon dont un document PDF est converti en document de traitement de texte.

public DocConversionMode Mode { get; set; }

Valeur de la propriété

DocConversionMode

Remarques

Utilisez le mode Documentize.DocConversionMode.TextBox lorsque le document résultant ne sera pas fortement modifié par la suite. Les zones de texte sont faciles à modifier lorsqu’il n’y a pas grand‑chose à 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 aisée du texte, mais les objets de mise en forme non pris en charge apparaîtront pire qu’en mode Documentize.DocConversionMode.TextBox.

Namespace : Documentize Assembly : Documentize.dll

Class PdfToHtmlOptions

Information

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

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToHtmlOptions

Implémente

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

Propriétés

OutputDataType

Obtient le type de données de sortie.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Valeur de propriété

PdfToHtmlOptions.SaveDataType

Espace de noms : Documentize
Assemblage : Documentize.dll

Class PdfToJpegOptions

Information

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

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToJpegOptions

Implémente

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

int

PageList

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

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

Valeur de la propriété

List<int>

Quality

Obtient et définit la qualité de sortie.
Spécifie le niveau de compression d’une image.
La plage de valeurs utiles pour la qualité va de 0 à 100.
Plus le nombre indiqué est bas, plus la compression est élevée et donc plus la qualité de l’image est basse.
Zero donne l’image de la plus basse qualité et 100 la plus haute.

public int Quality { get; set; }

Valeur de la propriété

int

Espace de noms : Documentize
Assemblage : Documentize.dll

Class PdfToPdfAOptions

Information

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

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

Héritage

object ← PdfAOptionsBase ← PdfToPdfAOptions

Implémente

Membres hérités

Constructeurs

PdfToPdfAOptions()

public PdfToPdfAOptions()

Propriétés

Outputs

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

public List<IData> Outputs { get; }

Valeur de la propriété

List<IData>

Méthodes

AddOutput(IData)

Ajoute une nouvelle cible d’enregistrement du résultat.

public void AddOutput(IData data)

Paramètres

  • data IData : Cible (source de données fichier ou flux) pour enregistrer les résultats de l’opération.

Namespace : Documentize
Assembly : Documentize.dll

Class PdfToPngOptions

Information

Représente les options du convertisseur PDF vers PNG pour le plugin Documentize.PdfConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Héritage

object ←
PluginBaseOptions ←
PdfToPngOptions

Implémente

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é

int

PageList

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

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

Valeur de la propriété

List<int>

Espace de noms : Documentize
Assemblage : Documentize.dll

Class PdfToTiffOptions

Information

Représente les options du convertisseur PDF vers TIFF pour le plugin Documentize.PdfConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← PdfToTiffOptions

Implémente

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 le drapeau qui permet d’enregistrer toutes les pages dans un seul TIFF multipage.

Valeur par défaut : false.
public bool MultiPage { get; set; }

Valeur de la propriété

bool

OutputResolution

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

public int OutputResolution { get; set; }

Valeur de la propriété

int

PageList

Obtient ou définit une liste de pages à traiter.

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

Valeur de la propriété

List<int>

Espace de noms : Documentize
Assemblage : 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

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é

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Définissez sur true si vous avez besoin d’insérer une colonne vide comme première colonne de la feuille de calcul.
Valeur par défaut : false ; cela signifie qu’aucune colonne vide ne sera insérée.

public bool InsertBlankColumnAtFirst { get; set; }

Valeur de la propriété

bool

MinimizeTheNumberOfWorksheets

Définissez sur true si vous devez réduire le nombre de feuilles de calcul dans le classeur résultant.
Valeur par défaut : false ; cela signifie qu’une page PDF sera sauvegardée comme feuille de calcul distincte.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Valeur de la propriété

bool

Espace de noms : Documentize
Assemblage : Documentize.dll

Class PluginBaseOptions

Information

Représente les options de base pour les composants.

public class PluginBaseOptions : IPluginOptions

Héritage

object ← PluginBaseOptions

Dérivés

Implémente

Membres hérités

Propriétés

CloseInputStreams

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

public bool CloseInputStreams { get; set; }

Valeur de la propriété

bool

CloseOutputStreams

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

public bool CloseOutputStreams { get; set; }

Valeur de la propriété

bool

Inputs

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

public List<IData> Inputs { get; }

Valeur de la propriété

List<IData>

Outputs

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

public List<IData> Outputs { get; }

Valeur de la propriété

List<IData>

Méthodes

AddInput(IData)

Ajoute de nouvelles données aux entrées.

public void AddInput(IData data)

Paramètres

  • data IData : Données à ajouter.

AddOutput(IData)

Ajoute de nouvelles données aux sorties.

public void AddOutput(IData data)

Paramètres

  • data IData : 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("The class will be deleted soon. Please use PdfConverter class.")]
public static class PngConverter

Inheritance

object ← PngConverter

Inherited Members

Methods

Process(PdfToPngOptions)

Convertit un document PDF au format PNG.

public static ResultContainer Process(PdfToPngOptions options)

Parameters

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

Returns

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : Documentize
Assemblage : 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.

Espace de noms : Documentize Assemblage : Documentize.dll

Class RemoveFieldsOptions

Information

Représente les options pour la suppression de champs dans le document par le plug‑in Documentize.PdfForm.

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

Héritage

object ←
PluginBaseOptions ←
RemoveFieldsOptions

Implémente

Membres hérités

Constructeurs

RemoveFieldsOptions()

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

public RemoveFieldsOptions()

Espace de noms : Documentize
Assemblage : 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

Membres hérités

Constructeurs

ResizeOptions()

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

PageSize

Espace de noms : Documentize
Assemblage : Documentize.dll

Class ResultContainer

Information

Représente un conteneur qui contient la collection de 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 de l’opération

public List<ioperationresult> ResultCollection { get; }

Valeur de la propriété

List<IOperationResult>

Espace de noms : Documentize
Assemblage : 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

Implémente

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

Rotation

Espace de noms : Documentize
Assembly : Documentize.dll

Class SanitizeOptions

Information

Représente les options de configuration pour la désinfection des données cachées dans un document.

public class SanitizeOptions : OptionsWithInputAndOutput, IHaveInput

Héritage

object ← OptionsWithInput ← OptionsWithInputAndOutput ← SanitizeOptions

Implémente

Membres hérités

Constructeurs

SanitizeOptions()

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

public SanitizeOptions()

SanitizeOptions(IData, IData)

Initialise une nouvelle instance de l’objet Documentize.SanitizeOptions avec les données d’entrée spécifiées.

public SanitizeOptions(IData inputData, IData outputData = null)

Paramètres

  • inputData IData : Les données d’entrée.
  • outputData IData : Les données de sortie.

SanitizeOptions(string, string)

Initialise une nouvelle instance de l’objet Documentize.SanitizeOptions avec les fichiers d’entrée et de sortie spécifiés.

public SanitizeOptions(string inputFile, string outputFile)

Paramètres

  • inputFile string : Le chemin du fichier d’entrée.
  • outputFile string : Le chemin du fichier de sortie.

SanitizeOptions(Stream, Stream)

Initialise une nouvelle instance de l’objet Documentize.SanitizeOptions avec les flux d’entrée et de sortie spécifiés.

public SanitizeOptions(Stream inputStream, Stream outputStream)

Paramètres

  • inputStream Stream : Le flux d’entrée.
  • outputStream Stream : Le flux de sortie.

SanitizeOptions(string, Stream)

Initialise une nouvelle instance de l’objet Documentize.SanitizeOptions avec le fichier d’entrée et le flux de sortie spécifiés.

public SanitizeOptions(string inputFile, Stream outputStream)

Paramètres

  • inputFile string : Le chemin du fichier d’entrée.
  • outputStream Stream : Le flux de sortie.

SanitizeOptions(Stream, string)

Initialise une nouvelle instance de l’objet Documentize.SanitizeOptions avec le flux d’entrée et le fichier de sortie spécifiés.

public SanitizeOptions(Stream inputStream, string outputFile)

Paramètres

  • inputStream Stream : Le flux d’entrée.
  • outputFile string : Le chemin du fichier de sortie.

Propriétés

ConvertPagesToImages

Obtient ou définit l’option de conversion des pages en images.
La conversion des pages en images se produit après la suppression des principales données cachées, contrôlée par d’autres options.
La valeur par défaut est false.

public bool ConvertPagesToImages { get; set; }

Valeur de la propriété

bool

FlattenForms

Obtient ou définit un booléen indiquant si les formulaires du document doivent être aplatis pendant le processus de désinfection.
L’aplatissement des formulaires convertit les champs interactifs en contenu statique, les rendant non modifiables ou remplissables.
La valeur par défaut est true.

public bool FlattenForms { get; set; }

Valeur de la propriété

bool

FlattenLayers

Obtient ou définit l’option d’aplatissement des calques du document PDF.
Lorsqu’elle est activée, tous les calques du document sont fusionnés en un seul calque, supprimant leur structure séparée.
Cette option est utile pour désinfecter les documents en simplifiant leur contenu et en s’assurant qu’aucune donnée cachée ne subsiste dans les calques.
La valeur par défaut est true.

public bool FlattenLayers { get; set; }

Valeur de la propriété

bool

ImageDpi

Obtient ou définit l’option de résolution des images de page lors de la conversion des pages en images.
Cette propriété est prise en compte si la propriété Documentize.SanitizeOptions.ConvertPagesToImages est true.

public int ImageDpi { get; set; }

Valeur de la propriété

int

Input

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

public override IData Input { get; set; }

Valeur de la propriété

IData

Output

Obtient ou définit les données de sortie.

public override IData Output { get; set; }

Valeur de la propriété

IData

RemoveAnnotations

Obtient ou définit un booléen indiquant s’il faut supprimer les annotations du document.
Lorsqu’elle est activée, toutes les annotations présentes dans le document seront supprimées pendant le processus de désinfection.
Des annotations de rédaction seront appliquées.
La valeur par défaut est true.

public bool RemoveAnnotations { get; set; }

Valeur de la propriété

bool

RemoveAttachments

Obtient ou définit l’option de suppression de tous les fichiers joints du document.
Lorsqu’elle est activée, elle garantit que toutes les pièces jointes du PDF sont éliminées pendant le processus de désinfection.
La valeur par défaut est true.

public bool RemoveAttachments { get; set; }

Valeur de la propriété

bool

RemoveJavaScriptsAndActions

Obtient ou définit un booléen indiquant si les scripts JavaScript et les actions associées doivent être supprimés du document.
Cette option est utile pour éliminer les potentielles vulnérabilités de sécurité introduites par des scripts embarqués.
La valeur par défaut est true.

public bool RemoveJavaScriptsAndActions { get; set; }

Valeur de la propriété

bool

RemoveMetadata

Obtient ou définit une option de suppression des métadonnées du document.
Si elle est définie sur true, les métadonnées telles que les propriétés du document et les informations de métadonnées supplémentaires intégrées seront supprimées pendant la désinfection.
La valeur par défaut est true.

public bool RemoveMetadata { get; set; }

Valeur de la propriété

bool

RemoveSearchIndexAndPrivateInfo

Obtient ou définit un booléen indiquant si l’index de recherche et les informations privées doivent être supprimés du document.
Permet la suppression des index de recherche intégrés et des données privées afin d’améliorer la sécurité et la confidentialité du document.
La valeur par défaut est true.

public bool RemoveSearchIndexAndPrivateInfo { get; set; }

Valeur de la propriété

bool

Namespace : Documentize
Assembly : Documentize.dll

Class Security

Information

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

[Obsolete("The class will be deleted soon. Please use PdfSecurity class.")]
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 les instructions pour l’opération.

Valeur de retour

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

Exceptions

ArgumentException

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 les instructions pour l’opération.

Valeur de retour

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class Signature

Information

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

[Obsolete("The class will be deleted soon. Please use PdfSecurity class.")]
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 les instructions pour l’opération.

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class SignOptions

Information

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

public sealed class SignOptions : OptionsWithInputAndOutput, IHaveInput

Héritage

object ←
OptionsWithInput ←
OptionsWithInputAndOutput ←
SignOptions

Implémente

Membres hérités

Constructeurs

SignOptions(Stream, string)

Initialise une nouvelle instance de l’objet Documentize.SignOptions avec le flux pfx et le mot de passe.

public SignOptions(Stream pfx, string password)

Paramètres

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

SignOptions(string, string)

Initialise une nouvelle instance de l’objet Documentize.SignOptions avec le fichier pfx et le mot de passe.

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(IData, IData, IData, string)

Initialise une nouvelle instance de l’objet Documentize.SignOptions avec les données d’entrée, de sortie, le pfx et le mot de passe.

public SignOptions(IData inputData, IData outputData, IData pfxData, string password)

Paramètres

  • inputData IData : Les données d’entrée.
  • outputData IData : Les données de sortie.
  • pfxData IData : Les données du pfx.
  • password string : Le mot de passe du pfx.

SignOptions(string, string, string, string)

Initialise une nouvelle instance de l’objet Documentize.SignOptions avec les fichiers d’entrée, de sortie, le pfx et le mot de passe.

public SignOptions(string inputFile, string outputFile, string pfxFile, string pfxPassword)

Paramètres

  • inputFile string : Le chemin du fichier d’entrée.
  • outputFile string : Le chemin du fichier de sortie.
  • pfxFile string : Le chemin du fichier pfx.
  • pfxPassword string : Le mot de passe du pfx.

SignOptions(Stream, Stream, Stream, string)

Initialise une nouvelle instance de l’objet Documentize.SignOptions avec les flux d’entrée, de sortie, le pfx et le mot de passe.

public SignOptions(Stream inputStream, Stream outputStream, Stream pfxStream, string pfxPassword)

Paramètres

  • inputStream Stream : Le flux du fichier d’entrée.
  • outputStream Stream : Le flux du fichier de sortie.
  • pfxStream Stream : Le flux du fichier pfx.
  • pfxPassword string : Le mot de passe du pfx.

SignOptions(TimestampOptions)

Initialise une nouvelle instance de l’objet Documentize.SignOptions avec les options de timestamp.
Vous pouvez définir le timestamp d’un document comme une signature distincte.

public SignOptions(TimestampOptions timestampOptions)

Paramètres

  • timestampOptions TimestampOptions : Le timestamp utilisé pour créer la signature de timestamp sans nécessiter de certificat.

Propriétés

Contact

Le contact de la signature.

public string Contact { get; set; }

Valeur de la propriété

string

Input

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

public override IData Input { get; set; }

Valeur de la propriété

IData

Location

L’emplacement de la signature.

public string Location { get; set; }

Valeur de la propriété

string

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é

string

Output

Obtient ou définit les données de sortie.

public override IData Output { get; set; }

Valeur de la propriété

IData

PageNumber

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

public int PageNumber { get; set; }

Valeur de la propriété

int

Pfx

Le flux contenant les données PFX.

public Stream Pfx { get; set; }

Valeur de la propriété

Stream

PfxPassword

Le mot de passe du Documentize.SignOptions.Pfx.

public string PfxPassword { get; set; }

Valeur de la propriété

string

Reason

Le motif de la signature.

public string Reason { get; set; }

Valeur de la propriété

string

Rectangle

Le rectangle de la signature.

public Rectangle Rectangle { get; set; }

Valeur de la propriété

Rectangle

TimestampOptions

Options de timestamp.
Les timestamps sont utilisés pour créer la signature de timestamp sans nécessiter de certificat.
Si la propriété est définie et qu’un certificat est fourni au constructeur de la classe Documentize.SignOptions, la signature numérique sera horodatée avec un timestamp intégré.
Si la propriété est définie mais aucun certificat n’est fourni, le timestamp sera ajouté comme une signature distincte.

public TimestampOptions TimestampOptions { get; set; }

Valeur de la propriété

TimestampOptions

Visible

La visibilité de la signature.
La valeur par défaut est true.

public bool Visible { get; set; }

Valeur de la propriété

bool

Namespace : Documentize
Assembly : Documentize.dll

Class SplitOptions

Information

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

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← SplitOptions

Implémente

Membres hérités

Constructeurs

SplitOptions()

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

public SplitOptions()

Espace de noms : Documentize
Assemblage : Documentize.dll

Class Splitter

Information

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

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
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 les instructions pour l’opération.

Retour

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class StreamData

Information

Représente les données de flux pour les opérations de chargement et de sauvegarde.

public sealed class StreamData : IData

Héritage

object ← StreamData

Implémente

Membres hérités

Constructeurs

StreamData(Stream)

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

public StreamData(Stream data)

Paramètres

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 données (flux).

public DataType DataType { get; }

Valeur de la propriété

DataType

Espace de noms : Documentize
Assemblage : 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

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

Propriétés

Data

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

public Stream Data { get; }

Valeur de la Propriété

Stream

DataType

Type de source de données (flux).

public DataType DataType { get; }

Valeur de la Propriété

DataType

Namespace : Documentize Assembly : Documentize.dll

Class StreamResult

Information

Représente le résultat d’une opération sous forme de flux.

public sealed class StreamResult : IOperationResult

Héritage

object ← StreamResult

Implémente

Membres hérités

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.

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

Méthodes

ToFile()

Tente de convertir le résultat en fichier.

public string ToFile()

Retourne

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

ToStream()

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

public Stream ToStream()

Retourne

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

Membres hérités

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.

public bool IsStream { get; }

Valeur de la propriété

bool

IsString

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

public bool IsString { get; }

Valeur de la propriété

bool

Text

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

public string Text { get; }

Valeur de la propriété

string

Méthodes

ToFile()

Tente de convertir le résultat en fichier.

public string ToFile()

Retourne

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

ToStream()

Tente de convertir le résultat en objet flux.

public Stream ToStream()

Retourne

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

ToString()

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

public override string ToString()

Retourne

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

Espace de noms : Documentize
Assembly : Documentize.dll

Class TableBuilder

Information

La classe représente le constructeur d’une table dans une page PDF.

public class TableBuilder

Héritage

object ← TableBuilder

Dérivés

Membres hérités

Méthodes

AddRow()

Ajoute une nouvelle ligne au tableau.

public virtual TableRowBuilder AddRow()

Retourne

TableRowBuilder : Instance du Documentize.TableRowBuilder actuel.

AddTable()

Ajoute un nouveau tableau au document.

public TableBuilder AddTable()

Retourne

TableBuilder : Instance du Documentize.TableBuilder actuel.

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 du Documentize.TableOptions actuel.

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 du Documentize.TableOptions actuel.

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 du Documentize.TableBuilder actuel.

Retourne

TableOptions : Résultat de la conversion en PdfGeneratorTableOptions.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class TableCellBuilder

Information

Classe représente le 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()

Valeur retournée

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 des paragraphes.

Valeur retournée

TableCellBuilder : Instance du Documentize.TableCellBuilder actuel.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class TableGenerator

Information

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

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

Héritage

object ← TableGenerator

Membres hérités

Exemples

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

// Configure table options
var options = new TableOptions().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 FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
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 les instructions pour l’opération.

Retour

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : Documentize Assemblage : Documentize.dll

Class TableOptions

Information

Représente les options pour ajouter un tableau au document via le plugin Documentize.PdfManager.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Héritage

object ← PluginBaseOptions ← TableOptions

Implémente

Membres hérités

Constructeurs

TableOptions()

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

public TableOptions()

Méthodes

AddTable()

Ajoute un tableau au document.

public TableBuilder AddTable()

Renvoie

TableBuilder : Nouvelle instance de Documentize.TableBuilder.

Create()

Crée une instance de Documentize.TableOptions.

public static TableOptions Create()

Renvoie

TableOptions : Nouvelle instance de Documentize.TableOptions.

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 page après laquelle insérer le tableau.

Renvoie

TableOptions : Instance du Documentize.TableOptions actuel.

InsertPageBefore(int)

Insère une page avant la page spécifiée.

public TableOptions InsertPageBefore(int page)

Paramètres

  • page int : Numéro de page avant laquelle insérer le tableau.

Renvoie

TableOptions : Instance du Documentize.TableOptions actuel.

Espace de noms : Documentize
Assemblage : Documentize.dll

Class TableRowBuilder

Information

La classe représente le constructeur d’une ligne de tableau.

public class TableRowBuilder : TableBuilder

Héritage

object ← TableBuilder ← TableRowBuilder

Dérivés

Membres hérités

Méthodes

AddCell()

Ajoute une cellule à la ligne du tableau.

public virtual TableCellBuilder AddCell()

Retour

TableCellBuilder : Instance du Documentize.TableCellBuilder créé.

AddRow()

Remplace la méthode AddRow.

public override TableRowBuilder AddRow()

Retour

TableRowBuilder : Instance du Documentize.TableRowBuilder actuel.

Namespace : Documentize
Assembly : Documentize.dll

Class TextExtractor

Information

Représente le composant Documentize.TextExtractor. Utilisé pour extraire du texte de documents PDF.

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

Héritage

object ← TextExtractor

Membres hérités

Méthodes

Process(ExtractTextOptions)

Extrait du texte du document PDF.

public static string Process(ExtractTextOptions options)

Paramètres

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

Renvoie

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

Exceptions

ArgumentException

Si les options ne sont pas définies.

Espace de noms : 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

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é

List<IDataSource>

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 plug-in Documentize.TiffConverter. Utilisé pour convertir des documents PDF au format TIFF.

[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
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 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.

Espace de noms : Documentize
Assemblage : 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

ArgumentException

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 informations d’authentification de base, le nom d’utilisateur et le mot de passe étant combinés dans une chaîne « username:password ».

Propriétés

BasicAuthCredentials

Obtient ou définit les informations d’authentification de base, le nom d’utilisateur et le mot de passe étant combinés dans une chaîne « username:password ».

public string BasicAuthCredentials { get; set; }

Valeur de la propriété

string

ServerUrl

Obtient ou définit l’URL du serveur de timestamp.

public string ServerUrl { get; set; }

Valeur de la propriété

string

Espace de noms : Documentize
Assemblage : Documentize.dll

Class TocGenerator

Information

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

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

Héritage

object ← TocGenerator

Membres hérités

Exemples

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

// 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 FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

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

// 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 FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

L’exemple montre comment ajouter une table des matières à un fichier PDF et le sauvegarder sous forme de flux.

// 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 FileData("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Perform the process
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.

Renvoie

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Class TocHeading

Information

Représente les options pour les titres ou en-têtes de la table des matières à documenter avec 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 : Utilisation de la génération de numérotation.
  • level int : Le niveau.

Propriétés

GenerateNumbering

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

public bool GenerateNumbering { get; set; }

Valeur de la propriété

bool

Level

Le niveau.
Utilisé pour la génération de numérotation.

public int Level { get; set; }

Valeur de la propriété

int

PageNumber

Le numéro de page pour le lien.

public int PageNumber { get; set; }

Valeur de la propriété

int

Text

Le texte du titre.

public string Text { get; set; }

Valeur de la propriété

string

Espace de noms : Documentize
Assemblage : 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

object ← PluginBaseOptions ← TocOptions

Implémente

Membres hérités

Constructeurs

TocOptions()

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

public TocOptions()

Propriétés

GenerateBookmarks

Utilise la génération de signets.
Si la valeur est true, les signets seront d’abord supprimés puis régénérés à partir des titres ; sinon, les signets ne seront pas modifiés.

public bool GenerateBookmarks { get; set; }

Valeur de la propriété

bool

Headings

Titres ou en-têtes 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é

string

Espace de noms : Documentize
Assembly : Documentize.dll

Class Usage

Information

Statistiques d’utilisation pour la demande de complétion.

public class Usage

Héritage

object ← Usage

Membres hérités

Constructeurs

Usage()

public Usage()

Propriétés

CompletionTokens

Nombre de tokens dans la complétion générée.

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

Valeur de la propriété

int

PromptTokens

Nombre de tokens dans l’invite.

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

Valeur de la propriété

int

TotalTokens

Nombre total de tokens utilisés dans la requête (invite + complétion).

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

Valeur de la propriété

int

Espace de noms : Documentize Assemblage : 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("The class will be deleted soon. Please use PdfConverter class.")]
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 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.

Espace de noms : 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

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é

List<IDataSource>

Nom de l’opération

Renvoie le nom de l’opération

public virtual string OperationName { get; }

Valeur de la propriété

string

Méthodes

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Paramètres

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

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

Information

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

public enum ConvertErrorAction

Fields

  • Delete = 0
  • None = 1

Espace de noms : Documentize
Assemblage : Documentize.dll

Enum ConvertSoftMaskAction

Information

Cette action représente des actions de conversion d’images avec masque doux.

public enum ConvertSoftMaskAction

Fields

  • ConvertToStencilMask = 1 : Le masque doux sera converti en masque 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 du composant.

public enum DataType

Fields

  • Directory = 2: Le type de données est un répertoire représenté par son chemin.
  • File = 0: Le type de données est un fichier représenté par son chemin.
  • 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 le regroupement et l’analyse à plusieurs niveaux pour restaurer l’intention de l’auteur du document original et produire un document le plus éditable possible. L’inconvénient est que le document de sortie peut différer visuellement du fichier PDF d’origine.
  • TextBox = 0 : Ce mode est rapide et permet de préserver au maximum l’apparence originale du fichier PDF, mais l’éditabilité du document résultant peut être limitée. Chaque bloc de texte visuellement groupé dans le PDF d’origine est converti en zone de texte dans le document final. Cela assure une ressemblance maximale du document de sortie avec le PDF original. Le document de sortie sera esthétiquement correct, mais il sera entièrement composé de zones de texte, ce qui peut rendre l’édition ultérieure dans Microsoft Word assez difficile. C’est le mode par défaut.

Espace de noms : Documentize
Assemblage : Documentize.dll

Enum HtmlMediaType

Information

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

public enum HtmlMediaType

Champs

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Enum HtmlPageLayoutOption

Information

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

public enum HtmlPageLayoutOption

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

Information

Spécifie la version du standard PDF/A pour un document PDF.

public enum PdfAStandardVersion

Champs

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

Espace de noms : Documentize
Assembly : Documentize.dll

Enum PdfToHtmlOptions.SaveDataType

Information

Définit le type de sortie du fichier HTML.

public enum PdfToHtmlOptions.SaveDataType

Champs

  • FileWithEmbeddedResources = 1: Enregistre le HTML dans un fichier avec les ressources incorporées
  • FileWithExternalResources = 0: Enregistre le HTML dans un fichier avec les ressources externes
  • StreamWithEmbeddedResources = 2: Enregistre le flux de fichier HTML avec les ressources incorporées

Espace de noms : Documentize
Assemblage : 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.

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

public enum PdfToXlsOptions.ExcelFormat

Fields

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

Espace de noms : 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

Espace de noms : Documentize
Assemblage : Documentize.dll

Enum Rotation

Information

Énumération des valeurs de rotation possibles.

public enum Rotation

Fields

  • None = 0: Non tourné.
  • On180 = 2: Tourné de 180 degrés.
  • On270 = 3: Tourné de 270 degrés dans le sens horaire.
  • On360 = 4: Tourné de 360 degrés dans le sens horaire.
  • On90 = 1: Tourné de 90 degrés dans le sens horaire.

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

Fields

  • Flatten = 2: Représente le contenu PDF avec des fragments de texte positionnés selon leurs coordonnées. C’est essentiellement 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 de lecture.
  • Pure = 0: Représente le contenu texte du 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.

Espace de noms : Documentize Assemblage : Documentize.dll

Enum TiffColorDepth

Information

Utilisé pour spécifier la profondeur de couleur pour Documentize.PdfToTiffOptions.

public enum TiffColorDepth

Fields

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Enum TiffCompression

Information

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

public enum TiffCompression

Fields

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

Espace de noms : Documentize
Assemblage : Documentize.dll

Interface IData

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 IData

Propriétés

DataType

Type de source de données.

DataType DataType { get; }

Valeur de la propriété

DataType

Espace de noms : Documentize
Assemblage : 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é

DataType

Namespace : Documentize Assembly : Documentize.dll

Interface IHaveInput

Information

Interface de données générale qui définit les données d’entrée que les Options doivent implémenter.

public interface IHaveInput

Propriétés

Input

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

IData Input { get; set; }

Valeur de la propriété

IData

Espace de noms : Documentize
Assemblage : Documentize.dll

Interface IOperationResult

Information

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

public interface IOperationResult

Properties

Data

Obtient les données brutes.

object Data { get; }

Property Value

object

IsFile

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

bool IsFile { get; }

Property Value

bool

IsStream

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

bool IsStream { get; }

Property Value

bool

IsString

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

bool IsString { get; }

Property Value

bool

Methods

ToFile()

Essaie de convertir le résultat en fichier.

string ToFile()

Returns

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.

Stream ToStream()

Returns

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

Espace de noms: Documentize
Assemblage: Documentize.dll

Interface IPluginOptions

Information

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

public interface IPluginOptions

Espace de noms : Documentize
Assembly : Documentize.dll

 Français