Class AddTimestampOptions

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

継承

object ← PluginBaseOptions ← AddTimestampOptions

実装

• IPluginOptions

継承メンバー

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

コンストラクター

AddTimestampOptions(Stream, string, string, string)

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

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

パラメータ

• pfx Stream: pfx ファイルへのパス。
• password string: pfx ファイルのパスワード。
• serverUrl string: タイムスタンプサーバーの URL。
• serverBasicAuthCredentials string: 基本認証情報。ユーザー名とパスワードを “username:password” の形式で結合した文字列です。(オプション)。

AddTimestampOptions(string, string, string, string)

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

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

パラメータ

• pfx string: pfx ファイルへのパス。
• password string: pfx ファイルのパスワード。
• serverUrl string: タイムスタンプサーバーの URL。
• serverBasicAuthCredentials string: 基本認証情報。ユーザー名とパスワードを “username:password” の形式で結合した文字列です。(オプション)。

Class ChatCompletion

public class ChatCompletion

継承

object ← ChatCompletion

継承されたメンバー

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

コンストラクタ

ChatCompletion()

public ChatCompletion()

プロパティ

Choices

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

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

プロパティの値

List<Choice>

Created

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

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

プロパティの値

long

Id

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

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

プロパティの値

string

Model

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

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

プロパティの値

string

Object

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

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

プロパティの値

string

SystemFingerprint

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

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

プロパティの値

string

Usage

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

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

プロパティの値

Usage

Class ChatGptConsts

public static class ChatGptConsts

継承

object ← ChatGptConsts

継承されたメンバー

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

フィールド

• ApiUrl

フィールドの値

string

ModelName

public static string ModelName

フィールドの値

string

SystemRole

public static string SystemRole

フィールドの値

string

SystemRoleDescription

public static string SystemRoleDescription

フィールドの値

string

UserRole

public static string UserRole

フィールドの値

string

Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← ChatGptRequestOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクター

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

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

public ChatGptRequestOptions(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; }

プロパティ値

string

ApiUrl

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

public string ApiUrl { get; set; }

プロパティ値

string

CancellationToken

キャンセルトークン。

public CancellationToken CancellationToken { get; set; }

プロパティ値

CancellationToken

MaxTokens

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

public int? MaxTokens { get; set; }

プロパティ値

int?

Messages

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

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

プロパティ値

List<Message>

Remarks

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

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

Model

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

public string Model { get; set; }

プロパティ値

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

プロパティ値

int

Query

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

public string Query { get; set; }

プロパティ値

string

Temperature

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

public double Temperature { get; set; }

プロパティ値

double

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

継承

object ←
PluginBaseOptions ←
CompressOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクター

CompressOptions()

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

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← DecryptionOptions

実装

• IPluginOptions

継承メンバー

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

コンストラクター

DecryptionOptions(string)

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

public DecryptionOptions(string ownerPassword)

パラメーター

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

プロパティ

OwnerPassword

オーナーパスワード。

public string OwnerPassword { get; set; }

プロパティ値

string

Class DecryptOptions

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← DecryptOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

DecryptOptions(string)

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

public DecryptOptions(string ownerPassword)

Parameters

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

Properties

OwnerPassword

所有者パスワード。

public string OwnerPassword { get; set; }

Property Value

string

Class DirectoryData

public sealed class DirectoryData : IData

継承

object ← DirectoryData

実装

• IData

継承されたメンバー

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

コンストラクター

DirectoryData(string)

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

public DirectoryData(string path)

パラメーター

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

プロパティ

DataType

データ ソースの種類。

public DataType DataType { get; }

プロパティの値

DataType

Path

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

public string Path { get; }

プロパティの値

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

継承

object ← DirectoryDataSource

実装

• IDataSource

継承メンバー

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

コンストラクター

DirectoryDataSource(string)

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

public DirectoryDataSource(string path)

パラメーター

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

プロパティ

DataType

データソースの種類。

public DataType DataType { get; }

プロパティ値

DataType

Path

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

public string Path { get; }

プロパティ値

string

Class DocConverter

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

