Tiểu mục của Documentize Namespace
Class AddTimestampOptions
Thông tin
Đại diện cho Tùy chọn Thêm Dấu Thời Gian cho plugin Documentize.Timestamp.
[Obsolete("Lớp này sẽ sớm bị xóa. Vui lòng sử dụng lớp SignOptions.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
AddTimestampOptions
Triển khai
Các 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
AddTimestampOptions(Stream, string, string, string)
Khởi tạo một thể hiện mới của đối tượng Documentize.AddTimestampOptions với các tùy chọn mặc định.
public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")
Tham số
pfx Stream: Đường dẫn đến file pfx.password string: Mật khẩu cho file pfx.serverUrl string: Địa chỉ url của máy chủ dấu thời gian.serverBasicAuthCredentials string: Thông tin xác thực xác thực cơ bản, tên người dùng và mật khẩu được kết hợp thành 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 = "")
Tham số
pfx string: Đường dẫn đến file pfx.password string: Mật khẩu cho file pfx.serverUrl string: Địa chỉ url của máy chủ dấu thời gian.serverBasicAuthCredentials string: Thông tin xác thực xác thực cơ bản, tên người dùng và mật khẩu được kết hợp thành một chuỗi “username:password”. (Tùy chọn).
Class ChatCompletion
Thông tin
Đại diện cho một phản hồi hoàn thành trò chuyện được trả về bởi mô hình, dựa trên đầu vào đã cung cấp.
public class ChatCompletion
Kế thừa
object ←
ChatCompletion
Các thành viên kế thừa
Các hàm tạo
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
Thông tin
Lớp này đại diện cho một kho chứa cho 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
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
Thông tin
Đại diện cho các tùy chọn cho plugin Documentize.PdfManager.
public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
ChatGptRequestOptions
Triển khai
Các 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()
Constructors
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.
public ChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)
Tham số
Thuộc tính
ApiKey
Lấy hoặc thiết lập khóa để truy cập vào API ChatGPT.
public string ApiKey { get; set; }
Giá trị Thuộc tính
string
ApiUrl
Lấy hoặc thiết lập URL API ChatGPT.
public string ApiUrl { get; set; }
Giá trị Thuộc tính
string
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, có nghĩa là vô hạn.
public int? MaxTokens { get; set; }
Giá trị Thuộc tính
int?
Messages
Lấy hoặc thiết lập một 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>
Nhận xét
Khi thêm nhiều tin nhắn vào các tùy chọn, thứ tự trong tập hợp các tin nhắn như sau:
- Tin nhắn đầu tiên (nếu có) từ options.Query, trước đó là tin nhắn có nội dung: “Bạn là một trợ lý hữu ích.”,
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ột đối tượng tin nhắn cho mỗi tài liệu với vai trò “user”.
Nếu không có một 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 tới ChatGPT.
Nếu không rỗ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ử dụng, giữa 0 và 2.
Các giá trị cao như 0.8 sẽ làm cho đầu ra ngẫu nhiên hơn,
trong khi các 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 Choice
Thông tin
Một lựa chọn hoàn thành chat.
Kế thừa
object ←
Choice
Các thành viên kế thừa
Các Constructor
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
Thông tin
Đại diện cho các tùy chọn nén cho plugin Documentize.PdfManager.
public sealed class CompressOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
CompressOptions
Thực hiện
Các thành viên kế thừa
- 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 trình 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.
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
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
Thông tin
Đại diện cho 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
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
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.
Các thuộc tính
OwnerPassword
Mật khẩu chủ sở hữu.
public string OwnerPassword { get; set; }
Giá trị thuộc tính
string
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
Các Thành Viên Kế Thừa
Các Hàm Khởi Tạo
DirectoryDataSource(string)
Khởi tạo dữ liệu thư mục mới với đường dẫn được chỉ định.
public DirectoryDataSource(string path)
Tham Số
path string: Một chuỗi đại diện cho đường dẫn tới thư mục.
Thuộc Tính
DataType
Loại nguồn dữ liệu.
public DataType DataType { get; }
Giá Trị Thuộc Tính
DataType
Path
Lấy đường dẫn tới thư mục của dữ liệu hiện tại.
public string Path { get; }
Giá Trị Thuộc Tính
string
Class DocConverter
Thông tin
Đại diện cho plugin Documentize.DocConverter. Được sử dụng để chuyển đổi tài liệu PDF sang định dạng DOC/DOCX.
[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
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
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
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
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
Triển khai
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()
Constructors
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
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 plugin Documentize.PdfForm và Documentize.PdfExtractor.
public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions
Inheritance
object ←
PluginBaseOptions ←
ExtractFormDataToDsvOptions
Implements
Inherited Members
- 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()
Constructors
Khởi tạo một thể hiện mới của đối tượng Documentize.ExtractFormDataToDsvOptions.
public ExtractFormDataToDsvOptions(char delimeter = ',', bool addFieldNames = false)
Parameters
delimeter 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.
Properties
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
bool
Ký tự phân tách được sử dụng cho các giá trị xuất.
public char Delimeter { get; set; }
Property Value
char
Thông tin
Đại diện cho các tùy chọn trích xuất hình ảnh cho plugin Documentize.PdfExtractor.
public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
ExtractImagesOptions
Triển khai
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()
Constructors
Khởi tạo một phiên bản mới của đối tượng Documentize.ExtractImagesOptions với các tùy chọn mặc định.
public ExtractImagesOptions()
Thông tin
Biểu diễn các tùy chọn trích xuất thuộc tính PDF cho plugin Documentize.PdfExtractor.
public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput
Inheritance
object ←
OptionsWithInput ←
ExtractPropertiesOptions
Implements
Inherited Members
Constructors
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()
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(IDataSource data)
Parameters
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.
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
Properties
Lấy hoặc đặt dữ liệu đầu vào.
public override IDataSource Input { get; set; }
Property Value
IDataSource
Thông tin
Đại diện cho các tùy chọn trích xuất văn bản cho plugin Documentize.PdfExtractor.
public sealed class ExtractTextOptions
Kế thừa
object ←
ExtractTextOptions
Các thành viên kế thừa
Các hàm khởi tạo
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 đã chỉ định.
public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)
Tham số
Các thuộc tính
Lấy chế độ định dạng.
public TextFormattingMode FormattingMode { get; set; }
Giá trị thuộc tính
TextFormattingMode
Trả về dữ liệu Inputs cho thao tác.
public List<idatasource> Inputs { get; }
Giá trị thuộc tính
List<IDataSource>
Các phương thức
Thêm dữ liệu mới vào Inputs.
public void AddInput(IDataSource dataSource)
Tham số
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
Thành viên kế thừa
Các hàm khởi tạo
FileDataSource(string)
Khởi tạo nguồn dữ liệu tệp mới với đường dẫn được chỉ định.
public FileDataSource(string path)
Tham số
path string: Một chuỗi đại diện cho đường dẫn đến tệp nguồn.
Thuộc tính
DataType
Loại nguồn dữ liệu.
public DataType DataType { get; }
Giá trị Thuộc tính
DataType
Path
Lấy đường dẫn đến tệp của dữ liệu hiện tại.
public string Path { get; }
Giá trị Thuộc tính
string
Class FileResult
Thông tin
Đại diện cho kết quả hoạt động dưới dạng đường dẫn chuỗi đến tệp.
public sealed class FileResult : IOperationResult
Kế thừa
object ←
FileResult
Thực hiện
Các thành viên kế thừa
Các thuộc tính
Data
Lấy dữ liệu thô.
public object Data { get; }
Giá trị thuộc tính
object
IsFile
Cho biết liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.
public bool IsFile { get; }
Giá trị thuộc tính
bool
IsStream
Cho biết liệu kết quả có phải là một luồng đầu ra hay không.
public bool IsStream { get; }
Giá trị thuộc tính
bool
IsString
Cho biết liệu kết quả có phải là một chuỗi văn bản hay không.
public bool IsString { get; }
Giá trị thuộc tính
bool
Các phương thức
ToFile()
Cố gắng chuyển đổi kết quả thành một tệp.
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.
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
Thông tin
Đại diện cho các tùy chọn khi làm phẳng các trường trong tài liệu bằng plugin Documentize.PdfForm.
public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions
Inheritance
object ←
PluginBaseOptions ←
FlattenFieldsOptions
Implements
Inherited Members
- 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()
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
List<string>
Thông tin
Đại diện cho Documentize.FormExporter plugin. Được sử dụng để xuất giá trị Form 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
Kế thừa
object ←
FormExporter
Thành viên kế thừa
Phương thức
Bắt đầu xử lý Documentize.FormExporter với các tham số được chỉ định.
public static ResultContainer Process(ExtractFormDataToDsvOptions options)
Tham số
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.
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
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
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
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
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
Thông tin
Đại diện cho plugin Documentize.FormFlattener. Được 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
Inheritance
object ←
FormFlattener
Inherited Members
Ví dụ
Ví dụ minh họa cách làm phẳng các trường trong tệp PDF.
// Create FormFlattenerOptions object to set instructions
var options = new FormFlattenerOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
FormFlattener.Process(options);
Ví dụ minh họa cách làm phẳng các trường trong tệp PDF và bỏ qua trường đầu tiên.
// Get Fields Names
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Create FormFlattenerOptions object to set instructions
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
FormFlattener.Process(options);
Ví dụ minh họa cách lấy tên các trường từ tệp PDF.
// Get Fields Names
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
Phương thức
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ề
List<string>
Danh sách các tên trong tài liệu PDF.
public static List<string> GetFieldNames(Stream stream)
Tham số
stream Stream: Luồng chứa tài liệu PDF.
Trả về
List<string>
Danh sách các tên trong tài liệu PDF.
public static ResultContainer Process(FlattenFieldsOptions options)
Tham số
Trả về
ResultContainer : Đố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.
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
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
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
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
Thông tin
Đại diện cho các tùy chọn của Get Field Names trong tài liệu bởi plugin Documentize.PdfForm.
public class GetFieldNamesOptions
Kế thừa
object ←
GetFieldNamesOptions
Thành viên kế thừa
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ố
Class HtmlConverter
Thông tin
Đại diện cho plugin Documentize.HtmlConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng HTML và tài liệu HTML thành định dạng PDF.
[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 thành định dạng HTML.
public static ResultContainer Process(PdfToHtmlOptions options)
Tham số
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ố
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
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
Triển khai
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.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ơ bản cho tệp html.
public string BasePath { get; set; }
Giá trị thuộc tính
string
Lấy hoặc thiết lập các loại phương tiện có thể sử dụng trong quá trình tạo.
public HtmlMediaType HtmlMediaType { get; set; }
Giá trị thuộc tính
HtmlMediaType
IsRenderToSinglePage
Lấy hoặc thiết lập xem tất cả tài liệu trên một trang duy nhất.
public bool IsRenderToSinglePage { get; set; }
Giá trị thuộc tính
bool
PageInfo
Lấy hoặc thiết lập thông tin trang tài liệu.
public PageInfo PageInfo { get; set; }
Giá trị thuộc tính
PageInfo
PageLayoutOption
Lấy hoặc thiết lập tùy chọn bố cục.
public HtmlPageLayoutOption PageLayoutOption { get; set; }
Giá trị thuộc tính
HtmlPageLayoutOption
Thông tin
Đại diện cho plugin Documentize.ImageExtractor. Được sử dụng để trích xuất hình ảnh từ tài liệu PDF.
[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
Phương thức
Trích xuất hình ảnh từ tài liệu PDF.
public static ResultContainer Process(ExtractImagesOptions options)
Tham số
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.
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
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
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
Thông tin
Lớp này cung cấp thông tin về bản dựng sản phẩm hiện tại.
Kế thừa
object ←
Info
Thành viên kế thừa
Trường
AssemblyVersion Phiên bản Assembly.
Giá trị trường
string
Product
Tên sản phẩm.
public const string Product = "Documentize"
Giá trị trường
string
Class JpegConverter
Thông tin
Đại diện cho plugin Documentize.JpegConverter. Được sử dụng để chuyển đổi các tài liệu PDF thành định dạng JPEG.
[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
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
Thông tin
Cung cấp phương thức để thiết lập Giấy phép.
public static class License
Kế thừa
object ←
License
Các thành viên kế thừa
Ví dụ
Cho thấy cách kích hoạt giấy phép.
// Thiết lập Giấy phép
License.Set("PathToLicense.lic");
Phương thức
Set(string)
Cấp phép cho thành phần.
public static void Set(string licenseName)
Tham số
licenseName string: Có thể là tên tệp đầy đủ hoặc ngắn. Sử dụng chuỗi trống để chuyển sang chế độ đánh giá.
Class MergeOptions
Thông tin
Đại diện cho các tùy chọn hợp nhất cho plugin Documentize.PdfManager.
public sealed class MergeOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
MergeOptions
Implements
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
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.
Class Merger
Thông tin
Đại diện cho plugin Documentize.Merger. Sử dụng để kết hợp nhiều tài liệu PDF thành một 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 kế thừa
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
Thông tin
Một tin nhắn hoàn thành cuộc trò chuyện được tạo ra bởi mô hình.
Kế thừa
object ←
Message
Thành viên Được Kế thừa
Các hàm khởi tạo
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
Thông tin
Đại diện cho kết quả hoạt động dưới dạng chuỗi.
public sealed class ObjectResult : IOperationResult
Kế thừa
object ←
ObjectResult
Triển khai
Thành viên được kế thừa
Thuộc tính
Data
Lấy dữ liệu thô.
public object Data { get; }
Giá trị thuộc tính
object
IsFile
Cho biết liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.
public bool IsFile { get; }
Giá trị thuộc tính
bool
IsObject
Cho biết liệu kết quả có phải là một đối tượng hay không.
public bool IsObject { get; }
Giá trị thuộc tính
bool
IsStream
Cho biết liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.
public bool IsStream { get; }
Giá trị thuộc tính
bool
IsString
Cho biết liệu kết quả có phải là một chuỗi hay không.
public bool IsString { get; }
Giá trị thuộc tính
bool
Text
Trả về đại diện chuỗi của kết quả.
public string Text { get; }
Giá trị thuộc tính
string
Phương thức
ToFile()
Cố gắng chuyển đổi kết quả thành một tệp.
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.
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
Thông tin
Đại diện cho các tùy chọn tối ưu hóa cho plugin Documentize.PdfManager.
public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
OptimizeOptions
Triển khai
Các 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.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Các hàm khởi tạo
OptimizeOptions()
Khởi tạo một thể hiện mới của đối tượng Documentize.OptimizeOptions với các tùy chọn mặc định.
Định tuyến tài liệu nhằm
- mở trang đầu tiên nhanh nhất có thể;
- hiển thị trang tiếp theo hoặc theo liên kết đến trang tiếp theo nhanh nhất có thể;
- hiển thị trang theo từng phần khi nó đến khi dữ liệu cho một trang được cung cấp qua một kênh chậm (hiển thị dữ liệu hữu ích nhất trước);
- cho phép tương tác của người dùng, chẳng hạn như theo liên kết, được thực hiện ngay cả trước khi toàn bộ trang đã được nhận và hiển thị.
Class Optimizer
Thông tin
Đại diện cho plugin Documentize.Optimizer. Dùng để Tối ưu, 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 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.
Thông tin
Biểu diễn các tùy chọn cơ bản cho các thao tác với 1 dữ liệu đầu vào.
public abstract class OptionsWithInput : IHaveInput
Kế thừa
object ←
OptionsWithInput
Lớp con
Thực hiện
Thành viên kế thừa
Trường
Giá trị Trường
IDataSource
Thuộc tính
Lấy hoặc đặt Dữ liệu Đầu vào.
public virtual IDataSource Input { get; set; }
Giá trị Thuộc tính
IDataSource
Class PageInfo
Thông tin
Đại diện cho thông tin trang.
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.
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
Thông tin
Lớp đại diện cho kích thước trang trong tài liệu PDF.
Kế thừa
object ←
PageSize
Được dẫn xuất
Thành viên kế thừa
Các hàm khởi tạo
PageSize()
Hàm khởi tạo của Documentize.PageSize. Kích thước A4 theo mặc định.
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
Thông tin
Đại diện cho một plugin để xử lý chuyển đổi tài liệu PDF ở định dạng PDF/A và để xác thực sự tuân thủ PDF/A.
[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
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ố
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ố
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
Thông tin
Đại diện cho các tùy chọn để chuyển đổi tài liệu PDF sang định dạng PDF/A với plugin Documentize.PdfAConverter.
public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions
Kế thừa
object ←
PdfAOptionsBase ←
PdfAConvertOptions
Thực hiện
Các thành viên kế thừa
- 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
Thông tin
Đại diện cho lớp cơ sở cho các tùy chọn plugin Documentize.PdfAConverter. Lớp này cung cấp các thuộc tính và phương thức để cấu hình quá trình chuyển đổi và xác thực PDF/A.
Đại diện cho lớp cơ sở cho các tùy chọn plugin Documentize.PdfAConverter.
Lớp này cung cấp các thuộc tính và phương thức để cấu hình quá trình chuyển đổi và xác thực PDF/A.
public abstract class PdfAOptionsBase : IPluginOptions
Kế thừa
object ←
PdfAOptionsBase
Kế thừa khác
Thực hiện
Thành viên kế thừa
Các hàm khởi tạo
PdfAOptionsBase()
protected PdfAOptionsBase()
Thuộc tính
AlignText
Lấy hoặc thiết lập giá trị cho biết liệu có cần thêm phương tiện để bảo tồn căn chỉnh văn bản
trong quá trình chuyển đổi PDF/A hay không.
public bool AlignText { get; set; }
Giá trị thuộc tính
bool
Nhận xét
Khi được thiết lập thành true, quá trình chuyển đổi sẽ cố gắng phục hồi các 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 từ 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ờ điều khiển quá trình chuyển đổi PDF/A cho các trường hợp khi tài liệu PDF nguồn không
tương ứng với đặc tả PDF.
public bool CheckDifferentNamesInFontDictionaries { get; set; }
Giá trị thuộc tính
bool
ErrorAction
Lấy hoặc thiết lập hành động cần 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 thiết lập tên tệp của hồ sơ ICC (International Color Consortium) sẽ được sử dụng cho việc chuyển đổi PDF/A thay cho
một cái mặc định.
public string IccProfileFileName { get; set; }
Giá trị thuộc tính
string
Lấy tập hợp các nguồn dữ liệu
public List<idatasource> Inputs { get; }
Giá trị thuộc tính
List<IDataSource>
IsLowMemoryMode
Lấy hoặc thiết lập giá trị cho biết chế độ bộ nhớ thấp có được kích hoạt trong quá trình chuyển đổi PDF/A hay không.
public bool IsLowMemoryMode { get; set; }
Giá trị thuộc tính
bool
LogOutputSource
Lấy hoặc thiết lập nguồn dữ liệu cho đầu ra nhật ký.
public IDataSource LogOutputSource { get; set; }
Giá trị thuộc tính
IDataSource
OptimizeFileSize
Lấy hoặc thiết lập giá trị cho biết có nên cố gắng giảm kích thước tệp trong quá trình chuyển đổi PDF/A hay không.
public bool OptimizeFileSize { get; set; }
Giá trị thuộc tính
bool
Nhận xét
Khi được thiết lập thành true, quá trình chuyển đổi sẽ cố gắng tối thiểu hóa kích thước tệp kết quả.
Điều này có thể ảnh hưởng đến hiệu suất của quá trình chuyển đổi.
PdfAVersion
Lấy hoặc thiết lập phiên bản của tiêu chuẩn PDF/A sẽ được sử dụng để xác thực hoặc chuyển đổi.
public PdfAStandardVersion PdfAVersion { get; set; }
Giá trị thuộc tính
PdfAStandardVersion
Nhận xét
Phiên bản tiêu chuẩn PDF/A được sử dụng để xác định mức độ tuân thủ cho xác thực và chuyển đổi PDF/A.
Nếu phiên bản được thiết lập 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 xác thực dựa trên siêu dữ liệu tài liệu.
Đối với quá trình chuyển đổi PDF/A, Documentize.PdfAStandardVersion.Auto mặc định là phiên bản tiêu chuẩn PDF/A-1b.
SoftMaskAction
Lấy hoặc thiết lập hành động cần thực hiện trong quá trình chuyển đổi các hình ảnh có mặt nạ mềm.
public ConvertSoftMaskAction SoftMaskAction { get; set; }
Giá trị thuộc tính
ConvertSoftMaskAction
Phương thức
Thêm nguồn dữ liệu mới vào tập hợp
public void AddInput(IDataSource dataSource)
Tham số
Class PdfAValidateOptions
Thông tin
Đại diện cho các tùy chọn để xác thực tính tuân thủ PDF/A của các tài liệu PDF với plugin Documentize.PdfConverter.
public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions
Kế thừa
object ←
PdfAOptionsBase ←
PdfAValidateOptions
Triển khai
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
PdfAValidateOptions()
public PdfAValidateOptions()
Class PdfAValidationResult
Thông tin
Đại diện cho kết quả của một quy trình xác thực PDF/A.
public sealed class PdfAValidationResult
Kế thừa
object ←
PdfAValidationResult
Thành viên kế thừa
Các trường
DataSource Lấy nguồn dữ liệu đã được xác thực.
Giá trị trường
IDataSource
IsValid
Lấy một giá trị cho biết liệu việc xác thực có thành công hay không.
public readonly bool IsValid
Giá trị trường
bool
StandardVersion
Lấy phiên bản tiêu chuẩn PDF/A được sử dụng cho việc xác thực.
public readonly PdfAStandardVersion StandardVersion
Giá trị trường
PdfAStandardVersion
Class PdfChatGpt
Thông tin
Đại diện cho plugin 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
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
Thông tin
Đại diện cho các tùy chọn cho plugin Documentize.PdfChatGpt.
public class PdfChatGptOptions : IPluginOptions
Kế thừa
object ←
PdfChatGptOptions
Kế thừa từ
Thực hiện
Thành viên kế thừa
Constructors
PdfChatGptOptions()
Khởi tạo một thể hiện mới của đối tượng Documentize.PdfChatGptOptions.
public PdfChatGptOptions()
Thuộc tính
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
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
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
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ố
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
Thông tin
Đại diện cho plugin Documentize.PdfConverter. 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 bạn thực hiện xác minh PDF/A và chuyển đổi HTML sang PDF.
Đại diện cho plugin Documentize.PdfConverter. 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 bạn thực hiện xác minh PDF/A và chuyển đổi HTML sang PDF.
public static class PdfConverter
Kế thừa
object ←
PdfConverter
Các thành viên kế thừa
Ví dụ
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng Doc.
// Tạo đối tượng PdfToDocOptions để thiết lập hướng dẫn
var options = new PdfToDocOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng Doc với thiết lập Chế độ.
// Tạo đối tượng PdfToDocOptions để thiết lập hướng dẫn
var options = new PdfToDocOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Thiết lập Chế độ
options.Mode = DocConversionMode.Flow;
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi PDF sang tài liệu XLSX.
// Tạo đối tượng PdfToXlsOptions để thiết lập hướng dẫn
var options = new PdfToXlsOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xlsx"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi PDF sang tài liệu XLS.
// Tạo đối tượng PdfToXlsOptions để thiết lập hướng dẫn
var options = new PdfToXlsOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Chỉ định định dạng XLS
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xls"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi PDF sang tài liệu HTML.
// Tạo đối tượng PdfToHtmlOptions để thiết lập loại dữ liệu đầu ra là tệp với tài nguyên nhúng
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_output.html"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi HTML sang tài liệu PDF.
// Tạo HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.html"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng JPEG.
// Tạo đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToJpegOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng JPEG với các cài đặt cho trang, độ phân giải, chất lượng.
// Tạo đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToJpegOptions();
// Chỉ xử lý trang đầu tiên
options.PageList = [1];
// Thiết lập độ phân giải đầu ra là 200 DPI
options.OutputResolution = 200;
// Thiết lập chất lượng đầu ra là 50
options.Quality = 50;
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng JPEG sang các luồng.
// Tạo đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToJpegOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thực hiện quá trình
var results = PdfConverter.Convert(options);
// Lấy kết quả luồng
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng PNG.
// Tạo đối tượng PdfToPngOptions để thiết lập hướng dẫn
var options = new PdfToPngOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi 1 trang của tài liệu PDF sang định dạng PNG.
// Tạo đối tượng PdfToPngOptions để thiết lập hướng dẫn
var options = new PdfToPngOptions()
// Chỉ xử lý trang đầu tiên
options.PageList = [1];
// Thiết lập độ phân giải đầu ra là 200 DPI
options.OutputResolution = 200;
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng PNG sang các luồng.
// Tạo đối tượng PdfToJpegOptions để thiết lập hướng dẫn
var options = new PdfToPngOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thực hiện quá trình
var results = PdfConverter.Convert(options);
// Lấy kết quả luồng
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng TIFF.
// Tạo đối tượng PdfToTiffOptions để thiết lập hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng TIFF với tùy chỉnh trang và DPI.
// Tạo đối tượng PdfToTiffOptions để thiết lập hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thiết lập các trang
options.PageList = [1, 3];
// Thiết lập độ phân giải hình ảnh kết quả
options.OutputResolution = 400;
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng TIFF dưới dạng nhiều trang.
// Tạo đối tượng PdfToTiffOptions để thiết lập hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Bật đầu ra TIFF nhiều trang
options.MultiPage = true;
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng TIFF với tùy chỉnh Định dạng nén và Độ sâu màu.
// Tạo đối tượng PdfToTiffOptions để thiết lập hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn thư mục đầu ra
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Thiết lập Định dạng nén và Độ sâu màu
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Thực hiện quá trình
PdfConverter.Convert(options);
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng TIFF sang các luồng.
// Tạo đối tượng PdfToTiffOptions để thiết lập hướng dẫn
var options = new PdfToTiffOptions();
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Thực hiện quá trình
var results = PdfConverter.Convert(options);
// Lấy kết quả luồng
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
Ví dụ này minh họa cách chuyển đổi tài liệu PDF sang định dạng PDF/A (PDF/A-3b trong trường hợp này):
// Tạo lớp tùy chọn để thiết lập quá trình chuyển đổi
var options = new PdfToPdfAOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_3B
};
// Thêm tệp nguồn
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // thay thế bằng đường dẫn tệp thực tế của bạn
// Thêm đường dẫn để lưu tệp đã chuyển đổi
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));
// Chạy quá trình chuyển đổi
PdfConverter.Convert(options);
Ví dụ này minh họa cách xác minh tài liệu PDF tuân thủ định dạng PDF/A (PDF/A-1a trong trường hợp này):
// Tạo lớp tùy chọn để thiết lập quá trình xác minh
var options = new PdfAValidateOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_1A
};
// Thêm một hoặc nhiều tệp cần xác minh
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // thay thế bằng đường dẫn tệp thực tế của bạn
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// thêm nhiều tệp khi cần
// Chạy quá trình xác minh và lấy kết quả
var resultContainer = PdfConverter.Validate(options);
// Kiểm tra thuộc tính resultContainer.ResultCollection để xem kết quả xác minh cho từng tệp:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
var result = resultContainer.ResultCollection[i];
var validationResult = (PdfAValidationResult) result.Data;
var isValid = validationResult.IsValid; // Kết quả xác minh cho tài liệu thứ i
}
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: 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 không thiết lập tùy chọn.
Convert(PdfToXlsOptions)
Chuyển đổi tài liệu PDF sang đị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 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 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ố
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
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ố
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
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ố
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
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: 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 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ố
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
Ngoại lệ
ArgumentException
Nếu không thiết lập tùy chọn.
Convert(PdfToPdfAOptions)
Chuyển đổi tài liệu PDF sang định dạng PDF/A.
public static ResultContainer Convert(PdfToPdfAOptions options)
Tham số
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
Ngoại lệ
ArgumentException
Nếu không thiết lập tùy chọn.
Validate(PdfAValidateOptions)
Kiểm tra tài liệu PDF để đảm bảo tuân thủ định dạng PDF/A đã chỉ định.
public static ResultContainer Validate(PdfAValidateOptions options)
Tham số
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
Ngoại lệ
ArgumentException
Nếu không thiết lập tùy chọn.
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ừ
Triển khai
Thành viên kế thừa
Thuộc tính
Trả về bộ sưu tập dữ liệu plugin PdfConverterOptions.
public List<idatasource> Inputs { get; }
Giá trị thuộc tính
List<IDataSource>
Outputs
Lấy bộ sưu tập các mục tiêu đã thêm để lưu kết quả hoạt động.
public List<idatasource> Outputs { get; }
Giá trị thuộc tính
List<IDataSource>
Phương thức
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ố
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
Thông tin
Đại diện cho plugin Documentize.PdfExtractor. Được sử dụng để Trích xuất Văn bản, Hình ảnh, Dữ liệu Biểu mẫu, 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
Trích xuất văn bản từ tài liệu PDF.
public static ResultContainer Extract(ExtractTextOptions options)
Tham số
Trả về
ResultContainer : Một đối tượng chứa kết quả của quá trình trích xuất.
Ví dụ
Ví dụ dưới đây minh họa cách Trích xuất nội dung Văn bản của tài liệu PDF.
// Create ExtractTextOptions object to set instructions
var options = new ExtractTextOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get the extracted text from the ResultContainer object
var textExtracted = results.ResultCollection[0].ToString();
Ví dụ dưới đây minh họa cách Trích xuất nội dung Văn bản của tài liệu PDF với TextFormattingMode.
// Create ExtractTextOptions object to set TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get the extracted text from the ResultContainer object
var textExtracted = results.ResultCollection[0].ToString();
Ngoại lệ
ArgumentException
Nếu không thiết lập options.
Trích xuất hình ảnh từ tài liệu PDF.
public static ResultContainer Extract(ExtractImagesOptions options)
Tham số
Trả về
ResultContainer : Một đố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 Trích xuất Hình ảnh từ tài liệu PDF.
// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get path to image result
var imageExtracted = results.ResultCollection[0].ToFile();
Ví dụ dưới đây minh họa cách Trích xuất Hình ảnh từ tài liệu PDF tới Streams mà không tạo thư mục.
// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Not set output - it will write results to streams
// Perform the process
var results = PdfExtractor.Extract(options);
// Get Stream
var ms = results.ResultCollection[0].ToStream();
// Copy data to file for demo
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
ms.CopyTo(fs);
}
Ngoại lệ
ArgumentException
Nếu không thiết lập options.
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ố
Trả về
ResultContainer : Một đố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 Xuất giá trị Biểu mẫu ra file CSV.
// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// Perform the process
PdfExtractor.Extract(options);
Ngoại lệ
ArgumentException
Nếu không thiết lập options.
Trích xuất Thuộc tính từ tài liệu PDF.
public static PdfProperties Extract(ExtractPropertiesOptions options)
Tham số
Trả về
PdfProperties : Một đố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 Trích xuất Thuộc tính (Tiêu đề, Tác giả, Chủ đề, Từ khóa, Số trang) từ file PDF.
// Create ExtractPropertiesOptions object to set input file
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var numberOfPages = pdfProperties.NumberOfPages;
Ví dụ dưới đây minh họa cách Trích xuất Thuộc tính (Tiêu đề, Tác giả, Chủ đề, Từ khóa, Số trang) từ stream PDF.
// Create ExtractPropertiesOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var numberOfPages = pdfProperties.NumberOfPages;
Ví dụ dưới đây minh họa cách Trích xuất Thuộc tính từ file PDF bằng cách ngắn gọn nhất.
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));
Ngoại lệ
ArgumentException
Nếu không thiết lập options.
Thông tin
Đại diện plugin Documentize.PdfForm. Được sử dụng để Flatten, Extract Forms Data. Ngoài ra còn cho phép bạn Get Fields Names.
Đại diện plugin Documentize.PdfForm. Được sử dụng để Flatten, Extract Forms Data.
Cũng cho phép bạn Get Fields Names.
public static class PdfForm
Inheritance
object ←
PdfForm
Inherited Members
Methods
Trích xuất dữ liệu biểu mẫu từ tài liệu PDF.
public static ResultContainer Extract(ExtractFormDataToDsvOptions options)
Parameters
Returns
ResultContainer : Một đối tượng chứa kết quả của thao tác.
Examples
Ví dụ minh họa cách Export Form values sang file CSV.
// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// Perform the process
PdfForm.Extract(options);
Exceptions
ArgumentException
Nếu options không được thiết lập.
Flatten các trường trong tài liệu PDF.
public static ResultContainer Flatten(FlattenFieldsOptions options)
Parameters
Returns
ResultContainer : Một đối tượng chứa kết quả của thao tác.
Examples
Ví dụ minh họa cách Flatten các trường trong file PDF.
// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Flatten(options);
Ví dụ minh họa cách Flatten các trường trong file PDF và bỏ qua trường đầu tiên.
// Get Fields Names
var fieldNames = PdfForm.GetFieldNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
PdfForm.Flatten(options);
Exceptions
ArgumentException
Nếu options không được thiết lập.
Lấy tên các trường trong tài liệu PDF.
public static List<string> GetNames(GetFieldNamesOptions options)
Parameters
Returns
List<string>
Danh sách các tên trong tài liệu PDF.
Examples
Ví dụ minh họa cách Get field Names từ file PDF.
// Get Field Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
public static ResultContainer Remove(RemoveFieldsOptions options)
Parameters
Returns
ResultContainer : Một đối tượng chứa kết quả của thao tác.
Examples
Ví dụ minh họa cách Remove các trường từ file PDF.
// Create RemoveFieldsOptions object to set instructions
var options = new RemoveFieldsOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Remove(options);
Exceptions
ArgumentException
Nếu options không được thiết lập.
Class PdfManager
Thông tin
Đại diện cho plugin Documentize.PdfManager. Được sử dụng để Gộp, Tách, Tối ưu, Xoay, Thay đổi kích thước, Nén các tài liệu PDF và Thêm Bảng, Thêm Mục lục (TOC) 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.
Represents Documentize.PdfManager plugin. Used to Merge, Split, Optimize, Rotate, Resize, Compress PDF documents and Add Table, Add TOC to PDF documents.
Can Merge multiple PDF documents into a single PDF.
Can Split PDF documents into separate pages.
Can Optimize, Rotate, Resize, Compress PDF documents.
Can Rotate, Resize Pages of PDF document.
Can Add a Table to a PDF document.
Can Add a Table of Contents to PDF document.
public static class PdfManager
Inheritance
object ←
PdfManager
Inherited Members
Examples
The example demonstrates how to Merge two PDF documents.
// Create MergeOptions object to set instructions
var options = new MergeOptions();
// Add input file paths
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Merge(options);
The example demonstrates how to Split PDF document.
// Create SplitOptions object to set instructions
var options = new SplitOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file paths
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// Perform the process
PdfManager.Split(options);
The example demonstrates how to Optimize PDF document.
// Create OptimizeOptions object to set instructions
var options = new OptimizeOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Optimize(options);
The example demonstrates how to Rotate PDF document.
// Create RotateOptions object to set instructions
var options = new RotateOptions();
// Set new Rotation
options.Rotation = Rotation.On90;
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Rotate(options);
The example demonstrates how to Resize PDF document.
// Create ResizeOptions object to set instructions
var options = new ResizeOptions();
// Set new PageSize
options.PageSize = PageSize.A3;
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Resize(options);
The example demonstrates how to Compress PDF document.
// Create CompressOptions object to set instructions
var options = new CompressOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Compress(options);
The example demonstrates how to Add Table to PDF file.
// Configure table options
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");
// Add input file path
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);
The example demonstrates how to add Table of Contents to PDF file.
// 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 FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);
The example demonstrates how to add Table of Contents to PDF file with generating bookmarks.
// 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 FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);
The example demonstrates how to add Table of Contents to PDF file and save as stream.
// 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 FileDataSource("path_to_your_pdf_file.pdf"));
// Set output stream
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Perform the process
PdfManager.AddTableOfContents(options);
The example demonstrates how to use ChatGpt by adding messages to the request.
var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.
// Add the request messages.
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
});
// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.
The example demonstrates how to use ChatGpt by adding one message to the request.
var options = new ChatGptRequestOptions();
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf")); // Add the output file path.
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.
// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "What is the lowest temperature recorded on the Earth?";
// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.
The example demonstrates how to use Chat by adding file(s) as the message source(s).
var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Add the PDF text source.
// In case of multiple sources, the text from each document will be added to the request message collection
// as a separate message with the role "user".
options.AddInput(new FileDataSource("TextSource.pdf"));
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.
// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "How many letters in the provided text?";
// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.
Methods
AddTable(TableOptions)
Add Table to PDF document.
public static ResultContainer AddTable(TableOptions options)
Parameters
options TableOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
AddTableOfContents(TocOptions)
Add Table of Contents (TOC) to PDF document.
public static ResultContainer AddTableOfContents(TocOptions options)
Parameters
options TocOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
Compress(CompressOptions)
Compress PDF document. Try to reduce size of the document.
public static ResultContainer Compress(CompressOptions options)
Parameters
options CompressOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)
Create PDF document by Reply of ChatGpt.
Used to send requests to ChatGPT directly or by adding PDF file sources and save the reply to the output source.
public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)
Parameters
Returns
Task<ResultContainer>
An object containing the result of the operation.
Exceptions
ArgumentException : If options not set.
Merge(MergeOptions)
Merge PDF documents.
public static ResultContainer Merge(MergeOptions options)
Parameters
options MergeOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
Optimize(OptimizeOptions)
Optimize PDF document.
Linearize the document in order to
- open the first page as quickly as possible;
- display next page or follow by link to the next page as quickly as possible;
- display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first);
- permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed.
public static ResultContainer Optimize(OptimizeOptions options)
Parameters
options OptimizeOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
Resize(ResizeOptions)
Resize Pages of PDF document.
public static ResultContainer Resize(ResizeOptions options)
Parameters
options ResizeOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
Rotate(RotateOptions)
Rotate Pages of PDF document.
public static ResultContainer Rotate(RotateOptions options)
Parameters
options RotateOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
Split(SplitOptions)
Split PDF document by pages.
public static ResultContainer Split(SplitOptions options)
Parameters
options SplitOptions: An options object containing instructions for the operation.
Returns
ResultContainer : An object containing the result of the operation.
Exceptions
ArgumentException
If options not set.
Class PdfProperties
Thông tin
Đại diện cho các thuộc tính và thông tin meta của tài liệu PDF.
public class PdfProperties
Kế thừa
object ←
PdfProperties
Thành viên được kế thừa
Hàm tạo
PdfProperties()
Thuộc tính
Author
Lấy hoặc thiết lập Tác giả PDF.
public string Author { get; set; }
Giá trị Thuộc tính
string
Keywords
Lấy hoặc thiết lập Từ khóa PDF.
public string Keywords { get; set; }
Giá trị Thuộc tính
string
NumberOfPages
Lấy hoặc thiết lập Số trang PDF.
public int NumberOfPages { get; set; }
Giá trị Thuộc tính
int
Subject
Lấy hoặc thiết lập Chủ đề PDF.
public string Subject { get; set; }
Giá trị Thuộc tính
string
Title
Lấy hoặc thiết lập Tiêu đề PDF.
public string Title { get; set; }
Giá trị Thuộc tính
string
Class PdfSecurity
Thông tin
Đại diện cho plugin Documentize.PdfSecurity. Sử dụng để Mã hóa, Giải mã và Ký tài liệu PDF.
public static class PdfSecurity
Kế thừa
object ←
PdfSecurity
Các thành viên kế thừa
Phương thức
Decrypt(DecryptOptions)
Giải mã tài liệu PDF.
public static ResultContainer Decrypt(DecryptOptions options)
Tham số
options DecryptOptions: 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.
Ví dụ
Ví dụ minh họa cách Giải mã tài liệu PDF.
// Tạo đối tượng DecryptOptions để đặt hướng dẫn
var options = new DecryptOptions("123456");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
PdfSecurity.Decrypt(options);
Ngoại lệ
ArgumentException
Nếu tùy chọn không được thiết lập.
Encrypt(EncryptOptions)
Mã hóa tài liệu PDF.
public static ResultContainer Encrypt(EncryptOptions options)
Tham số
options EncryptOptions: 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.
Ví dụ
Ví dụ minh họa cách Mã hóa tài liệu PDF.
// Tạo đối tượng EncryptOptions để đặt hướng dẫn
var options = new EncryptOptions("123456", "qwerty");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
PdfSecurity.Encrypt(options);
Ngoại lệ
ArgumentException
Nếu tùy chọn không được thiết lập.
Sign(SignOptions)
Ký tài liệu PDF bằng chữ ký số.
public static ResultContainer Sign(SignOptions options)
Tham số
options SignOptions: Một đối tượng tùy chọn chứa hướng dẫn cho hoạt động.
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
Ví dụ
Ví dụ minh họa cách Ký tài liệu PDF.
// Tạo đối tượng SignOptions để đặt hướng dẫn
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
PdfSecurity.Sign(options);
Ví dụ minh họa cách Ký tài liệu PDF với Luồng 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");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
PdfSecurity.Sign(options);
Ví dụ minh họa cách Ký tài liệu PDF với chữ ký vô hình.
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Cấu hình chữ ký vô hình
signOptions.Visible = false;
// Thực hiện quá trình
PdfSecurity.Sign(options);
Ví dụ minh họa cách Ký tài liệu PDF với các tùy chọn bổ sung.
// Tạo đối tượng SignOptions để đặt hướng dẫn
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Các tham số tùy chọn
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Thực hiện quá trình
PdfSecurity.Sign(options);
Ví dụ minh họa cách Ký tài liệu PDF với Thời gian.
// Tạo đối tượng SignOptions để đặt hướng dẫn
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
PdfSecurity.Sign(options);
Ngoại lệ
ArgumentException
Nếu tùy chọn không được thiết lập.
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
Triển khai
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()
Constructors
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.
Tính chất
Mode
Cho phép kiểm soát cách thức một tài liệu PDF được chuyển đổi thành tài liệu xử lý từ.
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 phải
chỉnh sửa nhiều. Các ô văn bản dễ dàng chỉnh sửa khi không có quá nhiều việc phải làm.
Sử dụng chế độ Documentize.DocConversionMode.Flow khi tài liệu đầu ra cần phải chỉnh sửa thêm.
Các đoạn văn và dòng văn bản trong chế độ dòng cho phép chỉnh sửa văn bản dễ dàng, nhưng các đối tượng
định dạng không được hỗ trợ sẽ trông tệ hơn so với chế độ Documentize.DocConversionMode.TextBox.
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
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()
Constructors
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 đã chỉ định.
public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType = SaveDataType.FileWithExternalResources)
Tham số
Properties
OutputDataType
Lấy kiểu dữ liệu đầu ra.
public PdfToHtmlOptions.SaveDataType OutputDataType { get; }
Giá trị thuộc tính
PdfToHtmlOptions.SaveDataType
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
Kế thừa
object ←
PluginBaseOptions ←
PdfToJpegOptions
Triển khai
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
PdfToJpegOptions()
Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToJpegOptions.
public PdfToJpegOptions()
Thuộc tính
OutputResolution
Lấy hoặc thiết lập giá trị độ phân giải của các hình ảnh kết quả.
public int OutputResolution { get; set; }
Giá trị thuộc tính
int
PageList
Lấy hoặc thiết lập danh sách các trang cho quá trình.
public List<int> PageList { get; set; }
Giá trị thuộc tính
List<int>
Quality
Lấy và thiết lập chất lượng đầu ra.
Chỉ đị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ố càng thấp, nén càng cao và do đó chất lượng hình ảnh càng thấp.
Số không sẽ cho bạn hình ảnh có chất lượng thấp nhất và 100 là cao nhất.
public int Quality { get; set; }
Giá trị thuộc tính
int
Class PdfToPdfAOptions
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.PdfConverter.
public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions
Kế thừa
object ←
PdfAOptionsBase ←
PdfToPdfAOptions
Cài đặt
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()
Constructors
PdfToPdfAOptions()
public PdfToPdfAOptions()
Properties
Outputs
Lấy bộ sưu tập các mục tiêu đã thêm (tài liệu hoặc nguồn dữ liệu luồng) cho kết quả lưu trữ.
public List<idatasource> Outputs { get; }
Giá trị thuộc tính
List<IDataSource>
Methods
AddOutput(IDataSource)
Thêm mục tiêu lưu trữ kết quả mới.
public void AddOutput(IDataSource dataSource)
Tham số
dataSource IDataSource: Mục tiêu (tài liệu hoặc nguồn dữ liệu luồng) cho kết quả lưu trữ. :
Class PdfToPngOptions
Thông tin
Đại diện cho các tùy chọn chuyển đổi PDF sang PNG cho plugin Documentize.PdfConverter.
public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
PdfToPngOptions
Triển khai
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
PdfToPngOptions()
Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToPngOptions.
Các thuộc tính
OutputResolution
Lấy hoặc thiết lập giá trị độ phân giải của các hình ảnh kết quả.
public int OutputResolution { get; set; }
Giá trị thuộc tính
int
PageList
Lấy hoặc thiết lập danh sách các trang cho quá trình.
public List<int> PageList { get; set; }
Giá trị thuộc tính
List<int>
Class PdfToTiffOptions
Thông tin
Đại diện cho các tùy chọn chuyển đổi PDF sang TIFF cho plugin Documentize.PdfConverter.
public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
PdfToTiffOptions
Áp dụng
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 trình khởi tạo
PdfToTiffOptions()
Khởi tạo một thể hiện mới của đối tượng Documentize.PdfToTiffOptions.
public PdfToTiffOptions()
Các thuộc tính
ColorDepth
Lấy hoặc đặt độ sâu màu.
public TiffColorDepth ColorDepth { get; set; }
Giá trị thuộc tính
TiffColorDepth
Nhận xét
Giá trị mặc định là Documentize.TiffColorDepth.Format32bpp.
Compression
Lấy hoặc đặt loại nén.
public TiffCompression Compression { get; set; }
Giá trị thuộc tính
TiffCompression
Nhận xét
Giá trị mặc định là Documentize.TiffCompression.LZW.
MultiPage
Lấy và đặt cờ cho phép lưu tất cả các trang vào một tiff đa trang.
Giá trị mặc định là false.
public bool MultiPage { get; set; }
Giá trị thuộc tính
bool
OutputResolution
Lấy hoặc đặt giá trị độ phân giải của các hình ảnh kết quả.
public int OutputResolution { get; set; }
Giá trị thuộc tính
int
PageList
Lấy hoặc đặt danh sách các trang cho quá trình.
public List<int> PageList { get; set; }
Giá trị thuộc tính
List<int>
Class PdfToXlsOptions
Thông tin
Biểu diễn các tùy chọn chuyển đổi PDF sang XLS/XLSX cho Documentize.PdfConverter plugin.
public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions
Inheritance
object ←
PluginBaseOptions ←
PdfToXlsOptions
Implements
Inherited Members
- 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()
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.
Properties
Định dạng đầu ra.
public PdfToXlsOptions.ExcelFormat Format { get; set; }
Property Value
PdfToXlsOptions.ExcelFormat
InsertBlankColumnAtFirst
Đặt true nếu bạn cần chèn cột trống làm cột đầu tiên của worksheet.
Giá trị mặc định là false; nghĩa là cột trống sẽ không được chèn.
public bool InsertBlankColumnAtFirst { get; set; }
Property Value
bool
MinimizeTheNumberOfWorksheets
Đặt true nếu bạn cần giảm thiểu số lượng worksheet 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 worksheet riêng biệt.
public bool MinimizeTheNumberOfWorksheets { get; set; }
Property Value
bool
Class PluginBaseOptions
Thông tin
Biểu diễn các tùy chọn cơ bản cho plugin.
public class PluginBaseOptions : IPluginOptions
Kế thừa
object ←
PluginBaseOptions
Lớp con
- AddTimestampOptions,
- ChatGptRequestOptions,
- CompressOptions,
- DecryptOptions,
- EncryptOptions,
- ExtractFormDataToDsvOptions,
- ExtractImagesOptions,
- FlattenFieldsOptions,
- HtmlToPdfOptions,
- MergeOptions,
- OptimizeOptions,
- PdfToDocOptions,
- PdfToHtmlOptions,
- PdfToJpegOptions,
- PdfToPngOptions,
- PdfToTiffOptions,
- PdfToXlsOptions,
- RemoveFieldsOptions,
- ResizeOptions,
- RotateOptions,
- SignOptions,
- SplitOptions,
- TableOptions,
- TocOptions
Thực hiện
Thành viên kế thừa
Thuộc tính
Đó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
bool
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
bool
Trả về dữ liệu Inputs cho thao tác.
public List<idatasource> Inputs { get; }
Giá trị thuộc tính
List<IDataSource>
Outputs
Trả về dữ liệu Outputs cho thao tác.
public List<idatasource> Outputs { get; }
Giá trị thuộc tính
List<IDataSource>
Phương thức
Thêm dữ liệu mới vào Inputs.
public void AddInput(IDataSource dataSource)
Tham số
AddOutput(IDataSource)
Thêm dữ liệu mới vào Outputs.
public void AddOutput(IDataSource saveDataSource)
Tham số
Class PngConverter
Thông tin
Đại diện cho plugin Documentize.PngConverter. Được sử dụng để chuyển đổi tài liệu PDF thành định dạng PNG.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class PngConverter
Kế thừa
object ←
PngConverter
Các thành viên được kế thừa
Phương thức
Process(PdfToPngOptions)
Chuyển đổi tài liệu PDF thành định dạng PNG.
public static ResultContainer Process(PdfToPngOptions options)
Tham số
options PdfToPngOptions: 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 Rectangle
Thông tin
Class đại diện cho hình chữ nhật.
Kế thừa
object ←
Rectangle
Các thành viên được kế thừa
Các hàm khởi tạo
Rectangle(double, double, double, double)
Hàm khởi tạo của Rectangle.
public Rectangle(double llx, double lly, double urx, double ury)
Tham số
llx double: X của góc dưới bên trái.lly double: Y của góc dưới bên trái.urx double: X của góc trên bên phải.ury double: Y của góc trên bên phải.
Class RemoveFieldsOptions
Thông tin
Mô tả các tùy chọn cho việc 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 hiện
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()
Hàm 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()
Class ResizeOptions
Thông tin
Đại diện cho các tùy chọn Kích thước cho plugin Documentize.PdfManager.
public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
ResizeOptions
Thực hiện
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 bộ xây dựng
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.
Các 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
PageSize
Class ResultContainer
Thông tin
Đại diện cho container chứa tập hợp kết quả của quá trình xử lý plugin.
public class ResultContainer
Kế thừa
object ←
ResultContainer
Các thành viên kế thừa
Thuộc tính
ResultCollection
Lấy tập hợp kết quả của các phép toán
public List<ioperationresult> ResultCollection { get; }
Giá trị thuộc tính
List<IOperationResult>
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
Inheritance
object ←
PluginBaseOptions ←
RotateOptions
Implements
Inherited Members
- 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()
Constructors
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.
Properties
Rotation
Lấy hoặc đặt giá trị xoay cho các trang mới.
public Rotation Rotation { get; set; }
Property Value
Rotation
Class Security
Thông tin
Đại diện cho plugin Documentize.Security. Sử dụng để mã hóa và giải mã tài liệu PDF.
[Obsolete("Lớp này sẽ bị xóa sớm. Vui lòng sử dụng lớp PdfSecurity.")]
public static class Security
Kế thừa
object ←
Security
Các 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: Một đối tượng tùy chọn chứa hướng dẫn cho thao tác.
Trả về
ResultContainer : Một đối tượng chứa kết quả của thao tác.
Ngoại lệ
ArgumentException
Nếu tùy chọn chưa được thiết lập.
Process(DecryptOptions)
Giải mã tài liệu PDF.
public static ResultContainer Process(DecryptOptions options)
Tham số
options DecryptOptions: Một đối tượng tùy chọn chứa hướng dẫn cho thao tác.
Trả về
ResultContainer : Một đối tượng chứa kết quả của thao tác.
Ngoại lệ
ArgumentException
Nếu tùy chọn chưa được thiết lập.
Class Signature
Thông tin
Đại diện cho plugin Documentize.Signature. Sử dụng để ký tài liệu PDF.
[Obsolete("Lớp này sẽ bị xóa sớm. Vui lòng sử dụng lớp PdfSecurity.")]
public static class Signature
Kế thừa
object ←
Signature
Các thành viên kế thừa
Phương thức
Process(SignOptions)
Ký tài liệu PDF.
public static ResultContainer Process(SignOptions options)
Tham số
options SignOptions: Một đối tượng tùy chọn chứa hướng dẫn cho hoạt động.
Trả về
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
Ngoại lệ
ArgumentException
Nếu tùy chọn không được thiết lập.
Class SignOptions
Thông tin
Đại diện cho tùy chọn ký cho plugin Documentize.PdfSecurity.
public sealed class SignOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
SignOptions
Thực thi
Các 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.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Các hàm khởi tạo
SignOptions(string, string)
Khởi tạo một thể hiện mới của đối tượng Documentize.SignOptions với các tùy chọn mặc định.
public SignOptions(string pfx, string password)
Tham số
pfx string: Đường dẫn đến tệp pfx.password string: Mật khẩu cho tệp pfx.
SignOptions(Stream, string)
Khởi tạo một thể hiện mới của đối tượng Documentize.SignOptions với các tùy chọn mặc định.
public SignOptions(Stream pfx, string password)
Tham số
pfx Stream: Luồng chứa tệp pfx.password string: Mật khẩu cho tệp pfx.
Thuộc tính
Thông tin liên lạc của chữ ký.
public string Contact { get; set; }
Giá trị thuộc tính
string
Location
Vị trí của chữ ký.
public string Location { get; set; }
Giá trị thuộc tính
string
Name
Tên của trường chữ ký hiện có.
Null để tạo một trường mới.
public string Name { get; set; }
Giá trị thuộc tính
string
PageNumber
Số trang trên đó chữ ký được thực hiện.
public int PageNumber { get; set; }
Giá trị thuộc tính
int
Reason
Lý do của chữ ký.
public string Reason { get; set; }
Giá trị thuộc tính
string
Rectangle
Hình chữ nhật của chữ ký.
public Rectangle Rectangle { get; set; }
Giá trị thuộc tính
Rectangle
TimestampOptions
Tùy chọn dấu thời gian.
public TimestampOptions TimestampOptions { get; set; }
Giá trị thuộc tính
TimestampOptions
Visible
Độ hiển thị của chữ ký.
public bool Visible { get; set; }
Giá trị thuộc tính
bool
Class SplitOptions
Thông tin
Đại diện cho tùy chọn chia tách cho plugin Documentize.PdfManager.
public sealed class SplitOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
SplitOptions
Triển khai
Các 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.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Các hàm khởi tạo
SplitOptions()
Khởi tạo một thể hiện mới của đối tượng Documentize.SplitOptions với các tùy chọn mặc định.
Class Splitter
Thông tin
Đại diện cho plugin Documentize.Splitter. Được sử dụng để chia tách 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
Inheritance
object ←
Splitter
Inherited Members
Methods
Process(SplitOptions)
Chia tách tài liệu PDF theo trang.
public static ResultContainer Process(SplitOptions options)
Parameters
options SplitOptions: Một đối tượng tùy chọn chứa 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
ArgumentException
Nếu tùy chọn không được thiết lập.
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
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ố
Các thuộc tính
Data
Nhận đối tượng luồng của nguồn dữ liệu hiện tại.
public Stream Data { get; }
Giá trị thuộc tính
Stream
DataType
Loại nguồn dữ liệu (luồng).
public DataType DataType { get; }
Giá trị thuộc tính
DataType
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 hiện
Thành viên kế thừa
Thuộc tính
Data
Nhận dữ liệu thô.
public object Data { get; }
Giá trị thuộc tính
object
IsFile
Chỉ ra xem kết quả có phải là đường dẫn đến tệp xuất hay không.
public bool IsFile { get; }
Giá trị thuộc tính
bool
IsStream
Chỉ ra xem kết quả có phải là một đối tượng Stream hay không.
public bool IsStream { get; }
Giá trị thuộc tính
bool
IsString
Chỉ ra xem kết quả có phải là một chuỗi hay không.
public bool IsString { get; }
Giá trị thuộc tính
bool
Phương thức
ToFile()
Cố gắng chuyển đổi kết quả thành một tệp.
Trả về
string : Một chuỗi đại diện cho đường dẫn đến tệp xuất nếu kết quả là tệp; ngược lại null.
ToStream()
Cố gắng chuyển đổi kết quả thành một đối tượng stream.
Trả về
Stream : Một đối tượng stream đại diện cho dữ liệu đầu ra nếu kết quả là stream; ngược lại null.
Class StringResult
Thông tin
Đại diện cho kết quả hoạt động dưới dạng chuỗi.
public sealed class StringResult : IOperationResult
Kế thừa
object ←
StringResult
Thực hiện
Thành viên được kế thừa
Thuộc tính
Dữ liệu
Lấy dữ liệu thô.
public object Data { get; }
Giá trị thuộc tính
object
IsFile
Chỉ định liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.
public bool IsFile { get; }
Giá trị thuộc tính
bool
IsStream
Chỉ định liệu kết quả có phải là một đường dẫn đến tệp đầu ra hay không.
public bool IsStream { get; }
Giá trị thuộc tính
bool
IsString
Chỉ định liệu kết quả có phải là một chuỗi hay không.
public bool IsString { get; }
Giá trị thuộc tính
bool
Văn bản
Trả về đại diện chuỗi của kết quả.
public string Text { get; }
Giá trị thuộc tính
string
Phương thức
ToFile()
Cố gắng chuyển đổi kết quả thành một tệp.
Trả về
string : Một chuỗi đại diện cho đường dẫn đến tệp đầu ra nếu kết quả là tệp; nếu không trả về null.
ToStream()
Cố gắng chuyển đổi kết quả thành một đối tượng stream.
Trả về
Stream : Một đối tượng stream đại diện cho dữ liệu đầu ra nếu kết quả là stream; nếu không trả về null.
ToString()
Cố gắng chuyển đổi kết quả thành một chuỗi.
public override string ToString()
Trả về
string : Một chuỗi đại diện cho nội dung văn bản nếu kết quả là chuỗi; nếu không trả về base.ToString().
Class TableBuilder
Thông tin
Lớp đại diện cho builder cho bảng trong trang pdf.
public class TableBuilder
Kế thừa
object ←
TableBuilder
Kế thừa từ
Các thành viên kế thừa
Phương thức
AddRow()
Thêm một hàng mới vào bảng.
public virtual TableRowBuilder AddRow()
Trả về
TableRowBuilder : Thể hiện của Documentize.TableRowBuilder hiện tại.
AddTable()
Thêm một bảng mới vào tài liệu.
public TableBuilder AddTable()
Trả về
TableBuilder : Thể hiện của Documentize.TableBuilder hiện tại.
InsertPageAfter(int)
Chèn trang sau trang đã chỉ định.
public TableOptions InsertPageAfter(int page)
Tham số
page int: Số trang để chèn bảng sau.
Trả về
TableOptions : Thể hiện của Documentize.TableOptions hiện tại.
InsertPageBefore(int)
Chèn trang trước trang đã chỉ định.
public TableOptions InsertPageBefore(int page)
Tham số
page int: Số trang để chèn bảng trước.
Trả về
TableOptions : Thể hiện của Documentize.TableOptions hiện tại.
Toán tử
implicit operator TableOptions(TableBuilder)
Chuyển đổi builder Documentize.TableBuilder thành tùy chọn Documentize.TableOptions.
public static implicit operator TableOptions(TableBuilder builder)
Tham số
builder TableBuilder: Thể hiện của Documentize.TableBuilder hiện tại.
Trả về
TableOptions : Kết quả của việc chuyển đổi sang PdfGeneratorTableOptions.
Class TableCellBuilder
Thông tin
Class đại diện cho builder cho ô bảng.
public class TableCellBuilder : TableRowBuilder
Kế thừa
object ←
TableBuilder ←
TableRowBuilder ←
TableCellBuilder
Các thành phần kế thừa
- TableRowBuilder.AddCell(),
- TableRowBuilder.AddRow(),
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Phương thức
AddCell()
Thêm ô vào bảng.
public override TableCellBuilder AddCell()
Trả về
TableCellBuilder : Instance của Documentize.TableCellBuilder hiện tại.
AddParagraph(params string[])
Thêm các đoạn vào ô bảng.
public TableCellBuilder AddParagraph(params string[] paragraphs)
Tham số
paragraphs string[]: Văn bản cho các đoạn.
Trả về
TableCellBuilder : Instance của Documentize.TableCellBuilder hiện tại.
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("Lớp này sẽ bị xóa sớm. Vui lòng sử dụng lớp PdfManager.")]
public static class TableGenerator
Kế thừa
object ←
TableGenerator
Các thành viên kế thừa
Ví dụ
Ví dụ này minh họa cách thêm bảng vào tệp PDF.
// Cấu hình tùy chọn bảng
var options = new TableOptions().InsertPageBefore(1)
.AddTable()
.AddRow()
.AddCell().AddParagraph("Tên")
.AddCell().AddParagraph("Tuổi")
.AddRow()
.AddCell().AddParagraph("Bob")
.AddCell().AddParagraph("12")
.AddRow()
.AddCell().AddParagraph("Sam")
.AddCell().AddParagraph("20")
.AddRow()
.AddCell().AddParagraph("Sandy")
.AddCell().AddParagraph("26")
.AddRow()
.AddCell().AddParagraph("Tom")
.AddCell().AddParagraph("12")
.AddRow()
.AddCell().AddParagraph("Jim")
.AddCell().AddParagraph("27");
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Đặt đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Thực hiện quá trình
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 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 TableOptions
Thông tin
Đại diện cho các tùy chọn để thêm bảng vào tài liệu bằng plugin Documentize.PdfManager.
public sealed class TableOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
TableOptions
Triển khai
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()
Phương thức 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.
Phương thức
AddTable()
Thêm bảng vào tài liệu.
public TableBuilder AddTable()
Trả về
TableBuilder : Thể hiện mới của Documentize.TableBuilder.
Create()
Tạo thể hiện của Documentize.TableOptions.
public static TableOptions Create()
Trả về
TableOptions : Thể hiện mới của Documentize.TableOptions.
InsertPageAfter(int)
Chèn trang sau trang đã chỉ định.
public TableOptions InsertPageAfter(int page)
Tham số
page int: Số trang để chèn bảng sau đó.
Trả về
TableOptions : Thể hiện của Documentize.TableOptions hiện tại.
InsertPageBefore(int)
Chèn trang trước trang đã chỉ định.
public TableOptions InsertPageBefore(int page)
Tham số
page int: Số trang để chèn bảng sau đó.
Trả về
TableOptions : Thể hiện của Documentize.TableOptions hiện tại.
Class TableRowBuilder
Thông tin
Class đại diện cho builder cho hàng bảng.
public class TableRowBuilder : TableBuilder
Kế thừa
object ←
TableBuilder ←
TableRowBuilder
Kế thừa
Thành viên được kế thừa
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Phương thức
AddCell()
Thêm ô vào hàng bảng.
public virtual TableCellBuilder AddCell()
Trả về
TableCellBuilder : Thể hiện của Documentize.TableCellBuilder đã tạo.
AddRow()
Ghi đè AddRow.
public override TableRowBuilder AddRow()
Trả về
TableRowBuilder : Thể hiện của Documentize.TableRowBuilder hiện tại.
Thông tin
Đại diện cho plugin Documentize.TextExtractor. 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
Kế thừa
object ←
TextExtractor
Các thành viên kế thừa
Phương thức
Trích xuất văn bản từ tài liệu PDF.
public static ResultContainer Process(ExtractTextOptions options)
Tham số
Trả về
ResultContainer : Một đối tượng chứa kết quả của việc trích xuất.
Ngoại lệ
ArgumentException
Nếu tùy chọn không được thiết lập.
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
Khởi tạo một thể hiện mới của đối tượng Documentize.TextExtractorOptions cho chế độ định dạng văn bản được chỉ định.
public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)
Các tham số
Các thuộc tính
Lấy chế độ định dạng.
public TextFormattingMode FormattingMode { get; set; }
Giá trị thuộc tính
TextFormattingMode
Trả về dữ liệu Inputs cho hoạt động.
public List<idatasource> Inputs { get; }
Giá trị thuộc tính
List<IDataSource>
Các phương thức
Thêm dữ liệu mới vào Inputs.
public void AddInput(IDataSource dataSource)
Các tham số
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
Inheritance
object ←
TiffConverter
Inherited Members
Methods
Process(PdfToTiffOptions)
Chuyển đổi tài liệu PDF sang định dạng TIFF.
public static ResultContainer Process(PdfToTiffOptions options)
Parameters
Returns
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
Exceptions
ArgumentException
Nếu tùy chọn không được thiết lập.
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
Returns
ResultContainer : Một đối tượng chứa kết quả của hoạt động.
Exceptions
ArgumentException
Nếu tùy chọn không được thiết lập.
Class TimestampOptions
public class TimestampOptions
Kế thừa
object ←
TimestampOptions
Các thành viên được kế thừa
Constructors
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: Địa chỉ 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 kết hợp thành một chuỗi “username:password”.
Properties
BasicAuthCredentials
Lấy/cài đặt 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”.
public string BasicAuthCredentials { get; set; }
Giá trị thuộc tính
string
ServerUrl
Lấy/cài đặt địa chỉ URL của máy chủ timestamp.
public string ServerUrl { get; set; }
Giá trị thuộc tính
string
Class TocGenerator
Thông tin
Đại diện cho plugin Documentize.TocGenerator. Sử dụng để thêm Mục lục vào tài liệu PDF.
[Obsolete("Lớp sẽ bị xóa sớm. Vui lòng sử dụng lớp PdfManager.")]
public static class TocGenerator
Kế thừa
object ←
TocGenerator
Các thành viên kế thừa
Ví dụ
Ví dụ này minh họa cách thêm Mục lục vào tệp PDF.
// Tạo đối tượng TocOptions để thiết lập hướng dẫn
var options = new TocOptions();
// Thiết lập tiêu đề
options.Title = "Mục lục của tôi";
// Thiết kế các tiêu đề
options.Headings.Add(new TocHeading("Giới thiệu", 2));
options.Headings.Add(new TocHeading("Chương I", 3));
options.Headings.Add(new TocHeading("Chương II", 4));
options.Headings.Add(new TocHeading("Chương III", 5));
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
TocGenerator.Process(options);
Ví dụ này minh họa cách thêm Mục lục vào tệp PDF với việc tạo dấu trang.
// Tạo đối tượng TocOptions để thiết lập hướng dẫn
var options = new TocOptions();
// Thiết lập tiêu đề
options.Title = "Mục lục của tôi";
// Tạo liên kết trong dấu trang
options.GenerateBookmarks = true;
// Thiết kế các tiêu đề
options.Headings.Add(new TocHeading("Giới thiệu", 2, false, 1));
options.Headings.Add(new TocHeading("Chương I", 3, true, 1));
options.Headings.Add(new TocHeading("Chương II", 4, true, 1));
options.Headings.Add(new TocHeading("Ví dụ A", 4, true, 2));
options.Headings.Add(new TocHeading("Ví dụ B", 4, true, 2));
options.Headings.Add(new TocHeading("Ví dụ C", 4, true, 2));
options.Headings.Add(new TocHeading("Ví dụ D", 4, true, 2));
options.Headings.Add(new TocHeading("Chương III", 5, true, 1));
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập đường dẫn tệp đầu ra
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Thực hiện quá trình
TocGenerator.Process(options);
Ví dụ này 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.
// Tạo đối tượng TocOptions để thiết lập hướng dẫn
var options = new TocOptions();
// Thiết lập tiêu đề
options.Title = "Mục lục của tôi";
// Thiết kế các tiêu đề
options.Headings.Add(new TocHeading("Giới thiệu", 2, false, 1));
// Thêm đường dẫn tệp đầu vào
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Thiết lập luồng đầu ra
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Thực hiện quá trình
TocGenerator.Process(options);
Phương thức
Process(TocOptions)
Bắt đầu quá trình Documentize.TocGenerator với các tham số đượ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.
Class TocHeading
Thông tin
Đại diện cho các tùy chọn cho Đầu mục hoặc Tiêu đề của Mục lục để tài liệu bằng plugin Documentize.PdfManager.
Kế thừa
object ←
TocHeading
Các Thành viên Kế thừa
Các Bộ Xây Dựng
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: Nội dung của Đầu mục.pageNumber int: Số trang cho liên kết.generateNumbering bool: Sử dụng tạo số.level int: Cấp độ.
Các Thuộc Tính
GenerateNumbering
Sử dụng tạo số.
Nếu true, thì việc đánh số sẽ tự động; nếu không, việc đánh số sẽ được thực hiện thủ công.
public bool GenerateNumbering { get; set; }
Giá Trị Thuộc Tính
bool
Level
Cấp độ.
Được sử dụng cho việc tạo số.
public int Level { get; set; }
Giá Trị Thuộc Tính
int
PageNumber
Số trang cho liên kết.
public int PageNumber { get; set; }
Giá Trị Thuộc Tính
int
Text
Nội dung của Tiêu đề.
public string Text { get; set; }
Giá Trị Thuộc Tính
string
Class TocOptions
Thông tin
Đại diện cho các tùy chọn để thêm mục lục vào tài liệu bằng plugin Documentize.PdfManager.
public sealed class TocOptions : PluginBaseOptions, IPluginOptions
Kế thừa
object ←
PluginBaseOptions ←
TocOptions
Thực thi
Các 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.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Các hàm khởi tạo
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.
Các thuộc tính
GenerateBookmarks
Sử dụng tính năng tạo Bookmarks.
Nếu được đặt true, thì Bookmarks sẽ được xóa và được tạo mới bởi các Tiêu đề; nếu không, Bookmarks sẽ không thay đổi.
public bool GenerateBookmarks { get; set; }
Giá trị thuộc tính
bool
Headings
Các Tiêu đề hoặc Tiêu đề của Mục lục.
public List<tocheading> Headings { get; set; }
Giá trị thuộc tính
List<TocHeading>
Title
Tiêu đề của Mục lục.
public string Title { get; set; }
Giá trị thuộc tính
string
Class Usage
Thông tin
Thống kê sử dụng cho yêu cầu hoàn thành.
Kế thừa
object ←
Usage
Các thành viên được kế thừa
Các hàm tạo
Usage()
Các thuộc tính
CompletionTokens
Số lượng token trong phần hoàn thành được tạo ra.
[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }
Giá trị thuộc tính
int
PromptTokens
Số lượng token trong phần nhắc.
[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }
Giá trị thuộc tính
int
TotalTokens
Tổng số lượng token đã sử dụng trong yêu cầu (nhắc + hoàn thành).
[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }
Giá trị thuộc tính
int
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 định dạng XLSX/XLS/CSV/XLSM/ODS.
[Obsolete("Lớp này sẽ bị xóa trong thời gian tới. Vui lòng sử dụng lớp PdfConverter.")]
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 định dạng XLSX/XLS/CSV/XLSM/ODS.
public static ResultContainer Process(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 : 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.
Enum ConvertErrorAction
Thông tin
Lớp này đại diện cho hành động xử lý lỗi chuyển đổi.
public enum ConvertErrorAction
Fields
Enum ConvertSoftMaskAction
Thông tin
Hành động này đại diện cho các hành động chuyển đổi hình ảnh với mặt nạ mềm.
public enum ConvertSoftMaskAction
Fields
ConvertToStencilMask = 1: Mặt nạ mềm sẽ được chuyển đổi thành mặt nạ khuôn.Default = 0: Sử dụng chiến lược mặc định.
Enum DataType
Thông tin
Đại diện cho các loại dữ liệu có thể cho việc xử lý plugin.
Fields
Directory = 2: Loại dữ liệu là thư mục được đại diện bởi đường dẫn đến nó.File = 0: Loại dữ liệu là tệp được đại diện bởi đường dẫn đến nó.Stream = 1: Loại dữ liệu là luồng.
Enum DocConversionMode
Thông tin
Xác định chế độ chuyển đổi của tài liệu đầu ra.
public enum DocConversionMode
Các trường
Flow = 1: Chế độ nhận diện toàn diện, engine thực hiện nhóm và phân tích đa cấp để phục hồi ý định của tác giả tài liệu gốc và tạo ra một tài liệu có thể 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 giữ nguyên hình thức của file PDF gốc, 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 được chuyển đổi thành một textbox trong tài liệu kết quả. Điều này đạt được sự 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 nó sẽ hoàn toàn gồm các textbox và có thể làm cho việc chỉnh sửa tài liệu trong Microsoft Word trở nên khá khó khăn. Đây là chế độ mặc định.
Thông tin
Chỉ định các loại phương tiện có thể được sử dụng trong quá trình kết xuất.
public enum HtmlMediaType
Fields
Print = 0: In.Screen = 1: Màn hình.
Enum HtmlPageLayoutOption
Thông tin
Chỉ định các cờ mà cùng với các tùy chọn khác xác định kích thước và bố cục của các trang.
public enum HtmlPageLayoutOption
Fields
FitToWidestContentWidth = 3: Chỉ rõ rằng chiều rộng của trang được xác định từ kích thước nội dung, không phải từ chiều rộng trang đã chỉ định.None = 0: Giá trị mặc định cho biết rằng HtmlPageLayoutOption sẽ không ảnh hưởng đến kích thước và bố cục của các trang.ScaleToPageWidth = 256: Chỉ rằng nội dung của tài liệu sẽ được thay đổi kích thước để phù hợp với trang.
Enum PdfAStandardVersion
Thông tin
Xác định phiên bản tiêu chuẩn PDF/A cho tài liệu PDF.
public enum PdfAStandardVersion
Fields
Auto = 0: Phiên bản tiêu chuẩn PDF/A được xác định tự động.PDF_A_1A = 1: Xác định phiên bản tiêu chuẩn PDF/A-1a.PDF_A_1B = 2: Xác định phiên bản tiêu chuẩn PDF/A-1b.PDF_A_2A = 3: Xác định phiên bản tiêu chuẩn PDF/A-2a.PDF_A_2B = 4: Xác định phiên bản tiêu chuẩn PDF/A-2b.PDF_A_2U = 5: Xác định phiên bản tiêu chuẩn PDF/A-2u.PDF_A_3A = 6: Xác định phiên bản tiêu chuẩn PDF/A-3a.PDF_A_3B = 7: Xác định phiên bản tiêu chuẩn PDF/A-3b.PDF_A_3U = 8: Xác định phiên bản tiêu chuẩn PDF/A-3u.
Enum PdfToHtmlOptions.SaveDataType
Thông tin
Định nghĩa loại đầu ra của tệp HTML.
public enum PdfToHtmlOptions.SaveDataType
Fields
FileWithEmbeddedResources = 1: Lưu HTML vào tệp với tài nguyên nhúngFileWithExternalResources = 0: Lưu HTML vào tệp với tài nguyên bên ngoàiStreamWithEmbeddedResources = 2: Lưu HTML vào dòng tệp với tài nguyên nhúng
Thông tin
Cho phép chỉ định định dạng tệp xls/xlsx/xml/csv. Giá trị mặc định là XLSX.
Cho phép chỉ định định dạng tệp xls/xlsx/xml/csv.
Giá trị mặc định là XLSX.
public enum PdfToXlsOptions.ExcelFormat
Fields
CSV = 2: Định dạng tệp giá trị phân tá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 có macro (.xlsm).XLSX = 1: Định dạng tệp Office Open XML (.xlsx).XMLSpreadSheet2003 = 0: Định dạng tệp Excel 2003 XML (.xls).
Enum Role
Thông tin
Vai trò của tác giả tin nhắn.
Fields
Assistant = 2System = 1User = 0
Enum Rotation
Thông tin
Liệt kê các giá trị xoay có thể có.
Fields
None = 0: Không xoay.On180 = 2: Xoay 180 độ.On270 = 3: Xoay 270 độ theo chiều kim đồng hồ.On360 = 4: Xoay 360 độ theo chiều kim đồng hồ.On90 = 1: Xoay 90 độ theo chiều kim đồng hồ.
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.
Enum TextFormattingMode
Thông tin
Định nghĩa 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: Đại diện cho nội dung PDF với việc định vị các đoạn văn bản theo tọa độ của chúng. Nó cơ bản tương tự như chế độ “Raw”. Nhưng trong khi “Raw” tập trung vào việc duy trì 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ự mà nó được đọc.Pure = 0: Đại diện cho nội dung văn bản PDF với một số quy trình định dạng. Điều này bao gồm việc xem xét các vị trí tương đối và thêm khoảng trắng bổ sung để căn chỉnh văn bản với chiều rộng của trang.Raw = 1: Đại diện cho nội dung PDF như là, tức là không có định dạng.
Enum TiffColorDepth
Thông tin
Sử dụng để chỉ định Độ Sâu Màu cho Documentize.PdfToTiffOptions.
public enum TiffColorDepth
Fields
Format1bpp = 4: 1 bit mỗi pixel.Format24bpp = 1: 24 bits mỗi pixel. Rgb.Format32bpp = 0: 32 bits mỗi pixel. Được sử dụng mặc định.Format4bpp = 3: 4 bits mỗi pixel.Format8bpp = 2: 8 bits mỗi pixel.
Enum TiffCompression
Thông tin
Dùng để chỉ định loại nén cho Documentize.PdfToTiffOptions.
public enum TiffCompression
Fields
CCITT3 = 2: Chỉ định sơ đồ nén CCITT3. Có thể được truyền cho bộ mã hóa CCITT3 như một tham số thuộc danh mục Compression.CCITT4 = 1: Chỉ định sơ đồ nén CCITT4. Có thể được truyền cho bộ mã hóa CCITT4 như một tham số thuộc danh mục Compression.LZW = 0: Chỉ định sơ đồ nén LZW. Có thể được truyền cho bộ mã hóa Tiff như một tham số thuộc danh mục Compression.None = 4: Chỉ định không có nén. Có thể được truyền cho bộ mã hóa Tiff như một tham số thuộc danh mục nén.RLE = 3: Chỉ định sơ đồ nén RLE. Có thể được truyền cho bộ mã hóa RLE như một tham số thuộc danh mục Compression.
Interface IDataSource
Thông tin
Giao diện dữ liệu chung định nghĩa các thành viên chung mà dữ liệu cụ thể nên triển khai.
public interface IDataSource
Properties
DataType
Loại nguồn dữ liệu.
DataType DataType { get; }
Property Value
DataType
Thông tin
Giao diện dữ liệu chung định nghĩa Dữ liệu Đầu vào mà Options nên triển khai.
public interface IHaveInput
Properties
Lấy hoặc thiết lập Dữ liệu Đầu vào.
IDataSource Input { get; set; }
Property Value
IDataSource
Interface IOperationResult
Thông tin
Giao diện kết quả hoạt động tổng quát định nghĩa các phương thức chung mà kết quả hoạt động plugin cụ thể nên triển khai.
public interface IOperationResult
Properties
Data
Lấy dữ liệu thô.
Giá trị thuộc tính
object
IsFile
Chỉ ra liệu kết quả có phải là một đường dẫn đến một tệp đầu ra hay không.
Giá trị thuộc tính
bool
IsStream
Chỉ ra liệu kết quả có phải là một luồng đầu ra hay không.
Giá trị thuộc tính
bool
IsString
Chỉ ra liệu kết quả có phải là một chuỗi văn bản hay không.
Giá trị thuộc tính
bool
Methods
ToFile()
Cố gắng chuyển đổi kết quả thành tệp.
Trả về
string : Một chuỗi đại diện cho đường dẫn đến tệp đầu ra nếu kết quả là tệp; nếu không thì null.
ToStream()
Cố gắng chuyển đổi kết quả thành đối tượng luồng.
Trả về
Stream : Một đối tượng luồng đại diện cho dữ liệu đầu ra nếu kết quả là luồng; nếu không thì null.
Interface IPluginOptions
Thông tin
Giao diện tùy chọn plugin chung, định nghĩa các phương thức chung mà tùy chọn plugin cụ thể nên triển khai.
public interface IPluginOptions