Documentize Namespace الأقسام الفرعية
Class AddTimestampOptions
معلومات
يمثل خيارات إضافة الطابع الزمني لإضافة Documentize.Timestamp.
[Obsolete("The class will be deleted soon. Please use SignOptions class.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
AddTimestampOptions
يُنفذ
الأعضاء الموروثة
- 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()
المنشئات
AddTimestampOptions(Stream, string, string, string)
يقوم بتهيئة مثيل جديد من كائن Documentize.AddTimestampOptions مع خيارات افتراضية.
public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")
المعلمات
pfx Stream: المسار إلى ملف pfx.password string: كلمة المرور لملف pfx.serverUrl string: عنوان URL لخادم الطابع الزمني.serverBasicAuthCredentials string: بيانات اعتماد المصادقة الأساسية، واسم المستخدم وكلمة المرور مدمجان في سلسلة “username:password”. (اختياري).
AddTimestampOptions(string, string, string, string)
يقوم بتهيئة مثيل جديد من كائن Documentize.AddTimestampOptions مع خيارات افتراضية.
public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")
المعلمات
pfx string: المسار إلى ملف pfx.password string: كلمة المرور لملف pfx.serverUrl string: عنوان URL لخادم الطابع الزمني.serverBasicAuthCredentials string: بيانات اعتماد المصادقة الأساسية، واسم المستخدم وكلمة المرور مدمجان في سلسلة “username:password”. (اختياري).
Class ChatCompletion
معلومات
يمثل استجابة إكمال الدردشة المعادة من النموذج، بناءً على المدخلات المقدمة.
public class ChatCompletion
الوراثة
object ←
ChatCompletion
الأعضاء الموروثة
المنشئات
ChatCompletion()
الخصائص
Choices
قائمة بخيارات إكمال الدردشة. يمكن أن تكون أكثر من واحدة إذا كانت n أكبر من 1.
[JsonProperty("choices")]
public List<choice> Choices { get; set; }
قيمة الخاصية
List<Choice>
Created
الطابع الزمني لنظام Unix (بالثواني) عندما تم إنشاء إكمال الدردشة.
[JsonProperty("created")]
public long Created { get; set; }
قيمة الخاصية
long
Id
معرف فريد لإكمال الدردشة.
[JsonProperty("id")]
public string Id { get; set; }
قيمة الخاصية
string
Model
النموذج المستخدم لإكمال الدردشة.
[JsonProperty("model")]
public string Model { get; set; }
قيمة الخاصية
string
Object
نوع الكائن، والذي يكون دائمًا chat.completion.
[JsonProperty("object")]
public string Object { get; set; }
قيمة الخاصية
string
SystemFingerprint
يمثل هذا البصمة تكوين الخلفية الذي يعمل به النموذج.
[JsonProperty("system_fingerprint")]
public string SystemFingerprint { get; set; }
قيمة الخاصية
string
Usage
إحصائيات الاستخدام لطلب الإكمال.
[JsonProperty("usage")]
public Usage Usage { get; set; }
قيمة الخاصية
Usage
Class ChatGptConsts
معلومات
تمثل هذه الفئة تخزينًا للثوابت.
public static class ChatGptConsts
الوراثة
object ←
ChatGptConsts
الأعضاء الموروثون
الحقول
قيمة الحقل
string
ModelName
public static string ModelName
قيمة الحقل
string
SystemRole
public static string SystemRole
قيمة الحقل
string
SystemRoleDescription
public static string SystemRoleDescription
قيمة الحقل
string
UserRole
public static string UserRole
قيمة الحقل
string
Class ChatGptRequestOptions
معلومات
يمثل الخيارات لإضافة Documentize.PdfManager.
public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions
وراثة
object ←
PluginBaseOptions ←
ChatGptRequestOptions
تنفيذ
الأعضاء الوراثيون
- 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()
البانيون
ChatGptRequestOptions()
初始化新的 Documentize.ChatGptRequestOptions 对象实例,带有默认选项。
public ChatGptRequestOptions()
ChatGptRequestOptions(string, string, string, string)
初始化一个新的 Documentize.ChatGptRequestOptions 对象实例,带有选项。
public ChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)
参数
الخصائص
ApiKey
获取或设置访问 ChatGPT API 的密钥。
public string ApiKey { get; set; }
قيمة الخاصية
string
ApiUrl
获取或设置 ChatGPT API 的 URL。
public string ApiUrl { get; set; }
قيمة الخاصية
string
CancellationToken
رمز الإلغاء.
public CancellationToken CancellationToken { get; set; }
قيمة الخاصية
CancellationToken
MaxTokens
الحد الأقصى لعدد الرموز في الاستجابة.
القيمة الافتراضية هي null، مما يعني اللانهاية.
public int? MaxTokens { get; set; }
قيمة الخاصية
int?
Messages
获取或设置 Documentize.Message 对象的集合。
public List<message> Messages { get; set; }
قيمة الخاصية
List<Message>
ملاحظات
عند إضافة عدة رسائل إلى الخيارات، فإن ترتيبها في مجموعة الرسائل هو كما يلي:
- الرسالة الأولى (إن وجدت) تأتي من options.Query، تسبقها الرسالة التي تحتوي على المحتوى: “أنت مساعد مفيد.”,
والدور هو “نظام”.
- ثم يتم إضافة الرسائل من مجموعة options.Messages (إن وجدت).
- تُضاف رسائل من مصادر الملفات (إن وجدت) في النهاية، كائن رسالة واحد لكل مستند مع دور “مستخدم”.
إذا لم يتم توفير أي رسالة واحدة، يتم إطلاق ArgumentException.
Model
يحدد أو يحصل على هوية النموذج للاستخدام.
public string Model { get; set; }
قيمة الخاصية
string
NumberOfChoices
كم عدد خيارات الاكتمال للدردشة التي يجب إنشاؤها لكل رسالة إدخال.
public int NumberOfChoices { get; set; }
قيمة الخاصية
int
Query
获取或设置对 ChatGPT 的字符串请求。
如果不为空,这是集合中的第一条消息,
将作为请求发送。
public string Query { get; set; }
قيمة الخاصية
string
Temperature
使用的采样温度,介于 0 和 2 之间。
较高的值如 0.8 将使输出更随机,
而较低的值如 0.2 将使输出更集中和确定。
默认值为 1。
public double Temperature { get; set; }
قيمة الخاصية
double
Class CompressOptions
معلومات
يمثل خيارات الضغط لإضافة Documentize.PdfManager.
public sealed class CompressOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
CompressOptions
التطبيقات
الأعضاء الموروثة
- 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()
البانيون
CompressOptions()
يتم تهيئة مثيل جديد من كائن Documentize.CompressOptions مع الخيارات الافتراضية.
Class DecryptionOptions
معلومات
يمثل خيارات فك التشفير لإضافة Documentize.Security.
public class DecryptionOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
DecryptionOptions
التنفيذات
الأعضاء الموروثة
- 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()
البانيين
DecryptionOptions(string)
يبدأ مثيلًا جديدًا من كائن Documentize.DecryptionOptions مع خيارات افتراضية.
public DecryptionOptions(string ownerPassword)
المعلمات
ownerPassword string: كلمة مرور المالك.
الخصائص
OwnerPassword
كلمة مرور المالك.
public string OwnerPassword { get; set; }
قيمة الخاصية
string
Class DecryptOptions
معلومات
يمثل خيارات فك التشفير لملحق Documentize.PdfSecurity.
public class DecryptOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
DecryptOptions
التنفيذات
الأعضاء الموروثة
- 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()
المنشئات
DecryptOptions(string)
يقوم بتهيئة مثيل جديد من كائن Documentize.DecryptOptions مع خيارات افتراضية.
public DecryptOptions(string ownerPassword)
المعاملات
ownerPassword string: كلمة مرور المالك.
الخصائص
OwnerPassword
كلمة مرور المالك.
public string OwnerPassword { get; set; }
قيمة الخاصية
string
Class DirectoryDataSource
معلومات
يمثل بيانات الدليل لعمليات التحميل والحفظ لمكون إضافي.
public sealed class DirectoryDataSource : IDataSource
Inheritance
object ←
DirectoryDataSource
Implements
Inherited Members
Constructors
DirectoryDataSource(string)
يبدأ بيانات الدليل الجديدة مع المسار المحدد.
public DirectoryDataSource(string path)
Parameters
path string: سلسلة تمثل المسار إلى الدليل.
Properties
DataType
نوع مصدر البيانات.
public DataType DataType { get; }
Property Value
DataType
Path
يحصل على المسار إلى دليل البيانات الحالي.
public string Path { get; }
Property Value
string
Class DocConverter
معلومات
يمثل مكون Documentize.DocConverter. يُستخدم لتحويل مستندات PDF إلى صيغة DOC/DOCX.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class DocConverter
Inheritance
object ←
DocConverter
Inherited Members
Methods
Process(PdfToDocOptions)
يحول مستند PDF إلى صيغة DOC/DOCX.
public static ResultContainer Process(PdfToDocOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Class EncryptionOptions
معلومات
يمثل خيارات التشفير لإضافة Documentize.Security.
public class EncryptionOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
EncryptionOptions
التنفيذ
الأعضاء الموروثة
- 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()
البناة
EncryptionOptions(string, string)
يهيئ مثيلاً جديدًا من كائن Documentize.EncryptionOptions مع الخيارات الافتراضية.
public EncryptionOptions(string ownerPassword, string userPassword)
المعلمات
ownerPassword string: كلمة مرور المالك.userPassword string: كلمة مرور المستخدم.
الخصائص
OwnerPassword
كلمة مرور المالك.
public string OwnerPassword { get; set; }
قيمة الخاصية
string
UserPassword
كلمة مرور المستخدم.
public string UserPassword { get; set; }
قيمة الخاصية
string
Class EncryptOptions
معلومات
يمثل خيارات التشفير لمكون Documentize.PdfSecurity.
public class EncryptOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
EncryptOptions
التنفيذ
الأعضاء الموروثة
- 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()
المنشئات
EncryptOptions(string, string)
يقوم بتهيئة مثيل جديد من كائن Documentize.EncryptOptions مع خيارات افتراضية.
public EncryptOptions(string ownerPassword, string userPassword)
المعلمات
ownerPassword string: كلمة مرور المالك.userPassword string: كلمة مرور المستخدم.
الخصائص
OwnerPassword
كلمة مرور المالك.
public string OwnerPassword { get; set; }
قيمة الخاصية
string
UserPassword
كلمة مرور المستخدم.
public string UserPassword { get; set; }
قيمة الخاصية
string
معلومات
يمثل الخيارات لتصدير قيم الحقول لمكون Documentize.PdfExtractor.
public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
ExtractFormDataToDsvOptions
التنفيذ
الأعضاء الموروثة
- 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()
المنشئات
يهيئ مثيلاً جديدًا من كائن Documentize.ExtractFormDataToDsvOptions.
public ExtractFormDataToDsvOptions(char delimeter = ',', bool addFieldNames = false)
المعاملات
delimeter char: يحدد الفاصل الذي سيتم استخدامه في البيانات المصدرة بين القيم. القيمة الافتراضية هي ‘,’.addFieldNames bool: إضافة اسم الحقل قبل القيمة. التنسيق: الاسم + الفاصل + القيمة + الفاصل.
الخصائص
إضافة اسم الحقل قبل القيمة.
التنسيق: الاسم + الفاصل + القيمة + الفاصل.
public bool AddFieldName { get; set; }
قيمة الخاصية
bool
الفاصل المستخدم للقيم المصدرة.
public char Delimeter { get; set; }
قيمة الخاصية
char
معلومات
يمثل خيارات استخراج الصور لإضافة Documentize.PdfExtractor.
public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
ExtractImagesOptions
التنفيذ
الأعضاء الموروثة
- 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()
البناة
ينشئ مثيلًا جديدًا من كائن Documentize.ExtractImagesOptions مع الخيارات الافتراضية.
public ExtractImagesOptions()
معلومات
تمثل خيارات استخراج النص لـ Documentize.PdfExtractor.
public sealed class ExtractTextOptions
الوراثة
object ←
ExtractTextOptions
الأعضاء الموروثة
المنشئات
يبدأ مثيلًا جديدًا من كائن Documentize.ExtractTextOptions لوضع تنسيق النص المحدد.
public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)
المعلمات
الخصائص
يحصل على وضع التنسيق.
public TextFormattingMode FormattingMode { get; set; }
قيمة الخاصية
TextFormattingMode
يعود ببيانات المدخلات للعملية.
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف بيانات جديدة إلى المدخلات.
public void AddInput(IDataSource dataSource)
المعلمات
Class FileDataSource
معلومات
يمثل بيانات الملف لعمليات التحميل والحفظ للإضافة.
public sealed class FileDataSource : IDataSource
الوراثة
object ←
FileDataSource
ينفذ
الأعضاء الموروثة
المُنشئات
FileDataSource(string)
يتم تهيئة مصدر البيانات الملف الجديد مع المسار المحدد.
public FileDataSource(string path)
المعلمات
path string: سلسلة تمثل المسار إلى الملف المصدر.
الخصائص
DataType
نوع مصدر البيانات.
public DataType DataType { get; }
قيمة الخاصية
DataType
Path
يحصل على المسار إلى ملف البيانات الحالي.
public string Path { get; }
قيمة الخاصية
string
Class FileResult
معلومات
تمثل نتيجة العملية في شكل مسار نصي إلى ملف.
public sealed class FileResult : IOperationResult
الوراثة
object ←
FileResult
تنفذ
الأعضاء الموروثة
الخصائص
البيانات
الحصول على البيانات الخام.
public object Data { get; }
قيمة الخاصية
object
IsFile
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف إخراج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsStream
تشير إلى ما إذا كانت النتيجة تدفق إخراج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
تشير إلى ما إذا كانت النتيجة نصًا.
public bool IsString { get; }
قيمة الخاصية
bool
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
يعيد
string : سلسلة تمثل مسار إلى ملف الإخراج إذا كانت النتيجة هي ملف؛ وإلا null.
ToStream()
يحاول تحويل النتيجة إلى كائن تدفق.
يعيد
Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة هي تدفق؛ وإلا null.
معلومات
تمثل الاضافة Documentize.FormExporter. تستخدم لتصدير قيم النماذج من مستندات PDF إلى ملف DSV أو CSV.
[Obsolete("The class will be deleted soon. Please use PdfExtractor class.")]
public static class FormExporter
الميراث
object ←
FormExporter
الأعضاء الموروثة
الطرق
تبدأ معالجة Documentize.FormExporter بالمعلمات المحددة.
public static ResultContainer Process(ExtractFormDataToDsvOptions options)
المعلمات
العائدات
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
معلومات
يمثل الخيارات لتصدير قيم الحقول لملحق Documentize.FormExporter.
public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
FormExportToDsvOptions
التنفيذ
الأعضاء الموروثة
- 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()
المنشئات
يُهيئ مثيل جديد من كائن Documentize.FormExportToDsvOptions.
public FormExportToDsvOptions(char delimeter = ',', bool addFieldNames = false)
المعلمات
delimeter char: يحدد الفاصل المستخدم في البيانات المصدرة بين القيم. القيمة الافتراضية هي ‘,’.addFieldNames bool: إضافة اسم الحقل قبل القيمة. التنسيق: الاسم + الفاصل + القيمة + الفاصل.
الخصائص
إضافة اسم الحقل قبل القيمة.
التنسيق: الاسم + الفاصل + القيمة + الفاصل.
public bool AddFieldName { get; set; }
قيمة الخاصية
bool
الفاصل المستخدم للقيم المصدرة.
public char Delimeter { get; set; }
قيمة الخاصية
char
معلومات
يمثل ملحق Documentize.FormFlattener. يستخدم لتسطيح الحقول في مستندات PDF.
public static class FormFlattener
الوراثة
object ←
FormFlattener
الأعضاء الموروثة
أمثلة
توضح المثال كيفية تسطيح الحقول في ملف PDF.
// إنشاء كائن FormFlattenerOptions لتعيين التعليمات
var options = new FormFlattenerOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
FormFlattener.Process(options);
توضح المثال كيفية تسطيح الحقول في ملف PDF وتخطي الحقل الأول.
// الحصول على أسماء الحقول
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// إنشاء كائن FormFlattenerOptions لتعيين التعليمات
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تخطي 1 حقل.
options.SkipFields.Add(fieldNames[0]);
// تنفيذ العملية
FormFlattener.Process(options);
توضح المثال كيفية الحصول على أسماء الحقول من ملف PDF.
// الحصول على أسماء الحقول
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
الطرق
الحصول على أسماء الحقول في مستند PDF.
public static List<string> GetFieldNames(string path)
المعاملات
path string: المسار إلى مستند PDF.
النتائج
List<string>
قائمة بالأسماء في مستند PDF.
public static List<string> GetFieldNames(Stream stream)
المعاملات
stream Stream: الدفق مع مستند PDF.
النتائج
List<string>
قائمة بالأسماء في مستند PDF.
public static ResultContainer Process(FormFlattenerOptions options)
المعاملات
النتائج
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
معلومات
يمثل الخيارات لتفريغ الحقول في المستند بواسطة ملحق Documentize.FormFlattener.
public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
FormFlattenerOptions
تنفيذ
الأعضاء الموروثة
- 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()
المنشئات
يتم تهيئة مثيل جديد من كائن Documentize.FormFlattenerOptions مع الخيارات الافتراضية.
public FormFlattenerOptions()
الخصائص
قائمة الحقول التي لن يتم تفريغها.
public List<string> SkipFields { get; set; }
قيمة الخاصية
List<string>
Class HtmlConverter
معلومات
يمثل إضافة Documentize.HtmlConverter. تُستخدم لتحويل مستندات PDF إلى تنسيق HTML ومستندات HTML إلى تنسيق PDF.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class HtmlConverter
Inheritance
object ←
HtmlConverter
Inherited Members
Methods
Process(PdfToHtmlOptions)
تحول مستندات PDF إلى تنسيق HTML.
public static ResultContainer Process(PdfToHtmlOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Process(HtmlToPdfOptions)
تحول مستندات HTML إلى تنسيق PDF.
public static ResultContainer Process(HtmlToPdfOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Class HtmlToPdfOptions
معلومات
تمثل خيارات محول HTML إلى PDF لملحق Documentize.PdfConverter.
public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
HtmlToPdfOptions
تنفذ
الأعضاء الموروثة
- 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()
المُنشؤون
HtmlToPdfOptions()
يهيئ مثيلًا جديدًا من كائن Documentize.HtmlToPdfOptions.
public HtmlToPdfOptions()
الخصائص
BasePath
مسار/عنوان URL الأساسي لملف HTML.
public string BasePath { get; set; }
قيمة الخاصية
string
يحصل على أو يحدد أنواع الوسائط الممكنة المستخدمة خلال عملية العرض.
public HtmlMediaType HtmlMediaType { get; set; }
قيمة الخاصية
HtmlMediaType
IsRenderToSinglePage
يحصل على أو يحدد عرض جميع المستندات في صفحة واحدة.
public bool IsRenderToSinglePage { get; set; }
قيمة الخاصية
bool
PageInfo
يحصل على أو يحدد معلومات صفحة المستند.
public PageInfo PageInfo { get; set; }
قيمة الخاصية
PageInfo
PageLayoutOption
يحصل على أو يحدد خيار التخطيط.
public HtmlPageLayoutOption PageLayoutOption { get; set; }
قيمة الخاصية
HtmlPageLayoutOption
معلومات
يمثل مكون Documentize.ImageExtractor. يُستخدم لاستخراج الصور من مستندات PDF.
[Obsolete("The class will be deleted soon. Please use PdfExtractor class.")]
public static class ImageExtractor
وراثة
object ←
ImageExtractor
الأعضاء الموروثة
الأساليب
استخراج الصور من مستند PDF.
public static ResultContainer Process(ExtractImagesOptions options)
المعلمات
إرجاع
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا كانت الخيارات غير مضبوطة.
معلومات
يمثل خيارات استخراج الصور لإضافة Documentize.ImageExtractor.
public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
ImageExtractorOptions
التنفيذات
الأعضاء الموروثة
- 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()
المنشآت
يبدأ مثيلًا جديدًا من كائن Documentize.ImageExtractorOptions مع خيارات افتراضية.
public ImageExtractorOptions()
Class JpegConverter
معلومات
يمثل إضافة Documentize.JpegConverter. تُستخدم لتحويل مستندات PDF إلى تنسيق JPEG.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class JpegConverter
الوراثة
object ←
JpegConverter
الأعضاء الموروثين
الطرق
Process(PdfToJpegOptions)
تحول مستند PDF إلى تنسيق JPEG.
public static ResultContainer Process(PdfToJpegOptions options)
المعلمات
options PdfToJpegOptions: كائن الخيارات الذي يحتوي على تعليمات لإضافة Documentize.JpegConverter.
القيم المرتجعة
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Class License
معلومات
يوفر طريقة لتعيين الترخيص.
public static class License
الوراثة
object ←
License
الأعضاء الموروثة
أمثلة
يوضح كيفية تفعيل الترخيص.
// Set License
License.Set("PathToLicense.lic");
الطرق
Set(string)
يرخص المكون.
public static void Set(string licenseName)
المعلمات
licenseName string: يمكن أن يكون اسم ملف كامل أو مختصر. استخدم سلسلة فارغة للتحويل إلى وضع التقييم.
Class MergeOptions
معلومات
تمثل خيارات الدمج لملحق Documentize.PdfManager.
public sealed class MergeOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
MergeOptions
تنفذ
الأعضاء الموروثة
- 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()
المُنشئون
MergeOptions()
يقوم بتهيئة مثيل جديد من كائن Documentize.MergeOptions مع خيارات افتراضية.
Class Merger
معلومات
يمثل مكون Documentize.Merger. يستخدم لدمج عدة مستندات PDF في ملف PDF واحد.
[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class Merger
الوراثة
object ←
Merger
الأعضاء الموروثة
الطرق
Process(MergeOptions)
دمج مستندات PDF.
public static ResultContainer Process(MergeOptions options)
المعلمات
options MergeOptions: كائن خيارات يحتوي على تعليمات للعملية.
الإرجاع
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Class Message
معلومات
رسالة إكمال دردشة تم إنشاؤها بواسطة النموذج.
الوراثة
object ←
Message
الأعضاء الموروثون
المنشئات
Message()
الخصائص
المحتوى
محتويات الرسالة.
[JsonProperty("content")]
public string Content { get; set; }
قيمة الخاصية
string
الدور
يحدد أو يحصل على دور مؤلف هذه الرسالة.
[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }
قيمة الخاصية
Role
Class ObjectResult
معلومات
يمثل نتيجة العملية في شكل سلسلة.
public sealed class ObjectResult : IOperationResult
الوراثة
object ←
ObjectResult
ينفذ
الأعضاء الموروثة
الخصائص
البيانات
يحصل على البيانات الخام.
public object Data { get; }
قيمة الخاصية
object
IsFile
تشير إلى ما إذا كانت النتيجة مسارًا لملف إخراج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsObject
تشير إلى ما إذا كانت النتيجة كائنًا.
public bool IsObject { get; }
قيمة الخاصية
bool
IsStream
تشير إلى ما إذا كانت النتيجة مسارًا لملف إخراج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
تشير إلى ما إذا كانت النتيجة سلسلة.
public bool IsString { get; }
قيمة الخاصية
bool
النص
يعيد التمثيل النصي للنتيجة.
public string Text { get; }
قيمة الخاصية
string
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
يعود
string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ خلاف ذلك null.
ToStream()
يحاول تحويل النتيجة إلى كائن تدفق.
يعود
Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة تدفقًا؛ خلاف ذلك null.
ToString()
يحاول تحويل النتيجة إلى سلسلة.
public override string ToString()
يعود
string : سلسلة تمثل محتوى النص إذا كانت النتيجة سلسلة؛ خلاف ذلك ترجع base.ToString().
Class OptimizeOptions
معلومات
يمثل خيارات التحسين لإضافة Documentize.PdfManager.
public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
OptimizeOptions
ينفذ
الأعضاء الموروثة
- 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()
المنشئون
OptimizeOptions()
يهيئ مثيلًا جديدًا من كائن Documentize.OptimizeOptions مع خيارات افتراضية.
قم بخطية الوثيقة من أجل
- فتح الصفحة الأولى بأسرع ما يمكن؛
- عرض الصفحة التالية أو متابعتها عبر رابط إلى الصفحة التالية بأسرع ما يمكن؛
- عرض الصفحة بشكل تدريجي كما تصل عندما يتم تسليم البيانات لصفحة عبر قناة بطيئة (عرض أكثر البيانات فائدة أولاً)؛
- السماح بتفاعل المستخدم، مثل متابعة رابط، ليتم تنفيذها حتى قبل استلام وعرض الصفحة بالكامل.
Class Optimizer
معلومات
يمثل إضافة Documentize.Optimizer. يُستخدم لتحسين وتدوير وتغيير حجم وضغط مستندات PDF.
[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class Optimizer
Inheritance
object ←
Optimizer
Inherited Members
Methods
Process(OptimizeOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public static ResultContainer Process(OptimizeOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Process(RotateOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public static ResultContainer Process(RotateOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Process(ResizeOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public static ResultContainer Process(ResizeOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Process(CompressOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public static ResultContainer Process(CompressOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Class PageInfo
public class PageInfo : PageSize
الوراثة
object ←
PageSize ←
PageInfo
الأعضاء الموروثون
- 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()
المنشئات
PageInfo()
منشئ Documentize.PageInfo.
PageInfo(double, double)
منشئ Documentize.PageInfo.
public PageInfo(double width, double height)
المعلمات
الخصائص
MarginBottom
يحصل أو يحدد قيمة تشير إلى الهامش السفلي.
public double MarginBottom { get; set; }
قيمة الخاصية
double
MarginLeft
يحصل أو يحدد قيمة تشير إلى الهامش الأيسر.
public double MarginLeft { get; set; }
قيمة الخاصية
double
MarginRight
يحصل أو يحدد قيمة تشير إلى الهامش الأيمن.
public double MarginRight { get; set; }
قيمة الخاصية
double
MarginTop
يحصل أو يحدد قيمة تشير إلى الهامش العلوي.
public double MarginTop { get; set; }
قيمة الخاصية
double
Class PageSize
معلومات
فئة تمثل حجم الصفحة في مستند PDF.
Inheritance
object ←
PageSize
Derived
Inherited Members
Constructors
PageSize()
Constructor of Documentize.PageSize. A4 sizes by default.
PageSize(double, double)
Constructor of Documentize.PageSize.
public PageSize(double width, double height)
Parameters
Properties
A0
حجم A0 (1189x840 مم).
public static PageSize A0 { get; }
Property Value
PageSize
A1
حجم A1 (840x594 مم).
public static PageSize A1 { get; }
Property Value
PageSize
A2
حجم A2 (594x420 مم).
public static PageSize A2 { get; }
Property Value
PageSize
A3
حجم A3 (420x297 مم).
public static PageSize A3 { get; }
Property Value
PageSize
A4
حجم A4 (297x210 مم).
public static PageSize A4 { get; }
Property Value
PageSize
A5
حجم A5 (210x148 مم).
public static PageSize A5 { get; }
Property Value
PageSize
A6
حجم A6 (148x105 مم).
public static PageSize A6 { get; }
Property Value
PageSize
B5
حجم B5 (250x176 مم).
public static PageSize B5 { get; }
Property Value
PageSize
Height
الحصول على أو تعيين ارتفاع الصفحة.
public double Height { get; set; }
Property Value
double
IsLandscape
الحصول على اتجاه الصفحة. يعيد true إذا كان هذا هو الاتجاه الأفقي وfalse إذا كان هذا هو الاتجاه العمودي.
public bool IsLandscape { get; }
Property Value
bool
P11x17
تنسيق 11x17 بوصة.
public static PageSize P11x17 { get; }
Property Value
PageSize
PageLedger
حجم دفتر (432x279 مم).
public static PageSize PageLedger { get; }
Property Value
PageSize
PageLegal
حجم قانوني (356x216 مم).
public static PageSize PageLegal { get; }
Property Value
PageSize
PageLetter
حجم رسالة (279x216 مم).
public static PageSize PageLetter { get; }
Property Value
PageSize
Width
الحصول على أو تعيين عرض الصفحة.
public double Width { get; set; }
Property Value
double
Class PdfAConverter
معلومات
تمثل إضافة لمعالجة تحويل مستندات PDF إلى تنسيق PDF/A والتحقق من conformal PDF/A.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class PdfAConverter
الوراثة
object ←
PdfAConverter
الأعضاء الموروثة
الطرق
Process(PdfToPdfAOptions)
يحول مستند PDF إلى تنسيق PDF/A.
public static ResultContainer Process(PdfToPdfAOptions options)
المعلمات
الإرجاع
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Process(PdfAValidateOptions)
تحقق من امتثال مستند PDF للتنسيق المحدد PDF/A.
public static ResultContainer Process(PdfAValidateOptions options)
المعلمات
الإرجاع
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Class PdfAConvertOptions
معلومات
يمثل خيارات لتحويل مستندات PDF إلى تنسيق PDF/A باستخدام المكون الإضافي Documentize.PdfAConverter.
public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions
الوراثة
object ←
PdfAOptionsBase ←
PdfAConvertOptions
تنفيذ
الأعضاء الموروثة
- 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()
المنشئين
PdfAConvertOptions()
public PdfAConvertOptions()
الخصائص
Outputs
يحصل على مجموعة من الأهداف المضافة (مصادر بيانات ملف أو تدفق) لنتائج عملية الحفظ.
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الأساليب
AddOutput(IDataSource)
يضيف هدف حفظ نتيجة جديدة.
public void AddOutput(IDataSource dataSource)
المعلمات
dataSource IDataSource: الهدف (ملف أو مصدر بيانات تدفق) لحفظ نتائج العملية. :
Class PdfAOptionsBase
معلومات
تمثل هذه الفئة الفئة الأساسية لخيارات ملحق Documentize.PdfAConverter. توفر هذه الفئة خصائص وطرق لتكوين عملية تحويل PDF/A والتحقق منها.
تمثل هذه الفئة الفئة الأساسية لخيارات ملحق Documentize.PdfAConverter.
توفر هذه الفئة خصائص وطرق لتكوين عملية تحويل PDF/A والتحقق منها.
public abstract class PdfAOptionsBase : IPluginOptions
الوراثة
object ←
PdfAOptionsBase
المشتقات
التنفيذ
الأعضاء الموروثة
المنشئات
PdfAOptionsBase()
protected PdfAOptionsBase()
الخصائص
AlignText
يسترجع أو يحدد قيمة تشير إلى ما إذا كانت وسائل إضافية ضرورية للحفاظ على محاذاة النص خلال عملية تحويل PDF/A.
public bool AlignText { get; set; }
قيمة الخاصية
bool
ملاحظات
عند تعيينها على true، ستحاول عملية التحويل استعادة حدود جزء النص الأصلي.
بالنسبة لمعظم المستندات، لا يحتاج هذا الخاصية إلى تغيير القيمة الافتراضية false، حيث إن محاذاة النص لا تتغير أثناء عملية التحويل الافتراضية.
CheckDifferentNamesInFontDictionaries
يسترجع العلامات التي تتحكم في تحويل PDF/A للحالات التي لا يتطابق فيها مستند PDF المصدر مع مواصفة PDF.
public bool CheckDifferentNamesInFontDictionaries { get; set; }
قيمة الخاصية
bool
ErrorAction
يسترجع أو يحدد الإجراء الواجب اتخاذه للأجسام التي لا يمكن تحويلها.
public ConvertErrorAction ErrorAction { get; set; }
قيمة الخاصية
ConvertErrorAction
IccProfileFileName
يسترجع أو يحدد اسم ملف ملف تعريف ICC (التحالف الدولي للألوان) الذي سيتم استخدامه في تحويل PDF/A بدلاً من الملف الافتراضي.
public string IccProfileFileName { get; set; }
قيمة الخاصية
string
يسترجع مجموعة مصادر البيانات
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
IsLowMemoryMode
يسترجع أو يحدد قيمة تشير إلى ما إذا كان وضع الذاكرة المنخفضة مفعلًا خلال عملية تحويل PDF/A.
public bool IsLowMemoryMode { get; set; }
قيمة الخاصية
bool
LogOutputSource
يسترجع أو يحدد مصدر البيانات لخرج السجل.
public IDataSource LogOutputSource { get; set; }
قيمة الخاصية
IDataSource
OptimizeFileSize
يسترجع أو يحدد قيمة تشير إلى ما إذا كان ينبغي محاولة تقليل حجم الملف خلال عملية تحويل PDF/A.
public bool OptimizeFileSize { get; set; }
قيمة الخاصية
bool
ملاحظات
عند تعيينها على true، ستحاول عملية التحويل تقليل حجم الملف الناتج.
قد يؤثر ذلك على أداء عملية التحويل.
PdfAVersion
يسترجع أو يحدد إصدار معيار PDF/A الذي سيتم استخدامه للتحقق أو التحويل.
public PdfAStandardVersion PdfAVersion { get; set; }
قيمة الخاصية
PdfAStandardVersion
ملاحظات
يستخدم إصدار معيار PDF/A لتحديد مستوى الامتثال للتحقق والتحويل PDF/A.
إذا تم تعيين الإصدار على Documentize.PdfAStandardVersion.Auto، سيحدد النظام تلقائيًا
الإصدار المناسب من معيار PDF/A للتحقق بناءً على بيانات التعريف الخاصة بالمستند.
بالنسبة لعملية تحويل PDF/A، سيكون القيمة الافتراضية لـ Documentize.PdfAStandardVersion.Auto هي النسخة القياسية PDF/A-1b.
SoftMaskAction
يسترجع أو يحدد الإجراء الواجب اتخاذه خلال تحويل الصور ذات الأقنعة اللينة.
public ConvertSoftMaskAction SoftMaskAction { get; set; }
قيمة الخاصية
ConvertSoftMaskAction
الطرق
يضيف مصدر بيانات جديد إلى المجموعة
public void AddInput(IDataSource dataSource)
المعلمات
Class PdfAValidateOptions
معلومات
يمثل الخيارات الخاصة بالتحقق من توافق PDF/A المستندات PDF مع المكون الإضافي Documentize.PdfConverter.
public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions
الوراثة
object ←
PdfAOptionsBase ←
PdfAValidateOptions
ينفذ
الأعضاء الموروثة
- 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()
المنشئات
PdfAValidateOptions()
public PdfAValidateOptions()
Class PdfAValidationResult
معلومات
يمثل نتيجة عملية التحقق من صحة PDF/A.
public sealed class PdfAValidationResult
الوراثة
object ←
PdfAValidationResult
الأعضاء الموروثة
الحقول
DataSource يحصل على مصدر البيانات الذي تم التحقق منه.
قيمة الحقل
IDataSource
IsValid
يحصل على قيمة تشير إلى ما إذا كانت عملية التحقق ناجحة.
public readonly bool IsValid
قيمة الحقل
bool
StandardVersion
يحصل على إصدار معيار PDF/A الذي تم استخدامه للتحقق.
public readonly PdfAStandardVersion StandardVersion
قيمة الحقل
PdfAStandardVersion
Class PdfChatGpt
معلومات
يمثل برنامج PdfChatGpt المساعد.
[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class PdfChatGpt
الوراثة
object ←
PdfChatGpt
الأعضاء الموروثة
الملاحظات
يستخدم Documentize.PdfChatGpt لإرسال الطلبات إلى ChatGPT مباشرة
أو عن طريق إضافة مصادر ملفات PDF وحفظ الرد في مصدر الإخراج.
الطرق
Process(IPluginOptions)
لا توجد نسخة متزامنة من هذه الطريقة. استخدم طريقة ProcessAsync بدلاً من ذلك.
public static ResultContainer Process(IPluginOptions options)
المعلمات
الإرجاع
ResultContainer : #### الاستثناءات
NotImplementedException
ProcessAsync(IPluginOptions)
يبدأ معالجة PdfChatGpt مع المعلمات المحددة.
public static Task<resultcontainer> ProcessAsync(IPluginOptions options)
المعلمات
الإرجاع
Task<ResultContainer>
كائن المهمة الذي يمثل العملية غير المتزامنة.
الاستثناءات
ArgumentException : InvalidOperationException
Class PdfChatGptOptions
معلومات
يمثل الخيارات لـ Documentize.PdfChatGpt plugin.
public class PdfChatGptOptions : IPluginOptions
الوراثة
object ←
PdfChatGptOptions
المشتقة
تنفيذ
الأعضاء الموروثة
المُنشئون
PdfChatGptOptions()
يحدد مثيلًا جديدًا لكائن Documentize.PdfChatGptOptions.
public PdfChatGptOptions()
الخصائص
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
المخرجات
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف مصدر بيانات جديد إلى مجموعة بيانات مكون PdfChatGpt.
public void AddInput(IDataSource dataSource)
المعلمات
dataSource IDataSource: مصدر البيانات (ملف أو تدفق) لإضافته.
AddOutput(IDataSource)
يضيف مصدر بيانات حفظ جديد إلى مجموعة بيانات مكون PdfChatGpt.
public void AddOutput(IDataSource saveDataSource)
المعلمات
saveDataSource IDataSource: مصدر البيانات (ملف أو تدفق) لحفظ نتائج العملية. :
Class PdfChatGptRequestOptions
معلومات
يمثل الخيارات لـ Documentize.PdfChatGpt plugin.
public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions
التوريث
object ←
PdfChatGptOptions ←
PdfChatGptRequestOptions
التنفيذ
الأعضاء الموروثة
- 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()
المنشئات
PdfChatGptRequestOptions()
يبدأ مثيلًا جديدًا من كائن Documentize.PdfChatGptRequestOptions مع خيارات افتراضية.
public PdfChatGptRequestOptions()
PdfChatGptRequestOptions(string, string, string, string)
يبدأ مثيلًا جديدًا من كائن Documentize.PdfChatGptRequestOptions مع خيارات.
public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)
المعلمات
الخصائص
ApiKey
يحصل أو يحدد المفتاح للوصول إلى واجهة برمجة تطبيقات ChatGPT.
public string ApiKey { get; set; }
قيمة الخاصية
string
ApiUrl
يحصل أو يحدد عنوان URL لواجهة برمجة تطبيقات ChatGPT.
public string ApiUrl { get; set; }
قيمة الخاصية
string
CancellationToken
رمز الإلغاء.
public CancellationToken CancellationToken { get; set; }
قيمة الخاصية
CancellationToken
MaxTokens
الحد الأقصى لعدد الرموز في الاستجابة.
القيمة الافتراضية هي null، مما يعني اللانهاية.
public int? MaxTokens { get; set; }
قيمة الخاصية
int?
Messages
يحصل أو يحدد مجموعة من كائنات Documentize.Message.
public List<message> Messages { get; set; }
قيمة الخاصية
List<Message>
الملاحظات
عند إضافة عدة رسائل إلى الخيارات، يكون ترتيب مجموعة الرسائل كما يلي:
- الرسالة الأولى (إن وجدت) هي من options.Query، تسبقها الرسالة بمحتوى: “أنت مساعد مفيد."، والدور هو “نظام”.
- ثم (إن وجدت) يتم إضافة الرسائل من مجموعة options.Messages.
- تُضاف الرسائل من مصادر الملفات (إن وجدت) في النهاية، كائن رسالة واحد لكل مستند مع دور “مستخدم”.
إذا لم يتم تقديم أي رسالة، سيتم رمي ArgumentException.
Model
يحدد أو يحصل على معرّف النموذج للاستخدام.
public string Model { get; set; }
قيمة الخاصية
string
NumberOfChoices
كم عدد خيارات استكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال.
public int NumberOfChoices { get; set; }
قيمة الخاصية
int
Query
يحصل أو يحدد نص الطلب إلى ChatGPT.
إذا لم يكن فارغًا، فهذه هي الرسالة الأولى في المجموعة،
التي ستُرسل في الطلب.
public string Query { get; set; }
قيمة الخاصية
string
Temperature
ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و 2.
القيم الأعلى مثل 0.8 ستجعل المخرجات أكثر عشوائية،
بينما القيم الأقل مثل 0.2 ستجعلها أكثر تركيزًا وحتمية.
القيمة الافتراضية هي 1.
public double Temperature { get; set; }
قيمة الخاصية
double
Class PdfConverter
معلومات
يمثل مكون Documentize.PdfConverter. يستخدم لتحويل مستندات PDF إلى تنسيقات أخرى مثل DOCX/DOC، XLSX/XLS/CSV/XLSM/ODS، HTML، JPEG، PNG، TIFF، PDF/A. كما يسمح لك بتنفيذ تحقق من PDF/A وتحويل HTML إلى PDF.
يمثل مكون Documentize.PdfConverter. يستخدم لتحويل مستندات PDF إلى تنسيقات أخرى مثل DOCX/DOC، XLSX/XLS/CSV/XLSM/ODS، HTML، JPEG، PNG، TIFF، PDF/A.
كما يسمح لك بتنفيذ تحقق من PDF/A وتحويل HTML إلى PDF.
public static class PdfConverter
الوراثة
object ←
PdfConverter
الأعضاء الموروثة
الأمثلة
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق Doc.
// إنشاء كائن PdfToDocOptions لتحديد التعليمات
var options = new PdfToDocOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق Doc مع إعداد الوضع.
// إنشاء كائن PdfToDocOptions لتحديد التعليمات
var options = new PdfToDocOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// تحديد الوضع
options.Mode = DocConversionMode.Flow;
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل PDF إلى مستند XLSX.
// إنشاء كائن PdfToXlsOptions لتحديد التعليمات
var options = new PdfToXlsOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xlsx"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل PDF إلى مستند XLS.
// إنشاء كائن PdfToXlsOptions لتحديد التعليمات
var options = new PdfToXlsOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد تنسيق XLS
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// تحديد مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xls"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل PDF إلى مستند HTML.
// إنشاء كائن PdfToHtmlOptions لتحديد نوع البيانات الناتجة كملف مع موارد مضمنة
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تحديد مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_output.html"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل HTML إلى مستند PDF.
// إنشاء HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.html"));
// تحديد مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق JPEG.
// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToJpegOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق JPEG مع إعدادات للصفحات والدقة والجودة.
// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToJpegOptions();
// معالجة الصفحة الأولى فقط
options.PageList = [1];
// تحديد دقة الإخراج إلى 200 DPI
options.OutputResolution = 200;
// تحديد الجودة إلى 50
options.Quality = 50;
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق JPEG إلى تيارات.
// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToJpegOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تنفيذ العملية
var results = PdfConverter.Convert(options);
// الحصول على نتائج التيار
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق PNG.
// إنشاء كائن PdfToPngOptions لتحديد التعليمات
var options = new PdfToPngOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل صفحة واحدة من مستند PDF إلى تنسيق PNG.
// إنشاء كائن PdfToPngOptions لتحديد التعليمات
var options = new PdfToPngOptions()
// معالجة الصفحة الأولى فقط
options.PageList = [1];
// تحديد دقة الإخراج إلى 200 DPI
options.OutputResolution = 200;
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق PNG إلى تيارات.
// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToPngOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تنفيذ العملية
var results = PdfConverter.Convert(options);
// الحصول على نتائج التيار
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق TIFF.
// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق TIFF مع تخصيص الصفحات وDPI.
// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تحديد الصفحات
options.PageList = [1, 3];
// تحديد دقة الصورة الناتجة
options.OutputResolution = 400;
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى TIFF كصفحات متعددة.
// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تمكين الإخراج بتنسيق TIFF متعدد الصفحات
options.MultiPage = true;
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى TIFF مع تخصيص الضغط وعمق اللون.
// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار الدليل الناتج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تحديد الضغط وعمق اللون
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// تنفيذ العملية
PdfConverter.Convert(options);
يظهر المثال كيفية تحويل مستند PDF إلى TIFF إلى تيارات.
// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تنفيذ العملية
var results = PdfConverter.Convert(options);
// الحصول على نتائج التيار
foreach (var result in results.ResultCollection)
{
var streamResultPage1 = result.ToStream();
}
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق PDF/A (PDF/A-3b في هذه الحالة):
// إنشاء كائن الفئة لتحديد عملية التحويل
var options = new PdfToPdfAOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_3B
};
// إضافة الملف المصدر
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // استبدل بمسار الملف الفعلي الخاص بك
// إضافة المسار لحفظ الملف المحول
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));
// تنفيذ التحويل
PdfConverter.Convert(options);
يظهر المثال كيفية التحقق من مطابقة مستند PDF مع تنسيق PDF/A (PDF/A-1a في هذه الحالة):
// إنشاء كائن الفئة لتحديد عملية التحقق
var options = new PdfAValidateOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_1A
};
// إضافة ملف أو أكثر للتحقق منها
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // استبدل بمسار الملف الفعلي الخاص بك
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// إضافة مزيد من الملفات حسب الحاجة
// تنفيذ التحقق والحصول على النتائج
var resultContainer = PdfConverter.Validate(options);
// تحقق من خاصية resultContainer.ResultCollection للحصول على نتائج التحقق لكل ملف:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
var result = resultContainer.ResultCollection[i];
var validationResult = (PdfAValidationResult) result.Data;
var isValid = validationResult.IsValid; // نتيجة التحقق للمستند i
}
الوظائف
Convert(PdfToDocOptions)
يحول مستند PDF إلى تنسيقات DOC/DOCX.
public static ResultContainer Convert(PdfToDocOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Convert(PdfToXlsOptions)
يحول مستند PDF إلى تنسيقات XLSX/XLS/CSV/XLSM/ODS.
public static ResultContainer Convert(PdfToXlsOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Convert(PdfToHtmlOptions)
يحول مستند PDF إلى تنسيق HTML.
public static ResultContainer Convert(PdfToHtmlOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Convert(HtmlToPdfOptions)
يحول مستند HTML إلى تنسيق PDF.
public static ResultContainer Convert(HtmlToPdfOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Convert(PdfToJpegOptions)
يحول مستند PDF إلى تنسيق JPEG.
public static ResultContainer Convert(PdfToJpegOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Convert(PdfToPngOptions)
يحول مستند PDF إلى تنسيق PNG.
public static ResultContainer Convert(PdfToPngOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Convert(PdfToTiffOptions)
يحول مستند PDF إلى تنسيق TIFF.
public static ResultContainer Convert(PdfToTiffOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Convert(PdfToPdfAOptions)
يحول مستند PDF إلى تنسيق PDF/A.
public static ResultContainer Convert(PdfToPdfAOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Validate(PdfAValidateOptions)
تحقق من مستند PDF للحصول على التوافق مع تنسيق PDF/A المحدد.
public static ResultContainer Validate(PdfAValidateOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم إعداد الخيارات.
Class PdfConverterOptions
معلومات
يمثل خيارات_plugins محولات PDF.
public abstract class PdfConverterOptions : IPluginOptions
الوراثة
object ←
PdfConverterOptions
المشتقات
التنفيذ
الأعضاء الموروثة
الخصائص
يعيد مجموعة بيانات ملحق PdfConverterOptions.
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
المخرجات
يحصل على مجموعة الأهداف المضافة لنتائج عملية الحفظ.
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف مصدر بيانات جديد إلى مجموعة بيانات ملحق PdfConverter.
public void AddInput(IDataSource dataSource)
المعلمات
AddOutput(IDataSource)
يضيف مصدر بيانات جديد إلى مجموعة بيانات ملحق PdfToXLSXConverterOptions.
public void AddOutput(IDataSource saveDataSource)
المعلمات
saveDataSource IDataSource: مصدر البيانات (ملف أو تدفق) لنتائج عملية الحفظ.
الاستثناءات
NotImplementedException
معلومات
يمثل مكون Documentize.PdfExtractor. يستخدم لاستخراج النصوص والصور وبيانات النماذج من وثائق PDF.
public static class PdfExtractor
الوراثة
object ←
PdfExtractor
الأعضاء الموروثة
الأمثلة
توضح هذه المثال كيفية استخراج محتوى النص من وثيقة PDF.
// إنشاء كائن ExtractTextOptions لتحديد التعليمات
var options = new ExtractTextOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تنفيذ العملية
var results = PdfExtractor.ExtractText(options);
// الحصول على النص المستخرج من كائن ResultContainer
var textExtracted = results.ResultCollection[0].ToString();
توضح هذه المثال كيفية استخراج محتوى النص من وثيقة PDF مع TextFormattingMode.
// إنشاء كائن ExtractTextOptions لتحديد TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تنفيذ العملية
var results = PdfExtractor.ExtractText(options);
// الحصول على النص المستخرج من كائن ResultContainer
var textExtracted = results.ResultCollection[0].ToString();
توضح هذه المثال كيفية استخراج الصور من وثيقة PDF.
// إنشاء كائن ExtractImagesOptions لتحديد التعليمات
var options = new ExtractImagesOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار دليلا الناتج
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// تنفيذ العملية
var results = PdfExtractor.ExtractImages(options);
// الحصول على مسار الصورة الناتجة
var imageExtracted = results.ResultCollection[0].ToFile();
توضح هذه المثال كيفية استخراج الصور من وثيقة PDF إلى التدفقات بدون مجلد.
// إنشاء كائن ExtractImagesOptions لتحديد التعليمات
var options = new ExtractImagesOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// عدم تحديد الإخراج - سيتم كتابة النتائج إلى التدفقات
// تنفيذ العملية
var results = PdfExtractor.ExtractImages(options);
// الحصول على التدفق
var ms = results.ResultCollection[0].ToStream();
// نسخ البيانات إلى ملف للعرض
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
ms.CopyTo(fs);
}
توضح هذه المثال كيفية تصدير قيم النموذج إلى ملف CSV.
// إنشاء كائن ExtractFormDataToDsvOptions لتحديد التعليمات
var options = new ExtractFormDataToDsvOptions(',', true);
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// تنفيذ العملية
PdfExtractor.ExtractFormData(options);
الأساليب
استخراج بيانات النموذج من وثيقة PDF.
public static ResultContainer ExtractFormData(ExtractFormDataToDsvOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
استخراج الصور من وثيقة PDF.
public static ResultContainer ExtractImages(ExtractImagesOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
استخراج النص من وثيقة PDF.
public static ResultContainer ExtractText(ExtractTextOptions options)
المعلمات
العوائد
ResultContainer : كائن يحتوي على نتيجة الاستخراج.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Class PdfManager
معلومات
يمثل مكون Documentize.PdfManager. يُستخدم لدمج، تقسيم، تحسين، تدوير، تغيير حجم، ضغط مستندات PDF وإضافة جدول، وإضافة جدول محتويات لمستندات PDF. يمكن دمج مستندات PDF متعددة في ملف PDF واحد. يمكن تقسيم مستندات PDF إلى صفحات منفصلة. يمكن تحسين، تدوير، تغيير حجم، ضغط مستندات PDF. يمكن تدوير، تغيير حجم صفحات مستند PDF. يمكن إضافة جدول إلى مستند PDF. يمكن إضافة جدول محتويات إلى مستند PDF.
يمثل مكون Documentize.PdfManager. يُستخدم لدمج، تقسيم، تحسين، تدوير، تغيير حجم، ضغط مستندات PDF وإضافة جدول، وإضافة جدول محتويات لمستندات PDF.
يمكن دمج مستندات PDF متعددة في ملف PDF واحد.
يمكن تقسيم مستندات PDF إلى صفحات منفصلة.
يمكن تحسين، تدوير، تغيير حجم، ضغط مستندات PDF.
يمكن تدوير، تغيير حجم صفحات مستند PDF.
يمكن إضافة جدول إلى مستند PDF.
يمكن إضافة جدول محتويات إلى مستند PDF.
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)
إضافة جدول إلى مستند PDF.
public static ResultContainer AddTable(TableOptions options)
Parameters
options TableOptions: كائن خيارات يحتوي على تعليمات للعملية.
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
AddTableOfContents(TocOptions)
إضافة جدول محتويات (TOC) إلى مستند PDF.
public static ResultContainer AddTableOfContents(TocOptions options)
Parameters
options TocOptions: كائن خيارات يحتوي على تعليمات للعملية.
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Compress(CompressOptions)
ضغط مستند PDF. محاولة تقليل حجم المستند.
public static ResultContainer Compress(CompressOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)
إنشاء مستند PDF بواسطة رد ChatGpt.
يُستخدم لإرسال الطلبات إلى ChatGPT مباشرةً أو من خلال إضافة مصادر ملفات PDF وحفظ الرد إلى مصدر الإخراج.
public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)
Parameters
Returns
Task<ResultContainer>
كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException : إذا لم يتم تعيين الخيارات.
Merge(MergeOptions)
دمج مستندات PDF.
public static ResultContainer Merge(MergeOptions options)
Parameters
options MergeOptions: كائن خيارات يحتوي على تعليمات للعملية.
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Optimize(OptimizeOptions)
تحسين مستند PDF.
توزيع المستند بشكل خطي لتحقيق:
- فتح الصفحة الأولى في أسرع وقت ممكن;
- عرض الصفحة التالية أو المتابعة من خلال الرابط إلى الصفحة التالية في أسرع وقت ممكن;
- عرض الصفحة بشكل تدريجي عند وصول البيانات للصفحة عبر قناة بطيئة (عرض البيانات الأكثر فائدة أولاً);
- السماح بالتفاعل مع المستخدم، مثل المتابعة عبر رابط، يتم تنفيذها حتى قبل استلام وعرض الصفحة بالكامل.
public static ResultContainer Optimize(OptimizeOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Resize(ResizeOptions)
تغيير حجم صفحات مستند PDF.
public static ResultContainer Resize(ResizeOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Rotate(RotateOptions)
تدوير صفحات مستند PDF.
public static ResultContainer Rotate(RotateOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Split(SplitOptions)
تقسيم مستند PDF حسب الصفحات.
public static ResultContainer Split(SplitOptions options)
Parameters
options SplitOptions: كائن خيارات يحتوي على تعليمات للعملية.
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Class PdfSecurity
معلومات
تمثل مكون PdfSecurity من Documentize. يُستخدم لتشفير وفك تشفير وتوقيع مستندات PDF.
public static class PdfSecurity
الوراثة
object ←
PdfSecurity
الأعضاء الموروثة
الطرق
Decrypt(DecryptOptions)
فك تشفير مستند PDF.
public static ResultContainer Decrypt(DecryptOptions options)
المعلمات
القيمة المُرجعة
ResultContainer: كائن يحتوي على نتيجة العملية.
الأمثلة
المثال يوضح كيفية فك تشفير مستند PDF.
// إنشاء كائن DecryptOptions لتعيين التعليمات
var options = new DecryptOptions("123456");
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
PdfSecurity.Decrypt(options);
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Encrypt(EncryptOptions)
تشفير مستند PDF.
public static ResultContainer Encrypt(EncryptOptions options)
المعلمات
القيمة المُرجعة
ResultContainer: كائن يحتوي على نتيجة العملية.
الأمثلة
المثال يوضح كيفية تشفير مستند PDF.
// إنشاء كائن EncryptOptions لتعيين التعليمات
var options = new EncryptOptions("123456", "qwerty");
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
PdfSecurity.Encrypt(options);
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Sign(SignOptions)
توقيع مستند PDF بتوقيع رقمي.
public static ResultContainer Sign(SignOptions options)
المعلمات
options SignOptions: كائن خيارات يحتوي على تعليمات للعملية.
القيمة المُرجعة
ResultContainer: كائن يحتوي على نتيجة العملية.
الأمثلة
المثال يوضح كيفية توقيع مستند PDF.
// إنشاء كائن SignOptions لتعيين التعليمات
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"));
// تنفيذ العملية
PdfSecurity.Sign(options);
المثال يوضح كيفية توقيع مستند PDF باستخدام Stream من ملف 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"));
// تنفيذ العملية
PdfSecurity.Sign(options);
المثال يوضح كيفية توقيع مستند PDF بتوقيع غير مرئي.
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"));
// تكوين التوقيع غير المرئي
signOptions.Visible = false;
// تنفيذ العملية
PdfSecurity.Sign(options);
المثال يوضح كيفية توقيع مستند PDF مع خيارات إضافية.
// إنشاء كائن SignOptions لتعيين التعليمات
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"));
// معلمات اختيارية
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// تنفيذ العملية
PdfSecurity.Sign(options);
المثال يوضح كيفية توقيع مستند PDF مع الطابع الزمني.
// إنشاء كائن SignOptions لتعيين التعليمات
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
PdfSecurity.Sign(options);
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Class PdfToDocOptions
معلومات
تمثل خيارات تحويل PDF إلى DOC لمكون Documentize.PdfConverter.
public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
PdfToDocOptions
تنفيذ
الأعضاء الموروثة
- 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()
المنشئات
PdfToDocOptions()
يعتمد مثيلًا جديدًا من كائن Documentize.PdfToDocOptions مع خيارات افتراضية.
الخصائص
Mode
يسمح بالتحكم في كيفية تحويل مستند PDF إلى مستند معالجة نصوص.
public DocConversionMode Mode { get; set; }
قيمة الخاصية
DocConversionMode
ملاحظات
استخدم وضع Documentize.DocConversionMode.TextBox عندما لا يتم تحرير المستند الناتج بشكل كبير لاحقًا. تعتبر مربعات النص سهلة التعديل عندما لا يوجد الكثير للقيام به.
استخدم وضع Documentize.DocConversionMode.Flow عندما يحتاج المستند الناتج لمزيد من التحرير.
الفقرات وخطوط النص في وضع التدفق تسمح بتعديل النص بسهولة، لكن الكائنات التنسيقية غير المدعومة ستبدو أسوأ من وضع Documentize.DocConversionMode.TextBox.
Class PdfToHtmlOptions
معلومات
تمثيل خيارات محول PDF إلى HTML لملحق Documentize.PdfConverter.
public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions
Inheritance
object ←
PluginBaseOptions ←
PdfToHtmlOptions
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
PdfToHtmlOptions(SaveDataType)
Initializes a new instance of the Documentize.PdfToHtmlOptions object for the specified output data type.
public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType = SaveDataType.FileWithExternalResources)
Parameters
Properties
OutputDataType
Gets output data type.
public PdfToHtmlOptions.SaveDataType OutputDataType { get; }
Property Value
PdfToHtmlOptions.SaveDataType
Class PdfToJpegOptions
معلومات
يمثل خيارات تحويل PDF إلى JPEG للملحق Documentize.PdfConverter.
public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
PdfToJpegOptions
ينفذ
الأعضاء الموروثة
- 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()
المنشئات
PdfToJpegOptions()
يبدأ مثيلاً جديدًا من كائن Documentize.PdfToJpegOptions.
public PdfToJpegOptions()
الخصائص
OutputResolution
يحصل أو يحدد قيمة دقة الصور الناتجة.
public int OutputResolution { get; set; }
قيمة الخاصية
int
PageList
يحصل أو يحدد قائمة الصفحات للمعالجة.
public List<int> PageList { get; set; }
قيمة الخاصية
List<int>
Quality
يحصل ويحدد جودة الإخراج.
يحدد مستوى الضغط للصورة.
نطاق القيم المفيدة للجودة هو من 0 إلى 100.
كلما كان الرقم المحدد أقل، كان الضغط أعلى وبالتالي كانت جودة الصورة أقل.
صفر سيتيح لك أقل جودة للصورة و100 الأعلى.
public int Quality { get; set; }
قيمة الخاصية
int
Class PdfToPdfAOptions
معلومات
يمثل الخيارات لتحويل مستندات PDF إلى تنسيق PDF/A باستخدام مكون Documentize.PdfConverter.
public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions
الوراثة
object ←
PdfAOptionsBase ←
PdfToPdfAOptions
التنفيذات
الأعضاء الموروثة
- 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()
المُنشئات
PdfToPdfAOptions()
public PdfToPdfAOptions()
الخصائص
Outputs
يتم الحصول على مجموعة الأهداف المضافة (مصادر بيانات الملفات أو التدفقات) لنتائج عملية الحفظ.
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
AddOutput(IDataSource)
يضيف هدف حفظ جديد للنتائج.
public void AddOutput(IDataSource dataSource)
المعلمات
dataSource IDataSource: الهدف (مصدر بيانات ملف أو تدفق) لحفظ نتائج العملية. :
Class PdfToPngOptions
معلومات
يمثل خيارات محول PDF إلى PNG لملحق Documentize.PdfConverter.
public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions
Inheritance
object ←
PluginBaseOptions ←
PdfToPngOptions
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
PdfToPngOptions()
يعيد تهيئة مثيل جديد لكائن Documentize.PdfToPngOptions.
Properties
OutputResolution
يحصل أو يضبط قيمة الدقة للصور الناتجة.
public int OutputResolution { get; set; }
Property Value
int
PageList
يحصل أو يضبط قائمة الصفحات لعملية التحويل.
public List<int> PageList { get; set; }
Property Value
List<int>
Class PdfToTiffOptions
معلومات
يمثل خيارات تحويل PDF إلى TIFF لإضافة Documentize.PdfConverter.
public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
PdfToTiffOptions
Implements
الأعضاء الموروثة
- 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
PdfToTiffOptions()
يهيئ مثيلًا جديدًا من كائن Documentize.PdfToTiffOptions.
public PdfToTiffOptions()
Properties
ColorDepth
يحصل أو يضبط عمق اللون.
public TiffColorDepth ColorDepth { get; set; }
قيمة الخاصية
TiffColorDepth
ملاحظات
القيمة الافتراضية هي Documentize.TiffColorDepth.Format32bpp.
Compression
يحصل أو يضبط نوع الضغط.
public TiffCompression Compression { get; set; }
قيمة الخاصية
TiffCompression
ملاحظات
القيمة الافتراضية هي Documentize.TiffCompression.LZW.
MultiPage
يحصل أو يضبط علمًا يسمح بحفظ جميع الصفحات في ملف TIFF متعدد الصفحات.
القيمة الافتراضية هي false.
public bool MultiPage { get; set; }
قيمة الخاصية
bool
OutputResolution
يحصل أو يضبط قيمة الدقة للصور الناتجة.
public int OutputResolution { get; set; }
قيمة الخاصية
int
PageList
يحصل أو يضبط قائمة الصفحات للعملية.
public List<int> PageList { get; set; }
قيمة الخاصية
List<int>
Class PdfToXlsOptions
معلومات
تمثل خيارات محول PDF إلى XLS/XLSX لملحق Documentize.PdfConverter.
public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions
الوراثة
object ←
PdfConverterOptions ←
PdfToXlsOptions
يُطبق
الأعضاء الموروثة
- PdfConverterOptions.AddInput(IDataSource),
- PdfConverterOptions.AddOutput(IDataSource),
- PdfConverterOptions.Inputs,
- PdfConverterOptions.Outputs,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
البانيات
PdfToXlsOptions()
يُنشئ مثيل جديد من كائن Documentize.PdfToXlsOptions باستخدام الخيارات الافتراضية.
الخصائص
تنسيق الإخراج.
public PdfToXlsOptions.ExcelFormat Format { get; set; }
قيمة الخاصية
PdfToXlsOptions.ExcelFormat
InsertBlankColumnAtFirst
قم بتعيين القيمة إلى true إذا كنت بحاجة لإضافة عمود فارغ كأول عمود في ورقة العمل.
القيمة الافتراضية هي false؛ مما يعني أنه لن يتم إدراج عمود فارغ.
public bool InsertBlankColumnAtFirst { get; set; }
قيمة الخاصية
bool
MinimizeTheNumberOfWorksheets
قم بتعيين القيمة إلى true إذا كنت بحاجة لتقليل عدد أوراق العمل في دفتر العمل الناتج.
القيمة الافتراضية هي false؛ مما يعني حفظ كل صفحة PDF كورقة عمل منفصلة.
public bool MinimizeTheNumberOfWorksheets { get; set; }
قيمة الخاصية
bool
Class PluginBaseOptions
معلومات
يمثل الخيارات الأساسية للإضافات.
public class PluginBaseOptions : IPluginOptions
الوراثة
object ←
PluginBaseOptions
المشتقات
- AddTimestampOptions,
- ChatGptRequestOptions,
- CompressOptions,
- DecryptOptions,
- EncryptOptions,
- ExtractFormDataToDsvOptions,
- ExtractImagesOptions,
- FormFlattenerOptions,
- HtmlToPdfOptions,
- MergeOptions,
- OptimizeOptions,
- PdfToDocOptions,
- PdfToHtmlOptions,
- PdfToJpegOptions,
- PdfToPngOptions,
- PdfToTiffOptions,
- ResizeOptions,
- RotateOptions,
- SignOptions,
- SplitOptions,
- TableOptions,
- TocOptions
ينفذ
الأعضاء الموروثة
الخصائص
يغلق تدفقات الإدخال بعد اكتمال العملية.
public bool CloseInputStreams { get; set; }
قيمة الخاصية
bool
CloseOutputStreams
يغلق تدفقات الإخراج بعد اكتمال العملية.
public bool CloseOutputStreams { get; set; }
قيمة الخاصية
bool
يُرجع بيانات الإدخال للعملية.
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
Outputs
يُرجع بيانات الإخراج للعملية.
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف بيانات جديدة إلى الإدخالات.
public void AddInput(IDataSource dataSource)
المعلمات
AddOutput(IDataSource)
يضيف بيانات جديدة إلى الإخراج.
public void AddOutput(IDataSource saveDataSource)
المعلمات
saveDataSource IDataSource: البيانات التي سيتم إضافتها. :
Class PngConverter
معلومات
يمثل مكون Documentize.PngConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق PNG.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class PngConverter
الوراثة
object ←
PngConverter
الأعضاء الموروثة
الطرق
Process(PdfToPngOptions)
يحول مستند PDF إلى تنسيق PNG.
public static ResultContainer Process(PdfToPngOptions options)
المعلمات
الإرجاع
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Class Rectangle
الوراثة
object ←
Rectangle
الأعضاء الموروثة
المنشئون
Rectangle(double, double, double, double)
منشئ المستطيل.
public Rectangle(double llx, double lly, double urx, double ury)
المعلمات
llx double: X للزاوية السفلية اليسرى.lly double: Y للزاوية السفلية اليسرى.urx double: X للزاوية العلوية اليمنى.ury double: Y للزاوية العلوية اليمنى.
Class ResizeOptions
معلومات
يمثل خيارات تغيير الحجم لملحق Documentize.PdfManager.
public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
ResizeOptions
تطبيقات
الأعضاء الموروثة
- 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()
البناة
ResizeOptions()
يتم تهيئة مثيل جديد لكائن Documentize.ResizeOptions مع خيارات افتراضية.
الخصائص
PageSize
يحصل أو يحدد حجم الصفحة الجديد.
public PageSize PageSize { get; set; }
قيمة الخاصية
PageSize
Class ResultContainer
معلومات
يمثل حاوية تحتوي على مجموعة النتائج الناتجة عن معالجة الإضافة.
public class ResultContainer
الوراثة
object ←
ResultContainer
الأعضاء الموروثة
الخصائص
ResultCollection
تحصل على مجموعة نتائج العمليات
public List<ioperationresult> ResultCollection { get; }
قيمة الخاصية
List<IOperationResult>
Class RotateOptions
معلومات
يمثل خيارات التدوير لإضافة Documentize.PdfManager.
public sealed class RotateOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
RotateOptions
ينفذ
الأعضاء الموروثة
- 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()
المنشئات
RotateOptions()
يُنشئ مثيلًا جديدًا من كائن Documentize.RotateOptions مع خيارات افتراضية.
الخصائص
Rotation
يحصل أو يعين تدوير الصفحات الجديدة.
public Rotation Rotation { get; set; }
قيمة الخاصية
Rotation
Class Security
معلومات
يمثل مكون Documentize.Security. يستخدم لتشفير وفك تشفير مستندات PDF.
[Obsolete("The class will be deleted soon. Please use PdfSecurity class.")]
public static class Security
Inheritance
object ←
Security
Inherited Members
Methods
Process(EncryptOptions)
تشفير مستند PDF.
public static ResultContainer Process(EncryptOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Process(DecryptOptions)
فك تشفير مستند PDF.
public static ResultContainer Process(DecryptOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Class SignOptions
معلومات
يمثل خيارات التوقيع لإضافة Documentize.PdfSecurity.
public sealed class SignOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
SignOptions
التنفيذ
الأعضاء الموروثة
- 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()
المُنشئات
SignOptions(string, string)
يتم تهيئة مثيل جديد من كائن Documentize.SignOptions مع الخيارات الافتراضية.
public SignOptions(string pfx, string password)
المعلمات
pfx string: مسار ملف pfx.password string: كلمة المرور لملف pfx.
SignOptions(Stream, string)
يتم تهيئة مثيل جديد من كائن Documentize.SignOptions مع الخيارات الافتراضية.
public SignOptions(Stream pfx, string password)
المعلمات
pfx Stream: التدفق الذي يحتوي على ملف pfx.password string: كلمة المرور لملف pfx.
الخصائص
جهة الاتصال للتوقيع.
public string Contact { get; set; }
قيمة الخاصية
string
Location
موقع التوقيع.
public string Location { get; set; }
قيمة الخاصية
string
Name
اسم حقل التوقيع الموجود.
Null لإنشاء حقل جديد.
public string Name { get; set; }
قيمة الخاصية
string
PageNumber
رقم الصفحة التي تم فيها التوقيع.
public int PageNumber { get; set; }
قيمة الخاصية
int
Reason
سبب التوقيع.
public string Reason { get; set; }
قيمة الخاصية
string
Rectangle
مستطيل التوقيع.
public Rectangle Rectangle { get; set; }
قيمة الخاصية
Rectangle
TimestampOptions
خيارات الطابع الزمني.
public TimestampOptions TimestampOptions { get; set; }
قيمة الخاصية
TimestampOptions
Visible
رؤية التوقيع.
public bool Visible { get; set; }
قيمة الخاصية
bool
Class SplitOptions
معلومات
يمثل خيارات التجزئة لملحق Documentize.PdfManager.
public sealed class SplitOptions : PluginBaseOptions, IPluginOptions
Inheritance
object ←
PluginBaseOptions ←
SplitOptions
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
SplitOptions()
يُهيئ مثيلًا جديدًا من كائن Documentize.SplitOptions مع الخيارات الافتراضية.
Class Splitter
معلومات
يمثل مكون Documentize.Splitter. يستخدم لتقسيم مستندات PDF إلى صفحات منفصلة.
[Obsolete("سيتم حذف الفصل قريبًا. يرجى استخدام فصل PdfManager.")]
public static class Splitter
الوراثة
object ←
Splitter
الأعضاء الموروثة
الطرق
Process(SplitOptions)
قسّم مستند PDF حسب الصفحات.
public static ResultContainer Process(SplitOptions options)
المعلمات
options SplitOptions: كائن خيارات يحتوي على تعليمات للعملية.
الإرجاع
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Class StreamDataSource
معلومات
تمثل مصدر بيانات البث لعمليات التحميل والحفظ للملحق.
public sealed class StreamDataSource : IDataSource
الوراثة
object ←
StreamDataSource
ينفذ
الأعضاء الموروثة
المنشئات
StreamDataSource(Stream)
يُهيئ مصدر بيانات بث جديد باستخدام كائن البث المحدد.
public StreamDataSource(Stream data)
المعلمات
الخصائص
Data
يحصل على كائن البث لمصدر البيانات الحالي.
public Stream Data { get; }
قيمة الخاصية
Stream
DataType
نوع مصدر البيانات (بث).
public DataType DataType { get; }
قيمة الخاصية
DataType
Class StreamResult
معلومات
تمثل نتيجة العملية في شكل تدفق.
public sealed class StreamResult : IOperationResult
الوراثة
object ←
StreamResult
تنفيذ
الأعضاء الموروثة
الخصائص
البيانات
يحصل على البيانات الخام.
public object Data { get; }
قيمة الخاصية
object
IsFile
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsStream
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
تشير إلى ما إذا كانت النتيجة سلسلة نصية.
public bool IsString { get; }
قيمة الخاصية
bool
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
يرجع
string : سلسلة تمثل المسار إلى ملف الإخراج إذا كانت النتيجة ملفًا؛ وإلا null.
ToStream()
يحاول تحويل النتيجة إلى كائن تدفق.
يرجع
Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة تدفقًا؛ وإلا null.
Class StringResult
معلومات
يمثل نتيجة العملية على شكل سلسلة.
public sealed class StringResult : IOperationResult
الوراثة
object ←
StringResult
ينفذ
الأعضاء الموروثة
الخصائص
البيانات
يسترجع البيانات الخام.
public object Data { get; }
قيمة الخاصية
object
IsFile
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsStream
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
تشير إلى ما إذا كانت النتيجة سلسلة.
public bool IsString { get; }
قيمة الخاصية
bool
النص
تسترجع التمثيل النصي للنتيجة.
public string Text { get; }
قيمة الخاصية
string
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
المرتجع
string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ خلاف ذلك null.
ToStream()
يحاول تحويل النتيجة إلى كائن تيار.
المرتجع
Stream : كائن تيار يمثل بيانات الإخراج إذا كانت النتيجة تيارًا؛ خلاف ذلك null.
ToString()
يحاول تحويل النتيجة إلى سلسلة.
public override string ToString()
المرتجع
string : سلسلة تمثل محتوى النص إذا كانت النتيجة سلسلة؛ خلاف ذلك تعيد base.ToString().
Class TableBuilder
معلومات
Class يمثل الباني للجداول في صفحة pdf.
public class TableBuilder
الوراثة
object ←
TableBuilder
المشتقات
الأعضاء الموروثة
الطرق
AddRow()
إضافة صف جديد إلى الجدول.
public virtual TableRowBuilder AddRow()
الإرجاع
TableRowBuilder : مثيل من Documentize.TableRowBuilder الحالي.
AddTable()
إضافة جدول جديد إلى الوثيقة.
public TableBuilder AddTable()
الإرجاع
TableBuilder : مثيل من Documentize.TableBuilder الحالي.
InsertPageAfter(int)
إدراج صفحة بعد الصفحة المحددة.
public TableOptions InsertPageAfter(int page)
المعلمات
page int: رقم الصفحة لإدراج الجدول بعدها.
الإرجاع
TableOptions : مثيل من Documentize.TableOptions الحالي.
InsertPageBefore(int)
إدراج صفحة قبل الصفحة المحددة.
public TableOptions InsertPageBefore(int page)
المعلمات
page int: رقم الصفحة لإدراج الجدول بعدها.
الإرجاع
TableOptions : مثيل من Documentize.TableOptions الحالي.
المشغلون
implicit operator TableOptions(TableBuilder)
تحويل الباني Documentize.TableBuilder إلى الخيارات Documentize.TableOptions
public static implicit operator TableOptions(TableBuilder builder)
المعلمات
builder TableBuilder: مثيل من Documentize.TableBuilder الحالي.
الإرجاع
TableOptions : نتيجة التحويل إلى PdfGeneratorTableOptions.
Class TableCellBuilder
معلومات
الصف يمثل المولد لخلية الجدول.
public class TableCellBuilder : TableRowBuilder
الوراثة
object ←
TableBuilder ←
TableRowBuilder ←
TableCellBuilder
الأعضاء الموروثة
- 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()
الطرق
AddCell()
إضافة خلية إلى الجدول.
public override TableCellBuilder AddCell()
الإرجاع
TableCellBuilder : مثيل من Documentize.TableCellBuilder الحالي.
AddParagraph(params string[])
إضافة فقرات إلى خلية الجدول.
public TableCellBuilder AddParagraph(params string[] paragraphs)
المعاملات
paragraphs string[]: نص للفقرات.
الإرجاع
TableCellBuilder : مثيل من Documentize.TableCellBuilder الحالي.
Class TableGenerator
معلومات
يمثل مكون Documentize.TableGenerator. يستخدم لإضافة جدول إلى مستند PDF.
[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class TableGenerator
الوراثة
object ←
TableGenerator
الأعضاء الموروثة
أمثلة
المثال يوضح كيفية إضافة جدول إلى ملف PDF.
// Configure table options
var options = new TableOptions().InsertPageBefore(1)
.AddTable()
.AddRow()
.AddCell().AddParagraph("Name")
.AddCell().AddParagraph("Age")
.AddRow()
.AddCell().AddParagraph("Bob")
.AddCell().AddParagraph("12")
.AddRow()
.AddCell().AddParagraph("Sam")
.AddCell().AddParagraph("20")
.AddRow()
.AddCell().AddParagraph("Sandy")
.AddCell().AddParagraph("26")
.AddRow()
.AddCell().AddParagraph("Tom")
.AddCell().AddParagraph("12")
.AddRow()
.AddCell().AddParagraph("Jim")
.AddCell().AddParagraph("27");
// 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
TableGenerator.Process(options);
الطرق
Process(TableOptions)
إضافة جدول إلى مستند PDF.
public static ResultContainer Process(TableOptions options)
المعاملات
options TableOptions: كائن خيارات يحتوي على تعليمات للعملية.
النتائج
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين خيارات.
Class TableOptions
معلومات
يمثل خيارات إضافة جدول إلى المستند بواسطة ملحق Documentize.PdfManager.
public sealed class TableOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
TableOptions
ينفذ
الأعضاء الموروثة
- 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()
المُنشئون
TableOptions()
يُهيئ مثيلًا جديدًا من كائن Documentize.TableOptions مع خيارات افتراضية.
الأساليب
AddTable()
إضافة جدول إلى المستند.
public TableBuilder AddTable()
العائدات
TableBuilder : مثيل جديد من Documentize.TableBuilder.
Create()
إنشاء مثيل من Documentize.TableOptions.
public static TableOptions Create()
العائدات
TableOptions : مثيل جديد من Documentize.TableOptions.
InsertPageAfter(int)
إدراج صفحة بعد الصفحة المحددة.
public TableOptions InsertPageAfter(int page)
المعلمات
page int: رقم الصفحة لإدراج الجدول بعدها.
العائدات
TableOptions : مثيل من Documentize.TableOptions الحالي.
InsertPageBefore(int)
إدراج صفحة قبل الصفحة المحددة.
public TableOptions InsertPageBefore(int page)
المعلمات
page int: رقم الصفحة لإدراج الجدول بعدها.
العائدات
TableOptions : مثيل من Documentize.TableOptions الحالي.
Class TableRowBuilder
معلومات
الفئة تمثل مُنشئًا لصف الجدول.
public class TableRowBuilder : TableBuilder
الوراثة
object ←
TableBuilder ←
TableRowBuilder
مشتق
الأعضاء الموروثة
- 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()
الطرق
AddCell()
إضافة خلية إلى صف الجدول.
public virtual TableCellBuilder AddCell()
العائدات
TableCellBuilder : مثيل من Documentize.TableCellBuilder الذي تم إنشاؤه.
AddRow()
تجاوز AddRow.
public override TableRowBuilder AddRow()
العائدات
TableRowBuilder : مثيل من Documentize.TableRowBuilder الحالي.
معلومات
يمثل مكون Documentize.TextExtractor. يستخدم لاستخراج النص من مستندات PDF.
[Obsolete("The class will be deleted soon. Please use PdfExtractor class.")]
public static class TextExtractor
الوراثة
object ←
TextExtractor
الأعضاء الموروثة
الطرق
استخراج النص من مستند PDF.
public static ResultContainer Process(ExtractTextOptions options)
المعلمات
الإرجاع
ResultContainer : كائن يحتوي على نتيجة الاستخراج.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
معلومات
يمثل خيارات استخراج النص لملحق Documentize.TextExtractor.
public sealed class TextExtractorOptions
الوراثة
object ←
TextExtractorOptions
الأعضاء الموروثة
البانيين
يقوم بتهيئة مثيل جديد من كائن Documentize.TextExtractorOptions لوضع تنسيق النص المحدد.
public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)
المعلمات
الخصائص
يحصل على وضع التنسيق.
public TextFormattingMode FormattingMode { get; set; }
قيمة الخاصية
TextFormattingMode
يعيد بيانات المدخلات للعملية.
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف بيانات جديدة إلى المدخلات.
public void AddInput(IDataSource dataSource)
المعلمات
Class TiffConverter
معلومات
يمثل مكون Documentize.TiffConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق TIFF.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class TiffConverter
Inheritance
object ←
TiffConverter
Inherited Members
Methods
Process(PdfToTiffOptions)
يحول مستند PDF إلى تنسيق TIFF.
public static ResultContainer Process(PdfToTiffOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Class Timestamp
معلومات
يمثل مكون Documentize.Timestamp. يُستخدم لإضافة الطابع الزمني إلى وثيقة.
[Obsolete("The class will be deleted soon. Please use PdfSecurity class.")]
public static class Timestamp
Inheritance
object ←
Timestamp
Inherited Members
Methods
Process(AddTimestampOptions)
يبدأ معالجة Documentize.Timestamp بالمعلمات المحددة.
public static ResultContainer Process(AddTimestampOptions options)
Parameters
Returns
ResultContainer : كائن يحتوي على نتيجة العملية.
Exceptions
ArgumentException
إذا لم يتم تعيين الخيارات.
Class TimestampOptions
public class TimestampOptions
الوراثة
object ←
TimestampOptions
الأعضاء الموروثين
المنشئات
TimestampOptions(string, string)
يبدأ مثيلًا جديدًا من فئة Documentize.TimestampOptions.
public TimestampOptions(string serverUrl, string basicAuthCredentials = "")
المعلمات
serverUrl string: عنوان url لخادم الطابع الزمني.basicAuthCredentials string: بيانات اعتماد المصادقة الأساسية، حيث يتم دمج اسم المستخدم وكلمة المرور في سلسلة “username:password”.
الخصائص
BasicAuthCredentials
يحصل/يحدد بيانات اعتماد المصادقة الأساسية، حيث يتم دمج اسم المستخدم وكلمة المرور في سلسلة “username:password”.
public string BasicAuthCredentials { get; set; }
قيمة الخاصية
string
ServerUrl
يحصل/يحدد عنوان url لخادم الطابع الزمني.
public string ServerUrl { get; set; }
قيمة الخاصية
string
Class TocGenerator
معلومات
يمثل مكون Documentize.TocGenerator. يُستخدم لإضافة جدول محتويات إلى مستندات PDF.
[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class TocGenerator
التوريث
object ←
TocGenerator
الأعضاء الموروثة
أمثلة
يظهر المثال كيفية إضافة جدول محتويات إلى ملف PDF.
// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);
يظهر المثال كيفية إضافة جدول محتويات إلى ملف PDF مع توليد الإشارات المرجعية.
// 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
TocGenerator.Process(options);
يظهر المثال كيفية إضافة جدول محتويات إلى ملف PDF والحفظ كدفق.
// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, 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
TocGenerator.Process(options);
الطرق
Process(TocOptions)
يبدأ معالجة Documentize.TocGenerator بالمعلمات المحددة.
public static ResultContainer Process(TocOptions options)
المعلمات
options TocOptions: كائن خيارات يحتوي على تعليمات العملية.
النتيجة
ResultContainer : كائن Documentize.ResultContainer يحتوي على نتيجة العملية.
Class TocHeading
معلومات
يمثل الخيارات للعناوين أو الأسماء في جدول المحتويات لتوثيقها بواسطة ملحق Documentize.PdfManager.
الوراثة
object ←
TocHeading
الأعضاء الموروثة
المُنشئات
TocHeading(string, int, bool, int)
يُهيئ مثيلًا جديدًا من Documentize.TocHeading.
public TocHeading(string text = "", int pageNumber = 1, bool generateNumbering = false, int level = 1)
المعلمات
text string: نص العنوان.pageNumber int: رقم الصفحة للرابط.generateNumbering bool: استخدام توليد الأرقام.level int: المستوى.
الخصائص
GenerateNumbering
استخدام توليد الأرقام.
إذا كانت true، فيجب إجراء الترقيم تلقائيًا؛ خلاف ذلك، يجب إجراء الترقيم يدويًا.
public bool GenerateNumbering { get; set; }
قيمة الخاصية
bool
Level
المستوى.
يستخدم لتوليد الأرقام.
public int Level { get; set; }
قيمة الخاصية
int
PageNumber
رقم الصفحة للرابط.
public int PageNumber { get; set; }
قيمة الخاصية
int
Text
نص العنوان.
public string Text { get; set; }
قيمة الخاصية
string
Class TocOptions
معلومات
يمثل الخيارات لإضافة جدول محتويات إلى المستند عن طريق مكون Documentize.PdfManager.
public sealed class TocOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
TocOptions
ينفذ
الأعضاء الموروثة
- 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()
المُنشئات
TocOptions()
يهيئ مثيلًا جديدًا من كائن Documentize.TocOptions مع خيارات افتراضية.
الخصائص
GenerateBookmarks
استخدام إنشاء العلامات.
إذا تم تعيين true فسيتم مسح العلامات وإنشاؤها بواسطة العناوين؛ وإلا، فلن تتغير العلامات.
public bool GenerateBookmarks { get; set; }
قيمة الخاصية
bool
Headings
العناوين أو العناوين الرئيسية لجدول المحتويات.
public List<tocheading> Headings { get; set; }
قيمة الخاصية
List<TocHeading>
Title
عنوان جدول المحتويات.
public string Title { get; set; }
قيمة الخاصية
string
Class XlsConverter
معلومات
يمثل مكون Documentize.XlsConverter. يُستخدم لتحويل مستندات PDF إلى تنسيقات XLSX/XLS/CSV/XLSM/ODS.
[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class XlsConverter
الوراثة
object ←
XlsConverter
الأعضاء الموروثة
الطرق
Process(PdfToXlsOptions)
يحول مستند PDF إلى تنسيقات XLSX/XLS/CSV/XLSM/ODS.
public static ResultContainer Process(PdfToXlsOptions options)
المعلمات
العودة
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
Enum ConvertErrorAction
معلومات
هذه الفئة تمثل الإجراء للأخطاء في التحويل.
public enum ConvertErrorAction
Fields
Enum ConvertSoftMaskAction
معلومات
تمثل هذه العملية إجراءات لتحويل الصور باستخدام قناع ناعم.
public enum ConvertSoftMaskAction
Fields
ConvertToStencilMask = 1: سيتم تحويل القناع الناعم إلى قناع استنسل.Default = 0: استخدم الاستراتيجية الافتراضية.
Enum DataType
معلومات
يمثل الأنواع الممكنة للبيانات لمعالجة المكونات الإضافية.
Fields
Directory = 2: نوع البيانات هو دليل يُمثل بواسطة المسار إليه.File = 0: نوع البيانات هو ملف يُمثل بواسطة المسار إليه.Stream = 1: نوع البيانات هو دفق.
Enum DocConversionMode
معلومات
تحديد وضع تحويل الوثيقة الناتجة.
public enum DocConversionMode
الفئات
Flow = 1: وضع التعرف الكامل، حيث يقوم المحرك بأداء التجميع والتحليل متعدد المستويات لاستعادة نية مؤلف الوثيقة الأصلية وإنتاج وثيقة قابلة للتحرير بشكل كامل. السلبيات هي أن الوثيقة الناتجة قد تبدو مختلفة عن ملف PDF الأصلي.TextBox = 0: هذا الوضع سريع وجيد للحفاظ على الشكل الأصلي لملف PDF، ولكن قابلية تحرير الوثيقة الناتجة قد تكون محدودة. كل كتلة نصية مرئية مجمعة في ملف PDF الأصلي يتم تحويلها إلى مربع نص في الوثيقة الناتجة. هذا يحقق تشابهاً أقصى بين الوثيقة الناتجة وملف PDF الأصلي. ستبدو الوثيقة الناتجة جيدة، لكنها ستتكون بالكامل من صناديق نصية وقد يجعل ذلك تحرير الوثيقة في Microsoft Word صعباً للغاية. هذا هو الوضع الافتراضي.
معلومات
يحدد أنواع الوسائط الممكنة المستخدمة أثناء التقديم.
public enum HtmlMediaType
Fields
Print = 0: طباعة.Screen = 1: شاشة.
Enum HtmlPageLayoutOption
معلومات
تحدد الأعلام التي معًا تحدد خيارات أخرى أحجام وتنسيقات الصفحات.
public enum HtmlPageLayoutOption
Fields
FitToWidestContentWidth = 3: تشير إلى أن عرض الصفحة يتم تحديده من حجم المحتوى نفسه، وليس من عرض الصفحة المحدد.None = 0: القيمة الافتراضية التي تشير إلى أن HtmlPageLayoutOption لن تؤثر على أحجام وتنسيقات الصفحات.ScaleToPageWidth = 256: تشير إلى أن محتوى الوثيقة سيتم تغيير مقاسه ليناسب الصفحة.
Enum PdfAStandardVersion
معلومات
يحدد إصدار معيار PDF/A لوثيقة PDF.
public enum PdfAStandardVersion
Fields
Auto = 0: يتم تحديد إصدار معيار PDF/A تلقائيًا.PDF_A_1A = 1: يحدد إصدار معيار PDF/A-1a.PDF_A_1B = 2: يحدد إصدار معيار PDF/A-1b.PDF_A_2A = 3: يحدد إصدار معيار PDF/A-2a.PDF_A_2B = 4: يحدد إصدار معيار PDF/A-2b.PDF_A_2U = 5: يحدد إصدار معيار PDF/A-2u.PDF_A_3A = 6: يحدد إصدار معيار PDF/A-3a.PDF_A_3B = 7: يحدد إصدار معيار PDF/A-3b.PDF_A_3U = 8: يحدد إصدار معيار PDF/A-3u.
Enum PdfToHtmlOptions.SaveDataType
public enum PdfToHtmlOptions.SaveDataType
Fields
FileWithEmbeddedResources = 1: حفظ HTML في ملف مع موارد متضمّنةFileWithExternalResources = 0: حفظ HTML في ملف مع موارد خارجيةStreamWithEmbeddedResources = 2: حفظ HTML في دفق الملف مع موارد متضمّنة
معلومات
يسمح بتحديد تنسيق ملف xls/xlsx/xml/csv. القيمة الافتراضية هي XLSX.
يسمح بتحديد تنسيق ملف xls/xlsx/xml/csv.
القيمة الافتراضية هي XLSX.
public enum PdfToXlsOptions.ExcelFormat
Fields
CSV = 2: تنسيق ملف القيم مفصولة بفواصل (.csv).ODS = 4: جدول بيانات المستند المفتوح.XLSM = 3: تنسيق ملف Office Open XML (.xlsm) المدعوم بالماكرو.XLSX = 1: تنسيق ملف Office Open XML (.xlsx).XMLSpreadSheet2003 = 0: تنسيق ملف Excel 2003 XML (.xls).
Enum Role
Fields
Assistant = 2System = 1User = 0
Enum Rotation
معلومات
تعداد القيم الممكنة للدوران.
Fields
None = 0: غير مدور.On180 = 2: مدور بزاوية 180 درجة.On270 = 3: مدور بزاوية 270 درجة في اتجاه عقارب الساعة.On360 = 4: مدور بزاوية 360 درجة في اتجاه عقارب الساعة.On90 = 1: مدور بزاوية 90 درجة في اتجاه عقارب الساعة.
معلومات
يحدد أوضاعًا مختلفة يمكن استخدامها عند تحويل مستند PDF إلى نص. راجع فئة Documentize.TextExtractorOptions.
public enum TextExtractorOptions.TextFormattingMode
Fields
Plain = 2: يمثل محتوى نص PDF مع الأخذ في الاعتبار موضع النص النسبي ولكن دون إضافة مسافات إضافية.Pure = 0: يمثل محتوى نص PDF مع بعض روتينات التنسيق. وهذا يشمل الأخذ في الاعتبار المواقع النسبية وإضافة مسافات إضافية لمحاذاة النص مع عرض الصفحة.Raw = 1: يمثل محتوى PDF كما هو، أي بدون تنسيق.
Enum TextFormattingMode
معلومات
يحدد أوضاع مختلفة يمكن استخدامها أثناء تحويل مستند PDF إلى نص. انظر إلى فئة Documentize.ExtractTextOptions.
public enum TextFormattingMode
Fields
Flatten = 2: يمثل محتوى PDF مع تحديد مواقع أجزاء النص حسب إحداثياتها. إنه مشابه أساسًا لوضع “Raw”. لكن بينما يركز “Raw” على الحفاظ على هيكل أجزاء النص (المشغلين) في مستند، يركز “Flatten” على الحفاظ على النص بالترتيب الذي يتم قراءته.Pure = 0: يمثل محتوى نص PDF مع بعض روتينات التنسيق. وهذا يشمل الأخذ في الاعتبار المواقع النسبية وإضافة مسافات إضافية لمحاذاة النص بعرض الصفحة.Raw = 1: يمثل محتوى PDF كما هو، أي بدون تنسيق.
Enum TiffColorDepth
معلومات
يستخدم لتحديد عمق اللون لخيارات Documentize.PdfToTiff.
public enum TiffColorDepth
الحقول
Format1bpp = 4: 1 بت لكل بكسل.Format24bpp = 1: 24 بت لكل بكسل. Rgb.Format32bpp = 0: 32 بت لكل بكسل. يستخدم بشكل افتراضي.Format4bpp = 3: 4 بت لكل بكسل.Format8bpp = 2: 8 بت لكل بكسل.
Enum TiffCompression
معلومات
يستخدم لتحديد نوع الضغط لخيار Documentize.PdfToTiffOptions.
public enum TiffCompression
الحقول
CCITT3 = 2: يحدد مخطط ضغط CCITT3. يمكن تمريره إلى مشفر CCITT3 كمعامل ينتمي إلى فئة الضغط.CCITT4 = 1: يحدد مخطط ضغط CCITT4. يمكن تمريره إلى مشفر CCITT4 كمعامل ينتمي إلى فئة الضغط.LZW = 0: يحدد مخطط ضغط LZW. يمكن تمريره إلى مشفر Tiff كمعامل ينتمي إلى فئة الضغط.None = 4: يحدد عدم وجود ضغط. يمكن تمريره إلى مشفر Tiff كمعامل ينتمي إلى فئة الضغط.RLE = 3: يحدد مخطط ضغط RLE. يمكن تمريره إلى مشفر RLE كمعامل ينتمي إلى فئة الضغط.
Interface IDataSource
معلومات
واجهة بيانات عامة تحدد الأعضاء المشتركين التي ينبغي أن تنفذها البيانات الملموسة.
public interface IDataSource
الخصائص
DataType
نوع مصدر البيانات.
DataType DataType { get; }
قيمة الخاصية
DataType
Interface IOperationResult
معلومات
واجهة نتيجة العملية العامة التي تحدد الطرق المشتركة التي يجب على نتائج عملية المكون المحدد تنفيذها.
public interface IOperationResult
الخصائص
البيانات
يحصل على البيانات الخام.
قيمة الخاصية
object
IsFile
يشير إلى ما إذا كانت النتيجة هي مسار إلى ملف الإخراج.
قيمة الخاصية
bool
IsStream
يشير إلى ما إذا كانت النتيجة هي دفق إخراج.
قيمة الخاصية
bool
IsString
يشير إلى ما إذا كانت النتيجة هي سلسلة نصية.
قيمة الخاصية
bool
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
الإرجاع
string : سلسلة تمثل المسار إلى ملف الإخراج إذا كانت النتيجة ملف؛ وإلا null.
ToStream()
يحاول تحويل النتيجة إلى كائن دفق.
الإرجاع
Stream : كائن دفق يمثل بيانات الإخراج إذا كانت النتيجة دفق؛ وإلا null.
Interface IPluginOptions
معلومات
واجهة خيارات الإضافات العامة التي تحدد الطرق الشائعة التي يجب على خيارات الإضافات المحددة تنفيذها.
public interface IPluginOptions
اختيار الفئة
الوراثة
object ←
Choice
الأعضاء الموروثة
المُنشئات
Choice()
الخصائص
FinishReason
السبب الذي جعل النموذج يتوقف عن توليد الرموز.
سيتوقف هذا إذا وصل النموذج إلى نقطة توقف طبيعية أو
تسلسل توقف محدد، أو إذا تم الوصول إلى الحد الأقصى لعدد
الرموز المحددة في الطلب.
[JsonProperty("finish_reason")]
public string FinishReason { get; set; }
قيمة الخاصية
string
Index
فهرس الخيار في قائمة الخيارات.
[JsonProperty("index")]
public int Index { get; set; }
قيمة الخاصية
int
Message
رسالة إكمال الدردشة تم توليدها بواسطة النموذج.
[JsonProperty("message")]
public Message Message { get; set; }
قيمة الخاصية
Message
استخدام الفئة
معلومات
إحصائيات الاستخدام لطلب الإكمال.
الوراثة
object ←
Usage
الأعضاء الموروثون
المنشئات
Usage()
الخصائص
CompletionTokens
عدد الرموز في الإكمال المُولد.
[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }
قيمة الخاصية
int
PromptTokens
عدد الرموز في الطلب.
[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }
قيمة الخاصية
int
TotalTokens
إجمالي عدد الرموز المستخدمة في الطلب (الطلب + الإكمال).
[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }
قيمة الخاصية
int
صورة الفئة
معلومات
يمثل إضافة Documentize.Signature. تستخدم لتوقيع مستندات PDF.
[Obsolete("سيتم حذف الفئة قريبًا. يُرجى استخدام فئة PdfSecurity.")]
public static class Signature
الوراثة
object ←
Signature
الأعضاء الموروثة
الطرق
Process(SignOptions)
توقيع مستند PDF.
public static ResultContainer Process(SignOptions options)
المعلمات
options SignOptions: كائن خيارات يحتوي على تعليمات العملية.
العائدات
ResultContainer : كائن يحتوي على نتيجة العملية.
الاستثناءات
ArgumentException
إذا لم يتم تعيين الخيارات.
معلومات الفئة
معلومات
توفر الفئة معلومات حول بناء المنتج الحالي.
الوراثة
object ←
Info
الأعضاء الموروثة
الحقول
AssemblyVersion إصدار التجميع.
قيمة الحقل
string
المنتج
اسم المنتج.
public const string Product = "Documentize"
قيمة الحقل
string