継承

object ← DocConverter

継承されたメンバー

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

メソッド

Process(PdfToDocOptions)

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

public static ResultContainer Process(PdfToDocOptions options)

パラメーター

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

戻り値

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

例外

ArgumentException

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

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← EncryptionOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

EncryptionOptions(string, string)

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

public EncryptionOptions(string ownerPassword, string userPassword)

Parameters

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

Properties

OwnerPassword

所有者のパスワード。

public string OwnerPassword { get; set; }

Property Value

string

UserPassword

ユーザーのパスワード。

public string UserPassword { get; set; }

Property Value

string

Class EncryptOptions

public class EncryptOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← EncryptOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクター

EncryptOptions(string, string)

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

public EncryptOptions(string ownerPassword, string userPassword)

パラメーター

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

プロパティ

OwnerPassword

所有者パスワード。

public string OwnerPassword { get; set; }

プロパティ値

string

UserPassword

ユーザーパスワード。

public string UserPassword { get; set; }

プロパティ値

string

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

ExtractFormDataToDsvOptions(char, bool)

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

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

Parameters

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

Properties

AddFieldName

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

public bool AddFieldName { get; set; }

Property Value

bool

Delimiter

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

public char Delimiter { get; set; }

Property Value

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← ExtractImagesOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクター

ExtractImagesOptions()

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

public ExtractImagesOptions()

Class ExtractPropertiesOptions

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

継承

object ← OptionsWithInput ← ExtractPropertiesOptions

実装

• IHaveInput

継承されたメンバー

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

コンストラクター

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

指定されたデータで Documentize.ExtractPropertiesOptions オブジェクトを新しく初期化します。

public ExtractPropertiesOptions(IData data)

パラメーター

• data IData: 入力データ。

ExtractPropertiesOptions(string)

指定されたファイルで Documentize.ExtractPropertiesOptions オブジェクトを新しく初期化します。

public ExtractPropertiesOptions(string file)

パラメーター

• file string: 入力ファイルパス。

ExtractPropertiesOptions(Stream)

指定されたストリームで Documentize.ExtractPropertiesOptions オブジェクトを新しく初期化します。

public ExtractPropertiesOptions(Stream stream)

パラメーター

• stream Stream: 入力ストリーム。

プロパティ

Input

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

public override IData Input { get; set; }

プロパティの値

IData

Class ExtractTextOptions

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

継承

object ← OptionsWithInput ← ExtractTextOptions

実装

• IHaveInput

継承メンバー

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

コンストラクタ

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

プロパティ値

IData

Class FileData

public sealed class FileData : IData

継承

object ← FileData

実装

• IData

継承されたメンバー

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

コンストラクター

FileData(string)

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

public FileData(string path)

パラメーター

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

プロパティ

DataType

データ ソースのタイプ。

public DataType DataType { get; }

プロパティの値

DataType

Path

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

public string Path { get; }

プロパティの値

string

Class FileDataSource

public sealed class FileDataSource : IDataSource

継承

object ← FileDataSource

実装

• IDataSource

継承メンバー

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

コンストラクタ

FileDataSource(string)

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

public FileDataSource(string path)

パラメータ

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

プロパティ

DataType

データソースの種類。

public DataType DataType { get; }

プロパティの値

DataType

Path

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

public string Path { get; }

プロパティの値

string

Class FileResult

public sealed class FileResult : IOperationResult

継承

object ← FileResult

実装

• IOperationResult

継承メンバー

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

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティ値

object

IsFile

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

public bool IsFile { get; }

プロパティ値

bool

IsStream

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

public bool IsStream { get; }

プロパティ値

bool

IsString

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

public bool IsString { get; }

プロパティ値

bool

メソッド

ToFile()

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

public string ToFile()

戻り値

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

ToStream()

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

public Stream ToStream()

戻り値

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

Class FlattenFieldsOptions

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← FlattenFieldsOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクター

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

プロパティ

SkipFields

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

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

プロパティの値

List<string>

Class FormExporter

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

継承

object ← FormExporter

継承されたメンバー

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

メソッド

