Documentize Namespace

Model

The model used for the chat completion.

チャット完了に使用されたモデルです。

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

Property Value

プロパティの値

Object

The object type, which is always chat.completion.

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

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

Property Value

プロパティの値

SystemFingerprint

This fingerprint represents the backend configuration that the model runs with.

この指紋は、モデルが実行されるバックエンド構成を表します。

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

Property Value

プロパティの値

Usage

Usage statistics for the completion request.

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

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

Property Value

プロパティの値

Usage

Namespace: Documentize
Assembly: Documentize.dll

Class ChatGptConsts

情報

このクラスは定数の格納場所を表します。

public static class ChatGptConsts

継承

object ← ChatGptConsts

継承されたメンバー

フィールド

ApiUrl

public static string ApiUrl

フィールドの値

ModelName

public static string ModelName

フィールドの値

SystemRole

public static string SystemRole

フィールドの値

SystemRoleDescription

public static string SystemRoleDescription

フィールドの値

UserRole

public static string UserRole

フィールドの値

Namespace: Documentize
Assembly: Documentize.dll

Class ChatGptRequestOptions

情報

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

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ChatGptRequestOptions

Implements

IPluginOptions

Inherited Members

Constructors

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

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

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

Parameters

apiKey string: ChatGPT API へアクセスするためのキー。
model string: ChatGPT のモデル名。デフォルトモデルは gpt-3.5-turbo-1106 です。
apiUrl string: ChatGPT API の URL。デフォルトは https://api.openai.com/v1/chat/completions です。
query string: ChatGPT への文字列リクエスト。

Properties

ApiKey

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

public string ApiKey { get; set; }

Property Value

ApiUrl

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

public string ApiUrl { get; set; }

Property Value

CancellationToken

キャンセルトークン。

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

MaxTokens

レスポンス内の最大トークン数。デフォルトは null（無制限）です。

public int? MaxTokens { get; set; }

Property Value

int?

Messages

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

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

Property Value

List<Message>

Remarks

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

最初のメッセージ（存在する場合）は options.Query から取得され、内容が「You are a helpful assistant.」でロールが「system」のメッセージが先行します。
次に（存在する場合）options.Messages コレクションのメッセージが追加されます。
ファイルソースからのメッセージ（存在する場合）は最後に追加され、各ドキュメントにつき「user」ロールのメッセージが 1 つ作成されます。
1 つもメッセージが提供されない場合は ArgumentException がスローされます。

Model

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

public string Model { get; set; }

Property Value

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Property Value

Query

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

public string Query { get; set; }

Property Value

Temperature

使用するサンプリング温度（0〜2 の範囲）。
0.8 のような高い値は出力をよりランダムにし、0.2 のような低い値は出力をより集中させ決定的にします。デフォルトは 1 です。

public double Temperature { get; set; }

Property Value

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

Class Choice

情報

チャット完了の選択肢です。

public class Choice

継承

object ← Choice

継承されたメンバー

コンストラクター

Choice()

public Choice()

プロパティ

FinishReason

モデルがトークンの生成を停止した理由です。
モデルが自然な停止点や指定された停止シークエンスに達した場合、またはリクエストで指定された最大トークン数に達した場合に停止します。

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

プロパティの値

Index

選択肢リスト内のインデックスです。

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

プロパティの値

Message

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

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

プロパティの値

Message

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

Class CompressOptions

情報

Documentize.PdfManager コンポーネントの圧縮オプションを表します。

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← CompressOptions

Implements

IPluginOptions

Inherited Members

Constructors

CompressOptions()

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

public CompressOptions()

Namespace: Documentize Assembly: Documentize.dll

Class DecryptionOptions

情報

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

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← DecryptionOptions

実装

IPluginOptions

継承メンバー

コンストラクター

DecryptionOptions(string)

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

public DecryptionOptions(string ownerPassword)

パラメーター

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

プロパティ

OwnerPassword

オーナーパスワード。

public string OwnerPassword { get; set; }

プロパティ値

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

Class DecryptOptions

情報

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

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ←
PluginBaseOptions ←
DecryptOptions

Implements

IPluginOptions

Inherited Members

Constructors

DecryptOptions(string)

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

public DecryptOptions(string ownerPassword)

Parameters

ownerPassword string: 所有者パスワード。

Properties

OwnerPassword

所有者パスワード。

public string OwnerPassword { get; set; }

Property Value

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

Class DirectoryData

情報

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

public sealed class DirectoryData : IData

継承

object ← DirectoryData

実装

IData

継承されたメンバー

コンストラクター

DirectoryData(string)

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

public DirectoryData(string path)

パラメーター

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

プロパティ

DataType

データソースの種類。

public DataType DataType { get; }

プロパティ値

Path

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

public string Path { get; }

プロパティ値

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

Class DirectoryDataSource

情報

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

public sealed class DirectoryDataSource : IDataSource

継承

object ← DirectoryDataSource

実装

IDataSource

継承メンバー

コンストラクター

DirectoryDataSource(string)

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

public DirectoryDataSource(string path)

パラメーター

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

プロパティ

DataType

データソースの種類。

public DataType DataType { get; }

プロパティ値

Path

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

public string Path { get; }

プロパティ値

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

Class DocConverter

情報

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

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

継承

object ← DocConverter

継承されたメンバー

メソッド

Process(PdfToDocOptions)

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

public static ResultContainer Process(PdfToDocOptions options)

パラメータ

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

戻り値

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

例外

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

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

Class EncryptionOptions

情報

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

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← EncryptionOptions

Implements

IPluginOptions

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

UserPassword

ユーザーのパスワード。

