Documentize Namespace

Classes

Class NameDescription
AddTimestampOptionsRepresents Add Timestamp Options for Documentize.Timestamp plugin.
ChatCompletionRepresents a chat completion response returned by model, based on the provided input.
ChatGptConstsThis class represents a storage for constants.
ChatGptRequestOptionsRepresents options for Documentize.PdfManager plugin.
ChoiceA chat completion choice.
CompressOptionsRepresents Compress options for Documentize.PdfManager plugin.
DecryptOptionsRepresents Decrypt Options for Documentize.PdfSecurity plugin.
DirectoryDataSourceRepresents directory data for load and save operations of a plugin.
DocConverterRepresents Documentize.DocConverter plugin. Used to convert PDF documents into DOC/DOCX format.
EncryptOptionsRepresents Encrypt Options for Documentize.PdfSecurity plugin.
ExtractFormDataToDsvOptionsRepresents options for export values of fields for Documentize.PdfExtractor plugin.
ExtractImagesOptionsRepresents images extraction options for the Documentize.PdfExtractor plugin.
ExtractTextOptionsRepresents text extraction options for the Documentize.PdfExtractor plugin.
FileDataSourceRepresents file data for load and save operations of a plugin.
FileResultRepresents operation result in the form of string path to file.
FormExporterRepresents Documentize.FormExporter plugin. Used to Export Form values of PDF documents to DSV or CSV file.
FormFlattenerRepresents Documentize.FormFlattener plugin. Used to Flatten fields in PDF documents.
FormFlattenerOptionsRepresents options for Flatten Fields in document by Documentize.FormFlattener plugin.
HtmlConverterRepresents Documentize.HtmlConverter plugin. Used to convert PDF documents into HTML format and HTML documents into PDF format.
HtmlToPdfOptionsRepresents HTML to PDF converter options for Documentize.PdfConverter plugin.
ImageExtractorRepresents Documentize.ImageExtractor plugin. Used to extract images from PDF documents.
InfoThe class provides information about current product build.
JpegConverterRepresents Documentize.JpegConverter plugin. Used to convert PDF documents into JPEG format.
LicenseProvides method to set License.
MergeOptionsRepresents Merge options for Documentize.PdfManager plugin.
MergerRepresents Documentize.Merger plugin. Used to merge multiple PDF documents into a single PDF.
MessageA chat completion message generated by the model.
ObjectResultRepresents operation result in the form of string.
OptimizeOptionsRepresents Optimize options for Documentize.PdfManager plugin.
OptimizerRepresents Documentize.Optimizer plugin. Used to Optimize, Rotate, Resize, Compress PDF documents.
PageInfoRepresents the page information.
PageSizeClass representing size of page in PDF document.
PdfAConverterRepresents a plugin for handling the conversion of PDF documents in a PDF/A format and for validation of the PDF/A conformance.
PdfAOptionsBaseRepresents the base class for the Documentize.PdfAConverter plugin options. This class provides properties and methods for configuring the PDF/A conversion and validation process.
PdfAValidateOptionsRepresents options for validating PDF/A compliance of PDF documents with the Documentize.PdfConverter plugin.
PdfAValidationResultRepresents the result of a PDF/A validation process.
PdfChatGptRepresents PdfChatGpt plugin.
PdfConverterRepresents Documentize.PdfConverter plugin. Used to Convert PDF documents to another formats like DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Also allows you to perform PDF/A Validation and Convert HTML to PDF.
PdfConverterOptionsRepresents options for Pdf converter plugins.
PdfExtractorRepresents Documentize.PdfExtractor plugin. Used to Extract Text, Images, Form Data from PDF documents.
PdfManagerRepresents Documentize.PdfManager plugin. Used to Merge, Split, Optimize, Rotate, Resize, Compress PDF documents and Add Table, Add TOC to PDF documents. Can Merge multiple PDF documents into a single PDF. Can Split PDF documents into separate pages. Can Optimize, Rotate, Resize, Compress PDF documents. Can Rotate, Resize Pages of PDF document. Can Add a Table to a PDF document. Can Add a Table of Contents to PDF document.
PdfSecurityRepresents Documentize.PdfSecurity plugin. Used to Encrypt, Decrypt and Sign PDF documents.
PdfToDocOptionsRepresents PDF to DOC converter options for Documentize.PdfConverter plugin.
PdfToHtmlOptionsRepresents PDF to HTML converter options for Documentize.PdfConverter plugin.
PdfToJpegOptionsRepresents PDF to JPEG converter options for the Documentize.PdfConverter plugin.
PdfToPdfAOptionsRepresents options for converting PDF documents to PDF/A format with the Documentize.PdfConverter plugin.
PdfToPngOptionsRepresents PDF to PNG converter options for the Documentize.PdfConverter plugin.
PdfToTiffOptionsRepresents PDF to TIFF converter options for the Documentize.PdfConverter plugin.
PdfToXlsOptionsRepresents PDF to XLS/XLSX converter options for Documentize.PdfConverter plugin.
PluginBaseOptionsRepresents base options for plugins.
PngConverterRepresents Documentize.PngConverter plugin. Used to convert PDF documents into PNG format.
RectangleClass represents rectangle.
ResizeOptionsRepresents Resize options for Documentize.PdfManager plugin.
ResultContainerRepresents container that contains the result collection of processing the plugin.
RotateOptionsRepresents Rotate options for Documentize.PdfManager plugin.
SecurityRepresents Documentize.Security plugin. Used to encrypt and decrypt PDF documents.
SignOptionsRepresents Sign Options for Documentize.PdfSecurity plugin.
SignatureRepresents Documentize.Signature plugin. Used to Sign PDF documents.
SplitOptionsRepresents Split options for Documentize.PdfManager plugin.
SplitterRepresents Documentize.Splitter plugin. Used to Split PDF documents into separate pages.
StreamDataSourceRepresents stream data source for load and save operations of a plugin.
StreamResultRepresents operation result in the form of Stream.
StringResultRepresents operation result in the form of string.
TableBuilderClass represents builder for table in pdf page.
TableCellBuilderClass represents builder for table cell.
TableGeneratorRepresents Documentize.TableGenerator plugin. Used to add a table to a PDF document.
TableOptionsRepresents options for add table to document by Documentize.PdfManager plugin.
TableRowBuilderClass represents builder for table row.
TextExtractorRepresents Documentize.TextExtractor plugin. Used to extract text from PDF documents.
TiffConverterRepresents Documentize.TiffConverter plugin. Used to convert PDF documents into TIFF format.
TimestampRepresents Documentize.Timestamp plugin. Used to add Timestamp to a document.
TimestampOptionsTocGenerator Represents Documentize.TocGenerator plugin. Used to add a Table of Contents to PDF documents.
TocHeadingRepresents options for Headings or Titles of Table of Contents to document by Documentize.PdfManager plugin.
TocOptionsRepresents options for add Table of Contents to document by Documentize.PdfManager plugin.
UsageUsage statistics for the completion request.
XlsConverterRepresents Documentize.XlsConverter plugin. Used to convert PDF documents into XLSX/XLS/CSV/XLSM/ODS formats.

Interfaces

Interface NameDescription
IDataSourceGeneral data interface that defines common members that concrete data should implement.
IOperationResultGeneral operation result interface that defines common methods that concrete plugin operation result should implement.
IPluginOptionsGeneral plugin option interface that defines common methods that concrete plugin option should implement.

Enums

Enum NameDescription
ConvertErrorActionThis class represents action for conversion errors.
ConvertSoftMaskActionThis action represents actions for conversion of images with soft mask.
DataTypeRepresents possible types of data for plugin processing.
DocConversionModeDefines conversion mode of the output document.
PdfToXlsOptions.ExcelFormatAllows to specify xls/xlsx/xml/csv file format. Default value is XLSX.
HtmlMediaTypeSpecifies possible media types used during rendering.
HtmlPageLayoutOptionSpecifies flags that together other options determine sizes and layouts of pages.
PdfAStandardVersionSpecifies the PDF/A standard version for a PDF document.
RoleThe role of the messages author.
RotationEnumeration of possible rotation values.
PdfToHtmlOptions.SaveDataTypeDefines output type of HTML file.
TextFormattingModeDefines different modes which can be used while converting a PDF document into text. See Documentize.ExtractTextOptions class.
TiffColorDepthUsed to specify the Color Depth for the Documentize.PdfToTiffOptions.
TiffCompressionUsed to specify the Compression type for the Documentize.PdfToTiffOptions.

Documentize Namespaceのサブセクション

Class AddTimestampOptions

情報

Documentize.Timestampプラグインのためのタイムスタンプオプションを表します。

