Tài liệu Namespace

Classes

Class NameDescription
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 hoạt động 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 sang đị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 hoạt động tải và lưu của một plugin.
FileResultĐại diện cho kết quả hoạt động dưới dạng đường dẫn chuỗi đến tệp.
FormExportToDsvOptionsĐại diện cho các tùy chọn xuất giá trị của các trường cho plugin Documentize.FormExporter.
FormExporterĐại diện cho plugin Documentize.FormExporter. Được sử dụng để xuất các giá trị biểu mẫu của tài liệu PDF sang tệp DSV hoặc CSV.
FormFlattenerĐại diện cho plugin Documentize.FormFlattener. Được sử dụng để làm phẳng các trường trong tài liệu PDF.
FormFlattenerOptionsĐại diện cho các tùy chọn làm phẳng các trường trong tài liệu bởi plugin Documentize.FormFlattener.
HtmlConverterĐại diện cho plugin Documentize.HtmlConverter. Được sử dụng để chuyển đổi tài liệu PDF sang định dạng HTML và tài liệu HTML sang đị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 này 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 sang đị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 Ghé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 PDF duy nhất.
MessageMột thông điệp hoàn thành trò chuyện do mô hình tạo ra.
ObjectResultĐại diện cho kết quả hoạt động 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. Được sử dụng để Tối ưu hóa, Xoay, Thay đổi kích thước, Nén tài liệu PDF.
PageInfoĐại diện cho thông tin trang.
PageSizeLớp đại diện cho kích thước của 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 sang đị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 sang định dạng PDF/A và để xác thực sự tuân thủ PDF/A.
PdfAOptionsBaseĐại diện cho lớp cơ sở cho các tùy chọn của 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.
PdfAValidateOptionsĐạ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.
PdfAValidationResultĐại diện cho kết quả của một quá trình xác thực 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.
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 XLS/XLSX cho plugin Documentize.XlsConverter.
PluginBaseOptionsĐại diện cho các tùy chọn cơ sở cho các plugin.
PngConverterĐại diện cho plugin Documentize.PngConverter. Được sử dụng để chuyển đổi tài liệu PDF sang đị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 một container chứa tập hợp kết quả của quá trình 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. Được sử dụng để mã hóa và giải mã tài liệu PDF.
SignOptionsĐại diện cho các tùy chọn Ký cho plugin Documentize.Signature.
SignatureĐại diện cho plugin Documentize.Signature. Được sử dụng để Ký tài liệu PDF.
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 PDF thành các trang riêng biệt.
StreamDataSourceĐại diện cho nguồn dữ liệu stream cho các hoạt động tải và lưu của một plugin.
StreamResultĐại diện cho kết quả hoạt động dưới dạng Stream.
StringResultĐại diện cho kết quả hoạt động dưới dạng chuỗi.
TableBuilderLớp đại diện cho trình xây dựng cho bảng trong trang PDF.
TableCellBuilderLớp đại diện cho trình xây dựng cho ô 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ởi plugin Documentize.TableGenerator.
TableRowBuilderLớp đại diện cho trình xây dựng cho 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ừ các 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 sang định dạng TIFF.
TimestampĐại diện cho plugin Documentize.Timestamp.
TocGeneratorĐại diện cho plugin Documentize.TocGenerator. Được sử dụng để thêm Mục lục vào tài liệu PDF.
TocHeadingĐại diện cho các tùy chọn cho tiêu đề hoặc tiêu đề của Mục lục cho tài liệu bởi plugin Documentize.TocGenerator.
TocOptionsĐại diện cho các tùy chọn để thêm Mục lục vào tài liệu bởi plugin Documentize.TocGenerator.
XlsConverterĐại diện cho plugin Documentize.XlsConverter. Được sử dụng để chuyển đổi tài liệu PDF sang định dạng XLSX/XLS.

Interfaces

Interface NameDescription
IDataSourceGiao diện dữ liệu chung xác định các thành viên chung mà dữ liệu cụ thể nên triển khai.
IOperationResultGiao diện kết quả hoạt động chung xác định các phương thức chung mà kết quả hoạt động của plugin cụ thể nên triển khai.
IPluginOptionsGiao diện tùy chọn plugin chung xác định các phương thức chung mà tùy chọn plugin cụ thể nên triển khai.

Enums

Enum NameDescription
ConvertErrorActionLớp này đại diện cho hành động cho các 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 với mặt nạ mềm.
DataTypeĐại diện cho các loại dữ liệu khả thi cho xử lý plugin.
PdfToXlsOptions.ExcelFormatCho phép chỉ định định dạng tệp xls/xlsx/xml/csv. Giá trị mặc định là XLSX.
HtmlMediaTypeChỉ định các loại phương tiện khả thi được sử dụng trong quá trình kết xuất.
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à cấu trúc của các trang.
PdfAStandardVersionChỉ định phiên bản tiêu chuẩn PDF/A cho một tài liệu PDF.
RoleVai trò của tác giả thông điệp.
RotationLiệt kê các giá trị xoay khả thi.
PdfToHtmlOptions.SaveDataTypeXác định loại đầu ra của tệp HTML.
TextFormattingModeXác định các chế độ khác nhau có thể được sử dụng trong khi chuyển đổi một tài liệu PDF thành văn bản. Xem lớp Documentize.TextExtractorOptions.
TiffColorDepthĐược sử dụng để chỉ định Độ sâu Màu cho Documentize.PdfToTiffOptions.
TiffCompressionĐược sử dụng để chỉ định loại Nén cho Documentize.PdfToTiffOptions.

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

Chữ ký của Lớp

Thông tin

Đại diện cho plugin Documentize.Signature. Dùng để ký các tài liệu PDF.

public static class Signature

Kế thừa

objectSignature

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

Ví dụ

Ví dụ dưới đây minh họa cách để ký tài liệu PDF.

// Tạo đối tượng SignOptions để thiết lập hướng dẫn
var options = new SignOptions("path_to_your_pfx_file.pfx", "passwprd_of_your_pfx_file");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Signature.Process(options);

Ví dụ dưới đây minh họa cách để ký tài liệu PDF với các tùy chọn bổ sung.

