Class AddTimestampOptions

[Obsolete("The class will be deleted soon. Please use SignOptions class.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← AddTimestampOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

AddTimestampOptions(Stream, string, string, string)

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

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

Parameters

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

AddTimestampOptions(string, string, string, string)

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

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

Parameters

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

Class ChatCompletion

public class ChatCompletion

Kế thừa

object ← ChatCompletion

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Các hàm tạo

ChatCompletion()

public ChatCompletion()

Các thuộc tính

Choices

Một danh sách các lựa chọn hoàn thành trò chuyện. Có thể có nhiều hơn một nếu n lớn hơn 1.

[JsonProperty("choices")]
public List<choice> Choices { get; set; }

Giá trị thuộc tính

List<Choice>

Created

Thời gian Unix (tính bằng giây) khi hoàn thành trò chuyện được tạo ra.

[JsonProperty("created")]
public long Created { get; set; }

Giá trị thuộc tính

long

Id

Một định danh duy nhất cho hoàn thành trò chuyện.

[JsonProperty("id")]
public string Id { get; set; }

Giá trị thuộc tính

string

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

string

Object

Loại đối tượng, luôn là chat.completion.

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

Giá trị thuộc tính

string

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

string

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

Class ChatGptConsts

public static class ChatGptConsts

Kế thừa

object ← ChatGptConsts

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Các trường

• ApiUrl

Giá trị trường

string

ModelName

public static string ModelName

Giá trị trường

string

SystemRole

public static string SystemRole

Giá trị trường

string

SystemRoleDescription

public static string SystemRoleDescription

Giá trị trường

string

UserRole

public static string UserRole

Giá trị trường

string

Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ←
PluginBaseOptions ←
ChatGptRequestOptions

Thực hiện

• IPluginOptions

Thành viên kế thừa

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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 cung cấp.

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 của 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

string

ApiUrl

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

public string ApiUrl { get; set; }

Giá trị thuộc tính

string

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 tập hợp tin nhắn như sau:

• Tin nhắn đầu tiên (nếu có) là 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ừ tập hợ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 đối tượng tin nhắn đại diện cho một tài liệu 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 ra 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

string

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

int

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 là tin nhắn đầu tiên trong tập hợp, sẽ được gửi trong yêu cầu.

public string Query { get; set; }

Giá trị thuộc tính

string

Temperature

Nhiệt độ lấy mẫu sẽ 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

double

Class Choice

public class Choice

Kế thừa

object ← Choice

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Các Constructor

Choice()

public Choice()

Các thuộc tính

FinishReason

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

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

Giá trị thuộc tính

string

Index

Chỉ số của lựa chọn trong danh sách các lựa chọn.

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

Giá trị thuộc tính

int

Message

Một thông điệp hoàn thành chat được tạo ra bởi mô hình.

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

Giá trị thuộc tính

Message

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← CompressOptions

Triển khai

• IPluginOptions

Thành viên kế thừa

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← DecryptionOptions

Triển khai

• IPluginOptions

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

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

DecryptionOptions(string)

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

public DecryptionOptions(string ownerPassword)

Tham số

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

Thuộc tính

OwnerPassword

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

public string OwnerPassword { get; set; }

Giá trị thuộc tính

string

Class DecryptOptions

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← DecryptOptions

Thực thi

• IPluginOptions

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

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

DecryptOptions(string)

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

public DecryptOptions(string ownerPassword)

Tham số

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

Thuộc tính

OwnerPassword

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

public string OwnerPassword { get; set; }

Giá trị thuộc tính

string

Class DirectoryData

public sealed class DirectoryData : IData

Kế thừa

object ← DirectoryData

Triển khai

• IData

Thành viên kế thừa

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Hàm khởi 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: Một chuỗi đại diện cho đường dẫn tới thư mục.

Thuộc tính

DataType

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

public DataType DataType { get; }

Giá trị thuộc tính

DataType

Path

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

public string Path { get; }

Giá trị thuộc tính

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Kế thừa

object ← DirectoryDataSource

Thực hiện

• IDataSource

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

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

DirectoryDataSource(string)

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

public DirectoryDataSource(string path)

Tham Số

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

Thuộc Tính

DataType

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

public DataType DataType { get; }

Giá Trị Thuộc Tính

DataType

Path

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

public string Path { get; }

Giá Trị Thuộc Tính

string

Class DocConverter

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

Kế thừa

object ← DocConverter

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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 hướng dẫn cho thao tác.

Trả về

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

Ngoại lệ

ArgumentException

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

Class EncryptionOptions

csharp
public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← EncryptionOptions

Triển khai

• IPluginOptions

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

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

EncryptionOptions(string, string)

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

csharp
public EncryptionOptions(string ownerPassword, string userPassword)

Tham số

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

Thuộc tính

OwnerPassword

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

csharp
public string OwnerPassword { get; set; }

Giá trị thuộc tính

string

UserPassword

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

csharp
public string UserPassword { get; set; }

Giá trị thuộc tính

string

Class EncryptOptions

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← EncryptOptions

Thực hiện

• IPluginOptions

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

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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 chủ sở hữu.
• userPassword string: Mật khẩu người dùng.

Thuộc tính

OwnerPassword

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

public string OwnerPassword { get; set; }

Giá trị thuộc tính

string

UserPassword

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

public string UserPassword { get; set; }

Giá trị thuộc tính

string

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Thực hiện

• IPluginOptions

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

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

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)

Tham số

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

Thuộc tính

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; }