[Obsolete("このクラスはすぐに削除されます。SignOptionsクラスを使用してください。")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsAddTimestampOptions

実装

継承されたメンバー

コンストラクター

AddTimestampOptions(Stream, string, string, string)

デフォルトオプションでDocumentize.AddTimestampOptionsオブジェクトの新しいインスタンスを初期化します。

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

パラメーター

  • pfx Stream: pfxファイルへのパス。
  • password string: pfxファイルのパスワード。
  • serverUrl string: タイムスタンプサーバーのURL。
  • serverBasicAuthCredentials string: ベーシック認証の資格情報で、ユーザー名とパスワードが「username:password」という文字列に組み合わされています。(オプション)。

AddTimestampOptions(string, string, string, string)

デフォルトオプションでDocumentize.AddTimestampOptionsオブジェクトの新しいインスタンスを初期化します。

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

パラメーター

  • pfx string: pfxファイルへのパス。
  • password string: pfxファイルのパスワード。
  • serverUrl string: タイムスタンプサーバーのURL。
  • serverBasicAuthCredentials string: ベーシック認証の資格情報で、ユーザー名とパスワードが「username:password」という文字列に組み合わされています。(オプション)。

名前空間: Documentize アセンブリ: Documentize.dll

Class ChatCompletion

情報

提供された入力に基づいてモデルから返されるチャット完了レスポンスを表します。

public class ChatCompletion

継承

objectChatCompletion

継承されたメンバー

コンストラクタ

ChatCompletion()

public ChatCompletion()

プロパティ

Choices

チャット完了の選択肢のリスト。n が 1 より大きい場合は複数になることがあります。

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

プロパティの値

List<Choice>

Created

チャット完了が作成された時刻の Unix タイムスタンプ(秒単位)。

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

プロパティの値

long

Id

チャット完了の一意の識別子。

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

プロパティの値

string

Model

チャット完了に使用されるモデル。

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

プロパティの値

string

Object

オブジェクトの種類であり、常に chat.completion です。

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

プロパティの値

string

SystemFingerprint

このフィンガープリントは、モデルが実行されるバックエンド設定を表します。

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

プロパティの値

string

Usage

完了リクエストの使用統計。

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

プロパティの値

Usage

名前空間: Documentize アセンブリ: Documentize.dll

Class ChatGptConsts

情報

このクラスは定数のストレージを表します。

public static class ChatGptConsts

継承

objectChatGptConsts

継承されたメンバー

フィールド

  • ApiUrl

フィールドの値

string

ModelName

public static string ModelName

フィールドの値

string

SystemRole

public static string SystemRole

フィールドの値

string

SystemRoleDescription

public static string SystemRoleDescription

フィールドの値

string

UserRole

public static string UserRole

フィールドの値

string

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptRequestOptions

情報

Documentize.PdfManagerプラグインのオプションを表します。

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsChatGptRequestOptions

実装

継承メンバー

コンストラクタ

ChatGptRequestOptions()

Documentize.ChatGptRequestOptionsオブジェクトの新しいインスタンスをデフォルトのオプションで初期化します。

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

オプションを指定してDocumentize.ChatGptRequestOptionsオブジェクトの新しいインスタンスを初期化します。

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

パラメータ

プロパティ

ApiKey

ChatGPT APIにアクセスするためのキーを取得または設定します。

public string ApiKey { get; set; }

プロパティ値

string

ApiUrl

ChatGPT APIのURLを取得または設定します。

public string ApiUrl { get; set; }

プロパティ値

string

CancellationToken

キャンセルトークン。

public CancellationToken CancellationToken { get; set; }

プロパティ値

CancellationToken

MaxTokens

応答の最大トークン数。 デフォルト値はnullで、無限を意味します。

public int? MaxTokens { get; set; }

プロパティ値

int?

Messages

Documentize.Messageオブジェクトのコレクションを取得または設定します。

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

プロパティ値

List<Message>

備考

オプションに複数のメッセージを追加する場合、メッセージのコレクション内の順序は次のとおりです:

  • 最初のメッセージ(あれば)はoptions.Queryからで、内容は「あなたは役に立つアシスタントです。」とされ、役割は「system」になります。
  • 次に(あれば)、options.Messagesコレクションからメッセージが追加されます。
  • ファイルソースからのメッセージ(あれば)が最後に追加されます。「user」役割の各ドキュメントに対して1つのメッセージオブジェクトが必要です。 いずれのメッセージも提供されない場合、ArgumentExceptionがスローされます。

Model

使用するモデルのIDを取得または設定します。

public string Model { get; set; }

プロパティ値

string

NumberOfChoices

各入力メッセージに対して生成するチャット完了の選択肢の数。

public int NumberOfChoices { get; set; }

プロパティ値

int

Query

ChatGPTへの文字列リクエストを取得または設定します。 空でない場合、コレクション内の最初のメッセージになり、 リクエストに送信されます。

public string Query { get; set; }

プロパティ値

string

Temperature

使用するサンプリング温度。0から2の間で設定します。 0.8のような高い値は出力をよりランダムにし、 0.2のような低い値はより焦点を絞った決定論的な出力を生成します。 デフォルト値は1です。

public double Temperature { get; set; }

プロパティ値

double

Namespace: Documentize Assembly: Documentize.dll

Class CompressOptions

情報

Documentize.PdfManager プラグインの圧縮オプションを表します。

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions  

継承

object
PluginBaseOptions
CompressOptions

実装

継承メンバー

コンストラクタ

CompressOptions()

Documentize.CompressOptions オブジェクトの新しいインスタンスをデフォルトオプションで初期化します。

public CompressOptions()  

名前空間: Documentize
アセンブリ: Documentize.dll

Class DecryptionOptions

情報

Documentize.Securityプラグインの復号化オプションを表します。

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsDecryptionOptions

実装

継承メンバー

コンストラクター

DecryptionOptions(string)

デフォルトオプションを使用してDocumentize.DecryptionOptionsオブジェクトの新しいインスタンスを初期化します。

public DecryptionOptions(string ownerPassword)

パラメーター

  • ownerPassword string: オーナーパスワード。

プロパティ

OwnerPassword

オーナーパスワード。

public string OwnerPassword { get; set; }

プロパティ値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class DecryptOptions

情報

Documentize.PdfSecurityプラグインの復号オプションを表します。

public class DecryptOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsDecryptOptions

実装

継承メンバー

コンストラクター

DecryptOptions(string)

デフォルトオプションでDocumentize.DecryptOptionsオブジェクトの新しいインスタンスを初期化します。

public DecryptOptions(string ownerPassword)

パラメーター

  • ownerPassword string: オーナーパスワード。

プロパティ

OwnerPassword

オーナーパスワード。

public string OwnerPassword { get; set; }

プロパティの値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class DirectoryDataSource

情報

プラグインのロードおよび保存操作のためのディレクトリデータを表します。

public sealed class DirectoryDataSource : IDataSource

継承

objectDirectoryDataSource

実装

継承メンバー

コンストラクター

DirectoryDataSource(string)

指定されたパスで新しいディレクトリデータを初期化します。

public DirectoryDataSource(string path)

パラメーター

  • path string: ディレクトリへのパスを表す文字列。

プロパティ

DataType

データソースの種類。

public DataType DataType { get; }

プロパティ値

DataType

Path

現在のデータのディレクトリへのパスを取得します。

public string Path { get; }

プロパティ値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class DocConverter

情報

Documentize.DocConverter プラグインを表します。PDF ドキュメントを DOC/DOCX 形式に変換するために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfConverter クラスを使用してください。")]
public static class DocConverter

継承

objectDocConverter

継承されたメンバー

メソッド

Process(PdfToDocOptions)

PDF ドキュメントを DOC/DOCX 形式に変換します。

public static ResultContainer Process(PdfToDocOptions options)

パラメーター

  • options PdfToDocOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Namespace: Documentize Assembly: Documentize.dll

Class EncryptionOptions

情報

Documentize.Securityプラグインの暗号化オプションを表します。

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsEncryptionOptions

Implements

Inherited Members

Constructors

EncryptionOptions(string, string)

Documentize.EncryptionOptionsオブジェクトの新しいインスタンスをデフォルトオプションで初期化します。

public EncryptionOptions(string ownerPassword, string userPassword)

Parameters

  • ownerPassword string: 所有者のパスワード。
  • userPassword string: ユーザーのパスワード。

Properties

OwnerPassword

所有者のパスワード。

public string OwnerPassword { get; set; }

Property Value

string

UserPassword

ユーザーのパスワード。

public string UserPassword { get; set; }

Property Value

string

Namespace: Documentize Assembly: Documentize.dll

Class EncryptOptions

情報

Documentize.PdfSecurityプラグインの暗号化オプションを表します。

public class EncryptOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsEncryptOptions

実装

継承メンバー

コンストラクター

EncryptOptions(string, string)

デフォルトオプションでDocumentize.EncryptOptionsオブジェクトの新しいインスタンスを初期化します。

public EncryptOptions(string ownerPassword, string userPassword)

パラメーター

  • ownerPassword string: オーナーパスワード。
  • userPassword string: ユーザーパスワード。

プロパティ

OwnerPassword

オーナーパスワード。

public string OwnerPassword { get; set; }

プロパティの値

string

UserPassword

ユーザーパスワード。

public string UserPassword { get; set; }

プロパティの値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class ExtractFormDataToDsvOptions

情報

Documentize.PdfExtractorプラグインのフィールドのエクスポート値のオプションを表します。

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsExtractFormDataToDsvOptions

実装

継承されたメンバー

コンストラクタ

ExtractFormDataToDsvOptions(char, bool)

Documentize.ExtractFormDataToDsvOptionsオブジェクトの新しいインスタンスを初期化します。

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

パラメーター

  • delimeter char: エクスポートされるデータ内の値間で使用される区切り文字を指定します。デフォルト値は’,‘です。
  • addFieldNames bool: 値の前にフィールド名を追加します。フォーマット: 名前 + 区切り文字 + 値 + 区切り文字。

プロパティ

AddFieldName

値の前にフィールド名を追加します。 フォーマット: 名前 + 区切り文字 + 値 + 区切り文字。

public bool AddFieldName { get; set; }

プロパティ値

bool

Delimeter

エクスポートされた値に使用される区切り文字。

public char Delimeter { get; set; }

プロパティ値

char

名前空間: Documentize アセンブリ: Documentize.dll

Class ExtractImagesOptions

情報

Documentize.PdfExtractorプラグインの画像抽出オプションを表します。

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsExtractImagesOptions

実装

継承されたメンバー

コンストラクタ

ExtractImagesOptions()

デフォルトのオプションでDocumentize.ExtractImagesOptionsオブジェクトの新しいインスタンスを初期化します。

public ExtractImagesOptions()

ネームスペース: Documentize アセンブリ: Documentize.dll

Class ExtractTextOptions

情報

Documentize.PdfExtractorプラグインのテキスト抽出オプションを表します。

public sealed class ExtractTextOptions

継承

objectExtractTextOptions

継承メンバー

コンストラクタ

ExtractTextOptions(TextFormattingMode)

指定されたテキストフォーマットモードのために、Documentize.ExtractTextOptionsオブジェクトの新しいインスタンスを初期化します。

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

パラメータ

プロパティ

FormattingMode

フォーマットモードを取得します。

public TextFormattingMode FormattingMode { get; set; }

プロパティ値

TextFormattingMode

Inputs

操作のためのInputsデータを返します。

public List<idatasource> Inputs { get; }

プロパティ値

List<IDataSource>

メソッド

AddInput(IDataSource)

Inputsに新しいデータを追加します。

public void AddInput(IDataSource dataSource)

パラメータ

  • dataSource IDataSource: 追加するデータソース。 :

Namespace: Documentize Assembly: Documentize.dll

Class FileDataSource

情報

プラグインのロードおよび保存操作に対するファイルデータを表します。

public sealed class FileDataSource : IDataSource

継承

objectFileDataSource

実装

継承メンバー

コンストラクタ

FileDataSource(string)

指定されたパスの新しいファイルデータソースを初期化します。

public FileDataSource(string path)

パラメータ

  • path string: ソースファイルへのパスを表す文字列。

プロパティ

DataType

データソースの種類。

public DataType DataType { get; }

プロパティの値

DataType

Path

現在のデータのファイルへのパスを取得します。

public string Path { get; }

プロパティの値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class FileResult

情報

ファイルへの文字列パスの形で操作結果を表します。

public sealed class FileResult : IOperationResult

継承

objectFileResult

実装

継承メンバー

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティ値

object

IsFile

結果が出力ファイルへのパスであるかどうかを示します。

public bool IsFile { get; }

プロパティ値

bool

IsStream

結果が出力ストリームであるかどうかを示します。

public bool IsStream { get; }

プロパティ値

bool

IsString

結果がテキスト文字列であるかどうかを示します。

public bool IsString { get; }

プロパティ値

bool

メソッド

ToFile()

結果をファイルに変換しようとします。

public string ToFile()

戻り値

string : 結果がファイルである場合、出力ファイルへのパスを表す文字列。それ以外の場合は null

ToStream()

結果をストリームオブジェクトに変換しようとします。

public Stream ToStream()

戻り値

Stream : 結果がストリームである場合、出力データを表すストリームオブジェクト。それ以外の場合は null

名前空間: Documentize アセンブリ: Documentize.dll

Class FormExportToDsvOptions

情報

Documentize.FormExporterプラグインのフィールドの値をエクスポートするためのオプションを表します。

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsFormExportToDsvOptions

実装

継承されたメンバー

コンストラクタ

FormExportToDsvOptions(char, bool)

Documentize.FormExportToDsvOptionsオブジェクトの新しいインスタンスを初期化します。

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

パラメーター

  • delimeter char: エクスポートされたデータの値の間で使用されるデリミターを指定します。デフォルト値は’,‘です。
  • addFieldNames bool: 値の前にフィールド名を追加します。形式: 名前 + デリミター + 値 + デリミター。

プロパティ

AddFieldName

値の前にフィールド名を追加します。 形式: 名前 + デリミター + 値 + デリミター。

public bool AddFieldName { get; set; }

プロパティの値

bool

Delimeter

エクスポートされた値に使用されるデリミター。

public char Delimeter { get; set; }

プロパティの値

char

名前空間: Documentize アセンブリ: Documentize.dll

Class FormFlattener

情報

Documentize.FormFlattener プラグインを表します。PDF ドキュメント内のフィールドをフラット化するために使用されます。

public static class FormFlattener

継承

objectFormFlattener

継承メンバー

この例は、PDF ファイル内のフィールドをフラット化する方法を示しています。

// 手順を設定するために FormFlattenerOptions オブジェクトを作成
var options = new FormFlattenerOptions();
// 入力ファイルのパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルのパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
FormFlattener.Process(options);

この例は、PDF ファイル内のフィールドをフラット化し、最初のフィールドをスキップする方法を示しています。

// フィールド名を取得
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// 手順を設定するために FormFlattenerOptions オブジェクトを作成
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 1 つのフィールドをスキップ
options.SkipFields.Add(fieldNames[0]);
// 処理を実行
FormFlattener.Process(options);

この例は、PDF ファイルからフィールド名を取得する方法を示しています。

// フィールド名を取得
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

メソッド

GetFieldNames(string)

PDF ドキュメント内のフィールド名を取得します。

public static List<string> GetFieldNames(string path)

パラメーター

  • path string: PDF ドキュメントのパス。

戻り値

List<string>

PDF ドキュメント内の名前のリスト。

GetFieldNames(Stream) : PDF ドキュメント内のフィールド名を取得します。

public static List<string> GetFieldNames(Stream stream)

パラメーター

  • stream Stream: PDF ドキュメントを含むストリーム。

戻り値

List<string>

PDF ドキュメント内の名前のリスト。

Process(FormFlattenerOptions) : PDF ドキュメントのフォームフィールドをフラット化します。

public static ResultContainer Process(FormFlattenerOptions options)

パラメーター

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class FormFlattenerOptions

情報

Documentize.FormFlattener プラグインによるドキュメント内のフィールドをフラット化するためのオプションを表します。

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsFormFlattenerOptions

実装

継承メンバー

コンストラクター

FormFlattenerOptions()

デフォルトのオプションで Documentize.FormFlattenerOptions オブジェクトの新しいインスタンスを初期化します。

public FormFlattenerOptions()

プロパティ

SkipFields

フラット化しないフィールドのリストです。

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

プロパティの値

List<string>

名前空間: Documentize アセンブリ: Documentize.dll

Class HtmlConverter

情報

Documentize.HtmlConverterプラグインを表します。PDFドキュメントをHTML形式に変換し、HTMLドキュメントをPDF形式に変換するために使用されます。

[Obsolete("このクラスは近日中に削除されます。PdfConverterクラスを使用してください。")]
public static class HtmlConverter

継承

objectHtmlConverter

継承メンバー

メソッド

Process(PdfToHtmlOptions)

PDFドキュメントをHTML形式に変換します。

public static ResultContainer Process(PdfToHtmlOptions options)

パラメータ

  • options PdfToHtmlOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Process(HtmlToPdfOptions)

HTMLドキュメントをPDF形式に変換します。

public static ResultContainer Process(HtmlToPdfOptions options)

パラメータ

  • options HtmlToPdfOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class HtmlToPdfOptions

情報

Documentize.PdfConverterプラグインのHTMLからPDFへの変換オプションを表します。

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsHtmlToPdfOptions

実装

継承されたメンバー

コンストラクタ

HtmlToPdfOptions()

Documentize.HtmlToPdfOptionsオブジェクトの新しいインスタンスを初期化します。

public HtmlToPdfOptions()

プロパティ

BasePath

HTMLファイルの基本パス/URLです。

public string BasePath { get; set; }

プロパティ値

string

HtmlMediaType

レンダリング中に使用される可能性のあるメディアタイプを取得または設定します。

public HtmlMediaType HtmlMediaType { get; set; }

プロパティ値

HtmlMediaType

IsRenderToSinglePage

すべてのドキュメントを単一ページにレンダリングするかどうかを取得または設定します。

public bool IsRenderToSinglePage { get; set; }

プロパティ値

bool

PageInfo

ドキュメントページ情報を取得または設定します。

public PageInfo PageInfo { get; set; }

プロパティ値

PageInfo

PageLayoutOption

レイアウトオプションを取得または設定します。

public HtmlPageLayoutOption PageLayoutOption { get; set; }

プロパティ値

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

情報

Documentize.ImageExtractorプラグインを表します。PDFドキュメントから画像を抽出するために使用されます。

[Obsolete("このクラスはすぐに削除されます。PdfExtractorクラスを使用してください。")]
public static class ImageExtractor

継承

objectImageExtractor

継承されたメンバー

メソッド

Process(ExtractImagesOptions)

PDFドキュメントから画像を抽出します。

public static ResultContainer Process(ExtractImagesOptions options)

パラメーター

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

optionsが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class ImageExtractorOptions

情報

Documentize.ImageExtractorプラグイン用の画像抽出オプションを表します。

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsImageExtractorOptions

実装

継承されたメンバー

コンストラクター

ImageExtractorOptions()

デフォルトオプションでDocumentize.ImageExtractorOptionsオブジェクトの新しいインスタンスを初期化します。

public ImageExtractorOptions()

名前空間: Documentize アセンブリ: Documentize.dll

Class JpegConverter

情報

Documentize.JpegConverter プラグインを表します。 PDF ドキュメントを JPEG 形式に変換するために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfConverter クラスを使用してください。")]
public static class JpegConverter

継承

objectJpegConverter

継承メンバー

メソッド

Process(PdfToJpegOptions)

PDF ドキュメントを JPEG 形式に変換します。

public static ResultContainer Process(PdfToJpegOptions options)

パラメーター

  • options PdfToJpegOptions: Documentize.JpegConverter のための指示を含むオプションオブジェクトです。

返り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

情報

Documentize.PdfManagerプラグインのマージオプションを表します。

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsMergeOptions

実装

継承されたメンバー

コンストラクタ

MergeOptions()

Documentize.MergeOptionsオブジェクトの新しいインスタンスをデフォルトオプションで初期化します。

public MergeOptions()

名前空間: Documentize アセンブリ: Documentize.dll

Class Merger

情報

Documentize.Mergerプラグインを表します。複数のPDFドキュメントを1つのPDFに統合するために使用されます。

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

継承

objectMerger

継承されたメンバー

メソッド

Process(MergeOptions)

PDFドキュメントを統合します。

public static ResultContainer Process(MergeOptions options)

パラメーター

  • options MergeOptions: 操作の指示を含むオプションオブジェクトです。

返り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Namespace: Documentize Assembly: Documentize.dll

Class ObjectResult

情報

文字列形式の操作結果を表します。

public sealed class ObjectResult : IOperationResult

継承

objectObjectResult

実装

継承メンバー

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティの値

object

IsFile

結果が出力ファイルへのパスであるかどうかを示します。

public bool IsFile { get; }

プロパティの値

bool

IsObject

結果がオブジェクトであるかどうかを示します。

public bool IsObject { get; }

プロパティの値

bool

IsStream

結果が出力ファイルへのパスであるかどうかを示します。

public bool IsStream { get; }

プロパティの値

bool

IsString

結果が文字列であるかどうかを示します。

public bool IsString { get; }

プロパティの値

bool

Text

結果の文字列表現を返します。

public string Text { get; }

プロパティの値

string

メソッド

ToFile()

結果をファイルに変換しようとします。

public string ToFile()

戻り値

string : 結果がファイルの場合、出力ファイルへのパスを表す文字列;そうでない場合は null

ToStream()

結果をストリームオブジェクトに変換しようとします。

public Stream ToStream()

戻り値

Stream : 結果がストリームの場合、出力データを表すストリームオブジェクト;そうでない場合は null

ToString()

結果を文字列に変換しようとします。

public override string ToString()

戻り値

string : 結果が文字列の場合、テキストコンテンツを表す文字列;そうでない場合は base.ToString() を返します。

Namespace: Documentize Assembly: Documentize.dll

Class OptimizeOptions

情報

Documentize.PdfManagerプラグインの最適化オプションを表します。

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsOptimizeOptions

実装

継承メンバー

コンストラクタ

OptimizeOptions()

デフォルトオプションでDocumentize.OptimizeOptionsオブジェクトの新しいインスタンスを初期化します。 文書を線形化して次のことを実現します。

  • できるだけ早く最初のページを開く。
  • 次のページをできるだけ早く表示するか、次のページへのリンクに従う。
  • ページのデータが遅いチャンネルで配信される場合、到着するにつれてページを段階的に表示する(最も有用なデータを最初に表示する)。
  • ユーザーが全ページを受信して表示する前に、リンクに従うなどの対話を行えるようにする。
public OptimizeOptions()

名前空間: Documentize アセンブリ: Documentize.dll

Class Optimizer

情報

Documentize.Optimizerプラグインを表します。PDF文書の最適化、回転、サイズ変更、圧縮に使用されます。

[Obsolete("このクラスはすぐに削除されます。PdfManagerクラスを使用してください。")]
public static class Optimizer

継承

objectOptimizer

継承メンバー

メソッド

Process(OptimizeOptions)

指定されたパラメータでDocumentize.Optimizer処理を開始します。

public static ResultContainer Process(OptimizeOptions options)

パラメータ

  • options OptimizeOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

Process(RotateOptions)

指定されたパラメータでDocumentize.Optimizer処理を開始します。

public static ResultContainer Process(RotateOptions options)

パラメータ

  • options RotateOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

Process(ResizeOptions)

指定されたパラメータでDocumentize.Optimizer処理を開始します。

public static ResultContainer Process(ResizeOptions options)

パラメータ

  • options ResizeOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

Process(CompressOptions)

指定されたパラメータでDocumentize.Optimizer処理を開始します。

public static ResultContainer Process(CompressOptions options)

パラメータ

  • options CompressOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

名前空間: Documentize アセンブリ: Documentize.dll

Class PageInfo

情報

ページ情報を表します。

public class PageInfo : PageSize

継承

objectPageSizePageInfo

継承されたメンバー

コンストラクター

PageInfo()

Documentize.PageInfoのコンストラクター。

public PageInfo()

PageInfo(double, double)

Documentize.PageInfoのコンストラクター。

public PageInfo(double width, double height)

パラメーター

  • width double: ページの幅。
  • height double: ページの高さ。

プロパティ

MarginBottom

下余白を示す値を取得または設定します。

public double MarginBottom { get; set; }

プロパティ値

double

MarginLeft

左余白を示す値を取得または設定します。

public double MarginLeft { get; set; }

プロパティ値

double

MarginRight

右余白を示す値を取得または設定します。

public double MarginRight { get; set; }

プロパティ値

double

MarginTop

上余白を示す値を取得または設定します。

public double MarginTop { get; set; }

プロパティ値

double

名前空間: Documentize アセンブリ: Documentize.dll

Class PageSize

情報

PDF ドキュメントにおけるページのサイズを表すクラス。

public class PageSize

継承

objectPageSize

派生

継承されたメンバー

コンストラクター

PageSize()

Documentize.PageSize のコンストラクター。デフォルトでは A4 サイズ。

public PageSize()

PageSize(double, double)

Documentize.PageSize のコンストラクター。

public PageSize(double width, double height)

パラメーター

  • width double: ページの幅。
  • height double: ページの高さ。

プロパティ

A0

A0 サイズ (1189x840 mm)。

public static PageSize A0 { get; }

プロパティ値

PageSize

A1

A1 サイズ (840x594 mm)。

public static PageSize A1 { get; }

プロパティ値

PageSize

A2

A2 サイズ (594x420 mm)。

public static PageSize A2 { get; }

プロパティ値

PageSize

A3

A3 サイズ (420x297 mm)。

public static PageSize A3 { get; }

プロパティ値

PageSize

A4

A4 サイズ (297x210 mm)。

public static PageSize A4 { get; }

プロパティ値

PageSize

A5

A5 サイズ (210x148 mm)。

public static PageSize A5 { get; }

プロパティ値

PageSize

A6

A6 サイズ (148x105 mm)。

public static PageSize A6 { get; }

プロパティ値

PageSize

B5

B5 サイズ (250x176 mm)。

public static PageSize B5 { get; }

プロパティ値

PageSize

Height

ページの高さを取得または設定します。

public double Height { get; set; }

プロパティ値

double

IsLandscape

ページの向きを取得します。横向きの場合は true を、縦向きの場合は false を返します。

public bool IsLandscape { get; }

プロパティ値

bool

P11x17

11x17 インチ形式。

public static PageSize P11x17 { get; }

プロパティ値

PageSize

PageLedger

レジャーサイズ (432x279 mm)。

public static PageSize PageLedger { get; }

プロパティ値

PageSize

リーガルサイズ (356x216 mm)。

public static PageSize PageLegal { get; }

プロパティ値

PageSize

PageLetter

レターサイズ (279x216 mm)。

public static PageSize PageLetter { get; }

プロパティ値

PageSize

Width

ページの幅を取得または設定します。

public double Width { get; set; }

プロパティ値

double

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

情報

PDF/A形式のPDF文書の変換およびPDF/A準拠の検証を処理するためのプラグインを表します。

[Obsolete("このクラスは近々削除されます。PdfConverterクラスを使用してください。")]
public static class PdfAConverter

継承

objectPdfAConverter

継承メンバー

メソッド

Process(PdfToPdfAOptions)

PDF文書をPDF/A形式に変換します。

public static ResultContainer Process(PdfToPdfAOptions options)

パラメータ

  • options PdfToPdfAOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Process(PdfAValidateOptions)

指定されたPDF/A形式への準拠をチェックします。

public static ResultContainer Process(PdfAValidateOptions options)

パラメータ

  • options PdfAValidateOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfAConvertOptions

情報

PDFドキュメントをDocumentize.PdfAConverterプラグインを使用してPDF/A形式に変換するためのオプションを表します。

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Inheritance

objectPdfAOptionsBasePdfAConvertOptions

Implements

Inherited Members

Constructors

PdfAConvertOptions()

public PdfAConvertOptions()

Properties

Outputs

保存操作結果のために追加されたターゲット(ファイルまたはストリームデータソース)のコレクションを取得します。

public List<idatasource> Outputs { get; }

Property Value

List<IDataSource>

Methods

AddOutput(IDataSource)

新しい結果保存ターゲットを追加します。

public void AddOutput(IDataSource dataSource)

Parameters

  • dataSource IDataSource: 保存操作結果のためのターゲット(ファイルまたはストリームデータソース)。 :

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

情報

Documentize.PdfAConverter プラグインオプションのベースクラスを表します。このクラスは、PDF/A 変換と検証プロセスを構成するためのプロパティとメソッドを提供します。

Documentize.PdfAConverter プラグインオプションのベースクラスを表します。 このクラスは、PDF/A 変換と検証プロセスを構成するためのプロパティとメソッドを提供します。

public abstract class PdfAOptionsBase : IPluginOptions

継承

objectPdfAOptionsBase

派生

実装

継承メンバー

コンストラクタ

PdfAOptionsBase()

protected PdfAOptionsBase()

プロパティ

AlignText

PDF/A 変換プロセス中にテキストの整列を維持するために追加手段が必要かどうかを示す値を取得または設定します。

public bool AlignText { get; set; }

プロパティ値

bool

備考

true に設定すると、変換プロセスは元のテキストセグメントの境界を復元しようとします。 ほとんどのドキュメントでは、デフォルトのfalse 値からこのプロパティを変更する必要はありません。 デフォルトの変換プロセス中にテキストの整列は変更されないからです。

CheckDifferentNamesInFontDictionaries

ソース PDF ドキュメントが PDF 仕様に対応していない場合の PDF/A 変換を制御するフラグを取得します。

public bool CheckDifferentNamesInFontDictionaries { get; set; }

プロパティ値

bool

ErrorAction

変換できないオブジェクトに対して取るべきアクションを取得または設定します。

public ConvertErrorAction ErrorAction { get; set; }

プロパティ値

ConvertErrorAction

IccProfileFileName

デフォルトの ICC (国際色彩コンソーシアム) プロファイルの代わりに PDF/A 変換に使用される ICC プロファイルのファイル名を取得または設定します。

public string IccProfileFileName { get; set; }

プロパティ値

string

Inputs

データソースのコレクションを取得します。

public List<idatasource> Inputs { get; }

プロパティ値

List<IDataSource>

IsLowMemoryMode

PDF/A 変換プロセス中に低メモリモードが有効かどうかを示す値を取得または設定します。

public bool IsLowMemoryMode { get; set; }

プロパティ値

bool

LogOutputSource

ログ出力のデータソースを取得または設定します。

public IDataSource LogOutputSource { get; set; }

プロパティ値

IDataSource

OptimizeFileSize

PDF/A 変換プロセス中にファイルサイズを削減しようとするかどうかを示す値を取得または設定します。

public bool OptimizeFileSize { get; set; }

プロパティ値

bool

備考

true に設定すると、変換プロセスは結果のファイルサイズを最小限に抑えようとします。 これにより、変換プロセスのパフォーマンスに影響を与える可能性があります。

PdfAVersion

検証または変換に使用される PDF/A 標準のバージョンを取得または設定します。

public PdfAStandardVersion PdfAVersion { get; set; }

プロパティ値

PdfAStandardVersion

備考

PDF/A 標準バージョンは、PDF/A 検証と変換の遵守レベルを決定するために使用されます。 バージョンが Documentize.PdfAStandardVersion.Auto に設定されている場合、システムはドキュメントのメタデータに基づいて適切な PDF/A 標準バージョンを自動的に決定します。 PDF/A 変換プロセスの場合、Documentize.PdfAStandardVersion.Auto は PDF/A-1b 標準バージョンにデフォルト設定されます。

SoftMaskAction

ソフトマスク付きの画像の変換中に取るべきアクションを取得または設定します。

public ConvertSoftMaskAction SoftMaskAction { get; set; }

プロパティ値

ConvertSoftMaskAction

メソッド

AddInput(IDataSource)

コレクションに新しいデータソースを追加します。

public void AddInput(IDataSource dataSource)

パラメータ

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfAValidateOptions

情報

Documentize.PdfConverterプラグインを使用してPDF文書のPDF/A準拠を検証するためのオプションを表します。

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

継承

objectPdfAOptionsBasePdfAValidateOptions

実装

継承メンバー

コンストラクター

PdfAValidateOptions()

public PdfAValidateOptions()

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfAValidationResult

情報

PDF/A 検証プロセスの結果を表します。

public sealed class PdfAValidationResult

継承

objectPdfAValidationResult

継承されたメンバー

フィールド

  • DataSource 検証されたデータソースを取得します。

フィールド値

IDataSource

IsValid

検証が成功したかどうかを示す値を取得します。

public readonly bool IsValid

フィールド値

bool

StandardVersion

検証に使用されるPDF/A標準のバージョンを取得します。

public readonly PdfAStandardVersion StandardVersion

フィールド値

PdfAStandardVersion

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfChatGpt

情報

PdfChatGptプラグインを表します。

[Obsolete("このクラスはまもなく削除されます。PdfManagerクラスを使用してください。")]
public static class PdfChatGpt

継承

objectPdfChatGpt

継承されたメンバー

備考

Documentize.PdfChatGptは、チャットGPTに直接リクエストを送信するため、またはPDFファイルソースを追加して応答を出力ソースに保存するために使用されます。

メソッド

Process(IPluginOptions)

このメソッドには同期版はありません。代わりにProcessAsyncメソッドを使用してください。

public static ResultContainer Process(IPluginOptions options)

パラメーター

  • options IPluginOptions: PdfChatGptの指示を含むオプションオブジェクト。

戻り値

ResultContainer : #### 例外

NotImplementedException

ProcessAsync(IPluginOptions)

指定されたパラメーターでPdfChatGpt処理を開始します。

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

パラメーター

  • options IPluginOptions: PdfChatGptの指示を含むオプションオブジェクト。

戻り値

Task<ResultContainer>

非同期操作を表すタスクオブジェクト。

例外

ArgumentException : InvalidOperationException

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

情報

Documentize.PdfChatGpt プラグインのオプションを表します。

public class PdfChatGptOptions : IPluginOptions

継承

objectPdfChatGptOptions

派生

実装

継承されたメンバー

コンストラクター

PdfChatGptOptions()

Documentize.PdfChatGptOptions オブジェクトの新しいインスタンスを初期化します。

public PdfChatGptOptions()

プロパティ

Inputs

public List<idatasource> Inputs { get; }

プロパティの値

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

プロパティの値

List<IDataSource>

メソッド

AddInput(IDataSource)

PdfChatGpt プラグインのデータコレクションに新しいデータソースを追加します。

public void AddInput(IDataSource dataSource)

パラメーター

  • dataSource IDataSource: 追加するデータソース(ファイルまたはストリーム)。

AddOutput(IDataSource)

PdfChatGpt プラグインのデータコレクションに新しい保存データソースを追加します。

public void AddOutput(IDataSource saveDataSource)

パラメーター

  • saveDataSource IDataSource: 結果を保存するためのデータソース(ファイルまたはストリーム)。 :

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfChatGptRequestOptions

情報

Documentize.PdfChatGptプラグインのオプションを表します。

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

継承

objectPdfChatGptOptionsPdfChatGptRequestOptions

実装

継承されたメンバー

コンストラクタ

PdfChatGptRequestOptions()

Documentize.PdfChatGptRequestOptionsオブジェクトの新しいインスタンスをデフォルトオプションで初期化します。

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

オプションを指定してDocumentize.PdfChatGptRequestOptionsオブジェクトの新しいインスタンスを初期化します。

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

パラメーター

プロパティ

ApiKey

ChatGPT APIにアクセスするためのキーを取得または設定します。

public string ApiKey { get; set; }

プロパティ値

string

ApiUrl

ChatGPT API URLを取得または設定します。

public string ApiUrl { get; set; }

プロパティ値

string

CancellationToken

キャンセルトークン。

public CancellationToken CancellationToken { get; set; }

プロパティ値

CancellationToken

MaxTokens

レスポンス内のトークンの最大数。 デフォルト値はnullで、無限を意味します。

public int? MaxTokens { get; set; }

プロパティ値

int?

Messages

Documentize.Messageオブジェクトのコレクションを取得または設定します。

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

プロパティ値

List<Message>

備考

オプションに複数のメッセージを追加する場合、メッセージのコレクション内の順序は次の通りです:

  • 最初のメッセージ(存在する場合)はoptions.Queryからで、“あなたは有益なアシスタントです。“という内容のメッセージに続き、役割は"system"です。
  • 次に(存在する場合)、options.Messagesコレクションからメッセージが追加されます。
  • ファイルソースからのメッセージ(存在する場合)は最後に追加され、各ドキュメントに対して"ユーザー"役割の1つのメッセージオブジェクトが追加されます。 一つのメッセージが提供されない場合はArgumentExceptionがスローされます。

Model

使用するモデルのIDを設定または取得します。

public string Model { get; set; }

プロパティ値

string

NumberOfChoices

各入力メッセージに対して生成するチャット完了の選択肢の数。

public int NumberOfChoices { get; set; }

プロパティ値

int

Query

ChatGPTへのリクエスト文字列を取得または設定します。 空でない場合、これはコレクション内の最初のメッセージであり、リクエストで送信されます。

public string Query { get; set; }

プロパティ値

string

Temperature

使用するサンプリング温度。0から2の間で指定します。 0.8のような高い値は出力をよりランダムにし、 0.2のような低い値はより集中して決定論的になります。 デフォルト値は1です。

public double Temperature { get; set; }

プロパティ値

double

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfConverter

情報

Documentize.PdfConverter プラグインを表します。PDF ドキュメントを DOCX/DOC、XLSX/XLS/CSV/XLSM/ODS、HTML、JPEG、PNG、TIFF、PDF/A などの他の形式に変換するために使用されます。また、PDF/A 検証を実行し、HTML を PDF に変換することもできます。

Documentize.PdfConverter プラグインを表します。PDF ドキュメントを DOCX/DOC、XLSX/XLS/CSV/XLSM/ODS、HTML、JPEG、PNG、TIFF、PDF/A などの他の形式に変換するために使用されます。 また、PDF/A 検証を実行し、HTML を PDF に変換することもできます。

public static class PdfConverter

継承

objectPdfConverter

継承メンバー

この例では、PDF ドキュメントを Doc 形式に変換する方法を示します。

// PdfToDocOptions オブジェクトを作成して指示を設定
var options = new PdfToDocOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// 処理を実行
PdfConverter.Convert(options);

この例では、モードを設定して PDF ドキュメントを Doc 形式に変換する方法を示します。

// PdfToDocOptions オブジェクトを作成して指示を設定
var options = new PdfToDocOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// モードを設定
options.Mode = DocConversionMode.Flow;
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF を XLSX ドキュメントに変換する方法を示します。

// PdfToXlsOptions オブジェクトを作成して指示を設定
var options = new PdfToXlsOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xlsx"));
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF を XLS ドキュメントに変換する方法を示します。

// PdfToXlsOptions オブジェクトを作成して指示を設定
var options = new PdfToXlsOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// XLS 形式を指定
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xls"));
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF を HTML ドキュメントに変換する方法を示します。

// PdfToHtmlOptions オブジェクトを作成して出力データ型を埋め込まれたリソースを持つファイルとして設定
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_output.html"));
// 処理を実行
PdfConverter.Convert(options);

この例では、HTML を PDF ドキュメントに変換する方法を示します。

// HtmlToPdfOptions を作成
var options = new HtmlToPdfOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.html"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF ドキュメントを JPEG 形式に変換する方法を示します。

// PdfToJpegOptions オブジェクトを作成して指示を設定
var options = new PdfToJpegOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
PdfConverter.Convert(options);

この例では、ページ、解像度、品質の設定で PDF ドキュメントを JPEG 形式に変換する方法を示します。

// PdfToJpegOptions オブジェクトを作成して指示を設定
var options = new PdfToJpegOptions();
// 最初のページのみ処理する
options.PageList = [1];
// 出力解像度を 200 DPI に設定
options.OutputResolution = 200;
// 出力品質を 50 に設定
options.Quality = 50;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF ドキュメントをストリームに JPEG 形式に変換する方法を示します。

// PdfToJpegOptions オブジェクトを作成して指示を設定
var options = new PdfToJpegOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 処理を実行
var results = PdfConverter.Convert(options);
// ストリームの結果を取得
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

この例では、PDF ドキュメントを PNG 形式に変換する方法を示します。

// PdfToPngOptions オブジェクトを作成して指示を設定
var options = new PdfToPngOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
PdfConverter.Convert(options);

この例では、1 ページの PDF ドキュメントを PNG 形式に変換する方法を示します。

// PdfToPngOptions オブジェクトを作成して指示を設定
var options = new PdfToPngOptions()
// 最初のページのみ処理する
options.PageList = [1];
// 出力解像度を 200 DPI に設定
options.OutputResolution = 200;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF ドキュメントをストリームに PNG 形式に変換する方法を示します。

// PdfToJpegOptions オブジェクトを作成して指示を設定
var options = new PdfToPngOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 処理を実行
var results = PdfConverter.Convert(options);
// ストリームの結果を取得
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

この例では、PDF ドキュメントを TIFF 形式に変換する方法を示します。

// PdfToTiffOptions オブジェクトを作成して指示を設定
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
PdfConverter.Convert(options);

この例では、ページと DPI をカスタマイズして PDF ドキュメントを TIFF 形式に変換する方法を示します。

// PdfToTiffOptions オブジェクトを作成して指示を設定
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// ページを設定
options.PageList = [1, 3];
// 結果の画像解像度を設定
options.OutputResolution = 400;
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF ドキュメントをマルチページ TIFF 形式に変換する方法を示します。

// PdfToTiffOptions オブジェクトを作成して指示を設定
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// マルチページ TIFF 出力を有効にする
options.MultiPage = true;
// 処理を実行
PdfConverter.Convert(options);

この例では、圧縮とカラー深度をカスタマイズして PDF ドキュメントを TIFF 形式に変換する方法を示します。

// PdfToTiffOptions オブジェクトを作成して指示を設定
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 圧縮とカラー深度を設定
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// 処理を実行
PdfConverter.Convert(options);

この例では、PDF ドキュメントをストリームに TIFF 形式に変換する方法を示します。

// PdfToTiffOptions オブジェクトを作成して指示を設定
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 処理を実行
var results = PdfConverter.Convert(options);
// ストリームの結果を取得
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

この例では、PDF/A 形式 (この場合は PDF/A-3b) の PDF ドキュメントを変換する方法を示します。

// 変換プロセスを設定するオプションクラスを作成
var options = new PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// ソースファイルを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // 実際のファイルパスに置き換えてください

// 変換されたファイルを保存するためのパスを追加
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// 変換を実行
PdfConverter.Convert(options);

この例では、PDF ドキュメントが PDF/A 形式に準拠しているかを検証する方法を示します (この場合は PDF/A-1a)。

// 検証プロセスを設定するオプションクラスを作成
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// 検証するファイルを 1 つ以上追加
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // 実際のファイルパスに置き換えてください
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// 必要に応じてさらにファイルを追加

// 検証を実行し、結果を取得
var resultContainer = PdfConverter.Validate(options);

// 各ファイルの検証結果を確認するには resultContainer.ResultCollection プロパティを確認します:
for (var i = 0; i &lt; resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // i 番目のドキュメントの検証結果
}

メソッド

Convert(PdfToDocOptions)

PDF ドキュメントを DOC/DOCX 形式に変換します。

public static ResultContainer Convert(PdfToDocOptions options)

パラメータ

  • options PdfToDocOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Convert(PdfToXlsOptions)

PDF ドキュメントを XLSX/XLS/CSV/XLSM/ODS 形式に変換します。

public static ResultContainer Convert(PdfToXlsOptions options)

パラメータ

  • options PdfToXlsOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Convert(PdfToHtmlOptions)

PDF ドキュメントを HTML 形式に変換します。

public static ResultContainer Convert(PdfToHtmlOptions options)

パラメータ

  • options PdfToHtmlOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Convert(HtmlToPdfOptions)

HTML ドキュメントを PDF 形式に変換します。

public static ResultContainer Convert(HtmlToPdfOptions options)

パラメータ

  • options HtmlToPdfOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Convert(PdfToJpegOptions)

PDF ドキュメントを JPEG 形式に変換します。

public static ResultContainer Convert(PdfToJpegOptions options)

パラメータ

  • options PdfToJpegOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Convert(PdfToPngOptions)

PDF ドキュメントを PNG 形式に変換します。

public static ResultContainer Convert(PdfToPngOptions options)

パラメータ

  • options PdfToPngOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Convert(PdfToTiffOptions)

PDF ドキュメントを TIFF 形式に変換します。

public static ResultContainer Convert(PdfToTiffOptions options)

パラメータ

  • options PdfToTiffOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Convert(PdfToPdfAOptions)

PDF ドキュメントを PDF/A 形式に変換します。

public static ResultContainer Convert(PdfToPdfAOptions options)

パラメータ

  • options PdfToPdfAOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Validate(PdfAValidateOptions)

指定された形式 PDF/A に対する PDF ドキュメントの適合性を確認します。

public static ResultContainer Validate(PdfAValidateOptions options)

パラメータ

  • options PdfAValidateOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverterOptions

情報

Pdfコンバータプラグインのオプションを表します。

public abstract class PdfConverterOptions : IPluginOptions

継承

objectPdfConverterOptions

派生

実装

継承されたメンバー

プロパティ

入力

PdfConverterOptionsプラグインデータコレクションを返します。

public List<idatasource> Inputs { get; }

プロパティの値

List<IDataSource>

出力

保存操作結果のために追加されたターゲットのコレクションを取得します。

public List<idatasource> Outputs { get; }

プロパティの値

List<IDataSource>

メソッド

AddInput(IDataSource)

PdfConverterプラグインデータコレクションに新しいデータソースを追加します。

public void AddInput(IDataSource dataSource)

パラメータ

  • dataSource IDataSource: 追加するデータソース。

AddOutput(IDataSource)

PdfToXLSXConverterOptionsプラグインデータコレクションに新しいデータソースを追加します。

public void AddOutput(IDataSource saveDataSource)

パラメータ

  • saveDataSource IDataSource: 保存操作結果のためのデータソース(ファイルまたはストリーム)。

例外

NotImplementedException

ネームスペース: Documentize アセンブリ: Documentize.dll

Class PdfExtractor

情報

Documentize.PdfExtractor プラグインを表します。PDF ドキュメントからテキスト、画像、フォームデータを抽出するために使用されます。

public static class PdfExtractor

継承

objectPdfExtractor

継承メンバー

サンプル

このサンプルは、PDF ドキュメントのテキストコンテンツを抽出する方法を示しています。

// ExtractTextOptions オブジェクトを作成して指示を設定
var options = new ExtractTextOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// プロセスを実行
var results = PdfExtractor.ExtractText(options);
// ResultContainer オブジェクトから抽出したテキストを取得
var textExtracted = results.ResultCollection[0].ToString();

このサンプルは、TextFormattingMode を使用して PDF ドキュメントのテキストコンテンツを抽出する方法を示しています。

// ExtractTextOptions オブジェクトを作成して TextFormattingMode を設定
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// プロセスを実行
var results = PdfExtractor.ExtractText(options);
// ResultContainer オブジェクトから抽出したテキストを取得
var textExtracted = results.ResultCollection[0].ToString();

このサンプルは、PDF ドキュメントから画像を抽出する方法を示しています。

// ExtractImagesOptions を作成して指示を設定
var options = new ExtractImagesOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// プロセスを実行
var results = PdfExtractor.ExtractImages(options);
// 画像結果へのパスを取得
var imageExtracted = results.ResultCollection[0].ToFile();

このサンプルは、フォルダを使用せずに PDF ドキュメントからストリームに画像を抽出する方法を示しています。

// ExtractImagesOptions を作成して指示を設定
var options = new ExtractImagesOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力を設定しない - 結果はストリームに書き込まれます
// プロセスを実行
var results = PdfExtractor.ExtractImages(options);
// ストリームを取得
var ms = results.ResultCollection[0].ToStream();
// デモ用にファイルにデータをコピー
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

このサンプルは、フォームの値を CSV ファイルにエクスポートする方法を示しています。

// ExtractFormDataToDsvOptions オブジェクトを作成して指示を設定
var options = new ExtractFormDataToDsvOptions(',', true);
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// プロセスを実行
PdfExtractor.ExtractFormData(options);

メソッド

ExtractFormData(ExtractFormDataToDsvOptions)

PDF ドキュメントからフォームデータを抽出します。

public static ResultContainer ExtractFormData(ExtractFormDataToDsvOptions options)

パラメータ

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

ExtractImages(ExtractImagesOptions)

PDF ドキュメントから画像を抽出します。

public static ResultContainer ExtractImages(ExtractImagesOptions options)

パラメータ

  • options ExtractImagesOptions: 操作に関する指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

ExtractText(ExtractTextOptions)

PDF ドキュメントからテキストを抽出します。

public static ResultContainer ExtractText(ExtractTextOptions options)

パラメータ

  • options ExtractTextOptions: 操作に関する指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 抽出の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfManager

情報

Documentize.PdfManagerプラグインを表します。PDFドキュメントをマージ、分割、最適化、回転、サイズ変更、圧縮し、テーブルを追加し、PDFドキュメントに目次を追加するために使用されます。複数のPDFドキュメントを単一のPDFにマージすることができます。PDFドキュメントを別々のページに分割できます。PDFドキュメントを最適化、回転、サイズ変更、圧縮できます。PDFドキュメントのページを回転、サイズ変更できます。PDFドキュメントにテーブルを追加できます。PDFドキュメントに目次を追加できます。

Documentize.PdfManagerプラグインを表します。PDFドキュメントをマージ、分割、最適化、回転、サイズ変更、圧縮し、テーブルを追加し、PDFドキュメントに目次を追加するために使用されます。 複数のPDFドキュメントを単一のPDFにマージすることができます。 PDFドキュメントを別々のページに分割できます。 PDFドキュメントを最適化、回転、サイズ変更、圧縮できます。 PDFドキュメントのページを回転、サイズ変更できます。 PDFドキュメントにテーブルを追加できます。 PDFドキュメントに目次を追加できます。

public static class PdfManager

継承

objectPdfManager

継承メンバー

この例は、2つのPDFドキュメントをマージする方法を示します。

// マージオプションオブジェクトを作成して指示を設定
var options = new MergeOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfManager.Merge(options);

この例は、PDFドキュメントを分割する方法を示します。

// 分割オプションオブジェクトを作成して指示を設定
var options = new SplitOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// 処理を実行
PdfManager.Split(options);

この例は、PDFドキュメントを最適化する方法を示します。

// 最適化オプションオブジェクトを作成して指示を設定
var options = new OptimizeOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfManager.Optimize(options);

この例は、PDFドキュメントを回転する方法を示します。

// 回転オプションオブジェクトを作成して指示を設定
var options = new RotateOptions();
// 新しい回転を設定
options.Rotation = Rotation.On90;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfManager.Rotate(options);

この例は、PDFドキュメントのサイズを変更する方法を示します。

// サイズ変更オプションオブジェクトを作成して指示を設定
var options = new ResizeOptions();
// 新しいページサイズを設定
options.PageSize = PageSize.A3;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfManager.Resize(options);

この例は、PDFドキュメントを圧縮する方法を示します。

// 圧縮オプションオブジェクトを作成して指示を設定
var options = new CompressOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfManager.Compress(options);

この例は、PDFファイルにテーブルを追加する方法を示します。

// テーブルオプションを設定
var options = new TableOptions();
options.InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("名前")
            .AddCell().AddParagraph("年齢")
        .AddRow()
            .AddCell().AddParagraph("ボブ")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("サム")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("サンディ")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("トム")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("ジム")
            .AddCell().AddParagraph("27");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// 処理を実行
PdfManager.AddTable(options);

この例は、PDFファイルに目次を追加する方法を示します。

// 目次オプションオブジェクトを作成して指示を設定
var options = new TocOptions();
// タイトルを設定
options.Title = "私の目次";
// 見出しをデザイン
options.Headings.Add(new TocHeading("はじめに", 2));
options.Headings.Add(new TocHeading("第 I 章", 3));
options.Headings.Add(new TocHeading("第 II 章", 4));
options.Headings.Add(new TocHeading("第 III 章", 5));
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfManager.AddTableOfContents(options);

この例は、目次を生成するブックマークを追加してPDFファイルに目次を追加する方法を示します。

// 目次オプションオブジェクトを作成して指示を設定
var options = new TocOptions();
// タイトルを設定
options.Title = "私の目次";
// ブックマーク内のリンクを生成
options.GenerateBookmarks = true;
// 見出しをデザイン
options.Headings.Add(new TocHeading("はじめに", 2, false, 1));
options.Headings.Add(new TocHeading("第 I 章", 3, true, 1));
options.Headings.Add(new TocHeading("第 II 章", 4, true, 1));
options.Headings.Add(new TocHeading("例 A", 4, true, 2));
options.Headings.Add(new TocHeading("例 B", 4, true, 2));
options.Headings.Add(new TocHeading("例 C", 4, true, 2));
options.Headings.Add(new TocHeading("例 D", 4, true, 2));
options.Headings.Add(new TocHeading("第 III 章", 5, true, 1));
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfManager.AddTableOfContents(options);

この例は、PDFファイルに目次を追加してストリームとして保存する方法を示します。

// 目次オプションオブジェクトを作成して指示を設定
var options = new TocOptions();
// タイトルを設定
options.Title = "私の目次";
// 見出しをデザイン
options.Headings.Add(new TocHeading("はじめに", 2, false, 1));
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ストリームを設定 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// 処理を実行
PdfManager.AddTableOfContents(options);

この例は、リクエストにメッセージを追加してChatGptを使用する方法を示します。

var options = new ChatGptRequestOptions();
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf")); 
options.ApiKey = "あなたのAPIキー"; // APIにアクセスするためにキーを提供する必要があります。
options.MaxTokens = 1000; // チャットの完了で生成されるトークンの最大数です。

// リクエストメッセージを追加します。
options.Messages.Add(new Message
{
    Content = "あなたは役に立つアシスタントです。",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "今まで作られた最大のピザの直径はどのくらいですか?",
    Role = Role.User
});

// リクエストを処理します。
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIのチャット完了オブジェクト。

この例は、リクエストに1つのメッセージを追加してChatGptを使用する方法を示します。

var options = new ChatGptRequestOptions();
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf")); // 出力ファイルパスを追加します。
options.ApiKey = "あなたのAPIキー"; // APIにアクセスするためにキーを提供する必要があります。
options.MaxTokens = 1000; // チャットの完了で生成されるトークンの最大数です。

// リクエストメッセージを追加します。
// この場合、"あなたは役に立つアシスタントです。"という内容のシステムメッセージがデフォルトで追加されます。
// クエリメッセージの役割はデフォルトで"ユーザー"です。
options.Query = "地球上で記録された最低の温度は何度ですか?";

// リクエストを処理します。
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIのチャット完了オブジェクト。

この例は、ファイルをメッセージソースとして追加してChatを使用する方法を示します。

var options = new ChatGptRequestOptions();
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));

