Documentize 名前空間のサブセクション
Class AddTimestampOptions
情報
ドキュメント化のタイムスタンププラグインのためのタイムスタンプオプションを表現します。
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
AddTimestampOptions
実装
継承メンバー
- 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()
コンストラクター
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 CompressOptions
情報
Documentize.Optimizerプラグインの圧縮オプションを表します。
public sealed class CompressOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
CompressOptions
実装
継承されたメンバー
- 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()
コンストラクター
CompressOptions()
デフォルトオプションでDocumentize.CompressOptionsオブジェクトの新しいインスタンスを初期化します。
Class DecryptionOptions
情報
Documentize.Securityプラグインの復号化オプションを表します。
public class DecryptionOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
DecryptionOptions
実装
継承メンバー
- 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 DirectoryDataSource
情報
プラグインのロードおよび保存操作のためのディレクトリデータを表します。
public sealed class DirectoryDataSource : IDataSource
継承
object ←
DirectoryDataSource
実装
継承メンバー
コンストラクター
DirectoryDataSource(string)
指定されたパスで新しいディレクトリデータを初期化します。
public DirectoryDataSource(string path)
パラメーター
path
string: ディレクトリへのパスを表す文字列。
プロパティ
DataType
データソースの種類。
public DataType DataType { get; }
プロパティ値
DataType
Path
現在のデータのディレクトリへのパスを取得します。
public string Path { get; }
プロパティ値
string
Class DocConverter
情報
Documentize.DocConverterプラグインを表します。PDFドキュメントをDOC/DOCX形式に変換するために使用されます。
public sealed class DocConverter
継承
object ←
DocConverter
継承メンバー
例
この例は、PDFドキュメントをDoc形式に変換する方法を示しています。
// DocConverterを初期化する
var plugin = new DocConverter();
// 指示を設定するためにPdfToDocOptionsオブジェクトを作成する
var options = new PdfToDocOptions();
// 入力ファイルパスを追加する
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ファイルパスを設定する
options.AddOutput(new FileDataSource("path_to_input.doc"));
// プロセスを実行する
plugin.Process(options);
コンストラクター
DocConverter()
メソッド
Dispose()
IDisposableの実装。
Process(PdfToDocOptions)
PDFドキュメントをDOC/DOCX形式に変換します。
public ResultContainer Process(PdfToDocOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
例外
ArgumentException
オプションが設定されていない場合。
Class EncryptionOptions
情報
Documentize.Securityプラグインの暗号化オプションを表します。
public class EncryptionOptions : PluginBaseOptions, IPluginOptions
Inheritance
object ←
PluginBaseOptions ←
EncryptionOptions
Implements
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 FileDataSource
情報
プラグインのロードおよび保存操作に対するファイルデータを表します。
public sealed class FileDataSource : IDataSource
継承
object ←
FileDataSource
実装
継承メンバー
コンストラクタ
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
実装
継承メンバー
プロパティ
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()
結果をファイルに変換しようとします。
戻り値
string : 結果がファイルである場合、出力ファイルへのパスを表す文字列。それ以外の場合は null
。
ToStream()
結果をストリームオブジェクトに変換しようとします。
戻り値
Stream : 結果がストリームである場合、出力データを表すストリームオブジェクト。それ以外の場合は null
。
情報
Documentize.FormExporterプラグインを表します。PDFドキュメントのフォーム値をDSVまたはCSVファイルにエクスポートするために使用されます。
public static class FormExporter
継承
object ←
FormExporter
引き継がれたメンバー
例
この例は、フォーム値をCSVファイルにエクスポートする方法を示しています。
// FormExportToDsvOptionsオブジェクトを作成して指示を設定
var options = new FormExportToDsvOptions(',', true);
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// プロセスを実行
FormExporter.Process(options);
メソッド
指定されたパラメータでDocumentize.FormExporterの処理を開始します。
public static ResultContainer Process(FormExportToDsvOptions options)
パラメータ
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
情報
Documentize.FormExporterプラグインのフィールドの値をエクスポートするためのオプションを表します。
public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
FormExportToDsvOptions
実装
継承されたメンバー
- 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()
コンストラクタ
Documentize.FormExportToDsvOptionsオブジェクトの新しいインスタンスを初期化します。
public FormExportToDsvOptions(char delimeter = ',', bool addFieldNames = false)
パラメーター
delimeter
char: エクスポートされたデータの値の間で使用されるデリミターを指定します。デフォルト値は’,‘です。addFieldNames
bool: 値の前にフィールド名を追加します。形式: 名前 + デリミター + 値 + デリミター。
プロパティ
値の前にフィールド名を追加します。
形式: 名前 + デリミター + 値 + デリミター。
public bool AddFieldName { get; set; }
プロパティの値
bool
エクスポートされた値に使用されるデリミター。
public char Delimeter { get; set; }
プロパティの値
char
情報
Documentize.FormFlattener プラグインを表します。PDF ドキュメント内のフィールドをフラット化するために使用されます。
public static class FormFlattener
継承
object ←
FormFlattener
継承メンバー
例
この例は、PDF ファイル内のフィールドをフラット化する方法を示しています。
// 手順を設定するために FormFlattenerOptions オブジェクトを作成
var options = new FormFlattenerOptions();
// 入力ファイルのパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルのパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
FormFlattener.Process(options);
この例は、PDF ファイル内のフィールドをフラット化し、最初のフィールドをスキップする方法を示しています。
// フィールド名を取得
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// 手順を設定するために FormFlattenerOptions オブジェクトを作成
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 1 つのフィールドをスキップ
options.SkipFields.Add(fieldNames[0]);
// 処理を実行
FormFlattener.Process(options);
この例は、PDF ファイルからフィールド名を取得する方法を示しています。
// フィールド名を取得
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
メソッド
PDF ドキュメント内のフィールド名を取得します。
public static List<string> GetFieldNames(string path)
パラメーター
戻り値
List<string>
PDF ドキュメント内の名前のリスト。
public static List<string> GetFieldNames(Stream stream)
パラメーター
stream
Stream: PDF ドキュメントを含むストリーム。
戻り値
List<string>
PDF ドキュメント内の名前のリスト。
public static ResultContainer Process(FormFlattenerOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
例外
ArgumentException
オプションが設定されていない場合。
情報
Documentize.FormFlattener プラグインによるドキュメント内のフィールドをフラット化するためのオプションを表します。
public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
FormFlattenerOptions
実装
継承メンバー
- 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()
コンストラクター
デフォルトのオプションで Documentize.FormFlattenerOptions オブジェクトの新しいインスタンスを初期化します。
public FormFlattenerOptions()
プロパティ
フラット化しないフィールドのリストです。
public List<string> SkipFields { get; set; }
プロパティの値
List<string>
Class HtmlConverter
情報
Documentize.HtmlConverter プラグインを表します。PDF ドキュメントを HTML 形式に、HTML ドキュメントを PDF 形式に変換するために使用されます。
public static class HtmlConverter
継承
object ←
HtmlConverter
継承されたメンバー
例
この例は、PDF を HTML ドキュメントに変換する方法を示しています。
// ファイルを埋め込まれたリソースとして出力データ型を設定するために PdfToHtmlOptions オブジェクトを作成します
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// 入力ファイルパスを追加します
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ファイルパスを設定します
options.AddOutput(new FileDataSource("path_to_output.html"));
// 処理を実行します
HtmlConverter.Process(options);
この例は、HTML を PDF ドキュメントに変換する方法を示しています。
// HtmlToPdfOptions を作成します
var options = new HtmlToPdfOptions();
// 入力ファイルパスを追加します
options.AddInput(new FileDataSource("path_to_input.html"));
// 出力ファイルパスを設定します
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// 処理を実行します
HtmlConverter.Process(options);
メソッド
Process(PdfToHtmlOptions)
PDF ドキュメントを HTML 形式に変換します。
public static ResultContainer Process(PdfToHtmlOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
Process(HtmlToPdfOptions)
HTML ドキュメントを PDF 形式に変換します。
public static ResultContainer Process(HtmlToPdfOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
Class HtmlToPdfOptions
情報
Documentize.HtmlConverterプラグイン用のHTMLからPDFへの変換オプションを表します。
public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
HtmlToPdfOptions
実装
継承されたメンバー
- 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()
コンストラクター
HtmlToPdfOptions()
Documentize.HtmlToPdfOptionsオブジェクトの新しいインスタンスを初期化します。
public HtmlToPdfOptions()
プロパティ
BasePath
HTMLファイルのベースパス/URL。
public string BasePath { get; set; }
プロパティ値
string
レンダリング中に使用される可能性のあるメディアタイプを取得または設定します。
public HtmlMediaType HtmlMediaType { get; set; }
プロパティ値
HtmlMediaType
IsRenderToSinglePage
すべてのドキュメントを単一ページにレンダリングするかどうかを取得または設定します。
public bool IsRenderToSinglePage { get; set; }
プロパティ値
bool
PageInfo
ドキュメントのページ情報を取得または設定します。
public PageInfo PageInfo { get; set; }
プロパティ値
PageInfo
PageLayoutOption
レイアウトオプションを取得または設定します。
public HtmlPageLayoutOption PageLayoutOption { get; set; }
プロパティ値
HtmlPageLayoutOption
情報
Documentize.ImageExtractorプラグインを表します。PDFドキュメントから画像を抽出するために使用されます。
public static class ImageExtractor
Inheritance
object ←
ImageExtractor
Inherited Members
Examples
この例はPDFドキュメントから画像を抽出する方法を示しています。
// 指示を設定するためのImageExtractorOptionsを作成
var options = new ImageExtractorOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// プロセスを実行
var results = ImageExtractor.Process(options);
// 画像結果へのパスを取得
var imageExtracted = results.ResultCollection[0].ToFile();
Methods
PDFドキュメントから画像を抽出します。
public static ResultContainer Process(ImageExtractorOptions options)
Parameters
Returns
ResultContainer : 操作の結果を含むオブジェクトです。
Exceptions
ArgumentException
オプションが設定されていない場合。
情報
Documentize.ImageExtractorプラグイン用の画像抽出オプションを表します。
public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
ImageExtractorOptions
実装
継承されたメンバー
- 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()
コンストラクター
デフォルトオプションでDocumentize.ImageExtractorOptionsオブジェクトの新しいインスタンスを初期化します。
public ImageExtractorOptions()
Class JpegConverter
情報
Documentize.JpegConverterプラグインを表します。PDFドキュメントをJPEG形式に変換するために使用されます。
public static class JpegConverter
継承
object ←
JpegConverter
継承されたメンバー
例
この例は、PDFドキュメントをJPEG形式に変換する方法を示します。
// インストラクションを設定するために PdfToJpegOptions オブジェクトを作成
var options = new PdfToJpegOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
JpegConverter.Process(options);
この例は、ページ、解像度、品質の設定でPDFドキュメントをJPEG形式に変換する方法を示します。
// インストラクションを設定するために PdfToJpegOptions オブジェクトを作成
var options = new PdfToJpegOptions();
// 最初のページのみ処理
options.PageList = [1];
// 出力解像度を200 DPIに設定
options.OutputResolution = 200;
// 出力品質を50に設定
options.Quality = 50;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
JpegConverter.Process(options);
この例は、ストリームにPDFドキュメントをJPEG形式に変換する方法を示します。
// インストラクションを設定するために PdfToJpegOptions オブジェクトを作成
var options = new PdfToJpegOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 処理を実行
var results = JpegConverter.Process(options);
// ストリーム結果を取得
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
メソッド
Process(PdfToJpegOptions)
PDFドキュメントをJPEG形式に変換します。
public static ResultContainer Process(PdfToJpegOptions options)
パラメータ
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
Class MergeOptions
情報
Documentize.Mergerプラグインのマージオプションを表します。
public sealed class MergeOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
MergeOptions
実装
継承メンバー
- 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()
コンストラクタ
MergeOptions()
デフォルトオプションでDocumentize.MergeOptionsオブジェクトの新しいインスタンスを初期化します。
Class Merger
情報
Documentize.Mergerプラグインを表します。複数のPDFドキュメントを1つのPDFにマージするために使用されます。
public static class Merger
継承
object ←
Merger
継承されたメンバー
例
この例は、2つのPDFドキュメントをマージする方法を示しています。
// MergeOptionsオブジェクトを作成して指示を設定
var options = new MergeOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
Merger.Process(options);
メソッド
Process(MergeOptions)
PDFドキュメントをマージします。
public static ResultContainer Process(MergeOptions options)
パラメータ
返り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
Class ObjectResult
public sealed class ObjectResult : IOperationResult
継承
object ←
ObjectResult
実装
継承メンバー
プロパティ
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()
結果をファイルに変換しようとします。
戻り値
string : 結果がファイルの場合、出力ファイルへのパスを表す文字列;そうでない場合は null
。
ToStream()
結果をストリームオブジェクトに変換しようとします。
戻り値
Stream : 結果がストリームの場合、出力データを表すストリームオブジェクト;そうでない場合は null
。
ToString()
結果を文字列に変換しようとします。
public override string ToString()
戻り値
string : 結果が文字列の場合、テキストコンテンツを表す文字列;そうでない場合は base.ToString() を返します。
Class OptimizeOptions
情報
Documentize.Optimizerプラグインの最適化オプションを表します。
public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
OptimizeOptions
実装
継承メンバー
- 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()
コンストラクター
OptimizeOptions()
デフォルトのオプションでDocumentize.OptimizeOptionsオブジェクトの新しいインスタンスを初期化します。
ドキュメントを線形化して
- 最初のページをできるだけ早く開くことができるようにします;
- 次のページをできるだけ早く表示またはリンクをたどることができるようにします;
- ページのデータが遅いチャネルで配信される際、到着するごとにページを段階的に表示します(最も役立つデータを最初に表示);
- ユーザーがリンクをたどるなどの対話を、ページ全体が受信および表示される前に実行できるようにします。
Class Optimizer
情報
Documentize.Optimizerプラグインを表します。PDFドキュメントの最適化、回転、リサイズ、圧縮に使用されます。
public static class Optimizer
継承
object ←
Optimizer
継承されたメンバー
例
この例は、PDFドキュメントを最適化する方法を示しています。
// 指示を設定するためのOptimizeOptionsオブジェクトを作成
var options = new OptimizeOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
Optimizer.Process(options);
この例は、PDFドキュメントを回転させる方法を示しています。
// 指示を設定するためのRotateOptionsオブジェクトを作成
var options = new RotateOptions();
// 新しい回転を設定
options.Rotation = Rotation.On90;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
Optimizer.Process(options);
この例は、PDFドキュメントのサイズを変更する方法を示しています。
// 指示を設定するためのResizeOptionsオブジェクトを作成
var options = new ResizeOptions();
// 新しいページサイズを設定
options.PageSize = PageSize.A3;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
Optimizer.Process(options);
この例は、PDFドキュメントを圧縮する方法を示しています。
// 指示を設定するためのCompressOptionsオブジェクトを作成
var options = new CompressOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
Optimizer.Process(options);
メソッド
Process(OptimizeOptions)
指定されたパラメーターでDocumentize.Optimizer処理を開始します。
public static ResultContainer Process(OptimizeOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
Process(RotateOptions)
指定されたパラメーターでDocumentize.Optimizer処理を開始します。
public static ResultContainer Process(RotateOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
Process(ResizeOptions)
指定されたパラメーターでDocumentize.Optimizer処理を開始します。
public static ResultContainer Process(ResizeOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
Process(CompressOptions)
指定されたパラメーターでDocumentize.Optimizer処理を開始します。
public static ResultContainer Process(CompressOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
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のコンストラクター。
PageInfo(double, double)
Documentize.PageInfoのコンストラクター。
public PageInfo(double width, double height)
パラメーター
プロパティ
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
情報
PDF ドキュメントにおけるページのサイズを表すクラス。
継承
object ←
PageSize
派生
継承されたメンバー
コンストラクター
PageSize()
Documentize.PageSize のコンストラクター。デフォルトでは A4 サイズ。
PageSize(double, double)
Documentize.PageSize のコンストラクター。
public PageSize(double width, double height)
パラメーター
プロパティ
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
情報
PDF/AフォーマットのPDFドキュメントの変換とPDF/A準拠の検証を処理するプラグインを表します。
public sealed class PdfAConverter
継承
object ←
PdfAConverter
継承されたメンバー
例
この例は、PDFドキュメントがPDF/Aフォーマット(この場合はPDF/A-1a)に準拠しているかを検証する方法を示しています。
// 検証プロセスを設定するためのオプションクラスを作成
var options = new PdfAValidateOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_1A
};
// 検証するファイルを1つ以上追加
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // 実際のファイルパスに置き換えてください
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// 必要に応じてさらにファイルを追加
// プラグインインスタンスを作成
var plugin = new PdfAConverter();
// 検証を実行し、結果を取得
var resultContainer = plugin.Process(options);
// resultContainer.ResultCollectionプロパティで各ファイルの検証結果を確認します:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
var result = resultContainer.ResultCollection[i];
var validationResult = (PdfAValidationResult) result.Data;
var isValid = validationResult.IsValid; // i-番目のドキュメントの検証結果
}
この例は、PDFドキュメントをPDF/Aフォーマット(この場合はPDF/A-3b)に変換する方法を示しています。
// 変換プロセスを設定するためのオプションクラスを作成
var options = new PdfAConvertOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_3B
};
// ソースファイルを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // 実際のファイルパスに置き換えてください
// 変換したファイルを保存するパスを追加
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));
// プラグインインスタンスを作成
var plugin = new PdfAConverter();
// 変換を実行
plugin.Process(options);
コンストラクタ
PdfAConverter()
メソッド
Process(IPluginOptions)
指定されたオプションでPDF/A変換または検証プロセスを開始します。
public ResultContainer Process(IPluginOptions options)
パラメータ
options
IPluginOptions: プラグインの指示を含むオプションオブジェクト。Documentize.PdfAConvertOptionsまたはDocumentize.PdfAValidateOptionsクラスのインスタンスでなければなりません。
戻り値
ResultContainer : 処理の結果を含むDocumentize.ResultContainerオブジェクトです。
Class PdfAConvertOptions
情報
PDFドキュメントをDocumentize.PdfAConverterプラグインを使用してPDF/A形式に変換するためのオプションを表します。
public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions
Inheritance
object ←
PdfAOptionsBase ←
PdfAConvertOptions
Implements
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変換と検証プロセスを構成するためのプロパティとメソッドを提供します。
Documentize.PdfAConverterプラグインオプションのベースクラスを表します。
このクラスは、PDF/A変換と検証プロセスを構成するためのプロパティとメソッドを提供します。
public abstract class PdfAOptionsBase : IPluginOptions
継承
object ←
PdfAOptionsBase
派生
実装
継承メンバー
コンストラクタ
PdfAOptionsBase()
protected PdfAOptionsBase()
プロパティ
AlignText
PDF/A変換プロセス中にテキストの整列を維持するために追加の手段が必要かどうかを示す値を取得または設定します。
public bool AlignText { get; set; }
プロパティの値
bool
備考
trueに設定されると、変換プロセスは元のテキストセグメントの境界を復元しようとします。
ほとんどのドキュメントでは、このプロパティをデフォルトのfalseに変更する必要はありません。
デフォルトの変換プロセスではテキストの整列が変更されないからです。
CheckDifferentNamesInFontDictionaries
ソースPDFドキュメントがPDF仕様に対応していない場合のPDF/A変換を制御するフラグを取得します。
public bool CheckDifferentNamesInFontDictionaries { get; set; }
プロパティの値
bool
ErrorAction
変換できないオブジェクトに対して実行されるアクションを取得または設定します。
public ConvertErrorAction ErrorAction { get; set; }
プロパティの値
ConvertErrorAction
IccProfileFileName
デフォルトのICC(国際色彩コンソーシアム)プロファイルの代わりにPDF/A変換に使用するICCプロファイルのファイル名を取得または設定します。
public string IccProfileFileName { get; set; }
プロパティの値
string
データソースのコレクションを取得します。
public List<idatasource> Inputs { get; }
プロパティの値
List<IDataSource>
IsLowMemoryMode
PDF/A変換プロセス中に低メモリモードが有効かどうかを示す値を取得または設定します。
public bool IsLowMemoryMode { get; set; }
プロパティの値
bool
LogOutputSource
ログ出力のデータソースを取得または設定します。
public IDataSource LogOutputSource { get; set; }
プロパティの値
IDataSource
OptimizeFileSize
PDF/A変換プロセス中にファイルサイズを削減しようとするかどうかを示す値を取得または設定します。
public bool OptimizeFileSize { get; set; }
プロパティの値
bool
備考
trueに設定されると、変換プロセスは結果のファイルサイズを最小化しようとします。
これにより、変換プロセスのパフォーマンスに影響する可能性があります。
PdfAVersion
検証または変換に使用されるPDF/A標準のバージョンを取得または設定します。
public PdfAStandardVersion PdfAVersion { get; set; }
プロパティの値
PdfAStandardVersion
備考
PDF/A標準のバージョンは、PDF/Aの検証と変換の準拠レベルを決定するために使用されます。
バージョンがDocumentize.PdfAStandardVersion.Autoに設定されていると、システムはドキュメントメタデータに基づいて検証に適切なPDF/A標準バージョンを自動的に決定します。
PDF/A変換プロセスの場合、Documentize.PdfAStandardVersion.AutoはPDF/A-1b標準バージョンにデフォルトで設定されます。
SoftMaskAction
ソフトマスク付きの画像の変換中に実行されるアクションを取得または設定します。
public ConvertSoftMaskAction SoftMaskAction { get; set; }
プロパティの値
ConvertSoftMaskAction
メソッド
コレクションに新しいデータソースを追加します。
public void AddInput(IDataSource dataSource)
パラメータ
Class PdfAValidateOptions
情報
Documentize.PdfAConverterプラグインを使用してPDF文書のPDF/A準拠を検証するためのオプションを表します。
public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions
継承関係
object ←
PdfAOptionsBase ←
PdfAValidateOptions
実装
継承されたメンバー
- 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()
コンストラクタ
PdfAValidateOptions()
public PdfAValidateOptions()
Class PdfAValidationResult
public sealed class PdfAValidationResult
継承
object ←
PdfAValidationResult
継承されたメンバー
フィールド
DataSource 検証されたデータソースを取得します。
フィールド値
IDataSource
IsValid
検証が成功したかどうかを示す値を取得します。
public readonly bool IsValid
フィールド値
bool
StandardVersion
検証に使用されるPDF/A標準のバージョンを取得します。
public readonly PdfAStandardVersion StandardVersion
フィールド値
PdfAStandardVersion
Class PdfChatGpt
public sealed class PdfChatGpt : IDisposable
継承
object ←
PdfChatGpt
実装
継承されたメンバー
例
この例では、リクエストにメッセージを追加することでPdfChatGptプラグインを使用する方法を示します。
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 出力ファイルパスを追加します。
options.ApiKey = "Your API key."; // APIにアクセスするためのキーを提供する必要があります。
options.MaxTokens = 1000; // チャット完了で生成する最大トークン数です。
// リクエストメッセージを追加します。
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
});
// リクエストを処理します。
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIのチャット完了オブジェクトです。
}
この例では、リクエストに1つのメッセージを追加することでPdfChatGptプラグインを使用する方法を示します。
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 出力ファイルパスを追加します。
options.ApiKey = "Your API key."; // APIにアクセスするためのキーを提供する必要があります。
options.MaxTokens = 1000; // チャット完了で生成する最大トークン数です。
// リクエストメッセージを追加します。
// この場合、Content = "You are a helpful assistant."のシステムメッセージがデフォルトで追加されます。
// クエリメッセージの役割はデフォルトで「ユーザー」です。
options.Query = "What is the lowest temperature recorded on the Earth?";
// リクエストを処理します。
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIのチャット完了オブジェクトです。
}
この例では、メッセージソースとしてファイルを追加することでPdfChatGptプラグインを使用する方法を示します。
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 出力ファイルパスを追加します。
// PDFテキストソースを追加します。
// 複数のソースがある場合、各ドキュメントからのテキストがリクエストメッセージコレクションに別々のメッセージとして追加されます。
// このメッセージの役割は「ユーザー」です。
options.AddInput(new FileDataSource("TextSource.pdf"));
options.ApiKey = "Your API key."; // APIにアクセスするためのキーを提供する必要があります。
options.MaxTokens = 1000; // チャット完了で生成する最大トークン数です。
// リクエストメッセージを追加します。
// この場合、Content = "You are a helpful assistant."のシステムメッセージがデフォルトで追加されます。
// クエリメッセージの役割はデフォルトで「ユーザー」です。
options.Query = "How many letters in the provided text?";
// リクエストを処理します。
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIのチャット完了オブジェクトです。
}
注意事項
Documentize.PdfChatGptオブジェクトは、PDFファイルソースを追加してChatGPTに直接リクエストを送信し、返信を出力ソースに保存するために使用されます。
コンストラクタ
PdfChatGpt()
Documentize.PdfChatGptオブジェクトの新しいインスタンスを初期化します。
メソッド
Dispose()
IDisposableの実装。実際には、PdfChatGptには必要ありません。
Process(IPluginOptions)
このメソッドには同期バージョンはありません。代わりにProcessAsyncメソッドを使用してください。
public ResultContainer Process(IPluginOptions options)
パラメータ
戻り値
ResultContainer : #### 例外
NotImplementedException
ProcessAsync(IPluginOptions)
指定されたパラメータでPdfChatGpt処理を開始します。
public Task<resultcontainer> ProcessAsync(IPluginOptions options)
パラメータ
戻り値
Task<ResultContainer>
非同期操作を表すタスクオブジェクトです。
例外
ArgumentException : InvalidOperationException
SetCancellationToken(CancellationToken)
キャンセルトークンを設定します。
public void SetCancellationToken(CancellationToken cancellationToken)
パラメータ
Class PdfChatGptOptions
情報
Documentize.PdfChatGpt プラグインのオプションを表します。
public class PdfChatGptOptions : IPluginOptions
継承
object ←
PdfChatGptOptions
派生
実装
継承されたメンバー
コンストラクター
PdfChatGptOptions()
Documentize.PdfChatGptOptions オブジェクトの新しいインスタンスを初期化します。
public PdfChatGptOptions()
プロパティ
public List<idatasource> Inputs { get; }
プロパティの値
List<IDataSource>
Outputs
public List<idatasource> Outputs { get; }
プロパティの値
List<IDataSource>
メソッド
PdfChatGpt プラグインのデータコレクションに新しいデータソースを追加します。
public void AddInput(IDataSource dataSource)
パラメーター
AddOutput(IDataSource)
PdfChatGpt プラグインのデータコレクションに新しい保存データソースを追加します。
public void AddOutput(IDataSource saveDataSource)
パラメーター
saveDataSource
IDataSource: 結果を保存するためのデータソース(ファイルまたはストリーム)。 :
Class PdfChatGptRequestOptions
情報
Documentize.PdfChatGptプラグインのオプションを表します。
public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions
継承
object ←
PdfChatGptOptions ←
PdfChatGptRequestOptions
実装
継承されたメンバー
- 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
ChatGPT APIにアクセスするためのキーを取得または設定します。
public string ApiKey { get; set; }
プロパティの値
string
ApiUrl
ChatGPT APIのURLを取得または設定します。
public string ApiUrl { get; set; }
プロパティの値
string
MaxTokens
レスポンス内のトークンの最大数。
デフォルト値はnullで、無限を意味します。
public int? MaxTokens { get; set; }
プロパティの値
int?
Messages
Documentize.Messageオブジェクトのコレクションを取得または設定します。
public List<message> Messages { get; set; }
プロパティの値
List<Message>
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 PdfConverterOptions
情報
Pdfコンバータプラグインのオプションを表します。
public abstract class PdfConverterOptions : IPluginOptions
継承
object ←
PdfConverterOptions
派生
実装
継承メンバー
プロパティ
PdfConverterOptionsプラグインデータコレクションを返します。
public List<idatasource> Inputs { get; }
プロパティ値
List<IDataSource>
出力
保存操作結果の追加対象のコレクションを取得します。
public List<idatasource> Outputs { get; }
プロパティ値
List<IDataSource>
メソッド
新しいデータソースをPdfConverterプラグインデータコレクションに追加します。
public void AddInput(IDataSource dataSource)
パラメーター
AddOutput(IDataSource)
新しいデータソースをPdfToXLSXConverterOptionsプラグインデータコレクションに追加します。
public void AddOutput(IDataSource saveDataSource)
パラメーター
saveDataSource
IDataSource: 保存操作結果のためのデータソース(ファイルまたはストリーム)。
例外
NotImplementedException
Class PdfToDocOptions
情報
Documentize.DocConverterプラグインのPDFからDOCへの変換オプションを表します。
public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions
継承
object ←
PdfConverterOptions ←
PdfToDocOptions
実装
継承されたメンバー
- PdfConverterOptions.AddInput(IDataSource),
- PdfConverterOptions.AddOutput(IDataSource),
- PdfConverterOptions.Inputs,
- PdfConverterOptions.Outputs,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
コンストラクタ
PdfToDocOptions()
デフォルトオプションでDocumentize.PdfToDocOptionsオブジェクトの新しいインスタンスを初期化します。
Class PdfToHtmlOptions
情報
Documentize.HtmlConverterプラグイン用のPDFからHTMLへの変換オプションを表します。
public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
PdfToHtmlOptions
実装
継承メンバー
- 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()
コンストラクター
PdfToHtmlOptions(SaveDataType)
指定された出力データ型のDocumentize.PdfToHtmlOptionsオブジェクトの新しいインスタンスを初期化します。
public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType = SaveDataType.FileWithExternalResources)
パラメーター
プロパティ
OutputDataType
出力データ型を取得します。
public PdfToHtmlOptions.SaveDataType OutputDataType { get; }
プロパティ値
PdfToHtmlOptions.SaveDataType
Class PdfToJpegOptions
情報
Documentize.JpegConverterプラグインのためのPDFからJPEGへのコンバータオプションを表します。
public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
PdfToJpegOptions
実装
継承されたメンバー
- 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()
コンストラクタ
PdfToJpegOptions()
Documentize.PdfToJpegOptionsオブジェクトの新しいインスタンスを初期化します。
public PdfToJpegOptions()
プロパティ
OutputResolution
結果画像の解像度値を取得または設定します。
public int OutputResolution { get; set; }
プロパティ値
int
PageList
処理するページのリストを取得または設定します。
public List<int> PageList { get; set; }
プロパティ値
List<int>
Quality
出力品質を取得および設定します。
画像の圧縮レベルを指定します。
品質の有用な値の範囲は0から100です。
指定された数値が低いほど圧縮率が高くなり、そのため画像の品質は低くなります。
ゼロは最低品質の画像を与え、100は最高品質の画像を与えます。
public int Quality { get; set; }
プロパティ値
int
Class PdfToPngOptions
情報
Documentize.PngConverterプラグインのPDFからPNGへのコンバータオプションを表します。
public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
PdfToPngOptions
実装
継承されたメンバー
- 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()
コンストラクタ
PdfToPngOptions()
Documentize.PdfToPngOptionsオブジェクトの新しいインスタンスを初期化します。
プロパティ
OutputResolution
結果の画像の解像度値を取得または設定します。
public int OutputResolution { get; set; }
プロパティ値
int
PageList
処理するページのリストを取得または設定します。
public List<int> PageList { get; set; }
プロパティ値
List<int>
Class PdfToTiffOptions
情報
Documentize.TiffConverterプラグインのPDFからTIFFへの変換オプションを表します。
public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
PdfToTiffOptions
実装
継承されたメンバー
- 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()
コンストラクタ
PdfToTiffOptions()
Documentize.PdfToTiffOptions オブジェクトの新しいインスタンスを初期化します。
public PdfToTiffOptions()
プロパティ
ColorDepth
色の深さを取得または設定します。
public TiffColorDepth ColorDepth { get; set; }
プロパティ値
TiffColorDepth
注釈
デフォルト値は Documentize.TiffColorDepth.Format32bpp です。
Compression
圧縮の種類を取得または設定します。
public TiffCompression Compression { get; set; }
プロパティ値
TiffCompression
注釈
デフォルト値は Documentize.TiffCompression.LZW です。
MultiPage
すべてのページを1つのマルチページTIFFに保存できるフラグを取得または設定します。
デフォルト値は false です。
public bool MultiPage { get; set; }
プロパティ値
bool
OutputResolution
生成される画像の解像度値を取得または設定します。
public int OutputResolution { get; set; }
プロパティ値
int
PageList
処理するページのリストを取得または設定します。
public List<int> PageList { get; set; }
プロパティ値
List<int>
Class PdfToXlsOptions
情報
Documentize.XlsConverterプラグインのPDFからXLS/XLSXへの変換オプションを表します。
public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions
継承
object ←
PdfConverterOptions ←
PdfToXlsOptions
実装
継承されたメンバー
- PdfConverterOptions.AddInput(IDataSource),
- PdfConverterOptions.AddOutput(IDataSource),
- PdfConverterOptions.Inputs,
- PdfConverterOptions.Outputs,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
コンストラクター
PdfToXlsOptions()
デフォルトオプションでDocumentize.PdfToXlsOptionsオブジェクトの新しいインスタンスを初期化します。
プロパティ
出力フォーマット。
public PdfToXlsOptions.ExcelFormat Format { get; set; }
プロパティ値
PdfToXlsOptions.ExcelFormat
InsertBlankColumnAtFirst
ワークシートの最初の列として空白の列を挿入する必要がある場合はtrueに設定します。
デフォルト値はfalseで、空白の列は挿入されません。
public bool InsertBlankColumnAtFirst { get; set; }
プロパティ値
bool
MinimizeTheNumberOfWorksheets
結果のワークブックのワークシートの数を最小限にする必要がある場合はtrueに設定します。
デフォルト値はfalseで、各PDFページを別々のワークシートとして保存します。
public bool MinimizeTheNumberOfWorksheets { get; set; }
プロパティ値
bool
Class PluginBaseOptions
public class PluginBaseOptions : IPluginOptions
継承
object ←
PluginBaseOptions
派生
- AddTimestampOptions,
- CompressOptions,
- DecryptionOptions,
- EncryptionOptions,
- FormExportToDsvOptions,
- FormFlattenerOptions,
- HtmlToPdfOptions,
- ImageExtractorOptions,
- MergeOptions,
- OptimizeOptions,
- PdfToHtmlOptions,
- PdfToJpegOptions,
- PdfToPngOptions,
- PdfToTiffOptions,
- ResizeOptions,
- RotateOptions,
- SignOptions,
- SplitOptions,
- TableOptions,
- TocOptions
実装
継承したメンバー
プロパティ
操作が完了した後に入力ストリームを閉じます。
public bool CloseInputStreams { get; set; }
プロパティ値
bool
CloseOutputStreams
操作が完了した後に出力ストリームを閉じます。
public bool CloseOutputStreams { get; set; }
プロパティ値
bool
操作のための入力データを返します。
public List<idatasource> Inputs { get; }
プロパティ値
List<IDataSource>
Outputs
操作のための出力データを返します。
public List<idatasource> Outputs { get; }
プロパティ値
List<IDataSource>
メソッド
Inputsに新しいデータを追加します。
public void AddInput(IDataSource dataSource)
パラメータ
AddOutput(IDataSource)
Outputsに新しいデータを追加します。
public void AddOutput(IDataSource saveDataSource)
パラメータ
Class PngConverter
情報
Documentize.PngConverterプラグインを表します。PDFドキュメントをPNG形式に変換するために使用されます。
public static class PngConverter
継承
object ←
PngConverter
継承されたメンバー
例
この例では、PDFドキュメントをPNG形式に変換する方法を示します。
// PdfToPngOptionsオブジェクトを作成して指示を設定
var options = new PdfToPngOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
PngConverter.Process(options);
この例では、PDFドキュメントの1ページをPNG形式に変換する方法を示します。
// PdfToPngOptionsオブジェクトを作成して指示を設定
var options = new PdfToPngOptions()
// 最初のページのみを処理
options.PageList = [1];
// 出力解像度を200 DPIに設定
options.OutputResolution = 200;
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 処理を実行
PngConverter.Process(options);
この例では、PDFドキュメントをPNG形式に変換してストリームに出力する方法を示します。
// PdfToJpegOptionsオブジェクトを作成して指示を設定
var options = new PdfToPngOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 処理を実行
var results = PngConverter.Process(options);
// ストリーム結果を取得
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
メソッド
Process(PdfToPngOptions)
PDFドキュメントをPNG形式に変換します。
public static ResultContainer Process(PdfToPngOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
Class Rectangle
継承
object ←
Rectangle
継承されたメンバー
コンストラクター
Rectangle(double, double, double, double)
Rectangleのコンストラクターです。
public Rectangle(double llx, double lly, double urx, double ury)
パラメーター
Class ResizeOptions
情報
Documentize.Optimizer プラグインのリサイズオプションを表します。
public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
ResizeOptions
実装
継承メンバー
- 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()
コンストラクタ
ResizeOptions()
デフォルトオプションで Documentize.ResizeOptions オブジェクトの新しいインスタンスを初期化します。
プロパティ
PageSize
新しいページサイズを取得または設定します。
public PageSize PageSize { get; set; }
プロパティ値
PageSize
Class ResultContainer
情報
プラグインの処理結果のコレクションを含むコンテナを表します。
public class ResultContainer
継承
object ←
ResultContainer
継承メンバー
プロパティ
ResultCollection
操作結果のコレクションを取得します。
public List<ioperationresult> ResultCollection { get; }
プロパティ値
List<IOperationResult>
Class RotateOptions
情報
Documentize.Optimizerプラグインの回転オプションを表します。
public sealed class RotateOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
RotateOptions
実装
継承メンバー
- 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()
コンストラクタ
RotateOptions()
デフォルトオプションを使用して、Documentize.RotateOptionsオブジェクトの新しいインスタンスを初期化します。
プロパティ
Rotation
新しいページの回転を取得または設定します。
public Rotation Rotation { get; set; }
プロパティ値
Rotation
Class Security
情報
Documentize.Securityプラグインを表します。PDF文書を暗号化および復号化するために使用されます。
public static class Security
継承
object ←
Security
継承メンバー
例
この例はPDF文書を暗号化する方法を示します。
// 指示を設定するためのEncryptionOptionsオブジェクトを作成
var options = new EncryptionOptions("123456", "qwerty");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
Security.Process(options);
この例はPDF文書を復号化する方法を示します。
// 指示を設定するためのDecryptionOptionsオブジェクトを作成
var options = new DecryptionOptions("123456");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// プロセスを実行
Security.Process(options);
メソッド
Process(EncryptionOptions)
PDFドキュメントを暗号化します。
public static ResultContainer Process(EncryptionOptions options)
パラメータ
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
Process(DecryptionOptions)
PDFドキュメントを復号化します。
public static ResultContainer Process(DecryptionOptions options)
パラメータ
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
Class SignOptions
情報
Documentize.Signatureプラグインの署名オプションを表します。
public sealed class SignOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
SignOptions
実装するインターフェース
継承メンバー
- 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()
コンストラクタ
SignOptions(string, string)
デフォルトのオプションでDocumentize.SignOptionsオブジェクトの新しいインスタンスを初期化します。
public SignOptions(string pfx, string password)
パラメーター
SignOptions(Stream, string)
デフォルトのオプションでDocumentize.SignOptionsオブジェクトの新しいインスタンスを初期化します。
public SignOptions(Stream pfx, string password)
パラメーター
プロパティ
署名の連絡先。
public string Contact { get; set; }
プロパティ値
string
Location
署名の場所。
public string Location { get; set; }
プロパティ値
string
Name
既存の署名フィールドの名前。
新しいフィールドを作成するにはnullを指定します。
public string Name { get; set; }
プロパティ値
string
PageNumber
署名が作成されるページ番号。
public int PageNumber { get; set; }
プロパティ値
int
Reason
署名の理由。
public string Reason { get; set; }
プロパティ値
string
Rectangle
署名の矩形。
public Rectangle Rectangle { get; set; }
プロパティ値
Rectangle
Visible
署名の可視性。
public bool Visible { get; set; }
プロパティ値
bool
Class SplitOptions
情報
Documentize.Splitterプラグインの分割オプションを表します。
public sealed class SplitOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
SplitOptions
実装
継承メンバー
- 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()
コンストラクタ
SplitOptions()
デフォルトオプションでDocumentize.SplitOptionsオブジェクトの新しいインスタンスを初期化します。
Class Splitter
情報
Documentize.Splitter プラグインを表します。PDF ドキュメントを別々のページに分割するために使用されます。
public static class Splitter
継承
object ←
Splitter
継承メンバー
例
この例は、PDF ドキュメントを分割する方法を示します。
// Create SplitOptions object to set instructions
var options = new SplitOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file paths
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// Perform the process
Splitter.Process(options);
メソッド
Process(SplitOptions)
ページごとにPDFドキュメントを分割します。
public static ResultContainer Process(SplitOptions options)
パラメータ
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
例外
ArgumentException
オプションが設定されていない場合。
Class StreamDataSource
情報
プラグインのロードおよび保存操作のためのストリームデータソースを表します。
public sealed class StreamDataSource : IDataSource
継承
object ←
StreamDataSource
実装
継承メンバー
コンストラクタ
StreamDataSource(Stream)
指定されたストリームオブジェクトを使用して新しいストリームデータソースを初期化します。
public StreamDataSource(Stream data)
パラメータ
プロパティ
Data
現在のデータソースのストリームオブジェクトを取得します。
public Stream Data { get; }
プロパティ値
Stream
DataType
データソースのタイプ(ストリーム)。
public DataType DataType { get; }
プロパティ値
DataType
Class StreamResult
public sealed class StreamResult : IOperationResult
継承
object ←
StreamResult
実装
継承されたメンバー
プロパティ
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()
結果をファイルに変換しようとします。
戻り値
string : 結果がファイルの場合、出力ファイルへのパスを表す文字列。そうでない場合は null
。
ToStream()
結果をストリームオブジェクトに変換しようとします。
戻り値
Stream : 結果がストリームの場合、出力データを表すストリームオブジェクト。そうでない場合は null
。
Class StringResult
public sealed class StringResult : IOperationResult
継承
object ←
StringResult
実装
継承されたメンバー
プロパティ
Data
生データを取得します。
public object Data { get; }
プロパティ値
object
IsFile
結果が出力ファイルへのパスであるかどうかを示します。
public bool IsFile { get; }
プロパティ値
bool
IsStream
結果が出力ファイルへのパスであるかどうかを示します。
public bool IsStream { get; }
プロパティ値
bool
IsString
結果が文字列であるかどうかを示します。
public bool IsString { get; }
プロパティ値
bool
Text
結果の文字列表現を返します。
public string Text { get; }
プロパティ値
string
メソッド
ToFile()
結果をファイルに変換しようとします。
戻り値
string : 結果がファイルである場合の出力ファイルへのパスを表す文字列; そうでない場合は null
。
ToStream()
結果をストリームオブジェクトに変換しようとします。
戻り値
Stream : 結果がストリームである場合の出力データを表すストリームオブジェクト; そうでない場合は null
。
ToString()
結果を文字列に変換しようとします。
public override string ToString()
戻り値
string : 結果が文字列である場合のテキストコンテンツを表す文字列; そうでない場合は base.ToString() を返します。
Class TableBuilder
情報
クラスはPDFページのためのテーブルビルダーを表します。
public class TableBuilder
継承
object ←
TableBuilder
派生
継承されたメンバー
メソッド
AddRow()
テーブルに新しい行を追加します。
public virtual TableRowBuilder AddRow()
返り値
TableRowBuilder : 現在のDocumentize.TableRowBuilderのインスタンス。
AddTable()
ドキュメントに新しいテーブルを追加します。
public TableBuilder AddTable()
返り値
TableBuilder : 現在のDocumentize.TableBuilderのインスタンス。
InsertPageAfter(int)
指定したページの後にページを挿入します。
public TableOptions InsertPageAfter(int page)
パラメータ
page
int: テーブルを追加するページ番号。
返り値
TableOptions : 現在のDocumentize.TableOptionsのインスタンス。
InsertPageBefore(int)
指定したページの前にページを挿入します。
public TableOptions InsertPageBefore(int page)
パラメータ
page
int: テーブルを追加するページ番号。
返り値
TableOptions : 現在のDocumentize.TableOptionsのインスタンス。
演算子
implicit operator TableOptions(TableBuilder)
ビルダーDocumentize.TableBuilderをオプションDocumentize.TableOptionsに変換します。
public static implicit operator TableOptions(TableBuilder builder)
パラメータ
返り値
TableOptions : PdfGeneratorTableOptionsへの変換の結果。
Class TableCellBuilder
public class TableCellBuilder : TableRowBuilder
継承
object ←
TableBuilder ←
TableRowBuilder ←
TableCellBuilder
継承したメンバー
- TableRowBuilder.AddCell(),
- TableRowBuilder.AddRow(),
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
メソッド
AddCell()
テーブルにセルを追加します。
public override TableCellBuilder AddCell()
返り値
TableCellBuilder : 現在の Documentize.TableCellBuilder のインスタンスです。
AddParagraph(params string[])
テーブルセルに段落を追加します。
public TableCellBuilder AddParagraph(params string[] paragraphs)
パラメータ
返り値
TableCellBuilder : 現在の Documentize.TableCellBuilder のインスタンスです。
Class TableGenerator
情報
Documentize.TableGeneratorプラグインを表します。PDF文書にテーブルを追加するために使用されます。
public sealed class TableGenerator
継承
object ←
TableGenerator
継承メンバー
例
この例は、PDFファイルにテーブルを追加する方法を示しています。
// TableGeneratorを初期化
var plugin = new TableGenerator();
// テーブルオプションを設定
var options = new TableOptions().InsertPageBefore(1)
.AddTable()
.AddRow()
.AddCell().AddParagraph("名前")
.AddCell().AddParagraph("年齢")
.AddRow()
.AddCell().AddParagraph("ボブ")
.AddCell().AddParagraph("12")
.AddRow()
.AddCell().AddParagraph("サム")
.AddCell().AddParagraph("20")
.AddRow()
.AddCell().AddParagraph("サンディ")
.AddCell().AddParagraph("26")
.AddRow()
.AddCell().AddParagraph("トム")
.AddCell().AddParagraph("12")
.AddRow()
.AddCell().AddParagraph("ジム")
.AddCell().AddParagraph("27");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// プロセスを実行
plugin.Process(options);
コンストラクタ
TableGenerator()
メソッド
Process(TableOptions)
PDF文書にテーブルを追加します。
public ResultContainer Process(TableOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
例外
ArgumentException
オプションが設定されていない場合。
Class TableOptions
情報
Documentize.TableGeneratorプラグインによってドキュメントにテーブルを追加するオプションを表します。
public sealed class TableOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
TableOptions
実装
継承されたメンバー
- 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()
コンストラクタ
TableOptions()
デフォルトオプションを使用してDocumentize.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のインスタンス。
Class TableRowBuilder
public class TableRowBuilder : TableBuilder
継承
object ←
TableBuilder ←
TableRowBuilder
派生
継承メンバー
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
メソッド
AddCell()
セルをテーブル行に追加します。
public virtual TableCellBuilder AddCell()
戻り値
TableCellBuilder : 作成されたDocumentize.TableCellBuilderのインスタンス。
AddRow()
AddRowをオーバーライドします。
public override TableRowBuilder AddRow()
戻り値
TableRowBuilder : 現在のDocumentize.TableRowBuilderのインスタンス。
情報
Documentize.TextExtractorプラグインを表します。PDF文書からテキストを抽出するために使用されます。
public static class TextExtractor
継承
object ←
TextExtractor
引き継がれたメンバー
例
この例は、PDF文書のテキストコンテンツを抽出する方法を示しています。
// 手順を設定するためのTextExtractorOptionsオブジェクトを作成
var options = new TextExtractorOptions(TextFormattingMode.Pure);
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 処理を実行
var results = TextExtractor.Process(options);
// ResultContainerオブジェクトから抽出されたテキストを取得
var textExtracted = results.ResultCollection[0].ToString();
メソッド
PDF文書からテキストを抽出します。
public static ResultContainer Process(TextExtractorOptions options)
パラメータ
戻り値
ResultContainer : 抽出の結果を含むオブジェクトです。
例外
ArgumentException
オプションが設定されていない場合。
情報
Documentize.TextExtractor プラグインのためのテキスト抽出オプションを表します。
public sealed class TextExtractorOptions
継承
object ←
TextExtractorOptions
継承メンバー
コンストラクタ
指定されたテキストフォーマットモードのために Documentize.TextExtractorOptions オブジェクトの新しいインスタンスを初期化します。
public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)
パラメーター
プロパティ
フォーマットモードを取得します。
public TextFormattingMode FormattingMode { get; set; }
プロパティ値
TextFormattingMode
操作のための Inputs データを返します。
public List<idatasource> Inputs { get; }
プロパティ値
List<IDataSource>
メソッド
Inputs に新しいデータを追加します。
public void AddInput(IDataSource dataSource)
パラメーター
Class TiffConverter
情報
Documentize.TiffConverterプラグインを表します。PDFドキュメントをTIFF形式に変換するために使用されます。
public static class TiffConverter
継承
object ←
TiffConverter
継承されたメンバー
例
この例は、PDFドキュメントをTIFF形式に変換する方法を示しています。
// 指示を設定するためのPdfToTiffOptionsオブジェクトを作成
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// プロセスを実行
TiffConverter.Process(options);
この例は、ページとDPIをカスタマイズしてPDFドキュメントをTIFF形式に変換する方法を示しています。
// 指示を設定するためのPdfToTiffOptionsオブジェクトを作成
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// ページを設定
options.PageList = [1, 3];
// 画像の解像度を設定
options.OutputResolution = 400;
// プロセスを実行
TiffConverter.Process(options);
この例は、PDFドキュメントをマルチページのTIFFとして変換する方法を示しています。
// 指示を設定するためのPdfToTiffOptionsオブジェクトを作成
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// マルチページTIFF出力を有効にする
options.MultiPage = true;
// プロセスを実行
TiffConverter.Process(options);
この例は、圧縮と色深度をカスタマイズしてPDFドキュメントをTIFF形式に変換する方法を示しています。
// 指示を設定するためのPdfToTiffOptionsオブジェクトを作成
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ディレクトリパスを設定
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// 圧縮と色深度を設定
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// プロセスを実行
TiffConverter.Process(options);
この例は、ストリームにPDFドキュメントをTIFF形式に変換する方法を示しています。
// 指示を設定するためのPdfToTiffOptionsオブジェクトを作成
var options = new PdfToTiffOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_input.pdf"));
// プロセスを実行
var results = TiffConverter.Process(options);
// ストリーム結果を取得
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
メソッド
Process(PdfToTiffOptions)
PDFドキュメントをTIFF形式に変換します。
public static ResultContainer Process(PdfToTiffOptions options)
パラメータ
戻り値
ResultContainer : 操作の結果を含むオブジェクトです。
例外
ArgumentException
optionsが設定されていない場合。
Class TocGenerator
情報
Documentize.TocGenerator プラグインを表します。PDF ドキュメントに目次を追加するために使用されます。
public static class TocGenerator
継承
object ←
TocGenerator
継承メンバー
例
この例は、PDF ファイルに目次を追加する方法を示します。
// TocOptions オブジェクトを作成して指示を設定
var options = new TocOptions();
// タイトルを設定
options.Title = "My Table of Contents";
// ブックマークのリンクを生成
options.GenerateBookmarks = true;
// 見出しをデザイン
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));
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
TocGenerator.Process(options);
メソッド
Process(TocOptions)
指定されたパラメータを使用して Documentize.TocGenerator の処理を開始します。
public static ResultContainer Process(TocOptions options)
パラメータ
戻り値
ResultContainer: 操作の結果を含む Documentize.ResultContainer オブジェクト。
Class TocHeading
情報
Documentize.TocGenerator プラグインによって文書化される目次の見出しやタイトルのオプションを表します。
継承
object ←
TocHeading
継承されたメンバー
コンストラクタ
TocHeading(string, int, bool, int)
Documentize.TocHeading の新しいインスタンスを初期化します。
public TocHeading(string text, int pageNumber, bool generateNumbering = false, int level = 1)
パラメーター
text
string: タイトルのテキスト。pageNumber
int: リンクのページ番号。generateNumbering
bool: 番号生成の使用。level
int: レベル。
プロパティ
GenerateNumbering
番号生成の使用。
true
の場合、自動的に番号付けを行う必要があります。それ以外の場合は、手動で番号付けを行う必要があります。
public bool GenerateNumbering { get; set; }
プロパティ値
bool
Level
レベル。
番号生成に使用されます。
public int Level { get; set; }
プロパティ値
int
PageNumber
リンクのページ番号。
public int PageNumber { get; set; }
プロパティ値
int
Text
タイトルのテキスト。
public string Text { get; set; }
プロパティ値
string
Class TocOptions
情報
Documentize.TocGenerator プラグインを使用して文書に目次を追加するためのオプションを表します。
public sealed class TocOptions : PluginBaseOptions, IPluginOptions
継承
object ←
PluginBaseOptions ←
TocOptions
実装
受け継いだメンバー
- 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()
コンストラクタ
TocOptions()
Documentize.TocOptions オブジェクトの新しいインスタンスをデフォルトオプションで初期化します。
プロパティ
GenerateBookmarks
ブックマーク生成を使用します。
true
に設定すると、ブックマークはクリアされ、見出しによって生成されます。そうでない場合、ブックマークは変更されません。
public bool GenerateBookmarks { get; set; }
プロパティ値
bool
Headings
目次の見出しまたはタイトルです。
public List<tocheading> Headings { get; set; }
プロパティ値
List<TocHeading>
Title
目次のタイトルです。
public string Title { get; set; }
プロパティ値
string
Class XlsConverter
情報
Documentize.XlsConverterプラグインを表します。PDFドキュメントをXLSX/XLS形式に変換するために使用されます。
public static class XlsConverter
継承
object ←
XlsConverter
継承されたメンバー
例
以下の例は、PDFをXLSXドキュメントに変換する方法を示しています。
// 指示を設定するためのPdfToXlsOptionsオブジェクトを作成
var options = new PdfToXlsOptions();
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
XlsConverter.Process(options);
メソッド
Process(PdfToXlsOptions)
PDFドキュメントをXLSX/XLS形式に変換します。
public static ResultContainer Process(PdfToXlsOptions options)
パラメーター
戻り値
ResultContainer : 操作の結果を含むオブジェクト。
例外
ArgumentException
オプションが設定されていない場合。
Enum ConvertErrorAction
情報
このクラスは変換エラーに対するアクションを表します。
public enum ConvertErrorAction
フィールド
Enum ConvertSoftMaskAction
情報
このアクションは、ソフトマスクを使用した画像の変換に関するアクションを表します。
public enum ConvertSoftMaskAction
フィールド
ConvertToStencilMask = 1
: ソフトマスクはステンシルマスクに変換されます。Default = 0
: デフォルトの戦略を使用します。
Enum DataType
情報
プラグイン処理のためのデータの可能なタイプを表します。
フィールド
Directory = 2
: データ型はそのパスで表されるディレクトリです。File = 0
: データ型はそのパスで表されるファイルです。Stream = 1
: データ型はストリームです。
情報
レンダリング中に使用される可能性のあるメディアタイプを指定します。
public enum HtmlMediaType
フィールド
Print = 0
: 印刷.Screen = 1
: スクリーン.
Enum HtmlPageLayoutOption
情報
ページのサイズとレイアウトを決定するフラグを指定します。
public enum HtmlPageLayoutOption
フィールド
FitToWidestContentWidth = 3
: ページの幅が指定されたページ幅ではなく、コンテンツサイズ自体から決定されることを示します。None = 0
: HtmlPageLayoutOptionがページのサイズやレイアウトに影響を与えないことを示すデフォルト値です。ScaleToPageWidth = 256
: ドキュメントの内容がページに合わせてスケーリングされることを示します。
Enum PdfAStandardVersion
情報
PDF文書のPDF/A標準バージョンを指定します。
public enum PdfAStandardVersion
フィールド
Auto = 0
: PDF/A標準バージョンは自動的に決定されます。PDF_A_1A = 1
: PDF/A-1a標準バージョンを指定します。PDF_A_1B = 2
: PDF/A-1b標準バージョンを指定します。PDF_A_2A = 3
: PDF/A-2a標準バージョンを指定します。PDF_A_2B = 4
: PDF/A-2b標準バージョンを指定します。PDF_A_2U = 5
: PDF/A-2u標準バージョンを指定します。PDF_A_3A = 6
: PDF/A-3a標準バージョンを指定します。PDF_A_3B = 7
: PDF/A-3b標準バージョンを指定します。PDF_A_3U = 8
: PDF/A-3u標準バージョンを指定します。
Enum PdfToHtmlOptions.SaveDataType
public enum PdfToHtmlOptions.SaveDataType
フィールド
FileWithEmbeddedResources = 1
: 埋め込みリソース付きのファイルにHTMLを保存FileWithExternalResources = 0
: 外部リソース付きのファイルにHTMLを保存StreamWithEmbeddedResources = 2
: 埋め込みリソース付きのファイルストリームにHTMLを保存
情報
xls/xlsx/xml/csvファイル形式を指定できます。デフォルト値はXLSXです。
xls/xlsx/xml/csvファイル形式を指定できます。
デフォルト値はXLSXです。
public enum PdfToXlsOptions.ExcelFormat
フィールド
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) ファイル形式。
Enum Role
フィールド
Assistant = 2
System = 1
User = 0
Enum Rotation
フィールド
None = 0
: 非回転。On180 = 2
: 180度回転。On270 = 3
: 時計回りに270度回転。On360 = 4
: 時計回りに360度回転。On90 = 1
: 時計回りに90度回転。
情報
PDF ドキュメントをテキストに変換するときに使用できる異なるモードを定義します。Documentize.TextExtractorOptions クラスを参照してください。
public enum TextExtractorOptions.TextFormattingMode
Fields
Plain = 2
: テキストフラグメントの相対的な位置を考慮しつつ、追加のスペースを加えずに PDF テキストコンテンツを表します。Pure = 0
: 少数のフォーマットルーチンを使用して PDF テキストコンテンツを表します。これには、相対的な位置を考慮し、テキストをページの幅に合わせるために追加のスペースを加えることが含まれます。Raw = 1
: フォーマットなしの PDF コンテンツをそのまま表します。
Enum TextFormattingMode
情報
PDFドキュメントをテキストに変換する際に使用できる異なるモードを定義します。Documentize.TextExtractorOptions クラスを参照してください。
public enum TextFormattingMode
フィールド
Flatten = 2
: PDFコンテンツを座標によるテキストフラグメントで表現します。これは基本的に「Raw」モードに似ています。しかし、「Raw」がドキュメント内のテキストフラグメント(オペレーター)の構造を保持することに重点を置くのに対し、「Flatten」は読み取られる順序でテキストを保持することに重点を置いています。Pure = 0
: PDFテキストコンテンツをいくつかのフォーマットルーチンを用いて表現します。これには相対的な位置を考慮し、テキストをページの幅に合わせるために追加のスペースを加えることが含まれます。Raw = 1
: PDFコンテンツをそのまま表現します。つまり、フォーマットなしで表現します。
Enum TiffColorDepth
情報
Documentize.PdfToTiffOptionsのカラー深度を指定するために使用されます。
public enum TiffColorDepth
フィールド
Format1bpp = 4
: 1ピクセルあたり1ビット。Format24bpp = 1
: 1ピクセルあたり24ビット。Rgb。Format32bpp = 0
: 1ピクセルあたり32ビット。デフォルトで使用されます。Format4bpp = 3
: 1ピクセルあたり4ビット。Format8bpp = 2
: 1ピクセルあたり8ビット。
Enum TiffCompression
情報
Documentize.PdfToTiffOptionsの圧縮タイプを指定するために使用されます。
public enum TiffCompression
フィールド
CCITT3 = 2
: CCITT3圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてCCITT3エンコーダに渡すことができます。CCITT4 = 1
: CCITT4圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてCCITT4エンコーダに渡すことができます。LZW = 0
: LZW圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてTiffエンコーダに渡すことができます。None = 4
: 圧縮なしを指定します。圧縮カテゴリに属するパラメータとしてTiffエンコーダに渡すことができます。RLE = 3
: RLE圧縮スキームを指定します。圧縮カテゴリに属するパラメータとしてRLEエンコーダに渡すことができます。
Interface IDataSource
情報
具体的なデータが実装すべき共通メンバーを定義する一般的なデータインターフェース。
public interface IDataSource
プロパティ
DataType
データソースのタイプ。
DataType DataType { get; }
プロパティの値
DataType
Interface IOperationResult
情報
具体的なプラグイン操作結果が実装すべき共通メソッドを定義する一般的な操作結果インターフェイス。
public interface IOperationResult
プロパティ
Data
生データを取得します。
プロパティの値
object
IsFile
結果が出力ファイルへのパスであるかどうかを示します。
プロパティの値
bool
IsStream
結果が出力ストリームであるかどうかを示します。
プロパティの値
bool
IsString
結果がテキスト文字列であるかどうかを示します。
プロパティの値
bool
メソッド
ToFile()
結果をファイルに変換しようとします。
戻り値
string : 結果がファイルの場合は出力ファイルへのパスを表す文字列、それ以外の場合は null
。
ToStream()
結果をストリームオブジェクトに変換しようとします。
戻り値
Stream : 結果がストリームの場合は出力データを表すストリームオブジェクト、それ以外の場合は null
。
Interface IPluginOptions
情報
一般的なプラグインオプションインターフェースで、具体的なプラグインオプションが実装すべき共通メソッドを定義します。
public interface IPluginOptions
情報
PDF 文書のページに存在する可能性のあるテキスト、画像、その他のタイプのコンテンツを抽出するための基本機能を表します。
public abstract class PdfExtractor : IDisposable
継承
object ←
PdfExtractor
派生
実装
継承されたメンバー
例
この例では、PDF 文書のテキストコンテンツを抽出する方法を示します。
// PDF コンテンツを抽出するために TextExtractor オブジェクトを作成
using (TextExtractor extractor = new TextExtractor())
{
// 指示を設定するために TextExtractorOptions オブジェクトを作成
textExtractorOptions = new TextExtractorOptions();
// 入力ファイルパスを追加
textExtractorOptions.AddInput(new FileDataSource(inputPath));
// 抽出プロセスを実行
ResultContainer resultContainer = extractor.Process(textExtractorOptions);
// ResultContainer オブジェクトから抽出したテキストを取得
string textExtracted = resultContainer.ResultCollection[0].ToString();
}
備考
Documentize.TextExtractor オブジェクトはテキストを抽出するために使用され、Documentize.ImageExtractor は画像を抽出するために使用されます。
コンストラクター
メソッド
IDisposable の実装。実際には、PdfExtractor のために必要ではありません。
指定されたパラメータで PdfExtractor の処理を開始します。
public ResultContainer Process(IPluginOptions pdfExtractorOptions)
パラメーター
pdfExtractorOptions
IPluginOptions: PdfExtractor のための指示を含むオプションオブジェクト。
戻り値
ResultContainer : 抽出の結果を含む ResultContainer オブジェクト。
情報
TextExtractorとImageExtractorプラグインのオプションを表します。
public abstract class PdfExtractorOptions : IPluginOptions
継承
object ←
PdfExtractorOptions
派生
実装
継承されたメンバー
備考
Documentize.PdfExtractorOptionsは、入力PDF文書を表すデータ(ファイル、ストリーム)を追加するための基本機能を含んでいます。
この代わりにDocumentize.TextExtractorOptionsまたはImageExtractorOptionsを作成してください。
プロパティ
PdfExtractorプラグインデータコレクションを返します。
public List<idatasource> Inputs { get; }
プロパティ値
List<IDataSource>
操作名を返します。
public virtual string OperationName { get; }
プロパティ値
string
メソッド
PdfExtractorプラグインデータコレクションに新しいデータソースを追加します。
public void AddInput(IDataSource dataSource)
パラメーター
クラス Timestamp
情報
Documentize.Timestampプラグインを表します。
継承
object ←
Timestamp
継承されたメンバー
例
この例は、ドキュメントにTimestampを追加する方法を示しています。
// create Timestamp
var plugin = new Timestamp();
// create AddTimestampOptions object to set instructions
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// add input file path
opt.AddInput(new FileDataSource("path_to_pdf"));
// set output file path
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// perform the process
plugin.Process(opt);
コンストラクター
Timestamp()
メソッド
Process(AddTimestampOptions)
指定されたパラメーターでDocumentize.Timestampの処理を開始します。
public ResultContainer Process(AddTimestampOptions options)
パラメーター
戻り値
ResultContainer: 操作の結果を含むResultContainerオブジェクト。
クラス シグネチャ
情報
Documentize.Signatureプラグインを表します。PDF文書に署名するために使用されます。
public static class Signature
継承
object ←
Signature
継承されたメンバー
例
この例では、PDF文書に署名する方法を示します。
// 指示を設定するためにSignOptionsオブジェクトを作成
var options = new SignOptions("path_to_your_pfx_file.pfx", "passwprd_of_your_pfx_file");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// 処理を実行
Signature.Process(options);
この例では、追加オプションを使用してPDF文書に署名する方法を示します。
// 指示を設定するためにSignOptionsオブジェクトを作成
var options = new SignOptions("path_to_your_pfx_file.pfx", "passwprd_of_your_pfx_file");
// 入力ファイルパスを追加
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// 出力ファイルパスを設定
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// オプションのパラメータ
options.Reason = "私の理由";
options.Contact = "私の連絡先";
options.Location = "私の場所";
options.PageNumber = 3;
// 処理を実行
Signature.Process(options);
メソッド
Process(SignOptions)
PDF文書に署名します。
public static ResultContainer Process(SignOptions options)
パラメータ
返り値
ResultContainer : 操作の結果を含むオブジェクト。
例外
ArgumentException
オプションが設定されていない場合。
クラス メッセージ
継承
object ←
Message
継承されたメンバー
コンストラクター
Message()
プロパティ
Content
メッセージの内容です。
[JsonProperty("content")]
public string Content { get; set; }
プロパティ値
string
Role
このメッセージの著者の役割を設定または取得します。
[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }
プロパティ値
Role
クラスライセンス
public static class License
継承
object ←
License
継承されたメンバー
例
ライセンスをアクティブにする方法を示します。
// ライセンスを設定
License.Set("PathToLicense.lic");
メソッド
Set(string)
コンポーネントにライセンスを付与します。
public static void Set(string licenseName)
パラメーター
licenseName
string: フルファイル名または短いファイル名が指定できます。評価モードに切り替えるには空の文字列を使用してください。
クラス情報
情報
このクラスは、現在の製品ビルドに関する情報を提供します。
継承
object ←
Info
継承されたメンバー
フィールド
AssemblyVersion アセンブリバージョン。
public const string AssemblyVersion = “25.8.0”
フィールドの値
string
製品
製品名。
public const string Product = "Documentize"
フィールドの値
string