Process(ExtractFormDataToDsvOptions)

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

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

パラメータ

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

戻り値

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

例外

ArgumentException

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

Class FormExportToDsvOptions

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← FormExportToDsvOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクタ

FormExportToDsvOptions(char, bool)

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

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

パラメーター

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

プロパティ

AddFieldName

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

public bool AddFieldName { get; set; }

プロパティの値

bool

Delimeter

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

public char Delimeter { get; set; }

プロパティの値

char

Class FormFlattener

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

Inheritance

object ← FormFlattener

Inherited Members

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

メソッド

GetFieldNames(string)

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

public static List<string> GetFieldNames(string path)

Parameters

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

Returns

List<string>

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

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

public static List<string> GetFieldNames(Stream stream)

Parameters

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

Returns

List<string>

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

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

public static ResultContainer Process(FlattenFieldsOptions options)

Parameters

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

Returns

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

Exceptions

ArgumentException

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

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← FormFlattenerOptions

実装

• IPluginOptions

継承メンバー

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

コンストラクター

FormFlattenerOptions()

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

public FormFlattenerOptions()

プロパティ

SkipFields

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

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

プロパティの値

List<string>

Class GetFieldNamesOptions

public class GetFieldNamesOptions

継承

object ← GetFieldNamesOptions

継承されたメンバー

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

コンストラクター

GetFieldNamesOptions(string)

ファイルへの入力パスを使用したオプションのコンストラクターです。

public GetFieldNamesOptions(string path)

パラメーター

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

GetFieldNamesOptions(Stream)

ストリームを使用したオプションのコンストラクターです。

public GetFieldNamesOptions(Stream stream)

パラメーター

• stream Stream: 入力ストリーム。

Class HtmlConverter

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

継承

object ← HtmlConverter

継承メンバー

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

メソッド

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

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

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← HtmlToPdfOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

HtmlToPdfOptions()

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

public HtmlToPdfOptions()

Properties

BasePath

HTML ファイルのベース パス/URL を指定します。

public string BasePath { get; set; }

Property Value

string

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

Property Value

bool

PageInfo

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

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Class ImageExtractor

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

継承

object ← ImageExtractor

継承されたメンバー

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

メソッド

Process(ExtractImagesOptions)

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

public static ResultContainer Process(ExtractImagesOptions options)

パラメーター

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

戻り値

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

例外

ArgumentException

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

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← ImageExtractorOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクター

ImageExtractorOptions()

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

public ImageExtractorOptions()

Class Info

public static class Info

継承

object ← Info

継承されたメンバー

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

フィールド

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

フィールドの値

string

製品

製品名。

public const string Product = "Documentize"

フィールドの値

string

Class JpegConverter

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

継承

object ← JpegConverter

継承メンバー

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

メソッド

Process(PdfToJpegOptions)

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

public static ResultContainer Process(PdfToJpegOptions options)

パラメーター

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

返り値

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

例外

ArgumentException

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

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← MergeOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

MergeOptions()

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

public MergeOptions()

Class Merger

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

継承

object ← Merger

継承されたメンバー

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

メソッド

Process(MergeOptions)

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

public static ResultContainer Process(MergeOptions options)

パラメーター

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

返り値

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

例外

ArgumentException

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

Class ObjectResult

public sealed class ObjectResult : IOperationResult

継承

object ← ObjectResult

実装

• IOperationResult

継承メンバー

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

プロパティ

Data

生データを取得します。

public object Data { get; }

プロパティの値

object

IsFile

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

public bool IsFile { get; }

プロパティの値

bool

IsObject

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

public bool IsObject { get; }

プロパティの値

bool

IsStream

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

public bool IsStream { get; }

プロパティの値

bool

IsString

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

public bool IsString { get; }

プロパティの値

bool

Text

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

public string Text { get; }

プロパティの値

string

メソッド

ToFile()

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

public string ToFile()

戻り値

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

ToStream()

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

public Stream ToStream()

戻り値

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

ToString()

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

public override string ToString()

戻り値

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

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

OptimizeOptions()

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