// PDFテキストソースを追加します。
// 複数のソースがある場合、各文書からのテキストが、役割"ユーザー"の別々のメッセージとしてリクエストメッセージコレクションに追加されます。
options.AddInput(new FileDataSource("TextSource.pdf"));

options.ApiKey = "あなたのAPIキー"; // APIにアクセスするためにキーを提供する必要があります。
options.MaxTokens = 1000; // チャットの完了で生成されるトークンの最大数です。

// リクエストメッセージを追加します。
// この場合、"あなたは役に立つアシスタントです。"という内容のシステムメッセージがデフォルトで追加されます。
// クエリメッセージの役割はデフォルトで"ユーザー"です。
options.Query = "提供されたテキストには何文字ありますか?";

// リクエストを処理します。
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIのチャット完了オブジェクト。

メソッド

AddTable(TableOptions)

PDFドキュメントにテーブルを追加します。

public static ResultContainer AddTable(TableOptions options)

パラメータ

  • options TableOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

AddTableOfContents(TocOptions)

PDFドキュメントに目次(TOC)を追加します。

public static ResultContainer AddTableOfContents(TocOptions options)

パラメータ

  • options TocOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Compress(CompressOptions)

PDFドキュメントを圧縮します。ドキュメントのサイズを減らそうとします。

