Tài liệu Namespace

Các lớp

Tên lớpMô tả
AddTimestampOptionsĐại diện cho các tùy chọn thêm dấu thời gian cho plugin Documentize.Timestamp.
CompressOptionsĐại diện cho các tùy chọn nén cho plugin Documentize.Optimizer.
DecryptionOptionsĐại diện cho các tùy chọn giải mã cho plugin Documentize.Security.
DirectoryDataSourceĐại diện cho dữ liệu thư mục cho các thao tác tải và lưu của một plugin.
DocConverterĐại diện cho plugin Documentize.DocConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng DOC/DOCX.
EncryptionOptionsĐại diện cho các tùy chọn mã hóa cho plugin Documentize.Security.
FileDataSourceĐại diện cho dữ liệu tệp cho các thao tác tải và lưu của một plugin.
FileResultĐại diện cho kết quả thao tác dưới dạng chuỗi đường dẫn đến tệp.
HtmlConverterĐại diện cho plugin Documentize.HtmlConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng HTML và tài liệu HTML thành định dạng PDF.
HtmlToPdfOptionsĐại diện cho các tùy chọn chuyển đổi HTML sang PDF cho plugin Documentize.HtmlConverter.
ImageExtractorĐại diện cho plugin Documentize.ImageExtractor. Được sử dụng để trích xuất hình ảnh từ tài liệu PDF.
ImageExtractorOptionsĐại diện cho các tùy chọn trích xuất hình ảnh cho plugin Documentize.ImageExtractor.
InfoLớp cung cấp thông tin về phiên bản sản phẩm hiện tại.
JpegConverterĐại diện cho plugin Documentize.JpegConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng JPEG.
LicenseCung cấp phương thức để thiết lập Giấy phép.
MergeOptionsĐại diện cho các tùy chọn gộp cho plugin Documentize.Merger.
MergerĐại diện cho plugin Documentize.Merger. Được sử dụng để gộp nhiều tài liệu PDF thành một tài liệu PDF duy nhất.
MessageMột tin nhắn hoàn thành trò chuyện được tạo ra bởi mô hình.
ObjectResultĐại diện cho kết quả thao tác dưới dạng chuỗi.
OptimizeOptionsĐại diện cho các tùy chọn tối ưu hóa cho plugin Documentize.Optimizer.
OptimizerĐại diện cho plugin Documentize.Optimizer.
PageInfoĐại diện cho thông tin trang.
PageSizeLớp đại diện cho kích thước trang trong tài liệu PDF.
PdfAConvertOptionsĐại diện cho các tùy chọn để chuyển đổi tài liệu PDF thành định dạng PDF/A với plugin Documentize.PdfAConverter.
PdfAConverterĐại diện cho một plugin để xử lý việc chuyển đổi tài liệu PDF thành định dạng PDF/A và kiểm tra tính tuân thủ PDF/A.
PdfAOptionsBaseĐại diện cho lớp cơ sở cho các tùy chọn plugin Documentize.PdfAConverter. Lớp này cung cấp các thuộc tính và phương thức để cấu hình quá trình chuyển đổi và kiểm tra PDF/A.
PdfAValidateOptionsĐại diện cho các tùy chọn để kiểm tra tính tuân thủ PDF/A của các tài liệu PDF với plugin Documentize.PdfAConverter.
PdfAValidationResultĐại diện cho kết quả của một quá trình kiểm tra PDF/A.
PdfChatGptĐại diện cho plugin PdfChatGpt.
PdfChatGptOptionsĐại diện cho các tùy chọn cho plugin Documentize.PdfChatGpt.
PdfChatGptRequestOptionsĐại diện cho các tùy chọn cho plugin Documentize.PdfChatGpt.
PdfConverterOptionsĐại diện cho các tùy chọn cho các plugin chuyển đổi PDF.
PdfExtractorĐại diện cho chức năng cơ bản để trích xuất văn bản, hình ảnh và các loại nội dung khác có thể xuất hiện trên các trang của tài liệu PDF.
PdfExtractorOptionsĐại diện cho các tùy chọn cho các plugin TextExtractor và ImageExtractor.
PdfToDocOptionsĐại diện cho các tùy chọn chuyển đổi PDF sang DOC cho plugin Documentize.DocConverter.
PdfToHtmlOptionsĐại diện cho các tùy chọn chuyển đổi PDF sang HTML cho plugin Documentize.HtmlConverter.
PdfToJpegOptionsĐại diện cho các tùy chọn chuyển đổi PDF sang JPEG cho plugin Documentize.JpegConverter.
PdfToPngOptionsĐại diện cho các tùy chọn chuyển đổi PDF sang PNG cho plugin Documentize.PngConverter.
PdfToTiffOptionsĐại diện cho các tùy chọn chuyển đổi PDF sang TIFF cho plugin Documentize.TiffConverter.
PdfToXlsOptionsĐại diện cho các tùy chọn chuyển đổi PDF sang XLSX cho plugin Documentize.XlsConverter.
PluginBaseOptionsĐại diện cho các tùy chọn cơ bản cho các plugin.
PngConverterĐại diện cho plugin Documentize.PngConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng PNG.
RectangleLớp đại diện cho hình chữ nhật.
ResizeOptionsĐại diện cho các tùy chọn thay đổi kích thước cho plugin Documentize.Optimizer.
ResultContainerĐại diện cho container chứa bộ sưu tập kết quả của việc xử lý plugin.
RotateOptionsĐại diện cho các tùy chọn xoay cho plugin Documentize.Optimizer.
SecurityĐại diện cho plugin Documentize.Security.
SignOptionsĐại diện cho các tùy chọn ký cho plugin Documentize.Signature.
SignatureĐại diện cho plugin Documentize.Signature.
SplitOptionsĐại diện cho các tùy chọn tách cho plugin Documentize.Splitter.
SplitterĐại diện cho plugin Documentize.Splitter. Được sử dụng để tách tài liệu thành các trang riêng biệt.
StreamDataSourceĐại diện cho nguồn dữ liệu luồng cho các thao tác tải và lưu của một plugin.
StreamResultĐại diện cho kết quả thao tác dưới dạng luồng.
StringResultĐại diện cho kết quả thao tác dưới dạng chuỗi.
TableBuilderLớp đại diện cho bộ xây dựng bảng trong trang pdf.
TableCellBuilderLớp đại diện cho bộ xây dựng ô bảng.
TableGeneratorĐại diện cho plugin Documentize.TableGenerator. Được sử dụng để thêm một bảng vào tài liệu PDF.
TableOptionsĐại diện cho các tùy chọn để thêm bảng vào tài liệu bằng plugin Documentize.TableGenerator.
TableRowBuilderLớp đại diện cho bộ xây dựng hàng bảng.
TextExtractorĐại diện cho plugin Documentize.TextExtractor. Được sử dụng để trích xuất văn bản từ tài liệu PDF.
TextExtractorOptionsĐại diện cho các tùy chọn trích xuất văn bản cho plugin Documentize.TextExtractor.
TiffConverterĐại diện cho plugin Documentize.TiffConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng TIFF.
TimestampĐại diện cho plugin Documentize.Timestamp.
XlsConverterĐại diện cho plugin Documentize.XlsConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng XLSX/XLS.

Các giao diện

Tên giao diệnMô tả
IDataSourceGiao diện dữ liệu chung định nghĩa các thành viên chung mà dữ liệu cụ thể nên triển khai.
IOperationResultGiao diện kết quả thao tác chung định nghĩa các phương thức chung mà kết quả thao tác plugin cụ thể nên triển khai.
IPluginOptionsGiao diện tùy chọn plugin chung định nghĩa các phương thức chung mà tùy chọn plugin cụ thể nên triển khai.

Các Enum

Tên EnumMô tả
ConvertErrorActionLớp này đại diện cho hành động đối với lỗi chuyển đổi.
ConvertSoftMaskActionHành động này đại diện cho các hành động cho việc chuyển đổi hình ảnh có mặt nạ mềm.
DataTypeĐại diện cho các loại dữ liệu có thể có để xử lý plugin.
PdfToXlsOptions.ExcelFormatCho phép chỉ định định dạng tệp .xlsx, .xls/xml hoặc csv. Giá trị mặc định là XLSX.
HtmlMediaTypeChỉ định các loại phương tiện có thể được sử dụng trong quá trình render.
HtmlPageLayoutOptionChỉ định các cờ mà cùng với các tùy chọn khác xác định kích thước và bố cục của các trang.
PdfAStandardVersionChỉ định phiên bản tiêu chuẩn PDF/A cho tài liệu PDF.
RoleVai trò của tác giả tin nhắn.
RotationLiệt kê các giá trị quay có thể có.
PdfToHtmlOptions.SaveDataTypeXác định loại đầu ra của tệp HTML.
TextExtractorOptions.TextFormattingModeXác định các chế độ khác nhau có thể được sử dụng trong quá trình chuyển đổi tài liệu PDF thành văn bản. Xem lớp Documentize.TextExtractorOptions.

Tiểu mục của Tài liệu Namespace

An ninh Lớp

Thông tin

Đại diện cho plugin Documentize.Security.

public sealed class Security  

Kế thừa

object
Security

Thành viên Kế thừa

Ví dụ

Ví dụ này chứng minh cách mã hóa tài liệu PDF.

// tạo Security  
var plugin = new Security();  
// tạo đối tượng EncryptionOptions để thiết lập hướng dẫn  
var opt = new EncryptionOptions("123456", "qwerty");  
// thêm đường dẫn tệp đầu vào  
opt.AddInput(new FileDataSource(inputPath));  
// thiết lập đường dẫn tệp đầu ra  
opt.AddOutput(new FileDataSource(outputPath));  
// thực hiện quá trình  
plugin.Process(opt);  

Ví dụ này chứng minh cách giải mã tài liệu PDF.

// tạo Security  
var plugin = new Security();  
// tạo đối tượng DecryptionOptions để thiết lập hướng dẫn  
var opt = new DecryptionOptions("123456"));  
// thêm đường dẫn tệp đầu vào  
opt.AddInput(new FileDataSource(inputPath));  
// thiết lập đường dẫn tệp đầu ra  
opt.AddOutput(new FileDataSource(outputPath));  
// thực hiện quá trình  
plugin.Process(opt);  

Constructor

Security()

public Security()  

Phương thức

Process(IPluginOptions)

Bắt đầu quá trình Documentize.Security với các tham số được chỉ định.

public ResultContainer Process(IPluginOptions options)  

Tham số

  • options IPluginOptions: Một đối tượng tùy chọn chứa hướng dẫn cho Documentize.Security.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của hoạt động.

Ngoại lệ

InvalidOperationException

Namespace: Documentize
Assembly: Documentize.dll

Bảng TableGenerator

Thông tin

Đại diện cho plugin Documentize.TableGenerator. Được sử dụng để thêm một bảng vào tài liệu PDF.

public sealed class TableGenerator

Kế thừa

objectTableGenerator

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách thêm bảng vào tệp PDF.

// tạo TableGenerator
var plugin = new TableGenerator();
// tạo đối tượng TableOptions để thiết lập hướng dẫn
TableOptions opt = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Tên")
            .AddCell().AddParagraph("Tuổi")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath1));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new FileDataSource(outputPath));
// thực hiện quá trình
plugin.Process(opt);

Các hàm khởi tạo

TableGenerator()

public TableGenerator()

Các phương thức

Process(TableOptions)

Bắt đầu quá trình Documentize.TableGenerator với các tham số được chỉ định.

public ResultContainer Process(TableOptions options)

Tham số

  • options TableOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.TableGenerator.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của thao tác.

Namespace: Documentize Assembly: Documentize.dll

Bộ chia lớp

Thông tin

Đại diện cho plugin Documentize.Splitter. Được sử dụng để chia tài liệu thành các trang riêng biệt.

public class Splitter  

Kế thừa

object
Splitter

Thành phần kế thừa

Ví dụ

Ví dụ này minh họa cách chia tài liệu PDF.