// Tạo đối tượng SignOptions để thiết lập hướng dẫn
var options = new SignOptions("path_to_your_pfx_file.pfx", "passwprd_of_your_pfx_file");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Các tham số tùy chọn
options.Reason = "lý do của tôi";
options.Contact = "liên lạc của tôi";
options.Location = "vị trí của tôi";
options.PageNumber = 3;
// Thực hiện quá trình
Signature.Process(options);

Phương thức

Process(SignOptions)

Ký tài liệu PDF.

public static ResultContainer Process(SignOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class AddTimestampOptions

Thông tin

Đại diện cho tùy chọn thêm thời gian cho plugin Documentize.Timestamp.

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsAddTimestampOptions

Triển khai

Thành viên kế thừa

Các hàm dựng

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 tùy chọn mặc định.

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

Tham số

  • pfx Stream: Đường dẫn tới tệp pfx.
  • password string: Mật khẩu cho tệp pfx.
  • serverUrl string: Đường dẫn máy chủ 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 một 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 tùy chọn mặc định.

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

Tham số

  • pfx string: Đường dẫn tới tệp pfx.
  • password string: Mật khẩu cho tệp pfx.
  • serverUrl string: Đường dẫn máy chủ 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 một chuỗi “username:password”. (Tùy chọn).

Namespace: Documentize Assembly: Documentize.dll

Class 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

objectPluginBaseOptionsCompressOptions

Triển khai

Thành viên kế thừa

Constructors

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

Class 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

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

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

DecryptionOptions(string)

Khởi tạo một thể hiện 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 của chủ sở hữu.

Thuộc tính

OwnerPassword

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

public string OwnerPassword { get; set; }

Giá trị thuộc tính

string

Namespace: Documentize Assembly: Documentize.dll

Class DirectoryDataSource

Thông tin

Đạ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.

public sealed class DirectoryDataSource : IDataSource

Kế thừa

objectDirectoryDataSource

Thực hiện

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

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

DirectoryDataSource(string)

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

public DirectoryDataSource(string path)

Tham Số

  • path string: Một chuỗi đại diện cho đường dẫn tới 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 tới thư mục 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

Class 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

objectDocConverter

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

Ví dụ

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

// Khởi tạo DocConverter
var plugin = new DocConverter();
// Tạo đối tượng PdfToDocOptions để thiết lập hướng dẫn
var options = new PdfToDocOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_input.doc"));
// Thực hiện quá trình
plugin.Process(options);

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

DocConverter()

public DocConverter()

Các phương thức

Dispose()

Triển khai của IDisposable.

public void Dispose()

Process(PdfToDocOptions)

Chuyển đổi tài liệu PDF sang định dạng DOC/DOCX.

public ResultContainer Process(PdfToDocOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class EncryptionOptions

Thông tin

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

csharp
public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsEncryptionOptions

Triển khai

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

Các hàm khởi 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.

csharp
public EncryptionOptions(string ownerPassword, string userPassword)

Tham số

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

Thuộc tính

OwnerPassword

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

csharp
public string OwnerPassword { get; set; }

Giá trị thuộc tính

string

UserPassword

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

csharp
public string UserPassword { get; set; }

Giá trị thuộc tính

string

Namespace: Documentize Assembly: Documentize.dll

Class 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

Thực thi

Thành viên kế thừa

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

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.

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

Class FileResult

Thông tin

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

public sealed class FileResult : IOperationResult

Kế thừa

objectFileResult

Thực hiện

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

Các thuộc tính

Data

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à 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

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

Các 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; ngược lại 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 null.

Namespace: Documentize Assembly: Documentize.dll

Class FormExporter

Thông tin

Đại diện cho plugin Documentize.FormExporter. Sử dụng để xuất các giá trị Form của tài liệu PDF sang tệp DSV hoặc CSV.

public static class FormExporter

Kế thừa

objectFormExporter

Thành viên kế thừa

Ví dụ

Ví dụ minh họa cách xuất các giá trị Form sang tệp CSV.

// Tạo đối tượng FormExportToDsvOptions để đặt hướng dẫn
var options = new FormExportToDsvOptions(',', true);
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// Thực hiện quá trình
FormExporter.Process(options);

Phương thức

Process(FormExportToDsvOptions)

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

public static ResultContainer Process(FormExportToDsvOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class FormExportToDsvOptions

Thông tin

Đại diện cho các tùy chọn để xuất giá trị của các trường cho plugin Documentize.FormExporter.

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsFormExportToDsvOptions

Triển khai

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

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

FormExportToDsvOptions(char, bool)

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

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

Tham số

  • delimeter char: Chỉ định dấu phân cách được sử dụng trong dữ liệu xuất giữa các giá trị. Giá trị mặc định là ‘,’.
  • addFieldNames bool: Thêm tên trường trước giá trị. Định dạng: Tên + dấu phân cách + Giá trị + dấu phân cách.

Các thuộc tính

AddFieldName

Thêm tên trường trước giá trị. Định dạng: Tên + dấu phân cách + Giá trị + dấu phân cách.

public bool AddFieldName { get; set; }

Giá trị thuộc tính

bool

Delimeter

Dấu phân cách được sử dụng cho các giá trị xuất.

public char Delimeter { get; set; }

Giá trị thuộc tính

char

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattener

Thông tin

Đại diện cho plugin Documentize.FormFlattener. Dùng để làm phẳng các trường trong tài liệu PDF.

public static class FormFlattener

Kế thừa

objectFormFlattener

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

Ví dụ

Ví dụ này minh họa cách làm phẳng các trường trong tệp PDF.

// Tạo đối tượng FormFlattenerOptions để thiết lập hướng dẫn
var options = new FormFlattenerOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
FormFlattener.Process(options);

Ví dụ này minh họa cách làm phẳng các trường trong tệp PDF và bỏ qua trường đầu tiên.

// Lấy tên các trường
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Tạo đối tượng FormFlattenerOptions để thiết lập hướng dẫn
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Bỏ qua 1 trường.
options.SkipFields.Add(fieldNames[0]);
// Thực hiện quá trình
FormFlattener.Process(options);

Ví dụ này minh họa cách lấy tên trường từ tệp PDF.

// Lấy tên các trường
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Phương thức

GetFieldNames(string)

Lấy tên các trường trong tài liệu PDF.

public static List<string> GetFieldNames(string path)

Tham số

  • path string: Đường dẫn đến tài liệu PDF.

Trả về

List<string>

Danh sách tên trong tài liệu PDF.

GetFieldNames(Stream) : Lấy tên các trường trong tài liệu PDF.

public static List<string> GetFieldNames(Stream stream)

Tham số

  • stream Stream: Luồng chứa tài liệu PDF.

Trả về

List<string>

Danh sách tên trong tài liệu PDF.

Process(FormFlattenerOptions) : Làm phẳng các trường biểu mẫu trong tài liệu PDF.

public static ResultContainer Process(FormFlattenerOptions options)

Tham số

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattenerOptions

Thông tin

Đại diện cho các tùy chọn để làm phẳng các trường trong tài liệu bằng plugin Documentize.FormFlattener.

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsFormFlattenerOptions

Triển khai

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

Các bộ tạo

FormFlattenerOptions()

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

public FormFlattenerOptions()

Thuộc tính

SkipFields

Danh sách các trường sẽ không được làm phẳng.

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

Giá trị thuộc tính

List<string>

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

Class HtmlConverter

Thông tin

Đại diện cho plugin Documentize.HtmlConverter. Dùng để chuyển đổi tài liệu PDF sang định dạng HTML và tài liệu HTML sang định dạng PDF.

public static class HtmlConverter

Kế thừa

objectHtmlConverter

Thành viên kế thừa

Ví dụ

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

// Tạo đối tượng PdfToHtmlOptions để thiết lập kiểu dữ liệu đầu ra là tệp với tài nguyên nhúng
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_output.html"));
// Thực hiện quá trình
HtmlConverter.Process(options);

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

// Tạo HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.html"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Thực hiện quá trình
HtmlConverter.Process(options);

Phương thức

Process(PdfToHtmlOptions)

Chuyển đổi tài liệu PDF sang định dạng HTML.

public static ResultContainer Process(PdfToHtmlOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Process(HtmlToPdfOptions)

Chuyển đổi tài liệu HTML sang định dạng PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

Thông tin

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

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsHtmlToPdfOptions

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

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 đặt các loại phương tiện có thể sử dụng trong quá trình dựng.

public HtmlMediaType HtmlMediaType { get; set; }

Giá trị thuộc tính

HtmlMediaType

IsRenderToSinglePage

Lấy hoặc đặt việc dựng tất cả tài liệu trên một trang duy nhất.

public bool IsRenderToSinglePage { get; set; }

Giá trị thuộc tính

bool

PageInfo

Lấy hoặc đặt 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 đặt tùy chọn bố cục.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Giá trị thuộc tính

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class 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 static class ImageExtractor

Kế thừa

objectImageExtractor

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

Ví dụ

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

// Tạo ImageExtractorOptions để thiết lập hướng dẫn
var options = new ImageExtractorOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Thực hiện quy trình
var results = ImageExtractor.Process(options);
// Lấy đường dẫn đến kết quả hình ảnh
var imageExtracted = results.ResultCollection[0].ToFile();

Phương thức

Process(ImageExtractorOptions)

Trích xuất hình ảnh từ tài liệu PDF.

public static ResultContainer Process(ImageExtractorOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tham số options không được thiết lập.

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 : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsImageExtractorOptions

Triển khai

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

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

ImageExtractorOptions()

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

public ImageExtractorOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Info

Thông tin

Lớp này cung cấp thông tin về bản xây dựng 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

Trường

  • AssemblyVersion Phiên bản lắp ráp.

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

Không gian tên: Documentize Lắp ráp: Documentize.dll

Class 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 static 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 đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToJpegOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
JpegConverter.Process(options);

Ví dụ này minh họa cách chuyển đổi tài liệu PDF thành định dạng JPEG với các cài đặt cho các trang, độ phân giải, chất lượng.

// Tạo đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToJpegOptions();
// Chỉ xử lý trang đầu tiên
options.PageList = [1];
// Thiết lập độ phân giải đầu ra là 200 DPI
options.OutputResolution = 200;
// Thiết lập chất lượng đầu ra là 50
options.Quality = 50;
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
JpegConverter.Process(options);

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

// Tạo đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToJpegOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thực hiện quá trình
var results = JpegConverter.Process(options);
// Lấy kết quả luồng
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Phương thức

Process(PdfToJpegOptions)

Chuyển đổi tài liệu PDF sang định dạng JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn chưa được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class License

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

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

Ví dụ

Cho thấy 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 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 ngắn. Sử dụng chuỗi trống để chuyển sang chế độ đánh giá.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

Thông tin

Đại diện cho các tùy chọn hợp nhất cho plugin Documentize.Merger.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsMergeOptions

Triển khai

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

Các nhà xây dựng

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

Class Merger

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 static class Merger

Kế thừa

objectMerger

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

Các ví dụ

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

// Tạo đối tượng MergeOptions để đặt hướng dẫn
var options = new MergeOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Merger.Process(options);

Các phương thức

Process(MergeOptions)

Hợp nhất các tài liệu PDF.

public static ResultContainer Process(MergeOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class Message

Thông tin

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

public class Message

Kế thừa

objectMessage

Thành viên Được 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

Class ObjectResult

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

Triển khai

Thành viên được 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

Cho biết 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

IsObject

Cho biết liệu 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

IsStream

Cho biết 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

Cho biết 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 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, 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; nếu không, 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; nếu không, trả về base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class 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

object
PluginBaseOptions
OptimizeOptions

Triển khai

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

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

OptimizeOptions()

Khởi tạo một phiên bản mới của đối tượng Documentize.OptimizeOptions với các tùy chọn mặc định.
Linear hóa tài liệu để

  • mở trang đầu tiên càng nhanh càng tốt;
  • hiển thị trang tiếp theo hoặc theo liên kết đến trang tiếp theo càng nhanh càng tốt;
  • hiển thị trang một cách dần dần khi dữ liệu cho một trang được truyền qua một kênh chậm (hiển thị dữ liệu hữu ích nhất trước);
  • cho phép tương tác của người dùng, chẳng hạn như theo 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

Class Optimizer

Thông tin

Đại diện cho plugin Documentize.Optimizer. Được sử dụng để Tối ưu hóa, Xoay, Thay đổi kích thước, Nén tài liệu PDF.

public static class Optimizer

Kế thừa

objectOptimizer

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 đối tượng OptimizeOptions để thiết lập hướng dẫn
var options = new OptimizeOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Optimizer.Process(options);

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

// Tạo đối tượng RotateOptions để thiết lập hướng dẫn
var options = new RotateOptions();
// Thiết lập Xoay mới
options.Rotation = Rotation.On90;
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Optimizer.Process(options);

Ví dụ này minh họa cách thay đổi kích thước tài liệu PDF.

// Tạo đối tượng ResizeOptions để thiết lập hướng dẫn
var options = new ResizeOptions();
// Thiết lập Kích thước trang mới
options.PageSize = PageSize.A3;
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Optimizer.Process(options);

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

// Tạo đối tượng CompressOptions để thiết lập hướng dẫn
var options = new CompressOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Optimizer.Process(options);

Phương thức

Process(OptimizeOptions)

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

public static ResultContainer Process(OptimizeOptions options)

Tham số

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

Trả về

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

Process(RotateOptions)

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

public static ResultContainer Process(RotateOptions options)

Tham số

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

Trả về

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

Process(ResizeOptions)

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

public static ResultContainer Process(ResizeOptions options)

Tham số

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

Trả về

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

Process(CompressOptions)

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

public static ResultContainer Process(CompressOptions options)

Tham số

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

Trả về

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

Namespace: Documentize Assembly: Documentize.dll

Class PageInfo

Thông tin

Đại diện cho thông tin trang.

public class PageInfo : PageSize

Kế thừa

objectPageSizePageInfo

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

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

PageInfo()

Hàm khởi tạo của Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Hàm khởi tạo 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.

Các thuộc tính

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

Class PageSize

Thông tin

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

public class PageSize

Kế thừa

objectPageSize

Được dẫn xuất

Thành viên kế thừa

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

PageSize()

Hàm khởi tạo của Documentize.PageSize. Kích thước A4 theo mặc định.

public PageSize()

PageSize(double, double)

Hàm khởi tạo 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 thiết lập chiều cao trang.

public double Height { get; set; }

Giá trị thuộc tính

double

IsLandscape

Lấy hướng trang. Trả về true nếu đây là hướng ngang và false nếu đây là hướ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

PageLedger

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

PageLetter

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 thiết lập chiều rộng trang.

public double Width { get; set; }

Giá trị thuộc tính

double

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

Thông tin

Đại diện cho một plugin để xử lý việc chuyển đổi các tài liệu PDF ở định dạng PDF/A và để xác minh tính tuân thủ của 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 minh tính 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 minh
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

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

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

// Chạy xác minh và nhận kết quả
var resultContainer = plugin.Process(options);

// Kiểm tra thuộc tính resultContainer.ResultCollection để xem kết quả xác minh cho từng tệp:
for (var i = 0; i &lt; resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Kết quả xác minh 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 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()

Phương thức

Process(IPluginOptions)

Bắt đầu một quy trình chuyển đổi hoặc xác minh 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 Documentize.PdfAValidateOptions.

Trả về

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

Namespace: Documentize Assembly: Documentize.dll

Class 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

objectPdfAOptionsBasePdfAConvertOptions

Thực hiện

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

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

PdfAConvertOptions()

public PdfAConvertOptions()

Các thuộc tính

Outputs

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

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

List<IDataSource>

Các phương thức

AddOutput(IDataSource)

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

public void AddOutput(IDataSource dataSource)

Các tham số

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

Thông tin

Đại diện cho lớp cơ sở cho các tùy chọn của 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 quy trình chuyển đổi PDF/A và xác thực.

Đại diện cho lớp cơ sở cho các tùy chọn của 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 quy trình chuyển đổi PDF/A và xác thực.

public abstract class PdfAOptionsBase : IPluginOptions

Kế thừa

objectPdfAOptionsBase

Kế thừa từ

Thực hiện

Thành viên kế thừa

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Thuộc tính

AlignText

Lấy hoặc đặt giá trị cho biết xem có cần các phương tiện bổ sung để giữ nguyên căn chỉnh văn bản trong quy trình chuyển đổi PDF/A hay không.

public bool AlignText { get; set; }

Giá trị thuộc tính

bool

Nhận xét

Khi được đặt thành true, quy trình chuyển đổi sẽ cố gắng khôi phục lại các giới hạn 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 thiết phải thay đổi thuộc tính này từ giá trị mặc định false, vì căn chỉnh văn bản không thay đổi trong quy trình chuyển đổi mặc định.

CheckDifferentNamesInFontDictionaries

Lấy các cờ điều khiển quy trình 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 đặc tả PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Giá trị thuộc tính

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Giá trị thuộc tính

ConvertErrorAction

IccProfileFileName

Lấy hoặc đặt tên tệp của hồ sơ ICC (International Color Consortium) sẽ được sử dụng cho quy 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 đặt giá trị cho biết xem chế độ bộ nhớ thấp có được kích hoạt trong quy 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 đặt nguồn dữ liệu cho đầu ra nhật ký.

public IDataSource LogOutputSource { get; set; }

Giá trị thuộc tính

IDataSource

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Giá trị thuộc tính

bool

Nhận xét

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

PdfAVersion

Lấy hoặc đặt phiên bản của tiêu chuẩn PDF/A sẽ được sử dụng để xác thực hoặc chuyển đổi.

public PdfAStandardVersion PdfAVersion { get; set; }

Giá trị thuộc tính

PdfAStandardVersion

Nhận xét

Phiên bản tiêu chuẩn PDF/A được sử dụng để xác định mức độ tuân thủ cho 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 thích hợp cho việc xác thực dựa trên siêu dữ liệu của tài liệu. Đối với quy 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 đặt hành động sẽ 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

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

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

objectPdfAOptionsBasePdfAValidateOptions

Thực thi

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

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

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidationResult

Thông tin

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

public sealed class PdfAValidationResult

Kế thừa

objectPdfAValidationResult

Thành viên kế thừa

Các trường

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

Giá trị trường

IDataSource

IsValid

Lấy một 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 cho việc xác thực.

public readonly PdfAStandardVersion StandardVersion

Giá trị trường

PdfAStandardVersion

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

Class PdfChatGpt

Thông tin

Đại diện cho plugin PdfChatGpt.

public sealed class PdfChatGpt : IDisposable

Kế thừa

objectPdfChatGpt

Thực hiện

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

Ví dụ

Ví dụ này minh hoạ 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 = "Your API key."; // Bạn cần cung cấp khóa để truy cập API.
    options.MaxTokens = 1000; // Số lượng token tối đa để tạo trong phần 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 API ChatGPT.
}

Ví dụ này minh hoạ 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 = "Your API key."; // Bạn cần cung cấp khóa để truy cập API.
    options.MaxTokens = 1000; // Số lượng token tối đa để tạo trong phần 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 Content = "Bạn là một trợ lý hữu ích." được thêm mặc định.
    // Vai trò của tin nhắn truy vấn là "user" 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 API ChatGPT.
}

Ví dụ này minh hoạ 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
    // như một tin nhắn riêng biệt với vai trò "user".
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "Your API key."; // Bạn cần cung cấp khóa để truy cập API.
    options.MaxTokens = 1000; // Số lượng token tối đa để tạo trong phần 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 Content = "Bạn là một trợ lý hữu ích." được thêm mặc định.
    // Vai trò của tin nhắn truy vấn là "user" 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 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 phản hồi vào nguồn đầu ra.

Các phương thức khởi tạo

PdfChatGpt()

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

public PdfChatGpt()

Các phương thức

Dispose()

Triển khai IDisposable. Trên thực tế, nó 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 thế.

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 xử lý PdfChatGpt với các tham số được 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.

public void SetCancellationToken(CancellationToken cancellationToken)

Tham số

Namespace: Documentize Assembly: Documentize.dll

Class 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 từ

Thực hiện

Thành viên kế thừa

Constructors

PdfChatGptOptions()

Khởi tạo một thể hiệ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 tập hợ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 tập hợ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) cho các kết quả của thao tác lưu. :

Namespace: Documentize Assembly: Documentize.dll

Class 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

Implements

Thành viên được 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)

Tham số

Thuộc tính

ApiKey

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

public string ApiKey { get; set; }

Giá trị thuộc tính

string

ApiUrl

Lấy hoặc thiết lập URL của 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ô hạ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á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ử 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 gửi đến ChatGPT. Nếu không trố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, giữa 0 và 2. Giá trị cao hơn như 0.8 sẽ khiến đầu ra ngẫu nhiên hơn, trong khi giá trị thấp hơn như 0.2 sẽ làm cho 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

Class 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

objectPdfConverterOptions

Dẫn xuất

Thực thi

Thành viên kế thừa

Thuộc tính

Inputs

Trả về bộ dữ liệu plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

List<IDataSource>

Outputs

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

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ộ dữ liệu 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ộ dữ liệu 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

Class 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

objectPdfConverterOptionsPdfToDocOptions

Thực hiện

Thành viên kế thừa

Các nhà xây dựng

PdfToDocOptions()

Khởi tạo một instance 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

Class PdfToHtmlOptions

Thông tin

Biểu diễn các tùy chọn chuyển đổi PDF sang HTML cho plugin Documentize.HtmlConverter.

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsPdfToHtmlOptions

Thực thi

Thành viên kế thừa

Constructors

PdfToHtmlOptions(SaveDataType)

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

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

Tham số

Thuộc tính

OutputDataType

Lấy kiểu dữ liệu đầu ra.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Giá trị thuộc tính

PdfToHtmlOptions.SaveDataType

Namespace: Documentize Assembly: Documentize.dll

Class 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

objectPluginBaseOptionsPdfToJpegOptions

Triển khai

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

Constructors

PdfToJpegOptions()

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

public PdfToJpegOptions()

Properties

OutputResolution

Lấy hoặc thiết lập giá trị độ phân giải của những 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>

Quality

Lấy và thiết lập chất lượng đầu ra. Xác định mức độ nén cho một hình ảnh. Phạm vi các giá trị hữu ích cho chất lượng là từ 0 đến 100. Số càng thấp, mức nén càng cao và do đó chất lượng hình ảnh càng thấp. Số không sẽ mang lại cho bạn hình ảnh có chất lượng thấp nhất và 100 là chất lượng cao nhất.

public int Quality { get; set; }

Giá trị thuộc tính

int

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPngOptions

Thông tin

Đại diện cho các 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

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

PdfToPngOptions()

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

public PdfToPngOptions()

Các thuộc tính

OutputResolution

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

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>

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

Class 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

Thực thi

Thành viên kế thừa

Nhà xây dựng

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

ColorDepth

Lấy hoặc thiết lập độ sâu màu.

public TiffColorDepth ColorDepth { get; set; }

Giá trị thuộc tính

TiffColorDepth

Nhận xét

Giá trị mặc định là Documentize.TiffColorDepth.Format32bpp.

Compression

Lấy hoặc thiết lập loại nén.

public TiffCompression Compression { get; set; }

Giá trị thuộc tính

TiffCompression

Nhận xét

Giá trị mặc định là Documentize.TiffCompression.LZW.

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. Giá trị mặc định là false.

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

Class PdfToXlsOptions

Thông tin

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

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

Kế thừa

objectPdfConverterOptionsPdfToXlsOptions

Thực thi

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

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

PdfToXlsOptions()

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

public PdfToXlsOptions()

Các 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 là 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 này có nghĩa là cột trống sẽ không được chèn.

public bool InsertBlankColumnAtFirst { get; set; }

Giá trị thuộc tính

bool

MinimizeTheNumberOfWorksheets

Đặt là true nếu bạn cần giảm thiểu số lượng bảng tính trong sách làm việc kết quả. Giá trị mặc định là false; điều này có nghĩa là lưu mỗi trang PDF như một 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

Class 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

Triển khai

Thành viên kế thừa

Các thuộc tính

CloseInputStreams

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

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 hoạt động.

public bool CloseOutputStreams { get; set; }

Giá trị thuộc tính

bool

Inputs

Trả về dữ liệu Inputs cho hoạt động.

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

List<IDataSource>

Outputs

Trả về dữ liệu Outputs cho hoạt động.

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

List<IDataSource>

Các 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ố

Namespace: Documentize Assembly: Documentize.dll

Class PngConverter

Thông tin

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

public static class PngConverter

Inheritance

objectPngConverter

Inherited Members

Examples

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

// Tạo đối tượng PdfToPngOptions để thiết lập hướng dẫn
var options = new PdfToPngOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Đặt đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
PngConverter.Process(options);

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

// Tạo đối tượng PdfToPngOptions để thiết lập hướng dẫn
var options = new PdfToPngOptions()
// Chỉ xử lý trang đầu tiên
options.PageList = [1];
// Đặt độ phân giải đầu ra là 200 DPI
options.OutputResolution = 200;
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Đặt đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
PngConverter.Process(options);

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

// Tạo đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToPngOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thực hiện quá trình
var results = PngConverter.Process(options);
// Lấy các kết quả stream
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Methods

Process(PdfToPngOptions)

Chuyển đổi tài liệu PDF sang định dạng PNG.

public static ResultContainer Process(PdfToPngOptions options)

Parameters

  • options PdfToPngOptions: 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 chứa kết quả của hoạt động.

Exceptions

ArgumentException

Nếu tùy chọn không được đặt.

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

Thông tin

Class đại diện cho hình chữ nhật.

public class Rectangle

Kế thừa

objectRectangle

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

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

Rectangle(double, double, double, double)

Hàm khởi tạo của Rectangle.

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.

Namespace: Documentize Assembly: Documentize.dll

Class ResizeOptions

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 được kế thừa

Các phương thức khởi tạo

ResizeOptions()

Khởi tạo một phiên bả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

Namespace: Documentize Assembly: Documentize.dll

Class ResultContainer

Thông tin

Đại diện cho container chứa tập hợp kết quả của quá trình 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 tập hợp kết quả của các phép toán

public List<ioperationresult> ResultCollection { get; }

Giá trị thuộc tính

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Class 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

Triển khai

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

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

RotateOptions()

Khởi tạo một thể hiện 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 việc xoay các trang mới.

public Rotation Rotation { get; set; }

Giá trị thuộc tính

Rotation

Namespace: Documentize Assembly: Documentize.dll

Class Security

Thông tin

Đại diện cho plugin Documentize.Security. Được sử dụng để mã hóa và giải mã tài liệu PDF.

public static class Security

Kế thừa

objectSecurity

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

Ví dụ

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

// Tạo đối tượng EncryptionOptions để đặt hướng dẫn
var options = new EncryptionOptions("123456", "qwerty");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Security.Process(options);

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

// Tạo đối tượng DecryptionOptions để đặt hướng dẫn
var options = new DecryptionOptions("123456");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
Security.Process(options);

Phương thức

Process(EncryptionOptions)

Mã hóa tài liệu PDF.

public static ResultContainer Process(EncryptionOptions options)

Tham số

  • options EncryptionOptions: Một đối tượng options chứa hướng dẫn cho hoạt động.

Trả về

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

Ngoại lệ

ArgumentException

Nếu options không được thiết lập.

Process(DecryptionOptions)

Giải mã tài liệu PDF.

public static ResultContainer Process(DecryptionOptions options)

Tham số

  • options DecryptionOptions: Một đối tượng options chứa hướng dẫn cho hoạt động.

Trả về

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

Ngoại lệ

ArgumentException

Nếu options không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

Thông tin

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

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsSignOptions

Thực hiện

Thành viên Kế thừa

Constructors

SignOptions(string, string)

Khởi tạo một thể hiện 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 thể hiện 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: Dòng với tệp pfx.
  • password string: Mật khẩu cho tệp pfx.

Properties

Contact

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

public string Contact { get; set; }

Giá trị thuộc tính

string

Location

Địa điểm 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à 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

Class SplitOptions

Thông tin

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

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsSplitOptions

Thực hiện

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

Các trình khởi tạo

SplitOptions()

Khởi tạo một thể hiện 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

Class Splitter

Thông tin

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

public static class Splitter

Kế thừa

objectSplitter

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

Ví dụ

Ví dụ này mô tả cách chia tách tài liệu PDF.

// Tạo đối tượng SplitOptions để thiết lập chỉ dẫn
var options = new SplitOptions();
// Thêm đường dẫn file đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn file đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// Thực hiện quá trình
Splitter.Process(options);

Phương thức

Process(SplitOptions)

Chia tách tài liệu PDF theo trang.

public static ResultContainer Process(SplitOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class 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 thi

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

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

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

Các thuộc tính

Data

Nhận đố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

Namespace: Documentize Assembly: Documentize.dll

Class 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

Thực hiện

Thành viên kế thừa

Thuộc tính

Data

Nhận dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

object

IsFile

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

public bool IsFile { get; }

Giá trị thuộc tính

bool

IsStream

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

public bool IsStream { get; }

Giá trị thuộc tính

bool

IsString

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

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 xuất 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 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; ngược lại null.

Namespace: Documentize Assembly: Documentize.dll

Class StringResult

Thông tin

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

public sealed class StringResult : IOperationResult

Kế thừa

objectStringResult

Thực hiện

Thành viên được 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ỉ định 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ỉ định 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ỉ định 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

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 trả về 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 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; nếu không trả về base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Thông tin

Lớp đại diện cho builder cho bảng trong trang pdf.

public class TableBuilder

Kế thừa

objectTableBuilder

Kế thừa từ

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

Phương thức

AddRow()

Thêm một 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 một 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 trước.

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 tùy chọn 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 sang PdfGeneratorTableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

Thông tin

Class đại diện cho builder cho ô bảng.

public class TableCellBuilder : TableRowBuilder

Kế thừa

objectTableBuilderTableRowBuilderTableCellBuilder

Các thành phần kế thừa

Phương thức

AddCell()

Thêm ô vào bảng.

public override TableCellBuilder AddCell()

Trả về

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

AddParagraph(params string[])

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

public TableCellBuilder AddParagraph(params string[] paragraphs)

Tham số

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

Trả về

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

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

Thông tin

Đại diện cho plugin Documentize.TableGenerator. 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.

// Khởi tạo TableGenerator
var plugin = new TableGenerator();
// Cấu hình tùy chọn bảng
var options = 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
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Thực hiện quá trình
plugin.Process(options);

Constructors

TableGenerator()

public TableGenerator()

Phương thức

Process(TableOptions)

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

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 hoạt động.

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

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

objectPluginBaseOptionsTableOptions

Triển khai

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

Constructors

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

Kết quả

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

Create()

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

public static TableOptions Create()

Kết quả

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

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.

Kết quả

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.

Kết quả

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

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

Thông tin

Class đại diện cho builder cho hàng bảng.

public class TableRowBuilder : TableBuilder  

Kế thừa

object
TableBuilder
TableRowBuilder

Kế thừa

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

Phương thức

AddCell()

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

public virtual TableCellBuilder AddCell()  

Trả về

TableCellBuilder : Thể hiện của Documentize.TableCellBuilder đã tạo.

AddRow()

Ghi đè AddRow.

public override TableRowBuilder AddRow()  

Trả về

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

Namespace: Documentize
Assembly: Documentize.dll

Class 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 static class TextExtractor

Kế thừa

objectTextExtractor

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

Ví dụ

Ví dụ demonstra 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 TextExtractorOptions để thiết lập hướng dẫn
var options = new TextExtractorOptions(TextFormattingMode.Pure);
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thực hiện quá trình
var results = TextExtractor.Process(options);
// Lấy văn bản đã trích xuất từ đối tượng ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

Phương thức

Process(TextExtractorOptions)

Trích xuất văn bản từ tài liệu PDF.

public static ResultContainer Process(TextExtractorOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class 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

Kế thừa

objectTextExtractorOptions

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

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

TextExtractorOptions(TextFormattingMode)

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

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Các tham số

Các thuộc tính

FormattingMode

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

public TextFormattingMode FormattingMode { get; set; }

Giá trị thuộc tính

TextFormattingMode

Inputs

Trả về dữ liệu Inputs cho hoạt động.

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

List<IDataSource>

Các phương thức

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Các tham số

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

Namespace: Documentize Assembly: Documentize.dll

Class 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 static 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 đối tượng PdfToTiffOptions để đặt hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quy trình
TiffConverter.Process(options);

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

// Tạo đối tượng PdfToTiffOptions để đặt hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Đặt Trang
options.PageList = [1, 3];
// Đặt độ phân giải hình ảnh kết quả
options.OutputResolution = 400;
// Thực hiện quy trình
TiffConverter.Process(options);

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

// Tạo đối tượng PdfToTiffOptions để đặt hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Kích hoạt đầu ra TIFF Đa Trang
options.MultiPage = true;
// Thực hiện quy trình
TiffConverter.Process(options);

Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng TIFF với Tuỳ chỉnh Nén và Độ sâu Màu.

// Tạo đối tượng PdfToTiffOptions để đặt hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Đặt Nén và Độ sâu Màu
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Thực hiện quy trình
TiffConverter.Process(options);

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

// Tạo đối tượng PdfToTiffOptions để đặt hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thực hiện quy trình
var results = TiffConverter.Process(options);
// Lấy kết quả luồng
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Phương thức

Process(PdfToTiffOptions)

Chuyển đổi tài liệu PDF sang định dạng TIFF.

public static ResultContainer Process(PdfToTiffOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn không được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class Timestamp

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.

// create Timestamp
var plugin = new Timestamp();
// create AddTimestampOptions object to set instructions
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// add input file path
opt.AddInput(new FileDataSource("path_to_pdf"));
// set output file path
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// perform the process
plugin.Process(opt);

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 hoạt động.

Namespace: Documentize Assembly: Documentize.dll

Class TocGenerator

Thông tin

Đại diện cho plugin Documentize.TocGenerator. Dùng để thêm mục lục vào tài liệu PDF.

public static class TocGenerator

Kế thừa

objectTocGenerator

Thành viên kế thừa

Ví dụ

Ví dụ dưới đây minh họa cách thêm mục lục vào tệp PDF.

// Tạo đối tượng TocOptions để thiết lập hướng dẫn
var options = new TocOptions();
// Đặt Tiêu đề
options.Title = "Mục lục của tôi";
// Tạo liên kết trong dấu trang
options.GenerateBookmarks = true;
// Thiết kế tiêu đề
options.Headings.Add(new TocHeading("Giới thiệu", 2, false, 1));
options.Headings.Add(new TocHeading("Chương I", 3, true, 1));
options.Headings.Add(new TocHeading("Chương II", 4, true, 1));
options.Headings.Add(new TocHeading("Ví dụ A", 4, true, 2));
options.Headings.Add(new TocHeading("Ví dụ B", 4, true, 2));
options.Headings.Add(new TocHeading("Ví dụ C", 4, true, 2));
options.Headings.Add(new TocHeading("Ví dụ D", 4, true, 2));
options.Headings.Add(new TocHeading("Chương III", 5, true, 1));
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
TocGenerator.Process(options);

Phương thức

Process(TocOptions)

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

public static ResultContainer Process(TocOptions options)

Tham số

  • options TocOptions: Đối tượng tùy chọn 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

Class TocHeading

Thông tin

Biểu thị các tùy chọn cho Tiêu đề hoặc Tiêu đề của Mục lục trong tài liệu bởi plugin Documentize.TocGenerator.

public class TocHeading

Kế thừa

objectTocHeading

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

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

TocHeading(string, int, bool, int)

Khởi tạo một thể hiện mới của Documentize.TocHeading.

public TocHeading(string text, int pageNumber, bool generateNumbering = false, int level = 1)

Tham số

  • text string: Văn bản của Tiêu đề.
  • pageNumber int: Số trang cho liên kết.
  • generateNumbering bool: Sử dụng tạo số.
  • level int: Cấp độ.

Thuộc tính

GenerateNumbering

Sử dụng tạo số. Nếu true, thì việc đánh số sẽ được thực hiện tự động; nếu không, việc đánh số sẽ được thực hiện thủ công.

public bool GenerateNumbering { get; set; }

Giá trị thuộc tính

bool

Level

Cấp độ. Sử dụng cho việc tạo số.

public int Level { get; set; }

Giá trị thuộc tính

int

PageNumber

Số trang cho liên kết.

public int PageNumber { get; set; }

Giá trị thuộc tính

int

Text

Văn bản của Tiêu đề.

public string Text { get; set; }

Giá trị thuộc tính

string

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

Class TocOptions

Thông tin

Đại diện cho các tùy chọn để thêm Mục lục vào tài liệu thông qua plugin Documentize.TocGenerator.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

Kế thừa

objectPluginBaseOptionsTocOptions

Triển khai

Thành viên kế thừa

Các khởi tạo

TocOptions()

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

public TocOptions()

Thuộc tính

GenerateBookmarks

Sử dụng chức năng tạo Bookmarks. Nếu đặt true, thì các Bookmarks sẽ được xóa và tạo lại bởi các Tiêu đề; nếu không, Bookmarks sẽ không thay đổi.

public bool GenerateBookmarks { get; set; }

Giá trị thuộc tính

bool

Headings

Các Tiêu đề của Mục lục.

public List<tocheading> Headings { get; set; }

Giá trị thuộc tính

List<TocHeading>

Title

Tiêu đề của Mục lục.

public string Title { get; set; }

Giá trị thuộc tính

string

Namespace: Documentize Assembly: Documentize.dll

Class XlsConverter

Thông tin

Đạ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.

public static class XlsConverter

Kế thừa

objectXlsConverter

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 XLSX.

// Tạo đối tượng PdfToXlsOptions để thiết lập hướng dẫn
var options = new PdfToXlsOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
XlsConverter.Process(options);

Phương thức

Process(PdfToXlsOptions)

Chuyển đổi tài liệu PDF thành định dạng XLSX/XLS.

public static ResultContainer Process(PdfToXlsOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

Nếu tùy chọn chưa được thiết lập.

Tên không gian: Documentize Tập hợp: Documentize.dll

Enum ConvertErrorAction

Thông tin

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

public enum ConvertErrorAction

Fields

  • Delete = 0
  • None = 1

Namespace: Documentize Assembly: Documentize.dll

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 DataType

Thông tin

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

public enum DataType

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

Thông tin

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

public enum HtmlMediaType

Fields

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

Namespace: Documentize Assembly: Documentize.dll

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ỉ rõ 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 cho biết 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ỉ rằng nội dung của tài liệu sẽ được thay đổi kích thước để phù hợp với trang.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

Thông tin

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

public enum PdfAStandardVersion

Fields

  • 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

Enum PdfToHtmlOptions.SaveDataType

Thông tin

Định nghĩa 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 dòng tệp với tài nguyên nhúng

Namespace: Documentize
Assembly: Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

Thông tin

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

Cho phép chỉ định định dạng tệp xls/xlsx/xml/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) có kích hoạt 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

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

Enum Rotation

Thông tin

Liệt kê các giá trị 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

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

Enum TextFormattingMode

Thông tin

Định nghĩa 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 TextFormattingMode

Fields

  • Flatten = 2: Đại diện cho nội dung PDF với các đoạn văn bản được định vị theo tọa độ của chúng. Nó cơ bản tương tự như chế độ “Raw”. Nhưng trong khi “Raw” tập trung vào việc bảo tồn cấu trúc của các đoạn văn bản (toán tử) trong một tài liệu, “Flatten” tập trung vào việc giữ văn bản theo thứ tự mà nó được đọc.
  • 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 bổ sung để căn chỉnh văn bản theo chiều rộng của trang.
  • Raw = 1: Đại diện cho nội dung PDF như nó là, tức là không có định dạng.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffColorDepth

Thông tin

Sử dụng để chỉ định Độ Sâu Màu cho Documentize.PdfToTiffOptions.

public enum TiffColorDepth

Fields

  • Format1bpp = 4: 1 bit mỗi pixel.
  • Format24bpp = 1: 24 bits mỗi pixel. Rgb.
  • Format32bpp = 0: 32 bits mỗi pixel. Được sử dụng mặc định.
  • Format4bpp = 3: 4 bits mỗi pixel.
  • Format8bpp = 2: 8 bits mỗi pixel.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffCompression

Thông tin

Dùng để chỉ định loại nén cho Documentize.PdfToTiffOptions.

public enum TiffCompression

Fields

  • CCITT3 = 2: Chỉ định sơ đồ nén CCITT3. Có thể được truyền cho bộ mã hóa CCITT3 như một tham số thuộc danh mục Compression.
  • CCITT4 = 1: Chỉ định sơ đồ nén CCITT4. Có thể được truyền cho bộ mã hóa CCITT4 như một tham số thuộc danh mục Compression.
  • LZW = 0: Chỉ định sơ đồ nén LZW. Có thể được truyền cho bộ mã hóa Tiff như một tham số thuộc danh mục Compression.
  • None = 4: Chỉ định không có nén. Có thể được truyền cho bộ mã hóa Tiff như một tham số thuộc danh mục nén.
  • RLE = 3: Chỉ định sơ đồ nén RLE. Có thể được truyền cho bộ mã hóa RLE như một tham số thuộc danh mục Compression.

Namespace: Documentize Assembly: Documentize.dll

Interface IDataSource

Thông tin

Giao 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.

public interface IDataSource

Properties

DataType

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

DataType DataType { get; }

Property Value

DataType

Namespace: Documentize Assembly: Documentize.dll

Interface IOperationResult

Thông tin

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

public interface IOperationResult

Properties

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 một 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

Methods

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; nếu không thì 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; nếu không thì null.

Namespace: Documentize Assembly: Documentize.dll

Interface IPluginOptions

Thông tin

Giao 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.

public interface IPluginOptions

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

 Tiếng Việt