Documentize Namespace

Model

Mô hình được sử dụng cho hoàn thành trò chuyện.

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

Giá trị thuộc tính

Object

Kiểu đối tượng, luôn là chat.completion.

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

Giá trị thuộc tính

SystemFingerprint

Dấu vân tay này đại diện cho cấu hình backend mà mô hình chạy cùng.

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

Giá trị thuộc tính

Usage

Thống kê sử dụng cho yêu cầu hoàn thành.

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

Giá trị thuộc tính

Usage

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptConsts

Thông tin

Lớp này đại diện cho một kho lưu trữ các hằng số.

public static class ChatGptConsts

Kế thừa

object ←
ChatGptConsts

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

Các trường

ApiUrl
```
public static string ApiUrl
```

Giá trị trường

ModelName

public static string ModelName

Giá trị trường

SystemRole

public static string SystemRole

Giá trị trường

SystemRoleDescription

public static string SystemRoleDescription

Giá trị trường

UserRole

public static string UserRole

Giá trị trường

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

Class ChatGptRequestOptions

Thông tin

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

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← ChatGptRequestOptions

Thực thi

IPluginOptions

Thành viên kế thừa

Hàm khởi tạo

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

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

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

Tham số

apiKey string: Khóa để truy cập API ChatGPT.
model string: Tên mô hình ChatGPT. Mô hình mặc định là: gpt-3.5-turbo-1106.
apiUrl string: URL của API ChatGPT. URL mặc định là: https://api.openai.com/v1/chat/completions.
query string: Yêu cầu dạng chuỗi gửi tới ChatGPT.

Thuộc tính

ApiKey

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

public string ApiKey { get; set; }

Giá trị thuộc tính

ApiUrl

Lấy hoặc đặt URL của API ChatGPT.

public string ApiUrl { get; set; }

Giá trị thuộc tính

CancellationToken

Token hủy.

public CancellationToken CancellationToken { get; set; }

Giá trị thuộc tính

CancellationToken

MaxTokens

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

public int? MaxTokens { get; set; }

Giá trị thuộc tính

int?

Messages

Lấy hoặc đặt một tập hợp các đối tượng Documentize.Message.

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

Giá trị thuộc tính

List<Message>

Ghi chú

Khi thêm nhiều tin nhắn vào các tùy chọn, thứ tự trong bộ sưu tập tin nhắn sẽ như sau:

Tin nhắn đầu tiên (nếu có) lấy từ options.Query, đứng trước tin nhắn có nội dung: “You are a helpful assistant.”, và vai trò là “system”.
Sau đó (nếu có) các tin nhắn từ bộ sưu tập options.Messages được thêm vào.
Các tin nhắn từ nguồn tệp (nếu có) được thêm cuối cùng, mỗi tài liệu tạo một đối tượng tin nhắn với vai trò “user”. Nếu không có bất kỳ tin nhắn nào được cung cấp, sẽ ném ArgumentException.

Model

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

public string Model { get; set; }

Giá trị thuộc tính

NumberOfChoices

Số lượng lựa chọn hoàn thành trò chuyện sẽ được tạo cho mỗi tin nhắn đầu vào.

public int NumberOfChoices { get; set; }

Giá trị thuộc tính

Query

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

public string Query { get; set; }

Giá trị thuộc tính

Temperature

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

public double Temperature { get; set; }

Giá trị thuộc tính

Namespace: Documentize
Assembly: Documentize.dll

Class Choice

Thông tin

Một tùy chọn hoàn thành trò chuyện.

public class Choice

Inheritance

object ← Choice

Inherited Members

Constructors

Choice()

public Choice()

Properties

FinishReason

Lý do mà mô hình dừng tạo token.
Điều này sẽ dừng nếu mô hình gặp một điểm dừng tự nhiên hoặc
một chuỗi dừng được cung cấp, hoặc nếu độ dài tối đa của
số token được chỉ định trong yêu cầu đã đạt tới.

[JsonProperty("finish_reason")]
public string FinishReason { get; set; }

Property Value

Index

Chỉ mục của tùy chọn trong danh sách các tùy chọn.

[JsonProperty("index")]
public int Index { get; set; }

Property Value

Message

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

[JsonProperty("message")]
public Message Message { get; set; }

Property Value

Message

Namespace: Documentize
Assembly: Documentize.dll

Class CompressOptions

Thông tin

Đại diện cho các tùy chọn nén cho thành phần Documentize.PdfManager.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← CompressOptions

Thực thi

IPluginOptions

Thành viên kế thừa

Hàm khởi tạo

CompressOptions()

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

public CompressOptions()

Không gian tên: Documentize
Tập tin lắp ráp: 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

object ← PluginBaseOptions ← DecryptionOptions

Triển khai

IPluginOptions

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

Namespace: Documentize Assembly: Documentize.dll

Class DecryptOptions

Thông tin

Biểu diễn các tùy chọn giải mã cho plugin Documentize.PdfSecurity.

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ←
PluginBaseOptions ←
DecryptOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Phương thức khởi tạo

DecryptOptions(string)

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

public DecryptOptions(string ownerPassword)

Tham số

ownerPassword string: Mật khẩu chủ.

Thuộc tính

OwnerPassword

Mật khẩu chủ.

public string OwnerPassword { get; set; }

Giá trị Thuộc tính

Không gian tên: Documentize
Tập tin lắp ráp: Documentize.dll

Class DirectoryData

Thông tin

Biểu diễn dữ liệu thư mục cho các hoạt động tải và lưu.

public sealed class DirectoryData : IData

Kế thừa

object ← DirectoryData

Thực hiện

IData

Thành viên kế thừa

Hàm tạo

DirectoryData(string)

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

public DirectoryData(string path)

Tham số

path string: Chuỗi đại diện cho đường dẫn tới thư mục.

Thuộc tính

DataType

Kiểu nguồn dữ liệu.

public DataType DataType { get; }

Giá trị thuộc tính

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

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

object ← DirectoryDataSource

Thực hiện

IDataSource

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

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

Namespace: Documentize Assembly: Documentize.dll

Class DocConverter

Thông tin

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

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

Kế thừa

object ← DocConverter

Thành viên kế thừa

Phương thức

Process(PdfToDocOptions)

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

public static 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 thao tác.

Giá trị trả về

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

Ngoại lệ

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

object ← PluginBaseOptions ← EncryptionOptions

Triển khai

IPluginOptions

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

UserPassword

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

csharp
public string UserPassword { get; set; }

Giá trị thuộc tính

Namespace: Documentize Assembly: Documentize.dll

Class EncryptOptions

Thông tin

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

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← EncryptOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm tạo

EncryptOptions(string, string)

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

public EncryptOptions(string ownerPassword, string userPassword)

Tham số

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

Thuộc tính

OwnerPassword

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

public string OwnerPassword { get; set; }

Giá trị thuộc tính

UserPassword

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

public string UserPassword { get; set; }

Giá trị thuộc tính

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

Class ExtractFormDataToDsvOptions

Thông tin

Đại diện cho các tùy chọn xuất giá trị của các trường cho các thành phần Documentize.PdfForm và Documentize.PdfExtractor.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implements

IPluginOptions

Inherited Members

Constructors

ExtractFormDataToDsvOptions(char, bool)

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

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

Parameters

delimiter char: Xác định ký tự phân tách sẽ đượ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 + ký tự phân tách + Giá trị + ký tự phân tách.

Properties

AddFieldName

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

public bool AddFieldName { get; set; }

Property Value

Delimiter

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

public char Delimiter { get; set; }

Property Value

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

Thông tin

Đại diện cho các tùy chọn trích xuất hình ảnh cho thành phần Documentize.PdfExtractor.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← ExtractImagesOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm khởi tạo

ExtractImagesOptions()

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

public ExtractImagesOptions()

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

Class ExtractPropertiesOptions

Thông tin

Biểu diễn các tùy chọn khai thác thuộc tính PDF cho thành phần Documentize.PdfExtractor.

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Kế thừa

object ← OptionsWithInput ← ExtractPropertiesOptions

Thực thi

IHaveInput

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

Hàm khởi tạo

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

Khởi tạo một đối tượng Documentize.ExtractPropertiesOptions mới với dữ liệu đầu vào được chỉ định.

public ExtractPropertiesOptions(IData inputData)

Tham số

inputData IData: Dữ liệu đầu vào.

ExtractPropertiesOptions(string)

Khởi tạo một đối tượng Documentize.ExtractPropertiesOptions mới với tệp đầu vào được chỉ định.

public ExtractPropertiesOptions(string inputFile)

Tham số

inputFile string: Đường dẫn tệp đầu vào.

ExtractPropertiesOptions(Stream)

Khởi tạo một đối tượng Documentize.ExtractPropertiesOptions mới với luồng đầu vào được chỉ định.

public ExtractPropertiesOptions(Stream inputStream)

Tham số

inputStream Stream: Luồng đầu vào.

Thuộc tính

Input

Lấy hoặc đặt Dữ liệu đầu vào.

public override IData Input { get; set; }

Giá trị thuộc tính

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

Class ExtractTextOptions

Thông tin

Đại diện cho các tùy chọn trích xuất văn bản cho thành phần Documentize.PdfExtractor.

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Kế thừa

object ← OptionsWithInput ← ExtractTextOptions

Thực hiện

IHaveInput

Thành viên kế thừa

Hàm khởi tạo

ExtractTextOptions(TextFormattingMode)

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

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Tham số

formattingMode TextFormattingMode: Giá trị chế độ định dạng văn bản.

ExtractTextOptions(IData, TextFormattingMode)

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

