文档化命名空间

类名描述
AddTimestampOptions表示文档化.Timestamp插件的添加时间戳选项。
CompressOptions表示文档化.Optimizer插件的压缩选项。
DecryptionOptions表示文档化.Security插件的解密选项。
DirectoryDataSource表示插件的加载和保存操作的目录数据。
DocConverter表示文档化.DocConverter插件。用于将PDF文档转换为DOC/DOCX格式。
EncryptionOptions表示文档化.Security插件的加密选项。
FileDataSource表示插件的加载和保存操作的文件数据。
FileResult表示以字符串路径形式的操作结果。
HtmlConverter表示文档化.HtmlConverter插件。用于将PDF文档转换为HTML格式和将HTML文档转换为PDF格式。
HtmlToPdfOptions表示文档化.HtmlConverter插件的HTML到PDF转换器选项。
ImageExtractor表示文档化.ImageExtractor插件。用于从PDF文档中提取图像。
ImageExtractorOptions表示文档化.ImageExtractor插件的图像提取选项。
Info该类提供有关当前产品构建的信息。
JpegConverter表示文档化.JpegConverter插件。用于将PDF文档转换为JPEG格式。
License提供设置许可证的方法。
MergeOptions表示文档化.Merger插件的合并选项。
Merger表示文档化.Merger插件。用于将多个PDF文档合并为单个PDF。
Message模型生成的聊天完成消息。
ObjectResult表示以字符串形式的操作结果。
OptimizeOptions表示文档化.Optimizer插件的优化选项。
Optimizer表示文档化.Optimizer插件。
PageInfo表示页面信息。
PageSize表示PDF文档中页面大小的类。
PdfAConvertOptions表示使用文档化.PdfAConverter插件将PDF文档转换为PDF/A格式的选项。
PdfAConverter表示处理PDF文档转换为PDF/A格式及验证PDF/A合规性的插件。
PdfAOptionsBase表示文档化.PdfAConverter插件选项的基类。该类提供配置PDF/A转换和验证过程的属性和方法。
PdfAValidateOptions表示使用文档化.PdfAConverter插件验证PDF文档的PDF/A合规性的选项。
PdfAValidationResult表示PDF/A验证过程的结果。
PdfChatGpt表示PdfChatGpt插件。
PdfChatGptOptions表示文档化.PdfChatGpt插件的选项。
PdfChatGptRequestOptions表示文档化.PdfChatGpt插件的选项。
PdfConverterOptions表示PDF转换插件的选项。
PdfExtractor表示提取文本、图像和其他可能出现在PDF文档页面上的内容的基本功能。
PdfExtractorOptions表示TextExtractor和ImageExtractor插件的选项。
PdfToDocOptions表示文档化.DocConverter插件的PDF到DOC转换器选项。
PdfToHtmlOptions表示文档化.HtmlConverter插件的PDF到HTML转换器选项。
PdfToJpegOptions表示文档化.JpegConverter插件的PDF到JPEG转换器选项。
PdfToPngOptions表示文档化.PngConverter插件的PDF到PNG转换器选项。
PdfToTiffOptions表示文档化.TiffConverter插件的PDF到TIFF转换器选项。
PdfToXlsOptions表示文档化.XlsConverter插件的PDF到XLSX转换器选项。
PluginBaseOptions表示插件的基本选项。
PngConverter表示文档化.PngConverter插件。用于将PDF文档转换为PNG格式。
Rectangle类表示矩形。
ResizeOptions表示文档化.Optimizer插件的调整大小选项。
ResultContainer表示包含处理插件结果集合的容器。
RotateOptions表示文档化.Optimizer插件的旋转选项。
Security表示文档化.Security插件。
SignOptions表示文档化.Signature插件的签名选项。
Signature表示文档化.Signature插件。
SplitOptions表示文档化.Splitter插件的拆分选项。
Splitter表示文档化.Splitter插件。用于将文档拆分为独立的页面。
StreamDataSource表示插件的加载和保存操作的流数据源。
StreamResult表示以流形式的操作结果。
StringResult表示以字符串形式的操作结果。
TableBuilder类表示PDF页面中表格的构建器。
TableCellBuilder类表示表格单元格的构建器。
TableGenerator表示文档化.TableGenerator插件。用于向PDF文档添加表格。
TableOptions表示文档化.TableGenerator插件添加表格到文档的选项。
TableRowBuilder类表示表格行的构建器。
TextExtractor表示文档化.TextExtractor插件。用于从PDF文档中提取文本。
TextExtractorOptions表示文档化.TextExtractor插件的文本提取选项。
TiffConverter表示文档化.TiffConverter插件。用于将PDF文档转换为TIFF格式。
Timestamp表示文档化.Timestamp插件。
XlsConverter表示文档化.XlsConverter插件。用于将PDF文档转换为XLSX/XLS格式。

接口

接口名描述
IDataSource定义具体数据应实现的公共成员的通用数据接口。
IOperationResult定义具体插件操作结果应实现的公共方法的通用操作结果接口。
IPluginOptions定义具体插件选项应实现的公共方法的通用插件选项接口。

枚举

枚举名描述
ConvertErrorAction该类表示转换错误的动作。
ConvertSoftMaskAction该动作表示对具有软遮罩的图像的转换动作。
DataType表示插件处理的可能数据类型。
PdfToXlsOptions.ExcelFormat允许指定.xlsx、.xls/xml或csv文件格式。默认值为XLSX。
HtmlMediaType指定在渲染期间使用的可能媒体类型。
HtmlPageLayoutOption指定标志,与其他选项一起确定页面的大小和布局。
PdfAStandardVersion指定PDF文档的PDF/A标准版本。
Role消息作者的角色。
Rotation可能的旋转值的枚举。
PdfToHtmlOptions.SaveDataType定义HTML文件的输出类型。
TextExtractorOptions.TextFormattingMode定义在将PDF文档转换为文本时可以使用的不同模式。请参见Documentize.TextExtractorOptions类。

文档化命名空间 的子部分

Enum PdfToHtmlOptions.SaveDataType

信息

定义HTML文件的输出类型。

public enum PdfToHtmlOptions.SaveDataType

字段

  • FileWithEmbeddedResources = 1: 将HTML保存到带有嵌入资源的文件中
  • FileWithExternalResources = 0: 将HTML保存到带有外部资源的文件中
  • StreamWithEmbeddedResources = 2: 将HTML保存到带有嵌入资源的文件流中

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

班级信息

信息

该班级提供关于当前产品构建的信息。

public static class Info

继承

objectInfo

继承成员

字段

  • AssemblyVersion 程序集版本。

字段值

string

产品

产品名称。

public const string Product = "Documentize"

字段值

string

命名空间: Documentize 程序集: Documentize.dll

接口 IDataSource

信息

定义具体数据应实现的公共成员的通用数据接口。

public interface IDataSource

属性

数据类型

数据源的类型。

DataType DataType { get; }

属性值

数据类型

命名空间: Documentize 程序集: Documentize.dll

接口 IOperationResult

信息

通用操作结果接口,定义了具体插件操作结果应实现的公共方法。

public interface IOperationResult

属性

数据

获取原始数据。

object Data { get; }

属性值

对象

IsFile

指示结果是否是输出文件的路径。

bool IsFile { get; }

属性值

布尔值

IsStream

指示结果是否是输出流。

bool IsStream { get; }

属性值

布尔值

IsString

指示结果是否是文本字符串。

bool IsString { get; }

属性值

布尔值

方法

ToFile()

尝试将结果转换为文件。

string ToFile()

返回

字符串 : 如果结果是文件,则返回表示输出文件路径的字符串;否则返回 null

ToStream()

尝试将结果转换为流对象。

Stream ToStream()

返回

: 如果结果是流,则返回表示输出数据的流对象;否则返回 null

命名空间: Documentize 程序集: Documentize.dll

接口 IPluginOptions

信息

定义具体插件选项应实现的通用插件选项接口。

public interface IPluginOptions

命名空间: Documentize 程序集: Documentize.dll

类 AddTimestampOptions

信息