public static ResultContainer Compress(CompressOptions options)

パラメータ

  • options CompressOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

ChatGptの返信によってPDFドキュメントを作成します。 ChatGPTに直接リクエストを送信するために使用されるか、PDFファイルソースを追加し、その返信を出力ソースに保存します。

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

パラメータ

戻り値

Task<ResultContainer>

操作の結果を含むオブジェクト。

例外

ArgumentException : オプションが設定されていない場合。

Merge(MergeOptions)

PDFドキュメントをマージします。

public static ResultContainer Merge(MergeOptions options)

パラメータ

  • options MergeOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Optimize(OptimizeOptions)

PDFドキュメントを最適化します。 ドキュメントを線形化して、次のことを行います。

  • できるだけ早く最初のページを開く。
  • 次のページや次のページへのリンクをできるだけ早く表示する。
  • 遅いチャネルでページのデータが送信されるときに届くデータに従ってページを段階的に表示する(最も有用なデータを最初に表示する)。
  • ユーザーインタラクション(たとえば、リンクをたどる)が行われることを許可します。ページ全体が受信されて表示される前に。
public static ResultContainer Optimize(OptimizeOptions options)

パラメータ

  • options OptimizeOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Resize(ResizeOptions)

PDFドキュメントのページをサイズ変更します。