// tạo Bộ chia  
var plugin = new Splitter();  
// tạo đối tượng SplitOptions để đặt chỉ dẫn  
var opt = new SplitOptions();  
// thêm đường dẫn tệp đầu vào  
opt.AddInput(new FileDataSource(inputPath));  
// đặt đường dẫn tệp đầu ra  
opt.AddOutput(new FileDataSource(outputPath1));  
opt.AddOutput(new FileDataSource(outputPath2));  
// thực hiện quá trình  
plugin.Process(opt);  

Các hàm dựng

Splitter()

public Splitter()  

Các phương thức

Process(IPluginOptions)

Bắt đầu quá trình Documentize.Splitter với các tham số được chỉ định.

public ResultContainer Process(IPluginOptions options)  

Tham số

  • options IPluginOptions: Một đối tượng tùy chọn chứa chỉ dẫn cho Documentize.Splitter.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của thao tác.

Ngoại lệ

InvalidOperationException

Namespace: Documentize
Assembly: Documentize.dll

Bộ Tối Ưu Lớp

Thông tin

Đại diện cho plugin Documentize.Optimizer.

public sealed class Optimizer  

Kế thừa

object
Optimizer

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách tối ưu hóa tài liệu PDF.

// tạo một bộ tối ưu  
var plugin = new Optimizer();  
// tạo đối tượng OptimizeOptions để thiết lập hướng dẫn  
var opt = new OptimizeOptions();  
// thêm đường dẫn tệp đầu vào  
opt.AddInput(new FileDataSource(inputPath));  
// thiết lập đường dẫn tệp đầu ra  
opt.AddOutput(new FileDataSource(outputPath));  
// thực hiện quá trình  
plugin.Process(opt);  

Bộ tạo

Optimizer()

public Optimizer()  

Phương thức

Process(OptimizeOptions)

Bắt đầu xử lý Documentize.Optimizer với các tham số đã chỉ định.

public ResultContainer Process(OptimizeOptions options)  

Tham số

  • options OptimizeOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.OptimizeOptions.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của hoạt động.

Process(RotateOptions)

Bắt đầu xử lý Documentize.Optimizer với các tham số đã chỉ định.

public ResultContainer Process(RotateOptions options)  

Tham số

  • options RotateOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.RotateOptions.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của hoạt động.

Process(ResizeOptions)

Bắt đầu xử lý Documentize.Optimizer với các tham số đã chỉ định.

public ResultContainer Process(ResizeOptions options)  

Tham số

  • options ResizeOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.ResizeOptions.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của hoạt động.

Process(CompressOptions)

Bắt đầu xử lý Documentize.Optimizer với các tham số đã chỉ định.

public ResultContainer Process(CompressOptions options)  

Tham số

  • options CompressOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.CompressOptions.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của hoạt động.

Namespace: Documentize
Assembly: Documentize.dll

Chữ ký lớp

Thông tin

Đại diện cho plugin Documentize.Signature.

public sealed class Signature

Kế thừa

objectSignature

Các thành viên được kế thừa

Ví dụ

Ví dụ dưới đây minh hoạ cách ký tài liệu PDF.

// tạo Chữ ký
var plugin = new Signature();
// tạo đối tượng SignOptions để thiết lập hướng dẫn
var opt = new SignOptions(inputPfx, inputPfxPassword);
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new FileDataSource(outputPath));
// thực hiện quá trình
plugin.Process(opt);

Hàm khởi tạo

Signature()

public Signature()

Phương thức

Process(IPluginOptions)

Bắt đầu quy trình Documentize.Signature với các tham số đã chỉ định.

public ResultContainer Process(IPluginOptions options)

Tham số

  • options IPluginOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.Signature.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của thao tác.

Ngoại lệ

InvalidOperationException

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

Thông tin

Đại diện cho tùy chọn chuyển đổi HTML sang PDF cho plugin Documentize.HtmlConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions  

Kế thừa

object
PluginBaseOptions
HtmlToPdfOptions

Triển khai

Thành viên kế thừa

Các hàm khởi tạo

HtmlToPdfOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()  

Các thuộc tính

BasePath

Đường dẫn/url cơ sở cho tệp html.

public string BasePath { get; set; }  

Giá trị thuộc tính

string

HtmlMediaType

Lấy hoặc thiết lập các loại phương tiện có thể được sử dụng trong quá trình hiển thị.

public HtmlMediaType HtmlMediaType { get; set; }  

Giá trị thuộc tính

HtmlMediaType

IsRenderToSinglePage

Lấy hoặc thiết lập việc hiển thị tất cả tài liệu thành một trang duy nhất.

public bool IsRenderToSinglePage { get; set; }  

Giá trị thuộc tính

bool

PageInfo

Lấy hoặc thiết lập thông tin trang tài liệu.

public PageInfo PageInfo { get; set; }  

Giá trị thuộc tính

PageInfo

PageLayoutOption

Lấy hoặc thiết lập tùy chọn bố trí.

public HtmlPageLayoutOption PageLayoutOption { get; set; }  

Giá trị thuộc tính

HtmlPageLayoutOption

Namespace: Documentize
Assembly: Documentize.dll

Class ImageExtractorOptions

Thông tin

Đại diện cho các tùy chọn trích xuất hình ảnh cho plugin Documentize.ImageExtractor.

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions  

Inheritance

object
PdfExtractorOptions
ImageExtractorOptions

Implements

Inherited Members

Remarks

Nó kế thừa các chức năng để thêm dữ liệu (tệp, luồng) đại diện cho các tài liệu PDF đầu vào.

Constructors

ImageExtractorOptions()

Khởi tạo một phiên bản mới của đối tượng Documentize.ImageExtractorOptions.

public ImageExtractorOptions()  

Properties

OperationName

Trả về tên của hoạt động.

public override string OperationName { get; }  

Property Value

string

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAConverter

Thông tin

Đại diện cho một plugin để xử lý việc chuyển đổi tài liệu PDF sang định dạng PDF/A và để xác thực sự tuân thủ PDF/A.

public sealed class PdfAConverter

Kế thừa

objectPdfAConverter

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách xác thực sự tuân thủ của tài liệu PDF đối với định dạng PDF/A (PDF/A-1a trong trường hợp này):

// Tạo lớp tùy chọn để thiết lập quy trình xác thực
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Thêm một hoặc nhiều tệp cần xác thực
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // thay thế bằng đường dẫn tệp thực tế của bạn
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// thêm nhiều tệp nếu cần

// Tạo thể hiện plugin
var plugin = new PdfAConverter();

// Chạy xác thực và lấy kết quả
var resultContainer = plugin.Process(options);

// Kiểm tra thuộc tính resultContainer.ResultCollection để xem kết quả xác thực cho từng tệp:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Kết quả xác thực cho tài liệu thứ i
}

Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng PDF/A (PDF/A-3b trong trường hợp này):

// Tạo lớp tùy chọn để thiết lập quy trình chuyển đổi
var options = new PdfAConvertOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Thêm tệp nguồn
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // thay thế bằng đường dẫn tệp thực tế của bạn

// Thêm đường dẫn để lưu tệp đã chuyển đổi
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Tạo thể hiện plugin
var plugin = new PdfAConverter();

// Chạy chuyển đổi
plugin.Process(options);

Các hàm khởi tạo

PdfAConverter()

public PdfAConverter()

Các phương thức

Process(IPluginOptions)

Bắt đầu một quá trình chuyển đổi hoặc xác thực PDF/A với các tùy chọn đã cho.

public ResultContainer Process(IPluginOptions options)

Tham số

  • options IPluginOptions: Một đối tượng tùy chọn chứa hướng dẫn cho plugin. Phải là một thể hiện của lớp Documentize.PdfAConvertOptions: hoặc lớp Documentize.PdfAValidateOptions.

Trả về

ResultContainer : Một đối tượng Documentize.ResultContainer chứa kết quả của quá trình xử lý.

Tên không gian: Documentize Assembly: Documentize.dll

Class PdfAValidateOptions

Thông tin

Đại diện cho các tùy chọn để xác thực sự tuân thủ PDF/A của các tài liệu PDF với plugin Documentize.PdfAConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions  

Kế thừa

object
PdfAOptionsBase
PdfAValidateOptions

Triển khai

Các thành viên được kế thừa

Các hàm khởi tạo

PdfAValidateOptions()

public PdfAValidateOptions()  

Không gian tên: Documentize
Assembly: Documentize.dll

Class PdfToHtmlOptions

Thông tin

Đại diện cho các tùy chọn chuyển đổi PDF sang HTML cho plugin Documentize.HtmlConverter.

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions

Kế thừa

objectPdfConverterOptionsPdfToHtmlOptions

Thực hiện

Các thành viên kế thừa

Các hàm khởi tạo

PdfToHtmlOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToHtmlOptions với các tùy chọn mặc định.

public PdfToHtmlOptions()

PdfToHtmlOptions(SaveDataType)

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToHtmlOptions cho loại dữ liệu đầu ra được chỉ định.

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)

Tham số

Thuộc tính

OutputDataType

Lấy loại dữ liệu đầu ra.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Giá trị thuộc tính

PdfToHtmlOptions.SaveDataType

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Thông tin

Class đại diện cho builder cho bảng trong trang pdf.

public class TableBuilder  

Kế thừa

object
TableBuilder

Kế thừa

Thành viên kế thừa

Phương thức

AddRow()

Thêm hàng mới vào bảng.

public virtual TableRowBuilder AddRow()  

Trả về

TableRowBuilder : Thể hiện của Documentize.TableRowBuilder hiện tại.

AddTable()

Thêm bảng mới vào tài liệu.

public TableBuilder AddTable()  

Trả về

TableBuilder : Thể hiện của Documentize.TableBuilder hiện tại.

InsertPageAfter(int)

Chèn trang sau trang đã chỉ định.

public TableOptions InsertPageAfter(int page)  

Tham số

  • page int: Số trang để chèn bảng sau.

Trả về

TableOptions : Thể hiện của Documentize.TableOptions hiện tại.

InsertPageBefore(int)

Chèn trang trước trang đã chỉ định.

public TableOptions InsertPageBefore(int page)  

Tham số

  • page int: Số trang để chèn bảng sau.

Trả về

TableOptions : Thể hiện của Documentize.TableOptions hiện tại.

Toán tử

implicit operator TableOptions(TableBuilder)

Chuyển đổi builder Documentize.TableBuilder thành options Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)  

Tham số

  • builder TableBuilder: Thể hiện của Documentize.TableBuilder hiện tại.

Trả về

TableOptions : Kết quả của việc chuyển đổi thành PdfGeneratorTableOptions.

Namespace: Documentize
Assembly: Documentize.dll

Class XlsConverter

Thông tin

Đại diện cho plugin Documentize.XlsConverter. Dùng để chuyển đổi tài liệu PDF sang định dạng XLSX/XLS.

public sealed class XlsConverter  

Inheritance

object
XlsConverter

Inherited Members

Examples

Ví dụ này minh họa cách chuyển đổi PDF thành tài liệu XLSX.

// tạo XlsConverter  
var plugin = new XlsConverter();  
// tạo PdfToXlsOptions  
var opt = new PdfToXlsOptions();  
// thêm đường dẫn tệp đầu vào  
opt.AddInput(new FileDataSource(inputPath));  
// đặt đường dẫn tệp đầu ra  
opt.AddOutput(new FileDataSource(outputPath));  
// thực hiện quá trình  
plugin.Process(opt);  

Constructors

XlsConverter()

public XlsConverter()  

Methods

Process(PdfToXlsOptions)

Bắt đầu quá trình Documentize.XlsConverter với các tham số được chỉ định.

public ResultContainer Process(PdfToXlsOptions options)  

Parameters

  • options PdfToXlsOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho hoạt động.

Returns

ResultContainer : Một đối tượng Documentize.ResultContainer chứa kết quả của hoạt động.

Namespace: Documentize
Assembly: Documentize.dll

Enum ConvertErrorAction

Thông tin

Lớp này đại diện cho hành động cho các lỗi chuyển đổi.