表示 Documentize.Timestamp 插件的添加时间戳选项。

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsAddTimestampOptions

实现

继承的成员

构造函数

AddTimestampOptions(Stream, string, string, string)

使用默认选项初始化 Documentize.AddTimestampOptions 对象的新实例。

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

参数

  • pfx Stream: pfx 文件的路径。
  • password string: pfx 文件的密码。
  • serverUrl string: 时间戳服务器的 URL。
  • serverBasicAuthCredentials string: 基本身份验证凭据,用户名和密码组合成字符串 “username:password”。 (可选)。

AddTimestampOptions(string, string, string, string)

使用默认选项初始化 Documentize.AddTimestampOptions 对象的新实例。

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

参数

  • pfx string: pfx 文件的路径。
  • password string: pfx 文件的密码。
  • serverUrl string: 时间戳服务器的 URL。
  • serverBasicAuthCredentials string: 基本身份验证凭据,用户名和密码组合成字符串 “username:password”。 (可选)。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 CompressOptions

信息

表示 Documentize.Optimizer 插件的压缩选项。

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions  

继承

object
PluginBaseOptions
CompressOptions

实现

继承成员

构造函数

CompressOptions()

使用默认选项初始化 Documentize.CompressOptions 对象的新实例。

public CompressOptions()  

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 DecryptionOptions

信息

表示 Documentize.Security 插件的解密选项。

public class DecryptionOptions : PluginBaseOptions, IPluginOptions  

继承

object
PluginBaseOptions
DecryptionOptions

实现

继承的成员

构造函数

DecryptionOptions(string)

使用默认选项初始化 Documentize.DecryptionOptions 对象的新实例。

public DecryptionOptions(string ownerPassword)  

参数

  • ownerPassword string: 所有者密码。

属性

OwnerPassword

所有者密码。

public string OwnerPassword { get; set; }  

属性值

string

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 DocConverter

信息

表示 Documentize.DocConverter 插件。用于将 PDF 文档转换为 DOC/DOCX 格式。

public sealed class DocConverter

继承

objectDocConverter

继承的成员

示例

该示例演示如何将 PDF 文档转换为 Doc 格式。

// 创建 DocConverter
var plugin = new DocConverter();
// 创建 PdfToDocOptions 对象以设置指令
var opt = new PdfToDocOptions();
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new FileDataSource(outputPath));
// 执行该过程
plugin.Process(opt);

构造函数

DocConverter()

public DocConverter()

方法

Dispose()

IDisposable 的实现。

public void Dispose()

Process(PdfToDocOptions)

使用指定的参数启动 Documentize.DocConverter 处理。

public ResultContainer Process(PdfToDocOptions options)

参数

  • options PdfToDocOptions:包含 Documentize.DocConverter 指令的选项对象。

返回

ResultContainer : 一个包含操作结果的 Documentize.ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 FileResult

信息

以文件的字符串路径形式表示操作结果。

public sealed class FileResult : IOperationResult

继承

objectFileResult

实现

继承的成员

属性

数据

获取原始数据。

public object Data { get; }

属性值

object

IsFile

指示结果是否是输出文件的路径。

public bool IsFile { get; }

属性值

bool

IsStream

指示结果是否是输出流。

public bool IsStream { get; }

属性值

bool

IsString

指示结果是否是文本字符串。

public bool IsString { get; }

属性值

bool

方法

ToFile()

尝试将结果转换为文件。

public string ToFile()

返回

string : 如果结果是文件,则返回表示输出文件路径的字符串;否则返回 null

ToStream()

尝试将结果转换为流对象。

public Stream ToStream()

返回

Stream : 如果结果是流,则返回表示输出数据的流对象;否则返回 null

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 HtmlConverter

信息

表示 Documentize.HtmlConverter 插件。用于将 PDF 文档转换为 HTML 格式,将 HTML 文档转换为 PDF 格式。

public sealed class HtmlConverter : IDisposable

继承

objectHtmlConverter

实现

继承的成员

示例

该示例演示如何将 PDF 转换为 HTML 文档。

// 创建 HtmlConverter
var plugin = new HtmlConverter();
// 创建 PdfToHtmlOptions 对象,将输出数据类型设置为包含嵌入资源的文件
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

该示例演示如何将 HTML 转换为 PDF 文档。

// 创建 HtmlConverter
var plugin = new HtmlConverter();
// 创建 HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

构造函数

HtmlConverter()

public HtmlConverter()

方法

Dispose()

IDisposable 的实现。

public void Dispose()

Process(IPluginOptions)

使用指定参数开始 Documentize.HtmlConverter 处理。

public ResultContainer Process(IPluginOptions options)

参数

  • options IPluginOptions: 一个包含 Documentize.HtmlConverter 指令的选项对象。

返回值

ResultContainer : 一个包含操作结果的 Documentize.ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 HtmlToPdfOptions

信息

表示 Documentize.HtmlConverter 插件的 HTML 到 PDF 转换器选项。

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsHtmlToPdfOptions

实现

继承成员

构造函数

HtmlToPdfOptions()

初始化 Documentize.HtmlToPdfOptions 对象的新实例。

public HtmlToPdfOptions()

属性

BasePath

HTML 文件的基础路径/URL。

public string BasePath { get; set; }

属性值

string

HtmlMediaType

获取或设置渲染过程中使用的可能媒体类型。

public HtmlMediaType HtmlMediaType { get; set; }

属性值

HtmlMediaType

IsRenderToSinglePage

获取或设置是否将所有文档渲染为单一页面。

public bool IsRenderToSinglePage { get; set; }

属性值

bool

PageInfo

获取或设置文档页面信息。

public PageInfo PageInfo { get; set; }

属性值

PageInfo

PageLayoutOption

获取或设置布局选项。

public HtmlPageLayoutOption PageLayoutOption { get; set; }

属性值

HtmlPageLayoutOption

命名空间: Documentize 程序集: Documentize.dll

类 ImageExtractor

信息

表示 Documentize.ImageExtractor 插件。用于从 PDF 文档中提取图像。

public class ImageExtractor : PdfExtractor, IDisposable

继承

objectPdfExtractorImageExtractor

实现

继承的成员

示例

此示例演示如何从 PDF 文档中提取图像。

// 创建 ImageExtractor 对象以提取图像
using (var plugin = new ImageExtractor())
{
    // 创建 ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // 添加输入文件路径
    opt.AddInput(new FileDataSource(inputPath));
    // 设置输出目录
    opt.AddInput(new FileDataSource("D:\\"));

    // 执行提取过程
    var resultContainer = plugin.Process(opt);

    // 从 ResultContainer 对象中获取图像
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

构造函数

ImageExtractor()

public ImageExtractor()

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 ImageExtractorOptions

信息

表示 Documentize.ImageExtractor 插件的图像提取选项。

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions

继承

objectPdfExtractorOptionsImageExtractorOptions

实现

继承成员

备注

它继承了添加表示输入 PDF 文档的数据(文件、流)的功能。

构造函数

ImageExtractorOptions()

初始化 Documentize.ImageExtractorOptions 对象的新实例。

public ImageExtractorOptions()

属性

OperationName

返回操作的名称。

public override string OperationName { get; }

属性值

string

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 JpegConverter

信息

表示 Documentize.JpegConverter 插件。用于将 PDF 文档转换为 JPEG 格式。

public sealed class JpegConverter

继承

objectJpegConverter

继承的成员

示例

该示例演示如何将 PDF 文档转换为 JPEG 格式。

// 创建 JpegConverter
var plugin = new JpegConverter();
// 创建 PdfToJpegOptions 对象以设置指令
var opt = new PdfToJpegOptions();
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new DirectoryDataSource(outputPath));
// 执行处理
plugin.Process(opt);

构造函数

JpegConverter()

public JpegConverter()

方法

Process(PdfToJpegOptions)

使用指定的参数启动 Documentize.JpegConverter 处理。

public ResultContainer Process(PdfToJpegOptions options)

参数

  • options PdfToJpegOptions: 一个包含 Documentize.JpegConverter 指令的选项对象。