public static ResultContainer Resize(ResizeOptions options)

パラメータ

  • options ResizeOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Rotate(RotateOptions)

PDFドキュメントのページを回転します。

public static ResultContainer Rotate(RotateOptions options)

パラメータ

  • options RotateOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Split(SplitOptions)

PDFドキュメントをページごとに分割します。

public static ResultContainer Split(SplitOptions options)

パラメータ

  • options SplitOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

Namespace: Documentize Assembly: Documentize.dll

Class PdfSecurity

情報

Documentize.PdfSecurityプラグインを表します。PDF文書の暗号化、復号化、署名に使用されます。

public static class PdfSecurity

継承

objectPdfSecurity

継承メンバー

メソッド

Decrypt(DecryptOptions)

PDF文書を復号化します。

public static ResultContainer Decrypt(DecryptOptions options)

パラメーター

  • options DecryptOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

この例は、PDF文書を復号化する方法を示しています。

// 指示を設定するためのDecryptOptionsオブジェクトを作成
var options = new DecryptOptions("123456");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
PdfSecurity.Decrypt(options);

例外

ArgumentException

オプションが設定されていない場合。

Encrypt(EncryptOptions)

PDF文書を暗号化します。

public static ResultContainer Encrypt(EncryptOptions options)

パラメーター

  • options EncryptOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

この例は、PDF文書を暗号化する方法を示しています。

// 指示を設定するためのEncryptOptionsオブジェクトを作成
var options = new EncryptOptions("123456", "qwerty");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
PdfSecurity.Encrypt(options);

例外

ArgumentException

オプションが設定されていない場合。

Sign(SignOptions)

デジタル署名によってPDF文書に署名します。

public static ResultContainer Sign(SignOptions options)

パラメーター

  • options SignOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

この例は、PDF文書に署名する方法を示しています。

// 指示を設定するためのSignOptionsオブジェクトを作成
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
PdfSecurity.Sign(options);

この例は、PFXファイルのストリームを使用してPDF文書に署名する方法を示しています。

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
PdfSecurity.Sign(options);

この例は、見えない署名でPDF文書に署名する方法を示しています。

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 見えない署名を設定
signOptions.Visible = false;
// プロセスを実行
PdfSecurity.Sign(options);

この例は、追加オプションを使用してPDF文書に署名する方法を示しています。

// 指示を設定するためのSignOptionsオブジェクトを作成
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// オプションのパラメーター
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// プロセスを実行
PdfSecurity.Sign(options);

この例は、タイムスタンプを使用してPDF文書に署名する方法を示しています。

// 指示を設定するためのSignOptionsオブジェクトを作成
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
PdfSecurity.Sign(options);

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfToDocOptions

情報

Documentize.PdfConverterプラグインのPDFからDOCへの変換オプションを表します。

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsPdfToDocOptions

実装

継承されたメンバー

コンストラクタ

PdfToDocOptions()

Documentize.PdfToDocOptionsオブジェクトの新しいインスタンスをデフォルトオプションで初期化します。

public PdfToDocOptions()

プロパティ

Mode

PDFドキュメントがワードプロセッシングドキュメントに変換される方法を制御することを許可します。