public enum ConvertErrorAction

Fields

  • Delete = 0
  • None = 1

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum ConvertSoftMaskAction

Thông tin

Hành động này đại diện cho các hành động chuyển đổi hình ảnh với mặt nạ mềm.

public enum ConvertSoftMaskAction

Fields

  • ConvertToStencilMask = 1: Mặt nạ mềm sẽ được chuyển đổi thành mặt nạ khuôn.
  • Default = 0: Sử dụng chiến lược mặc định.

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum HtmlMediaType

Thông tin

Chỉ định các loại phương tiện có thể sử dụng trong quá trình xuất.

public enum HtmlMediaType

Fields

  • Print = 0: In.
  • Screen = 1: Màn hình.

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum HtmlPageLayoutOption

Thông tin

Chỉ định các cờ mà cùng với các tùy chọn khác xác định kích thước và bố cục của các trang.

public enum HtmlPageLayoutOption

Fields

  • FitToWidestContentWidth = 3: Chỉ ra rằng chiều rộng của trang được xác định từ kích thước nội dung, không phải từ chiều rộng trang đã chỉ định.
  • None = 0: Giá trị mặc định chỉ ra rằng HtmlPageLayoutOption sẽ không ảnh hưởng đến kích thước và bố cục của các trang.
  • ScaleToPageWidth = 256: Chỉ ra rằng nội dung của tài liệu sẽ được thu nhỏ để phù hợp với trang.

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum PdfAStandardVersion

Thông tin

Xác định phiên bản tiêu chuẩn PDF/A cho một tài liệu PDF.

public enum PdfAStandardVersion

Các trường

  • Auto = 0: Phiên bản tiêu chuẩn PDF/A được xác định tự động.
  • PDF_A_1A = 1: Xác định phiên bản tiêu chuẩn PDF/A-1a.
  • PDF_A_1B = 2: Xác định phiên bản tiêu chuẩn PDF/A-1b.
  • PDF_A_2A = 3: Xác định phiên bản tiêu chuẩn PDF/A-2a.
  • PDF_A_2B = 4: Xác định phiên bản tiêu chuẩn PDF/A-2b.
  • PDF_A_2U = 5: Xác định phiên bản tiêu chuẩn PDF/A-2u.
  • PDF_A_3A = 6: Xác định phiên bản tiêu chuẩn PDF/A-3a.
  • PDF_A_3B = 7: Xác định phiên bản tiêu chuẩn PDF/A-3b.
  • PDF_A_3U = 8: Xác định phiên bản tiêu chuẩn PDF/A-3u.

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum PdfToHtmlOptions.SaveDataType

Thông tin

Xác định loại đầu ra của tệp HTML.

public enum PdfToHtmlOptions.SaveDataType

Fields

  • FileWithEmbeddedResources = 1: Lưu HTMl vào tệp với tài nguyên nhúng
  • FileWithExternalResources = 0: Lưu HTMl vào tệp với tài nguyên bên ngoài
  • StreamWithEmbeddedResources = 2: Lưu HTMl vào luồng tệp với tài nguyên nhúng

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum PdfToXlsOptions.ExcelFormat

Thông tin

Cho phép chỉ định định dạng tệp .xlsx, .xls/xml hoặc csv. Giá trị mặc định là XLSX.

Cho phép chỉ định định dạng tệp .xlsx, .xls/xml hoặc csv. Giá trị mặc định là XLSX.

public enum PdfToXlsOptions.ExcelFormat

Fields

  • CSV = 2: Định dạng tệp giá trị phân cách bằng dấu phẩy (CSV).
  • ODS = 4: Bảng tính Open Document.
  • XLSM = 3: Định dạng tệp Office Open XML (.xlsm) cho phép macro.
  • XLSX = 1: Định dạng tệp Office Open XML (.xlsx).
  • XMLSpreadSheet2003 = 0: Định dạng tệp Excel 2003 XML (.xls).

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum Role

Thông tin

Vai trò của tác giả tin nhắn.

public enum Role

Fields

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

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Enum TextExtractorOptions.TextFormattingMode

Thông tin

Xác định các chế độ khác nhau có thể được sử dụng khi chuyển đổi một tài liệu PDF thành văn bản. Xem lớp Documentize.TextExtractorOptions.

public enum TextExtractorOptions.TextFormattingMode  

Fields

  • Plain = 2: Đại diện cho nội dung văn bản PDF với vị trí tương đối của các đoạn văn bản nhưng không thêm khoảng trống thừa.
  • Pure = 0: Đại diện cho nội dung văn bản PDF với một số quy trình định dạng. Điều này bao gồm việc xem xét các vị trí tương đối và thêm khoảng trống thừa để căn chỉnh văn bản với chiều rộng của trang.
  • Raw = 1: Đại diện cho nội dung PDF như nó vốn có, tức là không có định dạng.

Namespace: Documentize
Assembly: Documentize.dll

29 thg 12, 2024

Giao diện IDataSource

Thông tin

Giao diện dữ liệu tổng quát định nghĩa các thành viên chung mà dữ liệu cụ thể nên thực hiện.

public interface IDataSource

Thuộc tính

DataType

Loại nguồn dữ liệu.

DataType DataType { get; }

Giá trị thuộc tính

DataType

Không gian tên: Documentize Tập tin: Documentize.dll

Giao diện IOperationResult

Thông tin

Giao diện kết quả thao tác chung định nghĩa các phương thức chung mà kết quả thao tác plugin cụ thể nên triển khai.

public interface IOperationResult

Thuộc tính

Data

Lấy dữ liệu thô.

object Data { get; }

Giá trị thuộc tính

object

IsFile

Chỉ ra liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.

bool IsFile { get; }

Giá trị thuộc tính

bool

IsStream

Chỉ ra liệu kết quả có phải là một luồng đầu ra hay không.

bool IsStream { get; }

Giá trị thuộc tính

bool

IsString

Chỉ ra liệu kết quả có phải là một chuỗi văn bản hay không.

bool IsString { get; }

Giá trị thuộc tính

bool

Phương thức

ToFile()

Cố gắng chuyển đổi kết quả thành tệp.

string ToFile()

Trả về

string : Một chuỗi đại diện cho đường dẫn đến tệp đầu ra nếu kết quả là tệp; ngược lại null.

ToStream()

Cố gắng chuyển đổi kết quả thành đối tượng luồng.

Stream ToStream()

Trả về

Stream : Một đối tượng luồng đại diện cho dữ liệu đầu ra nếu kết quả là luồng; ngược lại null.

Namespace: Documentize Assembly: Documentize.dll

Giao diện IPluginOptions

Thông tin

Giao diện tuỳ chọn plugin tổng quát xác định các phương thức chung mà tuỳ chọn plugin cụ thể nên triển khai.

public interface IPluginOptions  

Namespace: Documentize
Assembly: Documentize.dll

Giấy phép lớp

Thông tin

Cung cấp phương thức để thiết lập Giấy phép.

public static class License

Kế thừa

objectLicense

Thành viên kế thừa

Ví dụ

Chỉ ra cách kích hoạt giấy phép.

// Thiết lập Giấy phép
License.Set("PathToLicense.lic");

Phương thức

Set(string)

Cấp giấy phép cho thành phần.

public static void Set(string licenseName)

Tham số

  • licenseName string: Có thể là tên tệp đầy đủ hoặc tên tệp ngắn. Sử dụng chuỗi rỗng để chuyển sang chế độ đánh giá.

Namespace: Documentize Assembly: Documentize.dll

Hợp nhất lớp

Thông tin

Đại diện cho plugin Documentize.Merger. Được sử dụng để hợp nhất nhiều tài liệu PDF thành một PDF duy nhất.

public sealed class Merger

Kế thừa

objectMerger

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách hợp nhất hai tài liệu PDF.

// tạo Merger
var plugin = new Merger();
// tạo đối tượng MergeOptions để thiết lập hướng dẫn
var opt = new MergeOptions();
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath1));
opt.AddInput(new FileDataSource(inputPath2));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new FileDataSource(outputPath));
// thực hiện quá trình
plugin.Process(opt);

Các hàm khởi tạo

Merger()

public Merger()

Các phương thức

Process(MergeOptions)

Bắt đầu quá trình Documentize.Merger với các tham số đã chỉ định.

public ResultContainer Process(MergeOptions options)

Tham số

  • options MergeOptions: Một đối tượng tùy chọn có chứa hướng dẫn cho hoạt động.

Trả về

ResultContainer : Một đối tượng Documentize.ResultContainer chứa kết quả của hoạt động.

Namespace: Documentize Assembly: Documentize.dll

Kết quả đối tượng Lớp

Thông tin

Đại diện cho kết quả hoạt động dưới dạng chuỗi.

public sealed class ObjectResult : IOperationResult

Kế thừa

objectObjectResult

Cài đặt

Thành viên kế thừa

Thuộc tính

Dữ liệu

Nhận dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

object

LàFile

Chỉ ra xem kết quả có phải là đường dẫn đến tệp đầu ra hay không.

public bool IsFile { get; }

Giá trị thuộc tính

bool

LàĐốiTượng

Chỉ ra xem kết quả có phải là một đối tượng hay không.

public bool IsObject { get; }

Giá trị thuộc tính

bool

LàDòng

Chỉ ra xem kết quả có phải là đường dẫn đến tệp đầu ra hay không.

public bool IsStream { get; }

Giá trị thuộc tính

bool

LàChuỗi

Chỉ ra xem kết quả có phải là một chuỗi hay không.

public bool IsString { get; }

Giá trị thuộc tính

bool

Văn bản

Trả về đại diện chuỗi của kết quả.

public string Text { get; }

Giá trị thuộc tính

string

Phương thức

ToFile()

Cố gắng chuyển đổi kết quả thành một tệp.

public string ToFile()

Trả về

string : Một chuỗi đại diện cho đường dẫn đến tệp đầu ra nếu kết quả là tệp; nếu không null.

ToStream()

Cố gắng chuyển đổi kết quả thành một đối tượng luồng.

public Stream ToStream()

Trả về

Stream : Một đối tượng luồng đại diện cho dữ liệu đầu ra nếu kết quả là luồng; nếu không null.

ToString()

Cố gắng chuyển đổi kết quả thành một chuỗi.

public override string ToString()

Trả về

string : Một chuỗi đại diện cho nội dung văn bản nếu kết quả là chuỗi; nếu không trả về base.ToString().

Không gian tên: Documentize Assembly: Documentize.dll

Kết quả lớp Container

Thông tin

Đại diện cho container chứa bộ sưu tập kết quả của việc xử lý plugin.

public class ResultContainer

Kế thừa

objectResultContainer

Các thành viên kế thừa

Thuộc tính

ResultCollection

Lấy bộ sưu tập kết quả của các hoạt động

public List<ioperationresult> ResultCollection { get; }

Giá trị thuộc tính

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Kết quả StreamResult

Thông tin

Đại diện cho kết quả hoạt động dưới dạng Stream.

public sealed class StreamResult : IOperationResult

Kế thừa

objectStreamResult

Triển khai

Thành viên kế thừa

Thuộc tính

Dữ liệu

Lấy dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

object

IsFile

Chỉ ra liệu kết quả có phải là một đường dẫn tới tệp đầu ra hay không.

public bool IsFile { get; }

Giá trị thuộc tính

bool

IsStream

Chỉ ra liệu kết quả có phải là một đường dẫn tới tệp đầu ra hay không.

public bool IsStream { get; }

Giá trị thuộc tính

bool

IsString

Chỉ ra liệu kết quả có phải là một chuỗi hay không.

public bool IsString { get; }

Giá trị thuộc tính

bool

Phương thức

ToFile()

Cố gắng chuyển đổi kết quả thành một tệp.

public string ToFile()

Trả về

string : Một chuỗi đại diện cho đường dẫn tới tệp đầu ra nếu kết quả là tệp; nếu không thì null.

ToStream()

Cố gắng chuyển đổi kết quả thành một đối tượng stream.

public Stream ToStream()

Trả về