返回

ResultContainer : 一个包含操作结果的 ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

类 ObjectResult

信息

表示字符串形式的操作结果.

public sealed class ObjectResult : IOperationResult

继承

objectObjectResult

实现

继承的成员

属性

Data

获取原始数据.

public object Data { get; }

属性值

object

IsFile

指示结果是否是输出文件的路径.

public bool IsFile { get; }

属性值

bool

IsObject

指示结果是否是一个对象.

public bool IsObject { get; }

属性值

bool

IsStream

指示结果是否是输出文件的路径.

public bool IsStream { get; }

属性值

bool

IsString

指示结果是否是字符串.

public bool IsString { get; }

属性值

bool

Text

返回结果的字符串表示.

public string Text { get; }

属性值

string

方法

ToFile()

尝试将结果转换为文件.

public string ToFile()

返回值

string : 如果结果是文件,返回表示输出文件路径的字符串;否则返回 null

ToStream()

尝试将结果转换为流对象.

public Stream ToStream()

返回值

Stream : 如果结果是流,返回表示输出数据的流对象;否则返回 null

ToString()

尝试将结果转换为字符串.

public override string ToString()

返回值

string : 如果结果是字符串,返回表示文本内容的字符串;否则返回 base.ToString().

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 OptimizeOptions

信息

表示 Documentize.Optimizer 插件的优化选项.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsOptimizeOptions

实现

继承的成员

构造函数

OptimizeOptions()

使用默认选项初始化 Documentize.OptimizeOptions 对象的新实例。 线性化文档以便于

  • 尽快打开第一页;
  • 尽快显示下一页或通过链接转到下一页;
  • 当页面的数据通过慢速通道传送时,增量显示页面(首先显示最有用的数据);
  • 允许用户在整个页面尚未接收和显示之前执行用户交互,例如遵循链接。
public OptimizeOptions()

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PageInfo

信息

表示页面信息。

public class PageInfo : PageSize

继承

objectPageSizePageInfo

继承成员

构造函数

PageInfo()

Documentize.PageInfo 的构造函数。

public PageInfo()

PageInfo(double, double)

Documentize.PageInfo 的构造函数。

public PageInfo(double width, double height)

参数

  • width double: 页面的宽度。
  • height double: 页面的高度。

属性

MarginBottom

获取或设置指示底部边距的值。

public double MarginBottom { get; set; }

属性值

double

MarginLeft

获取或设置指示左侧边距的值。

public double MarginLeft { get; set; }

属性值

double

MarginRight

获取或设置指示右侧边距的值。

public double MarginRight { get; set; }

属性值

double

MarginTop

获取或设置指示顶部边距的值。

public double MarginTop { get; set; }

属性值

double

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PageSize

信息

表示 PDF 文档中页面大小的类。

public class PageSize

继承

objectPageSize

派生

继承成员

构造函数

PageSize()

Documentize.PageSize 的构造函数。默认 A4 大小。

public PageSize()

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

法律大小 (356x216 mm)。

public static PageSize PageLegal { get; }

属性值

PageSize

PageLetter

信件大小 (279x216 mm)。

public static PageSize PageLetter { get; }

属性值

PageSize

Width

获取或设置页面宽度。

public double Width { get; set; }

属性值

double

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfAConverter

信息

表示一个处理 PDF 文档转换为 PDF/A 格式及 PDF/A 合规性验证的插件。

public sealed class PdfAConverter

继承

objectPdfAConverter

继承成员

示例

示例演示如何验证 PDF 文档是否符合 PDF/A 格式(此处为 PDF/A-1a):

// 创建选项类以设置验证过程
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// 添加一个或多个要验证的文件
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()

public PdfAConverter()

方法

Process(IPluginOptions)

开始 PDF/A 转换或验证过程,使用给定选项。

public ResultContainer Process(IPluginOptions options)

参数

  • options IPluginOptions: 一个选项对象,包含插件的指令。必须是 Documentize.PdfAConvertOptions 或 Documentize.PdfAValidateOptions 类的实例。

返回值

ResultContainer : 包含处理结果的 Documentize.ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfAConvertOptions

信息

表示使用 Documentize.PdfAConverter 插件将 PDF 文档转换为 PDF/A 格式的选项。

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

继承

objectPdfAOptionsBasePdfAConvertOptions

实现

继承成员

构造函数

PdfAConvertOptions()

public PdfAConvertOptions()

属性

Outputs

获取用于保存操作结果的已添加目标(文件或流数据源)集合。

public List<idatasource> Outputs { get; }

属性值

List<IDataSource&gt;

方法

AddOutput(IDataSource)

添加新的结果保存目标。

public void AddOutput(IDataSource dataSource)

参数

  • dataSource IDataSource: 保存操作结果的目标(文件或流数据源)。 :

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfAOptionsBase

信息

表示 Documentize.PdfAConverter 插件选项的基类。该类提供了配置 PDF/A 转换和验证过程的属性和方法。

表示 Documentize.PdfAConverter 插件选项的基类。 该类提供了配置 PDF/A 转换和验证过程的属性和方法。

public abstract class PdfAOptionsBase : IPluginOptions

继承

objectPdfAOptionsBase

派生

实现

继承的成员

构造函数

PdfAOptionsBase()

protected PdfAOptionsBase()

属性

AlignText

获取或设置一个值,该值指示在 PDF/A 转换过程中是否需要额外的手段来保持文本对齐。

public bool AlignText { get; set; }

属性值

bool

备注

当设置为 true 时,转换过程将尝试恢复原始文本段边界。 对于大多数文档,通常不需要将此属性从默认的 false 值更改,因为在默认转换过程中,文本对齐不会改变。

CheckDifferentNamesInFontDictionaries

获取控制 PDF/A 转换的标志,以处理源 PDF 文档与 PDF 规范不一致的情况。

public bool CheckDifferentNamesInFontDictionaries { get; set; }

属性值

bool

ErrorAction

获取或设置无法转换的对象所采取的操作。

public ConvertErrorAction ErrorAction { get; set; }

属性值

ConvertErrorAction

IccProfileFileName

获取或设置用于 PDF/A 转换的 ICC(国际色彩联盟)配置文件的文件名,替代默认文件名。

public string IccProfileFileName { get; set; }

属性值

string

Inputs

获取数据源集合。

public List<idatasource> Inputs { get; }

属性值

List<IDataSource&gt;

IsLowMemoryMode

获取或设置一个值,该值指示 PDF/A 转换过程中是否启用低内存模式。

public bool IsLowMemoryMode { get; set; }

属性值

bool

LogOutputSource

获取或设置日志输出的数据源。

public IDataSource LogOutputSource { get; set; }

属性值

IDataSource

OptimizeFileSize

获取或设置一个值,该值指示是否应该在 PDF/A 转换过程中尝试减少文件大小。

public bool OptimizeFileSize { get; set; }

属性值

bool

备注

当设置为 true 时,转换过程将尝试最小化生成的文件大小。 这可能会影响转换过程的性能。

PdfAVersion

获取或设置要用于验证或转换的 PDF/A 标准版本。

public PdfAStandardVersion PdfAVersion { get; set; }

属性值

PdfAStandardVersion

备注

PDF/A 标准版本用于确定 PDF/A 验证和转换的合规性水平。 如果版本设置为 Documentize.PdfAStandardVersion.Auto,系统将根据文档元数据自动确定适当的 PDF/A 标准版本进行验证。 对于 PDF/A 转换过程,Documentize.PdfAStandardVersion.Auto 默认使用 PDF/A-1b 标准版本。

SoftMaskAction

获取或设置在转换带有软遮罩的图像时应采取的操作。

public ConvertSoftMaskAction SoftMaskAction { get; set; }

属性值

ConvertSoftMaskAction

方法

AddInput(IDataSource)

将新的数据源添加到集合中。

public void AddInput(IDataSource dataSource)

参数

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfAValidateOptions

信息

表示用于使用 Documentize.PdfAConverter 插件验证 PDF 文档的 PDF/A 合规性选项。

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

继承

objectPdfAOptionsBasePdfAValidateOptions