public DocConversionMode Mode { get; set; }

プロパティ値

DocConversionMode

注釈

結果のドキュメントがその後大幅に編集される予定がない場合は、Documentize.DocConversionMode.TextBoxモードを使用します。テキストボックスは、あまり手を加えない場合に簡単に修正できます。

出力ドキュメントにさらなる編集が必要な場合は、Documentize.DocConversionMode.Flowモードを使用してください。フローモードの段落とテキスト行はテキストの簡単な修正を可能にしますが、サポートされないフォーマットオブジェクトはDocumentize.DocConversionMode.TextBoxモードよりも見栄えが悪くなります。

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfToHtmlOptions

情報

Documentize.PdfConverterプラグインのPDFからHTMLへの変換オプションを表します。

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsPdfToHtmlOptions

実装

継承メンバー

コンストラクタ

PdfToHtmlOptions(SaveDataType)

指定された出力データ型のためにDocumentize.PdfToHtmlOptionsオブジェクトの新しいインスタンスを初期化します。

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType = SaveDataType.FileWithExternalResources)

パラメータ

プロパティ

OutputDataType

出力データ型を取得します。

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

プロパティ値

PdfToHtmlOptions.SaveDataType

Namespace: Documentize Assembly: Documentize.dll

Class PdfToJpegOptions

情報

Documentize.PdfConverterプラグインのPDFからJPEG変換オプションを表します。

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsPdfToJpegOptions

実装

継承メンバー

コンストラクター

PdfToJpegOptions()

Documentize.PdfToJpegOptionsオブジェクトの新しいインスタンスを初期化します。

public PdfToJpegOptions()

プロパティ

OutputResolution

生成される画像の解像度値を取得または設定します。

public int OutputResolution { get; set; }

プロパティ値

int

PageList

処理するページのリストを取得または設定します。

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

プロパティ値

List<int>

Quality

出力品質を取得および設定します。 画像の圧縮レベルを指定します。 品質の有用な値の範囲は0から100です。 指定した数値が低いほど圧縮が高く、したがって画像の品質が低くなります。 ゼロは最も低い品質の画像を、100は最高品質の画像を提供します。

public int Quality { get; set; }

プロパティ値

int

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfToPdfAOptions

情報

Documentize.PdfConverterプラグインを使用してPDFドキュメントをPDF/A形式に変換するためのオプションを表します。

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

継承

objectPdfAOptionsBasePdfToPdfAOptions

実装

継承メンバー

コンストラクター

PdfToPdfAOptions()

public PdfToPdfAOptions()

プロパティ

Outputs

保存操作の結果を保存するための追加されたターゲット(ファイルまたはストリームデータソース)のコレクションを取得します。

public List<idatasource> Outputs { get; }

プロパティ値

List<IDataSource>

メソッド

AddOutput(IDataSource)

新しい結果保存ターゲットを追加します。

public void AddOutput(IDataSource dataSource)

パラメーター

  • dataSource IDataSource: 操作結果を保存するためのターゲット(ファイルまたはストリームデータソース)。 :

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfToPngOptions

情報

Documentize.PdfConverterプラグインのPDFからPNGへの変換オプションを表します。

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsPdfToPngOptions

実装

継承メンバー

コンストラクター

PdfToPngOptions()

Documentize.PdfToPngOptionsオブジェクトの新しいインスタンスを初期化します。

public PdfToPngOptions()

プロパティ

OutputResolution

結果の画像の解像度値を取得または設定します。

public int OutputResolution { get; set; }

プロパティ値

int

PageList

プロセス用のページのリストを取得または設定します。

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

プロパティ値

List<int>

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfToTiffOptions

情報

Documentize.PdfConverterプラグインのPDFからTIFFへの変換オプションを表します。

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsPdfToTiffOptions

実装

継承されたメンバー

コンストラクタ

PdfToTiffOptions()

Documentize.PdfToTiffOptionsオブジェクトの新しいインスタンスを初期化します。

public PdfToTiffOptions()

プロパティ

ColorDepth

色の深さを取得または設定します。

public TiffColorDepth ColorDepth { get; set; }

プロパティ値

TiffColorDepth

備考

デフォルト値はDocumentize.TiffColorDepth.Format32bppです。

Compression

圧縮のタイプを取得または設定します。

public TiffCompression Compression { get; set; }

プロパティ値

TiffCompression

備考

デフォルト値はDocumentize.TiffCompression.LZWです。

MultiPage

すべてのページを1つのマルチページTIFFに保存することを許可するフラグを取得および設定します。 デフォルト値はfalseです。

public bool MultiPage { get; set; }

プロパティ値

bool

OutputResolution

結果画像の解像度値を取得または設定します。

public int OutputResolution { get; set; }

プロパティ値

int

PageList

処理するページのリストを取得または設定します。

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

プロパティ値

List<int>

名前空間: Documentize アセンブリ: Documentize.dll

Class PdfToXlsOptions

情報

Documentize.PdfConverterプラグインのためのPDFからXLS/XLSXへの変換オプションを表します。

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

継承

objectPdfConverterOptionsPdfToXlsOptions

実装

継承されたメンバー

コンストラクタ

PdfToXlsOptions()

Documentize.PdfToXlsOptionsオブジェクトの新しいインスタンスをデフォルトオプションで初期化します。

public PdfToXlsOptions()

プロパティ

Format

出力フォーマット。

public PdfToXlsOptions.ExcelFormat Format { get; set; }

プロパティ値

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

ワークシートの最初の列として空白の列を挿入する必要がある場合はtrueに設定します。 デフォルト値はfalseで、空白の列は挿入されません。

public bool InsertBlankColumnAtFirst { get; set; }

プロパティ値

bool

MinimizeTheNumberOfWorksheets

結果のワークブック内のワークシートの数を最小限にする必要がある場合はtrueに設定します。 デフォルト値はfalseで、各PDFページを別々のワークシートとして保存します。

public bool MinimizeTheNumberOfWorksheets { get; set; }

プロパティ値

bool

名前空間: Documentize アセンブリ: Documentize.dll

Class PluginBaseOptions

情報

プラグインの基本オプションを表します。

public class PluginBaseOptions : IPluginOptions

継承

objectPluginBaseOptions

派生

実装

継承されたメンバー

プロパティ

CloseInputStreams

操作が完了した後に入力ストリームを閉じます。

public bool CloseInputStreams { get; set; }

プロパティの値

bool

CloseOutputStreams

操作が完了した後に出力ストリームを閉じます。

public bool CloseOutputStreams { get; set; }

プロパティの値

bool

Inputs

操作のための入力データを返します。

public List<idatasource> Inputs { get; }

プロパティの値

List<IDataSource>

Outputs

操作のための出力データを返します。

public List<idatasource> Outputs { get; }

プロパティの値

List<IDataSource>

メソッド

AddInput(IDataSource)

Inputsに新しいデータを追加します。

public void AddInput(IDataSource dataSource)

パラメーター

AddOutput(IDataSource)

Outputsに新しいデータを追加します。

public void AddOutput(IDataSource saveDataSource)

パラメーター

Namespace: Documentize Assembly: Documentize.dll

Class PngConverter

情報

Documentize.PngConverterプラグインを表します。PDFドキュメントをPNG形式に変換するために使用されます。

[Obsolete("このクラスはすぐに削除されます。PdfConverterクラスを使用してください。")]
public static class PngConverter

継承

objectPngConverter

継承されたメンバー

メソッド

Process(PdfToPngOptions)

PDFドキュメントをPNG形式に変換します。

public static ResultContainer Process(PdfToPngOptions options)

パラメータ

  • options PdfToPngOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class Rectangle

情報

クラスは長方形を表します。

public class Rectangle

継承

objectRectangle

継承されたメンバー

コンストラクター

Rectangle(double, double, double, double)

Rectangleのコンストラクターです。

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

パラメーター

Namespace: Documentize Assembly: Documentize.dll

Class ResizeOptions

情報

Documentize.PdfManagerプラグインのリサイズオプションを表します。

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsResizeOptions

実装

継承されたメンバー

コンストラクタ

ResizeOptions()

デフォルトオプションでDocumentize.ResizeOptionsオブジェクトの新しいインスタンスを初期化します。

public ResizeOptions()

プロパティ

PageSize

新しいページサイズを取得または設定します。

public PageSize PageSize { get; set; }

プロパティ値

PageSize

名前空間: Documentize アセンブリ: Documentize.dll

Class ResultContainer

情報

プラグインの処理結果のコレクションを含むコンテナを表します。

public class ResultContainer

継承

objectResultContainer

継承メンバー

プロパティ

ResultCollection

操作結果のコレクションを取得します。

public List<ioperationresult> ResultCollection { get; }

プロパティ値

List<IOperationResult>

名前空間: Documentize アセンブリ: Documentize.dll

Class RotateOptions

情報

Documentize.PdfManagerプラグインの回転オプションを表します。

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsRotateOptions

実装

継承メンバー

コンストラクタ

RotateOptions()

デフォルトオプションでDocumentize.RotateOptionsオブジェクトの新しいインスタンスを初期化します。

public RotateOptions()

プロパティ

Rotation

新しいページの回転を取得または設定します。

public Rotation Rotation { get; set; }

プロパティ値

Rotation

名前空間: Documentize アセンブリ: Documentize.dll

Class SignOptions

情報

Documentize.PdfSecurityプラグインの署名オプションを表します。

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsSignOptions

実装

継承されたメンバー

コンストラクタ

SignOptions(string, string)

デフォルトオプションでDocumentize.SignOptionsオブジェクトの新しいインスタンスを初期化します。

public SignOptions(string pfx, string password)

パラメーター

  • pfx string: pfxファイルへのパス。
  • password string: pfxファイルのパスワード。

SignOptions(Stream, string)

デフォルトオプションでDocumentize.SignOptionsオブジェクトの新しいインスタンスを初期化します。

public SignOptions(Stream pfx, string password)

パラメーター

  • pfx Stream: pfxファイルを持つストリーム。
  • password string: pfxファイルのパスワード。

プロパティ

Contact

署名の連絡先。

public string Contact { get; set; }

プロパティ値

string

Location

署名の場所。

public string Location { get; set; }

プロパティ値

string

Name

既存の署名フィールドの名前。 新しいフィールドを作成するにはnullを指定します。

public string Name { get; set; }

プロパティ値

string

PageNumber

署名が行われるページ番号。

public int PageNumber { get; set; }

プロパティ値

int

Reason

署名の理由。

public string Reason { get; set; }

プロパティ値

string

Rectangle

署名の矩形。

public Rectangle Rectangle { get; set; }

プロパティ値

Rectangle

TimestampOptions

タイムスタンプオプション。

public TimestampOptions TimestampOptions { get; set; }

プロパティ値

TimestampOptions

Visible

署名の可視性。

public bool Visible { get; set; }

プロパティ値

bool

名前空間: Documentize アセンブリ: Documentize.dll

Class SplitOptions

情報

Documentize.PdfManagerプラグインのスプリットオプションを表します。

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsSplitOptions

実装

継承されたメンバー

コンストラクター

SplitOptions()

デフォルトオプションを持つDocumentize.SplitOptionsオブジェクトの新しいインスタンスを初期化します。

public SplitOptions()

名前空間: Documentize アセンブリ: Documentize.dll

Class Splitter

情報

Documentize.Splitterプラグインを表します。PDF文書を個別のページに分割するために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfManagerクラスを使用してください。")]
public static class Splitter

継承

objectSplitter

継承されたメンバー

メソッド

Process(SplitOptions)

ページごとにPDF文書を分割します。

public static ResultContainer Process(SplitOptions options)

パラメーター

  • options SplitOptions: 操作に対する指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class StreamDataSource

情報

プラグインのロードおよび保存操作のためのストリームデータソースを表します。

public sealed class StreamDataSource : IDataSource

継承

objectStreamDataSource

実装

継承メンバー

コンストラクタ

StreamDataSource(Stream)

指定されたストリームオブジェクトを使用して新しいストリームデータソースを初期化します。

public StreamDataSource(Stream data)

パラメータ

  • data Stream: ストリームオブジェクト

プロパティ

Data

現在のデータソースのストリームオブジェクトを取得します。

public Stream Data { get; }

プロパティ値

Stream

DataType

データソースのタイプ(ストリーム)。

public DataType DataType { get; }

プロパティ値

DataType

Namespace: Documentize Assembly: Documentize.dll

Class StreamResult

情報

ストリームの形で操作結果を表します。

public sealed class StreamResult : IOperationResult

継承

objectStreamResult

実装

継承されたメンバー

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティ値

object

IsFile

結果が出力ファイルへのパスであるかどうかを示します。

public bool IsFile { get; }

プロパティ値

bool

IsStream

結果が出力ファイルへのパスであるかどうかを示します。

public bool IsStream { get; }

プロパティ値

bool

IsString

結果が文字列であるかどうかを示します。

public bool IsString { get; }

プロパティ値

bool

メソッド

ToFile()

結果をファイルに変換しようとします。

public string ToFile()

戻り値

string : 結果がファイルの場合、出力ファイルへのパスを表す文字列。そうでない場合は null

ToStream()

結果をストリームオブジェクトに変換しようとします。

public Stream ToStream()

戻り値

Stream : 結果がストリームの場合、出力データを表すストリームオブジェクト。そうでない場合は null

名前空間: Documentize アセンブリ: Documentize.dll

Class StringResult

情報

文字列の形式で操作結果を表します。

public sealed class StringResult : IOperationResult

継承

objectStringResult

実装

継承されたメンバー

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティ値

object

IsFile

結果が出力ファイルへのパスであるかどうかを示します。

public bool IsFile { get; }

プロパティ値

bool

IsStream

結果が出力ファイルへのパスであるかどうかを示します。

public bool IsStream { get; }

プロパティ値

bool

IsString

結果が文字列であるかどうかを示します。

public bool IsString { get; }

プロパティ値

bool

Text

結果の文字列表現を返します。

public string Text { get; }