Stream : Một đối tượng stream đại diện cho dữ liệu đầu ra nếu kết quả là stream; nếu không thì null.

Namespace: Documentize Assembly: Documentize.dll

Kết quả xác thực PdfAValidationResult

Thông tin

Đại diện cho kết quả của quá trình xác thực PDF/A.

public sealed class PdfAValidationResult  

Kế thừa

object
PdfAValidationResult

Thành viên kế thừa

Trường

  • DataSource Lấy nguồn dữ liệu đã được xác thực.

Giá trị trường

IDataSource

IsValid

Lấy giá trị cho biết liệu việc xác thực có thành công hay không.

public readonly bool IsValid  

Giá trị trường

bool

StandardVersion

Lấy phiên bản tiêu chuẩn PDF/A được sử dụng để xác thực.

public readonly PdfAStandardVersion StandardVersion  

Giá trị trường

PdfAStandardVersion

Namespace: Documentize
Assembly: Documentize.dll

Kích thước trang lớp

Thông tin

Lớp đại diện cho kích thước của trang trong tài liệu PDF.

public class PageSize  

Kế thừa

object
PageSize

Kế thừa

Thành viên đã kế thừa

Constructor

PageSize()

Constructor của Documentize.PageSize. Kích thước A4 theo mặc định.

public PageSize()  

PageSize(double, double)

Constructor của Documentize.PageSize.

public PageSize(double width, double height)  

Tham số

  • width double: Chiều rộng của trang.
  • height double: Chiều cao của trang.

Thuộc tính

A0

Kích thước A0 (1189x840 mm).

public static PageSize A0 { get; }  

Giá trị thuộc tính

PageSize

A1

Kích thước A1 (840x594 mm).

public static PageSize A1 { get; }  

Giá trị thuộc tính

PageSize

A2

Kích thước A2 (594x420 mm).

public static PageSize A2 { get; }  

Giá trị thuộc tính

PageSize

A3

Kích thước A3 (420x297 mm).

public static PageSize A3 { get; }  

Giá trị thuộc tính

PageSize

A4

Kích thước A4 (297x210 mm).

public static PageSize A4 { get; }  

Giá trị thuộc tính

PageSize

A5

Kích thước A5 (210x148 mm).

public static PageSize A5 { get; }  

Giá trị thuộc tính

PageSize

A6

Kích thước A6 (148x105 mm).

public static PageSize A6 { get; }  

Giá trị thuộc tính

PageSize

B5

Kích thước B5 (250x176 mm).

public static PageSize B5 { get; }  

Giá trị thuộc tính

PageSize

Chiều cao

Lấy hoặc đặt chiều cao trang.

public double Height { get; set; }  

Giá trị thuộc tính

double

Định dạng ngang

Lấy hướng của trang. Trả về true nếu đây là định dạng ngang và false nếu đây là định dạng dọc.

public bool IsLandscape { get; }  

Giá trị thuộc tính

bool

P11x17

Định dạng 11x17 inch.

public static PageSize P11x17 { get; }  

Giá trị thuộc tính

PageSize

Kích thước Ledger

Kích thước Ledger (432x279 mm).

public static PageSize PageLedger { get; }  

Giá trị thuộc tính

PageSize

Kích thước Legal (356x216 mm).

public static PageSize PageLegal { get; }  

Giá trị thuộc tính

PageSize

Kích thước Letter

Kích thước Letter (279x216 mm).

public static PageSize PageLetter { get; }  

Giá trị thuộc tính

PageSize

Chiều rộng

Lấy hoặc đặt chiều rộng trang.

public double Width { get; set; }  

Giá trị thuộc tính

double

Namespace: Documentize
Assembly: Documentize.dll

Kiểu Dữ Liệu Enum

Thông tin

Đại diện cho các loại dữ liệu có thể cho quá trình xử lý plugin.

public enum DataType

Các Trường

  • Directory = 2: Kiểu dữ liệu là một thư mục được đại diện bởi đường dẫn đến nó.
  • File = 0: Kiểu dữ liệu là một tệp được đại diện bởi đường dẫn đến nó.
  • Stream = 1: Kiểu dữ liệu là một luồng.

Namespace: Documentize Assembly: Documentize.dll

29 thg 12, 2024

Lớp AddTimestampOptions

Thông tin

Đại diện cho Các Tùy Chọn Thêm Dấu Thời Gian cho plugin Documentize.Timestamp.

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsAddTimestampOptions

Triển khai

Các Thành Phần Kế Thừa

Các Hàm Khởi Tạo