实现

继承成员

构造函数

PdfAValidateOptions()

public PdfAValidateOptions()

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfAValidationResult

信息

表示 PDF/A 验证过程的结果。

public sealed class PdfAValidationResult  

继承

object
PdfAValidationResult

继承的成员

字段

  • DataSource 获取已验证的数据源。

字段值

IDataSource

IsValid

获取指示验证是否成功的值。

public readonly bool IsValid  

字段值

bool

StandardVersion

获取用于验证的 PDF/A 标准版本。

public readonly PdfAStandardVersion StandardVersion  

字段值

PdFAStandardVersion

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 PdfChatGpt

信息

表示 PdfChatGpt 插件。

public sealed class PdfChatGpt : IDisposable

继承

objectPdfChatGpt

实现

继承的成员

示例

该示例演示如何通过将消息添加到请求来使用 PdfChatGpt 插件。

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 添加输出文件路径。
    options.ApiKey = "您的 API 密钥。"; // 您需要提供访问 API 的密钥。
    options.MaxTokens = 1000; // 在聊天完成中生成的最大令牌数。

    // 添加请求消息。
    options.Messages.Add(new Message
    {
        Content = "您是一个有帮助的助手。",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "有史以来制作的最大比萨饼直径是多少?",
        Role = Role.User
    });

    // 处理请求。
    var result = await 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")); // 添加输出文件路径。
    options.ApiKey = "您的 API 密钥。"; // 您需要提供访问 API 的密钥。
    options.MaxTokens = 1000; // 在聊天完成中生成的最大令牌数。

    // 添加请求消息。
    // 在这种情况下,系统消息 Content = "您是一个有帮助的助手。" 默认添加。
    // 查询消息的角色默认为 "user"。
    options.Query = "地球上记录的最低温度是多少?";

    // 处理请求。
    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 文本源。
    // 若有多个源,则每个文档的文本将作为角色为 "user" 的单独消息添加到请求消息集合中。
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "您的 API 密钥。"; // 您需要提供访问 API 的密钥。
    options.MaxTokens = 1000; // 在聊天完成中生成的最大令牌数。

    // 添加请求消息。
    // 在这种情况下,系统消息 Content = "您是一个有帮助的助手。" 默认添加。
    // 查询消息的角色默认为 "user"。
    options.Query = "提供的文本中有多少个字母?";

    // 处理请求。
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT API 聊天完成对象。
}

备注

Documentize.PdfChatGpt 对象用于直接发送请求到 ChatGPT 或通过添加 PDF 文件源并将回复保存到输出源。

构造函数

PdfChatGpt()

初始化一个 Documentize.PdfChatGpt 对象的新实例。

public PdfChatGpt()

方法

Dispose()

IDisposable 的实现。实际上,对于 PdfChatGpt 来说并不是必需的。

public void Dispose()

Process(IPluginOptions)

该方法没有同步版本。请改用 ProcessAsync 方法。

public ResultContainer Process(IPluginOptions options)

参数

返回

ResultContainer : #### 异常

NotImplementedException

ProcessAsync(IPluginOptions)

以指定的参数启动 PdfChatGpt 处理。

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

参数

返回

Task<ResultContainer&gt;

表示异步操作的任务对象。

异常

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

设置取消令牌。

public void SetCancellationToken(CancellationToken cancellationToken)

参数

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfChatGptOptions

信息

表示 Documentize.PdfChatGpt 插件的选项。

public class PdfChatGptOptions : IPluginOptions  

继承

object
PdfChatGptOptions

派生

实现

继承成员

构造函数

PdfChatGptOptions()

初始化 Documentize.PdfChatGptOptions 对象的新实例。

public PdfChatGptOptions()  

属性

输入

public List<idatasource> Inputs { get; }  

属性值

List<IDataSource&gt;

输出

public List<idatasource> Outputs { get; }  

属性值

List<IDataSource&gt;

方法

AddInput(IDataSource)

向 PdfChatGpt 插件数据集合添加新的数据源。

public void AddInput(IDataSource dataSource)  

参数

  • dataSource IDataSource: 要添加的数据源(文件或流)。

AddOutput(IDataSource)

向 PdfChatGpt 插件数据集合添加新的保存数据源。

public void AddOutput(IDataSource saveDataSource)  

参数

  • saveDataSource IDataSource: 用于保存操作结果的数据源(文件或流)。

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 PdfChatGptRequestOptions

信息

表示 Documentize.PdfChatGpt 插件的选项。

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

继承

objectPdfChatGptOptionsPdfChatGptRequestOptions

实现

继承成员

构造函数

PdfChatGptRequestOptions()

用默认选项初始化 Documentize.PdfChatGptRequestOptions 对象的新实例。

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

用选项初始化 Documentize.PdfChatGptRequestOptions 对象的新实例。

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

参数

属性

ApiKey

获取或设置用于访问 ChatGPT API 的密钥。

public string ApiKey { get; set; }

属性值

string

ApiUrl

获取或设置 ChatGPT API 的 URL。

public string ApiUrl { get; set; }

属性值

string

MaxTokens

响应中的最大令牌数。 默认值为 null,表示无限。

public int? MaxTokens { get; set; }

属性值

int?

Messages

获取或设置 Documentize.Message 对象的集合。

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

属性值

List<Message&gt;

Model

设置或获取要使用的模型 ID。

public string Model { get; set; }

属性值

string

NumberOfChoices

为每个输入消息生成多少个聊天完成选项。

public int NumberOfChoices { get; set; }

属性值

int

Query

获取或设置请求 ChatGPT 的字符串。 如果不为空,这是请求中将发送的集合中的第一条消息。

public string Query { get; set; }

属性值

string

Temperature

使用的采样温度,介于 0 和 2 之间。 较高的值如 0.8 会使输出更加随机, 而较低的值如 0.2 会使其更集中且确定。 默认值为 1。

public double Temperature { get; set; }

属性值

double

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfConverterOptions

信息

表示 Pdf 转换器插件的选项。

public abstract class PdfConverterOptions : IPluginOptions

继承

objectPdfConverterOptions

派生

实现

继承成员

属性

输入

返回 PdfConverterOptions 插件数据集合。

public List<idatasource> Inputs { get; }

属性值

List<IDataSource&gt;

输出

获取用于保存操作结果的添加目标的集合。

public List<idatasource> Outputs { get; }

属性值

List<IDataSource&gt;

方法

AddInput(IDataSource)

将新的数据源添加到 PdfConverter 插件数据集合中。

public void AddInput(IDataSource dataSource)

参数

AddOutput(IDataSource)

将新的数据源添加到 PdfToXLSXConverterOptions 插件数据集合中。

public void AddOutput(IDataSource saveDataSource)

参数

  • saveDataSource IDataSource: 用于保存操作结果的数据源(文件或流)。

异常

NotImplementedException

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfExtractor

信息

表示提取文本、图像和可能出现在PDF文档页面上的其他类型内容的基本功能。

public abstract class PdfExtractor : IDisposable

继承

objectPdfExtractor

派生

实现

继承成员

示例

该示例演示如何提取PDF文档的文本内容。

// 创建TextExtractor对象以提取PDF内容
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用于提取图像。

构造函数

PdfExtractor()

protected PdfExtractor()

方法

Dispose()

IDisposable的实现。实际上,对于PdfExtractor来说不是必须的。

public void Dispose()

Process(IPluginOptions)

使用指定参数开始PdfExtractor处理。

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

参数

  • pdfExtractorOptions IPluginOptions: 一个包含PdfExtractor指令的选项对象。

返回

ResultContainer : 一个包含提取结果的ResultContainer对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfExtractorOptions

信息

表示 TextExtractor 和 ImageExtractor 插件的选项。

public abstract class PdfExtractorOptions : IPluginOptions

继承

objectPdfExtractorOptions

派生

实现

继承成员

备注

Documentize.PdfExtractorOptions 包含添加表示输入 PDF 文档的数据(文件、流)的基本功能。 请创建 Documentize.TextExtractorOptions 或 ImageExtractorOptions,而不是这个。