プロパティ値

string

メソッド

ToFile()

結果をファイルに変換しようとします。

public string ToFile()

戻り値

string : 結果がファイルである場合の出力ファイルへのパスを表す文字列; そうでない場合は null

ToStream()

結果をストリームオブジェクトに変換しようとします。

public Stream ToStream()

戻り値

Stream : 結果がストリームである場合の出力データを表すストリームオブジェクト; そうでない場合は null

ToString()

結果を文字列に変換しようとします。

public override string ToString()

戻り値

string : 結果が文字列である場合のテキストコンテンツを表す文字列; そうでない場合は base.ToString() を返します。

Namespace: Documentize
Assembly: Documentize.dll

Class TableBuilder

情報

クラスはPDFページのためのテーブルビルダーを表します。

public class TableBuilder

継承

objectTableBuilder

派生

継承されたメンバー

メソッド

AddRow()

テーブルに新しい行を追加します。

public virtual TableRowBuilder AddRow()

返り値

TableRowBuilder : 現在のDocumentize.TableRowBuilderのインスタンス。

AddTable()

ドキュメントに新しいテーブルを追加します。

public TableBuilder AddTable()

返り値

TableBuilder : 現在のDocumentize.TableBuilderのインスタンス。

InsertPageAfter(int)

指定したページの後にページを挿入します。

public TableOptions InsertPageAfter(int page)

パラメータ

  • page int: テーブルを追加するページ番号。

返り値

TableOptions : 現在のDocumentize.TableOptionsのインスタンス。

InsertPageBefore(int)

指定したページの前にページを挿入します。

public TableOptions InsertPageBefore(int page)

パラメータ

  • page int: テーブルを追加するページ番号。

返り値

TableOptions : 現在のDocumentize.TableOptionsのインスタンス。

演算子

implicit operator TableOptions(TableBuilder)

ビルダーDocumentize.TableBuilderをオプションDocumentize.TableOptionsに変換します。

public static implicit operator TableOptions(TableBuilder builder)

パラメータ

  • builder TableBuilder: 現在のDocumentize.TableBuilderのインスタンス。

返り値

TableOptions : PdfGeneratorTableOptionsへの変換の結果。

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

情報

クラスはテーブルセルのビルダーを表します。

public class TableCellBuilder : TableRowBuilder

継承

objectTableBuilderTableRowBuilderTableCellBuilder

継承したメンバー

メソッド

AddCell()

テーブルにセルを追加します。

public override TableCellBuilder AddCell()

返り値

TableCellBuilder : 現在の Documentize.TableCellBuilder のインスタンスです。

AddParagraph(params string[])

テーブルセルに段落を追加します。

public TableCellBuilder AddParagraph(params string[] paragraphs)

パラメータ

  • paragraphs string[]: 段落のテキスト。

返り値

TableCellBuilder : 現在の Documentize.TableCellBuilder のインスタンスです。

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

情報

Documentize.TableGeneratorプラグインを表します。PDFドキュメントにテーブルを追加するために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfManagerクラスを使用してください。")]
public static class TableGenerator

継承

objectTableGenerator

継承されたメンバー

この例では、PDFファイルにテーブルを追加する方法を示します。

// テーブルオプションを設定
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("名前")
            .AddCell().AddParagraph("年齢")
        .AddRow()
            .AddCell().AddParagraph("ボブ")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("サム")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("サンディ")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("トム")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("ジム")
            .AddCell().AddParagraph("27");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// プロセスを実行
TableGenerator.Process(options);

メソッド

Process(TableOptions)

PDFドキュメントにテーブルを追加します。

public static ResultContainer Process(TableOptions options)

パラメータ

  • options TableOptions: 操作のための指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class TableOptions

情報

Documentize.PdfManagerプラグインによってドキュメントにテーブルを追加するためのオプションを表します。

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsTableOptions

実装

継承されたメンバー

コンストラクター

TableOptions()

デフォルトオプションでDocumentize.TableOptionsオブジェクトの新しいインスタンスを初期化します。

public TableOptions()

メソッド

AddTable()

ドキュメントにテーブルを追加します。

public TableBuilder AddTable()

戻り値

TableBuilder : Documentize.TableBuilderの新しいインスタンス。

Create()

Documentize.TableOptionsのインスタンスを作成します。

public static TableOptions Create()

戻り値

TableOptions : Documentize.TableOptionsの新しいインスタンス。

InsertPageAfter(int)

指定されたページの後にページを挿入します。

public TableOptions InsertPageAfter(int page)

パラメータ

  • page int: テーブルを追加するページ番号。

戻り値

TableOptions : 現在のDocumentize.TableOptionsのインスタンス。

InsertPageBefore(int)

指定されたページの前にページを挿入します。

public TableOptions InsertPageBefore(int page)

パラメータ

  • page int: テーブルを追加するページ番号。

戻り値

TableOptions : 現在のDocumentize.TableOptionsのインスタンス。

名前空間: Documentize アセンブリ: Documentize.dll

Class TableRowBuilder

情報

クラスはテーブル行のビルダーを表します。

public class TableRowBuilder : TableBuilder

継承

objectTableBuilderTableRowBuilder

派生

継承メンバー

メソッド

AddCell()

セルをテーブル行に追加します。

public virtual TableCellBuilder AddCell()

戻り値

TableCellBuilder : 作成されたDocumentize.TableCellBuilderのインスタンス。

AddRow()

AddRowをオーバーライドします。

public override TableRowBuilder AddRow()

戻り値

TableRowBuilder : 現在のDocumentize.TableRowBuilderのインスタンス。

名前空間: Documentize アセンブリ: Documentize.dll

Class TextExtractor

情報

Documentize.TextExtractorプラグインを表します。PDFドキュメントからテキストを抽出するために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfExtractorクラスを使用してください。")]
public static class TextExtractor

継承

objectTextExtractor

継承メンバー

メソッド

Process(ExtractTextOptions)

PDFドキュメントからテキストを抽出します。

public static ResultContainer Process(ExtractTextOptions options)

パラメータ

戻り値

ResultContainer : 抽出の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class TextExtractorOptions

情報

Documentize.TextExtractor プラグインのためのテキスト抽出オプションを表します。

public sealed class TextExtractorOptions

継承

objectTextExtractorOptions

継承メンバー

コンストラクタ

TextExtractorOptions(TextFormattingMode)

指定されたテキストフォーマットモードのために Documentize.TextExtractorOptions オブジェクトの新しいインスタンスを初期化します。

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

パラメーター

プロパティ

FormattingMode

フォーマットモードを取得します。

public TextFormattingMode FormattingMode { get; set; }

プロパティ値

TextFormattingMode

Inputs

操作のための Inputs データを返します。

public List<idatasource> Inputs { get; }

プロパティ値

List<IDataSource>

メソッド

AddInput(IDataSource)

Inputs に新しいデータを追加します。

public void AddInput(IDataSource dataSource)

パラメーター

  • dataSource IDataSource: 追加するデータソース。 :

名前空間: Documentize アセンブリ: Documentize.dll

Class TiffConverter

情報

Documentize.TiffConverter プラグインを表します。PDF ドキュメントを TIFF フォーマットに変換するために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfConverter クラスを使用してください。")]
public static class TiffConverter

継承

objectTiffConverter

継承されたメンバー

メソッド

Process(PdfToTiffOptions)

PDF ドキュメントを TIFF フォーマットに変換します。

public static ResultContainer Process(PdfToTiffOptions options)

パラメーター

  • options PdfToTiffOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Class Timestamp

情報

Documentize.Timestampプラグインを表します。ドキュメントにタイムスタンプを追加するために使用されます。

[Obsolete("このクラスはすぐに削除されます。PdfSecurityクラスを使用してください。")]
public static class Timestamp

継承

objectTimestamp

継承されたメンバー

メソッド

Process(AddTimestampOptions)

指定されたパラメータでDocumentize.Timestamp処理を開始します。

public static ResultContainer Process(AddTimestampOptions options)

パラメータ

  • options AddTimestampOptions: 操作に関する指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

optionsが設定されていない場合。

Namespace: Documentize Assembly: Documentize.dll

Class TimestampOptions

public class TimestampOptions

継承

objectTimestampOptions

継承されたメンバー

コンストラクター

TimestampOptions(string, string)

Documentize.TimestampOptions クラスの新しいインスタンスを初期化します。

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

パラメーター

  • serverUrl string: タイムスタンプサーバーの URL。
  • basicAuthCredentials string: 基本認証資格情報で、ユーザー名とパスワードが “username:password” の文字列として結合されています。

プロパティ

BasicAuthCredentials

基本認証資格情報を取得/設定します。ユーザー名とパスワードが “username:password” の文字列として結合されています。

public string BasicAuthCredentials { get; set; }

プロパティの値

string

ServerUrl

タイムスタンプサーバーの URL を取得/設定します。

public string ServerUrl { get; set; }

プロパティの値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class TocGenerator

情報

Documentize.TocGeneratorプラグインを表します。PDFドキュメントに目次を追加するために使用されます。

[Obsolete("このクラスは近日中に削除されます。PdfManagerクラスを使用してください。")]
public static class TocGenerator

継承

objectTocGenerator

継承されたメンバー

この例はPDFファイルに目次を追加する方法を示します。

// 設定を設定するためにTocOptionsオブジェクトを作成
var options = new TocOptions();
// タイトルを設定
options.Title = "私の目次";
// 見出しを設計
options.Headings.Add(new TocHeading("はじめに", 2));
options.Headings.Add(new TocHeading("第I章", 3));
options.Headings.Add(new TocHeading("第II章", 4));
options.Headings.Add(new TocHeading("第III章", 5));
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
TocGenerator.Process(options);

この例はPDFファイルに目次を追加し、ブックマークを生成する方法を示します。

// 設定を設定するためにTocOptionsオブジェクトを作成
var options = new TocOptions();
// タイトルを設定
options.Title = "私の目次";
// ブックマーク内のリンクを生成
options.GenerateBookmarks = true;
// 見出しを設計
options.Headings.Add(new TocHeading("はじめに", 2, false, 1));
options.Headings.Add(new TocHeading("第I章", 3, true, 1));
options.Headings.Add(new TocHeading("第II章", 4, true, 1));
options.Headings.Add(new TocHeading("例A", 4, true, 2));
options.Headings.Add(new TocHeading("例B", 4, true, 2));
options.Headings.Add(new TocHeading("例C", 4, true, 2));
options.Headings.Add(new TocHeading("例D", 4, true, 2));
options.Headings.Add(new TocHeading("第III章", 5, true, 1));
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
TocGenerator.Process(options);

この例はPDFファイルに目次を追加し、ストリームとして保存する方法を示します。

// 設定を設定するためにTocOptionsオブジェクトを作成
var options = new TocOptions();
// タイトルを設定
options.Title = "私の目次";
// 見出しを設計
options.Headings.Add(new TocHeading("はじめに", 2, false, 1));
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ストリームを設定
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// プロセスを実行
TocGenerator.Process(options);

メソッド

Process(TocOptions)

指定したパラメーターでDocumentize.TocGenerator処理を開始します。

public static ResultContainer Process(TocOptions options)

パラメーター

  • options TocOptions: 操作のための指示を含むオプションオブジェクトです。

返却値

ResultContainer : 操作の結果を含むDocumentize.ResultContainerオブジェクトです。

名前空間: Documentize アセンブリ: Documentize.dll

Class TocHeading

情報

Documentize.PdfManagerプラグインを使用して目次の見出しやタイトルを文書化するためのオプションを表します。

public class TocHeading

継承

objectTocHeading

継承されたメンバー

コンストラクタ

TocHeading(string, int, bool, int)

Documentize.TocHeadingの新しいインスタンスを初期化します。

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

パラメータ

  • text string: 見出しのテキスト。
  • pageNumber int: リンクのページ番号。
  • generateNumbering bool: 番号生成を使用。
  • level int: レベル。

プロパティ

GenerateNumbering

番号生成を使用します。 trueの場合、自動的に番号が付けられます。それ以外の場合は手動で番号を付ける必要があります。

public bool GenerateNumbering { get; set; }

プロパティの値

bool

Level

レベル。 番号生成に使用されます。

public int Level { get; set; }

プロパティの値

int

PageNumber

リンクのためのページ番号。

public int PageNumber { get; set; }

プロパティの値

int

Text

タイトルのテキスト。

public string Text { get; set; }

プロパティの値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class TocOptions

情報

Documentize.PdfManagerプラグインを使用してドキュメントに目次を追加するためのオプションを表します。

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

継承

objectPluginBaseOptionsTocOptions

実装

継承されたメンバー

コンストラクター

TocOptions()

デフォルトオプションでDocumentize.TocOptionsオブジェクトの新しいインスタンスを初期化します。

public TocOptions()

プロパティ

GenerateBookmarks

ブックマーク生成の使用。 trueに設定すると、ブックマークはクリアされ、見出しによって生成されます。それ以外の場合、ブックマークは変更されません。

public bool GenerateBookmarks { get; set; }

プロパティ値

bool

Headings

目次の見出しまたはタイトル。

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

プロパティ値

List<TocHeading>

Title

目次のタイトル。

public string Title { get; set; }

プロパティ値

string

名前空間: Documentize アセンブリ: Documentize.dll

Class XlsConverter

情報

Documentize.XlsConverter プラグインを表します。PDF ドキュメントを XLSX/XLS/CSV/XLSM/ODS 形式に変換するために使用されます。

[Obsolete("このクラスは間もなく削除されます。PdfConverter クラスを使用してください。")]
public static class XlsConverter

継承

objectXlsConverter

継承メンバー

メソッド

Process(PdfToXlsOptions)

PDF ドキュメントを XLSX/XLS/CSV/XLSM/ODS 形式に変換します。

public static ResultContainer Process(PdfToXlsOptions options)

パラメータ

  • options PdfToXlsOptions: 操作の指示を含むオプション オブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

Enum ConvertErrorAction

情報

このクラスは変換エラーに対するアクションを表します。