AddTimestampOptions(Stream, string, string, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.AddTimestampOptions với các tùy chọn mặc định.

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

Tham số

  • pfx Stream: Đường dẫn đến tệp pfx.
  • password string: Mật khẩu cho tệp pfx.
  • serverUrl string: Đường dẫn máy chủ dấu thời gian.
  • serverBasicAuthCredentials string: Thông tin xác thực xác thực cơ bản, tên người dùng và mật khẩu được kết hợp thành chuỗi “username:password”. (Tùy chọn).

AddTimestampOptions(string, string, string, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.AddTimestampOptions với các tùy chọn mặc định.

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

Tham số

  • pfx string: Đường dẫn đến tệp pfx.
  • password string: Mật khẩu cho tệp pfx.
  • serverUrl string: Đường dẫn máy chủ dấu thời gian.
  • serverBasicAuthCredentials string: Thông tin xác thực xác thực cơ bản, tên người dùng và mật khẩu được kết hợp thành chuỗi “username:password”. (Tùy chọn).

Namespace: Documentize Assembly: Documentize.dll

Lớp CompressOptions

Thông tin

Đại diện cho các tùy chọn nén cho plugin Documentize.Optimizer.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions  

Kế thừa

object
PluginBaseOptions
CompressOptions

Thực hiện

Các thành viên kế thừa

Các hàm khởi tạo

CompressOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.CompressOptions với các tùy chọn mặc định.

public CompressOptions()  

Namespace: Documentize
Assembly: Documentize.dll

Lớp DecryptionOptions

Thông tin

Đại diện cho các tùy chọn giải mã cho plugin Documentize.Security.

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsDecryptionOptions

Triển khai

Thành viên kế thừa

Các hàm khởi tạo

DecryptionOptions(string)

Khởi tạo một instance mới của đối tượng Documentize.DecryptionOptions với các tùy chọn mặc định.

public DecryptionOptions(string ownerPassword)

Tham số

  • ownerPassword string: Mật khẩu chủ sở hữu.

Thuộc tính

OwnerPassword

Mật khẩu chủ sở hữu.

public string OwnerPassword { get; set; }

Giá trị thuộc tính

string

Tên không gian: Documentize Assembly: Documentize.dll

Lớp DocConverter

Thông tin

Đại diện cho plugin Documentize.DocConverter. Được sử dụng để chuyển đổi tài liệu PDF sang định dạng DOC/DOCX.

public sealed class DocConverter  

Kế thừa

object
DocConverter

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng Doc.

// tạo DocConverter  
var plugin = new DocConverter();  
// tạo đối tượng PdfToDocOptions để đặt hướng dẫn  
var opt = new PdfToDocOptions();  
// thêm đường dẫn tệp đầu vào  
opt.AddInput(new FileDataSource(inputPath));  
// đặt đường dẫn tệp đầu ra  
opt.AddOutput(new FileDataSource(outputPath));  
// thực hiện quá trình  
plugin.Process(opt);  

Hàm tạo

DocConverter()

public DocConverter()  

Phương thức

Dispose()

Triển khai của IDisposable.

public void Dispose()  

Process(PdfToDocOptions)

Bắt đầu quá trình Documentize.DocConverter với các tham số đã chỉ định.

public ResultContainer Process(PdfToDocOptions options)  

Tham số

  • options PdfToDocOptions: Một đối tượng tùy chọn chứa hướng dẫn cho Documentize.DocConverter.

Trả về

ResultContainer: Một đối tượng Documentize.ResultContainer chứa kết quả của hoạt động.

Namespace: Documentize
Assembly: Documentize.dll

Lớp EncryptionOptions

Thông tin

Đại diện cho Tùy chọn Mã hóa cho plugin Documentize.Security.

public class EncryptionOptions : PluginBaseOptions, IPluginOptions  

Kế thừa

object
PluginBaseOptions
EncryptionOptions

Triển khai

Các thành viên được kế thừa

Các Bộ tạo

EncryptionOptions(string, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.EncryptionOptions với các tùy chọn mặc định.

public EncryptionOptions(string ownerPassword, string userPassword)  

Tham số

  • ownerPassword string: Mật khẩu chủ sở hữu.
  • userPassword string: Mật khẩu người dùng.

Các thuộc tính

OwnerPassword

Mật khẩu chủ sở hữu.

public string OwnerPassword { get; set; }  

Giá trị thuộc tính

string

UserPassword

Mật khẩu người dùng.

public string UserPassword { get; set; }  

Giá trị thuộc tính

string

Namespace: Documentize
Assembly: Documentize.dll

Lớp FileDataSource

Thông tin

Đại diện cho dữ liệu tệp cho các thao tác tải và lưu của một plugin.

public sealed class FileDataSource : IDataSource

Kế thừa

objectFileDataSource

Triển khai

Các thành viên kế thừa

Các hàm dựng

FileDataSource(string)

Khởi tạo nguồn dữ liệu tệp mới với đường dẫn được chỉ định.

public FileDataSource(string path)

Tham số

  • path string: Một chuỗi đại diện cho đường dẫn đến tệp nguồn.

Các thuộc tính

DataType

Loại nguồn dữ liệu.

public DataType DataType { get; }

Giá trị thuộc tính

DataType

Path

Lấy đường dẫn đến tệp của dữ liệu hiện tại.

public string Path { get; }

Giá trị thuộc tính

string

Namespace: Documentize Assembly: Documentize.dll

Lớp FileResult

Thông tin

Đại diện cho kết quả hoạt động dưới dạng đường dẫn chuỗi tới tệp.

public sealed class FileResult : IOperationResult

Kế thừa

objectFileResult

Triển khai

Thành viên kế thừa

Thuộc tính

Dữ liệu

Lấy dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

object

IsFile

Cho biết liệu kết quả có phải là đường dẫn tới một tệp đầu ra hay không.

public bool IsFile { get; }

Giá trị thuộc tính

bool

IsStream

Cho biết liệu kết quả có phải là một luồng đầu ra hay không.

public bool IsStream { get; }

Giá trị thuộc tính

bool

IsString

Cho biết liệu kết quả có phải là một chuỗi văn bản hay không.

public bool IsString { get; }

Giá trị thuộc tính

bool

Phương thức

ToFile()

Cố gắng chuyển đổi kết quả thành một tệp.

public string ToFile()

Trả về

string : Một chuỗi đại diện cho đường dẫn tới tệp đầu ra nếu kết quả là tệp; nếu không thì null.

ToStream()

Cố gắng chuyển đổi kết quả thành một đối tượng luồng.

public Stream ToStream()

Trả về

Stream : Một đối tượng luồng đại diện cho dữ liệu đầu ra nếu kết quả là luồng; nếu không thì null.

Namespace: Documentize Assembly: Documentize.dll

Lớp Hình Chữ Nhật

Thông tin

Lớp đại diện cho hình chữ nhật.

public class Rectangle

Kế thừa

objectRectangle

Các thành viên kế thừa

Các Hàm Khởi Tạo

Rectangle(double, double, double, double)

Hàm khởi tạo của Hình Chữ Nhật.

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

Tham số

  • llx double: X của góc dưới bên trái.
  • lly double: Y của góc dưới bên trái.
  • urx double: X của góc trên bên phải.
  • ury double: Y của góc trên bên phải.

Không gian tên: Documentize Thư viện: Documentize.dll

Lớp HtmlConverter

Thông tin

Đại diện cho plugin Documentize.HtmlConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng HTML và tài liệu HTML thành định dạng PDF.

public sealed class HtmlConverter : IDisposable

Di sản

objectHtmlConverter

Thực hiện

Các thành viên kế thừa

Ví dụ

Ví dụ minh họa cách chuyển đổi PDF thành tài liệu HTML.

// tạo HtmlConverter
var plugin = new HtmlConverter();
// tạo đối tượng PdfToHtmlOptions để thiết lập kiểu dữ liệu đầu ra là tệp với các tài nguyên nhúng
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Ví dụ minh họa cách chuyển đổi HTML thành tài liệu PDF.

// tạo HtmlConverter
var plugin = new HtmlConverter();
// tạo HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Các hàm xây dựng

HtmlConverter()

public HtmlConverter()

Các phương thức

Dispose()

Cài đặt của IDisposable.

public void Dispose()

Process(IPluginOptions)

Bắt đầu xử lý Documentize.HtmlConverter với các tham số được chỉ định.

public ResultContainer Process(IPluginOptions options)

Tham số

  • options IPluginOptions: Một đối tượng tùy chọn chứa các chỉ dẫn cho Documentize.HtmlConverter.

Trả về

ResultContainer : Một đối tượng Documentize.ResultContainer chứa kết quả của thao tác.

Namespace: Documentize Assembly: Documentize.dll

Lớp ImageExtractor

Thông tin

Đại diện cho plugin Documentize.ImageExtractor. Được sử dụng để trích xuất hình ảnh từ tài liệu PDF.

public class ImageExtractor : PdfExtractor, IDisposable

Kế thừa

objectPdfExtractorImageExtractor

Triển khai

Các thành viên kế thừa

Ví dụ

Ví dụ minh họa cách trích xuất hình ảnh từ tài liệu PDF.

// tạo đối tượng ImageExtractor để trích xuất hình ảnh
using (var plugin = new ImageExtractor())
{
    // tạo ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // thêm đường dẫn tệp đầu vào
    opt.AddInput(new FileDataSource(inputPath));
    // đặt thư mục đầu ra
    opt.AddInput(new FileDataSource("D:\\"));

    // thực hiện quá trình trích xuất
    var resultContainer = plugin.Process(opt);

    // lấy hình ảnh từ đối tượng ResultContainer
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

Các hàm khởi tạo

ImageExtractor()

public ImageExtractor()

Namespace: Documentize Assembly: Documentize.dll

Lớp JpegConverter

Thông tin

Đại diện cho plugin Documentize.JpegConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng JPEG.

public sealed class JpegConverter

Kế thừa

objectJpegConverter

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách chuyển đổi tài liệu PDF thành định dạng JPEG.

// tạo JpegConverter
var plugin = new JpegConverter();
// tạo đối tượng PdfToJpegOptions để đặt hướng dẫn
var opt = new PdfToJpegOptions();
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath));
// đặt đường dẫn tệp đầu ra
opt.AddOutput(new DirectoryDataSource(outputPath));
// thực hiện quá trình
plugin.Process(opt);

Các hàm khởi tạo

JpegConverter()

public JpegConverter()

Các phương thức

Process(PdfToJpegOptions)

Bắt đầu quá trình Documentize.JpegConverter với các tham số đã chỉ định.

public ResultContainer Process(PdfToJpegOptions options)

Tham số

  • options PdfToJpegOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.JpegConverter.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của thao tác.

Namespace: Documentize Assembly: Documentize.dll

Lớp MergeOptions

Thông tin

Đại diện cho các tùy chọn Gộp cho plugin Documentize.Merger.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions  

Kế thừa

object
PluginBaseOptions
MergeOptions

Triển khai

Thành viên kế thừa

Các hàm khởi tạo

MergeOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.MergeOptions với các tùy chọn mặc định.

public MergeOptions()  

Namespace: Documentize
Assembly: Documentize.dll

Lớp OptimizeOptions

Thông tin

Đại diện cho các tùy chọn tối ưu hóa cho plugin Documentize.Optimizer.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsOptimizeOptions

Thực thi

Thành viên kế thừa

Các hàm khởi tạo

OptimizeOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.OptimizeOptions với các tùy chọn mặc định. Tuyến tính hóa tài liệu để

  • mở trang đầu tiên nhanh nhất có thể;
  • hiển thị trang tiếp theo hoặc theo đường dẫn đến trang tiếp theo nhanh nhất có thể;
  • hiển thị trang theo từng phần khi nó đến khi dữ liệu cho một trang được chuyển giao qua kênh chậm (hiển thị dữ liệu hữu ích nhất trước);
  • cho phép tương tác với người dùng, chẳng hạn như theo một liên kết, được thực hiện ngay cả trước khi toàn bộ trang đã được nhận và hiển thị.
public OptimizeOptions()

Namespace: Documentize Assembly: Documentize.dll

Lớp PdfAConvertOptions

Thông tin

Đại diện cho các tùy chọn để chuyển đổi tài liệu PDF sang định dạng PDF/A với plugin Documentize.PdfAConverter.

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions  

Kế thừa

object
PdfAOptionsBase
PdfAConvertOptions

Thực hiện

Các thành viên kế thừa

Bộ xây dựng

PdfAConvertOptions()

public PdfAConvertOptions()  

Thuộc tính

Outputs

Lấy bộ sưu tập các mục tiêu đã thêm (tài liệu hoặc nguồn dữ liệu luồng) cho kết quả lưu hoạt động.

public List<idatasource> Outputs { get; }  

Giá trị thuộc tính

List<IDataSource>

Phương thức

AddOutput(IDataSource)

Thêm mục tiêu lưu kết quả mới.

public void AddOutput(IDataSource dataSource)  

Tham số

  • dataSource IDataSource: Mục tiêu (tài liệu hoặc nguồn dữ liệu luồng) để lưu kết quả hoạt động. :

Namespace: Documentize
Assembly: Documentize.dll

Lớp PdfAOptionsBase

Thông tin

Đại diện cho lớp cơ sở cho tùy chọn plugin Documentize.PdfAConverter. Lớp này cung cấp các thuộc tính và phương thức để cấu hình quá trình chuyển đổi và xác thực PDF/A.

Đại diện cho lớp cơ sở cho tùy chọn plugin Documentize.PdfAConverter.
Lớp này cung cấp các thuộc tính và phương thức để cấu hình quá trình chuyển đổi và xác thực PDF/A.

public abstract class PdfAOptionsBase : IPluginOptions  

Kế thừa

object
PdfAOptionsBase

Kế thừa

Thực hiện

Thành viên được kế thừa

Các hàm khởi tạo

PdfAOptionsBase()

protected PdfAOptionsBase()  

Các thuộc tính

AlignText

Lấy hoặc thiết lập một giá trị cho biết liệu có cần phương tiện bổ sung để bảo tồn sự căn chỉnh văn bản trong quá trình chuyển đổi PDF/A hay không.

public bool AlignText { get; set; }  

Giá trị thuộc tính

bool

Ghi chú

Khi được đặt thành true, quá trình chuyển đổi sẽ cố gắng phục hồi ranh giới của đoạn văn bản gốc.
Đối với hầu hết các tài liệu, không cần phải thay đổi thuộc tính này từ giá trị mặc định false,
vì sự căn chỉnh văn bản không thay đổi trong quá trình chuyển đổi mặc định.

CheckDifferentNamesInFontDictionaries

Lấy các cờ điều khiển chuyển đổi PDF/A cho các trường hợp khi tài liệu PDF nguồn không tương ứng với thông số kỹ thuật PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }  

Giá trị thuộc tính

bool

ErrorAction

Lấy hoặc thiết lập hành động sẽ được thực hiện cho các đối tượng không thể được chuyển đổi.

public ConvertErrorAction ErrorAction { get; set; }  

Giá trị thuộc tính

ConvertErrorAction

IccProfileFileName

Lấy hoặc thiết lập tên tệp của hồ sơ ICC (International Color Consortium) sẽ được sử dụng cho quá trình chuyển đổi PDF/A thay cho hồ sơ mặc định.

public string IccProfileFileName { get; set; }  

Giá trị thuộc tính

string

Inputs

Lấy tập hợp các nguồn dữ liệu

public List<idatasource> Inputs { get; }  

Giá trị thuộc tính

List<IDataSource>

IsLowMemoryMode

Lấy hoặc thiết lập một giá trị cho biết liệu chế độ bộ nhớ thấp có được kích hoạt trong quá trình chuyển đổi PDF/A hay không.

public bool IsLowMemoryMode { get; set; }  

Giá trị thuộc tính

bool

LogOutputSource

Lấy hoặc thiết lập nguồn dữ liệu cho đầu ra log.

public IDataSource LogOutputSource { get; set; }  

Giá trị thuộc tính

IDataSource

OptimizeFileSize

Lấy hoặc thiết lập một giá trị cho biết có nên cố gắng giảm kích thước tệp trong quá trình chuyển đổi PDF/A hay không.

public bool OptimizeFileSize { get; set; }  

Giá trị thuộc tính

bool

Ghi chú

Khi được đặt thành true, quá trình chuyển đổi sẽ cố gắng giảm thiểu kích thước tệp kết quả.
Điều này có thể ảnh hưởng đến hiệu suất quá trình chuyển đổi.

PdfAVersion

Lấy hoặc thiết lập phiên bản tiêu chuẩn PDF/A sẽ được sử dụng cho việc xác thực hoặc chuyển đổi.

public PdfAStandardVersion PdfAVersion { get; set; }  

Giá trị thuộc tính

PdfAStandardVersion

Ghi chú

Phiên bản tiêu chuẩn PDF/A được sử dụng để xác định mức độ tuân thủ cho việc xác thực và chuyển đổi PDF/A.
Nếu phiên bản được đặt thành Documentize.PdfAStandardVersion.Auto, hệ thống sẽ tự động xác định
phiên bản tiêu chuẩn PDF/A phù hợp cho việc xác thực dựa trên siêu dữ liệu tài liệu.
Đối với quá trình chuyển đổi PDF/A, Documentize.PdfAStandardVersion.Auto mặc định là phiên bản tiêu chuẩn PDF/A-1b.

SoftMaskAction

Lấy hoặc thiết lập hành động sẽ được thực hiện trong quá trình chuyển đổi hình ảnh với mặt nạ mềm.

public ConvertSoftMaskAction SoftMaskAction { get; set; }  

Giá trị thuộc tính

ConvertSoftMaskAction

Các phương thức

AddInput(IDataSource)

Thêm nguồn dữ liệu mới vào bộ sưu tập

public void AddInput(IDataSource dataSource)  

Tham số

Namespace: Documentize
Assembly: Documentize.dll

Lớp PdfChatGpt

Thông tin

Đại diện cho plugin PdfChatGpt.

public sealed class PdfChatGpt : IDisposable  

Kế thừa

object
PdfChatGpt

Thực hiện

Thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách sử dụng plugin PdfChatGpt bằng cách thêm tin nhắn vào yêu cầu.

using (var plugin = new PdfChatGpt())  
{  
    var options = new PdfChatGptRequestOptions();  
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Thêm đường dẫn tệp đầu ra.  
    options.ApiKey = "Khóa API của bạn."; // Bạn cần cung cấp khóa để truy cập API.  
    options.MaxTokens = 1000; // Số lượng tối đa token để tạo trong hoàn thành trò chuyện.  
  
    // Thêm các tin nhắn yêu cầu.  
    options.Messages.Add(new Message  
    {  
        Content = "Bạn là một trợ lý hữu ích.",  
        Role = Role.System  
    });  
    options.Messages.Add(new Message  
    {  
        Content = "Đường kính pizza lớn nhất từng được làm là bao nhiêu?",  
        Role = Role.User  
    });  
  
    // Xử lý yêu cầu.  
    var result = await plugin.ProcessAsync(options);  
  
    var fileResultPath = result.ResultCollection[0].Data;  
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Đối tượng hoàn thành trò chuyện của API ChatGPT.  
}  

Ví dụ này minh họa cách sử dụng plugin PdfChatGpt bằng cách thêm một tin nhắn vào yêu cầu.

using (var plugin = new PdfChatGpt())  
{  
    var options = new PdfChatGptRequestOptions();  
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Thêm đường dẫn tệp đầu ra.  
    options.ApiKey = "Khóa API của bạn."; // Bạn cần cung cấp khóa để truy cập API.  
    options.MaxTokens = 1000; // Số lượng tối đa token để tạo trong hoàn thành trò chuyện.  
  
    // Thêm tin nhắn yêu cầu.  
    // Trong trường hợp này, tin nhắn hệ thống với nội dung = "Bạn là một trợ lý hữu ích." được thêm vào mặc định.  
    // Vai trò của tin nhắn truy vấn là "người dùng" theo mặc định.  
    options.Query = "Nhiệt độ thấp nhất đã được ghi nhận trên Trái Đất là bao nhiêu?";  
  
    // Xử lý yêu cầu.  
    var result = await plugin.ProcessAsync(options);  
  
    var fileResultPath = result.ResultCollection[0].Data;  
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Đối tượng hoàn thành trò chuyện của API ChatGPT.  
}  

Ví dụ này minh họa cách sử dụng plugin PdfChatGpt bằng cách thêm tệp là nguồn tin nhắn.

using (var plugin = new PdfChatGpt())  
{  
    var options = new PdfChatGptRequestOptions();  
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Thêm đường dẫn tệp đầu ra.  
  
    // Thêm nguồn văn bản PDF.  
    // Trong trường hợp có nhiều nguồn, văn bản từ mỗi tài liệu sẽ được thêm vào bộ sưu tập tin nhắn yêu cầu  
    // dưới dạng một tin nhắn riêng biệt với vai trò "người dùng".  
    options.AddInput(new FileDataSource("TextSource.pdf"));  
  
    options.ApiKey = "Khóa API của bạn."; // Bạn cần cung cấp khóa để truy cập API.  
    options.MaxTokens = 1000; // Số lượng tối đa token để tạo trong hoàn thành trò chuyện.  
  
    // Thêm tin nhắn yêu cầu.  
    // Trong trường hợp này, tin nhắn hệ thống với nội dung = "Bạn là một trợ lý hữu ích." được thêm vào mặc định.  
    // Vai trò của tin nhắn truy vấn là "người dùng" theo mặc định.  
    options.Query = "Có bao nhiêu chữ cái trong văn bản đã cung cấp?";  
  
    // Xử lý yêu cầu.  
    var result = await plugin.ProcessAsync(options);  
  
    var fileResultPath = result.ResultCollection[0].Data;  
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Đối tượng hoàn thành trò chuyện của API ChatGPT.  
}  

Nhận xét

Đối tượng Documentize.PdfChatGpt được sử dụng để gửi yêu cầu trực tiếp đến ChatGPT
hoặc bằng cách thêm các nguồn tệp PDF và lưu lại phản hồi vào nguồn đầu ra.

Bộ khởi tạo

PdfChatGpt()

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfChatGpt.

public PdfChatGpt()  

Phương thức

Dispose()

Triển khai IDisposable. Thực tế, không cần thiết cho PdfChatGpt.

public void Dispose()  

Process(IPluginOptions)

Phương thức này không có phiên bản đồng bộ. Sử dụng phương thức ProcessAsync thay vào đó.

public ResultContainer Process(IPluginOptions options)  

Tham số

  • options IPluginOptions: Một đối tượng tùy chọn chứa hướng dẫn cho PdfChatGpt.

Trả về

ResultContainer : #### Ngoại lệ

NotImplementedException

ProcessAsync(IPluginOptions)

Bắt đầu quá trình PdfChatGpt với các tham số đã chỉ định.

public Task<resultcontainer> ProcessAsync(IPluginOptions options)  

Tham số

  • options IPluginOptions: Một đối tượng tùy chọn chứa hướng dẫn cho PdfChatGpt.

Trả về

Task<ResultContainer>

Đối tượng tác vụ đại diện cho hoạt động bất đồng bộ.

Ngoại lệ

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Thiết lập token hủy bỏ.

public void SetCancellationToken(CancellationToken cancellationToken)  

Tham số

Namespace: Documentize
Assembly: Documentize.dll

Lớp PdfChatGptOptions

Thông tin

Đại diện cho các tùy chọn cho plugin Documentize.PdfChatGpt.

public class PdfChatGptOptions : IPluginOptions

Kế thừa

objectPdfChatGptOptions

Kế thừa

Thực hiện

Thành viên kế thừa

Các hàm khởi tạo

PdfChatGptOptions()

Khởi tạo một phiên bản mới của đối tượng Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Thuộc tính

Inputs

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

List<IDataSource>

Phương thức

AddInput(IDataSource)

Thêm nguồn dữ liệu mới vào bộ sưu tập dữ liệu của plugin PdfChatGpt.

public void AddInput(IDataSource dataSource)

Tham số

  • dataSource IDataSource: Nguồn dữ liệu (tệp hoặc luồng) để thêm.

AddOutput(IDataSource)

Thêm nguồn dữ liệu lưu mới vào bộ sưu tập dữ liệu của plugin PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Tham số

  • saveDataSource IDataSource: Nguồn dữ liệu (tệp hoặc luồng) để lưu kết quả hoạt động. :

Không gian tên: Documentize Thư viện: Documentize.dll

Lớp PdfChatGptRequestOptions

Thông tin

Đại diện cho các tùy chọn cho plugin Documentize.PdfChatGpt.

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Kế thừa

objectPdfChatGptOptionsPdfChatGptRequestOptions

Thực hiện

Các thành viên kế thừa

Các hàm khởi tạo

PdfChatGptRequestOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfChatGptRequestOptions với các tùy chọn mặc định.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfChatGptRequestOptions với các tùy chọn.

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

Các tham số

Thuộc tính

ApiKey

Lấy hoặc thiết lập khóa để truy cập API ChatGPT.

public string ApiKey { get; set; }

Giá trị thuộc tính

string

ApiUrl

Lấy hoặc thiết lập URL API ChatGPT.

public string ApiUrl { get; set; }

Giá trị thuộc tính

string

MaxTokens

Số lượng tối đa token trong phản hồi. Giá trị mặc định là null, có nghĩa là vô tận.

public int? MaxTokens { get; set; }

Giá trị thuộc tính

int?

Messages

Lấy hoặc thiết lập một bộ sưu tập của các đối tượng Documentize.Message.

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

Giá trị thuộc tính

List<Message>

Model

Thiết lập hoặc lấy ID của mô hình sẽ sử dụng.

public string Model { get; set; }

Giá trị thuộc tính

string

NumberOfChoices

Số lượng lựa chọn hoàn thành chat để tạo cho mỗi tin nhắn đầu vào.

public int NumberOfChoices { get; set; }

Giá trị thuộc tính

int

Query

Lấy hoặc thiết lập chuỗi yêu cầu đến ChatGPT. Nếu không rỗng, đây là tin nhắn đầu tiên trong bộ sưu tập, sẽ được gửi trong yêu cầu.

public string Query { get; set; }

Giá trị thuộc tính

string

Temperature

Nhiệt độ lấy mẫu để sử dụng, từ 0 đến 2. Giá trị cao như 0.8 sẽ làm cho đầu ra trở nên ngẫu nhiên hơn, trong khi các giá trị thấp như 0.2 sẽ làm cho nó trở nên tập trung và xác định hơn. Giá trị mặc định là 1.

public double Temperature { get; set; }

Giá trị thuộc tính

double

Namespace: Documentize Assembly: Documentize.dll

Lớp PdfConverterOptions

Thông tin

Đại diện cho các tùy chọn cho các plugin chuyển đổi Pdf.

public abstract class PdfConverterOptions : IPluginOptions  

Kế thừa

object
PdfConverterOptions

Được dẫn xuất

Triển khai

Thành viên được kế thừa

Thuộc tính

Inputs

Trả về bộ sưu tập dữ liệu plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }  