• 最初のページをできるだけ速く開くこと。
• 次のページや、次のページへのリンクをできるだけ速く表示すること。
• ページのデータが遅いチャネルで順次配信される際に、到着したデータを段階的に表示し、最も有用なデータを先に表示すること。
• ページ全体が受信・表示される前でも、リンクをたどるなどのユーザー操作を実行できるようにすること。

public OptimizeOptions()

Class Optimizer

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

継承

object ← Optimizer

継承メンバー

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

メソッド

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 : 操作の結果を含むオブジェクト。

Class OptionsWithInput

public abstract class OptionsWithInput : IHaveInput

継承

object ←
OptionsWithInput

派生

• ExtractPropertiesOptions,
• ExtractTextOptions

実装

• IHaveInput

継承されたメンバー

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

フィールド

• input

フィールド値

IData

プロパティ

Input

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

public virtual IData Input { get; set; }

プロパティ値

IData

Class PageInfo

public class PageInfo : PageSize

継承

object ← PageSize ← PageInfo

継承されたメンバー

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

コンストラクター

PageInfo()

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

public PageInfo()

PageInfo(double, double)

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

public PageInfo(double width, double height)

パラメーター

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

プロパティ

MarginBottom

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

public double MarginBottom { get; set; }

プロパティ値

double

MarginLeft

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

public double MarginLeft { get; set; }

プロパティ値

double

MarginRight

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

public double MarginRight { get; set; }

プロパティ値

double

MarginTop

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

public double MarginTop { get; set; }

プロパティ値

double

Class PageSize

public class PageSize

継承

object ← PageSize

派生

• PageInfo

継承されたメンバー

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

コンストラクター

PageSize()

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

public PageSize()

PageSize(double, double)

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

public PageSize(double width, double height)

パラメーター

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

プロパティ

A0

A0 サイズ (1189x840 mm)。

public static PageSize A0 { get; }

プロパティ値

PageSize

A1

A1 サイズ (840x594 mm)。

public static PageSize A1 { get; }

プロパティ値

PageSize

A2

A2 サイズ (594x420 mm)。

public static PageSize A2 { get; }

プロパティ値

PageSize

A3

A3 サイズ (420x297 mm)。

public static PageSize A3 { get; }

プロパティ値

PageSize

A4

A4 サイズ (297x210 mm)。

public static PageSize A4 { get; }

プロパティ値

PageSize

A5

A5 サイズ (210x148 mm)。

public static PageSize A5 { get; }

プロパティ値

PageSize

A6

A6 サイズ (148x105 mm)。

public static PageSize A6 { get; }

プロパティ値

PageSize

B5

B5 サイズ (250x176 mm)。

public static PageSize B5 { get; }

プロパティ値

PageSize

Height

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

public double Height { get; set; }

プロパティ値

double

IsLandscape

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

public bool IsLandscape { get; }

プロパティ値

bool

P11x17

11x17 インチ形式。

public static PageSize P11x17 { get; }

プロパティ値

PageSize

PageLedger

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

public static PageSize PageLedger { get; }

プロパティ値

PageSize

PageLegal

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

public static PageSize PageLegal { get; }

プロパティ値

PageSize

PageLetter

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

public static PageSize PageLetter { get; }

プロパティ値

PageSize

Width

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

public double Width { get; set; }

プロパティ値

double

Class PdfAConverter

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

継承

object ← PdfAConverter

継承メンバー

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

メソッド

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

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

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfAConvertOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

PdfAConvertOptions()

public PdfAConvertOptions()

Properties

Outputs

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

public List<idatasource> Outputs { get; }

Property Value

List<IDataSource>

Methods

AddOutput(IDataSource)

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

public void AddOutput(IDataSource dataSource)

Parameters

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

Class PdfAOptionsBase

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

public abstract class PdfAOptionsBase : IPluginOptions

Inheritance

object ← PdfAOptionsBase

Derived

• PdfAValidateOptions,
• PdfToPdfAOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

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

public bool AlignText { get; set; }

Property Value

bool

Remarks

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

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }

Property Value

string