public enum ConvertErrorAction  

フィールド

  • Delete = 0
  • None = 1

Namespace: Documentize
Assembly: Documentize.dll

Enum ConvertSoftMaskAction

情報

このアクションは、ソフトマスクを使用した画像の変換に関するアクションを表します。

public enum ConvertSoftMaskAction

フィールド

  • ConvertToStencilMask = 1: ソフトマスクはステンシルマスクに変換されます。
  • Default = 0: デフォルトの戦略を使用します。

Namespace: Documentize Assembly: Documentize.dll

Enum DataType

情報

プラグイン処理のためのデータの可能なタイプを表します。

public enum DataType

フィールド

  • Directory = 2: データ型はそのパスで表されるディレクトリです。
  • File = 0: データ型はそのパスで表されるファイルです。
  • Stream = 1: データ型はストリームです。

Namespace: Documentize Assembly: Documentize.dll

Enum DocConversionMode

情報

出力ドキュメントの変換モードを定義します。

public enum DocConversionMode

フィールド

  • Flow = 1: フル認識モードで、エンジンはグループ化と多階層分析を実行して、元のドキュメント作成者の意図を復元し、最大限に編集可能なドキュメントを生成します。欠点は、出力ドキュメントが元のPDFファイルとは異なる見た目になる可能性があることです。
  • TextBox = 0: このモードは高速で、PDFファイルの元の外観を最大限に保持するのに適していますが、結果として得られるドキュメントの編集可能性は制限される可能性があります。元のPDFファイルの視覚的にグループ化された各テキストブロックは、結果のドキュメントのテキストボックスに変換されます。これにより、出力ドキュメントは元のPDFファイルに最大限に類似します。出力ドキュメントは見栄えが良いですが、完全にテキストボックスで構成されており、Microsoft Wordでのさらなる編集がかなり難しくなる可能性があります。これがデフォルトモードです。

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

情報

レンダリング中に使用される可能性のあるメディアタイプを指定します。

public enum HtmlMediaType

フィールド

  • Print = 0: 印刷.
  • Screen = 1: スクリーン.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

情報

ページのサイズとレイアウトを決定するフラグを指定します。

public enum HtmlPageLayoutOption

フィールド

  • FitToWidestContentWidth = 3: ページの幅が指定されたページ幅ではなく、コンテンツサイズ自体から決定されることを示します。
  • None = 0: HtmlPageLayoutOptionがページのサイズやレイアウトに影響を与えないことを示すデフォルト値です。
  • ScaleToPageWidth = 256: ドキュメントの内容がページに合わせてスケーリングされることを示します。

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

情報

PDF文書のPDF/A標準バージョンを指定します。

public enum PdfAStandardVersion

フィールド

  • Auto = 0: PDF/A標準バージョンは自動的に決定されます。
  • PDF_A_1A = 1: PDF/A-1a標準バージョンを指定します。
  • PDF_A_1B = 2: PDF/A-1b標準バージョンを指定します。
  • PDF_A_2A = 3: PDF/A-2a標準バージョンを指定します。
  • PDF_A_2B = 4: PDF/A-2b標準バージョンを指定します。
  • PDF_A_2U = 5: PDF/A-2u標準バージョンを指定します。
  • PDF_A_3A = 6: PDF/A-3a標準バージョンを指定します。
  • PDF_A_3B = 7: PDF/A-3b標準バージョンを指定します。
  • PDF_A_3U = 8: PDF/A-3u標準バージョンを指定します。

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToHtmlOptions.SaveDataType

情報

HTMLファイルの出力タイプを定義します。

public enum PdfToHtmlOptions.SaveDataType

フィールド

  • FileWithEmbeddedResources = 1: 埋め込みリソース付きのファイルにHTMLを保存
  • FileWithExternalResources = 0: 外部リソース付きのファイルにHTMLを保存
  • StreamWithEmbeddedResources = 2: 埋め込みリソース付きのファイルストリームにHTMLを保存

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

情報

xls/xlsx/xml/csvファイル形式を指定することを可能にします。デフォルト値はXLSXです。

xls/xlsx/xml/csvファイル形式を指定することを可能にします。 デフォルト値はXLSXです。

public enum PdfToXlsOptions.ExcelFormat

フィールド

  • CSV = 2: カンマ区切り値 (.csv) ファイル形式。
  • ODS = 4: オープンドキュメントスプレッドシート。
  • XLSM = 3: マクロ対応Office Open XML (.xlsm) ファイル形式。
  • XLSX = 1: Office Open XML (.xlsx) ファイル形式。
  • XMLSpreadSheet2003 = 0: Excel 2003 XML (.xls) ファイル形式。

名前空間: Documentize アセンブリ: Documentize.dll

Enum Role

情報

メッセージの著者の役割。

public enum Role

フィールド

  • Assistant = 2
  • System = 1
  • User = 0

Namespace: Documentize Assembly: Documentize.dll

Enum Rotation

情報

可能な回転値の列挙。

public enum Rotation

フィールド

  • None = 0: 非回転。
  • On180 = 2: 180度回転。
  • On270 = 3: 時計回りに270度回転。
  • On360 = 4: 時計回りに360度回転。
  • On90 = 1: 時計回りに90度回転。

Namespace: Documentize Assembly: Documentize.dll

Enum TextExtractorOptions.TextFormattingMode

情報

PDF ドキュメントをテキストに変換するときに使用できる異なるモードを定義します。Documentize.TextExtractorOptions クラスを参照してください。

public enum TextExtractorOptions.TextFormattingMode

Fields

  • Plain = 2: テキストフラグメントの相対的な位置を考慮しつつ、追加のスペースを加えずに PDF テキストコンテンツを表します。
  • Pure = 0: 少数のフォーマットルーチンを使用して PDF テキストコンテンツを表します。これには、相対的な位置を考慮し、テキストをページの幅に合わせるために追加のスペースを加えることが含まれます。
  • Raw = 1: フォーマットなしの PDF コンテンツをそのまま表します。

Namespace: Documentize Assembly: Documentize.dll

Enum TextFormattingMode

情報

PDF ドキュメントをテキストに変換する際に使用できるさまざまなモードを定義します。Documentize.ExtractTextOptions クラスを参照してください。

public enum TextFormattingMode

フィールド

  • Flatten = 2: PDF コンテンツをテキストフラグメントの座標によって位置づけて表現します。基本的には「Raw」モードに似ています。しかし、「Raw」はドキュメント内のテキストフラグメント(オペレーター)の構造を保持することに重点を置くのに対し、「Flatten」はテキストが読み取られる順序を保持することに重点を置いています。
  • Pure = 0: PDF テキストコンテンツをいくつかのフォーマットルーチンで表現します。これには、相対的な位置を考慮し、テキストをページの幅に合わせるために余分なスペースを追加することが含まれます。
  • Raw = 1: PDF コンテンツをそのまま、すなわちフォーマットなしで表現します。

名前空間: Documentize アセンブリ: Documentize.dll

Enum TiffColorDepth

情報

Documentize.PdfToTiffOptionsのカラー深度を指定するために使用されます。

public enum TiffColorDepth

フィールド

  • Format1bpp = 4: 1ピクセルあたり1ビット。
  • Format24bpp = 1: 1ピクセルあたり24ビット。Rgb。
  • Format32bpp = 0: 1ピクセルあたり32ビット。デフォルトで使用されます。
  • Format4bpp = 3: 1ピクセルあたり4ビット。
  • Format8bpp = 2: 1ピクセルあたり8ビット。

Namespace: Documentize Assembly: Documentize.dll

Enum TiffCompression

情報

Documentize.PdfToTiffOptionsの圧縮タイプを指定するために使用されます。

public enum TiffCompression

フィールド

  • CCITT3 = 2: CCITT3圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてCCITT3エンコーダに渡すことができます。
  • CCITT4 = 1: CCITT4圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてCCITT4エンコーダに渡すことができます。
  • LZW = 0: LZW圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてTiffエンコーダに渡すことができます。
  • None = 4: 圧縮なしを指定します。圧縮カテゴリに属するパラメータとしてTiffエンコーダに渡すことができます。
  • RLE = 3: RLE圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてRLEエンコーダに渡すことができます。

名前空間: Documentize アセンブリ: Documentize.dll

Interface IDataSource

情報

具体的なデータが実装すべき共通メンバーを定義する一般的なデータインターフェース。

public interface IDataSource

プロパティ

DataType

データソースのタイプ。

DataType DataType { get; }

プロパティの値

DataType

名前空間: Documentize アセンブリ: Documentize.dll

Interface IOperationResult

情報

具体的なプラグイン操作結果が実装すべき共通メソッドを定義する一般的な操作結果インターフェイス。

public interface IOperationResult

プロパティ

Data

生データを取得します。

object Data { get; }

プロパティの値

object

IsFile

結果が出力ファイルへのパスであるかどうかを示します。

bool IsFile { get; }

プロパティの値

bool

IsStream

結果が出力ストリームであるかどうかを示します。

bool IsStream { get; }

プロパティの値

bool

IsString

結果がテキスト文字列であるかどうかを示します。

bool IsString { get; }

プロパティの値

bool

メソッド

ToFile()

結果をファイルに変換しようとします。

string ToFile()

戻り値

string : 結果がファイルの場合は出力ファイルへのパスを表す文字列、それ以外の場合は null

ToStream()

結果をストリームオブジェクトに変換しようとします。

Stream ToStream()

戻り値

Stream : 結果がストリームの場合は出力データを表すストリームオブジェクト、それ以外の場合は null

Namespace: Documentize Assembly: Documentize.dll

Interface IPluginOptions

情報

一般的なプラグインオプションインターフェースで、具体的なプラグインオプションが実装すべき共通メソッドを定義します。

public interface IPluginOptions

Namespace: Documentize Assembly: Documentize.dll

クラス FormExporter

情報

Documentize.FormExporter プラグインを表します。PDF ドキュメントのフォーム値を DSV または CSV ファイルにエクスポートするために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfExtractor クラスを使用してください。")]
public static class FormExporter

継承

objectFormExporter

継承されたメンバー

メソッド

Process(ExtractFormDataToDsvOptions)

指定されたパラメータで Documentize.FormExporter 処理を開始します。

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

パラメータ

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

クラス Security

情報

Documentize.Security プラグインを表します。PDF ドキュメントを暗号化および復号化するために使用されます。

[Obsolete("このクラスはまもなく削除されます。PdfSecurity クラスを使用してください。")]
public static class Security

継承

objectSecurity

継承されたメンバー

メソッド

Process(EncryptOptions)

PDF ドキュメントを暗号化します。

public static ResultContainer Process(EncryptOptions options)

パラメータ

  • options EncryptOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

Process(DecryptOptions)

PDF ドキュメントを復号化します。

public static ResultContainer Process(DecryptOptions options)

パラメータ

  • options DecryptOptions: 操作の指示を含むオプションオブジェクトです。

戻り値

ResultContainer : 操作の結果を含むオブジェクトです。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

クラス メッセージ

情報

モデルによって生成されたチャット完了メッセージ。

public class Message

継承

objectMessage

継承されたメンバー

コンストラクター

Message()

public Message()

プロパティ

Content

メッセージの内容です。

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

プロパティ値

string

Role

このメッセージの著者の役割を設定または取得します。

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

プロパティ値

Role

名前空間: Documentize アセンブリ: Documentize.dll

クラスシグネチャ

情報

Documentize.Signatureプラグインを表します。PDF文書に署名するために使用されます。

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

継承

objectSignature

継承されたメンバー

メソッド

Process(SignOptions)

PDF文書に署名します。

public static ResultContainer Process(SignOptions options)

パラメーター

  • options SignOptions: 操作の指示を含むオプションオブジェクト。

戻り値

ResultContainer : 操作の結果を含むオブジェクト。

例外

ArgumentException

オプションが設定されていない場合。

名前空間: Documentize アセンブリ: Documentize.dll

クラスの使用法

情報

補完リクエストの使用統計。

public class Usage

継承

objectUsage

継承されたメンバー

コンストラクター

Usage()

public Usage()

プロパティ

CompletionTokens

生成された補完のトークン数。

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

プロパティの値

int

PromptTokens

プロンプトに含まれるトークン数。

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

プロパティの値

int

TotalTokens

リクエストで使用されたトークンの総数(プロンプト + 補完)。

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

プロパティの値

int

名前空間: Documentize アセンブリ: Documentize.dll

クラスの選択

情報

チャット完了の選択。

public class Choice

継承

objectChoice

継承メンバー

コンストラクタ

Choice()

public Choice()

プロパティ

FinishReason

モデルがトークンの生成を停止した理由。 これは、モデルが自然な停止点に達した場合や 提供された停止シーケンスに達した場合、リクエストで指定されたトークンの最大数に達した場合に停止します。

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

プロパティ値

string

Index

選択肢のリスト内の選択肢のインデックス。

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

プロパティ値

int

Message

モデルによって生成されたチャット完了メッセージ。

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

プロパティ値

Message

名前空間: Documentize アセンブリ: Documentize.dll

クラスライセンス

情報

ライセンスを設定するためのメソッドを提供します。

public static class License

継承

objectLicense

継承されたメンバー

ライセンスをアクティブにする方法を示します。

// ライセンスを設定
License.Set("PathToLicense.lic");

メソッド

Set(string)

コンポーネントにライセンスを付与します。

public static void Set(string licenseName)

パラメーター

  • licenseName string: フルファイル名または短いファイル名が指定できます。評価モードに切り替えるには空の文字列を使用してください。

名前空間: Documentize アセンブリ: Documentize.dll

クラス情報

情報

このクラスは現在の製品ビルドに関する情報を提供します。

public static class Info

継承

objectInfo

継承されたメンバー

フィールド

  • アセンブリバージョン アセンブリバージョン。

public const string AssemblyVersion = “25.11.0”

フィールド値

string

製品

製品名。

public const string Product = "Documentize"

フィールド値

string

名前空間: Documentize アセンブリ: Documentize.dll

 日本語