Giá trị thuộc tính

List<IDataSource>

Outputs

Lấy bộ sưu tập các mục tiêu đã thêm cho kết quả hoạt động lưu trữ.

public List<idatasource> Outputs { get; }  

Giá trị thuộc tính

List<IDataSource>

Phương thức

AddInput(IDataSource)

Thêm nguồn dữ liệu mới vào bộ sưu tập dữ liệu của plugin PdfConverter.

public void AddInput(IDataSource dataSource)  

Tham số

  • dataSource IDataSource: Nguồn dữ liệu để thêm.

AddOutput(IDataSource)

Thêm nguồn dữ liệu mới vào bộ sưu tập dữ liệu của plugin PdfToXLSXConverterOptions.

public void AddOutput(IDataSource saveDataSource)  

Tham số

  • saveDataSource IDataSource: Nguồn dữ liệu (tệp hoặc luồng) để lưu kết quả hoạt động.

Ngoại lệ

NotImplementedException

Namespace: Documentize
Assembly: Documentize.dll

Lớp PdfExtractor

Thông tin

Đại diện cho chức năng cơ bản để trích xuất văn bản, hình ảnh và các loại nội dung khác có thể xuất hiện trên các trang của tài liệu PDF.

public abstract class PdfExtractor : IDisposable

Kế thừa

objectPdfExtractor

Được kế thừa

Triển khai

Các thành viên kế thừa

Ví dụ

Ví dụ minh họa cách trích xuất nội dung văn bản của tài liệu PDF.