属性

输入

返回 PdfExtractor 插件数据集合。

public List<idatasource> Inputs { get; }

属性值

List<IDataSource&gt;

操作名称

返回操作名称

public virtual string OperationName { get; }

属性值

string

方法

AddInput(IDataSource)

将新的数据源添加到 PdfExtractor 插件数据集合。

public void AddInput(IDataSource dataSource)

参数

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfToDocOptions

信息

表示 Documentize.DocConverter 插件的 PDF 转 DOC 转换器选项.

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

继承

objectPdfConverterOptionsPdfToDocOptions

实现

继承成员

构造函数

PdfToDocOptions()

使用默认选项初始化 Documentize.PdfToDocOptions 对象的新实例.

public PdfToDocOptions()

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfToHtmlOptions

信息

表示 Documentize.HtmlConverter 插件的 PDF 到 HTML 转换选项。

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions  

继承

object
PdfConverterOptions
PdfToHtmlOptions

实现

继承成员

构造函数

PdfToHtmlOptions()

使用默认选项初始化 Documentize.PdfToHtmlOptions 对象的新实例。

public PdfToHtmlOptions()  

PdfToHtmlOptions(SaveDataType)

为指定的输出数据类型初始化 Documentize.PdfToHtmlOptions 对象的新实例。

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)  

参数

属性

OutputDataType

获取输出数据类型。

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }  

属性值

PdfToHtmlOptions.SaveDataType

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 PdfToJpegOptions

信息

表示 Documentize.JpegConverter 插件的 PDF 到 JPEG 转换器选项。

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions  

继承

object
PluginBaseOptions
PdfToJpegOptions

实现

继承的成员

构造函数

PdfToJpegOptions()

初始化 Documentize.PdfToJpegOptions 对象的新实例。

public PdfToJpegOptions()  

属性

OutputResolution

获取或设置生成图像的分辨率值。

public int OutputResolution { get; set; }  

属性值

int

PageList

获取或设置用于处理的页面列表。

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

属性值

List<int>

Quality

获取和设置输出质量。

public int Quality { get; set; }  

属性值

int

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 PdfToPngOptions

信息

表示 Documentize.PngConverter 插件的 PDF 到 PNG 转换器选项。

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsPdfToPngOptions

实现

继承成员

构造函数

PdfToPngOptions()

初始化 Documentize.PdfToPngOptions 对象的新实例。

public PdfToPngOptions()

属性

OutputResolution

获取或设置生成图像的分辨率值。

public int OutputResolution { get; set; }

属性值

int

PageList

获取或设置处理的页面列表。

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

属性值

List<int&gt;

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfToTiffOptions

信息

表示 Documentize.TiffConverter 插件的 PDF 到 TIFF 转换器选项.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsPdfToTiffOptions

实现

继承成员

构造函数

PdfToTiffOptions()

初始化 Documentize.PdfToTiffOptions 对象的新实例。

public PdfToTiffOptions()

属性

MultiPage

获取或设置允许将所有页面保存为一个多页 TIFF 的标志。

public bool MultiPage { get; set; }

属性值

bool

OutputResolution

获取或设置生成图像的分辨率值。

public int OutputResolution { get; set; }

属性值

int

PageList

获取或设置处理的页面列表。

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

属性值

List<int&gt;

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PdfToXlsOptions

信息

表示 Documentize.XlsConverter 插件的 PDF 到 XLSX 转换器选项。

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

继承

objectPdfConverterOptionsPdfToXlsOptions

实现

继承成员

构造函数

PdfToXlsOptions()

使用默认选项初始化 Documentize.PdfToXlsOptions 对象的新实例。

public PdfToXlsOptions()

属性

Format

输出格式。

public PdfToXlsOptions.ExcelFormat Format { get; set; }

属性值

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

如果需要将空白列插入为工作表的第一列,则设置为 true。默认值为 false;这意味着不会插入空白列。

public bool InsertBlankColumnAtFirst { get; set; }

属性值

bool

MinimizeTheNumberOfWorksheets

如果需要最小化结果工作簿中的工作表数量,则设置为 true。默认值为 false;这意味着将每个 PDF 页面保存为单独的工作表。

public bool MinimizeTheNumberOfWorksheets { get; set; }

属性值

bool

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 PluginBaseOptions

信息

表示插件的基本选项。

public class PluginBaseOptions : IPluginOptions  

继承

object
PluginBaseOptions

派生

实现

继承成员

属性

CloseInputStreams

在操作完成后关闭输入流。

public bool CloseInputStreams { get; set; }  

属性值

bool

CloseOutputStreams

在操作完成后关闭输出流。

public bool CloseOutputStreams { get; set; }  

属性值

bool

Inputs

返回操作的输入数据。

public List<idatasource> Inputs { get; }  

属性值

List<IDataSource&gt;

Outputs

返回操作的输出数据。

public List<idatasource> Outputs { get; }  

属性值

List<IDataSource&gt;

方法

AddInput(IDataSource)

向输入添加新数据。

public void AddInput(IDataSource dataSource)  

参数

AddOutput(IDataSource)

向输出添加新数据。

public void AddOutput(IDataSource saveDataSource)  

参数

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 PngConverter

信息

表示 Documentize.PngConverter 插件。用于将 PDF 文档转换为 PNG 格式。

public sealed class PngConverter

继承

objectPngConverter

继承的成员

示例

该示例演示如何将 PDF 文档转换为 PNG 格式。

// 创建 PngConverter
var plugin = new PngConverter();
// 创建 PdfToPngOptions 对象以设置指令
var opt = new PdfToPngOptions();
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new DirectoryDataSource(outputPath));
// 执行处理
plugin.Process(opt);

构造函数

PngConverter()

public PngConverter()

方法

Process(PdfToPngOptions)

使用指定的参数开始 Documentize.PngConverter 处理。

public ResultContainer Process(PdfToPngOptions options)

参数

  • options PdfToPngOptions: 一个包含 Documentize.PngConverter 指令的选项对象。

返回

ResultContainer : 一个包含操作结果的 ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 ResizeOptions

信息

表示 Documentize.Optimizer 插件的缩放选项。

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsResizeOptions

实现

继承的成员

构造函数

ResizeOptions()

使用默认选项初始化 Documentize.ResizeOptions 对象的新实例。

public ResizeOptions()

属性

PageSize

获取或设置新的页面大小。

public PageSize PageSize { get; set; }

属性值

PageSize

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 ResultContainer

信息

表示包含插件处理结果集合的容器。

public class ResultContainer  

继承

object
ResultContainer

继承的成员

属性

ResultCollection

获取操作结果的集合

public List<ioperationresult> ResultCollection { get; }  

属性值

List<IOperationResult&gt;

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类 RotateOptions

信息

表示 Documentize.Optimizer 插件的旋转选项。

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsRotateOptions

实现

继承成员

构造函数

RotateOptions()

使用默认选项初始化 Documentize.RotateOptions 对象的新实例。

public RotateOptions()

属性

Rotation

获取或设置新页面的旋转。

public Rotation Rotation { get; set; }

属性值

Rotation

命名空间: Documentize 程序集: Documentize.dll

类 SignOptions

信息

表示 Documentize.Signature 插件的签名选项。

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsSignOptions

实现

继承成员

构造函数

SignOptions(string, string)

使用默认选项初始化 Documentize.SignOptions 对象的新实例。

public SignOptions(string pfx, string password)

参数

  • pfx string: pfx 文件的路径。
  • password string: pfx 文件的密码。

SignOptions(Stream, string)

使用默认选项初始化 Documentize.SignOptions 对象的新实例。

public SignOptions(Stream pfx, string password)

参数

  • pfx Stream: 包含 pfx 文件的流。
  • password string: pfx 文件的密码。

属性

Contact

签名的联系人。

public string Contact { get; set; }

属性值

string

Location

签名的位置。

public string Location { get; set; }

属性值

string

Name

现有签名字段的名称。 为空以创建一个新字段。

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

命名空间: Documentize 程序集: Documentize.dll

类 StreamDataSource