Inputs

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

public List<idata> Inputs { get; }

Property Value

List<IData>

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Property Value

bool

LogOutputSource

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

public IData LogOutputSource { get; set; }

Property Value

IData

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Property Value

bool

Remarks

true に設定すると、変換プロセスは生成されるファイルサイズの最小化を試みます。
これにより変換処理のパフォーマンスに影響を与える可能性があります。

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

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

SoftMaskAction

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

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IData)

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

public void AddInput(IData data)

Parameters

• data IData: Input data. :

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

継承

object ← PdfAOptionsBase ← PdfAValidateOptions

実装

• IPluginOptions

継承メンバー

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

コンストラクター

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Inheritance

object ← PdfAValidationResult

Inherited Members

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

Fields

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

Field Value

IData

IsValid

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

public readonly bool IsValid

Field Value

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Field Value

PdfAStandardVersion

Class PdfChatGpt

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

継承

object ← PdfChatGpt

継承されたメンバー

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

備考

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

メソッド

Process(IPluginOptions)

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

public static ResultContainer Process(IPluginOptions options)

パラメーター

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

戻り値

ResultContainer : #### 例外

NotImplementedException

ProcessAsync(IPluginOptions)

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

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

パラメーター

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

戻り値

Task<ResultContainer>

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

例外

ArgumentException : InvalidOperationException

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

継承

object ← PdfChatGptOptions

派生

• PdfChatGptRequestOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクター

PdfChatGptOptions()

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

public PdfChatGptOptions()

プロパティ

Inputs

public List<idatasource> Inputs { get; }

プロパティの値

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

プロパティの値

List<IDataSource>

メソッド

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

パラメーター

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

AddOutput(IDataSource)

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

public void AddOutput(IDataSource saveDataSource)

パラメーター

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

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

継承

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

実装

• IPluginOptions

継承されたメンバー

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

コンストラクタ

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

プロパティ値

string

ApiUrl

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

public string ApiUrl { get; set; }

プロパティ値

string

CancellationToken

キャンセルトークン。

public CancellationToken CancellationToken { get; set; }

プロパティ値

CancellationToken

MaxTokens

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

public int? MaxTokens { get; set; }

プロパティ値

int?

Messages

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

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

プロパティ値

List<Message>

備考

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

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

Model

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

public string Model { get; set; }

プロパティ値

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

プロパティ値

int

Query

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

public string Query { get; set; }

プロパティ値

string

Temperature

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

public double Temperature { get; set; }

プロパティ値

double

Class PdfConverter

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

public static class PdfConverter

Inheritance

object ← PdfConverter

Inherited Members

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

Methods

Convert(PdfToDocOptions)

Converts PDF document into DOC/DOCX formats.

public static ResultContainer Convert(PdfToDocOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Examples

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

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new 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);

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

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new 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);

Exceptions

ArgumentException

If options not set.

Convert(PdfToXlsOptions)

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

public static ResultContainer Convert(PdfToXlsOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to convert PDF to XLSX document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new 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);

The example demonstrates how to convert PDF to XLS document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new 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);

Exceptions

ArgumentException

If options not set.

Convert(PdfToHtmlOptions)

Converts PDF document into HTML format.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to convert PDF to HTML document.

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

Exceptions

ArgumentException

If options not set.

Convert(HtmlToPdfOptions)

Converts HTML document into PDF format.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to convert HTML to PDF document.

// 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);

Exceptions

ArgumentException

If options not set.

Convert(PdfToJpegOptions)

Converts PDF document into JPEG format.

public static ResultContainer Convert(PdfToJpegOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Examples

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

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

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

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

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

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

Exceptions

ArgumentException

If options not set.

Convert(PdfToPngOptions)

Converts PDF document into PNG format.

public static ResultContainer Convert(PdfToPngOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Examples

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

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

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

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

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

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

Exceptions

ArgumentException

If options not set.

Convert(PdfToTiffOptions)

Converts PDF document into TIFF format.

public static ResultContainer Convert(PdfToTiffOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Examples

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

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

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

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

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

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

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

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

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

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