// tạo đối tượng TextExtractor để trích xuất nội dung PDF
using (TextExtractor extractor = new TextExtractor())
{
    // tạo đối tượng TextExtractorOptions để thiết lập hướng dẫn
    textExtractorOptions = new TextExtractorOptions();

    // thêm đường dẫn tệp đầu vào
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // thực hiện quy trình trích xuất
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

    // lấy văn bản đã trích xuất từ đối tượng ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Nhận xét

Đối tượng Documentize.TextExtractor được sử dụng để trích xuất văn bản, hoặc Documentize.ImageExtractor để trích xuất hình ảnh.

Các hàm khởi tạo

PdfExtractor()

protected PdfExtractor()

Phương thức

Dispose()

Triển khai của IDisposable. Trên thực tế, không cần thiết cho PdfExtractor.

public void Dispose()

Process(IPluginOptions)

Bắt đầu quy trình PdfExtractor với các tham số được chỉ định.

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

Tham số

  • pdfExtractorOptions IPluginOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho PdfExtractor.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của quá trình trích xuất.

Namespace: Documentize Assembly: Documentize.dll

Lớp PdfExtractorOptions

Thông tin

Đại diện cho các tùy chọn cho các plugin TextExtractor và ImageExtractor.

public abstract class PdfExtractorOptions : IPluginOptions

Kế thừa

objectPdfExtractorOptions

Kế thừa

Thực hiện

Thành viên kế thừa

Nhận xét

Documentize.PdfExtractorOptions chứa các chức năng cơ bản để thêm dữ liệu (tệp, luồng) đại diện cho các tài liệu PDF đầu vào. Vui lòng tạo Documentize.TextExtractorOptions hoặc ImageExtractorOptions thay vì cái này.

Thuộc tính

Inputs

Trả về bộ sưu tập dữ liệu plugin PdfExtractor.

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

List<IDataSource>

OperationName

Trả về tên hoạt động

public virtual string OperationName { get; }

Giá trị thuộc tính

string

Phương pháp

AddInput(IDataSource)

Thêm nguồn dữ liệu mới vào bộ sưu tập dữ liệu plugin PdfExtractor.

public void AddInput(IDataSource dataSource)

Tham số

  • dataSource IDataSource: Nguồn dữ liệu để thêm. :

Namespace: Documentize Assembly: Documentize.dll

Lớp PdfToDocOptions

Thông tin

Đại diện cho các tùy chọn chuyển đổi PDF sang DOC cho plugin Documentize.DocConverter.

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions  

Kế thừa

object
PdfConverterOptions
PdfToDocOptions

Thực thi

Các thành viên kế thừa

Các hàm khởi tạo

PdfToDocOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToDocOptions với các tùy chọn mặc định.

public PdfToDocOptions()  

Namespace: Documentize
Assembly: Documentize.dll

Lớp PdfToJpegOptions

Thông tin

Đại diện cho các tùy chọn chuyển đổi PDF sang JPEG cho plugin Documentize.JpegConverter.

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions  

Kế thừa

object
PluginBaseOptions
PdfToJpegOptions

Triển khai

Thành viên kế thừa

Các hàm khởi tạo

PdfToJpegOptions()

Khởi tạo một phiên bản mới của đối tượng Documentize.PdfToJpegOptions.

public PdfToJpegOptions()  

Các thuộc tính

OutputResolution

Lấy hoặc đặt giá trị độ phân giải của các hình ảnh kết quả.

public int OutputResolution { get; set; }  

Giá trị thuộc tính

int

PageList

Lấy hoặc đặt danh sách các trang cho quy trình.

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

Giá trị thuộc tính

List<int>

Quality

Lấy và đặt chất lượng đầu ra.

public int Quality { get; set; }  

Giá trị thuộc tính

int

Namespace: Documentize
Assembly: Documentize.dll

Lớp PdfToPngOptions

Thông tin

Đại diện cho tùy chọn chuyển đổi PDF sang PNG cho plugin Documentize.PngConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsPdfToPngOptions

Triển khai

Các thành viên kế thừa

Constructors

PdfToPngOptions()

Khởi tạo một phiên bản mới của đối tượng Documentize.PdfToPngOptions.

public PdfToPngOptions()

Properties

OutputResolution

Lấy hoặc thiết lập giá trị độ phân giải của các hình ảnh kết quả.

public int OutputResolution { get; set; }

Giá trị thuộc tính

int

PageList

Lấy hoặc thiết lập danh sách các trang cho quá trình.

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

Giá trị thuộc tính

List<int>

Namespace: Documentize Assembly: Documentize.dll

Lớp PdfToTiffOptions

Thông tin

Đại diện cho các tùy chọn chuyển đổi PDF sang TIFF cho plugin Documentize.TiffConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsPdfToTiffOptions

Triển khai

Thành viên được kế thừa

Constructors

PdfToTiffOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToTiffOptions.

public PdfToTiffOptions()

Thuộc tính

MultiPage

Lấy và thiết lập cờ cho phép lưu tất cả các trang trong một tiff đa trang.

public bool MultiPage { get; set; }

Giá trị thuộc tính

bool

OutputResolution

Lấy hoặc thiết lập giá trị độ phân giải của các hình ảnh kết quả.

public int OutputResolution { get; set; }

Giá trị thuộc tính

int

PageList

Lấy hoặc thiết lập danh sách các trang cho quá trình.

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

Giá trị thuộc tính

List<int>

Namespace: Documentize Assembly: Documentize.dll

Lớp PdfToXlsOptions

Thông tin

Đại diện cho các tùy chọn chuyển đổi PDF sang XLSX cho plugin Documentize.XlsConverter.

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions  

Kế thừa

object
PdfConverterOptions
PdfToXlsOptions

Triển khai

Các thành viên kế thừa

Các nhà xây dựng

PdfToXlsOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToXlsOptions với các tùy chọn mặc định.

public PdfToXlsOptions()  

Thuộc tính

Format

Định dạng đầu ra.

public PdfToXlsOptions.ExcelFormat Format { get; set; }  

Giá trị thuộc tính

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Đặt true nếu bạn cần chèn cột trắng làm cột đầu tiên của bảng tính.
Giá trị mặc định là false; điều đó có nghĩa là cột trắng sẽ không bị chèn.

public bool InsertBlankColumnAtFirst { get; set; }  

Giá trị thuộc tính

bool

MinimizeTheNumberOfWorksheets

Đặt true nếu bạn cần giảm thiểu số lượng bảng tính trong sổ làm việc kết quả.
Giá trị mặc định là false; điều đó có nghĩa là lưu mỗi trang PDF dưới dạng bảng tính riêng biệt.

public bool MinimizeTheNumberOfWorksheets { get; set; }  

Giá trị thuộc tính

bool

Namespace: Documentize
Assembly: Documentize.dll

Lớp PluginBaseOptions

Thông tin

Đại diện cho các tùy chọn cơ bản cho các plugin.

public class PluginBaseOptions : IPluginOptions

Kế thừa

objectPluginBaseOptions

Kế thừa

Thực hiện

Thành viên kế thừa

Thuộc tính

CloseInputStreams

Đóng các luồng đầu vào sau khi hoàn thành thao tác.

public bool CloseInputStreams { get; set; }

Giá trị thuộc tính

bool

CloseOutputStreams

Đóng các luồng đầu ra sau khi hoàn thành thao tác.

public bool CloseOutputStreams { get; set; }

Giá trị thuộc tính

bool

Inputs

Trả về dữ liệu Inputs cho thao tác.

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

List<IDataSource>

Outputs

Trả về dữ liệu Outputs cho thao tác.

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

List<IDataSource>

Phương thức

AddInput(IDataSource)

Thêm dữ liệu mới vào Inputs.

public void AddInput(IDataSource dataSource)

Tham số

AddOutput(IDataSource)

Thêm dữ liệu mới vào Outputs.

public void AddOutput(IDataSource saveDataSource)

Tham số

Không gian tên: Documentize Thư viện: Documentize.dll

Lớp PngConverter

Thông tin

Đại diện cho plugin Documentize.PngConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng PNG.

public sealed class PngConverter

Kế thừa

objectPngConverter

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách chuyển đổi tài liệu PDF thành định dạng PNG.

// tạo PngConverter
var plugin = new PngConverter();
// tạo đối tượng PdfToPngOptions để thiết lập hướng dẫn
var opt = new PdfToPngOptions();
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new DirectoryDataSource(outputPath));
// thực hiện quy trình
plugin.Process(opt);

Các hàm khởi tạo

PngConverter()

public PngConverter()

Các phương thức

Process(PdfToPngOptions)

Bắt đầu quá trình xử lý của Documentize.PngConverter với các tham số được chỉ định.

public ResultContainer Process(PdfToPngOptions options)

Tham số

  • options PdfToPngOptions: Một đối tượng tùy chọn chứa hướng dẫn cho Documentize.PngConverter.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của thao tác.

Namespace: Documentize Assembly: Documentize.dll

Lớp RotateOptions

Thông tin

Đại diện cho các tùy chọn xoay cho plugin Documentize.Optimizer.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsRotateOptions

Cài đặt

Thành viên kế thừa

Constructors

RotateOptions()

Khởi tạo một instance mới của đối tượng Documentize.RotateOptions với các tùy chọn mặc định.

public RotateOptions()

Thuộc tính

Rotation

Lấy hoặc thiết lập xoay trang mới.

public Rotation Rotation { get; set; }

Giá trị thuộc tính

Rotation

Namespace: Documentize Assembly: Documentize.dll

Lớp StreamDataSource

Thông tin

Đại diện cho nguồn dữ liệu luồng cho các thao tác tải và lưu của một plugin.

public sealed class StreamDataSource : IDataSource

Kế thừa

objectStreamDataSource

Thực hiện

Thành viên kế thừa

Constructor

StreamDataSource(Stream)

Khởi tạo nguồn dữ liệu luồng mới với đối tượng luồng được chỉ định.

public StreamDataSource(Stream data)

Tham số

  • data Stream: Đối tượng luồng

Thuộc tính

Data

Lấy đối tượng luồng của nguồn dữ liệu hiện tại.

public Stream Data { get; }

Giá trị thuộc tính

Stream

DataType

Loại nguồn dữ liệu (luồng).

public DataType DataType { get; }

Giá trị thuộc tính

DataType

Tên không gian: Documentize Assembly: Documentize.dll

Lớp StringResult

Thông tin

Đại diện cho kết quả thao tác dưới hình thức chuỗi.

public sealed class StringResult : IOperationResult

Kế thừa

objectStringResult

Triển khai

Thành viên kế thừa

Thuộc tính

Data

Lấy dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

object

IsFile

Chỉ ra liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.

public bool IsFile { get; }

Giá trị thuộc tính

bool

IsStream

Chỉ ra liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.

public bool IsStream { get; }

Giá trị thuộc tính

bool

IsString

Chỉ ra liệu kết quả có phải là một chuỗi hay không.

public bool IsString { get; }

Giá trị thuộc tính

bool

Text

Trả về đại diện chuỗi của kết quả.

public string Text { get; }

Giá trị thuộc tính

string

Phương thức

ToFile()

Cố gắng chuyển đổi kết quả thành tệp.

public string ToFile()

Trả về

string : Một chuỗi đại diện cho đường dẫn đến tệp đầu ra nếu kết quả là tệp; ngược lại trả về null.

ToStream()

Cố gắng chuyển đổi kết quả thành một đối tượng luồng.

public Stream ToStream()

Trả về

Stream : Một đối tượng luồng đại diện cho dữ liệu đầu ra nếu kết quả là luồng; ngược lại trả về null.

ToString()

Cố gắng chuyển đổi kết quả thành một chuỗi.

public override string ToString()

Trả về

string : Một chuỗi đại diện cho nội dung văn bản nếu kết quả là chuỗi; ngược lại trả về base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Lớp TableCellBuilder

Thông tin

Lớp đại diện cho builder cho ô bảng.

public class TableCellBuilder : TableRowBuilder

Kế thừa

objectTableBuilderTableRowBuilderTableCellBuilder

Các thành viên được kế thừa

Phương thức

AddCell()

Thêm ô vào bảng.

public override TableCellBuilder AddCell()

Kết quả

TableCellBuilder : Instance của Documentize.TableCellBuilder hiện tại.

AddParagraph(params string[])

Thêm đoạn văn vào ô bảng.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Tham số

  • paragraphs string[]: Văn bản cho các đoạn văn.

Kết quả

TableCellBuilder : Instance của Documentize.TableCellBuilder hiện tại.

Tên không gian: Documentize Assembly: Documentize.dll

Lớp TableRowBuilder

Thông tin

Lớp đại diện cho builder cho hàng bảng.

public class TableRowBuilder : TableBuilder

Kế thừa

objectTableBuilderTableRowBuilder

Kế thừa

Thành viên đã kế thừa

Phương thức

AddCell()

Thêm ô vào hàng bảng.

public virtual TableCellBuilder AddCell()

Trả về

TableCellBuilder : Instance của Documentize.TableCellBuilder được tạo ra.

AddRow()

Ghi đè AddRow.

public override TableRowBuilder AddRow()

Trả về

TableRowBuilder : Instance của Documentize.TableRowBuilder hiện tại.

Namespace: Documentize Assembly: Documentize.dll

Lớp TextExtractor

Thông tin

Đại diện cho plugin Documentize.TextExtractor. Được sử dụng để trích xuất văn bản từ tài liệu PDF.

public class TextExtractor : PdfExtractor, IDisposable

Kế thừa

objectPdfExtractorTextExtractor

Triển khai

Các thành viên kế thừa

Ví dụ

Ví dụ dưới đây minh họa cách trích xuất nội dung văn bản của tài liệu PDF.

// tạo đối tượng TextExtractor để trích xuất văn bản trong nội dung PDF
using (var plugin = new TextExtractor())
{
    // tạo TextExtractorOptions
    var opt = new TextExtractorOptions();

    // thêm đường dẫn tệp đầu vào
    opt.AddInput(new FileDataSource(inputPath));

    // thực hiện quá trình trích xuất
    var resultContainer = plugin.Process(opt);

    // lấy văn bản đã được trích xuất từ đối tượng ResultContainer
    var textExtracted = resultContainer.ResultCollection[0].ToString();
}

Các hàm khởi tạo

TextExtractor()

public TextExtractor()

Namespace: Documentize Assembly: Documentize.dll

Lớp TextExtractorOptions

Thông tin

Đại diện cho các tùy chọn trích xuất văn bản cho plugin Documentize.TextExtractor.

public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions

Kế thừa

objectPdfExtractorOptionsTextExtractorOptions

Thực thi

Thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách trích xuất nội dung văn bản của tài liệu PDF.