信息

表示用于插件的加载和保存操作的流数据源。

public sealed class StreamDataSource : IDataSource

继承

objectStreamDataSource

实现

继承成员

构造函数

StreamDataSource(Stream)

使用指定的流对象初始化新的流数据源。

public StreamDataSource(Stream data)

参数

属性

Data

获取当前数据源的流对象。

public Stream Data { get; }

属性值

Stream

DataType

数据源的类型(流)。

public DataType DataType { get; }

属性值

DataType

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 StreamResult

信息

以流的形式表示操作结果。

public sealed class StreamResult : IOperationResult

继承

objectStreamResult

实现

继承成员

属性

Data

获取原始数据。

public object Data { get; }

属性值

object

IsFile

指示结果是否为输出文件的路径。

public bool IsFile { get; }

属性值

bool

IsStream

指示结果是否为输出文件的路径。

public bool IsStream { get; }

属性值

bool

IsString

指示结果是否为字符串。

public bool IsString { get; }

属性值

bool

方法

ToFile()

尝试将结果转换为文件。

public string ToFile()

返回

string : 如果结果是文件,则返回表示输出文件路径的字符串;否则返回 null

ToStream()

尝试将结果转换为流对象。

public Stream ToStream()

返回

Stream : 如果结果是流,则返回表示输出数据的流对象;否则返回 null

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 StringResult

信息

表示以字符串形式的操作结果。

public sealed class StringResult : IOperationResult

继承

objectStringResult

实现

继承成员

属性

数据

获取原始数据。

public object Data { get; }

属性值

object

IsFile

指示结果是否是输出文件的路径。

public bool IsFile { get; }

属性值

bool

IsStream

指示结果是否是输出文件的路径。

public bool IsStream { get; }

属性值

bool

IsString

指示结果是否是字符串。

public bool IsString { get; }

属性值

bool

文本

返回结果的字符串表示。

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

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 TableCellBuilder

信息

类表示表格单元的构建器。

public class TableCellBuilder : TableRowBuilder

继承

objectTableBuilderTableRowBuilderTableCellBuilder

继承成员

方法

AddCell()

向表格添加单元格。

public override TableCellBuilder AddCell()

返回

TableCellBuilder : 当前 Documentize.TableCellBuilder 的实例。

AddParagraph(params string[])

向表格单元添加段落。

public TableCellBuilder AddParagraph(params string[] paragraphs)

参数

  • paragraphs string[]: 段落的文本。

返回

TableCellBuilder : 当前 Documentize.TableCellBuilder 的实例。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 TableRowBuilder

信息

类表示表行构建器.

public class TableRowBuilder : TableBuilder

继承关系

objectTableBuilderTableRowBuilder

派生

继承成员

方法

AddCell()

向表行添加单元格.

public virtual TableCellBuilder AddCell()

返回值

TableCellBuilder : 创建的 Documentize.TableCellBuilder 的实例.

AddRow()

重写 AddRow.

public override TableRowBuilder AddRow()

返回值

TableRowBuilder : 当前 Documentize.TableRowBuilder 的实例.

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 TextExtractor

信息

表示 Documentize.TextExtractor 插件。用于从 PDF 文档中提取文本。

public class TextExtractor : PdfExtractor, IDisposable

继承

objectPdfExtractorTextExtractor

实现

继承成员

示例

这个示例演示了如何提取 PDF 文档的文本内容。

// 创建 TextExtractor 对象以提取 PDF 内容中的文本
using (var plugin = new TextExtractor())
{
    // 创建 TextExtractorOptions
    var opt = new TextExtractorOptions();

    // 添加输入文件路径
    opt.AddInput(new FileDataSource(inputPath));

    // 执行提取过程
    var resultContainer = plugin.Process(opt);

    // 从 ResultContainer 对象获取提取的文本
    var textExtracted = resultContainer.ResultCollection[0].ToString();
}

构造函数

TextExtractor()

public TextExtractor()

命名空间: Documentize 程序集: Documentize.dll

类 TextExtractorOptions

信息

表示 Documentize.TextExtractor 插件的文本提取选项。

public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions

继承

objectPdfExtractorOptionsTextExtractorOptions

实现

继承成员

示例

该示例演示如何提取 PDF 文档的文本内容。

// 创建 TextExtractor 对象以提取 PDF 内容
using (TextExtractor extractor = new TextExtractor())
{
    // 创建 TextExtractorOptions 对象以设置 TextFormattingMode(Pure 或 Raw - 默认)
    extractorOptions = new TextExtractorOptions(TextExtractorOptions.TextFormattingMode.Pure);

    // 将输入文件路径添加到数据源
    extractorOptions.AddInput(new FileDataSource(inputPath));

    // 执行提取过程
    ResultContainer resultContainer = extractor.Process(extractorOptions);

    // 从 ResultContainer 对象中获取提取的文本
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

备注

Documentize.TextExtractorOptions 对象用于设置 Documentize.TextExtractorOptions.TextFormattingMode 和其他文本提取操作的选项。 此外,它继承了添加数据(文件、流)以表示输入 PDF 文档的功能。

构造函数

TextExtractorOptions(TextFormattingMode)

初始化 Documentize.TextExtractorOptions 对象的新实例,指定文本格式模式。

public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)

参数

TextExtractorOptions()

使用 ‘Raw’(默认)文本格式模式初始化 Documentize.TextExtractorOptions 对象的新实例。

public TextExtractorOptions()

属性

FormattingMode

获取格式模式。

public TextExtractorOptions.TextFormattingMode FormattingMode { get; }

属性值

TextExtractorOptions.TextFormattingMode

OperationName

返回操作的名称。

public override string OperationName { get; }

属性值

string

命名空间: Documentize 程序集: Documentize.dll

类 TiffConverter

信息

表示 Documentize.TiffConverter 插件。用于将 PDF 文档转换为 TIFF 格式。

public sealed class TiffConverter

继承

objectTiffConverter

继承的成员

示例

该示例演示如何将 PDF 文档转换为 TIFF 格式。

// 创建 TiffConverter
var plugin = new TiffConverter();
// 创建 PdfToTiffOptions 对象以设置指令
var opt = new PdfToTiffOptions();
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new DirectoryDataSource(outputPath));
// 执行处理
plugin.Process(opt);

构造函数

TiffConverter()

public TiffConverter()

方法

Process(PdfToTiffOptions)

使用指定的参数开始 Documentize.TiffConverter 的处理。

public ResultContainer Process(PdfToTiffOptions options)

参数

  • options PdfToTiffOptions: 一个选项对象,包含 Documentize.TiffConverter 的指令。

返回

ResultContainer : 一个包含操作结果的 ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 XlsConverter

信息

表示 Documentize.XlsConverter 插件。用于将 PDF 文档转换为 XLSX/XLS 格式。

public sealed class XlsConverter

继承

objectXlsConverter

继承的成员

示例

该示例演示了如何将 PDF 转换为 XLSX 文档。

// 创建 XlsConverter
var plugin = new XlsConverter();
// 创建 PdfToXlsOptions 
var opt = new PdfToXlsOptions();
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new FileDataSource(outputPath));
// 执行处理
plugin.Process(opt);

构造函数

XlsConverter()

public XlsConverter()

方法

Process(PdfToXlsOptions)

使用指定的参数启动 Documentize.XlsConverter 处理。

public ResultContainer Process(PdfToXlsOptions options)

参数

返回

ResultContainer : 一个包含操作结果的 Documentize.ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

类 表格构建器

信息

类表示 PDF 页面中的表格构建器。

public class TableBuilder

继承

objectTableBuilder

派生

继承成员

方法

AddRow()

向表中添加新行。

public virtual TableRowBuilder AddRow()

返回

TableRowBuilder : 当前 Documentize.TableRowBuilder 的实例。

AddTable()

向文档中添加新表。

public TableBuilder AddTable()

返回

TableBuilder : 当前 Documentize.TableBuilder 的实例。

InsertPageAfter(int)

在指定页面后插入页面。

public TableOptions InsertPageAfter(int page)