public ExtractTextOptions(IData data, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Tham số

data IData: Dữ liệu đầu vào.
formattingMode TextFormattingMode: Giá trị chế độ định dạng văn bản.

ExtractTextOptions(string, TextFormattingMode)

Khởi tạo một thể hiện mới của đối tượng Documentize.ExtractTextOptions với tệp được chỉ định.

public ExtractTextOptions(string file, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Tham số

file string: Đường dẫn tệp đầu vào.
formattingMode TextFormattingMode: Giá trị chế độ định dạng văn bản.

ExtractTextOptions(Stream, TextFormattingMode)

Khởi tạo một thể hiện mới của đối tượng Documentize.ExtractTextOptions với luồng được chỉ định.

public ExtractTextOptions(Stream stream, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Tham số

stream Stream: Luồng đầu vào.
formattingMode TextFormattingMode: Giá trị chế độ định dạng văn bản.

Thuộc tính

FormattingMode

Lấy hoặc đặt chế độ định dạng.

public TextFormattingMode FormattingMode { get; set; }

Giá trị thuộc tính

TextFormattingMode

Input

Lấy hoặc đặt dữ liệu đầu vào.

public override IData Input { get; set; }

Giá trị thuộc tính

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

Class FileData

Thông tin

Biểu diễn dữ liệu tệp cho các thao tác tải và lưu.

public sealed class FileData : IData

Kế thừa

object ← FileData

Thực hiện

IData

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

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

FileData(string)

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

public FileData(string path)

Tham số

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

Thuộc tính

DataType

Kiểu của nguồn dữ liệu.

public DataType DataType { get; }

Giá trị thuộc tính

Path

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

public string Path { get; }

Giá trị thuộc tính

Phương thức

ToString()

Chuyển đổi thể hiện thành System.String.

public override string ToString()

Trả về

string : Đường dẫn tới tệp.

Không gian tên: 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

object ← FileDataSource

Thực thi

IDataSource

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

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

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 tệp dạng chuỗi.

public sealed class FileResult : IOperationResult

Inheritance

object ← FileResult

Implements

IOperationResult

Inherited Members

Thuộc tính

Data

Lấy dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

IsFile

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

public bool IsFile { get; }

Giá trị thuộc tính

IsStream

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

public bool IsStream { get; }

Giá trị thuộc tính

IsString

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

public bool IsString { get; }

Giá trị thuộc tính

Phương thức

ToFile()

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

public string ToFile()

Trả về

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

ToStream()

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

public Stream ToStream()

Trả về

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

Namespace: Documentize Assembly: Documentize.dll

Class FlattenFieldsOptions

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 thành phần Documentize.PdfForm.

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← FlattenFieldsOptions

Implements

IPluginOptions

Inherited Members

Constructors

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Properties

SkipFields

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

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

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class FormExporter

Thông tin

Biểu thị 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 file DSV hoặc CSV.

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

Inheritance

object ← FormExporter

Inherited Members

Methods

Process(ExtractFormDataToDsvOptions)

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

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Parameters

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

Returns

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

Exceptions

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

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

object ← PluginBaseOptions ← FormExportToDsvOptions

Triển khai

IPluginOptions

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

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. Được sử dụng để làm phẳng các trường trong tài liệu PDF.

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

Kế thừa

object ← FormFlattener

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

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 tới tài liệu PDF.

Trả về

Danh sách các 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ề

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

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

public static ResultContainer Process(FlattenFieldsOptions options)

Tham số

options FlattenFieldsOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ngoại lệ

Nếu options 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

object ← PluginBaseOptions ← FormFlattenerOptions

Triển khai

IPluginOptions

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

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

Class GetFieldNamesOptions

Thông tin

Đại diện cho các tùy chọn cho Get Field Names trong tài liệu bởi thành phần Documentize.PdfForm.

public class GetFieldNamesOptions : OptionsWithInput, IHaveInput

Inheritance

object ← OptionsWithInput ← GetFieldNamesOptions

Implements

IHaveInput

Inherited Members

Constructors

GetFieldNamesOptions(string)

Phương thức khởi tạo cho các tùy chọn với Đường dẫn đầu vào tới tệp.

public GetFieldNamesOptions(string path)

Parameters

path string: Đường dẫn đầu vào tới tệp.

GetFieldNamesOptions(Stream)

Phương thức khởi tạo cho các tùy chọn với luồng đầu vào.

public GetFieldNamesOptions(Stream stream)

Parameters

stream Stream: Luồng đầu vào.

Properties

Input

Lấy hoặc đặt Dữ liệu đầu vào.

public override IData Input { get; set; }

Property Value

Namespace: Documentize
Assembly: Documentize.dll

Class HtmlConverter

Thông tin

Đại diện 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.

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

Kế thừa

object ← HtmlConverter

Thành viên kế thừa

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: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Kết quả trả về

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

Ngoại lệ

Nếu không thiết lập options.

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: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Kết quả trả về

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

Ngoại lệ

Nếu không thiết lập options.

Tên không gian: 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.PdfConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ←
PluginBaseOptions ←
HtmlToPdfOptions

Thực thi

IPluginOptions

Thành viên kế thừa

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ơ bản cho tệp html.

public string BasePath { get; set; }

Giá trị Thuộc tính

HtmlMediaType

Lấy hoặc đặt các loại media có thể sử dụng trong quá trình render.

public HtmlMediaType HtmlMediaType { get; set; }

Giá trị Thuộc tính

HtmlMediaType

IsRenderToSinglePage

Lấy hoặc đặt việc render toàn bộ tài liệu thành một trang duy nhất.

public bool IsRenderToSinglePage { get; set; }

Giá trị Thuộc tính

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Giá trị Thuộc tính

HtmlPageLayoutOption

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

Class ImageExtractor

Thông tin

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

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

Kế thừa

object ← ImageExtractor

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

Phương thức

Process(ExtractImagesOptions)

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

public static ResultContainer Process(ExtractImagesOptions options)

Tham số

options ExtractImagesOptions: 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ệ

Nếu options chưa được thiết lập.

Không gian tên: Documentize Lắp ráp: 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

object ← PluginBaseOptions ← ImageExtractorOptions

Triển khai

IPluginOptions

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 cung cấp thông tin về bản dựng sản phẩm hiện tại.

public static class Info

Kế thừa

object ← Info

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

Trường

AssemblyVersion Phiên bản Assembly.

public const string AssemblyVersion = "26.9.0"

Giá trị trường

Product

Tên sản phẩm.

public const string Product = "Documentize"

Giá trị trường

Namespace: Documentize Assembly: Documentize.dll

Class JpegConverter

Thông tin

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

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

Kế thừa

object ← JpegConverter

Thành viên kế thừa

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: Đối tượng tùy chọn chứa các hướng dẫn cho Documentize.JpegConverter.

Trả về

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

Ngoại lệ

Nếu options chưa được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class License

Thông tin

Cung cấp phương thức để đặt License.

public static class License

Kế thừa

object ← License

Thành viên kế thừa

Ví dụ

Hiển thị cách kích hoạt một giấy phép.

// Set License
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 rỗng để chuyển sang chế độ đánh giá.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

Thông tin

Biểu diễn các tùy chọn Merge cho plugin Documentize.PdfManager.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← MergeOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm 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 tài liệu PDF duy nhất.

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

Kế thừa

object ← Merger

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

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: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ngoại lệ

ArgumentException
Nếu options chưa được thiết lập.

Namespace: Documentize
Assembly: Documentize.dll

Class Message

Thông tin

Một tin nhắn hoàn thành trò chuyện do mô hình tạo ra.

public class Message

Kế thừa

object ← Message

Thành viên kế thừa

Hàm tạo

Message()

public Message()

Thuộc tính

Content

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

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

Giá trị thuộc tính

Role

Đặt hoặc lấy vai trò của tác giả 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

Không gian tên: Documentize Tập tin thực thi: Documentize.dll

Class ObjectResult

Thông tin

Biểu diễn kết quả hoạt động dưới dạng chuỗi.

public sealed class ObjectResult : IOperationResult

Inheritance

object ← ObjectResult

Implements

IOperationResult

Inherited Members

Properties

Data

Lấy dữ liệu thô.

public object Data { get; }

Property Value

IsFile

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

public bool IsFile { get; }

Property Value

IsObject

Cho biết kết quả là một đối tượng hay không.

public bool IsObject { get; }

Property Value

IsStream

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

public bool IsStream { get; }

Property Value

IsString

Cho biết kết quả là một chuỗi hay không.

public bool IsString { get; }

Property Value

Text

Trả về biểu diễn chuỗi của kết quả.

public string Text { get; }

Property Value

Methods

ToFile()

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

public string ToFile()

Returns

string : Một chuỗi đại diện cho đường dẫn tới tệp đầu ra nếu kết quả là tệp; 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()

Returns

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.

ToString()

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

public override string ToString()

Returns

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

Namespace: Documentize Assembly: Documentize.dll

Class OptimizeOptions

Thông tin

Biểu diễn các tùy chọn Optimize cho plugin Documentize.PdfManager.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

IPluginOptions

Inherited Members

Constructors

OptimizeOptions()

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

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

Thể hiện 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.

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

Kế thừa

object ← Optimizer

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

Phương thức

Process(OptimizeOptions)

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

public static ResultContainer Process(OptimizeOptions options)

Tham số

options OptimizeOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Giá trị trả về

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

Process(RotateOptions)

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

public static ResultContainer Process(RotateOptions options)

Tham số

options RotateOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Giá trị trả về

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

Process(ResizeOptions)

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

public static ResultContainer Process(ResizeOptions options)

Tham số

options ResizeOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Giá trị trả về

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

Process(CompressOptions)

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

public static ResultContainer Process(CompressOptions options)

Tham số

options CompressOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Giá trị trả về

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

Namespace: Documentize Assembly: Documentize.dll

Class OptionsWithInput

Thông tin

Biểu diễn các tùy chọn nền tảng cho các thao tác với 1 Dữ liệu Đầu vào.

public abstract class OptionsWithInput : IHaveInput

Inheritance

object ← OptionsWithInput

Derived

Implements

IHaveInput

Inherited Members

Fields

input

protected IData input;

Field Value

Properties

Input

Lấy hoặc đặt Dữ liệu Đầu vào.

public virtual IData Input { get; set; }

Property Value

Namespace: Documentize
Assembly: Documentize.dll

Class OptionsWithInputAndOutput

Thông tin

Biểu diễn các tùy chọn cơ bản cho các thao tác có 1 dữ liệu đầu vào và 1 dữ liệu đầu ra.

public abstract class OptionsWithInputAndOutput : OptionsWithInput, IHaveInput

Inheritance

object ← OptionsWithInput ← OptionsWithInputAndOutput

Derived

Implements

IHaveInput

Inherited Members

Fields

output

protected IData output;

Field Value

Properties

Output

Lấy hoặc thiết lập Dữ liệu đầu ra.

public virtual IData Output { get; set; }

Property Value

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

object ←
PageSize ←
PageInfo

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

Hàm khởi tạo

PageInfo()

Constructor của Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Constructor của Documentize.PageInfo.

public PageInfo(double width, double height)

Tham số

width double: Độ rộng của trang.
height double: Độ cao của trang.

Thuộc tính

MarginBottom

Lấy hoặc đặt giá trị cho biết lề dưới.

public double MarginBottom { get; set; }

Giá trị thuộc tính

MarginLeft

Lấy hoặc đặt giá trị cho biết lề trái.

public double MarginLeft { get; set; }

Giá trị thuộc tính

MarginRight

Lấy hoặc đặt giá trị cho biết lề phải.

public double MarginRight { get; set; }

Giá trị thuộc tính

MarginTop

Lấy hoặc đặt giá trị cho biết lề trên.

public double MarginTop { get; set; }

Giá trị thuộc tính

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

Class PageSize

Thông tin

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

public class PageSize

Kế thừa

object ← PageSize

Lớp con

PageInfo

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

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

PageSize()

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

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: Độ rộng của trang.
height double: Độ 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

A1

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

public static PageSize A1 { get; }

Giá trị thuộc tính

A2

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

public static PageSize A2 { get; }

Giá trị thuộc tính

A3

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

public static PageSize A3 { get; }

Giá trị thuộc tính

A4

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

public static PageSize A4 { get; }

Giá trị thuộc tính

A5

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

public static PageSize A5 { get; }

Giá trị thuộc tính

A6

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

public static PageSize A6 { get; }

Giá trị thuộc tính

B5

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

public static PageSize B5 { get; }

Giá trị thuộc tính

Height

Lấy hoặc thiết lập chiều cao của trang.

public double Height { get; set; }

Giá trị thuộc tính

IsLandscape

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

public bool IsLandscape { get; }

Giá trị thuộc tính

P11x17

Định dạng 11x17 inch.

public static PageSize P11x17 { get; }

Giá trị thuộc tính

PageLedger

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

public static PageSize PageLedger { get; }

Giá trị thuộc tính

PageLegal

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

public static PageSize PageLegal { get; }

Giá trị thuộc tính

PageLetter

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

public static PageSize PageLetter { get; }

Giá trị thuộc tính

Width

Lấy hoặc thiết lập chiều rộng của trang.

public double Width { get; set; }

Giá trị thuộc tính

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

Thông tin

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

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

Kế thừa

object ← PdfAConverter

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

Phương thức

Process(PdfToPdfAOptions)

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

public static ResultContainer Process(PdfToPdfAOptions options)

Tham số

options PdfToPdfAOptions: Đối tượng tùy chọn chứa các chỉ dẫn cho thao tác.

Trả về

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

Ngoại lệ

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

Process(PdfAValidateOptions)

Kiểm tra tài liệu PDF để xác nhận tuân thủ định dạng PDF/A đã chỉ định.

public static ResultContainer Process(PdfAValidateOptions options)

Tham số

options PdfAValidateOptions: Đối tượng tùy chọn chứa các chỉ dẫn cho thao tác.

Trả về

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

Ngoại lệ

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

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

object ← PdfAOptionsBase ← PdfAConvertOptions

Thực hiện

IPluginOptions

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

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

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

Represents the base class for the Documentize.PdfAConverter plugin options.
This class provides properties and methods for configuring the PDF/A conversion and validation process.

public abstract class PdfAOptionsBase : IPluginOptions

Kế thừa

object ← PdfAOptionsBase

Lớp dẫn xuất

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm tạo

PdfAOptionsBase()

protected PdfAOptionsBase()

Thuộc tính

AlignText

Lấy hoặc đặt giá trị cho biết có cần các biện pháp bổ sung để giữ nguyên căn chỉnh văn bản trong quá trình chuyển đổi PDF/A.

public bool AlignText { get; set; }

Giá trị thuộc tính

Ghi chú

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

CheckDifferentNamesInFontDictionaries

Lấy các cờ kiểm soát việc chuyển đổi PDF/A cho các trường hợp khi tài liệu PDF nguồn không phù hợp với tiêu chuẩn PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Giá trị thuộc tính

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 dùng cho việc chuyển đổi PDF/A thay cho hồ sơ mặc định.

public string IccProfileFileName { get; set; }

Giá trị thuộc tính

Inputs

Lấy bộ sưu tập dữ liệu.

public List<idata> Inputs { get; }

Giá trị thuộc tính

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Giá trị thuộc tính

LogOutputSource

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

public IData LogOutputSource { get; set; }

Giá trị thuộc tính

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Giá trị thuộc tính

Ghi chú

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

PdfAVersion

Lấy hoặc đặt phiên bản tiêu chuẩn PDF/A sẽ được dùng cho việc kiểm tra hoặc chuyển đổi.

public PdfAStandardVersion PdfAVersion { get; set; }

Giá trị thuộc tính

PdfAStandardVersion

Ghi chú

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

SoftMaskAction

Lấy hoặc đặt hành động sẽ thực hiện trong quá trình chuyển đổi hình ảnh có mặt nạ mềm (soft mask).

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Giá trị thuộc tính

ConvertSoftMaskAction

Phương thức

AddInput(IData)

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

public void AddInput(IData data)

Tham số

data IData: Dữ liệu đầu vào.

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAValidateOptions

Thông tin

Biểu diễn các tùy chọn để xác thực tuân thủ PDF/A của tài liệu PDF với plugin Documentize.PdfConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Kế thừa

object ←
PdfAOptionsBase ←
PdfAValidateOptions

Thực hiện

IPluginOptions

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

Các hàm tạo

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAValidationResult

Thông tin

Biểu diễn kết quả của quá trình xác thực PDF/A.

public sealed class PdfAValidationResult

Kế thừa

object ← PdfAValidationResult

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

Trường

Data

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

public readonly IData Data

Giá trị Trường

IsValid

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

public readonly bool IsValid

Giá trị Trường

ArgumentException : InvalidOperationException

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Giá trị Trường

PdfAStandardVersion

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

Class PdfChatGpt

Thông tin

Biểu diễn plugin PdfChatGpt.

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

Kế thừa

object ← PdfChatGpt

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

Ghi chú

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

Phương thức

Process(IPluginOptions)

Phương thức này không có phiên bản đồng bộ. Hãy sử dụng phương thức ProcessAsync thay thế.

public static ResultContainer Process(IPluginOptions options)

Tham số

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

Trả về

ResultContainer

Ngoại lệ

NotImplementedException

ProcessAsync(IPluginOptions)

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

public static Task<ResultContainer> ProcessAsync(IPluginOptions options)

Tham số

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

Trả về

Task<ResultContainer>

Đối tượng Task đại diện cho hoạt động bất đồng bộ.

Ngoại lệ

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

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

Outputs

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

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

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Triển khai

IPluginOptions

Thành viên kế thừa

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

PdfChatGptRequestOptions()

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

apiKey string: Khóa để truy cập vào ChatGPT API.
model string: Tên của mô hình ChatGPT. Mô hình mặc định là: gpt-3.5-turbo-1106:
apiUrl string: URL của ChatGPT API. URL mặc định là: https://api.openai.com/v1/chat/completions.
query string: Chuỗi yêu cầu gửi đến ChatGPT.

Thuộc tính

ApiKey

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

public string ApiKey { get; set; }

Giá trị thuộc tính

ApiUrl

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

public string ApiUrl { get; set; }

Giá trị thuộc tính

CancellationToken

Token hủy.

public CancellationToken CancellationToken { get; set; }

Giá trị thuộc tính

CancellationToken

MaxTokens

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

public int? MaxTokens { get; set; }

Giá trị thuộc tính

int?

Messages

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

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

Giá trị thuộc tính

List<Message>

Nhận xét

Khi thêm nhiều tin nhắn vào các tùy chọn, thứ tự trong bộ sưu tập tin nhắn như sau:

Tin nhắn đầu tiên (nếu có) là từ options.Query, được trước bởi tin nhắn có nội dung: “Bạn là một trợ lý hữu ích.”, và vai trò là “hệ thống”.
Sau đó (nếu có) các tin nhắn từ bộ sưu tập options.Messages được thêm vào.
Các tin nhắn từ các nguồn tệp (nếu có) được thêm vào cuối cùng, một đối tượng tin nhắn cho mỗi tài liệu với vai trò “người dùng”. Nếu không có tin nhắn nào được cung cấp, sẽ ném ra ArgumentException.

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

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Giá trị thuộc tính

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

Temperature

Nhiệt độ lấy mẫu để sử dụng, giữa 0 và 2. Giá trị cao như 0.8 sẽ làm cho kết quả đầu ra ngẫu nhiên hơn, trong khi giá trị thấp 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

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverter

Thông tin

Thể hiện thành phần Documentize.PdfConverter. Được sử dụng để chuyển đổi tài liệu PDF sang các định dạng khác như DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Ngoài ra còn cho phép thực hiện xác thực PDF/A và chuyển đổi HTML sang PDF.

Thể hiện thành phần Documentize.PdfConverter. Được sử dụng để chuyển đổi tài liệu PDF sang các định dạng khác như DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A.
Cũng cho phép thực hiện xác thực PDF/A và chuyển đổi HTML sang PDF.

public static class PdfConverter

#### Kế thừa

[object](https://learn.microsoft.com/dotnet/api/system.object) ← 
[PdfConverter](Documentize.PdfConverter.md)

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

- [object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
- [object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
- [object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring),
- [object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
- [object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
- [object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
- [object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Phương thức

### <a id="Documentize_PdfConverter_Convert_Documentize_PdfToDocOptions_"></a> Convert\(PdfToDocOptions\)

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

```csharp
public static ResultContainer Convert(PdfToDocOptions options)

Tham số

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

Trả về

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

Ví dụ

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

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Perform the process
PdfConverter.Convert(options);

Ví dụ minh họa cách chuyển đổi tài liệu PDF sang định dạng Doc với thiết lập Mode.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Set Mode
options.Mode = DocConversionMode.Flow;
// Perform the process
PdfConverter.Convert(options);

Ngoại lệ

Nếu chưa thiết lập options.

Convert(PdfToXlsOptions)

Chuyển đổi tài liệu PDF sang các định dạng XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Convert(PdfToXlsOptions options)

Tham số

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

Trả về

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

Ví dụ

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

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xlsx"));
// Perform the process
PdfConverter.Convert(options);

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

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Specify XLS format
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xls"));
// Perform the process
PdfConverter.Convert(options);

Ngoại lệ

Nếu chưa thiết lập options.

Convert(PdfToHtmlOptions)

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

public static ResultContainer Convert(PdfToHtmlOptions options)

Tham số

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

Trả về

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

Ví dụ

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

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

Ngoại lệ

Nếu chưa thiết lập options.

Convert(HtmlToPdfOptions)

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

public static ResultContainer Convert(HtmlToPdfOptions options)

Tham số

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

Trả về

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

Ví dụ

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

// Create HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Add input file path
options.AddInput(new FileData("path_to_input.html"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
//Perform the process
PdfConverter.Convert(options);

Ngoại lệ

Nếu chưa thiết lập options.

Convert(PdfToJpegOptions)

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

public static ResultContainer Convert(PdfToJpegOptions options)

Tham số

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

Trả về

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

Ví dụ

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

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

Ví dụ minh họa cách chuyển đổi PDF sang JPEG với các thiết lập cho trang, độ phân giải, chất lượng.

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

Ví dụ minh họa cách chuyển đổi PDF sang JPEG dưới dạng streams.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Ngoại lệ

Nếu chưa thiết lập options.

Convert(PdfToPngOptions)

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

public static ResultContainer Convert(PdfToPngOptions options)

Tham số

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

Trả về

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

Ví dụ

Ví dụ minh họa cách chuyển PDF sang định dạng PNG.

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

Ví dụ minh họa cách chuyển 1 trang PDF sang PNG.

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

Ví dụ minh họa cách chuyển PDF sang PNG dưới dạng streams.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Ngoại lệ

Nếu chưa thiết lập options.

Convert(PdfToTiffOptions)

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

public static ResultContainer Convert(PdfToTiffOptions options)

Tham số

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

Trả về

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

Ví dụ

Ví dụ minh họa cách chuyển PDF sang định dạng TIFF.

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

Ví dụ minh họa cách chuyển PDF sang TIFF với tùy chỉnh trang và DPI.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Pages
options.PageList = [1, 3];
// Set result image Resolution
options.OutputResolution = 400;
// Perform the process
PdfConverter.Convert(options);

Ví dụ minh họa cách tạo TIFF đa trang.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Enable Multi-Page TIFF output
options.MultiPage = true;
// Perform the process
PdfConverter.Convert(options);

Ví dụ minh họa cách chuyển PDF sang TIFF với tùy chỉnh nén và độ sâu màu.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Compression and ColorDepth
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Perform the process
PdfConverter.Convert(options);

Ví dụ minh họa cách chuyển PDF sang TIFF dưới dạng streams.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Ngoại lệ

Nếu chưa thiết lập options.

Convert(PdfToPdfAOptions)

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

public static ResultContainer Convert(PdfToPdfAOptions options)

Tham số

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

Trả về

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

Ví dụ

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

// Create the options class to set up the conversion process
var options = new PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Add the source file
options.AddInput(new FileData("path_to_your_pdf_file.pdf")); // replace with your actual file path

// Add the path to save the converted file
options.AddOutput(new FileData("path_to_the_converted_file.pdf"));

// Run the conversion
PdfConverter.Convert(options);

Ngoại lệ

Nếu chưa thiết lập options.

Validate(PdfAValidateOptions)

Kiểm tra tài liệu PDF có tuân thủ chuẩn PDF/A được chỉ định hay không.

public static ResultContainer Validate(PdfAValidateOptions options)

Tham số

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

Trả về

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

Ví dụ

Ví dụ minh họa cách xác thực tính tuân thủ của tài liệu PDF với chuẩn PDF/A (trong ví dụ này là PDF/A-1a):

// Create the options class to set up the validation process
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Add one or more files to be validated
options.AddInput(new FileData("path_to_your_first_pdf_file.pdf")); // replace with your actual file path
options.AddInput(new FileData("path_to_your_second_pdf_file.pdf"));
// add more files as needed

// Run the validation and get results
var resultContainer = PdfConverter.Validate(options);

// Check the resultContainer.ResultCollection property for validation results for each file:
foreach (var result in resultContainer.ResultCollection)
{
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for document
}

Ngoại lệ

Nếu chưa thiết lập options.

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

object ← PdfConverterOptions

Kế thừa từ

PdfToXlsOptions

Triển khai

IPluginOptions

Thành viên kế thừa

Thuộc tính

Inputs

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

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

Outputs

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

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

Phương thức

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Tham số

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

AddOutput(IDataSource)

Thêm nguồn dữ liệu mới vào bộ sưu tập dữ liệu 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 PdfExtractor

Thông tin

Đại diện cho thành phần Documentize.PdfExtractor. Được sử dụng để Trích xuất Văn bản, Hình ảnh, Dữ liệu Form, Thuộc tính (Siêu dữ liệu) từ tài liệu PDF.

public static class PdfExtractor

Kế thừa

object ← PdfExtractor

Thành viên kế thừa

Phương thức

Extract(ExtractTextOptions)

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

public static string Extract(ExtractTextOptions options)

Tham số

options ExtractTextOptions: Đối tượng tùy chọn chứa các hướng dẫn cho việc thực hiện.

Giá trị trả về

string : Văn bản đã được trích xuất.

Ví dụ

Ví dụ minh họa cách Trích xuất nội dung Văn bản từ tệp PDF.

// Tạo đối tượng ExtractTextOptions để đặt đường dẫn tệp đầu vào
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Thực hiện quá trình và nhận văn bản đã trích xuất
var textExtracted = PdfExtractor.Extract(options);

Ví dụ minh họa cách Trích xuất nội dung Văn bản từ luồng PDF.

// Tạo đối tượng ExtractTextOptions để đặt luồng đầu vào
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Thực hiện quá trình và nhận văn bản đã trích xuất
var textExtracted = PdfExtractor.Extract(options);

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 với TextFormattingMode.

// Tạo đối tượng ExtractTextOptions để đặt đường dẫn tệp và TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Thực hiện quá trình và nhận văn bản đã trích xuất
var textExtracted = PdfExtractor.Extract(options);

Ví dụ minh họa cách Trích xuất Văn bản từ tệp PDF theo kiểu ngắn gọn nhất có thể.

// Thực hiện quá trình và nhận văn bản đã trích xuất
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

Ngoại lệ

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

Extract(ExtractImagesOptions)

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

public static ResultContainer Extract(ExtractImagesOptions options)

Tham số

options ExtractImagesOptions: Đối tượng tùy chọn chứa các hướng dẫn cho việc thực hiện.

Giá trị trả về

ResultContainer : Đối tượng chứa kết quả của quá trình.

Ví dụ

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

// Tạo ExtractImagesOptions để đặt các hướng dẫn
var options = new ExtractImagesOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryData("path_to_results_directory"));
// Thực hiện quá trình
var results = PdfExtractor.Extract(options);
// Lấy đường dẫn tới kết quả hình ảnh
var imageExtracted = results.ResultCollection[0].ToFile();

Ví dụ minh họa cách Trích xuất Hình ảnh từ tài liệu PDF tới các Luồng mà không cần thư mục.

// Tạo ExtractImagesOptions để đặt các hướng dẫn
var options = new ExtractImagesOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Không đặt đầu ra – kết quả sẽ được ghi vào các luồng
// Thực hiện quá trình
var results = PdfExtractor.Extract(options);
// Lấy Luồng
var ms = results.ResultCollection[0].ToStream();
// Sao chép dữ liệu ra tệp để demo
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Ngoại lệ

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

Extract(ExtractFormDataToDsvOptions)

Trích xuất Dữ liệu Form từ tài liệu PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Tham số

options ExtractFormDataToDsvOptions: Đối tượng tùy chọn chứa các hướng dẫn cho việc thực hiện.

Giá trị trả về

ResultContainer : Đối tượng chứa kết quả của quá trình.

Ví dụ

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

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

Ví dụ minh họa cách Xuất giá trị Form ra tệp TSV và đặt các Thuộc tính.

// Tạo ExtractFormDataToDsvOptions để đặt các hướng dẫn
var options = new ExtractFormDataToDsvOptions();
// Đặt dấu phân cách
options.Delimiter = '\t';
// Thêm tên trường vào kết quả
options.AddFieldName = true;
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Thực hiện quá trình
PdfExtractor.Extract(options);

Ngoại lệ

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

Extract(ExtractPropertiesOptions)

Trích xuất Thuộc tính từ tài liệu PDF.

public static PdfProperties Extract(ExtractPropertiesOptions options)

Tham số

options ExtractPropertiesOptions: Đối tượng tùy chọn chứa các hướng dẫn cho việc thực hiện.

Giá trị trả về

PdfProperties : Đối tượng chứa kết quả của quá trình.

Ví dụ

Ví dụ minh họa cách Trích xuất Thuộc tính (FileName, Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) từ tệp PDF.

// Tạo ExtractPropertiesOptions để đặt tệp đầu vào
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Thực hiện quá trình và nhận Thuộc tính
var pdfProperties = PdfExtractor.Extract(options);
var filename = pdfProperties.FileName;
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

Ví dụ minh họa cách Trích xuất Thuộc tính (Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) từ luồng PDF.

// Tạo ExtractPropertiesOptions để đặt luồng đầu vào
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Thực hiện quá trình và nhận Thuộc tính
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

Ví dụ minh họa cách Trích xuất Thuộc tính từ tệp PDF theo kiểu ngắn gọn nhất có thể.

// Thực hiện quá trình và nhận Thuộc tính
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

Ngoại lệ

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

Namespace: Documentize
Assembly: Documentize.dll

Class PdfForm

Thông tin

Đại diện cho thành phần Documentize.PdfForm. Được sử dụng để làm phẳng, trích xuất dữ liệu biểu mẫu. Cũng cho phép bạn lấy tên các trường.

Đại diện cho thành phần Documentize.PdfForm. Được sử dụng để làm phẳng, trích xuất dữ liệu biểu mẫu.
Cũng cho phép bạn lấy tên các trường.

public static class PdfForm

Kế thừa

object ← PdfForm

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

Phương thức

Extract(ExtractFormDataToDsvOptions)

Trích xuất dữ liệu biểu mẫu từ tài liệu PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Tham số

options ExtractFormDataToDsvOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Trả về

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

Ví dụ

Ví dụ minh họa cách xuất giá trị biểu mẫu ra file CSV.

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

Ví dụ minh họa cách xuất giá trị biểu mẫu ra file TSV và thiết lập các thuộc tính.

// Tạo đối tượng ExtractFormDataToDsvOptions để đặt hướng dẫn
var options = new ExtractFormDataToDsvOptions();
// Đặt ký tự phân tách
options.Delimiter = '\t';
// Thêm tên trường vào kết quả
options.AddFieldName = true;
// Thêm đường dẫn file đầu vào
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn file đầu ra
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Thực hiện quá trình
PdfForm.Extract(options);

Ngoại lệ

Nếu options chưa được thiết lập.

Flatten(FlattenFieldsOptions)

Làm phẳng các trường trong tài liệu PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Tham số

options FlattenFieldsOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Trả về

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

Ví dụ

Ví dụ minh họa cách làm phẳng các trường trong file PDF.

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

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

// Lấy tên các trường
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Tạo đối tượng FlattenFieldsOptions để đặt hướng dẫn
var options = new FlattenFieldsOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Bỏ qua 1 trường.
options.SkipFields.Add(fieldNames[0]);
// Thực hiện quá trình
PdfForm.Flatten(options);

Ngoại lệ

Nếu options chưa được thiết lập.

GetNames(GetFieldNamesOptions)

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

public static List<string> GetNames(GetFieldNamesOptions options)

Tham số

options GetFieldNamesOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Trả về

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

Ví dụ

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

// Lấy tên các trường
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));

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

// Chuẩn bị luồng đầu vào
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
// Lấy tên các trường
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions(inputStream));

Remove(RemoveFieldsOptions) : Loại bỏ các trường khỏi tài liệu PDF.

public static ResultContainer Remove(RemoveFieldsOptions options)

Tham số

options RemoveFieldsOptions: Đối tượng tùy chọn chứa hướng dẫn cho thao tác.

Trả về

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

Ví dụ

Ví dụ minh họa cách loại bỏ các trường khỏi file PDF.

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

Ngoại lệ

Nếu options chưa được thiết lập.

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

Thông tin

Đại diện cho thành phần Documentize.PdfManager. Được sử dụng để Gộp, Tách, Tối ưu, Xoay, Thay đổi kích thước, Nén tài liệu PDF và Thêm Bảng, Thêm mục lục vào tài liệu PDF. Có thể Gộp nhiều tài liệu PDF thành một PDF duy nhất. Có thể Tách tài liệu PDF thành các trang riêng biệt. Có thể Tối ưu, Xoay, Thay đổi kích thước, Nén tài liệu PDF. Có thể Xoay, Thay đổi kích thước các trang của tài liệu PDF. Có thể Thêm Bảng vào tài liệu PDF. Có thể Thêm Mục lục vào tài liệu PDF.

Đại diện cho thành phần Documentize.PdfManager. Được sử dụng để Gộp, Tách, Tối ưu, Xoay, Thay đổi kích thước, Nén tài liệu PDF và Thêm Bảng, Thêm mục lục vào tài liệu PDF.
Có thể Gộp nhiều tài liệu PDF thành một PDF duy nhất.
Có thể Tách tài liệu PDF thành các trang riêng biệt.
Có thể Tối ưu, Xoay, Thay đổi kích thước, Nén tài liệu PDF.
Có thể Xoay, Thay đổi kích thước các trang của tài liệu PDF.
Có thể Thêm Bảng vào tài liệu PDF.
Có thể Thêm Mục lục vào tài liệu PDF.

public static class PdfManager

Inheritance

object ← PdfManager

Inherited Members

Methods

AddTable(TableOptions)

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

public static ResultContainer AddTable(TableOptions options)

Tham số

options TableOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ví dụ

Ví dụ dưới đây minh họa cách Thêm Bảng vào tập tin PDF.

// Cấu hình tùy chọn bảng
var options = new TableOptions();
options.InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .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 FileData("path_to_input.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileData("path_to_output.pdf"));
// Thực hiện quá trình
PdfManager.AddTable(options);

Ví dụ dưới đây minh họa cách Thêm Bảng vào tập tin PDF trước trang 2.

// Cấu hình tùy chọn bảng
var options = new TableOptions();
options.InsertPageBefore(2) // Thêm bảng trước trang 2
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileData("path_to_input.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileData("path_to_output.pdf"));
// Thực hiện quá trình
PdfManager.AddTable(options);

Ngoại lệ

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

AddTableOfContents(TocOptions)

Thêm Mục lục (TOC) vào tài liệu PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

Tham số

options TocOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ví dụ

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

// Tạo đối tượng TocOptions để đặt các chỉ dẫn
var options = new TocOptions();
// Đặt tiêu đề
options.Title = "My Table of Contents";
// Thiết kế các tiêu đề
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.AddTableOfContents(options);

Ví dụ dưới đây minh họa cách thêm Mục lục vào tập tin PDF và tạo các dấu trang.

var options = new TocOptions();
options.Title = "My Table of Contents";
options.GenerateBookmarks = true;
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.AddTableOfContents(options);

Ví dụ dưới đây minh họa cách thêm Mục lục vào tập tin PDF và lưu dưới dạng luồng.

var options = new TocOptions();
options.Title = "My Table of Contents";
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
PdfManager.AddTableOfContents(options);

Ví dụ dưới đây minh họa cách thêm Mục lục vào tập tin PDF với việc tùy chỉnh tiêu đề TOC.

var heading = new TocHeading();
heading.Text = "Intro";
heading.PageNumber = 5;
heading.GenerateNumbering = true;
heading.Level = 2;
var tocOptions = new TocOptions();
tocOptions.Headings.Add(heading);
tocOptions.AddInput(new FileData("path_to_your_pdf_file.pdf"));
tocOptions.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.AddTableOfContents(tocOptions);

Ngoại lệ

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

Compress(CompressOptions)

Nén tài liệu PDF. Cố gắng giảm kích thước tài liệu.

public static ResultContainer Compress(CompressOptions options)

Tham số

options CompressOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ví dụ

var options = new CompressOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.Compress(options);

Ngoại lệ

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

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Tạo tài liệu PDF từ phản hồi của ChatGpt.
Được sử dụng để gửi yêu cầu tới ChatGPT trực tiếp 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.

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Tham số

options ChatGptRequestOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

Task<ResultContainer>

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

Ví dụ

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key.";
options.MaxTokens = 1000;
options.Messages.Add(new Message { Content = "You are a helpful assistant.", Role = Role.System });
options.Messages.Add(new Message { Content = "What is the biggest pizza diameter ever made?", Role = Role.User });
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion;

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
options.ApiKey = "Your API key.";
options.MaxTokens = 1000;
options.Query = "What is the lowest temperature recorded on the Earth?";
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion;

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
options.AddInput(new FileData("TextSource.pdf"));
options.ApiKey = "Your API key.";
options.MaxTokens = 1000;
options.Query = "How many letters in the provided text?";
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion;

Ngoại lệ

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

Merge(MergeOptions)

Gộp tài liệu PDF.

public static ResultContainer Merge(MergeOptions options)

Tham số

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

Trả về

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

Ví dụ

var options = new MergeOptions();
options.AddInput(new FileData("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileData("path_to_your_pdf_file_2.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.Merge(options);

Ngoại lệ

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

Optimize(OptimizeOptions)

Tối ưu tài liệu PDF.
Linearize 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 tới 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 của một trang được truyền qua kênh chậm (hiển thị dữ liệu hữu ích nhất trước);
cho phép tương tác người dùng, chẳng hạn theo liên kết, được thực hiện ngay cả khi chưa nhận và hiển thị toàn bộ trang.

public static ResultContainer Optimize(OptimizeOptions options)

Tham số

options OptimizeOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ví dụ

var options = new OptimizeOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.Optimize(options);

Ngoại lệ

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

Resize(ResizeOptions)

Thay đổi kích thước các trang của tài liệu PDF.

public static ResultContainer Resize(ResizeOptions options)

Tham số

options ResizeOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ví dụ

var options = new ResizeOptions();
options.PageSize = PageSize.A3;
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.Resize(options);

Ngoại lệ

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

Rotate(RotateOptions)

Xoay các trang của tài liệu PDF.

public static ResultContainer Rotate(RotateOptions options)

Tham số

options RotateOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Trả về

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

Ví dụ

var options = new RotateOptions();
options.Rotation = Rotation.On90;
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.Rotate(options);

Ngoại lệ

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

Split(SplitOptions)

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

public static ResultContainer Split(SplitOptions options)

Tham số

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

Trả về

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

Ví dụ

var options = new SplitOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file_2.pdf"));
PdfManager.Split(options);

Ngoại lệ

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfProperties

Thông tin

Biểu diễn các thuộc tính và siêu thông tin của tài liệu PDF.

public class PdfProperties

Thừa kế

object ← PdfProperties

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

Hàm khởi tạo

PdfProperties()

public PdfProperties()

Thuộc tính

Application

Lấy hoặc đặt Ứng dụng PDF.

public string Application { get; set; }

Giá trị Thuộc tính

Author

Lấy hoặc đặt Tác giả PDF.

public string Author { get; set; }

Giá trị Thuộc tính

Created

Lấy hoặc đặt Ngày tạo PDF.

public DateTime? Created { get; set; }

Giá trị Thuộc tính

DateTime?

FileName

Lấy hoặc đặt Tên tệp PDF, nếu có.

public string FileName { get; set; }

Giá trị Thuộc tính

Keywords

Lấy hoặc đặt Từ khóa PDF.

public string Keywords { get; set; }

Giá trị Thuộc tính

Modified

Lấy hoặc đặt Ngày chỉnh sửa PDF.

public DateTime? Modified { get; set; }

Giá trị Thuộc tính

DateTime?

NumberOfPages

Lấy hoặc đặt Số trang PDF.

public int NumberOfPages { get; set; }

Giá trị Thuộc tính

PdfProducer

Lấy hoặc đặt Nhà sản xuất PDF.

public string PdfProducer { get; set; }

Giá trị Thuộc tính

Subject

Lấy hoặc đặt Chủ đề PDF.

public string Subject { get; set; }

Giá trị Thuộc tính

Title

Lấy hoặc đặt Tiêu đề PDF.

public string Title { get; set; }

Giá trị Thuộc tính

Namespace: Documentize
Assembly: Documentize.dll

Class PdfSecurity

Thông tin

Đại diện cho thành phần Documentize.PdfSecurity. Được sử dụng để Mã hoá, Giải mã, Ký, và Làm sạch tài liệu PDF.

public static class PdfSecurity

Inheritance

object ← PdfSecurity

Inherited Members

Methods

Decrypt(DecryptOptions)

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

public static ResultContainer Decrypt(DecryptOptions options)

Parameters

options DecryptOptions: Đối tượng tùy chọn chứa các chỉ dẫn cho thao tác.

Returns

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

Examples

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

// Create DecryptOptions object to set instructions
var options = new DecryptOptions("123456");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Decrypt(options);

Exceptions

Nếu không thiết lập options.

Encrypt(EncryptOptions)

Mã hoá tài liệu PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Parameters

options EncryptOptions: Đối tượng tùy chọn chứa các chỉ dẫn cho thao tác.

Returns

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

Examples

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

// Create EncryptOptions object to set instructions
var options = new EncryptOptions("123456", "qwerty");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Encrypt(options);

Exceptions

Nếu không thiết lập options.

Sanitize(SanitizeOptions)

Loại bỏ dữ liệu ẩn khỏi tài liệu PDF, đảm bảo rằng thông tin nhạy cảm hoặc không cần thiết như siêu dữ liệu, tệp đính kèm, chú thích, JavaScript, biểu mẫu, lớp, chỉ mục tìm kiếm hoặc nội dung riêng tư được xóa hoặc chuyển đổi.

public static ResultContainer Sanitize(SanitizeOptions options)

Parameters

options SanitizeOptions: Đối tượng tùy chọn chứa các chỉ dẫn cho thao tác.

Returns

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

Examples

Ví dụ minh họa cách làm sạch một tài liệu PDF.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch PDF từ stream sang stream.

// Prepare input and output streams
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream = new MemoryStream();
// Create SanitizeOptions object to set input and output streams
var options = new SanitizeOptions(inputStream, outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch PDF từ file sang stream.

// Prepare output stream
using var outputStream = new MemoryStream();
// Create SanitizeOptions object to set input file và output stream
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch PDF từ file sang stream với việc thiết lập thủ công các thuộc tính input và output.

// Prepare output stream
using var outputStream = new MemoryStream();
// Create SanitizeOptions object
var options = new SanitizeOptions();
//Set Input file
options.Input = new FileData("path_to_your_pdf_file.pdf");
//Set Output stream
options.Output = new StreamData(outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch PDF mà không xóa Metadata.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveMetadata = false;
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch PDF mà không xóa Attachments.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveAttachments = false;
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch PDF bằng cách chuyển đổi tất cả các trang thành hình ảnh và đặt dpi kết quả.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Turn on conversion and set dpi
options.ConvertPagesToImages = true;
options.ImageDpi = 200;
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch PDF mà không xóa JavaScripts và Actions.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveJavaScriptsAndActions = false;
// Perform the process
PdfSecurity.Sanitize(options);

Ví dụ minh họa cách làm sạch một tệp PDF trong phong cách ngắn gọn nhất có thể.

PdfSecurity.Sanitize(new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf"));

Exceptions

Nếu không thiết lập options.

Sign(SignOptions)

Ký tài liệu PDF bằng chữ ký số.

public static ResultContainer Sign(SignOptions options)

Parameters

options SignOptions: Đối tượng tùy chọn chứa các chỉ dẫn cho thao tác.

Returns

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

Examples

Ví dụ minh họa cách ký một tài liệu PDF.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Perform the process
PdfSecurity.Sign(options);

Ví dụ minh họa cách ký một tài liệu PDF bằng streams.

// Prepare streams
using var pdfStreamInput = File.OpenRead(@"path_to_your_pdf_file.pdf");
using var pfxStreamInput = File.OpenRead(@"path_to_your_pfx_file.pfx");
using var pdfStreamOutput = new MemoryStream();
// Create SignOptions object to set instructions
var options = new SignOptions(pdfStreamInput, pdfStreamOutput, pfxStreamInput, "password_of_your_pfx_file");
// Perform the process
PdfSecurity.Sign(options);

Ví dụ cho thấy cách ký một tài liệu PDF và thiết lập các tham số input và output riêng biệt.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Set input and output file paths
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sign(options);

Ví dụ minh họa cách ký một tài liệu PDF với Stream của tệp PFX.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
// Set input and output file paths
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sign(options);

Ví dụ minh họa cách ký một tài liệu PDF với chữ ký không hiển thị.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Configure invisible signature
options.Visible = false;
// Perform the process
PdfSecurity.Sign(options);

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

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf","path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Optional parameters
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Perform the process
PdfSecurity.Sign(options);

Ví dụ minh họa cách ký một tệp PDF trong phong cách ngắn gọn nhất có thể.

PdfSecurity.Sign(new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file"));

Ví dụ minh họa cách ký một tài liệu PDF với Timestamp.

// Create SignOptions object to set Timestamp
var options = new SignOptions(new TimestampOptions("server_url"));
// Set input and output file paths
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sign(options);

Exceptions

PdfToHtmlOptions.SaveDataType

Nếu không thiết lập options.

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

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ←
PluginBaseOptions ←
PdfToDocOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm khởi tạo

PdfToDocOptions()

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

public PdfToDocOptions()

Thuộc tính

Mode

Cho phép kiểm soát cách tài liệu PDF được chuyển đổi thành tài liệu xử lý văn bản.

public DocConversionMode Mode { get; set; }

Giá trị Thuộc tính

DocConversionMode

Ghi chú

Sử dụng chế độ Documentize.DocConversionMode.TextBox khi tài liệu kết quả không cần được chỉnh sửa nhiều nữa. Các hộp văn bản dễ dàng chỉnh sửa khi không có quá nhiều nội dung.

Sử dụng chế độ Documentize.DocConversionMode.Flow khi tài liệu đầu ra cần được chỉnh sửa thêm. Các đoạn văn và dòng văn bản trong chế độ luồng cho phép chỉnh sửa dễ dàng, nhưng các đối tượng định dạng không được hỗ trợ sẽ trông kém hơn so với chế độ Documentize.DocConversionMode.TextBox.

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

Class PdfToHtmlOptions

Thông tin

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

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← PdfToHtmlOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm tạo

PdfToHtmlOptions(SaveDataType)

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

outputDataType PdfToHtmlOptions.SaveDataType: Kiểu dữ liệu đầu ra.

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

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

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToJpegOptions

Implements

IPluginOptions

Inherited Members

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 đặt giá trị độ phân giải của các hình ảnh kết quả.

public int OutputResolution { get; set; }

Property Value

PageList

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

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

Property Value

List<int>

Quality

Lấy và đặt chất lượng đầu ra.
Xác định mức độ nén cho một hình ảnh.
Phạm vi giá trị hữu ích cho chất lượng là từ 0 đến 100.
Số chỉ định 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ố 0 sẽ cho bạn hình ảnh chất lượng thấp nhất và 100 là cao nhất.

public int Quality { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPdfAOptions

Thông tin

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

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

Kế thừa

object ← PdfAOptionsBase ← PdfToPdfAOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm khởi tạo

PdfToPdfAOptions()

public PdfToPdfAOptions()

Thuộc tính

Outputs

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

public List<idata> Outputs { get; }

Giá trị Thuộc tính

Phương thức

AddOutput(IData)

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

public void AddOutput(IData data)

Tham số

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

Không gian tên: Documentize
Tập tin lắp ráp: Documentize.dll

Class PdfToPngOptions

Thông tin

Biểu diễn các tùy chọn bộ chuyển đổi PDF sang PNG cho plugin Documentize.PdfConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ←
PluginBaseOptions ←
PdfToPngOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

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

Thuộc tính

OutputResolution

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

public int OutputResolution { get; set; }

Giá trị Thuộc tính

PageList

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

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

Giá trị Thuộc tính

List<int>

Không gian tên: Documentize
Tập tin lắp ráp: Documentize.dll

Class PdfToTiffOptions

Thông tin

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

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToTiffOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToTiffOptions()

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

public PdfToTiffOptions()

Properties

ColorDepth

Lấy hoặc đặt độ sâu màu.

public TiffColorDepth ColorDepth { get; set; }

Property Value

TiffColorDepth

Remarks

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

Compression

Lấy hoặc đặt loại nén.

public TiffCompression Compression { get; set; }

Property Value

TiffCompression

Remarks

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

MultiPage

Lấy và đặt cờ cho phép lưu tất cả các trang trong một tệp TIFF đa trang.

public bool MultiPage { get; set; }

Property Value

Remarks

Giá trị mặc định là false.

OutputResolution

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

public int OutputResolution { get; set; }

Property Value

PdfToXlsOptions.ExcelFormat

PageList

Lấy hoặc đặt danh sách các trang cho quá trình xử lý.

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

Property Value

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

Thông tin

Biểu diễn các tùy chọn chuyển đổi PDF sang XLS/XLSX cho plugin Documentize.PdfConverter.

public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToXlsOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToXlsOptions()

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

public PdfToXlsOptions()

Properties

Format

Định dạng đầu ra.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Property Value

InsertBlankColumnAtFirst

Đặt thành 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; nghĩa là không chèn cột trống.

public bool InsertBlankColumnAtFirst { get; set; }

Property Value

MinimizeTheNumberOfWorksheets

Đặt thành true nếu bạn muốn giảm số lượng bảng tính trong workbook kết quả. Giá trị mặc định là false; nghĩa là mỗi trang PDF sẽ được lưu dưới dạng một bảng tính riêng.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

Thông tin

Biểu diễn các tùy chọn cơ bản cho các thành phần.

public class PluginBaseOptions : IPluginOptions

Kế thừa

object ← PluginBaseOptions

Lớp con

Thực hiện

IPluginOptions

Thành viên kế thừa

Thuộc tính

CloseInputStreams

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

public bool CloseInputStreams { get; set; }

Giá trị thuộc tính

CloseOutputStreams

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

public bool CloseOutputStreams { get; set; }

Giá trị thuộc tính

Inputs

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

public List<IData> Inputs { get; }

Giá trị thuộc tính

Outputs

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

public List<IData> Outputs { get; }

Giá trị thuộc tính

Phương thức

AddInput(IData)

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

public void AddInput(IData data)

Tham số

data IData: Dữ liệu cần thêm.

AddOutput(IData)

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

public void AddOutput(IData data)

Tham số

data IData: Dữ liệu cần thêm.

Namespace: Documentize
Assembly: Documentize.dll

Class PngConverter

Thông tin

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

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

Inheritance

object ← PngConverter

Inherited Members

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 thao tác.

Returns

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

Exceptions

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

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

Thông tin

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

public class Rectangle

Kế thừa

object ← Rectangle

Thân viên kế thừa

Hàm khởi tạo

Rectangle(double, double, double, double)

Constructor of 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 RemoveFieldsOptions

Thông tin

Đại diện cho các tùy chọn khi xóa trường trong tài liệu bằng plugin Documentize.PdfForm.

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← RemoveFieldsOptions

Thực thi

IPluginOptions

Thành viên kế thừa

Hàm khởi tạo

RemoveFieldsOptions()

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

public RemoveFieldsOptions()

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

Class ResizeOptions

Thông tin

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

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← ResizeOptions

Thực thi

IPluginOptions

Thành viên kế thừa

Khởi tạo

ResizeOptions()

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

public ResizeOptions()

Thuộc tính

PageSize

Lấy hoặc đặt kích thước trang mới.

public PageSize PageSize { get; set; }

Giá trị thuộc tính

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

Class ResultContainer

Thông tin

Biểu thị một container chứa bộ sưu tập kết quả của quá trình xử lý plugin.

public class ResultContainer

Kế thừa

object ← ResultContainer

Thành viên kế thừa

Thuộc tính

ResultCollection

Lấy bộ sưu tập các kết quả của thao tác

public List<IOperationResult> ResultCollection { get; }

Giá trị thuộc tính

List<IOperationResult>

Không gian tên: Documentize Tập tin lắp ráp: Documentize.dll

Class RotateOptions

Thông tin

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

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← RotateOptions

Thực hiện

IPluginOptions

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

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 đặt phép quay cho các trang mới.

public Rotation Rotation { get; set; }

Giá trị thuộc tính

Rotation

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

Class SanitizeOptions

Thông tin

Mô tả các tùy chọn cấu hình để làm sạch dữ liệu ẩn trong tài liệu.

public class SanitizeOptions : OptionsWithInputAndOutput, IHaveInput

Inheritance

object ← OptionsWithInput ← OptionsWithInputAndOutput ← SanitizeOptions

Implements

IHaveInput

Inherited Members

Constructors

SanitizeOptions()

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

public SanitizeOptions()

SanitizeOptions(IData, IData)

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

public SanitizeOptions(IData inputData, IData outputData = null)

Parameters

inputData IData: Dữ liệu đầu vào.
outputData IData: Dữ liệu đầu ra.

SanitizeOptions(string, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.SanitizeOptions với các tệp đầu vào và đầu ra được chỉ định.

public SanitizeOptions(string inputFile, string outputFile)

Parameters

inputFile string: Đường dẫn tệp đầu vào.
outputFile string: Đường dẫn tệp đầu ra.

SanitizeOptions(Stream, Stream)

Khởi tạo một thể hiện mới của đối tượng Documentize.SanitizeOptions với các luồng đầu vào và đầu ra được chỉ định.

public SanitizeOptions(Stream inputStream, Stream outputStream)

Parameters

inputStream Stream: Luồng đầu vào.
outputStream Stream: Luồng đầu ra.

SanitizeOptions(string, Stream)

Khởi tạo một thể hiện mới của đối tượng Documentize.SanitizeOptions với tệp đầu vào và luồng đầu ra được chỉ định.

public SanitizeOptions(string inputFile, Stream outputStream)

Parameters

inputFile string: Đường dẫn tệp đầu vào.
outputStream Stream: Luồng đầu ra.

SanitizeOptions(Stream, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.SanitizeOptions với luồng đầu vào và tệp đầu ra được chỉ định.

public SanitizeOptions(Stream inputStream, string outputFile)

Parameters

inputStream Stream: Luồng đầu vào.
outputFile string: Đường dẫn tệp đầu ra.

Properties

ConvertPagesToImages

Lấy hoặc đặt tùy chọn chuyển các trang thành hình ảnh.
Việc chuyển đổi các trang thành hình ảnh sẽ diễn ra sau khi xóa dữ liệu ẩn chính, được điều khiển bởi các tùy chọn khác.
Mặc định là false.

public bool ConvertPagesToImages { get; set; }

Property Value

FlattenForms

Lấy hoặc đặt giá trị chỉ ra liệu các biểu mẫu trong tài liệu có được làm phẳng trong quá trình làm sạch hay không.
Việc làm phẳng biểu mẫu chuyển các trường biểu mẫu tương tác thành nội dung tĩnh, khiến chúng không thể chỉnh sửa hoặc điền được.
Mặc định là true.

public bool FlattenForms { get; set; }

Property Value

FlattenLayers

Lấy hoặc đặt tùy chọn làm phẳng các lớp trong tài liệu PDF.
Khi bật, tất cả các lớp trong tài liệu sẽ được hợp nhất thành một lớp duy nhất, loại bỏ cấu trúc riêng của chúng.
Tùy chọn này hữu ích cho việc làm sạch tài liệu bằng cách đơn giản hoá nội dung và đảm bảo không có dữ liệu ẩn trong các lớp.
Mặc định là true.

public bool FlattenLayers { get; set; }

Property Value

ImageDpi

Lấy hoặc đặt tùy chọn quyết định độ phân giải DPI của ảnh trang khi chuyển trang thành hình ảnh.
Thuộc tính này chỉ có hiệu lực nếu thuộc tính Documentize.SanitizeOptions.ConvertPagesToImages được đặt là true.

public int ImageDpi { get; set; }

Property Value

Input

Lấy hoặc đặt Dữ liệu Đầu vào.

public override IData Input { get; set; }

Property Value

Output

Lấy hoặc đặt Dữ liệu Đầu ra.

public override IData Output { get; set; }

Property Value

RemoveAnnotations

Lấy hoặc đặt giá trị chỉ ra liệu có xóa các chú thích khỏi tài liệu hay không.
Khi bật, tất cả các chú thích hiện có trong tài liệu sẽ bị xóa trong quá trình làm sạch.
Các chú thích bị che sẽ được áp dụng.
Mặc định là true.

public bool RemoveAnnotations { get; set; }

Property Value

RemoveAttachments

Lấy hoặc đặt tùy chọn xóa tất cả các tệp đính kèm khỏi tài liệu.
Khi bật, nó đảm bảo bất kỳ tệp đính kèm nào trong PDF cũng bị loại bỏ trong quá trình làm sạch.
Mặc định là true.

public bool RemoveAttachments { get; set; }

Property Value

RemoveJavaScriptsAndActions

Lấy hoặc đặt giá trị chỉ ra liệu các JavaScript và các hành động liên quan có nên bị xóa khỏi tài liệu hay không.
Tùy chọn này hữu ích để loại bỏ các lỗ hổng bảo mật tiềm ẩn do script nhúng gây ra.
Mặc định là true.

public bool RemoveJavaScriptsAndActions { get; set; }

Property Value

RemoveMetadata

Lấy hoặc đặt tùy chọn xóa siêu dữ liệu khỏi tài liệu.
Nếu đặt thành true, các siêu dữ liệu như thuộc tính tài liệu và thông tin siêu dữ liệu nhúng bổ sung sẽ bị xóa trong quá trình làm sạch.
Mặc định là true.

public bool RemoveMetadata { get; set; }

Property Value

RemoveSearchIndexAndPrivateInfo

Lấy hoặc đặt giá trị chỉ ra liệu chỉ mục tìm kiếm và thông tin cá nhân có nên bị xóa khỏi tài liệu hay không.
Cho phép xóa các chỉ mục tìm kiếm nhúng và dữ liệu cá nhân để tăng cường bảo mật và riêng tư cho tài liệu.
Mặc định là true.

public bool RemoveSearchIndexAndPrivateInfo { get; set; }

Property Value

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ã các tài liệu PDF.

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

Kế thừa

object ← Security

Thành viên kế thừa

Phương thức

Process(EncryptOptions)

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

public static ResultContainer Process(EncryptOptions options)

Tham số

options EncryptOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Giá trị trả về

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

Ngoại lệ

Nếu options chưa được thiết lập.

Process(DecryptOptions)

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

public static ResultContainer Process(DecryptOptions options)

Tham số

options DecryptOptions: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Giá trị trả về

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

Ngoại lệ

Nếu options chưa được thiết lập.

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

Class Signature

Thông tin

Đại diện cho plugin Documentize.Signature. Được sử dụng để ký tài liệu PDF.

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

Inheritance

object ← Signature

Inherited Members

Methods

Process(SignOptions)

Ký tài liệu PDF.

public static ResultContainer Process(SignOptions options)

Parameters

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

Returns

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

Exceptions

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

Namespace: Documentize
Assembly: Documentize.dll

Class SignOptions

Thông tin

Đại diện cho tùy chọn ký cho thành phần Documentize.PdfSecurity.

public sealed class SignOptions : OptionsWithInputAndOutput, IHaveInput

Inheritance

object ← OptionsWithInput ← OptionsWithInputAndOutput ← SignOptions

Implements

IHaveInput

Inherited Members

Constructors

SignOptions(Stream, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.SignOptions với luồng pfx và mật khẩu.

public SignOptions(Stream pfx, string password)

Parameters

pfx Stream: Luồng chứa tệp pfx.
password string: Mật khẩu của tệp pfx.

SignOptions(string, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.SignOptions với tệp pfx và mật khẩu.

public SignOptions(string pfx, string password)

Parameters

pfx string: Đường dẫn tới tệp pfx.
password string: Mật khẩu của tệp pfx.

SignOptions(IData, IData, IData, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.SignOptions với dữ liệu đầu vào, đầu ra, dữ liệu pfx và mật khẩu.

public SignOptions(IData inputData, IData outputData, IData pfxData, string password)

Parameters

inputData IData: Dữ liệu đầu vào.
outputData IData: Dữ liệu đầu ra.
pfxData IData: Dữ liệu pfx.
password string: Mật khẩu của pfx.

SignOptions(string, string, 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ệp đầu vào, đầu ra, pfx và mật khẩu.

public SignOptions(string inputFile, string outputFile, string pfxFile, string pfxPassword)

Parameters

inputFile string: Đường dẫn tệp đầu vào.
outputFile string: Đường dẫn tệp đầu ra.
pfxFile string: Đường dẫn tới tệp pfx.
pfxPassword string: Mật khẩu của pfx.

SignOptions(Stream, Stream, Stream, string)

Khởi tạo một thể hiện mới của đối tượng Documentize.SignOptions với các luồng đầu vào, đầu ra, pfx và mật khẩu.

public SignOptions(Stream inputStream, Stream outputStream, Stream pfxStream, string pfxPassword)

Parameters

inputStream Stream: Luồng tệp đầu vào.
outputStream Stream: Luồng tệp đầu ra.
pfxStream Stream: Luồng pfx.
pfxPassword string: Mật khẩu của pfx.

SignOptions(TimestampOptions)

Khởi tạo một thể hiện mới của đối tượng Documentize.SignOptions với tùy chọn Timestamp. Bạn có thể thiết lập timestamp cho tài liệu như một chữ ký riêng.

public SignOptions(TimestampOptions timestampOptions)

Parameters

timestampOptions TimestampOptions: Timestamp được sử dụng để tạo chữ ký timestamp mà không cần cung cấp chứng chỉ.

Properties

Contact

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

public string Contact { get; set; }

Property Value

Input

Lấy hoặc đặt dữ liệu đầu vào.

public override IData Input { get; set; }

Property Value

Location

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

public string Location { get; set; }

Property Value

Name

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

public string Name { get; set; }

Property Value

Output

Lấy hoặc đặt dữ liệu đầu ra.

public override IData Output { get; set; }

Property Value

PageNumber

Số trang mà chữ ký được đặt.

public int PageNumber { get; set; }

Property Value

Pfx

Luồng chứa dữ liệu PFX.

public Stream Pfx { get; set; }

Property Value

Stream

PfxPassword

Mật khẩu cho Documentize.SignOptions.Pfx.

public string PfxPassword { get; set; }

Property Value

Reason

Lý do của chữ ký.

public string Reason { get; set; }

Property Value

Rectangle

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

public Rectangle Rectangle { get; set; }

Property Value

Rectangle

TimestampOptions

Tùy chọn Timestamp. Timestamp được sử dụng để tạo chữ ký timestamp mà không cần cung cấp chứng chỉ. Nếu thuộc tính này được đặt và có chứng chỉ được cung cấp cho hàm khởi tạo của lớp Documentize.SignOptions, chữ ký số sẽ được gắn timestamp nhúng. Nếu thuộc tính này được đặt nhưng không có chứng chỉ nào được cung cấp, timestamp sẽ được thêm như một chữ ký riêng.

public TimestampOptions TimestampOptions { get; set; }

Property Value

TimestampOptions

Visible

Khả năng hiển thị của chữ ký. Mặc định là true.

public bool Visible { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class SplitOptions

Thông tin

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

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← SplitOptions

Implements

IPluginOptions

Inherited Members

Constructors

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

Biểu diễn plugin Documentize.Splitter. Được dùng để tách các tài liệu PDF thành các trang riêng biệt.

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

Kế thừa

object ← Splitter

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

Phương thức

Process(SplitOptions)

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

public static ResultContainer Process(SplitOptions options)

Tham số

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

Trả về

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

Ngoại lệ

Nếu không đặt options.

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

Class StreamData

Thông tin

Biểu diễn dữ liệu stream cho các thao tác tải và lưu.

public sealed class StreamData : IData

Kế thừa

object ← StreamData

Thực hiện

IData

Thành viên kế thừa

Hàm tạo

StreamData(Stream)

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

public StreamData(Stream data)

Tham số

data Stream: Đối tượng Stream

Thuộc tính

Data

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

public Stream Data { get; }

Giá trị thuộc tính

Stream

DataType

Kiểu dữ liệu (stream).

public DataType DataType { get; }

Giá trị thuộc tính

Không gian tên: Documentize Tập tin lắp ráp: 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

object ← StreamDataSource

Thực thi

IDataSource

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

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

object ←
StreamResult

Thực thi

IOperationResult

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

IsFile

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

public bool IsFile { get; }

Giá trị thuộc tính

IsStream

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

public bool IsStream { get; }

Giá trị thuộc tính

IsString

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

public bool IsString { get; }

Giá trị thuộc tính

Phương thức

ToFile()

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

public string ToFile()

Trả về

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

ToStream()

Cố gắng chuyển đổi kết quả thành đố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 null.

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

Class StringResult

Thông tin

Biểu diễn kết quả hoạt động dưới dạng chuỗi.

public sealed class StringResult : IOperationResult

Kế thừa

object ← StringResult

Triển khai

IOperationResult

Thành viên kế thừa

Thuộc tính

Data

Lấy dữ liệu thô.

public object Data { get; }

Giá trị Thuộc tính

IsFile

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

public bool IsFile { get; }

Giá trị Thuộc tính

IsStream

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

public bool IsStream { get; }

Giá trị Thuộc tính

IsString

Cho biết kết quả có phải là một chuỗi hay không.

public bool IsString { get; }

Giá trị Thuộc tính

Text

Trả về biểu diễn chuỗi của kết quả.

public string Text { get; }

Giá trị Thuộc tính

Phương thức

ToFile()

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

public string ToFile()

Trả về

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

ToStream()

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

public Stream ToStream()

Trả về

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

ToString()

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

public override string ToString()

Trả về

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

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Thông tin

Class đại diện cho trình xây dựng bảng trên trang pdf.

public class TableBuilder

Inheritance

object ← TableBuilder

Derived

TableRowBuilder

Inherited Members

Methods

AddRow()

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

public virtual TableRowBuilder AddRow()

Returns

TableRowBuilder : Instance of current Documentize.TableRowBuilder.

AddTable()

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

public TableBuilder AddTable()

Returns

TableBuilder : Instance of current Documentize.TableBuilder.

InsertPageAfter(int)

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

public TableOptions InsertPageAfter(int page)

Parameters

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

Returns

TableOptions : Instance of current Documentize.TableOptions.

InsertPageBefore(int)

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

public TableOptions InsertPageBefore(int page)

Parameters

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

Returns

TableOptions : Instance of current Documentize.TableOptions.

Operators

implicit operator TableOptions(TableBuilder)

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

public static implicit operator TableOptions(TableBuilder builder)

Parameters

builder TableBuilder: Instance of current Documentize.TableBuilder.

Returns

TableOptions : Result of conversion to PdfGeneratorTableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

Thông tin

Lớp đại diện cho bộ xây dựng ô bảng.

public class TableCellBuilder : TableRowBuilder

Kế thừa

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

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

Phương thức

AddCell()

Thêm ô vào bảng.

public override TableCellBuilder AddCell()

Giá trị trả về

TableCellBuilder : Instance of current Documentize.TableCellBuilder.

AddParagraph(params string[])

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

public TableCellBuilder AddParagraph(params string[] paragraphs)

Tham số

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

Giá trị trả về

TableCellBuilder : Instance of current Documentize.TableCellBuilder.

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

Thông tin

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

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

Kế thừa

object ← TableGenerator

Thành viên kế thừa

Ví dụ

The example demonstrates how to add table to PDF file.

// Cấu hình tùy chọn bảng
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .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 file đầu vào
options.AddInput(new FileData("path_to_input.pdf"));
// Đặt đường dẫn file đầu ra
options.AddOutput(new FileData("path_to_output.pdf"));
// Thực hiện quá trình
TableGenerator.Process(options);

Phương thức

Process(TableOptions)

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

public static 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 thao tác.

Giá trị 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 đặt.

Không gian tên: Documentize
Tệp lắp ráp: Documentize.dll

Class TableOptions

Thông tin

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

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← TableOptions

Thực hiện

IPluginOptions

Thành viên kế thừa

Hàm khởi tạo

TableOptions()

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

public TableOptions()

Phương thức

AddTable()

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

public TableBuilder AddTable()

Trả về

TableBuilder : Một thể hiện mới của Documentize.TableBuilder.

Create()

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

public static TableOptions Create()

Trả về

TableOptions : Một thể hiện mới của Documentize.TableOptions.

InsertPageAfter(int)

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

public TableOptions InsertPageAfter(int page)

Tham số

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

Trả về

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

InsertPageBefore(int)

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

public TableOptions InsertPageBefore(int page)

Tham số

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

Trả về

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

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

Thông tin

Lớp đại diện cho bộ xây dựng cho hàng bảng.

public class TableRowBuilder : TableBuilder

Kế thừa

object ←
TableBuilder ←
TableRowBuilder

Đối tượng được kế thừa

TableCellBuilder

Các 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 : Instance of created Documentize.TableCellBuilder.

AddRow()

Ghi đè AddRow.

public override TableRowBuilder AddRow()

Trả về

TableRowBuilder : Instance of current Documentize.TableRowBuilder.

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

Class TextExtractor

Thông tin

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

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

Inheritance

object ← TextExtractor

Inherited Members

Methods

Process(ExtractTextOptions)

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

public static string Process(ExtractTextOptions options)

Parameters

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

Returns

string : Một đối tượng chứa kết quả của việc trích xuất.

Exceptions

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

object ← TextExtractorOptions

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ố

formattingMode TextFormattingMode: Giá trị chế độ định dạng văn bản.

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

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.

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

Kế thừa

object ←
TiffConverter

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

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: Đối tượng tùy chọn chứa các hướng dẫn cho thao tác.

Đầu ra

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

Ngoại lệ

ArgumentException
Nếu options chưa được thiết lập.

Namespace: Documentize
Assembly: Documentize.dll

Class Timestamp

Thông tin

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

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

Inheritance

object ← Timestamp

Inherited Members

Methods

Process(AddTimestampOptions)

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

public static ResultContainer Process(AddTimestampOptions options)

Parameters

options AddTimestampOptions: Một đối tượng tùy chọn chứa 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

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

Namespace: Documentize Assembly: Documentize.dll

Class TimestampOptions

public class TimestampOptions

Kế thừa

object ← TimestampOptions

Thành viên kế thừa

Hàm tạo

TimestampOptions(string, string)

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

public TimestampOptions(string serverUrl, string basicAuthCredentials = "")

Tham số

serverUrl string: URL của máy chủ timestamp.
basicAuthCredentials string: Thông tin xác thực cơ bản, tên người dùng và mật khẩu được ghép thành một chuỗi “username:password”.

Thuộc tính

BasicAuthCredentials

Lấy/đặt thông tin xác thực cơ bản, tên người dùng và mật khẩu được ghép thành một chuỗi “username:password”.

public string BasicAuthCredentials { get; set; }

Giá trị thuộc tính

ServerUrl

Lấy/đặt URL của máy chủ timestamp.

public string ServerUrl { get; set; }

Giá trị thuộc tính

Không gian tên: Documentize
Tập tin lắp ráp: Documentize.dll

Class TocGenerator

Thông tin

Biểu diễn plugin Documentize.TocGenerator. Được sử dụng để thêm Mục Lục vào các tài liệu PDF.

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

Kế thừa

object ←
TocGenerator

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

Ví dụ

Ví dụ minh họa cách thêm Mục Lục vào tệp PDF.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

Ví dụ minh họa cách thêm Mục Lục vào tệp PDF kèm theo việc tạo dấu trang.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Generate links in bookmarks
options.GenerateBookmarks = true;
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

Ví dụ minh họa cách thêm Mục Lục vào tệp PDF và lưu dưới dạng luồng.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Perform the process
TocGenerator.Process(options);

Phương thức

Process(TocOptions)

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

public static ResultContainer Process(TocOptions options)

Tham số

options TocOptions: 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 Documentize.ResultContainer chứa kết quả của thao tác.

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

Class TocHeading

Thông tin

Đại diện cho các tùy chọn cho các tiêu đề hoặc tiêu đề phụ của Mục lục để tài liệu hóa bằng plugin Documentize.PdfManager.

public class TocHeading

Kế thừa

object ← TocHeading

Các thành viên được 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 = 1, 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 việc tạo số.
level int: Mức độ.

Thuộc tính

GenerateNumbering

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

public bool GenerateNumbering { get; set; }

Giá trị thuộc tính

Level

Mức độ. Được sử dụng cho việc tạo số.

public int Level { get; set; }

Giá trị thuộc tính

PageNumber

Số trang cho liên kết.

public int PageNumber { get; set; }

Giá trị thuộc tính

Text

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

public string Text { get; set; }

Giá trị thuộc tính

Không gian tên: Documentize
Bộ lắp ráp: Documentize.dll

Class TocOptions

Thông tin

Biểu diễn các tùy chọn để thêm Table of Contents vào tài liệu bằng Documentize.PdfManager plugin.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← TocOptions

Implements

IPluginOptions

Inherited Members

Constructors

TocOptions()

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

public TocOptions()

Properties

GenerateBookmarks

Sử dụng việc tạo Bookmarks.
Nếu đặt true thì Bookmarks sẽ được xóa và tạo lại dựa trên Headings; nếu không, Bookmarks sẽ không thay đổi.

public bool GenerateBookmarks { get; set; }

Property Value

Headings

Các Heading hoặc Tiêu đề của Table of Content.

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

Property Value

List<TocHeading>

Title

Tiêu đề của Table of Contents.

public string Title { get; set; }

Property Value

Namespace: Documentize
Assembly: Documentize.dll

Class Usage

Thông tin

Thống kê sử dụng cho yêu cầu hoàn thành.

public class Usage

Kế thừa

object ← Usage

Thành viên kế thừa

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

Usage()

public Usage()

Thuộc tính

CompletionTokens

Số token trong phần hoàn thành được tạo.

[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }

Giá trị thuộc tính

PromptTokens

Số token trong lời nhắc.

[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }

Giá trị thuộc tính

TotalTokens

Tổng số token được sử dụng trong yêu cầu (lời nhắc + hoàn thành).

[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }

Giá trị thuộc tính

Không gian tên: Documentize
Tập tin thực thi: 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 sang các định dạng XLSX/XLS/CSV/XLSM/ODS.

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

Kế thừa

object ← XlsConverter

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

Phương thức

Process(PdfToXlsOptions)

Chuyển đổi tài liệu PDF sang các định dạng XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Process(PdfToXlsOptions options)

Tham số

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

Trả về

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

Ngoại lệ

Nếu không thiết lập options.

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

Thông tin

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

public enum ConvertErrorAction

Các trường

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 có mặt nạ mềm.

public enum ConvertSoftMaskAction

Các trường

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

Namespace: Documentize
Assembly: Documentize.dll

Enum DataType

Thông tin

Biểu diễn các kiểu dữ liệu khả dĩ cho việc xử lý thành phần.

public enum DataType

Fields

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

Không gian tên: Documentize
Tập tin lắp ráp: Documentize.dll

Enum DocConversionMode

Thông tin

Xác định chế độ chuyển đổi của tài liệu đầu ra.

public enum DocConversionMode

Fields

Flow = 1: Chế độ nhận dạng đầy đủ, engine thực hiện việc nhóm và phân tích đa cấp để khôi phục ý định ban đầu của tác giả tài liệu và tạo ra một tài liệu có khả năng chỉnh sửa tối đa. Nhược điểm là tài liệu đầu ra có thể trông khác so với file PDF gốc.
TextBox = 0: Chế độ này nhanh và tốt cho việc bảo toàn tối đa giao diện gốc của file PDF, nhưng khả năng chỉnh sửa của tài liệu kết quả có thể bị hạn chế. Mỗi khối văn bản được nhóm trực quan trong file PDF gốc sẽ được chuyển thành một textbox trong tài liệu kết quả. Điều này đạt được độ giống nhau tối đa của tài liệu đầu ra với file PDF gốc. Tài liệu đầu ra sẽ trông đẹp, nhưng sẽ hoàn toàn được tạo bằng các textbox và có thể khiến việc chỉnh sửa tài liệu trong Microsoft Word khá khó khăn. Đây là chế độ mặc định.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

Thông tin

Xác định các loại phương tiện có thể được sử dụng trong quá trình render.

public enum HtmlMediaType

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

Thông tin

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

public enum HtmlPageLayoutOption

Fields

FitToWidestContentWidth = 3: Cho biết chiều rộng của trang được xác định dựa trên 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 HtmlPageLayoutOption sẽ không ảnh hưởng tới kích thước và bố cục của các trang.
ScaleToPageWidth = 256: Cho biết nội dung của tài liệu sẽ được thu phóng để vừa với chiều rộng trang.

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

Enum PdfAStandardVersion

Thông tin

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

public enum PdfAStandardVersion

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.

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

Enum PdfToHtmlOptions.SaveDataType

Thông tin

Xác định kiểu đầu ra của tệp HTML.

public enum PdfToHtmlOptions.SaveDataType

Fields

FileWithEmbeddedResources = 1: Lưu HTMl vào tệp với các tài nguyên nhúng
FileWithExternalResources = 0: Lưu HTMl vào tệp với các tài nguyên bên ngoài
StreamWithEmbeddedResources = 2: Lưu HTMl vào luồng tệp với các 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ị ngă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 hỗ trợ macro (.xlsm).
XLSX = 1: Định dạng Office Open XML (.xlsx).
XMLSpreadSheet2003 = 0: Định dạng 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

Các trường

Assistant = 2
System = 1
User = 0

Namespace: Documentize Assembly: Documentize.dll

Enum Rotation

Thông tin

Liệt kê các giá trị quay có thể.

public enum Rotation

Fields

None = 0: Không quay.
On180 = 2: Quay 180 độ.
On270 = 3: Quay 270 độ theo chiều kim đồng hồ.
On360 = 4: Quay 360 độ theo chiều kim đồng hồ.
On90 = 1: Quay 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

Enum TextFormattingMode

Thông tin

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

public enum TextFormattingMode

Fields

Flatten = 2: Biểu diễn nội dung PDF bằng các đoạn văn bản có vị trí dựa trên tọa độ của chúng. Nó cơ bản giống 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 (các toán tử) trong tài liệu, “Flatten” tập trung vào việc giữ văn bản theo thứ tự đọc.
Pure = 0: Biểu diễn nội dung văn bản PDF với một vài quy trình định dạng. Điều này bao gồm việc xem xét 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: Biểu diễn nội dung PDF nguyên trạng, tức là không có định dạng.

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

Enum TiffColorDepth

Thông tin

Được sử dụng để chỉ định độ sâu màu cho Documentize.PdfToTiffOptions.

public enum TiffColorDepth

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Enum TiffCompression

Thông tin

Được sử dụng để chỉ định loại nén cho Documentize.PdfToTiffOptions.

public enum TiffCompression

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Interface IData

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ể phải triển khai.

public interface IData

Thuộc tính

DataType

Kiểu của nguồn dữ liệu.

DataType DataType { get; }

Giá trị Thuộc tính

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

Namespace: Documentize Assembly: Documentize.dll

Interface IHaveInput

Thông tin

Giao diện dữ liệu chung xác định Dữ liệu Đầu vào mà Options nên triển khai.

public interface IHaveInput

Properties

Input

Lấy hoặc đặt Dữ liệu Đầu vào.

IData Input { get; set; }

Giá trị Thuộc tính

Namespace: Documentize Assembly: Documentize.dll

Interface IOperationResult

Thông tin

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

public interface IOperationResult

Thuộc tính

Data

Lấy dữ liệu thô.

object Data { get; }

Giá trị thuộc tính

IsFile

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

bool IsFile { get; }

Giá trị thuộc tính

IsStream

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

bool IsStream { get; }

Giá trị thuộc tính

IsString

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

bool IsString { get; }

Giá trị thuộc tính