// tạo đối tượng TextExtractor để trích xuất nội dung PDF
using (TextExtractor extractor = new TextExtractor())
{
    // tạo đối tượng TextExtractorOptions để thiết lập TextFormattingMode (Pure, hoặc Raw - mặc định)
    extractorOptions = new TextExtractorOptions(TextExtractorOptions.TextFormattingMode.Pure);

    // thêm đường dẫn tệp đầu vào vào các nguồn dữ liệu
    extractorOptions.AddInput(new FileDataSource(inputPath));

    // thực hiện quá trình trích xuất
    ResultContainer resultContainer = extractor.Process(extractorOptions);

    // lấy văn bản đã trích xuất từ đối tượng ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Nhận xét

Đối tượng Documentize.TextExtractorOptions được sử dụng để thiết lập Documentize.TextExtractorOptions.TextFormattingMode và các tùy chọn khác cho hoạt động trích xuất văn bản. Ngoài ra, nó kế thừa các chức năng để thêm dữ liệu (tệp, luồng) đại diện cho các tài liệu PDF đầu vào.

Các hàm khởi tạo

TextExtractorOptions(TextFormattingMode)

Khởi tạo một phiên bản mới của đối tượng Documentize.TextExtractorOptions cho chế độ định dạng văn bản đã chỉ định.

public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)

Tham số

TextExtractorOptions()

Khởi tạo một phiên bản mới của đối tượng Documentize.TextExtractorOptions với chế độ định dạng văn bản ‘Raw’ (mặc định).

public TextExtractorOptions()

Các thuộc tính

FormattingMode

Lấy chế độ định dạng.

public TextExtractorOptions.TextFormattingMode FormattingMode { get; }

Giá trị thuộc tính

TextExtractorOptions.TextFormattingMode

OperationName

Trả về tên của hoạt động.

public override string OperationName { get; }

Giá trị thuộc tính

string

Namespace: Documentize Assembly: Documentize.dll

Lớp TiffConverter

Thông tin

Đại diện cho plugin Documentize.TiffConverter. Được sử dụng để chuyển đổi tài liệu PDF sang định dạng TIFF.

public sealed class TiffConverter

Kế thừa

objectTiffConverter

Các thành viên kế thừa

Ví dụ

Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng TIFF.

// tạo TiffConverter
var plugin = new TiffConverter();
// tạo đối tượng PdfToTiffOptions để thiết lập hướng dẫn
var opt = new PdfToTiffOptions();
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource(inputPath));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new DirectoryDataSource(outputPath));
// thực hiện quá trình
plugin.Process(opt);

Các hàm khởi tạo

TiffConverter()

public TiffConverter()

Phương thức

Process(PdfToTiffOptions)

Bắt đầu quá trình Documentize.TiffConverter với các tham số được chỉ định.

public ResultContainer Process(PdfToTiffOptions options)

Tham số

  • options PdfToTiffOptions: Một đối tượng tùy chọn chứa hướng dẫn cho Documentize.TiffConverter.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của hoạt động.

Namespace: Documentize Assembly: Documentize.dll

Nguồn Dữ Liệu Danh Bạ Lớp

Thông tin

Đại diện cho dữ liệu danh bạ cho các hoạt động tải và lưu của một plugin.

public sealed class DirectoryDataSource : IDataSource

Kế thừa

objectDirectoryDataSource

Triển khai

Thành viên kế thừa

Các trình tạo

DirectoryDataSource(string)

Khởi tạo dữ liệu danh bạ mới với đường dẫn đã chỉ định.

public DirectoryDataSource(string path)

Tham số

  • path string: Một chuỗi đại diện cho đường dẫn đến thư mục.

Thuộc tính

DataType

Loại nguồn dữ liệu.

public DataType DataType { get; }

Giá trị thuộc tính

DataType

Path

Lấy đường dẫn đến thư mục của dữ liệu hiện tại.

public string Path { get; }

Giá trị thuộc tính

string

Không gian tên: Documentize Assembly: Documentize.dll

Thông tin lớp

Thông tin

Lớp cung cấp thông tin về phiên bản sản phẩm hiện tại.

public static class Info

Kế thừa

objectInfo

Các thành viên kế thừa

Các trường

  • AssemblyVersion Phiên bản Assembly.

Giá trị trường

string

Sản phẩm

Tên sản phẩm.

public const string Product = "Documentize"

Giá trị trường

string

Namespace: Documentize Assembly: Documentize.dll

Thông tin trang lớp

Thông tin

Biểu thị thông tin trang.

public class PageInfo : PageSize  

Kế thừa

object
PageSize
PageInfo

Các thành viên được kế thừa

Constructors

PageInfo()

Constructor của Documentize.PageInfo.

public PageInfo()  

PageInfo(double, double)

Constructor của Documentize.PageInfo.

public PageInfo(double width, double height)  

Tham số

  • width double: Chiều rộng của trang.
  • height double: Chiều cao của trang.

Properties

MarginBottom

Lấy hoặc thiết lập một giá trị cho biết lề dưới.

public double MarginBottom { get; set; }  

Giá trị thuộc tính

double

MarginLeft

Lấy hoặc thiết lập một giá trị cho biết lề trái.

public double MarginLeft { get; set; }  

Giá trị thuộc tính

double

MarginRight

Lấy hoặc thiết lập một giá trị cho biết lề phải.

public double MarginRight { get; set; }  

Giá trị thuộc tính

double

MarginTop

Lấy hoặc thiết lập một giá trị cho biết lề trên.

public double MarginTop { get; set; }  

Giá trị thuộc tính

double

Namespace: Documentize
Assembly: Documentize.dll

Timestamp Lớp

Thông tin

Đại diện cho plugin Documentize.Timestamp.

public class Timestamp

Kế thừa

objectTimestamp

Các Thành viên Kế thừa

Ví dụ

Ví dụ này minh họa cách thêm Timestamp vào tài liệu.

// tạo Timestamp
var plugin = new Timestamp();
// tạo đối tượng AddTimestampOptions để thiết lập hướng dẫn
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// thêm đường dẫn tệp đầu vào
opt.AddInput(new FileDataSource("path_to_pdf"));
// thiết lập đường dẫn tệp đầu ra
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// thực hiện quá trình
plugin.Process(opt);

Các Hàm Khởi Tạo

Timestamp()

public Timestamp()

Các Phương Thức

Process(AddTimestampOptions)

Bắt đầu quá trình Documentize.Timestamp với các tham số đã chỉ định.

public ResultContainer Process(AddTimestampOptions options)

Tham số

  • options AddTimestampOptions: Một đối tượng tùy chọn chứa các hướng dẫn cho Documentize.AddTimestampOptions.

Trả về

ResultContainer : Một đối tượng ResultContainer chứa kết quả của thao tác.

Không gian tên: Documentize Assembly: Documentize.dll

Tin nhắn lớp

Thông tin

Một tin nhắn hoàn thành trò chuyện được tạo ra bởi mô hình.

public class Message

Kế thừa

objectMessage

Các thành viên kế thừa

Các hàm khởi tạo

Message()

public Message()

Thuộc tính

Nội dung

Nội dung của tin nhắn.

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

Giá trị thuộc tính

string

Vai trò

Thiết lập hoặc lấy vai trò của tác giả của tin nhắn này.

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

Giá trị thuộc tính

Role

Namespace: Documentize Assembly: Documentize.dll

Tùy chọn bảng lớp

Thông tin

Đại diện cho các tùy chọn để thêm bảng vào tài liệu bằng plugin Documentize.TableGenerator.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions  

Kế thừa

object
PluginBaseOptions
TableOptions

Cài đặt

Thành viên kế thừa

Hàm khởi dựng

TableOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.TableOptions với các tùy chọn mặc định.

public TableOptions()  

Phương thức

AddTable()

Thêm bảng vào tài liệu.

public TableBuilder AddTable()  

Trả về

TableBuilder : Thể hiện mới của Documentize.TableBuilder.

Create()

Tạo thể hiện của Documentize.TableOptions.

public static TableOptions Create()  

Trả về

TableOptions : Thể hiện mới của Documentize.TableOptions.

InsertPageAfter(int)

Chèn trang sau trang được chỉ định.

public TableOptions InsertPageAfter(int page)  

Tham số

  • page int: Số trang để chèn bảng sau.

Trả về

TableOptions : Thể hiện của Documentize.TableOptions hiện tại.

InsertPageBefore(int)

Chèn trang trước trang được chỉ định.

public TableOptions InsertPageBefore(int page)  

Tham số

  • page int: Số trang để chèn bảng trước.

Trả về

TableOptions : Thể hiện của Documentize.TableOptions hiện tại.

Namespace: Documentize
Assembly: Documentize.dll

Tùy chọn Chia lớp

Thông tin

Đại diện cho tùy chọn Chia cho plugin Documentize.Splitter.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsSplitOptions

Triển khai

Thành viên Kế thừa

Constructors

SplitOptions()

Khởi tạo một instance mới của đối tượng Documentize.SplitOptions với các tùy chọn mặc định.

public SplitOptions()

Không gian tên: Documentize Assembly: Documentize.dll

Tùy chọn kích thước lớp

Thông tin

Đại diện cho các tùy chọn thay đổi kích thước cho plugin Documentize.Optimizer.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsResizeOptions

Triển khai

Các thành viên kế thừa

Các khái niệm tạo

ResizeOptions()

Khởi tạo một thể hiện mới của đối tượng Documentize.ResizeOptions với các tùy chọn mặc định.

public ResizeOptions()

Thuộc tính

PageSize

Lấy hoặc thiết lập kích thước trang mới.

public PageSize PageSize { get; set; }

Giá trị thuộc tính

PageSize

Không gian tên: Documentize Tập tin: Documentize.dll

Tùy chọn ký lớp

Thông tin

Đại diện cho Tùy chọn Ký cho tài liệu Documentize.Signature.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions  

Kế thừa

object
PluginBaseOptions
SignOptions

Triển khai

Các Thành viên Kế thừa

Các Bộ dựng

SignOptions(string, string)

Khởi tạo một instance mới của đối tượng Documentize.SignOptions với các tùy chọn mặc định.

public SignOptions(string pfx, string password)  

Tham số

  • pfx string: Đường dẫn đến tệp pfx.
  • password string: Mật khẩu cho tệp pfx.

SignOptions(Stream, string)

Khởi tạo một instance mới của đối tượng Documentize.SignOptions với các tùy chọn mặc định.

public SignOptions(Stream pfx, string password)  

Tham số

  • pfx Stream: Luồng với tệp pfx.
  • password string: Mật khẩu cho tệp pfx.

Thuộc tính

Contact

Liên hệ của chữ ký.

public string Contact { get; set; }  

Giá trị thuộc tính

string

Location

Vị trí của chữ ký.

public string Location { get; set; }  

Giá trị thuộc tính

string

Name

Tên của trường chữ ký hiện có.
Null để tạo một trường mới.

public string Name { get; set; }  

Giá trị thuộc tính

string

PageNumber

Số trang mà trên đó chữ ký được thực hiện.

public int PageNumber { get; set; }  

Giá trị thuộc tính

int

Reason

Lý do của chữ ký.

public string Reason { get; set; }  

Giá trị thuộc tính

string

Rectangle

Hình chữ nhật của chữ ký.

public Rectangle Rectangle { get; set; }  

Giá trị thuộc tính

Rectangle

Visible

Tính khả thi của chữ ký.

public bool Visible { get; set; }  

Giá trị thuộc tính

bool

Namespace: Documentize
Assembly: Documentize.dll

Vòng xoay Enum

Thông tin

Liệt kê các giá trị vòng xoay có thể có.

public enum Rotation

Fields

  • None = 0: Không xoay.
  • On180 = 2: Xoay 180 độ.
  • On270 = 3: Xoay 270 độ theo chiều kim đồng hồ.
  • On360 = 4: Xoay 360 độ theo chiều kim đồng hồ.
  • On90 = 1: Xoay 90 độ theo chiều kim đồng hồ.

Namespace: Documentize Assembly: Documentize.dll

 Tiếng Việt