参数

  • page int: 要在其后插入表格的页面号码。

返回

TableOptions : 当前 Documentize.TableOptions 的实例。

InsertPageBefore(int)

在指定页面前插入页面。

public TableOptions InsertPageBefore(int page)

参数

  • page int: 要在其后插入表格的页面号码。

返回

TableOptions : 当前 Documentize.TableOptions 的实例。

运算符

implicit operator TableOptions(TableBuilder)

将构建器 Documentize.TableBuilder 转换为选项 Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)

参数

  • builder TableBuilder: 当前 Documentize.TableBuilder 的实例。

返回

TableOptions : 转换为 PdfGeneratorTableOptions 的结果。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 表格生成器

信息

表示 Documentize.TableGenerator 插件。用于向 PDF 文档添加表格。

public sealed class TableGenerator

继承关系

objectTableGenerator

继承成员

示例

该示例演示如何向 PDF 文件添加表格。

// 创建 TableGenerator
var plugin = new TableGenerator();
// 创建 TableOptions 对象以设置指令
TableOptions opt = 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");
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath1));
// 设置输出文件路径
opt.AddOutput(new FileDataSource(outputPath));
// 执行处理
plugin.Process(opt);

构造函数

TableGenerator()

public TableGenerator()

方法

Process(TableOptions)

使用指定的参数开始 Documentize.TableGenerator 处理。

public ResultContainer Process(TableOptions options)

参数

  • options TableOptions: 包含 Documentize.TableGenerator 指令的选项对象。

返回值

ResultContainer : 包含操作结果的 ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 表格选项

信息

表示通过 Documentize.TableGenerator 插件将表格添加到文档的选项。

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsTableOptions

实现

继承成员

构造函数

TableOptions()

使用默认选项初始化 Documentize.TableOptions 对象的新实例。

public TableOptions()

方法

AddTable()

将表添加到文档。

public TableBuilder AddTable()

返回

TableBuilder : Documentize.TableBuilder 的新实例。

Create()

创建 Documentize.TableOptions 的实例。

public static TableOptions Create()

返回

TableOptions : Documentize.TableOptions 的新实例。

InsertPageAfter(int)

在指定页面后插入页面。

public TableOptions InsertPageAfter(int page)

参数

  • page int: 插入表后要插入的页面编号。

返回

TableOptions : 当前 Documentize.TableOptions 的实例。

InsertPageBefore(int)

在指定页面前插入页面。

public TableOptions InsertPageBefore(int page)

参数

  • page int: 插入表前要插入的页面编号。

返回

TableOptions : 当前 Documentize.TableOptions 的实例。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 加密选项

信息

表示 Documentize.Security 插件的加密选项。

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsEncryptionOptions

实现

继承的成员

构造函数

EncryptionOptions(string, string)

使用默认选项初始化 Documentize.EncryptionOptions 对象的新实例。

public EncryptionOptions(string ownerPassword, string userPassword)

参数

  • ownerPassword string: 拥有者密码。
  • userPassword string: 用户密码。

属性

OwnerPassword

拥有者密码。

public string OwnerPassword { get; set; }

属性值

string

UserPassword

用户密码。

public string UserPassword { get; set; }

属性值

string

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类 矩形

信息

类表示矩形。

public class Rectangle

继承

objectRectangle

继承成员

构造函数

Rectangle(double, double, double, double)

矩形的构造函数。

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

参数

  • llx double: 左下角的X坐标。
  • lly double: 左下角的Y坐标。
  • urx double: 右上角的X坐标。
  • ury double: 右上角的Y坐标。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类安全

信息

表示 Documentize.Security 插件。

public sealed class Security  

继承

object
Security

继承成员

示例

该示例演示如何加密 PDF 文档。

// 创建 Security  
var plugin = new Security();  
// 创建 EncryptionOptions 对象以设置指令  
var opt = new EncryptionOptions("123456", "qwerty");  
// 添加输入文件路径  
opt.AddInput(new FileDataSource(inputPath));  
// 设置输出文件路径  
opt.AddOutput(new FileDataSource(outputPath));  
// 执行处理  
plugin.Process(opt);  

该示例演示如何解密 PDF 文档。

// 创建 Security  
var plugin = new Security();  
// 创建 DecryptionOptions 对象以设置指令  
var opt = new DecryptionOptions("123456"));  
// 添加输入文件路径  
opt.AddInput(new FileDataSource(inputPath));  
// 设置输出文件路径  
opt.AddOutput(new FileDataSource(outputPath));  
// 执行处理  
plugin.Process(opt);  

构造函数

Security()

public Security()  

方法

Process(IPluginOptions)

使用指定的参数开始 Documentize.Security 处理。

public ResultContainer Process(IPluginOptions options)  

参数

  • options IPluginOptions: 包含 Documentize.Security 指令的选项对象。

返回

ResultContainer : 包含操作结果的 ResultContainer 对象。

异常

InvalidOperationException

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类别 分割选项

信息

表示 Documentize.Splitter 插件的分割选项。

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

继承

objectPluginBaseOptionsSplitOptions

实现

继承成员

构造函数

SplitOptions()

使用默认选项初始化 Documentize.SplitOptions 对象的新实例。

public SplitOptions()

命名空间: Documentize 程序集: Documentize.dll

类别消息

信息

由模型生成的聊天完成消息。

public class Message  

继承

object
Message

继承成员

构造函数

Message()

public Message()  

属性

内容

消息的内容。

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

属性值

string

角色

设置或获取此消息作者的角色。

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

属性值

Role

命名空间: Documentize
程序集: Documentize.dll

类拆分器

信息

表示 Documentize.Splitter 插件。用于将文档拆分成单独的页面。

public class Splitter  

继承

object
Splitter

继承成员

示例

示例演示如何拆分 PDF 文档。

// 创建 Splitter  
var plugin = new Splitter();  
// 创建 SplitOptions 对象以设置指令  
var opt = new SplitOptions();  
// 添加输入文件路径  
opt.AddInput(new FileDataSource(inputPath));  
// 设置输出文件路径  
opt.AddOutput(new FileDataSource(outputPath1));  
opt.AddOutput(new FileDataSource(outputPath2));  
// 执行处理  
plugin.Process(opt);  

构造函数

Splitter()

public Splitter()  

方法

Process(IPluginOptions)

使用指定的参数开始 Documentize.Splitter 处理。

public ResultContainer Process(IPluginOptions options)  

参数

  • options IPluginOptions: 一个选项对象,包含对 Documentize.Splitter 的指令。

返回

ResultContainer : 一个 ResultContainer 对象,包含操作的结果。

异常

InvalidOperationException

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类合并

信息

表示 Documentize.Merger 插件。用于将多个 PDF 文档合并为一个 PDF。

public sealed class Merger

继承

objectMerger

继承成员

示例

示例演示如何合并两个 PDF 文档。

// 创建 Merger
var plugin = new Merger();
// 创建 MergeOptions 对象以设置指令
var opt = new MergeOptions();
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath1));
opt.AddInput(new FileDataSource(inputPath2));
// 设置输出文件路径
opt.AddOutput(new FileDataSource(outputPath));
// 执行处理
plugin.Process(opt);

构造函数

Merger()

public Merger()

方法

Process(MergeOptions)

使用指定的参数开始 Documentize.Merger 处理。

public ResultContainer Process(MergeOptions options)

参数

  • options MergeOptions: 一个包含操作指令的选项对象。

返回

ResultContainer : 一个包含操作结果的 Documentize.ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类合并选项

信息

表示 Documentize.Merger 插件的合并选项。

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions  

继承

object
PluginBaseOptions
MergeOptions

实现

继承的成员

构造函数

MergeOptions()

初始化 Documentize.MergeOptions 对象的新实例,使用默认选项。

public MergeOptions()  

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类目录数据源

信息

表示插件的加载和保存操作的目录数据。

public sealed class DirectoryDataSource : IDataSource

继承

objectDirectoryDataSource

实现

继承成员

构造函数

DirectoryDataSource(string)

使用指定路径初始化新的目录数据。