Giá trị thuộc tính

bool

Delimiter

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

public char Delimiter { get; set; }

Giá trị thuộc tính

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractImagesOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

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

Class ExtractPropertiesOptions

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Inheritance

object ← OptionsWithInput ← ExtractPropertiesOptions

Implements

• IHaveInput

Inherited Members

• OptionsWithInput.Input,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

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

public ExtractPropertiesOptions(IData data)

Parameters

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

ExtractPropertiesOptions(string)

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

public ExtractPropertiesOptions(string file)

Parameters

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

ExtractPropertiesOptions(Stream)

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

public ExtractPropertiesOptions(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

IData

Class ExtractTextOptions

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Kế thừa

object ← OptionsWithInput ← ExtractTextOptions

Triển khai

• IHaveInput

Thành viên kế thừa

• OptionsWithInput.Input,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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ị của 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ị của 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ị của 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ị của 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

IData

Class FileData

public sealed class FileData : IData

Kế thừa

object ← FileData

Thực hiện

• IData

Thành viên kế thừa

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Các hàm 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

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

public DataType DataType { get; }

Giá trị thuộc tính

DataType

Path

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

public string Path { get; }

Giá trị thuộc tính

string

Class FileDataSource

public sealed class FileDataSource : IDataSource

Kế thừa

object ← FileDataSource

Thực thi

• IDataSource

Thành viên kế thừa

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

FileDataSource(string)

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

public FileDataSource(string path)

Tham số

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

Thuộc tính

DataType

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

public DataType DataType { get; }

Giá trị Thuộc tính

DataType

Path

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

public string Path { get; }

Giá trị Thuộc tính

string

Class FileResult

public sealed class FileResult : IOperationResult

Kế thừa

object ← FileResult

Thực hiện

• IOperationResult

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

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Các thuộc tính

Data

Lấy dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

object

IsFile

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

public bool IsFile { get; }

Giá trị thuộc tính

bool

IsStream

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

public bool IsStream { get; }

Giá trị thuộc tính

bool

IsString

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

public bool IsString { get; }

Giá trị thuộc tính

bool

Các phương thức

ToFile()

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

public string ToFile()

Trả về

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

ToStream()

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

public Stream ToStream()

Trả về

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

Class FlattenFieldsOptions

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← FlattenFieldsOptions

Triển khai

• IPluginOptions

Thành viên kế thừa

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Hàm khởi tạo

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

Thuộc tính

SkipFields

Danh sách các trường sẽ không được Flatten.

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

Giá trị Thuộc tính

List<string>

Class FormExporter

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

Kế thừa

object ← FormExporter

Thành viên kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Phương thức

Process(ExtractFormDataToDsvOptions)

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

public static ResultContainer Process(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.

Ngoại lệ

ArgumentException

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

Class FormExportToDsvOptions

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

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

FormExportToDsvOptions(char, bool)

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

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

Tham số

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

Các thuộc tính

AddFieldName

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

public bool AddFieldName { get; set; }

Giá trị thuộc tính

bool

Delimeter

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

public char Delimeter { get; set; }

Giá trị thuộc tính

char

Class FormFlattener

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

Inheritance

object ← FormFlattener

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Methods

GetFieldNames(string)

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

public static List<string> GetFieldNames(string path)

Parameters

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

Returns

List<string>

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

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

public static List<string> GetFieldNames(Stream stream)

Parameters

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

Returns

List<string>

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)

Parameters

• options FlattenFieldsOptions: Đố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.

Exceptions

ArgumentException

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

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← FormFlattenerOptions

Triển khai

• IPluginOptions

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

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Các bộ tạo

FormFlattenerOptions()

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

public FormFlattenerOptions()

Thuộc tính

SkipFields

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

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

Giá trị thuộc tính

List<string>

Class GetFieldNamesOptions

public class GetFieldNamesOptions

Kế thừa

object ← GetFieldNamesOptions

Thành viên kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Các hàm tạo

GetFieldNamesOptions(string)

Hàm tạo cho các tùy chọn với Đường dẫn tới tệp đầu vào.

public GetFieldNamesOptions(string path)

Tham số

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

GetFieldNamesOptions(Stream)

Hàm tạo cho các tùy chọn với Luồng đầu vào.

public GetFieldNamesOptions(Stream stream)

Tham số

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

Class HtmlConverter

[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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Phương thức

Process(PdfToHtmlOptions)

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

public static ResultContainer Process(PdfToHtmlOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

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

Process(HtmlToPdfOptions)

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

public static ResultContainer Process(HtmlToPdfOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

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

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← HtmlToPdfOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

HtmlToPdfOptions()

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

public HtmlToPdfOptions()

Properties

BasePath

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

public string BasePath { get; set; }

Property Value

string

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; }

Property Value

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; }

Property Value

bool

PageInfo

Lấy hoặc đặt thông tin trang của tài liệu.

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

Lấy hoặc đặt tùy chọn bố cục.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Class ImageExtractor

[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 kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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 options chứa hướng dẫn cho hoạt động.

Trả về

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

Ngoại lệ

ArgumentException

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

Class ImageExtractorOptions

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

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class Info

public static class Info

Kế thừa

object ← Info

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Trường

• AssemblyVersion Phiên bản Assembly.

public const string AssemblyVersion = "26.4.0"

Giá trị Trường

string

Sản phẩm

Tên sản phẩm.

public const string Product = "Documentize"

Giá trị Trường

string

Class JpegConverter

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

Kế thừa

object ← JpegConverter

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Phương thức

Process(PdfToJpegOptions)

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

public static ResultContainer Process(PdfToJpegOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

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

Class License

public static class License

Kế thừa

object ← License

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Ví dụ

Cho thấy cách kích hoạt giấy phép.

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

Phương thức

Set(string)

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

public static void Set(string licenseName)

Tham số

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

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Kế thừa

object ← PluginBaseOptions ← MergeOptions

Thực hiện

• IPluginOptions

Thành viên kế thừa

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Hàm khởi tạo

MergeOptions()

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

public MergeOptions()

Class Merger

[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 kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Phương thức

Process(MergeOptions)

Kết hợp các tài liệu PDF.

public static ResultContainer Process(MergeOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

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

Class Message

public class Message

Kế thừa

object ← Message

Thành viên Được Kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Message()

public Message()

Thuộc tính

Nội dung

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

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

Giá trị thuộc tính

string

Vai trò

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

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

Giá trị thuộc tính

Role

Class ObjectResult

public sealed class ObjectResult : IOperationResult

Kế thừa

object ← ObjectResult

Triển khai

• IOperationResult

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

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Thuộc tính

Data

Lấy dữ liệu thô.

public object Data { get; }

Giá trị thuộc tính

object

IsFile

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

public bool IsFile { get; }

Giá trị thuộc tính

bool

IsObject

Cho biết liệu kết quả có phải là một đối tượng hay không.

public bool IsObject { get; }

Giá trị thuộc tính

bool

IsStream

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

public bool IsStream { get; }

Giá trị thuộc tính

bool

IsString

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

public bool IsString { get; }

Giá trị thuộc tính

bool

Text

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

public string Text { get; }

Giá trị thuộc tính

string

Phương thức

ToFile()

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

public string ToFile()

Trả về

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

ToStream()

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

public Stream ToStream()

Trả về

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

ToString()

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

public override string ToString()

Trả về

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

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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 để

• 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 của người dùng, chẳng hạn như theo một liên kết, được thực hiện ngay cả khi trang chưa được nhận và hiển thị hoàn toàn.

public OptimizeOptions()

Class Optimizer

[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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Phương thức

Process(OptimizeOptions)

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

public static ResultContainer Process(OptimizeOptions options)

Tham số

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

Trả về

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

Process(RotateOptions)

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

public static ResultContainer Process(RotateOptions options)

Tham số

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

Trả về

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

Process(ResizeOptions)

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

public static ResultContainer Process(ResizeOptions options)

Tham số

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

Trả về

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

Process(CompressOptions)

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

public static ResultContainer Process(CompressOptions options)

Tham số

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

Trả về

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

Class OptionsWithInput

public abstract class OptionsWithInput : IHaveInput

Kế thừa

object ← OptionsWithInput

Các lớp dẫn xuất

• ExtractPropertiesOptions,
• ExtractTextOptions

Thực hiện

• IHaveInput

Thành viên kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Trường

• input

Giá trị Trường

IData

Thuộc tính

Input

Lấy hoặc thiết lập dữ liệu đầu vào.

public virtual IData Input { get; set; }

Giá trị Thuộc tính

IData

Class PageInfo

public class PageInfo : PageSize

Kế thừa

object ← PageSize ← PageInfo

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

• PageSize.Width,
• PageSize.Height,
• PageSize.IsLandscape,
• PageSize.A0,
• PageSize.A1,
• PageSize.A2,
• PageSize.A3,
• PageSize.A4,
• PageSize.A5,
• PageSize.A6,
• PageSize.B5,
• PageSize.PageLetter,
• PageSize.PageLegal,
• PageSize.PageLedger,
• PageSize.P11x17,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

PageInfo()

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

public PageInfo()

PageInfo(double, double)

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

public PageInfo(double width, double height)

Tham số

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

Các thuộc tính

MarginBottom

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

public double MarginBottom { get; set; }

Giá trị thuộc tính

double

MarginLeft

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

public double MarginLeft { get; set; }

Giá trị thuộc tính

double

MarginRight

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

public double MarginRight { get; set; }

Giá trị thuộc tính

double

MarginTop

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

public double MarginTop { get; set; }

Giá trị thuộc tính

double

Class PageSize

public class PageSize

Kế thừa

object ← PageSize

Được dẫn xuất

• PageInfo

Thành viên kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

PageSize()

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

public PageSize()

PageSize(double, double)

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

public PageSize(double width, double height)

Tham số

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

Thuộc tính

A0

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

public static PageSize A0 { get; }

Giá trị thuộc tính

PageSize

A1

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

public static PageSize A1 { get; }

Giá trị thuộc tính

PageSize

A2

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

public static PageSize A2 { get; }

Giá trị thuộc tính

PageSize

A3

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

public static PageSize A3 { get; }

Giá trị thuộc tính

PageSize

A4

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

public static PageSize A4 { get; }

Giá trị thuộc tính

PageSize

A5

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

public static PageSize A5 { get; }

Giá trị thuộc tính

PageSize

A6

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

public static PageSize A6 { get; }

Giá trị thuộc tính

PageSize

B5

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

public static PageSize B5 { get; }

Giá trị thuộc tính

PageSize

Chiều cao

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

public double Height { get; set; }

Giá trị thuộc tính

double

IsLandscape

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

public bool IsLandscape { get; }

Giá trị thuộc tính

bool

P11x17

Định dạng 11x17 inch.

public static PageSize P11x17 { get; }

Giá trị thuộc tính

PageSize

PageLedger

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

public static PageSize PageLedger { get; }

Giá trị thuộc tính

PageSize

PageLegal

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

public static PageSize PageLegal { get; }

Giá trị thuộc tính

PageSize

PageLetter

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

public static PageSize PageLetter { get; }

Giá trị thuộc tính

PageSize

Chiều rộng

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

public double Width { get; set; }

Giá trị thuộc tính

double

Class PdfAConverter

[Obsolete("Lớp này sẽ bị xóa sớm. Vui lòng sử dụng lớp PdfConverter.")]
public static class PdfAConverter

Kế thừa

object ← PdfAConverter

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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: Một đối tượng tùy chọn chứa hướng dẫn cho hoạt động.

Trả về

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

Ngoại lệ

ArgumentException

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

Process(PdfAValidateOptions)

Kiểm tra tài liệu PDF xem có tuân thủ định dạng PDF/A đã chỉ định hay không.

public static ResultContainer Process(PdfAValidateOptions options)

Tham số

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

Trả về

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

Ngoại lệ

ArgumentException

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

Class PdfAConvertOptions

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

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

PdfAConvertOptions()

public PdfAConvertOptions()

Các thuộc tính

Outputs

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

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

List<IDataSource>

Các phương thức

AddOutput(IDataSource)

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

public void AddOutput(IDataSource dataSource)

Các tham số

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

Class PdfAOptionsBase

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

Inheritance

object ← PdfAOptionsBase

Derived

• PdfAValidateOptions,
• PdfToPdfAOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

Gets or sets a value indicating whether additional means are necessary to preserve text alignment during the PDF/A conversion process.

public bool AlignText { get; set; }

Property Value

bool

Remarks

When set to true, the conversion process will attempt to restore the original text segment bounds. For the most of the documents there is no need to change this property from the default false value, as the text alignment doesn’t change during the default conversion process.

CheckDifferentNamesInFontDictionaries

Gets the flags that control the PDF/A conversion for cases when the source PDF document doesn’t correspond to the PDF specification.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

bool

ErrorAction

Gets or sets the action to be taken for objects that cannot be converted.

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

Gets or sets the filename of the ICC (International Color Consortium) profile to be used for the PDF/A conversion in place of the default one.

public string IccProfileFileName { get; set; }

Property Value

string

Inputs

Gets collection of data.

public List<idata> Inputs { get; }

Property Value

List<IData>

IsLowMemoryMode

Gets or sets a value indicating whether the low memory mode is enabled during the PDF/A conversion process.

public bool IsLowMemoryMode { get; set; }

Property Value

bool

LogOutputSource

Gets or sets the data source for the log output.

public IData LogOutputSource { get; set; }

Property Value

IData

OptimizeFileSize

Gets or sets a value indicating whether to try to reduce the file size during the PDF/A conversion process.

public bool OptimizeFileSize { get; set; }

Property Value

bool

Remarks

When set to true, the conversion process will attempt to minimize the resulting file size. This might affect the conversion process performance.

PdfAVersion

Gets or sets the version of the PDF/A standard to be used for validation or conversion.

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

The PDF/A standard version is used to determine the compliance level for PDF/A validation and conversion. If the version is set to Documentize.PdfAStandardVersion.Auto, the system will automatically determine the appropriate PDF/A standard version for validation based on the document metadata. For the PDF/A conversion process the Documentize.PdfAStandardVersion.Auto defaults to the PDF/A-1b standard version.

SoftMaskAction

Gets or sets the action to be taken during the conversion of images with soft masks.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IData)

Adds new data to the collection

public void AddInput(IData data)

Parameters

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

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Kế thừa

object ← PdfAOptionsBase ← PdfAValidateOptions

Thực thi

• IPluginOptions

Thành viên kế thừa

• PdfAOptionsBase.AddInput(IData),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Hàm khởi tạo

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Kế thừa

object ← PdfAValidationResult

Thành viên kế thừa

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Trường

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

• public readonly IData Data

Giá trị trường

IData

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

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Giá trị trường

PdfAStandardVersion

Class PdfChatGpt

[Obsolete("Lớp sẽ bị xóa sớm. Vui lòng sử dụng lớp PdfManager.")]
public static class PdfChatGpt

Kế thừa

object ← PdfChatGpt

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

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Nhận xét

Documentize.PdfChatGpt được sử dụng để gửi yêu cầu đến ChatGPT trực tiếp hoặc bằng cách thêm nguồn tệp PDF và lưu phản hồ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ộ. Sử dụng phương thức ProcessAsync thay vào đó.

public static ResultContainer Process(IPluginOptions options)

Tham số

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

Trả về

ResultContainer : #### Ngoại lệ

NotImplementedException

ProcessAsync(IPluginOptions)

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

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

Tham số

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

Trả về

Task<ResultContainer>

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

Ngoại lệ

ArgumentException : InvalidOperationException

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Kế thừa

object ← PdfChatGptOptions

Kế thừa từ

• PdfChatGptRequestOptions

Thực hiện

• IPluginOptions

Thành viên kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfChatGptOptions()

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

public PdfChatGptOptions()

Thuộc tính

Inputs

public List<idatasource> Inputs { get; }

Giá trị thuộc tính

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Giá trị thuộc tính

List<IDataSource>

Phương thức

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Tham số

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

AddOutput(IDataSource)

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

public void AddOutput(IDataSource saveDataSource)

Tham số

• saveDataSource IDataSource: Nguồn dữ liệu (tệp hoặc luồng) cho các kết quả của thao tác lưu. :

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Kế thừa

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Triển khai

• IPluginOptions

Thành viên kế thừa

• PdfChatGptOptions.AddInput(IDataSource),
• PdfChatGptOptions.AddOutput(IDataSource),
• PdfChatGptOptions.Inputs,
• PdfChatGptOptions.Outputs,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

string

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

string

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

string

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

int

Query

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

public string Query { get; set; }

Giá trị thuộc tính

string

Temperature

Nhiệt độ lấy mẫu để sử dụng, giữa 0 và 2. Giá trị cao 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

double

Class PdfConverter

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

public static class PdfConverter

Kế thừa

object ← PdfConverter

Thành viên kế thừa

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Phương thức

Convert(PdfToDocOptions)

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

public static ResultContainer Convert(PdfToDocOptions options)

Tham số

• options PdfToDocOptions: Đố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ệ

ArgumentException

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

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: Đố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 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 đổi 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ệ

ArgumentException

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

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: Đố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 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ệ

ArgumentException

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

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: Đố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 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ệ

ArgumentException

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

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: Đố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 tài liệu PDF sang định dạng 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 tài liệu PDF sang định dạng JPEG tới các stream.

// 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ệ

ArgumentException

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

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: Đố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 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 đổi 1 trang của tài liệu PDF sang định dạng 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 đổi tài liệu PDF sang định dạng PNG tới các stream.

// Create PdfToJpegOptions 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ệ

ArgumentException

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

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: Đố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 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 đổi tài liệu PDF sang định dạng 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);