public string UserPassword { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class EncryptOptions

情報

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

public class EncryptOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← EncryptOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

EncryptOptions(string, string)

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

public EncryptOptions(string ownerPassword, string userPassword)

パラメーター

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

プロパティ

OwnerPassword

オーナーパスワード。

public string OwnerPassword { get; set; }

プロパティの型

UserPassword

ユーザーパスワード。

public string UserPassword { get; set; }

プロパティの型

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

Class ExtractFormDataToDsvOptions

情報

Documentize.PdfForm と Documentize.PdfExtractor コンポーネントのフィールドのエクスポート値のオプションを表します。

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

ExtractFormDataToDsvOptions(char, bool)

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

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

パラメーター

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

プロパティ

AddFieldName

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

public bool AddFieldName { get; set; }

プロパティ値

Delimiter

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

public char Delimiter { get; set; }

プロパティ値

char

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

Class ExtractImagesOptions

情報

Documentize.PdfExtractor コンポーネントの画像抽出オプションを表します。

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

継承

object ←
PluginBaseOptions ←
ExtractImagesOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

ExtractImagesOptions()

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

public ExtractImagesOptions()

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

Class ExtractPropertiesOptions

情報

Documentize.PdfExtractor コンポーネント用の PDF プロパティ抽出オプションを表します。

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Inheritance

object ← OptionsWithInput ← ExtractPropertiesOptions

Implements

IHaveInput

Inherited Members

Constructors

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

指定された入力データで Documentize.ExtractPropertiesOptions オブジェクトの新しいインスタンスを初期化します。

public ExtractPropertiesOptions(IData inputData)

Parameters

inputData IData: 入力データ。

ExtractPropertiesOptions(string)

指定された入力ファイルで Documentize.ExtractPropertiesOptions オブジェクトの新しいインスタンスを初期化します。

public ExtractPropertiesOptions(string inputFile)

Parameters

inputFile string: 入力ファイルのパス。

ExtractPropertiesOptions(Stream)

指定された入力ストリームで Documentize.ExtractPropertiesOptions オブジェクトの新しいインスタンスを初期化します。

public ExtractPropertiesOptions(Stream inputStream)

Parameters

inputStream Stream: 入力ストリーム。

Properties

Input

入力データを取得または設定します。

public override IData Input { get; set; }

Property Value

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

Class ExtractTextOptions

情報

Documentize.PdfExtractor コンポーネントのテキスト抽出オプションを表します。

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

継承

object ← OptionsWithInput ← ExtractTextOptions

実装

IHaveInput

継承メンバー

コンストラクタ

ExtractTextOptions(TextFormattingMode)

指定されたテキスト書式設定モードの Documentize.ExtractTextOptions オブジェクトの新しいインスタンスを初期化します。

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

パラメーター

formattingMode TextFormattingMode: テキスト書式設定モードの値。

ExtractTextOptions(IData, TextFormattingMode)

指定されたデータで Documentize.ExtractTextOptions オブジェクトの新しいインスタンスを初期化します。

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

パラメーター

data IData: 入力データ。
formattingMode TextFormattingMode: テキスト書式設定モードの値。

ExtractTextOptions(string, TextFormattingMode)

指定されたファイルで Documentize.ExtractTextOptions オブジェクトの新しいインスタンスを初期化します。

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

パラメーター

file string: 入力ファイルのパス。
formattingMode TextFormattingMode: テキスト書式設定モードの値。

ExtractTextOptions(Stream, TextFormattingMode)

指定されたストリームで Documentize.ExtractTextOptions オブジェクトの新しいインスタンスを初期化します。

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

パラメーター

stream Stream: 入力ストリーム。
formattingMode TextFormattingMode: テキスト書式設定モードの値。

プロパティ

FormattingMode

書式設定モードを取得または設定します。

public TextFormattingMode FormattingMode { get; set; }

プロパティ値

TextFormattingMode

Input

入力データを取得または設定します。

public override IData Input { get; set; }

プロパティ値

Namespace: Documentize Assembly: Documentize.dll

Class FileData

情報

ロードおよび保存操作のためのファイルデータを表します。

public sealed class FileData : IData

継承

object ← FileData

実装

IData

継承されたメンバー

コンストラクター

FileData(string)

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

public FileData(string path)

パラメーター

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

プロパティ

DataType

データソースのタイプ。

public DataType DataType { get; }

プロパティの値

Path

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

public string Path { get; }

プロパティの値

メソッド

ToString()

インスタンスを System.String に変換します。

public override string ToString()

戻り値

string : ファイルへのパス。

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

Class FileDataSource

情報

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

public sealed class FileDataSource : IDataSource

継承

object ← FileDataSource

実装

IDataSource

継承メンバー

コンストラクタ

FileDataSource(string)

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

public FileDataSource(string path)

パラメータ

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

プロパティ

DataType

データソースの種類。

public DataType DataType { get; }

プロパティの値

Path

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

public string Path { get; }

プロパティの値

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

Class FileResult

情報

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

public sealed class FileResult : IOperationResult

Inheritance

object ← FileResult

Implements

IOperationResult

Inherited Members

Properties

Data

生データを取得します。

public object Data { get; }

Property Value

IsFile

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

public bool IsFile { get; }

Property Value

IsStream

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

public bool IsStream { get; }

Property Value

IsString

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

public bool IsString { get; }

Property Value

Methods

ToFile()

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

public string ToFile()

Returns

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

ToStream()

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

public Stream ToStream()

Returns

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

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

Class FlattenFieldsOptions

情報

Documentize.PdfForm コンポーネントによって文書内のフィールドをフラット化するためのオプションを表します。

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← FlattenFieldsOptions

Implements

IPluginOptions

Inherited Members

Constructors

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Properties

SkipFields

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

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

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class FormExporter

情報

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

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

継承

object ← FormExporter

継承メンバー

メソッド

Process(ExtractFormDataToDsvOptions)

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

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

パラメーター

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

戻り値

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

例外

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

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

Class FormExportToDsvOptions

情報

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

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← FormExportToDsvOptions

実装

IPluginOptions

継承されたメンバー

コンストラクタ

FormExportToDsvOptions(char, bool)

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

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

パラメーター

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

プロパティ

AddFieldName

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

public bool AddFieldName { get; set; }

プロパティの値

Delimeter

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

public char Delimeter { get; set; }

プロパティの値

char

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

Class FormFlattener

情報

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

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

継承

object ← FormFlattener

継承されたメンバー

メソッド

GetFieldNames(string)

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

public static List<string> GetFieldNames(string path)

パラメーター

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

戻り値

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

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

public static List<string> GetFieldNames(Stream stream)

パラメーター

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

戻り値

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

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

public static ResultContainer Process(FlattenFieldsOptions options)

パラメーター

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

戻り値

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

例外

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

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

Class FormFlattenerOptions

情報

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

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← FormFlattenerOptions

実装

IPluginOptions

継承メンバー

コンストラクター

FormFlattenerOptions()

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

public FormFlattenerOptions()

プロパティ

SkipFields

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

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

プロパティの値

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

Class GetFieldNamesOptions

情報

Documentize.PdfForm コンポーネントによるドキュメントのフィールド名取得オプションを表します。

public class GetFieldNamesOptions : OptionsWithInput, IHaveInput

継承

object ← OptionsWithInput ← GetFieldNamesOptions

実装

IHaveInput

継承メンバー

コンストラクター

GetFieldNamesOptions(string)

入力パスを指定するオプションのコンストラクター。

public GetFieldNamesOptions(string path)

パラメーター

path string: 入力ファイルへのパス。

GetFieldNamesOptions(Stream)

入力ストリームを指定するオプションのコンストラクター。

public GetFieldNamesOptions(Stream stream)

パラメーター

stream Stream: 入力ストリーム。

プロパティ

Input

入力データを取得または設定します。

public override IData Input { get; set; }

プロパティの値

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

Class HtmlConverter

情報

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

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

継承

object ←
HtmlConverter

継承メンバー

メソッド

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

Inheritance

object ←
PluginBaseOptions ←
HtmlToPdfOptions

Implements

IPluginOptions

Inherited Members

Constructors

HtmlToPdfOptions()

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

public HtmlToPdfOptions()

Properties

BasePath

HTML ファイルのベースパス/URL。

public string BasePath { get; set; }

Property Value

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

Property Value

PageInfo

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

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

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

Class ImageExtractor

情報

Documentize.ImageExtractor コンポーネントを表します。PDF ドキュメントから画像を抽出するために使用されます。

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

Inheritance

object ← ImageExtractor

Inherited Members

Methods

Process(ExtractImagesOptions)

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

public static ResultContainer Process(ExtractImagesOptions options)

Parameters

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

Returns

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

Exceptions

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

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractorOptions

情報

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

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← ImageExtractorOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

ImageExtractorOptions()

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

public ImageExtractorOptions()

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

Class Info

情報

このクラスは現在の製品ビルドに関する情報を提供します。

public static class Info

継承

object ← Info

継承されたメンバー

フィールド

AssemblyVersion アセンブリバージョン。

public const string AssemblyVersion = "26.9.0"

フィールド値

製品

製品名。

public const string Product = "Documentize"

フィールド値

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

Class JpegConverter

情報

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

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

継承

object ← JpegConverter

継承されたメンバー

メソッド

Process(PdfToJpegOptions)

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

public static ResultContainer Process(PdfToJpegOptions options)

パラメータ

options PdfToJpegOptions: Documentize.JpegConverter に対する指示を含むオプションオブジェクト。

戻り値

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

例外

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

Namespace: Documentize Assembly: Documentize.dll

Class License

情報

ライセンスを設定するメソッドを提供します。

public static class License

継承

object ← License

継承されたメンバー

例

ライセンスの有効化方法を示します。

// ライセンスを設定
License.Set("PathToLicense.lic");

メソッド

Set(string)

コンポーネントにライセンスを設定します。

public static void Set(string licenseName)

パラメーター

licenseName string: 完全なファイル名または短いファイル名のいずれかを指定できます。空文字列を使用すると評価モードに切り替わります。

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

Class MergeOptions

情報

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

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← MergeOptions

実装

IPluginOptions

継承されたメンバー

コンストラクタ

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

継承

object ← Merger

継承メンバー

メソッド

Process(MergeOptions)

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

public static ResultContainer Process(MergeOptions options)

パラメーター

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

戻り値

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

例外

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

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

Class Message

情報

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

public class Message

継承

object ← Message

継承されたメンバー

コンストラクター

Message()

public Message()

プロパティ

Content

メッセージの内容。

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

プロパティの型

Role

このメッセージの作者のロールを設定または取得します。

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

プロパティの型

Role

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

Class ObjectResult

情報

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

public sealed class ObjectResult : IOperationResult

継承

object ← ObjectResult

実装

IOperationResult

継承されたメンバー

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティの値

IsFile

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

public bool IsFile { get; }

プロパティの値

IsObject

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

public bool IsObject { get; }

プロパティの値

IsStream

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

public bool IsStream { get; }

プロパティの値

IsString

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

public bool IsString { get; }

プロパティの値

Text

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

public string Text { get; }

プロパティの値

メソッド

ToFile()

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

public string ToFile()

戻り値

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

ToStream()

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

public Stream ToStream()

戻り値

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

ToString()

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

public override string ToString()

戻り値

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

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

Class OptimizeOptions

情報

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

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

IPluginOptions

Inherited Members

Constructors

OptimizeOptions()

Documentize.OptimizeOptions オブジェクトの新しいインスタンスを、既定のオプションで初期化します。
ドキュメントをリニアライズして、次のことを実現します。

最初のページをできるだけ速く開く。
次のページや次のページへのリンクをできるだけ速く表示する。
データが遅い回線でページごとに届く際、ページが到着した順に段階的に表示し、最も有用なデータを先に表示する。
ページ全体が受信・表示される前でも、リンクをたどるなどのユーザー操作を可能にする。

public OptimizeOptions()

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

Class Optimizer

情報

Documentize.Optimizer プラグインを表します。PDF ドキュメントの最適化、回転、リサイズ、圧縮に使用します。

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

継承

object ← Optimizer

継承メンバー

メソッド

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 OptionsWithInput

情報

1 つの入力データを持つ操作の基礎オプションを表します。

public abstract class OptionsWithInput : IHaveInput

継承

object ← OptionsWithInput

派生

実装

IHaveInput

継承メンバー

フィールド

input

protected IData input

フィールド値

プロパティ

Input

入力データを取得または設定します。

public virtual IData Input { get; set; }

プロパティ値

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

Class OptionsWithInputAndOutput

情報

1 つの入力データと 1 つの出力データを持つ操作の基本オプションを表します。

public abstract class OptionsWithInputAndOutput : OptionsWithInput, IHaveInput

継承

object ←
OptionsWithInput ←
OptionsWithInputAndOutput

派生

実装

IHaveInput

継承されたメンバー

フィールド

output

protected IData output

フィールドの型

プロパティ

Output

出力データを取得または設定します。

public virtual IData Output { get; set; }

プロパティの型

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

Class PageInfo

情報

ページ情報を表します。

public class PageInfo : PageSize

Inheritance

object ← PageSize ← PageInfo

Inherited Members

コンストラクタ

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

プロパティの値

MarginLeft

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

public double MarginLeft { get; set; }

プロパティの値

MarginRight

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

public double MarginRight { get; set; }

プロパティの値

MarginTop

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

public double MarginTop { get; set; }

プロパティの値

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

Class PageSize

情報

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

public class PageSize

継承

object ← PageSize

派生クラス

PageInfo

継承メンバー

コンストラクター

PageSize()

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

public PageSize()

PageSize(double, double)

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

public PageSize(double width, double height)

パラメーター

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

プロパティ

A0

A0 サイズ (1189×840 mm)。

public static PageSize A0 { get; }

プロパティの値

A1

A1 サイズ (840×594 mm)。

public static PageSize A1 { get; }

プロパティの値

A2

A2 サイズ (594×420 mm)。

public static PageSize A2 { get; }

プロパティの値

A3

A3 サイズ (420×297 mm)。

public static PageSize A3 { get; }

プロパティの値

A4

A4 サイズ (297×210 mm)。

public static PageSize A4 { get; }

プロパティの値

A5

A5 サイズ (210×148 mm)。

public static PageSize A5 { get; }

プロパティの値

A6

A6 サイズ (148×105 mm)。

public static PageSize A6 { get; }

プロパティの値

B5

B5 サイズ (250×176 mm)。

public static PageSize B5 { get; }

プロパティの値

Height

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

public double Height { get; set; }

プロパティの値

IsLandscape

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

public bool IsLandscape { get; }

プロパティの値

P11x17

11×17 インチ形式。

public static PageSize P11x17 { get; }

プロパティの値

PageLedger

Ledger サイズ (432×279 mm)。

public static PageSize PageLedger { get; }

プロパティの値

PageLegal

Legal サイズ (356×216 mm)。

public static PageSize PageLegal { get; }

プロパティの値

PageLetter

Letter サイズ (279×216 mm)。

public static PageSize PageLetter { get; }

プロパティの値

Width

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

public double Width { get; set; }

プロパティの値

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

Class PdfAConverter

情報

PDF文書をPDF/A形式に変換し、PDF/Aの適合性を検証するプラグインを表します。

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

継承

object ← PdfAConverter

継承されたメンバー

メソッド

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
オプションが設定されていない場合。

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAConvertOptions

情報

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

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfAConvertOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfAConvertOptions()

public PdfAConvertOptions()

Properties

Outputs

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

public List<idatasource> Outputs { get; }

Property Value

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

継承

object ←
PdfAOptionsBase

派生

実装

IPluginOptions

継承されたメンバー

コンストラクター

PdfAOptionsBase()

protected PdfAOptionsBase()

プロパティ

AlignText

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

public bool AlignText { get; set; }

プロパティの値

備考

true に設定すると、変換プロセスは元のテキストセグメントの境界を復元しようとします。
ほとんどの文書では、デフォルトの false のままで問題なく、テキスト配置はデフォルト変換プロセス中に変更されません。

CheckDifferentNamesInFontDictionaries

ソース PDF 文書が PDF 仕様に合致しない場合の PDF/A 変換を制御するフラグを取得します。

public bool CheckDifferentNamesInFontDictionaries { get; set; }

プロパティの値

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

プロパティの値

ConvertErrorAction

IccProfileFileName

PDF/A 変換時に既定のプロファイルの代わりに使用する ICC（International Color Consortium）プロファイルのファイル名を取得または設定します。

public string IccProfileFileName { get; set; }

プロパティの値

Inputs

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

public List<idata> Inputs { get; }

プロパティの値

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

プロパティの値

LogOutputSource

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

public IData LogOutputSource { get; set; }

プロパティの値

OptimizeFileSize

PDF/A 変換プロセス中にファイルサイズの縮小を試みるかどうかを示す値を取得または設定します。

public bool OptimizeFileSize { get; set; }

プロパティの値

備考

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

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

public void AddInput(IData data)

パラメーター

data IData: 入力データ。

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAValidateOptions

情報

PDF ドキュメントの PDF/A 準拠性を Documentize.PdfConverter プラグインで検証するためのオプションを表します。

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

継承

object ← PdfAOptionsBase ← PdfAValidateOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

PdfAValidateOptions()

public PdfAValidateOptions()

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

Class PdfAValidationResult

情報

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

public sealed class PdfAValidationResult

Inheritance

object ← PdfAValidationResult

Inherited Members

Fields

Data

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

public readonly IData Data

Field Value

IsValid

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

public readonly bool IsValid

Field Value

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Field Value

PdfAStandardVersion

Namespace: Documentize
Assembly: Documentize.dll

Class PdfChatGpt

情報

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

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

継承

object ←
PdfChatGpt

継承されたメンバー

Remarks

Documentize.PdfChatGpt は、ChatGPT へ直接リクエストを送信したり、PDF ファイルをソースとして追加したりして、返信を出力先に保存するために使用されます。

Methods

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>

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

例外

Namespace: Documentize
Assembly: Documentize.dll

Class PdfChatGptOptions

情報

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

public class PdfChatGptOptions : IPluginOptions

継承されたメンバー

コンストラクター

PdfChatGptOptions()

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

public PdfChatGptOptions()

プロパティ

Inputs

public List<idatasource> Inputs { get; }

プロパティの値

Outputs

public List<idatasource> Outputs { get; }

プロパティの値

メソッド

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

継承

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

実装

IPluginOptions

継承されたメンバー

コンストラクタ

PdfChatGptRequestOptions()

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

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

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

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

パラメーター

apiKey string: ChatGPT APIにアクセスするためのキー。
model string: ChatGPTモデルの名前。デフォルトモデルは: gpt-3.5-turbo-1106:
apiUrl string: ChatGPT API URL。デフォルトURLは: https://api.openai.com/v1/chat/completions。
query string: ChatGPTへのリクエスト文字列。

プロパティ

ApiKey

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

public string ApiKey { get; set; }

プロパティ値

ApiUrl

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

public string ApiUrl { get; set; }

プロパティ値

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

プロパティ値

NumberOfChoices

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

public int NumberOfChoices { get; set; }

プロパティ値

Query

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

public string Query { get; set; }

プロパティ値

Temperature

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

public double Temperature { get; set; }

プロパティ値

名前空間: 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

Inheritance

object ←
PdfConverter

Inherited Members

Methods

Convert(PdfToDocOptions)

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

public static ResultContainer Convert(PdfToDocOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

例外

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

Convert(PdfToXlsOptions)

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

public static ResultContainer Convert(PdfToXlsOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

例外

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

Convert(PdfToHtmlOptions)

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

public static ResultContainer Convert(PdfToHtmlOptions options)

パラメーター

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

戻り値

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

例

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

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

例外

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

Convert(HtmlToPdfOptions)

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

public static ResultContainer Convert(HtmlToPdfOptions options)

パラメーター

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

戻り値

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

例

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

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

例外

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

Convert(PdfToJpegOptions)

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

public static ResultContainer Convert(PdfToJpegOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

この例は PDF ドキュメントをストリームへ変換する方法を示しています。

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

例外

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

Convert(PdfToPngOptions)

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

public static ResultContainer Convert(PdfToPngOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

この例は PDF ドキュメントをストリームへ変換する方法を示しています。

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

例外

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

Convert(PdfToTiffOptions)

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

public static ResultContainer Convert(PdfToTiffOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

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

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

この例は圧縮とカラーデプスを設定して PDF ドキュメントを TIFF 形式に変換する方法を示しています。

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

この例は PDF ドキュメントをストリームへ変換する方法を示しています。

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

例外

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

Convert(PdfToPdfAOptions)

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

public static ResultContainer Convert(PdfToPdfAOptions options)

パラメーター

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

戻り値

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

例

この例は PDF ドキュメントを PDF/A 形式（この例では PDF/A‑3b）に変換する方法を示しています。

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

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

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

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

例外

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

Validate(PdfAValidateOptions)

PDF ドキュメントが指定された PDF/A 形式に準拠しているかをチェックします。

public static ResultContainer Validate(PdfAValidateOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

// Check the resultContainer.ResultCollection property for validation results for each file:
foreach (var result in resultContainer.ResultCollection)
{
    var validationResult = (PdfAValidationResult)result.Data;
    var isValid = validationResult.IsValid; // Validation result for document
}

例外

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

Namespace: Documentize
Assembly: Documentize.dll

Class PdfConverterOptions

情報

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

public abstract class PdfConverterOptions : IPluginOptions

継承

object ← PdfConverterOptions

派生

PdfToXlsOptions

実装

IPluginOptions

継承されたメンバー

プロパティ

入力

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

public List<idatasource> Inputs { get; }

プロパティの値

出力

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

public List<idatasource> Outputs { get; }

プロパティの値

メソッド

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

継承

object ← PdfExtractor

継承されたメンバー

メソッド

Extract(ExtractTextOptions)

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

public static string Extract(ExtractTextOptions options)

パラメーター

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

戻り値

string : 抽出されたテキスト。

例

この例は PDF ファイルからテキストコンテンツを抽出する方法を示しています。

// Create ExtractTextOptions object to set input file path
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

この例は PDF ストリームからテキストコンテンツを抽出する方法を示しています。

// Create ExtractTextOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

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

// Create ExtractTextOptions object to set input file path and TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

この例は最も簡潔な形式で PDF ファイルからテキストを抽出する方法を示しています。

// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

例外

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

Extract(ExtractImagesOptions)

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

public static ResultContainer Extract(ExtractImagesOptions options)

パラメーター

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

戻り値

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

例

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

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

この例はフォルダーを使わずにストリームへ画像を抽出する方法を示しています。

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

例外

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

Extract(ExtractFormDataToDsvOptions)

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

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

パラメーター

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

戻り値

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

例

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

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

この例は TSV ファイルにフォームの値をエクスポートし、プロパティを設定する方法を示しています。

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

例外

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

Extract(ExtractPropertiesOptions)

PDF ドキュメントからプロパティを抽出します。

public static PdfProperties Extract(ExtractPropertiesOptions options)

パラメーター

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

戻り値

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

例

この例は PDF ファイルからプロパティ（FileName、Title、Author、Subject、Keywords、Created、Modified、Application、PDF Producer、ページ数）を抽出する方法を示しています。

// Create ExtractPropertiesOptions object to set input file
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var filename = pdfProperties.FileName;
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

この例は PDF ストリームからプロパティ（Title、Author、Subject、Keywords、Created、Modified、Application、PDF Producer、ページ数）を抽出する方法を示しています。

// Create ExtractPropertiesOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

この例は最も簡潔な形式で PDF ファイルからプロパティを抽出する方法を示しています。

// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

例外

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

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

Class PdfForm

情報

Documentize.PdfForm コンポーネントを表します。フラット化、フォームデータの抽出に使用します。また、フィールド名の取得も可能です。

Represents Documentize.PdfForm component. Used to Flatten, Extract Forms Data. Also allows you to Get Fields Names.

public static class PdfForm

継承

object ← PdfForm

継承されたメンバー

メソッド

Extract(ExtractFormDataToDsvOptions)

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

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

パラメーター

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

戻り値

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

例

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

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

この例は、フォームの値を TSV ファイルにエクスポートし、プロパティを設定する方法を示しています。

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

例外

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

Flatten(FlattenFieldsOptions)

PDF ドキュメント内のフィールドをフラット化します。

public static ResultContainer Flatten(FlattenFieldsOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

例外

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

GetNames(GetFieldNamesOptions)

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

public static List<string> GetNames(GetFieldNamesOptions options)

パラメーター

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

戻り値

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

例

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

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

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

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

Remove(RemoveFieldsOptions) : Remove Fields from PDF document.

public static ResultContainer Remove(RemoveFieldsOptions options)

パラメーター

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

戻り値

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

例

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

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

例外

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

情報

Documentize.PdfManager コンポーネントを表します。PDF ドキュメントの結合、分割、最適化、回転、サイズ変更、圧縮、およびテーブル追加、目次追加に使用されます。複数の PDF ドキュメントを単一の PDF に結合できます。PDF ドキュメントを個別のページに分割できます。PDF ドキュメントを最適化、回転、サイズ変更、圧縮できます。PDF ドキュメントのページを回転、サイズ変更できます。PDF ドキュメントにテーブルを追加できます。PDF ドキュメントに目次を追加できます。

Documentize.PdfManager コンポーネントを表します。PDF ドキュメントの結合、分割、最適化、回転、サイズ変更、圧縮、およびテーブル追加、目次追加に使用されます。
複数の PDF ドキュメントを単一の PDF に結合できます。
PDF ドキュメントを個別のページに分割できます。
PDF ドキュメントを最適化、回転、サイズ変更、圧縮できます。
PDF ドキュメントのページを回転、サイズ変更できます。
PDF ドキュメントにテーブルを追加できます。
PDF ドキュメントに目次を追加できます。

public static class PdfManager

Inheritance

object ←
PdfManager

Inherited Members

Methods

AddTable(TableOptions)

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

public static ResultContainer AddTable(TableOptions options)

パラメータ

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

戻り値

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

例

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

// Configure table options
var options = new TableOptions();
options.InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

この例は 2 ページの前にテーブルを追加する方法を示します。

// Configure table options
var options = new TableOptions();
options.InsertPageBefore(2) // Add table before page 2
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

例外

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

AddTableOfContents(TocOptions)

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

public static ResultContainer AddTableOfContents(TocOptions options)

パラメータ

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

戻り値

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

例

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

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

この例はブックマークを生成しながら目次を追加する方法を示します。

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

この例は目次をストリームとして保存する方法を示します。

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

この例は目次の見出しをカスタマイズして追加する方法を示します。

// Create TocOptions object to set instructions
var heading = new TocHeading();
heading.Text = "Intro";
heading.PageNumber = 5;
heading.GenerateNumbering = true;
heading.Level = 2;
var tocOptions = new TocOptions();
tocOptions.Headings.Add(heading);
// Add input and output files
tocOptions.AddInput(new FileData("path_to_your_pdf_file.pdf"));
tocOptions.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Generate the TOC with customized options
PdfManager.AddTableOfContents(tocOptions);

例外

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

Compress(CompressOptions)

PDF ドキュメントを圧縮します。サイズ削減を試みます。

public static ResultContainer Compress(CompressOptions options)

パラメータ

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

戻り値

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

例

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

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

例外

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

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

ChatGpt の返信から PDF ドキュメントを作成します。
ChatGPT へ直接リクエストを送信するか、PDF ファイルをソースとして追加し、返信を出力先に保存できます。

public static Task<ResultContainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

パラメータ

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

戻り値

Task<ResultContainer>

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

例

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

例外

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

Merge(MergeOptions)

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

public static ResultContainer Merge(MergeOptions options)

パラメータ

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

戻り値

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

例

この例は 2 つの PDF ドキュメントを結合する方法を示します。

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

例外

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

Optimize(OptimizeOptions)

PDF ドキュメントを最適化します。
ドキュメントをリニアライズし、

最初のページをできるだけ早く開く、
次のページやリンク先ページをできるだけ早く表示する、
ページデータが遅い回線で段階的に届く際に、ページを段階的に表示する（最も有用なデータを先に表示）、
ページ全体が受信・表示される前でも、リンククリックなどのユーザー操作を可能にする

ようにします。

public static ResultContainer Optimize(OptimizeOptions options)

パラメータ

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

戻り値

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

例

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

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

例外

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

Resize(ResizeOptions)

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

public static ResultContainer Resize(ResizeOptions options)

パラメータ

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

戻り値

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

例

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

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

例外

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

Rotate(RotateOptions)

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

public static ResultContainer Rotate(RotateOptions options)

パラメータ

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

戻り値

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

例

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

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

例外

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

Split(SplitOptions)

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

public static ResultContainer Split(SplitOptions options)

パラメータ

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

戻り値

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

例

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

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

例外

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

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

Class PdfProperties

情報

PDF ドキュメントのプロパティとメタ情報を表します。

public class PdfProperties

継承

object ← PdfProperties

継承されたメンバー

コンストラクター

PdfProperties()

public PdfProperties()

プロパティ

Application

PDF アプリケーションを取得または設定します。

public string Application { get; set; }

プロパティ値

Author

PDF の著者を取得または設定します。

public string Author { get; set; }

プロパティ値

Created

PDF の作成日を取得または設定します。

public DateTime? Created { get; set; }

プロパティ値

DateTime?

FileName

利用可能な場合、PDF のファイル名を取得または設定します。

public string FileName { get; set; }

プロパティ値

Keywords

PDF のキーワードを取得または設定します。

public string Keywords { get; set; }

プロパティ値

Modified

PDF の更新日を取得または設定します。

public DateTime? Modified { get; set; }

プロパティ値

DateTime?

NumberOfPages

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

public int NumberOfPages { get; set; }

プロパティ値

PdfProducer

PDF のプロデューサーを取得または設定します。

public string PdfProducer { get; set; }

プロパティ値

Subject

PDF の件名を取得または設定します。

public string Subject { get; set; }

プロパティ値

Title

PDF のタイトルを取得または設定します。

public string Title { get; set; }

プロパティ値

PdfToHtmlOptions.SaveDataType

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

Class PdfSecurity

情報

Documentize.PdfSecurity コンポーネントを表します。PDF ドキュメントの暗号化、復号、署名、サニタイズに使用されます。

public static class PdfSecurity

Inheritance

object ← PdfSecurity

Inherited Members

Methods

Decrypt(DecryptOptions)

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

public static ResultContainer Decrypt(DecryptOptions options)

Parameters

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

Returns

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

Examples

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

// 復号オプション オブジェクトを作成して指示を設定
var options = new DecryptOptions("123456");
// 入力ファイルパスを追加
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfSecurity.Decrypt(options);

Exceptions

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

Encrypt(EncryptOptions)

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

public static ResultContainer Encrypt(EncryptOptions options)

Parameters

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

Returns

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

Examples

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

// 暗号化オプション オブジェクトを作成して指示を設定
var options = new EncryptOptions("123456", "qwerty");
// 入力ファイルパスを追加
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// 処理を実行
PdfSecurity.Encrypt(options);

Exceptions

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

Sanitize(SanitizeOptions)

PDF ドキュメントから隠しデータをサニタイズし、メタデータ、添付ファイル、注釈、JavaScript、フォーム、レイヤー、検索インデックス、プライベートコンテンツなどの機密情報や不要な情報を削除または変換します。

public static ResultContainer Sanitize(SanitizeOptions options)

Parameters

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

Returns

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

Examples

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

// 入出力ファイルを設定したサニタイズオプション オブジェクトを作成
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// 処理を実行
PdfSecurity.Sanitize(options);

この例はストリーム間で PDF をサニタイズする方法を示します。

// 入出力ストリームを用意
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream = new MemoryStream();
// 入出力ストリームを設定したサニタイズオプション オブジェクトを作成
var options = new SanitizeOptions(inputStream, outputStream);
// 処理を実行
PdfSecurity.Sanitize(options);

この例はファイルからストリームへ PDF をサニタイズする方法を示します。

// 出力ストリームを用意
using var outputStream = new MemoryStream();
// 入力ファイルと出力ストリームを設定したサニタイズオプション オブジェクトを作成
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", outputStream);
// 処理を実行
PdfSecurity.Sanitize(options);

この例は、入力と出力プロパティを手動で設定してファイルからストリームへ PDF をサニタイズする方法を示します。

// 出力ストリームを用意
using var outputStream = new MemoryStream();
// サニタイズオプション オブジェクトを作成
var options = new SanitizeOptions();
// 入力ファイルを設定
options.Input = new FileData("path_to_your_pdf_file.pdf");
// 出力ストリームを設定
options.Output = new StreamData(outputStream);
// 処理を実行
PdfSecurity.Sanitize(options);

この例はメタデータを削除せずに PDF をサニタイズする方法を示します。

// 入出力ファイルを設定したサニタイズオプション オブジェクトを作成
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveMetadata = false;
// 処理を実行
PdfSecurity.Sanitize(options);

この例は添付ファイルを削除せずに PDF をサニタイズする方法を示します。

// 入出力ファイルを設定したサニタイズオプション オブジェクトを作成
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveAttachments = false;
// 処理を実行
PdfSecurity.Sanitize(options);

この例はすべてのページを画像に変換し、出力 DPI を設定して PDF をサニタイズする方法を示します。

// 入出力ファイルを設定したサニタイズオプション オブジェクトを作成
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// 変換を有効にし DPI を設定
options.ConvertPagesToImages = true;
options.ImageDpi = 200;
// 処理を実行
PdfSecurity.Sanitize(options);

この例は JavaScript とアクションを削除せずに PDF をサニタイズする方法を示します。

// 入出力ファイルを設定したサニタイズオプション オブジェクトを作成
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveJavaScriptsAndActions = false;
// 処理を実行
PdfSecurity.Sanitize(options);

この例は最も簡潔な書き方で PDF をサニタイズする方法を示します。

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

Exceptions

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

Sign(SignOptions)

デジタル署名により PDF ドキュメントに署名します。

public static ResultContainer Sign(SignOptions options)

Parameters

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

Returns

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

Examples

この例は PDF ドキュメントに署名する方法を示します。

// 署名オプション オブジェクトを作成して指示を設定
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 処理を実行
PdfSecurity.Sign(options);

この例はストリームを使用して PDF に署名する方法を示します。

// ストリームを用意
using var pdfStreamInput = File.OpenRead(@"path_to_your_pdf_file.pdf");
using var pfxStreamInput = File.OpenRead(@"path_to_your_pfx_file.pfx");
using var pdfStreamOutput = new MemoryStream();
// 署名オプション オブジェクトを作成して指示を設定
var options = new SignOptions(pdfStreamInput, pdfStreamOutput, pfxStreamInput, "password_of_your_pfx_file");
// 処理を実行
PdfSecurity.Sign(options);

この例は入力と出力パラメータを個別に設定して PDF に署名する方法を示します。

// 署名オプション オブジェクトを作成して指示を設定
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 入出力ファイルパスを設定
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("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.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// 処理を実行
PdfSecurity.Sign(options);

この例は不可視署名で PDF に署名する方法を示します。

// 署名オプション オブジェクトを作成して指示を設定
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 不可視署名を設定
options.Visible = false;
// 処理を実行
PdfSecurity.Sign(options);

この例は追加オプションを設定して PDF に署名する方法を示します。

// 署名オプション オブジェクトを作成して指示を設定
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf","path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 任意のパラメータ
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// 処理を実行
PdfSecurity.Sign(options);

この例は最も簡潔な書き方で PDF に署名する方法を示します。

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

この例はタイムスタンプ付きで PDF に署名する方法を示します。

// タイムスタンプを設定した署名オプション オブジェクトを作成
var options = new SignOptions(new TimestampOptions("server_url"));
// 入出力ファイルパスを設定
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// 処理を実行
PdfSecurity.Sign(options);

Exceptions

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

Namespace: Documentize
Assembly: Documentize.dll

Class PdfToDocOptions

情報

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

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

継承

object ←
PluginBaseOptions ←
PdfToDocOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

PdfToDocOptions()

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

public PdfToDocOptions()

プロパティ

Mode

PDF ドキュメントをワードプロセッサ用ドキュメントに変換する方法を制御できます。

public DocConversionMode Mode { get; set; }

プロパティ値

DocConversionMode

補足

生成されたドキュメントをそれほど頻繁に編集しない場合は、Documentize.DocConversionMode.TextBox モードを使用してください。テキストボックスは少量の編集であれば簡単に変更できます。

出力ドキュメントでさらに編集が必要な場合は、Documentize.DocConversionMode.Flow モードを使用してください。Flow モードでは段落やテキスト行が容易に修正できますが、サポートされていない書式設定オブジェクトは Documentize.DocConversionMode.TextBox モードより見栄えが悪くなります。

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

Class PdfToHtmlOptions

情報

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

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToHtmlOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToHtmlOptions(SaveDataType)

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

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

Parameters

outputDataType PdfToHtmlOptions.SaveDataType: 出力データタイプ。

Properties

OutputDataType

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

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Property Value

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

Class PdfToJpegOptions

情報

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

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

継承

object ←
PluginBaseOptions ←
PdfToJpegOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

PdfToJpegOptions()

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

public PdfToJpegOptions()

プロパティ

OutputResolution

結果として得られる画像の解像度を取得または設定します。

public int OutputResolution { get; set; }

プロパティの型

PageList

処理対象となるページの一覧を取得または設定します。

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

プロパティの型

List<int>

Quality

出力品質を取得および設定します。
画像の圧縮レベルを指定します。
有効な品質の範囲は 0 から 100 です。
指定した数値が小さいほど圧縮率が高くなり、画像の品質は低くなります。
0 は最低品質、100 は最高品質を表します。

public int Quality { get; set; }

プロパティの型

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

Class PdfToPdfAOptions

情報

Documentize.PdfConverter プラグインを使用して PDF 文書を PDF/A フォーマットに変換するためのオプションを表します。

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

継承

object ←
PdfAOptionsBase ←
PdfToPdfAOptions

実装

IPluginOptions

継承メンバー

コンストラクター

PdfToPdfAOptions()

public PdfToPdfAOptions()

プロパティ

Outputs

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

public List<IData> Outputs { get; }

プロパティの型

メソッド

AddOutput(IData)

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

public void AddOutput(IData data)

パラメーター

data IData: 保存操作の結果を保存するためのターゲット（ファイルまたはストリームデータソース）。

Namespace: Documentize
Assembly: Documentize.dll

Class PdfToPngOptions

情報

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

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← PdfToPngOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

PdfToPngOptions()

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

public PdfToPngOptions()

プロパティ

OutputResolution

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

public int OutputResolution { get; set; }

プロパティ値

PageList

処理対象のページの一覧を取得または設定します。

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

プロパティ値

List<int>

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

Class PdfToTiffOptions

情報

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

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToTiffOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToTiffOptions()

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

public PdfToTiffOptions()

Properties

ColorDepth

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

public TiffColorDepth ColorDepth { get; set; }

Property Value

TiffColorDepth

Remarks

既定値は Documentize.TiffColorDepth.Format32bpp です。

Compression

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

public TiffCompression Compression { get; set; }

Property Value

TiffCompression

Remarks

既定値は Documentize.TiffCompression.LZW です。

MultiPage

すべてのページを 1 つのマルチページ TIFF に保存できるかどうかのフラグを取得および設定します。

既定値は false です。

public bool MultiPage { get; set; }

Property Value

OutputResolution

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

public int OutputResolution { get; set; }

Property Value

PdfToXlsOptions.ExcelFormat

PageList

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

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

Property Value

List<int>

Namespace: Documentize
Assembly: Documentize.dll

Class PdfToXlsOptions

情報

Documentize.PdfConverter プラグインの PDF から XLS/XLSX へのコンバータオプションを表します。

public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← PdfToXlsOptions

実装

IPluginOptions

継承されたメンバー

コンストラクタ

PdfToXlsOptions()

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

public PdfToXlsOptions()

プロパティ

Format

出力フォーマット。

public PdfToXlsOptions.ExcelFormat Format { get; set; }

プロパティの値

InsertBlankColumnAtFirst

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

public bool InsertBlankColumnAtFirst { get; set; }

プロパティの値

MinimizeTheNumberOfWorksheets

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

public bool MinimizeTheNumberOfWorksheets { get; set; }

プロパティの値

Namespace: Documentize
Assembly: Documentize.dll

Class PluginBaseOptions

情報

コンポーネントの基本オプションを表します。

public class PluginBaseOptions : IPluginOptions

Inheritance

object ← PluginBaseOptions

Derived

Implements

IPluginOptions

Inherited Members

Properties

CloseInputStreams

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

public bool CloseInputStreams { get; set; }

Property Value

CloseOutputStreams

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

public bool CloseOutputStreams { get; set; }

Property Value

Inputs

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

public List<idata> Inputs { get; }

Property Value

Outputs

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

public List<idata> Outputs { get; }

Property Value

Methods

AddInput(IData)

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

public void AddInput(IData data)

Parameters

data IData: 追加するデータ。

AddOutput(IData)

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

public void AddOutput(IData data)

Parameters

data IData: 追加するデータ。

Namespace: Documentize
Assembly: Documentize.dll

Class PngConverter

情報

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

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

継承

object ← PngConverter

継承されたメンバー

メソッド

Process(PdfToPngOptions)

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

public static ResultContainer Process(PdfToPngOptions options)

パラメーター

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

戻り値

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

例外

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

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

Class Rectangle

情報

クラスは矩形を表します。

public class Rectangle

継承

object ← Rectangle

継承されたメンバー

コンストラクター

Rectangle(double, double, double, double)

Rectangle のコンストラクター。

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

パラメーター

llx double: 左下隅の X 座標。
lly double: 左下隅の Y 座標。
urx double: 右上隅の X 座標。
ury double: 右上隅の Y 座標。

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

Class RemoveFieldsOptions

情報

Documentize.PdfForm プラグインによるドキュメントのフィールド削除オプションを表します。

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← RemoveFieldsOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

RemoveFieldsOptions()

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

public RemoveFieldsOptions()

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

Class ResizeOptions

情報

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

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← ResizeOptions

実装

IPluginOptions

継承されたメンバー

コンストラクタ

ResizeOptions()

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

public ResizeOptions()

プロパティ

PageSize

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

public PageSize PageSize { get; set; }

プロパティの値

Namespace: Documentize
Assembly: Documentize.dll

Class ResultContainer

情報

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

public class ResultContainer

継承

object ← ResultContainer

継承されたメンバー

プロパティ

ResultCollection

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

public List<IOperationResult> ResultCollection { get; }

プロパティの値

List<IOperationResult>
IOperationResult

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

Class RotateOptions

情報

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

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← RotateOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

RotateOptions()

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

public RotateOptions()

プロパティ

Rotation

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

public Rotation Rotation { get; set; }

プロパティ値

Rotation

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

Class SanitizeOptions

情報

ドキュメント内の隠しデータをサニタイズするための設定オプションを表します。

public class SanitizeOptions : OptionsWithInputAndOutput, IHaveInput

Inheritance

object ← OptionsWithInput ← OptionsWithInputAndOutput ← SanitizeOptions

Implements

IHaveInput

Inherited Members

Constructors

SanitizeOptions()

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

public SanitizeOptions()

SanitizeOptions(IData, IData)

指定された入力データで Documentize.SanitizeOptions オブジェクトの新しいインスタンスを初期化します。

public SanitizeOptions(IData inputData, IData outputData = null)

Parameters

inputData IData: 入力データ。
outputData IData: 出力データ。

SanitizeOptions(string, string)

指定された入力ファイルと出力ファイルで Documentize.SanitizeOptions オブジェクトの新しいインスタンスを初期化します。

public SanitizeOptions(string inputFile, string outputFile)

Parameters

inputFile string: 入力ファイルのパス。
outputFile string: 出力ファイルのパス。

SanitizeOptions(Stream, Stream)

指定された入力ストリームと出力ストリームで Documentize.SanitizeOptions オブジェクトの新しいインスタンスを初期化します。

public SanitizeOptions(Stream inputStream, Stream outputStream)

Parameters

inputStream Stream: 入力ストリーム。
outputStream Stream: 出力ストリーム。

SanitizeOptions(string, Stream)

指定された入力ファイルと出力ストリームで Documentize.SanitizeOptions オブジェクトの新しいインスタンスを初期化します。

public SanitizeOptions(string inputFile, Stream outputStream)

Parameters

inputFile string: 入力ファイルのパス。
outputStream Stream: 出力ストリーム。

SanitizeOptions(Stream, string)

指定された入力ストリームと出力ファイルで Documentize.SanitizeOptions オブジェクトの新しいインスタンスを初期化します。

public SanitizeOptions(Stream inputStream, string outputFile)

Parameters

inputStream Stream: 入力ストリーム。
outputFile string: 出力ファイルのパス。

Properties

ConvertPagesToImages

ページを画像に変換するオプションを取得または設定します。
ページを画像に変換する処理は、他のオプションで制御される主な隠しデータのクリア後に実行されます。
デフォルトは false です。

public bool ConvertPagesToImages { get; set; }

Property Value

FlattenForms

サニタイズ処理中にドキュメントのフォームをフラット化するかどうかを取得または設定します。
フォームをフラット化すると、インタラクティブなフォームフィールドが静的コンテンツに変換され、編集や入力ができなくなります。
デフォルトは true です。

public bool FlattenForms { get; set; }

Property Value

FlattenLayers

PDF ドキュメント内のレイヤーをフラット化するオプションを取得または設定します。
有効にすると、ドキュメント内のすべてのレイヤーが単一のレイヤーに統合され、個別の構造が削除されます。
このオプションは、レイヤー内に隠しデータが残らないように内容を単純化してサニタイズする際に有用です。
デフォルトは true です。

public bool FlattenLayers { get; set; }

Property Value

ImageDpi

ページを画像に変換する際の画像解像度 (DPI) を取得または設定します。
このプロパティは Documentize.SanitizeOptions.ConvertPagesToImages が true の場合にのみ有効です。

public int ImageDpi { get; set; }

Property Value

Input

入力データを取得または設定します。

public override IData Input { get; set; }

Property Value

Output

出力データを取得または設定します。

public override IData Output { get; set; }

Property Value

RemoveAnnotations

ドキュメントから注釈を削除するかどうかを取得または設定します。
有効にすると、サニタイズ処理中にドキュメント内のすべての注釈が削除され、注釈の赤字処理 (Redact) が適用されます。
デフォルトは true です。

public bool RemoveAnnotations { get; set; }

Property Value

RemoveAttachments

ドキュメントからすべての添付ファイルを削除するオプションを取得または設定します。
有効にすると、PDF 内の添付ファイルがサニタイズ処理中に除去されます。
デフォルトは true です。

public bool RemoveAttachments { get; set; }

Property Value

RemoveJavaScriptsAndActions

ドキュメントから JavaScript および関連するアクションを削除するかどうかを取得または設定します。
このオプションは、埋め込みスクリプトによってもたらされる潜在的なセキュリティ脆弱性を排除するために有用です。
デフォルトは true です。

public bool RemoveJavaScriptsAndActions { get; set; }

Property Value

RemoveMetadata

ドキュメントからメタデータを削除するオプションを取得または設定します。
true に設定すると、ドキュメントプロパティや追加の埋め込みメタデータ情報などがサニタイズ中に除去されます。
デフォルトは true です。

public bool RemoveMetadata { get; set; }

Property Value

RemoveSearchIndexAndPrivateInfo

検索インデックスとプライベート情報をドキュメントから削除するかどうかを取得または設定します。
埋め込み検索インデックスやプライベートデータを除去することで、文書のセキュリティとプライバシーが向上します。
デフォルトは true です。

public bool RemoveSearchIndexAndPrivateInfo { get; set; }

Property Value

Namespace: Documentize
Assembly: Documentize.dll

Class Security

情報

Documentize.Security プラグインを表します。PDF ドキュメントの暗号化と復号に使用されます。

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

継承

object ←
Security

継承されたメンバー

メソッド

Process(EncryptOptions)

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

public static ResultContainer Process(EncryptOptions options)

パラメータ

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

戻り値

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

例外

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

Process(DecryptOptions)

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

public static ResultContainer Process(DecryptOptions options)

パラメータ

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

戻り値

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

例外

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

Namespace: Documentize
Assembly: Documentize.dll

Class Signature

情報

Documentize.Signature プラグインを表します。PDF ドキュメントの署名に使用されます。

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

継承

object ← Signature

継承されたメンバー

メソッド

Process(SignOptions)

PDF ドキュメントに署名します。

public static ResultContainer Process(SignOptions options)

パラメータ

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

戻り値

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

例外

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

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

Class SignOptions

情報

Documentize.PdfSecurity コンポーネントの署名オプションを表します。

public sealed class SignOptions : OptionsWithInputAndOutput, IHaveInput

Inheritance

object ← OptionsWithInput ← OptionsWithInputAndOutput ← SignOptions

Implements

IHaveInput

Inherited Members

Constructors

SignOptions(Stream, string)

Documentize.SignOptions オブジェクトの新しいインスタンスを初期化し、pfx ストリームとパスワードを設定します。

public SignOptions(Stream pfx, string password)

Parameters

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

SignOptions(string, string)

Documentize.SignOptions オブジェクトの新しいインスタンスを初期化し、pfx ファイルとパスワードを設定します。

public SignOptions(string pfx, string password)

Parameters

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

SignOptions(IData, IData, IData, string)

Documentize.SignOptions オブジェクトの新しいインスタンスを初期化し、入力、出力、pfx データおよびパスワードを設定します。

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

Parameters

inputData IData: 入力データ。
outputData IData: 出力データ。
pfxData IData: pfx データ。
password string: pfx のパスワード。

SignOptions(string, string, string, string)

Documentize.SignOptions オブジェクトの新しいインスタンスを初期化し、入力、出力、pfx ファイルおよびパスワードを設定します。

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

Parameters

inputFile string: 入力ファイルのパス。
outputFile string: 出力ファイルのパス。
pfxFile string: pfx ファイルへのパス。
pfxPassword string: pfx のパスワード。

SignOptions(Stream, Stream, Stream, string)

Documentize.SignOptions オブジェクトの新しいインスタンスを初期化し、入力、出力、pfx ストリームとパスワードを設定します。

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

Parameters

inputStream Stream: 入力ファイルのストリーム。
outputStream Stream: 出力ファイルのストリーム。
pfxStream Stream: pfx ストリーム。
pfxPassword string: pfx のパスワード。

SignOptions(TimestampOptions)

Documentize.SignOptions オブジェクトの新しいインスタンスを初期化し、タイムスタンプを設定します。
タイムスタンプは、別個の署名としてドキュメントに設定できます。

public SignOptions(TimestampOptions timestampOptions)

Parameters

timestampOptions TimestampOptions: 証明書を提供せずにタイムスタンプ署名を作成するために使用されるタイムスタンプオプション。

Properties

Contact

署名の連絡先情報。

public string Contact { get; set; }

Property Value

Input

入力データを取得または設定します。

public override IData Input { get; set; }

Property Value

Location

署名の場所。

public string Location { get; set; }

Property Value

Name

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

public string Name { get; set; }

Property Value

Output

出力データを取得または設定します。

public override IData Output { get; set; }

Property Value

PageNumber

署名を行うページ番号。

public int PageNumber { get; set; }

Property Value

Pfx

PFX データを含むストリーム。

public Stream Pfx { get; set; }

Property Value

Stream

PfxPassword

Documentize.SignOptions.Pfx のパスワード。

public string PfxPassword { get; set; }

Property Value

Reason

署名の理由。

public string Reason { get; set; }

Property Value

Rectangle

署名の矩形領域。

public Rectangle Rectangle { get; set; }

Property Value

Rectangle

TimestampOptions

タイムスタンプオプション。
証明書を提供せずにタイムスタンプ署名を作成するために使用されます。
このプロパティが設定され、かつ Documentize.SignOptions コンストラクタに証明書が提供された場合、デジタル署名は埋め込みタイムスタンプでタイムスタンプされます。
このプロパティが設定されているがコンストラクタに証明書が提供されていない場合、タイムスタンプは別個の署名として追加されます。

public TimestampOptions TimestampOptions { get; set; }

Property Value

TimestampOptions

Visible

署名の可視性。
デフォルトは true。

public bool Visible { get; set; }

Property Value

Namespace: Documentize
Assembly: Documentize.dll

Class SplitOptions

情報

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

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← SplitOptions

実装

IPluginOptions

継承メンバー

コンストラクター

SplitOptions()

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

public SplitOptions()

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

Class Splitter

情報

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

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

継承

object ← Splitter

継承されたメンバー

メソッド

Process(SplitOptions)

ページ単位で PDF ドキュメントを分割します。

public static ResultContainer Process(SplitOptions options)

パラメータ

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

戻り値

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

例外

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

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

Class StreamData

情報

ロードと保存操作のためのストリームデータを表します。

public sealed class StreamData : IData

継承

object ←
StreamData

実装

IData

継承されたメンバー

コンストラクター

StreamData(Stream)

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

public StreamData(Stream data)

パラメーター

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

プロパティ

Data

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

public Stream Data { get; }

プロパティの値

Stream

DataType

データの種類（ストリーム）。

public DataType DataType { get; }

プロパティの値

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

Class StreamDataSource

情報

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

public sealed class StreamDataSource : IDataSource

継承

object ← StreamDataSource

実装

IDataSource

継承メンバー

コンストラクタ

StreamDataSource(Stream)

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

public StreamDataSource(Stream data)

パラメータ

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

プロパティ

Data

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

public Stream Data { get; }

プロパティ値

Stream

DataType

データソースのタイプ（ストリーム）。

public DataType DataType { get; }

プロパティ値

Namespace: Documentize Assembly: Documentize.dll

Class StreamResult

情報

Streamの形で操作結果を表します。

public sealed class StreamResult : IOperationResult

Inheritance

object ← StreamResult

Implements

IOperationResult

Inherited Members

Properties

Data

生のデータを取得します。

public object Data { get; }

Property Value

IsFile

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

public bool IsFile { get; }

Property Value

IsStream

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

public bool IsStream { get; }

Property Value

IsString

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

public bool IsString { get; }

Property Value

Methods

ToFile()

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

public string ToFile()

Returns

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

ToStream()

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

public Stream ToStream()

Returns

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

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

Class StringResult

情報

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

public sealed class StringResult : IOperationResult

継承

object ← StringResult

実装

IOperationResult

継承メンバー

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティ値

IsFile

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

public bool IsFile { get; }

プロパティ値

IsStream

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

public bool IsStream { get; }

プロパティ値

IsString

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

public bool IsString { get; }

プロパティ値

Text

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

public string Text { get; }

プロパティ値

メソッド

ToFile()

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

public string ToFile()

戻り値

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

ToStream()

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

public Stream ToStream()

戻り値

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

ToString()

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

public override string ToString()

戻り値

string : 結果が文字列の場合はテキスト内容を表す文字列。そうでない場合は base.ToString() の戻り値を返します。

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

Class TableBuilder

情報

Class は PDF ページ内のテーブルのビルダーを表します。

public class TableBuilder

Inheritance

object ← TableBuilder

Derived

TableRowBuilder

Inherited Members

Methods

AddRow()

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

public virtual TableRowBuilder AddRow()

Returns

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

AddTable()

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

public TableBuilder AddTable()

Returns

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

InsertPageAfter(int)

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

public TableOptions InsertPageAfter(int page)

Parameters

page int: テーブルを挿入する対象ページのページ番号。

Returns

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

InsertPageBefore(int)

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

public TableOptions InsertPageBefore(int page)

Parameters

page int: テーブルを挿入する対象ページのページ番号。

Returns

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

Operators

implicit operator TableOptions(TableBuilder)

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

public static implicit operator TableOptions(TableBuilder builder)

Parameters

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

Returns

TableOptions : PdfGeneratorTableOptions への変換結果。

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

Class TableCellBuilder

情報

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

public class TableCellBuilder : TableRowBuilder

Inheritance

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Inherited Members

Methods

AddCell()

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

public override TableCellBuilder AddCell()

Returns

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

AddParagraph(params string[])

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

public TableCellBuilder AddParagraph(params string[] paragraphs)

Parameters

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

Returns

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

Namespace: Documentize
Assembly: Documentize.dll

Class TableGenerator

情報

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

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

Inheritance

object ← TableGenerator

Inherited Members

Examples

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

// Configure table options
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");

// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));

// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));

// Perform the process
TableGenerator.Process(options);

Methods

Process(TableOptions)

PDF ドキュメントに表を追加します。

public static ResultContainer Process(TableOptions options)

Parameters

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

Returns

ResultContainer – 操作の結果を格納したオブジェクト。

Exceptions

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

Namespace: Documentize
Assembly: Documentize.dll

Class TableOptions

情報

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

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

継承

object ←
PluginBaseOptions ←
TableOptions

実装

IPluginOptions

継承されたメンバー

コンストラクター

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 のインスタンス。

Namespace: Documentize
Assembly: Documentize.dll

Class TableRowBuilder

情報

Class はテーブル行のビルダーを表します。

public class TableRowBuilder : TableBuilder

継承

object ← TableBuilder ← TableRowBuilder

派生クラス

TableCellBuilder

継承されたメンバー

メソッド

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("The class will be deleted soon. Please use PdfExtractor class.")]
public static class TextExtractor

継承

object ← TextExtractor

継承されたメンバー

メソッド

Process(ExtractTextOptions)

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

public static string Process(ExtractTextOptions options)

パラメータ

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

戻り値

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

例外

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

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

Class TextExtractorOptions

情報

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

public sealed class TextExtractorOptions

継承

object ← TextExtractorOptions

継承メンバー

コンストラクタ

TextExtractorOptions(TextFormattingMode)

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

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

パラメーター

formattingMode TextFormattingMode: テキストフォーマットモードの値。

プロパティ

FormattingMode

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

public TextFormattingMode FormattingMode { get; set; }

プロパティ値

TextFormattingMode

Inputs

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

public List<idatasource> Inputs { get; }

プロパティ値

メソッド

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

パラメーター

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

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

Class TiffConverter

情報

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

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

Inheritance

object ← TiffConverter

Inherited Members

Methods

Process(PdfToTiffOptions)

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

public static ResultContainer Process(PdfToTiffOptions options)

Parameters

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

Returns

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

Exceptions

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

Namespace: Documentize Assembly: Documentize.dll

Class Timestamp

情報

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

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

継承

object ← Timestamp

継承されたメンバー

メソッド

Process(AddTimestampOptions)

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

public static ResultContainer Process(AddTimestampOptions options)

パラメータ

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

戻り値

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

例外

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

Namespace: Documentize Assembly: Documentize.dll

Class TimestampOptions

public class TimestampOptions

継承

object ←
TimestampOptions

継承されたメンバー

コンストラクタ

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

プロパティの値

ServerUrl

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

public string ServerUrl { get; set; }

プロパティの値

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

Class TocGenerator

情報

Documentize.TocGenerator プラグインを表します。PDF 文書に目次を追加するために使用します。

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

継承

object ← TocGenerator

継承されたメンバー

使用例

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

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

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

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

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

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

メソッド

Process(TocOptions)

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

public static ResultContainer Process(TocOptions options)

パラメータ

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

戻り値

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

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

情報

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

public class TocHeading

継承

object ← TocHeading

継承されたメンバー

コンストラクター

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 の場合は自動で番号付けが行われ、false の場合は手動で番号付けを行います。

public bool GenerateNumbering { get; set; }

プロパティの値

Level

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

public int Level { get; set; }

プロパティの値

PageNumber

リンク先のページ番号。

public int PageNumber { get; set; }

プロパティの値

Text

タイトルのテキスト。

public string Text { get; set; }

プロパティの値

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

Class TocOptions

情報

Documentize.PdfManager プラグインにより、ドキュメントに目次を追加するオプションを表します。

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

継承

object ←
PluginBaseOptions ←
TocOptions

実装

IPluginOptions

継承されたメンバー

コンストラクタ

TocOptions()

Documentize.TocOptions オブジェクトをデフォルトオプションで新規作成します。

public TocOptions()

プロパティ

GenerateBookmarks

ブックマークの生成を使用します。
true に設定するとブックマークはクリアされ、見出しに基づいて生成されます。false の場合、ブックマークは変更されません。

public bool GenerateBookmarks { get; set; }

プロパティの型

Headings

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

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

プロパティの型

List<TocHeading>

Title

目次のタイトル。

public string Title { get; set; }

プロパティの型

Namespace: Documentize
Assembly: Documentize.dll

Class Usage

情報

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

public class Usage

継承

object ←
Usage

継承されたメンバー

コンストラクター

Usage()

public Usage()

プロパティ

CompletionTokens

生成された補完に含まれるトークン数。

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

プロパティの値

PromptTokens

プロンプトに含まれるトークン数。

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

プロパティの値

TotalTokens

リクエストで使用されたトークンの総数（プロンプト + 補完）。

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

プロパティの値

Namespace: Documentize
Assembly: Documentize.dll

Class XlsConverter

情報

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

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

継承

object ←
XlsConverter

継承されたメンバー

メソッド

Process(PdfToXlsOptions)

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

public static ResultContainer Process(PdfToXlsOptions options)

パラメーター

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

戻り値

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

例外

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

Namespace: Documentize
Assembly: Documentize.dll

Enum ConvertErrorAction

情報

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

public enum ConvertErrorAction

Fields

Delete = 0
None = 1

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

Enum ConvertSoftMaskAction

情報

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

public enum ConvertSoftMaskAction

Fields

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

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

Enum DataType

情報

コンポーネント処理のためのデータの可能な型を表します。

public enum DataType

フィールド

Directory = 2: ディレクトリ型で、パスで表されます。
File = 0: ファイル型で、パスで表されます。
Stream = 1: ストリーム型です。

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

Enum DocConversionMode

情報

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

public enum DocConversionMode

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

情報

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

public enum HtmlMediaType

Fields

Print = 0: 印刷。
Screen = 1: 画面。

Namespace: Documentize
Assembly: Documentize.dll

Enum HtmlPageLayoutOption

情報

ページサイズとレイアウトを決定する他のオプションと組み合わせるフラグを指定します。

public enum HtmlPageLayoutOption

Fields

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

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

Enum PdfAStandardVersion

情報

PDF ドキュメントの PDF/A 標準バージョンを指定します。

public enum PdfAStandardVersion

Fields

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 標準バージョンを指定します。

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

Enum PdfToHtmlOptions.SaveDataType

情報

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

public enum PdfToHtmlOptions.SaveDataType

Fields

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

Fields

CSV = 2: カンマ区切り値 (.csv) ファイル形式。
ODS = 4: Open Document Spreadsheet。
XLSM = 3: マクロ有効 Office Open XML (.xlsm) ファイル形式。
XLSX = 1: Office Open XML (.xlsx) ファイル形式。
XMLSpreadSheet2003 = 0: Excel 2003 XML (.xls) ファイル形式。

Namespace: Documentize
Assembly: Documentize.dll

Enum Role

情報

メッセージの作成者の役割です。

public enum Role

フィールド

Assistant = 2
System = 1
User = 0

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

Enum Rotation

情報

可能な回転値の列挙。

public enum Rotation

Fields

None = 0: 回転していません。
On180 = 2: 180度回転。
On270 = 3: 時計回りに270度回転。
On360 = 4: 時計回りに360度回転。
On90 = 1: 時計回りに90度回転。

名前空間: Documentize
アセンブリ: 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

Fields

Flatten = 2: 座標に基づいてテキストフラグメントを配置することでPDFコンテンツを表現します。基本的には「Raw」モードと似ていますが、「Raw」が文書内のテキストフラグメント（演算子）の構造を保持することに重点を置くのに対し、「Flatten」はテキストが読み取られる順序を保持することに重点を置きます。
Pure = 0: いくつかのフォーマット処理を施したPDFテキストコンテンツを表します。相対位置を考慮し、ページ幅に合わせてテキストを整列させるために余分なスペースを追加することが含まれます。
Raw = 1: PDFコンテンツをそのまま表します。つまり、フォーマットは行いません。

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

Enum TiffColorDepth

情報

Documentize.PdfToTiffOptions のカラーデプスを指定するために使用します。

public enum TiffColorDepth

Fields

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

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

Enum TiffCompression

情報

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

public enum TiffCompression

Fields

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

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

Interface IData

情報

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

public interface IData

Properties

DataType

データソースのタイプ。

DataType DataType { get; }

プロパティの値

Namespace: Documentize
Assembly: Documentize.dll

Interface IDataSource

情報

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

public interface IDataSource

プロパティ

DataType

データソースのタイプ。

DataType DataType { get; }

プロパティの値

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

Interface IHaveInput

情報

オプションが実装すべき入力データを定義する汎用データインターフェース。

public interface IHaveInput

Properties

Input

入力データを取得または設定します。

IData Input { get; set; }

プロパティ値

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

Interface IOperationResult

情報

具体的なコンポーネントの操作結果が実装すべき共通メソッドを定義する、汎用的な操作結果インターフェイスです。

public interface IOperationResult

プロパティ

Data

生のデータを取得します。

object Data { get; }

プロパティの型

IsFile

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

bool IsFile { get; }

プロパティの型

IsStream

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

bool IsStream { get; }

プロパティの型

IsString

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

bool IsString { get; }

プロパティの型