public DirectoryDataSource(string path)

参数

  • path string: 表示目录路径的字符串。

属性

DataType

数据源的类型。

public DataType DataType { get; }

属性值

DataType

Path

获取当前数据的目录路径。

public string Path { get; }

属性值

string

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类签名

信息

表示 Documentize.Signature 插件。

public sealed class Signature

继承

objectSignature

继承的成员

示例

该示例演示如何签署 PDF 文档。

// 创建签名
var plugin = new Signature();
// 创建 SignOptions 对象以设置指令
var opt = new SignOptions(inputPfx, inputPfxPassword);
// 添加输入文件路径
opt.AddInput(new FileDataSource(inputPath));
// 设置输出文件路径
opt.AddOutput(new FileDataSource(outputPath));
// 执行处理
plugin.Process(opt);

构造函数

Signature()

public Signature()

方法

Process(IPluginOptions)

使用指定的参数开始 Documentize.Signature 处理。

public ResultContainer Process(IPluginOptions options)

参数

  • options IPluginOptions: 一个包含 Documentize.Signature 指令的选项对象。

返回

ResultContainer : 一个包含操作结果的 ResultContainer 对象。

异常

InvalidOperationException

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类时间戳

信息

表示 Documentize.Timestamp 插件。

public class Timestamp

继承关系

objectTimestamp

继承成员

示例

该示例演示如何将时间戳添加到文档。

// 创建时间戳
var plugin = new Timestamp();
// 创建 AddTimestampOptions 对象设置指令
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// 添加输入文件路径
opt.AddInput(new FileDataSource("path_to_pdf"));
// 设置输出文件路径
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// 执行处理
plugin.Process(opt);

构造函数

Timestamp()

public Timestamp()

方法

Process(AddTimestampOptions)

使用指定的参数开始 Documentize.Timestamp 处理。

public ResultContainer Process(AddTimestampOptions options)

参数

  • options AddTimestampOptions: 一个包含 Documentize.AddTimestampOptions 指令的选项对象。

返回

ResultContainer : 一个包含操作结果的 ResultContainer 对象。

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

类文件数据源

信息

表示插件的加载和保存操作的文件数据。

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

命名空间: Documentize
程序集: Documentize.dll

类许可证

信息

提供设置许可证的方法。

public static class License  

继承

object
License

继承的成员

示例

显示如何激活许可证。

// 设置许可证  
License.Set("PathToLicense.lic");  

方法

Set(string)

为组件授权。

public static void Set(string licenseName)  

参数

  • licenseName string: 可以是完整或简短的文件名。使用空字符串切换到评估模式。

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

类优化器

信息

表示 Documentize.Optimizer 插件。

public sealed class Optimizer  

继承

object
Optimizer

继承成员

示例

该示例演示如何优化 PDF 文档。

// 创建 Optimizer  
var plugin = new Optimizer();  
// 创建 OptimizeOptions 对象来设置指令  
var opt = new OptimizeOptions();  
// 添加输入文件路径  
opt.AddInput(new FileDataSource(inputPath));  
// 设置输出文件路径  
opt.AddOutput(new FileDataSource(outputPath));  
// 执行处理  
plugin.Process(opt);  

构造函数

Optimizer()

public Optimizer()  

方法

Process(OptimizeOptions)

使用指定的参数开始 Documentize.Optimizer 处理。

public ResultContainer Process(OptimizeOptions options)  

参数

  • options OptimizeOptions:包含 Documentize.OptimizeOptions 指令的选项对象。

返回

ResultContainer : 包含操作结果的 ResultContainer 对象。

Process(RotateOptions)

使用指定的参数开始 Documentize.Optimizer 处理。

public ResultContainer Process(RotateOptions options)  

参数

  • options RotateOptions:包含 Documentize.RotateOptions 指令的选项对象。

返回

ResultContainer : 包含操作结果的 ResultContainer 对象。

Process(ResizeOptions)

使用指定的参数开始 Documentize.Optimizer 处理。

public ResultContainer Process(ResizeOptions options)  

参数

  • options ResizeOptions:包含 Documentize.ResizeOptions 指令的选项对象。

返回

ResultContainer : 包含操作结果的 ResultContainer 对象。

Process(CompressOptions)

使用指定的参数开始 Documentize.Optimizer 处理。

public ResultContainer Process(CompressOptions options)  

参数

  • options CompressOptions:包含 Documentize.CompressOptions 指令的选项对象。

返回

ResultContainer : 包含操作结果的 ResultContainer 对象。

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

枚举 ConvertErrorAction

信息

该类表示转换错误的操作.

public enum ConvertErrorAction

字段

  • Delete = 0
  • None = 1

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

枚举 ConvertSoftMaskAction

信息

此操作表示用于软遮罩图像转换的操作。

public enum ConvertSoftMaskAction

字段

  • ConvertToStencilMask = 1: 软遮罩将被转换为模板遮罩。
  • Default = 0: 使用默认策略。

命名空间: Documentize 程序集: Documentize.dll

枚举 HtmlMediaType

信息

指定渲染过程中可能使用的媒体类型。

public enum HtmlMediaType  

字段

  • Print = 0: 打印。
  • Screen = 1: 屏幕。

命名空间: Documentize
程序集: Documentize.dll

枚举 HtmlPageLayoutOption

信息

指定标志,这些标志与其他选项共同决定页面的大小和布局。

public enum HtmlPageLayoutOption

字段

  • FitToWidestContentWidth = 3: 表示页面的宽度是由内容的大小决定的,而不是由指定的页面宽度决定的。
  • None = 0: 默认值,表示 HtmlPageLayoutOption 不会影响页面的大小和布局。
  • ScaleToPageWidth = 256: 表示文档的内容将被缩放以适应页面。

命名空间: Documentize 程序集: Documentize.dll

枚举 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 标准版本。

命名空间: Documentize
程序集: Documentize.dll

枚举 PdfToXlsOptions.ExcelFormat

信息

允许指定 .xlsx、.xls/xml 或 csv 文件格式。默认值是 XLSX。

允许指定 .xlsx、.xls/xml 或 csv 文件格式。 默认值是 XLSX。

public enum PdfToXlsOptions.ExcelFormat

Fields

  • CSV = 2: 逗号分隔值(CSV)文件格式。
  • ODS = 4: 开放文档电子表格。
  • XLSM = 3: 启用宏的 Office Open XML (.xlsm) 文件格式。
  • XLSX = 1: Office Open XML (.xlsx) 文件格式。
  • XMLSpreadSheet2003 = 0: Excel 2003 XML (.xls) 文件格式。

命名空间: Documentize 程序集: Documentize.dll

枚举 TextExtractorOptions.TextFormattingMode

信息

定义在将 PDF 文档转换为文本时可以使用的不同模式。请参见 Documentize.TextExtractorOptions 类。

public enum TextExtractorOptions.TextFormattingMode  

Fields

  • Plain = 2: 表示 PDF 文本内容,考虑文本片段的相对位置,但不添加额外空格。
  • Pure = 0: 表示带有少量格式化例程的 PDF 文本内容。这包括考虑相对位置并添加额外空格以使文本对齐到页面宽度。
  • Raw = 1: 表示 PDF 内容,原样输出,即不进行格式化。

命名空间: Documentize
程序集: Documentize.dll

2024年12月29日

枚举角色

信息

消息作者的角色.

public enum Role

字段

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

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日

枚举数据类型

信息

表示插件处理的可能数据类型.

public enum DataType

字段

  • Directory = 2: 数据类型是通过路径表示的目录。
  • File = 0: 数据类型是通过路径表示的文件。
  • Stream = 1: 数据类型是流。

命名空间: Documentize 程序集: Documentize.dll

枚举旋转

信息

可能旋转值的枚举。

public enum Rotation

字段

  • None = 0: 未旋转。
  • On180 = 2: 旋转180度。
  • On270 = 3: 顺时针旋转270度。
  • On360 = 4: 顺时针旋转360度。
  • On90 = 1: 顺时针旋转90度。

命名空间: Documentize 程序集: Documentize.dll

 中文