Documentize Namespace

Model

النموذج المستخدم لإكمال الدردشة.

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

قيمة الخاصية

Object

نوع الكائن، والذي يكون دائمًا chat.completion.

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

قيمة الخاصية

SystemFingerprint

يمثل هذا البصمة تكوين الخلفية الذي يعمل به النموذج.

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

قيمة الخاصية

Usage

إحصائيات الاستخدام لطلب الإكمال.

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

قيمة الخاصية

Usage

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptConsts

معلومات

تمثل هذه الفئة تخزينًا للثوابت.

public static class ChatGptConsts

الوراثة

object ← ChatGptConsts

الأعضاء الموروثون

الحقول

ApiUrl

قيمة الحقل

ModelName

public static string ModelName

قيمة الحقل

SystemRole

public static string SystemRole

قيمة الحقل

SystemRoleDescription

public static string SystemRoleDescription

قيمة الحقل

UserRole

public static string UserRole

قيمة الحقل

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptRequestOptions

معلومات

يمثل الخيارات لإضافة Documentize.PdfManager.

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

وراثة

object ← PluginBaseOptions ← ChatGptRequestOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المُنشئات

ChatGptRequestOptions()

يُنشئ نسخة جديدة من كائن Documentize.ChatGptRequestOptions بالإعدادات الافتراضية.

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

يُنشئ نسخة جديدة من كائن Documentize.ChatGptRequestOptions مع خيارات محددة.

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

المعاملات

apiKey string: المفتاح للوصول إلى واجهة ChatGPT.
model string: اسم نموذج ChatGPT. النموذج الافتراضي هو: gpt-3.5-turbo-1106.
apiUrl string: عنوان واجهة ChatGPT. العنوان الافتراضي هو: https://api.openai.com/v1/chat/completions.
query string: طلب النص إلى ChatGPT.

الخصائص

ApiKey

يحصل على المفتاح أو يحدده للوصول إلى واجهة ChatGPT.

public string ApiKey { get; set; }

قيمة الخاصية

ApiUrl

يحصل على عنوان واجهة ChatGPT أو يحدده.

public string ApiUrl { get; set; }

قيمة الخاصية

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، مسبوقةً بالرسالة التي محتواها: “You are a helpful assistant."، والدور هو “system”.
ثم تُضاف (إن وجدت) الرسائل من مجموعة options.Messages.
تُضاف أخيراً الرسائل من مصادر الملفات (إن وجدت)، رسالة واحدة لكل مستند بدور “user”. إذا لم يتم توفير أي رسالة، يتم إلقاء استثناء ArgumentException.

Model

يضبط أو يحصل على معرف النموذج المستخدم.

public string Model { get; set; }

قيمة الخاصية

NumberOfChoices

عدد خيارات إكمال الدردشة التي يجب توليدها لكل رسالة إدخال.

public int NumberOfChoices { get; set; }

قيمة الخاصية

Query

يحصل على طلب النص إلى ChatGPT أو يحدده. إذا لم يكن فارغًا، تكون هذه هي الرسالة الأولى في المجموعة التي تُرسل في الطلب.

public string Query { get; set; }

قيمة الخاصية

Temperature

درجة الحرارة التي تُستخدم في أخذ العينات، بين 0 و2. القيم الأعلى مثل 0.8 تجعل المخرجات أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعلها أكثر تركيزًا وتحديدًا. القيمة الافتراضية هي 1.

public double Temperature { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class CompressOptions

معلومات

يمثل خيارات الضغط لمكوّن Documentize.PdfManager.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← CompressOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المُنشئون

CompressOptions()

ينشئ مثالا جديدا من كائن Documentize.CompressOptions مع الخيارات الافتراضية.

public CompressOptions()

Namespace: Documentize Assembly: Documentize.dll

Class DecryptionOptions

معلومات

يمثل خيارات فك التشفير لإضافة Documentize.Security.

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← DecryptionOptions

التنفيذات

IPluginOptions

الأعضاء الموروثة

البانيين

DecryptionOptions(string)

يبدأ مثيلًا جديدًا من كائن Documentize.DecryptionOptions مع خيارات افتراضية.

public DecryptionOptions(string ownerPassword)

المعلمات

ownerPassword string: كلمة مرور المالك.

الخصائص

OwnerPassword

كلمة مرور المالك.

public string OwnerPassword { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class DecryptOptions

معلومات

يمثل خيارات فك التشفير لإضافة Documentize.PdfSecurity.

public class DecryptOptions : PluginBaseOptions, IPluginOptions

وراثة

object ← PluginBaseOptions ← DecryptOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

البُناة

DecryptOptions(string)

يقوم بتهيئة مثيل جديد من كائن Documentize.DecryptOptions مع الخيارات الافتراضية.

public DecryptOptions(string ownerPassword)

المعلمات

ownerPassword string: كلمة مرور المالك.

الخصائص

OwnerPassword

كلمة مرور المالك.

public string OwnerPassword { get; set; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Class DirectoryData

معلومات

يمثل بيانات الدليل لعمليات التحميل والحفظ.

public sealed class DirectoryData : IData

Inheritance

object ← DirectoryData

Implements

IData

Inherited Members

Constructors

DirectoryData(string)

يقوم بتهيئة بيانات دليل جديدة باستخدام المسار المحدد.

public DirectoryData(string path)

Parameters

path string: سلسلة تمثل مسار الدليل.

Properties

DataType

نوع مصدر البيانات.

public DataType DataType { get; }

Property Value

Path

يحصل على المسار إلى دليل البيانات الحالية.

public string Path { get; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class DirectoryDataSource

معلومات

يمثل بيانات الدليل لعمليات التحميل والحفظ لمكون إضافي.

public sealed class DirectoryDataSource : IDataSource

Inheritance

object ← DirectoryDataSource

Implements

IDataSource

Inherited Members

Constructors

DirectoryDataSource(string)

يبدأ بيانات الدليل الجديدة مع المسار المحدد.

public DirectoryDataSource(string path)

Parameters

path string: سلسلة تمثل المسار إلى الدليل.

Properties

DataType

نوع مصدر البيانات.

public DataType DataType { get; }

Property Value

Path

يحصل على المسار إلى دليل البيانات الحالي.

public string Path { get; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

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

options PdfToDocOptions: كائن خيارات يحتوي على تعليمات للعملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class EncryptionOptions

معلومات

يمثل خيارات التشفير لإضافة Documentize.Security.

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ←
PluginBaseOptions ←
EncryptionOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

البناة

EncryptionOptions(string, string)

يهيئ مثيلاً جديدًا من كائن Documentize.EncryptionOptions مع الخيارات الافتراضية.

public EncryptionOptions(string ownerPassword, string userPassword)

المعلمات

ownerPassword string: كلمة مرور المالك.
userPassword string: كلمة مرور المستخدم.

الخصائص

OwnerPassword

كلمة مرور المالك.

public string OwnerPassword { get; set; }

قيمة الخاصية

UserPassword

كلمة مرور المستخدم.

public string UserPassword { get; set; }

قيمة الخاصية

namespace: Documentize
Assembly: Documentize.dll

Class EncryptOptions

معلومات

يمثل خيارات التشفير لملحق Documentize.PdfSecurity.

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← EncryptOptions

Implements

IPluginOptions

Inherited Members

Constructors

EncryptOptions(string, string)

تهيئة مثيل جديد من كائن Documentize.EncryptOptions بخيارات افتراضية.

public EncryptOptions(string ownerPassword, string userPassword)

Parameters

ownerPassword string: كلمة مرور المالك.
userPassword string: كلمة مرور المستخدم.

Properties

OwnerPassword

كلمة مرور المالك.

public string OwnerPassword { get; set; }

Property Value

UserPassword

كلمة مرور المستخدم.

public string UserPassword { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class ExtractFormDataToDsvOptions

معلومات

يمثل الخيارات لتصدير قيم الحقول لمكونات Documentize.PdfForm و Documentize.PdfExtractor.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئ

ExtractFormDataToDsvOptions(char, bool)

يُنشئ نسخة جديدة من كائن Documentize.ExtractFormDataToDsvOptions.

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

الوسائط

delimiter char: يحدد الفاصل الذي يُستَخدم في البيانات المُصدَّرة بين القيم. القيمة الافتراضية هي ‘,’.
addFieldNames bool: إضافة اسم الحقل قبل القيمة. الصيغة: الاسم + الفاصل + القيمة + الفاصل.

الخصائص

AddFieldName

إضافة اسم الحقل قبل القيمة. الصيغة: الاسم + الفاصل + القيمة + الفاصل.

public bool AddFieldName { get; set; }

قيمة الخاصية

Delimiter

الفاصل المُستخدم للقيم المُصدَّرة.

public char Delimiter { get; set; }

قيمة الخاصية

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

معلومات

يمثل خيارات استخراج الصور لمكوّن Documentize.PdfExtractor.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← ExtractImagesOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

ExtractImagesOptions()

ينشئ مثالًا جديدًا من كائن Documentize.ExtractImagesOptions بخيارات افتراضية.

public ExtractImagesOptions()

المجال: Documentize التجميع: Documentize.dll

Class ExtractPropertiesOptions

معلومات

يمثل خيارات استخراج خصائص PDF لمكوّن Documentize.PdfExtractor.

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

الوراثة

object ← OptionsWithInput ← ExtractPropertiesOptions

التنفيذ

IHaveInput

الأعضاء الموروثة

البُنَاؤُ

ExtractPropertiesOptions()

يُنشئ نسخة جديدة من كائن Documentize.ExtractPropertiesOptions باستخدام الخيارات الافتراضية.

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

يُنشئ نسخة جديدة من كائن Documentize.ExtractPropertiesOptions باستخدام بيانات الإدخال المحددة.

public ExtractPropertiesOptions(IData inputData)

المعاملات

inputData IData: بيانات الإدخال.

ExtractPropertiesOptions(string)

يُنشئ نسخة جديدة من كائن Documentize.ExtractPropertiesOptions باستخدام ملف الإدخال المحدد.

public ExtractPropertiesOptions(string inputFile)

المعاملات

inputFile string: مسار ملف الإدخال.

ExtractPropertiesOptions(Stream)

يُنشئ نسخة جديدة من كائن Documentize.ExtractPropertiesOptions باستخدام تدفق الإدخال المحدد.

public ExtractPropertiesOptions(Stream inputStream)

المعاملات

inputStream Stream: تدفق الإدخال.

الخصائص

Input

يحصل على أو يعيّن بيانات الإدخال.

public override IData Input { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class ExtractTextOptions

معلومات

يمثل خيارات استخراج النص لمكوّن Documentize.PdfExtractor.

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Inheritance

object ← OptionsWithInput ← ExtractTextOptions

Implements

IHaveInput

Inherited Members

Constructors

ExtractTextOptions(TextFormattingMode)

ينشئ نسخة جديدة من كائن Documentize.ExtractTextOptions للنوع المحدد من تنسيق النص.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

formattingMode TextFormattingMode: قيمة وضع تنسيق النص.

ExtractTextOptions(IData, TextFormattingMode)

ينشئ نسخة جديدة من كائن Documentize.ExtractTextOptions باستخدام البيانات المحددة.

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

Parameters

data IData: بيانات الإدخال.
formattingMode TextFormattingMode: قيمة وضع تنسيق النص.

ExtractTextOptions(string, TextFormattingMode)

ينشئ نسخة جديدة من كائن Documentize.ExtractTextOptions باستخدام الملف المحدد.

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

Parameters

file string: مسار ملف الإدخال.
formattingMode TextFormattingMode: قيمة وضع تنسيق النص.

ExtractTextOptions(Stream, TextFormattingMode)

ينشئ نسخة جديدة من كائن Documentize.ExtractTextOptions باستخدام التدفق المحدد.

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

Parameters

stream Stream: تدفق الإدخال.
formattingMode TextFormattingMode: قيمة وضع تنسيق النص.

Properties

FormattingMode

الحصول على وضع التنسيق أو تعيينه.

public TextFormattingMode FormattingMode { get; set; }

Property Value

TextFormattingMode

Input

الحصول على بيانات الإدخال أو تعيينها.

public override IData Input { get; set; }

Property Value

المساحة الاسمية: Documentize
التجميع: Documentize.dll

Class FileData

معلومات

يمثل بيانات الملف لعمليات التحميل والحفظ.

public sealed class FileData : IData

Inheritance

object ← FileData

Implements

IData

Inherited Members

المُنشئات

FileData(string)

يُنشئ مصدر بيانات ملف جديد باستخدام المسار المحدد.

public FileData(string path)

المعلمات

path string: سلسلة تمثل المسار إلى ملف المصدر.

الخصائص

DataType

نوع مصدر البيانات.

public DataType DataType { get; }

قيمة الخاصية

Path

يحصل على المسار إلى ملف البيانات الحالي.

public string Path { get; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Class FileDataSource

معلومات

يمثل بيانات الملف لعمليات التحميل والحفظ للإضافة.

public sealed class FileDataSource : IDataSource

الوراثة

object ← FileDataSource

ينفذ

IDataSource

الأعضاء الموروثة

المُنشئات

FileDataSource(string)

يتم تهيئة مصدر البيانات الملف الجديد مع المسار المحدد.

public FileDataSource(string path)

المعلمات

path string: سلسلة تمثل المسار إلى الملف المصدر.

الخصائص

DataType

نوع مصدر البيانات.

public DataType DataType { get; }

قيمة الخاصية

Path

يحصل على المسار إلى ملف البيانات الحالي.

public string Path { get; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class FileResult

معلومات

تمثل نتيجة العملية في شكل مسار نصي إلى ملف.

public sealed class FileResult : IOperationResult

الوراثة

object ← FileResult

تنفذ

IOperationResult

الأعضاء الموروثة

الخصائص

البيانات

الحصول على البيانات الخام.

public object Data { get; }

قيمة الخاصية

IsFile

تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف إخراج.

public bool IsFile { get; }

قيمة الخاصية

IsStream

تشير إلى ما إذا كانت النتيجة تدفق إخراج.

public bool IsStream { get; }

قيمة الخاصية

IsString

تشير إلى ما إذا كانت النتيجة نصًا.

public bool IsString { get; }

قيمة الخاصية

الطرق

ToFile()

يحاول تحويل النتيجة إلى ملف.

public string ToFile()

يعيد

string : سلسلة تمثل مسار إلى ملف الإخراج إذا كانت النتيجة هي ملف؛ وإلا null.

ToStream()

يحاول تحويل النتيجة إلى كائن تدفق.

public Stream ToStream()

يعيد

Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة هي تدفق؛ وإلا null.

اسم المساحة: Documentize المجمع: Documentize.dll

Class FlattenFieldsOptions

معلومات

يمثل الخيارات لتسطيح الحقول في المستند بواسطة Documentize.PdfForm plugin.

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← FlattenFieldsOptions

Implements

IPluginOptions

Inherited Members

Constructors

FlattenFieldsOptions()

يقوم بإنشاء نسخة جديدة من كائن Documentize.FlattenFieldsOptions مع الخيارات الافتراضية.

public FlattenFieldsOptions()

Properties

SkipFields

القائمة التي تحتوي على الحقول التي لن يتم تسطيحها.

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

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Class FormExporter

معلومات

يمثل ملحق Documentize.FormExporter. يُستخدم لتصدير قيم النماذج في مستندات PDF إلى ملف DSV أو CSV.

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

Inheritance

object ← FormExporter

Inherited Members

Methods

Process(ExtractFormDataToDsvOptions)

يبدأ معالجة Documentize.FormExporter بالمعلمات المحددة.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Parameters

options ExtractFormDataToDsvOptions: كائن الخيارات الذي يحتوي على التعليمات الخاصة بالعملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

الفضاء الاسمي: Documentize التجميع: Documentize.dll

Class FormExportToDsvOptions

معلومات

يمثل الخيارات لتصدير قيم الحقول لملحق Documentize.FormExporter.

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← FormExportToDsvOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

FormExportToDsvOptions(char, bool)

يُهيئ مثيل جديد من كائن Documentize.FormExportToDsvOptions.

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

المعلمات

delimeter char: يحدد الفاصل المستخدم في البيانات المصدرة بين القيم. القيمة الافتراضية هي ‘,’.
addFieldNames bool: إضافة اسم الحقل قبل القيمة. التنسيق: الاسم + الفاصل + القيمة + الفاصل.

الخصائص

AddFieldName

إضافة اسم الحقل قبل القيمة. التنسيق: الاسم + الفاصل + القيمة + الفاصل.

public bool AddFieldName { get; set; }

قيمة الخاصية

Delimeter

الفاصل المستخدم للقيم المصدرة.

public char Delimeter { get; set; }

قيمة الخاصية

char

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattener

معلومات

يمثل ملحق Documentize.FormFlattener. يُستخدم لتسطيح الحقول في مستندات PDF.

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

Inheritance

object ← FormFlattener

Inherited Members

Methods

GetFieldNames(string)

احصل على أسماء الحقول في مستند PDF.

public static List<string> GetFieldNames(string path)

Parameters

path string: مسار مستند PDF.

Returns

قائمة بالأسماء في مستند PDF.

GetFieldNames(Stream) : احصل على أسماء الحقول في مستند PDF.

public static List<string> GetFieldNames(Stream stream)

Parameters

stream Stream: الدفق الذي يحتوي على مستند PDF.

Returns

قائمة بالأسماء في مستند PDF.

Process(FlattenFieldsOptions) : تسطيح حقول النموذج في مستند PDF.

public static ResultContainer Process(FlattenFieldsOptions options)

Parameters

options FlattenFieldsOptions: كائن الخيارات الذي يحتوي على التعليمات للعملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

النطاق: Documentize التجميع: Documentize.dll

Class FormFlattenerOptions

معلومات

يمثل الخيارات لتفريغ الحقول في المستند بواسطة ملحق Documentize.FormFlattener.

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← FormFlattenerOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

FormFlattenerOptions()

يتم تهيئة مثيل جديد من كائن Documentize.FormFlattenerOptions مع الخيارات الافتراضية.

public FormFlattenerOptions()

الخصائص

SkipFields

قائمة الحقول التي لن يتم تفريغها.

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

قيمة الخاصية

الفضاء الاسمي: Documentize الملف: Documentize.dll

Class GetFieldNamesOptions

معلومات

يمثل الخيارات للحصول على أسماء الحقول في المستند عبر ملحق Documentize.PdfForm.

public class GetFieldNamesOptions

Inheritance

object ← GetFieldNamesOptions

Inherited Members

Constructors

GetFieldNamesOptions(string)

منشئ للخيارات مع مسار الإدخال إلى الملف.

public GetFieldNamesOptions(string path)

Parameters

path string: مسار الإدخال إلى الملف.

GetFieldNamesOptions(Stream)

منشئ للخيارات مع تدفق الإدخال.

public GetFieldNamesOptions(Stream stream)

Parameters

stream Stream: تدفق الإدخال.

Namespace: Documentize
Assembly: Documentize.dll

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

options PdfToHtmlOptions: كائن خيارات يحتوي على تعليمات للعملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

Process(HtmlToPdfOptions)

تحول مستندات HTML إلى تنسيق PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Parameters

options HtmlToPdfOptions: كائن خيارات يحتوي على تعليمات للعملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

معلومات

يمثل خيارات محول HTML إلى PDF لإضافة Documentize.PdfConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← HtmlToPdfOptions

تطبيقات

IPluginOptions

الأعضاء الموروثة

المنشئ

HtmlToPdfOptions()

يفتح مثالًا جديدًا من كائن Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

الخصائص

BasePath

المسار/العنوان الأساسي لملف HTML.

public string BasePath { get; set; }

قيمة الخاصية

HtmlMediaType

يحصل أو يعيّن أنواع الوسائط الممكنة المستخدمة أثناء العرض.

public HtmlMediaType HtmlMediaType { get; set; }

قيمة الخاصية

HtmlMediaType

IsRenderToSinglePage

يحصل أو يعيّن تحويل كل المستند إلى صفحة واحدة.

public bool IsRenderToSinglePage { get; set; }

قيمة الخاصية

PageInfo

يحصل أو يعيّن معلومات صفحة المستند.

public PageInfo PageInfo { get; set; }

قيمة الخاصية

PageInfo

PageLayoutOption

يحصل أو يعيّن خيار التخطيط.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

قيمة الخاصية

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

معلومات

يمثل مكوّن Documentize.ImageExtractor. يستخدم لاستخراج الصور من مستندات PDF.

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

الوراثة

object ← ImageExtractor

الأعضاء الموروثة

الطرق

Process(ExtractImagesOptions)

استخراج الصور من مستند PDF.

public static ResultContainer Process(ExtractImagesOptions options)

المعاملات

options ExtractImagesOptions: كائن خيارات يحتوي على تعليمات العملية.

القيم المرتجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

النطاق: Documentize التجميع: Documentize.dll

Class ImageExtractorOptions

معلومات

يمثل خيارات استخراج الصور لإضافة Documentize.ImageExtractor.

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← ImageExtractorOptions

التنفيذات

IPluginOptions

الأعضاء الموروثة

المنشآت

ImageExtractorOptions()

يبدأ مثيلًا جديدًا من كائن Documentize.ImageExtractorOptions مع خيارات افتراضية.

public ImageExtractorOptions()

مساحة الاسم: Documentize التجميع: Documentize.dll

Class Info

معلومات

الصف يوفر معلومات حول بناء المنتج الحالي.

public static class Info

الوراثة

object ← Info

الأعضاء الموروثة

الحقول

AssemblyVersion نسخة التجميع.

public const string AssemblyVersion = "26.5.0"

قيمة الحقل

Product

اسم المنتج.

public const string Product = "Documentize"

قيمة الحقل

النطاق: Documentize التجميع: Documentize.dll

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 : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم إعداد الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class License

معلومات

يوفر طريقة لتعيين الترخيص.

public static class License

الوراثة

object ← License

الأعضاء الموروثة

أمثلة

يوضح كيفية تفعيل الترخيص.

// Set License
License.Set("PathToLicense.lic");

الطرق

Set(string)

يرخص المكون.

public static void Set(string licenseName)

المعلمات

licenseName string: يمكن أن يكون اسم ملف كامل أو مختصر. استخدم سلسلة فارغة للتحويل إلى وضع التقييم.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

معلومات

يمثل خيارات الدمج لإضافة Documentize.PdfManager.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← MergeOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

البنائين

MergeOptions()

يفعل مثيلًا جديدًا من كائن Documentize.MergeOptions بالإعدادات الافتراضية.

public MergeOptions()

النطاق: Documentize التجميع: Documentize.dll

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 : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class Message

معلومات

رسالة إكمال دردشة تم إنشاؤها بواسطة النموذج.

public class Message

الوراثة

object ← Message

الأعضاء الموروثون

المنشئات

Message()

public Message()

الخصائص

المحتوى

محتويات الرسالة.

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

قيمة الخاصية

الدور

يحدد أو يحصل على دور مؤلف هذه الرسالة.

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

قيمة الخاصية

Role

Namespace: Documentize Assembly: Documentize.dll

Class ObjectResult

معلومات

يمثل نتيجة العملية في شكل سلسلة.

public sealed class ObjectResult : IOperationResult

الوراثة

object ← ObjectResult

ينفذ

IOperationResult

الأعضاء الموروثة

الخصائص

البيانات

يحصل على البيانات الخام.

public object Data { get; }

قيمة الخاصية

IsFile

تشير إلى ما إذا كانت النتيجة مسارًا لملف إخراج.

public bool IsFile { get; }

قيمة الخاصية

IsObject

تشير إلى ما إذا كانت النتيجة كائنًا.

public bool IsObject { get; }

قيمة الخاصية

IsStream

تشير إلى ما إذا كانت النتيجة مسارًا لملف إخراج.

public bool IsStream { get; }

قيمة الخاصية

IsString

تشير إلى ما إذا كانت النتيجة سلسلة.

public bool IsString { get; }

قيمة الخاصية

النص

يعيد التمثيل النصي للنتيجة.

public string Text { get; }

قيمة الخاصية

الطرق

ToFile()

يحاول تحويل النتيجة إلى ملف.

public string ToFile()

يعود

string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ خلاف ذلك null.

ToStream()

يحاول تحويل النتيجة إلى كائن تدفق.

public Stream ToStream()

يعود

Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة تدفقًا؛ خلاف ذلك null.

ToString()

يحاول تحويل النتيجة إلى سلسلة.

public override string ToString()

يعود

string : سلسلة تمثل محتوى النص إذا كانت النتيجة سلسلة؛ خلاف ذلك ترجع base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class OptimizeOptions

معلومات

يمثل خيارات التحسين لـ Documentize.PdfManager plugin.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ←
PluginBaseOptions ←
OptimizeOptions

Implements

IPluginOptions

Inherited Members

Constructors

OptimizeOptions()

يفترض نسخة جديدة من كائن Documentize.OptimizeOptions مع الخيارات الافتراضية.
يقوم بعملية تحويل المستند إلى شكل خطي بغرض:

فتح الصفحة الأولى بأسرع ما يمكن؛
عرض الصفحة التالية أو الانتقال إلى الرابط المتجه للصفحة التالية بأسرع ما يمكن؛
عرض الصفحة تدريجياً أثناء وصول البيانات عبر قناة بطيئة (عرض أهم البيانات أولاً)؛
السماح بتفاعل المستخدم، مثل اتباع رابط، قبل أن يتم استلام الصفحة بالكامل وعرضها.

public OptimizeOptions()

المجال: Documentize
التجميع: Documentize.dll

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

options OptimizeOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Process(RotateOptions)

يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.

public static ResultContainer Process(RotateOptions options)

Parameters

options RotateOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Process(ResizeOptions)

يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.

public static ResultContainer Process(ResizeOptions options)

Parameters

options ResizeOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Process(CompressOptions)

يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.

public static ResultContainer Process(CompressOptions options)

Parameters

options CompressOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

namespace: Documentize Assembly: Documentize.dll

Class OptionsWithInput

معلومات

يمثل الخيارات الأساسية للعمليات مع بيانات إدخال واحدة.

public abstract class OptionsWithInput : IHaveInput

الوراثة

object ← OptionsWithInput

المشتقة

التنفيذ

IHaveInput

الأعضاء الموروثة

الحقول

input

قيمة الحقل

الخصائص

الإدخال

يحصل أو يحدد بيانات الإدخال.

public virtual IData Input { get; set; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Class OptionsWithInputAndOutput

public abstract class OptionsWithInputAndOutput : OptionsWithInput, IHaveInput

الأعضاء الموروثة

الحقول

output

قيمة الحقل

الخصائص

الإخراج

يحصل أو يحدد بيانات الإخراج.

public virtual IData Output { get; set; }

قيمة الخاصية

المساحة الاسمية: Documentize التجميع: Documentize.dll

Class PageInfo

معلومات

يمثل معلومات الصفحة.

public class PageInfo : PageSize

الوراثة

object ← PageSize ← PageInfo

الأعضاء الموروثون

المنشئات

PageInfo()

منشئ Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

منشئ Documentize.PageInfo.

public PageInfo(double width, double height)

المعلمات

width double: عرض الصفحة.
height double: ارتفاع الصفحة.

الخصائص

MarginBottom

يحصل أو يحدد قيمة تشير إلى الهامش السفلي.

public double MarginBottom { get; set; }

قيمة الخاصية

MarginLeft

يحصل أو يحدد قيمة تشير إلى الهامش الأيسر.

public double MarginLeft { get; set; }

قيمة الخاصية

MarginRight

يحصل أو يحدد قيمة تشير إلى الهامش الأيمن.

public double MarginRight { get; set; }

قيمة الخاصية

MarginTop

يحصل أو يحدد قيمة تشير إلى الهامش العلوي.

public double MarginTop { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class PageSize

معلومات

فئة تمثل حجم الصفحة في مستند PDF.

public class PageSize

Inheritance

object ← PageSize

Derived

PageInfo

Inherited Members

Constructors

PageSize()

Constructor of Documentize.PageSize. A4 sizes by default.

public PageSize()

PageSize(double, double)

Constructor of Documentize.PageSize.

public PageSize(double width, double height)

Parameters

width double: عرض الصفحة.
height double: ارتفاع الصفحة.

Properties

A0

حجم A0 (1189x840 مم).

public static PageSize A0 { get; }

Property Value

A1

حجم A1 (840x594 مم).

public static PageSize A1 { get; }

Property Value

A2

حجم A2 (594x420 مم).

public static PageSize A2 { get; }

Property Value

A3

حجم A3 (420x297 مم).

public static PageSize A3 { get; }

Property Value

A4

حجم A4 (297x210 مم).

public static PageSize A4 { get; }

Property Value

A5

حجم A5 (210x148 مم).

public static PageSize A5 { get; }

Property Value

A6

حجم A6 (148x105 مم).

public static PageSize A6 { get; }

Property Value

B5

حجم B5 (250x176 مم).

public static PageSize B5 { get; }

Property Value

Height

الحصول على أو تعيين ارتفاع الصفحة.

public double Height { get; set; }

Property Value

IsLandscape

الحصول على اتجاه الصفحة. يعيد true إذا كان هذا هو الاتجاه الأفقي وfalse إذا كان هذا هو الاتجاه العمودي.

public bool IsLandscape { get; }

Property Value

P11x17

تنسيق 11x17 بوصة.

public static PageSize P11x17 { get; }

Property Value

PageLedger

حجم دفتر (432x279 مم).

public static PageSize PageLedger { get; }

Property Value

PageLegal

حجم قانوني (356x216 مم).

public static PageSize PageLegal { get; }

Property Value

PageLetter

حجم رسالة (279x216 مم).

public static PageSize PageLetter { get; }

Property Value

Width

الحصول على أو تعيين عرض الصفحة.

public double Width { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

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)

المعلمات

options PdfToPdfAOptions: كائن خيارات يحتوي على تعليمات العملية.

الإرجاع

ResultContainer : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

Process(PdfAValidateOptions)

تحقق من امتثال مستند PDF للتنسيق المحدد PDF/A.

public static ResultContainer Process(PdfAValidateOptions options)

المعلمات

options PdfAValidateOptions: كائن خيارات يحتوي على تعليمات العملية.

الإرجاع

ResultContainer : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConvertOptions

معلومات

يمثل خيارات لتحويل مستندات PDF إلى تنسيق PDF/A باستخدام المكون الإضافي Documentize.PdfAConverter.

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

الوراثة

object ← PdfAOptionsBase ← PdfAConvertOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئين

PdfAConvertOptions()

public PdfAConvertOptions()

الخصائص

Outputs

يحصل على مجموعة من الأهداف المضافة (مصادر بيانات ملف أو تدفق) لنتائج عملية الحفظ.

public List<idatasource> Outputs { get; }

قيمة الخاصية

الأساليب

AddOutput(IDataSource)

يضيف هدف حفظ نتيجة جديدة.

public void AddOutput(IDataSource dataSource)

المعلمات

dataSource IDataSource: الهدف (ملف أو مصدر بيانات تدفق) لحفظ نتائج العملية. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

معلومات

يمثل الفئة الأساسية لخيارات ملحق Documentize.PdfAConverter. توفر هذه الفئة الخصائص والطرق لتكوين عملية تحويل PDF/A وعملية التحقق.

يمثل الفئة الأساسية لخيارات ملحق Documentize.PdfAConverter.
توفر هذه الفئة الخصائص والطرق لتكوين عملية تحويل PDF/A وعملية التحقق.

public abstract class PdfAOptionsBase : IPluginOptions

الوراثة

object ← PdfAOptionsBase

المشتقة

تنفيذ

IPluginOptions

الأعضاء الموروثة

البناؤات

PdfAOptionsBase()

protected PdfAOptionsBase()

الخصائص

AlignText

يحصل أو يعيّن قيمة تشير إلى ما إذا كانت هناك حاجة إلى وسائل إضافية للحفاظ على محاذاة النص أثناء عملية تحويل PDF/A.

public bool AlignText { get; set; }

قيمة الخاصية

ملاحظات

عند تعيينها إلى true، ستحاول عملية التحويل استعادة حدود مقاطع النص الأصلية.
معظم المستندات لا تحتاج إلى تغيير هذه الخاصية من القيمة الافتراضية false، حيث لا تتغيّر محاذاة النص أثناء عملية التحويل الافتراضية.

CheckDifferentNamesInFontDictionaries

يحصل على العلامات التي تتحكم في تحويل PDF/A في الحالات التي لا يتطابق فيها مستند PDF المصدر مع مواصفات PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

قيمة الخاصية

ErrorAction

يحصل أو يعيّن الإجراء الذي سيُتخذ بالنسبة للكائنات التي لا يمكن تحويلها.

public ConvertErrorAction ErrorAction { get; set; }

قيمة الخاصية

ConvertErrorAction

IccProfileFileName

يحصل أو يعيّن اسم ملف ملف تعريف ICC (International Color Consortium) الذي سيُستخدم في تحويل PDF/A بدلاً من الملف الافتراضي.

public string IccProfileFileName { get; set; }

قيمة الخاصية

Inputs

يحصل على مجموعة من البيانات.

public List<idata> Inputs { get; }

قيمة الخاصية

IsLowMemoryMode

يحصل أو يعيّن قيمة تشير إلى ما إذا تم تمكين وضع الذاكرة المنخفضة أثناء عملية تحويل PDF/A.

public bool IsLowMemoryMode { get; set; }

قيمة الخاصية

LogOutputSource

يحصل أو يعيّن مصدر البيانات لإخراج السجل.

public IData LogOutputSource { get; set; }

قيمة الخاصية

OptimizeFileSize

يحصل أو يعيّن قيمة تشير إلى ما إذا يجب محاولة تقليل حجم الملف أثناء عملية تحويل PDF/A.

public bool OptimizeFileSize { get; set; }

قيمة الخاصية

ملاحظات

عند تعيينها إلى 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

الطرق

AddInput(IData)

يضيف بيانات جديدة إلى المجموعة

public void AddInput(IData data)

المعلمات

data IData: بيانات الإدخال. :

المجال: Documentize
التجميع: Documentize.dll

Class PdfAValidateOptions

معلومات

يمثل الخيارات للتحقق من توافق ملفات PDF/A للوثائق PDF باستخدام إضافة Documentize.PdfConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ←
PdfAOptionsBase ←
PdfAValidateOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAValidationResult

معلومات

يمثل نتيجة عملية التحقق من PDF/A.

public sealed class PdfAValidationResult

Inheritance

object ← PdfAValidationResult

Inherited Members

Fields

Data يحصل على مصدر البيانات الذي تم التحقق منه.

Field Value

IsValid

يحصل على قيمة تشير إلى ما إذا كان التحقق ناجحًا.

public readonly bool IsValid

Field Value

ArgumentException : InvalidOperationException

StandardVersion

يحصل على إصدار معيار PDF/A المستخدم في التحقق.

public readonly PdfAStandardVersion StandardVersion

Field Value

PdfAStandardVersion

النطاق: Documentize التجميع: Documentize.dll

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)

المعلمات

options IPluginOptions: كائن خيارات يحتوي على تعليمات لـ PdfChatGpt.

الإرجاع

ResultContainer : #### الاستثناءات

NotImplementedException

ProcessAsync(IPluginOptions)

يبدأ معالجة PdfChatGpt مع المعلمات المحددة.

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

المعلمات

options IPluginOptions: كائن خيارات يحتوي على تعليمات لـ PdfChatGpt.

الإرجاع

Task<ResultContainer>

كائن المهمة الذي يمثل العملية غير المتزامنة.

الاستثناءات

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

معلومات

يمثل الخيارات لـ Documentize.PdfChatGpt plugin.

public class PdfChatGptOptions : IPluginOptions

الوراثة

object ← PdfChatGptOptions

المشتقة

PdfChatGptRequestOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المُنشئون

PdfChatGptOptions()

يحدد مثيلًا جديدًا لكائن Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

الخصائص

المدخلات

public List<idatasource> Inputs { get; }

قيمة الخاصية

المخرجات

public List<idatasource> Outputs { get; }

قيمة الخاصية

الطرق

AddInput(IDataSource)

يضيف مصدر بيانات جديد إلى مجموعة بيانات مكون PdfChatGpt.

public void AddInput(IDataSource dataSource)

المعلمات

dataSource IDataSource: مصدر البيانات (ملف أو تدفق) لإضافته.

AddOutput(IDataSource)

يضيف مصدر بيانات حفظ جديد إلى مجموعة بيانات مكون PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

المعلمات

saveDataSource IDataSource: مصدر البيانات (ملف أو تدفق) لحفظ نتائج العملية. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptRequestOptions

معلومات

يمثل الخيارات لـ Documentize.PdfChatGpt plugin.

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

التوريث

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

PdfChatGptRequestOptions()

يبدأ مثيلًا جديدًا من كائن Documentize.PdfChatGptRequestOptions مع خيارات افتراضية.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

يبدأ مثيلًا جديدًا من كائن Documentize.PdfChatGptRequestOptions مع خيارات.

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

المعلمات

apiKey string: المفتاح للوصول إلى واجهة برمجة تطبيقات ChatGPT.
model string: اسم نموذج ChatGPT. النموذج الافتراضي هو: gpt-3.5-turbo-1106:
apiUrl string: عنوان URL لواجهة برمجة التطبيقات ChatGPT. عنوان URL الافتراضي هو: https://api.openai.com/v1/chat/completions.
query string: نص الطلب إلى ChatGPT.

الخصائص

ApiKey

يحصل أو يحدد المفتاح للوصول إلى واجهة برمجة تطبيقات ChatGPT.

public string ApiKey { get; set; }

قيمة الخاصية

ApiUrl

يحصل أو يحدد عنوان URL لواجهة برمجة تطبيقات ChatGPT.

public string ApiUrl { get; set; }

قيمة الخاصية

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

قيمة الخاصية

NumberOfChoices

كم عدد خيارات استكمال الدردشة التي يجب إنشاؤها لكل رسالة إدخال.

public int NumberOfChoices { get; set; }

قيمة الخاصية

Query

يحصل أو يحدد نص الطلب إلى ChatGPT. إذا لم يكن فارغًا، فهذه هي الرسالة الأولى في المجموعة، التي ستُرسل في الطلب.

public string Query { get; set; }

قيمة الخاصية

Temperature

ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و 2. القيم الأعلى مثل 0.8 ستجعل المخرجات أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعلها أكثر تركيزًا وحتمية. القيمة الافتراضية هي 1.

public double Temperature { get; set; }

قيمة الخاصية

مساحة الأسماء: Documentize التجميع: Documentize.dll

Class PdfConverter

معلومات

يمثل مكوّن 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

الأعضاء الموروثة

الطرق

Convert(PdfToDocOptions)

يقوم بتحويل مستند PDF إلى صيغ DOC/DOCX.

public static ResultContainer Convert(PdfToDocOptions options)

المعلمات

options PdfToDocOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة Doc.

// إنشاء كائن PdfToDocOptions لتحديد التعليمات
var options = new PdfToDocOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_result_file.doc"));
// تنفيذ العملية
PdfConverter.Convert(options);

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة Doc مع ضبط الوضع.

// إنشاء كائن PdfToDocOptions لتحديد التعليمات
var options = new PdfToDocOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_result_file.doc"));
// ضبط الوضع
options.Mode = DocConversionMode.Flow;
// تنفيذ العملية
PdfConverter.Convert(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Convert(PdfToXlsOptions)

يقوم بتحويل مستند PDF إلى صيغ XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Convert(PdfToXlsOptions options)

المعلمات

options PdfToXlsOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل PDF إلى مستند XLSX.

// إنشاء كائن PdfToXlsOptions لتحديد التعليمات
var options = new PdfToXlsOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_result_xlsx_file.xlsx"));
// تنفيذ العملية
PdfConverter.Convert(options);

يُظهر المثال كيفية تحويل PDF إلى مستند XLS.

// إنشاء كائن PdfToXlsOptions لتحديد التعليمات
var options = new PdfToXlsOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد صيغة XLS
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_result_xlsx_file.xls"));
// تنفيذ العملية
PdfConverter.Convert(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Convert(PdfToHtmlOptions)

يقوم بتحويل مستند PDF إلى صيغة HTML.

public static ResultContainer Convert(PdfToHtmlOptions options)

المعلمات

options PdfToHtmlOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل PDF إلى مستند HTML.

// إنشاء كائن PdfToHtmlOptions لتحديد نوع البيانات كملف مع موارد مدمجة
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_input.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_output.html"));
// تنفيذ العملية
PdfConverter.Convert(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Convert(HtmlToPdfOptions)

يقوم بتحويل مستند HTML إلى صيغة PDF.

public static ResultContainer Convert(HtmlToPdfOptions options)

المعلمات

options HtmlToPdfOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل مستند HTML إلى PDF.

// إنشاء HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_input.html"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_output.pdf"));
// تنفيذ العملية
PdfConverter.Convert(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Convert(PdfToJpegOptions)

يقوم بتحويل مستند PDF إلى صيغة JPEG.

public static ResultContainer Convert(PdfToJpegOptions options)

المعلمات

options PdfToJpegOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة JPEG.

// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToJpegOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_input.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("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 FileData("path_to_input.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة JPEG إلى تدفقات.

// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToJpegOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_input.pdf"));
// تنفيذ العملية
var results = PdfConverter.Convert(options);
// الحصول على نتائج التدفق
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

الاستثناءات

إذا لم يتم تعيين الخيارات.

Convert(PdfToPngOptions)

يقوم بتحويل مستند PDF إلى صيغة PNG.

public static ResultContainer Convert(PdfToPngOptions options)

المعلمات

options PdfToPngOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة PNG.

// إنشاء كائن PdfToPngOptions لتحديد التعليمات
var options = new PdfToPngOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_input.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("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 FileData("path_to_input.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة PNG إلى تدفقات.

// إنشاء كائن PdfToPngOptions لتحديد التعليمات
var options = new PdfToPngOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_input.pdf"));
// تنفيذ العملية
var results = PdfConverter.Convert(options);
// الحصول على نتائج التدفق
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

الاستثناءات

إذا لم يتم تعيين الخيارات.

Convert(PdfToTiffOptions)

يقوم بتحويل مستند PDF إلى صيغة TIFF.

public static ResultContainer Convert(PdfToTiffOptions options)

المعلمات

options PdfToTiffOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة TIFF.

// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("path_to_output_directory"));
// تنفيذ العملية
PdfConverter.Convert(options);

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة TIFF مع تخصيص الصفحات والدقة.

// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("path_to_output_directory"));
// تحديد الصفحات
options.PageList = [1, 3];
// ضبط دقة الصورة الناتجة
options.OutputResolution = 400;
// تنفيذ العملية
PdfConverter.Convert(options);

يُظهر المثال تحويل مستند PDF إلى TIFF متعدد الصفحات.

// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("path_to_output_directory"));
// تمكين إخراج TIFF متعدد الصفحات
options.MultiPage = true;
// تنفيذ العملية
PdfConverter.Convert(options);

يُظهر المثال تحويل مستند PDF إلى صيغة TIFF مع تخصيص الضغط وعمق اللون.

// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var options = new PdfToTiffOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار دليل الإخراج
options.AddOutput(new DirectoryData("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 FileData("path_to_input.pdf"));
// تنفيذ العملية
var results = PdfConverter.Convert(options);
// الحصول على نتائج التدفق
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

الاستثناءات

إذا لم يتم تعيين الخيارات.

Convert(PdfToPdfAOptions)

يقوم بتحويل مستند PDF إلى صيغة PDF/A.

public static ResultContainer Convert(PdfToPdfAOptions options)

المعلمات

options PdfToPdfAOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية تحويل مستند PDF إلى صيغة PDF/A (PDF/A-3b في هذه الحالة):

// إنشاء فئة الخيارات لتكوين عملية التحويل
var options = new PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// إضافة الملف المصدر
options.AddInput(new FileData("path_to_your_pdf_file.pdf")); // استبدل بمسار الملف الفعلي

// إضافة مسار حفظ الملف المحوَّل
options.AddOutput(new FileData("path_to_the_converted_file.pdf"));

// تشغيل التحويل
PdfConverter.Convert(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Validate(PdfAValidateOptions)

يفحص مستند PDF للامتثال للصيغة المحددة PDF/A.

public static ResultContainer Validate(PdfAValidateOptions options)

المعلمات

options PdfAValidateOptions: كائن خيارات يحتوي على التعليمات للعملية.

القيمة المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يُظهر المثال كيفية التحقق من توافق مستند PDF مع صيغة PDF/A (PDF/A-1a في هذه الحالة):

// إنشاء فئة الخيارات لتكوين عملية التحقق
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// إضافة ملف أو أكثر للتحقق
options.AddInput(new FileData("path_to_your_first_pdf_file.pdf")); // استبدل بمسار الملف الفعلي
options.AddInput(new FileData("path_to_your_second_pdf_file.pdf"));
// أضف المزيد من الملفات حسب الحاجة

// تشغيل التحقق والحصول على النتائج
var resultContainer = PdfConverter.Validate(options);

// فحص الخاصية ResultCollection للحصول على نتائج التحقق لكل ملف:
foreach (var result in resultContainer.ResultCollection)
{
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // نتيجة التحقق للمستند
}

الاستثناءات

إذا لم يتم تعيين الخيارات.

مساحة الأسماء: Documentize التجميع: Documentize.dll

Class PdfConverterOptions

معلومات

يمثل خيارات_plugins محولات PDF.

public abstract class PdfConverterOptions : IPluginOptions

الوراثة

object ← PdfConverterOptions

المشتقات

PdfToXlsOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

الخصائص

المدخلات

يعيد مجموعة بيانات ملحق PdfConverterOptions.

public List<idatasource> Inputs { get; }

قيمة الخاصية

المخرجات

يحصل على مجموعة الأهداف المضافة لنتائج عملية الحفظ.

public List<idatasource> Outputs { get; }

قيمة الخاصية

الطرق

AddInput(IDataSource)

يضيف مصدر بيانات جديد إلى مجموعة بيانات ملحق PdfConverter.

public void AddInput(IDataSource dataSource)

المعلمات

dataSource IDataSource: مصدر البيانات المراد إضافته.

AddOutput(IDataSource)

يضيف مصدر بيانات جديد إلى مجموعة بيانات ملحق PdfToXLSXConverterOptions.

public void AddOutput(IDataSource saveDataSource)

المعلمات

saveDataSource IDataSource: مصدر البيانات (ملف أو تدفق) لنتائج عملية الحفظ.

الاستثناءات

NotImplementedException

Namespace: Documentize Assembly: Documentize.dll

Class PdfExtractor

معلومات

يمثّل مكوّن Documentize.PdfExtractor. يُستخدم لاستخراج النص، الصور، بيانات النماذج، الخصائص (البيانات التعريفية) من مستندات PDF.

public static class PdfExtractor

Inheritance

object ← PdfExtractor

Inherited Members

Methods

Extract(ExtractTextOptions)

استخراج النص من مستند PDF.

public static string Extract(ExtractTextOptions options)

Parameters

options ExtractTextOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

string : النص المستخرج.

Examples

يوضح المثال كيفية استخراج محتوى النص من ملف PDF.

// Create ExtractTextOptions object to set input file path
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

يوضح المثال كيفية استخراج محتوى النص من تدفق PDF.

// Create ExtractTextOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

يوضح المثال كيفية استخراج نص مستند PDF مع TextFormattingMode.

// Create ExtractTextOptions object to set input file path and TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

يوضح المثال كيفية استخراج النص من ملف PDF بأقصر صيغة ممكنة.

// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

Exceptions

إذا لم تُحدَّد الخيارات.

Extract(ExtractImagesOptions)

استخراج الصور من مستند PDF.

public static ResultContainer Extract(ExtractImagesOptions options)

Parameters

options ExtractImagesOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Examples

يوضح المثال كيفية استخراج الصور من مستند PDF.

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_results_directory"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get path to image result
var imageExtracted = results.ResultCollection[0].ToFile();

يوضح المثال كيفية استخراج الصور من مستند PDF إلى تدفقات دون مجلد.

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Not set output - it will write results to streams
// Perform the process
var results = PdfExtractor.Extract(options);
// Get Stream
var ms = results.ResultCollection[0].ToStream();
// Copy data to file for demo
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Exceptions

إذا لم تُحدَّد الخيارات.

Extract(ExtractFormDataToDsvOptions)

استخراج بيانات النموذج من مستند PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

options ExtractFormDataToDsvOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Examples

يوضح المثال كيفية تصدير قيم النموذج إلى ملف CSV.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Perform the process
PdfExtractor.Extract(options);

يوضح المثال كيفية تصدير قيم النموذج إلى ملف TSV وتعيين الخصائص.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions();
//Set Delimiter
options.Delimiter = '\t';
//Add Field Names to result
options.AddFieldName = true;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Perform the process
PdfExtractor.Extract(options);

Exceptions

إذا لم تُحدَّد الخيارات.

Extract(ExtractPropertiesOptions)

استخراج الخصائص من مستند PDF.

public static PdfProperties Extract(ExtractPropertiesOptions options)

Parameters

options ExtractPropertiesOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

PdfProperties : كائن يحتوي على نتيجة العملية.

Examples

يوضح المثال كيفية استخراج الخصائص (اسم الملف، العنوان، المؤلف، الموضوع، الكلمات المفتاحية، تاريخ الإنشاء، تاريخ التعديل، التطبيق، منتج PDF، عدد الصفحات) من ملف PDF.

// Create ExtractPropertiesOptions object to set input file
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var filename = pdfProperties.FileName;
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

يوضح المثال كيفية استخراج الخصائص (العنوان، المؤلف، الموضوع، الكلمات المفتاحية، تاريخ الإنشاء، تاريخ التعديل، التطبيق، منتج PDF، عدد الصفحات) من تدفق PDF.

// Create ExtractPropertiesOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

يوضح المثال كيفية استخراج الخصائص من ملف PDF بأقصر صيغة ممكنة.

// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

Exceptions

إذا لم تُحدَّد الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class PdfForm

معلومات

يمثل مكوّن Documentize.PdfForm. يُستخدم لتسوية (Flatten) واستخراج بيانات النماذج. كما يتيح لك الحصول على أسماء الحقول.

يمثل مكوّن Documentize.PdfForm. يُستخدم لتسوية (Flatten) واستخراج بيانات النماذج.
كما يتيح لك الحصول على أسماء الحقول.

public static class PdfForm

وراثة

object ← PdfForm

الأعضاء الموروثة

الأساليب

Extract(ExtractFormDataToDsvOptions)

استخراج بيانات النموذج من مستند PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

المعاملات

options ExtractFormDataToDsvOptions: كائن يحتوي على التعليمات الخاصة بالعملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية تصدير قيم النموذج إلى ملف CSV.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Perform the process
PdfForm.Extract(options);

يوضح المثال كيفية تصدير قيم النموذج إلى ملف TSV وتعيين الخصائص.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions();
//Set Delimiter
options.Delimiter = '\t';
//Add Field Names to result
options.AddFieldName = true;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Perform the process
PdfForm.Extract(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Flatten(FlattenFieldsOptions)

تسوية الحقول في مستند PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

المعاملات

options FlattenFieldsOptions: كائن يحتوي على التعليمات الخاصة بالعملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية تسوية الحقول في ملف PDF.

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

يوضح المثال كيفية تسوية الحقول في ملف PDF وتخطي الحقل الأول.

// Get Fields Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
PdfForm.Flatten(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

GetNames(GetFieldNamesOptions)

الحصول على أسماء الحقول في مستند PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

المعاملات

options GetFieldNamesOptions: كائن يحتوي على التعليمات الخاصة بالعملية.

القيم المرجعة

قائمة بالأسماء في مستند PDF.

أمثلة

يوضح المثال كيفية الحصول على أسماء الحقول من ملف PDF.

// Get Field Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));

Remove(RemoveFieldsOptions) : إزالة الحقول من مستند PDF.

public static ResultContainer Remove(RemoveFieldsOptions options)

المعاملات

options RemoveFieldsOptions: كائن يحتوي على التعليمات الخاصة بالعملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية إزالة الحقول من ملف PDF.

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

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

معلومات

يمثل مكوّن Documentize.PdfManager. يُستخدم للدمج، التقسيم، التحسين، الدوران، تغيير الحجم، ضغط ملفات PDF وإضافة جدول، إضافة فهرس إلى ملفات PDF. يمكن دمج عدة ملفات PDF في ملف واحد. يمكن تقسيم ملفات PDF إلى صفحات منفصلة. يمكن تحسين، دوران، تغيير حجم، ضغط ملفات PDF. يمكن دوران وتغيير حجم صفحات ملف PDF. يمكن إضافة جدول إلى ملف PDF. يمكن إضافة فهرس إلى ملف PDF.

يمثل مكوّن Documentize.PdfManager. يُستخدم للدمج، التقسيم، التحسين، الدوران، تغيير الحجم، ضغط ملفات PDF وإضافة جدول، إضافة فهرس إلى ملفات PDF.
يمكن دمج عدة ملفات PDF في ملف واحد.
يمكن تقسيم ملفات PDF إلى صفحات منفصلة.
يمكن تحسين، دوران، تغيير حجم، ضغط ملفات PDF.
يمكن دوران وتغيير حجم صفحات ملف PDF.
يمكن إضافة جدول إلى ملف PDF.
يمكن إضافة فهرس إلى ملف PDF.

public static class PdfManager

الوراثة

object ← PdfManager

الأعضاء الوراثية

الأساليب

AddTable(TableOptions)

إضافة جدول إلى ملف PDF.

public static ResultContainer AddTable(TableOptions options)

المعاملات

options TableOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية إضافة جدول إلى ملف PDF.

// 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 FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

يوضح المثال كيفية إضافة جدول إلى ملف PDF قبل الصفحة 2.

// Configure table options
var options = new TableOptions();
options.InsertPageBefore(2) // Add table before page 2
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

AddTableOfContents(TocOptions)

إضافة فهرس (TOC) إلى ملف PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

المعاملات

options TocOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية إضافة فهرس إلى ملف PDF.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(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 FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(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 FileData("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Perform the process
PdfManager.AddTableOfContents(options);

يوضح المثال كيفية إضافة فهرس إلى ملف PDF مع تخصيص عنوان الفهرس.

// Create TocOptions object to set instructions
var heading = new TocHeading();
heading.Text = "Intro";
heading.PageNumber = 5;
heading.GenerateNumbering = true;
heading.Level = 2;
var tocOptions = new TocOptions();
tocOptions.Headings.Add(heading);
// Add input and output files
tocOptions.AddInput(new FileData("path_to_your_pdf_file.pdf"));
tocOptions.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Generate the TOC with customized options
PdfManager.AddTableOfContents(tocOptions);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Compress(CompressOptions)

ضغط ملف PDF. محاولة تقليل حجم المستند.

public static ResultContainer Compress(CompressOptions options)

المعاملات

options CompressOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية ضغط ملف PDF.

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

الاستثناءات

إذا لم يتم تعيين الخيارات.

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

إنشاء مستند PDF بناءً على ردّ ChatGpt.
يُستخدم لإرسال طلبات إلى ChatGPT مباشرة أو عن طريق إضافة مصادر ملفات PDF وحفظ الرد في المصدر المحدد.

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

المعاملات

options ChatGptRequestOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

Task<ResultContainer>

كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية استخدام ChatGpt بإضافة رسائل إلى الطلب.

var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileData("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.

يوضح المثال كيفية استخدام ChatGpt بإضافة رسالة واحدة إلى الطلب.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("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.

يوضح المثال كيفية استخدام الدردشة بإضافة ملف (ملفات) كمصدر للرسائل.

var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileData("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 FileData("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.

الاستثناءات

ArgumentException : إذا لم يتم تعيين الخيارات.

Merge(MergeOptions)

دمج ملفات PDF.

public static ResultContainer Merge(MergeOptions options)

المعاملات

options MergeOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية دمج ملفين PDF.

// Create MergeOptions object to set instructions
var options = new MergeOptions();
// Add input file paths
options.AddInput(new FileData("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileData("path_to_your_pdf_file_2.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Merge(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Optimize(OptimizeOptions)

تحسين ملف PDF.
يتم تحسين المستند لجعله:

فتح الصفحة الأولى بأسرع ما يمكن؛
عرض الصفحة التالية أو الانتقال عبر رابط إلى الصفحة التالية بأسرع ما يمكن؛
عرض الصفحة تدريجيًا عند وصول البيانات عبر قناة بطيئة (عرض أهم البيانات أولًا)؛
السماح بالتفاعل (مثل اتباع رابط) قبل استلام وعرض الصفحة بالكامل.

public static ResultContainer Optimize(OptimizeOptions options)

المعاملات

options OptimizeOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية تحسين ملف PDF.

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

الاستثناءات

إذا لم يتم تعيين الخيارات.

Resize(ResizeOptions)

تغيير حجم صفحات ملف PDF.

public static ResultContainer Resize(ResizeOptions options)

المعاملات

options ResizeOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية تغيير حجم ملف PDF.

// Create ResizeOptions object to set instructions
var options = new ResizeOptions();
// Set new PageSize
options.PageSize = PageSize.A3;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Resize(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Rotate(RotateOptions)

دوران صفحات ملف PDF.

public static ResultContainer Rotate(RotateOptions options)

المعاملات

options RotateOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية دوران ملف PDF.

// Create RotateOptions object to set instructions
var options = new RotateOptions();
// Set new Rotation
options.Rotation = Rotation.On90;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Rotate(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Split(SplitOptions)

تقسيم ملف PDF حسب الصفحات.

public static ResultContainer Split(SplitOptions options)

المعاملات

options SplitOptions: كائن الخيارات الذي يحتوي على تعليمات العملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

يوضح المثال كيفية تقسيم ملف PDF.

// Create SplitOptions object to set instructions
var options = new SplitOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file paths
options.AddOutput(new FileData("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file_2.pdf"));
// Perform the process
PdfManager.Split(options);

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class PdfProperties

معلومات

يمثل الخصائص والمعلومات الوصفية لمستند PDF.

public class PdfProperties

الوراثة

object ← PdfProperties

الأعضاء الموروثة

المُنشئات

PdfProperties()

public PdfProperties()

الخصائص

Application

الحصول أو تعيين تطبيق PDF.

public string Application { get; set; }

نوع الخاصية

Author

الحصول أو تعيين مؤلف PDF.

public string Author { get; set; }

نوع الخاصية

Created

الحصول أو تعيين تاريخ إنشاء PDF.

public DateTime? Created { get; set; }

نوع الخاصية

DateTime?

FileName

الحصول أو تعيين اسم ملف PDF، إذا كان متاحًا.

public string FileName { get; set; }

نوع الخاصية

Keywords

الحصول أو تعيين كلمات مفتاحية للـ PDF.

public string Keywords { get; set; }

نوع الخاصية

Modified

الحصول أو تعيين تاريخ تعديل PDF.

public DateTime? Modified { get; set; }

نوع الخاصية

DateTime?

NumberOfPages

الحصول أو تعيين عدد صفحات PDF.

public int NumberOfPages { get; set; }

نوع الخاصية

PdfProducer

الحصول أو تعيين منتج PDF.

public string PdfProducer { get; set; }

نوع الخاصية

Subject

الحصول أو تعيين موضوع PDF.

public string Subject { get; set; }

نوع الخاصية

Title

الحصول أو تعيين عنوان PDF.

public string Title { get; set; }

نوع الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class PdfSecurity

معلومات

يمثل مكوّن Documentize.PdfSecurity. يُستخدم لتشفير، فك تشفير، توقيع، وتنظيف مستندات PDF.

public static class PdfSecurity

الوراثة

object ← PdfSecurity

الأعضاء الموروثة

الطرق

Decrypt(DecryptOptions)

فك تشفير مستند PDF.

public static ResultContainer Decrypt(DecryptOptions options)

المعلمات

options DecryptOptions: كائن الخيارات الذي يحتوي على التعليمات اللازمة للعملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

المثال يوضح كيفية فك تشفير مستند PDF.

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

الاستثناءات

إذا لم يتم تعيين الخيارات.

Encrypt(EncryptOptions)

تشفير مستند PDF.

public static ResultContainer Encrypt(EncryptOptions options)

المعلمات

options EncryptOptions: كائن الخيارات الذي يحتوي على التعليمات اللازمة للعملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

المثال يوضح كيفية تشفير مستند PDF.

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

الاستثناءات

إذا لم يتم تعيين الخيارات.

Sanitize(SanitizeOptions)

تنظيف البيانات المخفية من مستند PDF، مع ضمان إزالة أو تحويل المعلومات الحساسة أو غير الضرورية مثل البيانات التعريفية، التعليقات التوضيحية، جافا سكريبت، أو المحتوى الخاص.

public static ResultContainer Sanitize(SanitizeOptions options)

المعلمات

options SanitizeOptions: كائن الخيارات الذي يحتوي على التعليمات اللازمة للعملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

المثال يوضح كيفية تنظيف مستند PDF.

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

المثال يوضح كيفية تنظيف PDF من Stream إلى Stream.

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

المثال يوضح كيفية تنظيف PDF من ملف إلى Stream.

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

المثال يوضح كيفية تنظيف PDF من ملف إلى Stream مع ضبط يدوي لخصائص الإدخال والإخراج.

// Create SanitizeOptions object
var options = new SanitizeOptions();
//Set Input file
options.Input = new FileData("path_to_your_pdf_file.pdf");
//Set Output file
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sanitize(options);

المثال يوضح كيفية تنظيف PDF دون إزالة البيانات التعريفية.

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

المثال يوضح كيفية تنظيف PDF دون إزالة المرفقات.

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

المثال يوضح كيفية تنظيف PDF مع تحويل جميع الصفحات إلى صور وتحديد DPI للنتيجة.

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

المثال يوضح كيفية تنظيف PDF دون إزالة جافا سكريبتات والإجراءات.

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

المثال يوضح كيفية تنظيف ملف PDF بأقصر أسلوب ممكن.

// Perform the process
PdfSecurity.Sanitize(new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf"));

الاستثناءات

إذا لم يتم تعيين الخيارات.

Sign(SignOptions)

توقيع مستند PDF بالتوقيع الرقمي.

public static ResultContainer Sign(SignOptions options)

المعلمات

options SignOptions: كائن الخيارات الذي يحتوي على التعليمات اللازمة للعملية.

القيم المرجعة

ResultContainer : كائن يحتوي على نتيجة العملية.

أمثلة

المثال يوضح كيفية توقيع مستند PDF.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.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 FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

المثال يوضح كيفية توقيع مستند PDF بتوقيع غير مرئي.

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Configure invisible signature
signOptions.Visible = false;
// Perform the process
PdfSecurity.Sign(options);

المثال يوضح كيفية توقيع مستند PDF بخيارات إضافية.

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

المثال يوضح كيفية توقيع مستند PDF مع طابع زمني.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

الاستثناءات

PdfToHtmlOptions.SaveDataType

إذا لم يتم تعيين الخيارات.

النطاق: Documentize
المجمّع: Documentize.dll

Class PdfToDocOptions

معلومات

يمثل خيارات محول PDF إلى DOC لإضافة Documentize.PdfConverter.

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← PdfToDocOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المُنشئات

PdfToDocOptions()

ينشئ مثيلاً جديداً لكائن Documentize.PdfToDocOptions بخيارات افتراضية.

public PdfToDocOptions()

الخصائص

الوضع

يتيح التحكم في طريقة تحويل مستند PDF إلى مستند معالجة نصوص.

public DocConversionMode Mode { get; set; }

قيمة الخاصية

DocConversionMode

ملاحظات

استخدم وضع Documentize.DocConversionMode.TextBox عندما لا يكون من المتوقع تحرير المستند الناتج بشكل مكثف. الصناديق النصية سهلة التعديل عندما لا يكون هناك الكثير لتعديله.

استخدم وضع Documentize.DocConversionMode.Flow عندما يحتاج مستند الإخراج إلى مزيد من التحرير. الفقرات وأسطر النص في وضع التدفق تسمح بتعديل النص بسهولة، لكن الكائنات التنسيقية غير المدعومة ستظهر بأسوأ من وضع Documentize.DocConversionMode.TextBox.

النطاق: Documentize التجميع: Documentize.dll

Class PdfToHtmlOptions

معلومات

يمثل خيارات تحويل PDF إلى HTML لإضافة Documentize.PdfConverter.

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← PdfToHtmlOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

PdfToHtmlOptions(SaveDataType)

يفّعِل كائنًا جديدًا من Documentize.PdfToHtmlOptions لنوع بيانات الإخراج المحدد.

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

المعلمات

outputDataType PdfToHtmlOptions.SaveDataType: نوع بيانات الإخراج.

الخصائص

OutputDataType

يحصل على نوع بيانات الإخراج.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Class PdfToJpegOptions

معلومات

يمثّل خيارات محول PDF إلى JPEG لإضافة Documentize.PdfConverter.

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

وراثة

object ← PluginBaseOptions ← PdfToJpegOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المُنشئات

PdfToJpegOptions()

يفّتح مثيلًا جديدًا لكائن Documentize.PdfToJpegOptions.

public PdfToJpegOptions()

الخصائص

OutputResolution

يحصل على قيمة الدقة للصور الناتجة أو يعيّنها.

public int OutputResolution { get; set; }

قيمة الخاصية

PageList

يحصل على قائمة الصفحات للمعالجة أو يعيّنها.

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

قيمة الخاصية

List<int>

Quality

يحصل على جودة الإخراج ويعيّنها. يحدّد مستوى الضغط للصورة. نطاق القيم المفيدة للجودة هو من 0 إلى 100. كلما كان الرقم أصغر، زاد الضغط وبالتالي انخفضت جودة الصورة. الصفر يعطيك أقل جودة، و100 أعلى جودة.

public int Quality { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPdfAOptions

معلومات

يمثل خيارات تحويل مستندات PDF إلى تنسيق PDF/A باستخدام المكوّن Documentize.PdfConverter.

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfToPdfAOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToPdfAOptions()

public PdfToPdfAOptions()

Properties

Outputs

Gets the collection of added targets (file or stream data sources) for saving operation results.

public List<idata> Outputs { get; }

Property Value

Methods

AddOutput(IData)

Adds new result save target.

public void AddOutput(IData data)

Parameters

data IData: الهدف (مصدر بيانات ملف أو تدفق) لحفظ نتائج العملية.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPngOptions

معلومات

يمثل خيارات محول PDF إلى PNG لإضافة Documentize.PdfConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToPngOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToPngOptions()

تهيئ كائنًا جديدًا من فئة Documentize.PdfToPngOptions.

public PdfToPngOptions()

Properties

OutputResolution

الحصول على أو تعيين قيمة الدقة للصور الناتجة.

public int OutputResolution { get; set; }

Property Value

PageList

الحصول على أو تعيين قائمة الصفحات للعملية.

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

Property Value

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToTiffOptions

معلومات

يمثل خيارات محول PDF إلى TIFF لإضافة Documentize.PdfConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← PdfToTiffOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

PdfToTiffOptions()

ينشئ مثيلاً جديداً لكائن Documentize.PdfToTiffOptions.

public PdfToTiffOptions()

الخصائص

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

قيمة الخاصية

OutputResolution

يحصل على أو يعيّن قيمة الدقة للصور الناتجة.

public int OutputResolution { get; set; }

قيمة الخاصية

PdfToXlsOptions.ExcelFormat

PageList

يحصل على أو يعيّن قائمة الصفحات للعملية.

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

قيمة الخاصية

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

معلومات

تمثل خيارات محول PDF إلى XLS/XLSX لإضافة Documentize.PdfConverter.

public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← PdfToXlsOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

البناة

PdfToXlsOptions()

يفترض مثيلًا جديدًا من كائن Documentize.PdfToXlsOptions بخيارات افتراضية.

public PdfToXlsOptions()

الخصائص

Format

صيغة الإخراج.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

قيمة الخاصية

InsertBlankColumnAtFirst

عيّن true إذا كنت بحاجة إلى إدراج عمود فارغ كأول عمود في ورقة العمل. القيمة الافتراضية هي false؛ أي أنه لن يتم إدراج عمود فارغ.

public bool InsertBlankColumnAtFirst { get; set; }

قيمة الخاصية

MinimizeTheNumberOfWorksheets

عيّن true إذا كنت بحاجة إلى تقليل عدد أوراق العمل في المصنف الناتج. القيمة الافتراضية هي false؛ أي حفظ كل صفحة PDF كورقة عمل منفصلة.

public bool MinimizeTheNumberOfWorksheets { get; set; }

قيمة الخاصية

المساحة الاسمية: Documentize
التجميع: Documentize.dll

Class PluginBaseOptions

معلومات

يمثل الخيارات الأساسية للمكونات.

public class PluginBaseOptions : IPluginOptions

Inheritance

object ← PluginBaseOptions

Derived

Implements

IPluginOptions

Inherited Members

Properties

CloseInputStreams

إغلاق تدفقات الإدخال بعد إكمال العملية.

public bool CloseInputStreams { get; set; }

Property Value

CloseOutputStreams

إغلاق تدفقات الإخراج بعد إكمال العملية.

public bool CloseOutputStreams { get; set; }

Property Value

Inputs

إرجاع بيانات الإدخالات للعملية.

public List<idata> Inputs { get; }

Property Value

Outputs

إرجاع بيانات المخرجات للعملية.

public List<idata> Outputs { get; }

Property Value

Methods

AddInput(IData)

إضافة بيانات جديدة إلى الإدخالات.

public void AddInput(IData data)

Parameters

data IData: البيانات التي سيتم إضافتها.

AddOutput(IData)

إضافة بيانات جديدة إلى المخرجات.

public void AddOutput(IData data)

Parameters

data IData: البيانات التي سيتم إضافتها. :

Namespace: Documentize Assembly: Documentize.dll

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)

المعلمات

options PdfToPngOptions: كائن خيارات يحتوي على تعليمات التشغيل.

الإرجاع

ResultContainer : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

معلومات

فئة تمثل المستطيل.

public 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 للزاوية العلوية اليمنى.

Namespace: Documentize Assembly: Documentize.dll

Class RemoveFieldsOptions

معلومات

يمثل الخيارات لإزالة الحقول في المستند بواسطة ملحق Documentize.PdfForm.

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← RemoveFieldsOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

RemoveFieldsOptions()

ينشئ مثالًا جديدًا من كائن Documentize.RemoveFieldsOptions مع الخيارات الافتراضية.

public RemoveFieldsOptions()

المساحة الاسمية: Documentize التجميع: Documentize.dll

Class ResizeOptions

معلومات

يمثل خيارات التحجيم لإضافة Documentize.PdfManager.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← ResizeOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

ResizeOptions()

ينشئ مثلاً جديداً لكائن Documentize.ResizeOptions مع الخيارات الافتراضية.

public ResizeOptions()

الخصائص

PageSize

يحصل أو يضبط حجم الصفحة الجديد.

public PageSize PageSize { get; set; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Class ResultContainer

معلومات

يمثل حاوية تحتوي على مجموعة النتائج الناتجة عن معالجة الإضافة.

public class ResultContainer

الوراثة

object ← ResultContainer

الأعضاء الموروثة

الخصائص

ResultCollection

تحصل على مجموعة نتائج العمليات

public List<ioperationresult> ResultCollection { get; }

قيمة الخاصية

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Class RotateOptions

معلومات

يمثل خيارات التدوير لملحق Documentize.PdfManager.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← RotateOptions

التنفيذات

IPluginOptions

الأعضاء الموروثة

المُنشئات

RotateOptions()

يُنشئ مثيلاً جديداً لكائن Documentize.RotateOptions مع الخيارات الافتراضية.

public RotateOptions()

الخصائص

Rotation

يحصل أو يحدد دوران الصفحات الجديدة.

public Rotation Rotation { get; set; }

قيمة الخاصية

Rotation

النطاق: Documentize التجميع: Documentize.dll

Class SanitizeOptions

public class SanitizeOptions : OptionsWithInputAndOutput, IHaveInput

الوراثة

object ←
OptionsWithInput ←
OptionsWithInputAndOutput ←
SanitizeOptions

التنفيذات

IHaveInput

الأعضاء الموروثة

المنشئات

SanitizeOptions()

يُنشئ مثيلاً جديدًا من كائن Documentize.SanitizeOptions بخيارات افتراضية.

public SanitizeOptions()

SanitizeOptions(IData, IData)

يُنشئ مثيلاً جديدًا من كائن Documentize.SanitizeOptions باستخدام بيانات الإدخال المحددة.

public SanitizeOptions(IData inputData, IData outputData = null)

المعلمات

inputData IData: بيانات الإدخال.
outputData IData: بيانات الإخراج.

SanitizeOptions(string, string)

يُنشئ مثيلاً جديدًا من كائن Documentize.SanitizeOptions باستخدام ملفات الإدخال والإخراج المحددة.

public SanitizeOptions(string inputFile, string outputFile)

المعلمات

inputFile string: مسار ملف الإدخال.
outputFile string: مسار ملف الإخراج.

SanitizeOptions(Stream, Stream)

يُنشئ مثيلاً جديدًا من كائن Documentize.SanitizeOptions باستخدام تدفقات الإدخال والإخراج المحددة.

public SanitizeOptions(Stream inputStream, Stream outputStream)

المعلمات

inputStream Stream: تدفق الإدخال.
outputStream Stream: تدفق الإخراج.

SanitizeOptions(string, Stream)

يُنشئ مثيلاً جديدًا من كائن Documentize.SanitizeOptions باستخدام ملف الإدخال وتدفق الإخراج المحددين.

public SanitizeOptions(string inputFile, Stream outputStream)

المعلمات

inputFile string: مسار ملف الإدخال.
outputStream Stream: تدفق الإخراج.

SanitizeOptions(Stream, string)

يُنشئ مثيلاً جديدًا من كائن Documentize.SanitizeOptions باستخدام تدفق الإدخال وملف الإخراج المحدد.

public SanitizeOptions(Stream inputStream, string outputFile)

المعلمات

inputStream Stream: تدفق الإدخال.
outputFile string: مسار ملف الإخراج.

الخصائص

ConvertPagesToImages

يحصل أو يحدد الخيار لتحويل الصفحات إلى صور.
يحدث تحويل الصفحات إلى صور بعد مسح البيانات المخفية الرئيسية، والتي يتم التحكم فيها عبر خيارات أخرى.

public bool ConvertPagesToImages { get; set; }

قيمة الخاصية

FlattenForms

يحصل أو يحدد ما إذا كان يجب تسطيح النماذج في المستند أثناء عملية التنقية.
تسطيح النماذج يحول حقول النموذج التفاعلية إلى محتوى ثابت، مما يجعلها غير قابلة للتحرير أو الملء.

public bool FlattenForms { get; set; }

قيمة الخاصية

FlattenLayers

يحصل أو يحدد الخيار لتسطيح الطبقات في مستند PDF.
عند التمكين، تُدمج جميع الطبقات في المستند في طبقة واحدة، مما يزيل هيكلها المنفصل.
هذا الخيار مفيد لتنقية المستندات عن طريق تبسيط محتواها وضمان عدم وجود بيانات مخفية داخل الطبقات.

public bool FlattenLayers { get; set; }

قيمة الخاصية

ImageDpi

يحصل أو يحدد الخيار لتحديد دقة صور الصفحات أثناء تحويل الصفحات إلى صور.
تعمل الخاصية إذا كانت الخاصية Documentize.SanitizeOptions.ConvertPagesToImages true.

public int ImageDpi { get; set; }

قيمة الخاصية

Input

يحصل أو يحدد بيانات الإدخال.

public override IData Input { get; set; }

قيمة الخاصية

Output

يحصل أو يحدد بيانات الإخراج.

public override IData Output { get; set; }

قيمة الخاصية

RemoveAnnotations

يحصل أو يحدد ما إذا كان يجب إزالة التعليقات التوضيحية من المستند.
عند التمكين، تتم إزالة جميع التعليقات التوضيحية الموجودة في المستند أثناء عملية التنقية.
ستُطبق إخفاءات التعليقات التوضيحية.

public bool RemoveAnnotations { get; set; }

قيمة الخاصية

RemoveAttachments

يحصل أو يحدد الخيار لإزالة جميع الملفات المرفقة من المستند.
عند التمكين، يضمن ذلك حذف أي مرفقات داخل ملف PDF أثناء عملية التنقية.

public bool RemoveAttachments { get; set; }

قيمة الخاصية

RemoveJavaScriptsAndActions

يحصل أو يحدد ما إذا كان يجب إزالة جافاسكريبت والإجراءات المرتبطة منه من المستند.
هذا الخيار مفيد لإزالة الثغرات الأمنية المحتملة التي قد تُدخلها السكريبتات المدمجة.

public bool RemoveJavaScriptsAndActions { get; set; }

قيمة الخاصية

RemoveMetadata

يحصل أو يحدد الخيار لإزالة البيانات الوصفية من المستند.
إذا تم تعيينه إلى true، تُحذف البيانات الوصفية مثل خصائص المستند ومعلومات البيانات الوصفية المدمجة الإضافية أثناء عملية التنقية.

public bool RemoveMetadata { get; set; }

قيمة الخاصية

RemoveSearchIndexAndPrivateInfo

يحصل أو يحدد ما إذا كان يجب إزالة فهرس البحث والمعلومات الخاصة من المستند.
يتيح ذلك حذف فهارس البحث المدمجة والبيانات الخاصة لتعزيز أمان وخصوصية المستند.

public bool RemoveSearchIndexAndPrivateInfo { get; set; }

قيمة الخاصية

نطاق الاسم: Documentize
التجميع: Documentize.dll

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

options EncryptOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

Process(DecryptOptions)

فك تشفير مستند PDF.

public static ResultContainer Process(DecryptOptions options)

Parameters

options DecryptOptions: كائن خيارات يحتوي على تعليمات العملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

معلومات

يمثل خيارات التوقيع لإضافة Documentize.PdfSecurity.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← SignOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المنشئات

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.

الخصائص

Contact

جهة الاتصال الخاصة بالتوقيع.

public string Contact { get; set; }

قيمة الخاصية

Location

موقع التوقيع.

public string Location { get; set; }

قيمة الخاصية

Name

اسم حقل التوقيع الموجود. اتركه فارغًا لإنشاء حقل جديد.

public string Name { get; set; }

قيمة الخاصية

PageNumber

رقم الصفحة التي يُجرى عليها التوقيع.

public int PageNumber { get; set; }

قيمة الخاصية

Reason

سبب التوقيع.

public string Reason { get; set; }

قيمة الخاصية

Rectangle

مستطيل التوقيع.

public Rectangle Rectangle { get; set; }

قيمة الخاصية

Rectangle

TimestampOptions

خيارات الختم الزمني.

public TimestampOptions TimestampOptions { get; set; }

قيمة الخاصية

TimestampOptions

Visible

ظهور التوقيع.

public bool Visible { get; set; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Class SplitOptions

معلومات

يمثل خيارات التقسيم لإضافة Documentize.PdfManager.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← SplitOptions

التطبيقات

IPluginOptions

الأعضاء الموروثة

المنشئات

SplitOptions()

ينشئ مثيلاً جديداً من كائن Documentize.SplitOptions مع الخيارات الافتراضية.

public SplitOptions()

Namespace: Documentize Assembly: Documentize.dll

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 : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class StreamData

معلومات

يمثل بيانات التدفق لعمليات التحميل والحفظ.

public sealed class StreamData : IData

Inheritance

object ← StreamData

Implements

IData

Inherited Members

Constructors

StreamData(Stream)

يُنشئ مصدر بيانات تدفق جديد باستخدام كائن التدفق المحدد.

public StreamData(Stream data)

Parameters

data Stream: كائن التدفق

Properties

Data

يحصل على كائن التدفق لمصدر البيانات الحالي.

public Stream Data { get; }

Property Value

Stream

DataType

نوع البيانات (تدفق).

public DataType DataType { get; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class StreamDataSource

معلومات

تمثل مصدر بيانات البث لعمليات التحميل والحفظ للملحق.

public sealed class StreamDataSource : IDataSource

الوراثة

object ← StreamDataSource

ينفذ

IDataSource

الأعضاء الموروثة

المنشئات

StreamDataSource(Stream)

يُهيئ مصدر بيانات بث جديد باستخدام كائن البث المحدد.

public StreamDataSource(Stream data)

المعلمات

data Stream: كائن البث

الخصائص

Data

يحصل على كائن البث لمصدر البيانات الحالي.

public Stream Data { get; }

قيمة الخاصية

Stream

DataType

نوع مصدر البيانات (بث).

public DataType DataType { get; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class StreamResult

معلومات

تمثل نتيجة العملية في شكل تدفق.

public sealed class StreamResult : IOperationResult

الوراثة

object ← StreamResult

تنفيذ

IOperationResult

الأعضاء الموروثة

الخصائص

البيانات

يحصل على البيانات الخام.

public object Data { get; }

قيمة الخاصية

IsFile

تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.

public bool IsFile { get; }

قيمة الخاصية

IsStream

تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.

public bool IsStream { get; }

قيمة الخاصية

IsString

تشير إلى ما إذا كانت النتيجة سلسلة نصية.

public bool IsString { get; }

قيمة الخاصية

الطرق

ToFile()

يحاول تحويل النتيجة إلى ملف.

public string ToFile()

يرجع

string : سلسلة تمثل المسار إلى ملف الإخراج إذا كانت النتيجة ملفًا؛ وإلا null.

ToStream()

يحاول تحويل النتيجة إلى كائن تدفق.

public Stream ToStream()

يرجع

Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة تدفقًا؛ وإلا null.

اسم النطاق: Documentize التجميع: Documentize.dll

Class StringResult

معلومات

يمثل نتيجة العملية على شكل سلسلة.

public sealed class StringResult : IOperationResult

الوراثة

object ← StringResult

ينفذ

IOperationResult

الأعضاء الموروثة

الخصائص

البيانات

يسترجع البيانات الخام.

public object Data { get; }

قيمة الخاصية

IsFile

تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.

public bool IsFile { get; }

قيمة الخاصية

IsStream

تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.

public bool IsStream { get; }

قيمة الخاصية

IsString

تشير إلى ما إذا كانت النتيجة سلسلة.

public bool IsString { get; }

قيمة الخاصية

النص

تسترجع التمثيل النصي للنتيجة.

public string Text { get; }

قيمة الخاصية

الطرق

ToFile()

يحاول تحويل النتيجة إلى ملف.

public string ToFile()

المرتجع

string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ خلاف ذلك null.

ToStream()

يحاول تحويل النتيجة إلى كائن تيار.

public Stream ToStream()

المرتجع

Stream : كائن تيار يمثل بيانات الإخراج إذا كانت النتيجة تيارًا؛ خلاف ذلك null.

ToString()

يحاول تحويل النتيجة إلى سلسلة.

public override string ToString()

المرتجع

string : سلسلة تمثل محتوى النص إذا كانت النتيجة سلسلة؛ خلاف ذلك تعيد base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

معلومات

Class يمثل الباني للجداول في صفحة pdf.

public class TableBuilder

الوراثة

object ← TableBuilder

المشتقات

TableRowBuilder

الأعضاء الموروثة

الطرق

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.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

معلومات

الصف يمثل المولد لخلية الجدول.

public class TableCellBuilder : TableRowBuilder

الوراثة

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

الأعضاء الموروثة

الطرق

AddCell()

إضافة خلية إلى الجدول.

public override TableCellBuilder AddCell()

الإرجاع

TableCellBuilder : مثيل من Documentize.TableCellBuilder الحالي.

AddParagraph(params string[])

إضافة فقرات إلى خلية الجدول.

public TableCellBuilder AddParagraph(params string[] paragraphs)

المعاملات

paragraphs string[]: نص للفقرات.

الإرجاع

TableCellBuilder : مثيل من Documentize.TableCellBuilder الحالي.

Namespace: Documentize Assembly: Documentize.dll

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 FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
TableGenerator.Process(options);

الطرق

Process(TableOptions)

إضافة جدول إلى مستند PDF.

public static ResultContainer Process(TableOptions options)

المعاملات

options TableOptions: كائن خيارات يحتوي على تعليمات للاجراء.

العائد

ResultContainer : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

معلومات

يمثل خيارات إضافة جدول إلى المستند عبر المكوّن Documentize.PdfManager.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

وراثة

object ← PluginBaseOptions ← TableOptions

تنفيذ

IPluginOptions

الأعضاء الموروثة

البَناؤون

TableOptions()

يُنشئ نسخة جديدة من كائن Documentize.TableOptions باستخدام الخيارات الافتراضية.

public 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 الحالي.

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

معلومات

الفئة تمثل مُنشئًا لصف الجدول.

public class TableRowBuilder : TableBuilder

الوراثة

object ← TableBuilder ← TableRowBuilder

مشتق

TableCellBuilder

الأعضاء الموروثة

الطرق

AddCell()

إضافة خلية إلى صف الجدول.

public virtual TableCellBuilder AddCell()

العائدات

TableCellBuilder : مثيل من Documentize.TableCellBuilder الذي تم إنشاؤه.

AddRow()

تجاوز AddRow.

public override TableRowBuilder AddRow()

العائدات

TableRowBuilder : مثيل من Documentize.TableRowBuilder الحالي.

مساحة الاسم: Documentize المجمع: Documentize.dll

Class TextExtractor

معلومات

يمثل مكون Documentize.TextExtractor. يستخدم لاستخراج النص من مستندات PDF.

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

الوراثة

object ← TextExtractor

الأعضاء الموروثة

الطرق

Process(ExtractTextOptions)

استخراج النص من مستند PDF.

public static string Process(ExtractTextOptions options)

المعلمات

options ExtractTextOptions: كائن خيارات يحتوي على التعليمات الخاصة بالعملية.

الإرجاع

string : كائن يحتوي على نتيجة الاستخراج.

الاستثناءات

في حال عدم تعيين الخيارات.

المجال: Documentize التجميع: Documentize.dll

Class TextExtractorOptions

معلومات

يمثل خيارات استخراج النص لملحق Documentize.TextExtractor.

public sealed class TextExtractorOptions

الوراثة

object ← TextExtractorOptions

الأعضاء الموروثة

البانيين

TextExtractorOptions(TextFormattingMode)

يقوم بتهيئة مثيل جديد من كائن Documentize.TextExtractorOptions لوضع تنسيق النص المحدد.

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

المعلمات

formattingMode TextFormattingMode: قيمة وضع تنسيق النص.

الخصائص

FormattingMode

يحصل على وضع التنسيق.

public TextFormattingMode FormattingMode { get; set; }

قيمة الخاصية

TextFormattingMode

Inputs

يعيد بيانات المدخلات للعملية.

public List<idatasource> Inputs { get; }

قيمة الخاصية

الطرق

AddInput(IDataSource)

يضيف بيانات جديدة إلى المدخلات.

public void AddInput(IDataSource dataSource)

المعلمات

dataSource IDataSource: مصدر البيانات المراد إضافته. :

Namespace: Documentize Assembly: Documentize.dll

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

options PdfToTiffOptions: كائن خيارات يحتوي على تعليمات للعملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

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

options AddTimestampOptions: كائن خيارات يحتوي على تعليمات للعملية.

Returns

ResultContainer : كائن يحتوي على نتيجة العملية.

Exceptions

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

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

قيمة الخاصية

ServerUrl

يحصل/يحدد عنوان url لخادم الطابع الزمني.

public string ServerUrl { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class TocGenerator

معلومات

يمثل ملحق Documentize.TocGenerator. يُستخدم لإضافة جدول محتويات إلى مستندات PDF.

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

الوراثة

object ← TocGenerator

الأعضاء الموروثة

أمثلة

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 FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

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 FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

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 FileData("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Perform the process
TocGenerator.Process(options);

الطرق

Process(TocOptions)

يبدأ معالجة Documentize.TocGenerator باستخدام المعلمات المحددة.

public static ResultContainer Process(TocOptions options)

المعلمات

options TocOptions: كائن خيارات يحتوي على التعليمات الخاصة بالعملية.

الإرجاع

ResultContainer : كائن Documentize.ResultContainer يحتوي على نتيجة العملية.

النطاق: Documentize التجميع: Documentize.dll

Class TocHeading

معلومات

يمثل الخيارات للعناوين أو الأسماء في جدول المحتويات لتوثيقها بواسطة ملحق Documentize.PdfManager.

public class TocHeading

الوراثة

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

قيمة الخاصية

Level

المستوى. يستخدم لتوليد الأرقام.

public int Level { get; set; }

قيمة الخاصية

PageNumber

رقم الصفحة للرابط.

public int PageNumber { get; set; }

قيمة الخاصية

Text

نص العنوان.

public string Text { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Class TocOptions

معلومات

يمثل خيارات لإضافة جدول المحتويات إلى الوثيقة بواسطة ملحق Documentize.PdfManager.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← TocOptions

التنفيذ

IPluginOptions

الأعضاء الموروثة

المُنشئات

TocOptions()

يُنشئ نسخة جديدة من كائن Documentize.TocOptions مع الخيارات الافتراضية.

public TocOptions()

الخصائص

GenerateBookmarks

استخدام توليد الإشارات المرجعية. إذا تم تعيين true فسيتم مسح الإشارات المرجعية وتوليدها بناءً على العناوين؛ وإلا، لن تتغير الإشارات المرجعية.

public bool GenerateBookmarks { get; set; }

قيمة الخاصية

Headings

العناوين أو العناوين الفرعية لجدول المحتويات.

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

قيمة الخاصية

List<TocHeading>

Title

عنوان جدول المحتويات.

public string Title { get; set; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

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)

المعلمات

options PdfToXlsOptions: كائن خيارات يحتوي على تعليمات للعملية.

العودة

ResultContainer : كائن يحتوي على نتيجة العملية.

الاستثناءات

إذا لم يتم تعيين الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

معلومات

هذه الفئة تمثل الإجراء للأخطاء في التحويل.

public enum ConvertErrorAction

Fields

Delete = 0
None = 1

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertSoftMaskAction

معلومات

تمثل هذه العملية إجراءات لتحويل الصور باستخدام قناع ناعم.

public enum ConvertSoftMaskAction

Fields

ConvertToStencilMask = 1: سيتم تحويل القناع الناعم إلى قناع استنسل.
Default = 0: استخدم الاستراتيجية الافتراضية.

Namespace: Documentize Assembly: Documentize.dll

Enum DataType

معلومات

يمثل الأنواع الممكنة للبيانات لمعالجة المكوّن.

public enum DataType

Fields

Directory = 2: نوع البيانات هو دليل يُمثَّل بالمسار الخاص به.
File = 0: نوع البيانات هو ملف يُمثَّل بالمسار الخاص به.
Stream = 1: نوع البيانات هو تدفق.

النطاق: Documentize التجميع: Documentize.dll

Enum DocConversionMode

معلومات

تحديد وضع تحويل الوثيقة الناتجة.

public enum DocConversionMode

الفئات

Flow = 1: وضع التعرف الكامل، حيث يقوم المحرك بأداء التجميع والتحليل متعدد المستويات لاستعادة نية مؤلف الوثيقة الأصلية وإنتاج وثيقة قابلة للتحرير بشكل كامل. السلبيات هي أن الوثيقة الناتجة قد تبدو مختلفة عن ملف PDF الأصلي.
TextBox = 0: هذا الوضع سريع وجيد للحفاظ على الشكل الأصلي لملف PDF، ولكن قابلية تحرير الوثيقة الناتجة قد تكون محدودة. كل كتلة نصية مرئية مجمعة في ملف PDF الأصلي يتم تحويلها إلى مربع نص في الوثيقة الناتجة. هذا يحقق تشابهاً أقصى بين الوثيقة الناتجة وملف PDF الأصلي. ستبدو الوثيقة الناتجة جيدة، لكنها ستتكون بالكامل من صناديق نصية وقد يجعل ذلك تحرير الوثيقة في Microsoft Word صعباً للغاية. هذا هو الوضع الافتراضي.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

معلومات

يحدد أنواع الوسائط الممكنة المستخدمة أثناء التقديم.

public enum HtmlMediaType

Fields

Print = 0: طباعة.
Screen = 1: شاشة.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

معلومات

تحدد الأعلام التي معًا تحدد خيارات أخرى أحجام وتنسيقات الصفحات.

public enum HtmlPageLayoutOption

Fields

FitToWidestContentWidth = 3: تشير إلى أن عرض الصفحة يتم تحديده من حجم المحتوى نفسه، وليس من عرض الصفحة المحدد.
None = 0: القيمة الافتراضية التي تشير إلى أن HtmlPageLayoutOption لن تؤثر على أحجام وتنسيقات الصفحات.
ScaleToPageWidth = 256: تشير إلى أن محتوى الوثيقة سيتم تغيير مقاسه ليناسب الصفحة.

Namespace: Documentize Assembly: Documentize.dll

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.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToHtmlOptions.SaveDataType

معلومات

يحدد نوع مخرج ملف HTML.

public enum PdfToHtmlOptions.SaveDataType

Fields

FileWithEmbeddedResources = 1: حفظ HTML في ملف مع موارد متضمّنة
FileWithExternalResources = 0: حفظ HTML في ملف مع موارد خارجية
StreamWithEmbeddedResources = 2: حفظ HTML في دفق الملف مع موارد متضمّنة

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

معلومات

يسمح بتحديد تنسيق ملف 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).

Namespace: Documentize Assembly: Documentize.dll

Enum Role

معلومات

دور مؤلف الرسائل.

public enum Role

Fields

Assistant = 2
System = 1
User = 0

Namespace: Documentize Assembly: Documentize.dll

Enum Rotation

معلومات

تعداد القيم الممكنة للدوران.

public enum Rotation

Fields

None = 0: غير مدور.
On180 = 2: مدور بزاوية 180 درجة.
On270 = 3: مدور بزاوية 270 درجة في اتجاه عقارب الساعة.
On360 = 4: مدور بزاوية 360 درجة في اتجاه عقارب الساعة.
On90 = 1: مدور بزاوية 90 درجة في اتجاه عقارب الساعة.

Namespace: Documentize Assembly: Documentize.dll

Enum TextExtractorOptions.TextFormattingMode

معلومات

يحدد أوضاعًا مختلفة يمكن استخدامها عند تحويل مستند PDF إلى نص. راجع فئة Documentize.TextExtractorOptions.

public enum TextExtractorOptions.TextFormattingMode

Fields

Plain = 2: يمثل محتوى نص PDF مع الأخذ في الاعتبار موضع النص النسبي ولكن دون إضافة مسافات إضافية.
Pure = 0: يمثل محتوى نص PDF مع بعض روتينات التنسيق. وهذا يشمل الأخذ في الاعتبار المواقع النسبية وإضافة مسافات إضافية لمحاذاة النص مع عرض الصفحة.
Raw = 1: يمثل محتوى PDF كما هو، أي بدون تنسيق.

Namespace: Documentize Assembly: Documentize.dll

Enum TextFormattingMode

معلومات

يحدد أوضاع مختلفة يمكن استخدامها أثناء تحويل مستند PDF إلى نص. انظر إلى فئة Documentize.ExtractTextOptions.

public enum TextFormattingMode

Fields

Flatten = 2: يمثل محتوى PDF مع تحديد مواقع أجزاء النص حسب إحداثياتها. إنه مشابه أساسًا لوضع “Raw”. لكن بينما يركز “Raw” على الحفاظ على هيكل أجزاء النص (المشغلين) في مستند، يركز “Flatten” على الحفاظ على النص بالترتيب الذي يتم قراءته.
Pure = 0: يمثل محتوى نص PDF مع بعض روتينات التنسيق. وهذا يشمل الأخذ في الاعتبار المواقع النسبية وإضافة مسافات إضافية لمحاذاة النص بعرض الصفحة.
Raw = 1: يمثل محتوى PDF كما هو، أي بدون تنسيق.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffColorDepth

معلومات

يستخدم لتحديد عمق اللون لخيارات Documentize.PdfToTiff.

public enum TiffColorDepth

الحقول

Format1bpp = 4: 1 بت لكل بكسل.
Format24bpp = 1: 24 بت لكل بكسل. Rgb.
Format32bpp = 0: 32 بت لكل بكسل. يستخدم بشكل افتراضي.
Format4bpp = 3: 4 بت لكل بكسل.
Format8bpp = 2: 8 بت لكل بكسل.

Namespace: Documentize Assembly: Documentize.dll

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 كمعامل ينتمي إلى فئة الضغط.

Namespace: Documentize Assembly: Documentize.dll

Interface IData

معلومات

واجهة البيانات العامة التي تحدد الأعضاء المشتركة التي يجب أن تنفذها البيانات الملموسة.

public interface IData

Properties

DataType

نوع مصدر البيانات.

DataType DataType { get; }

Property Value

النطاق: Documentize التجميع: Documentize.dll

Interface IDataSource

معلومات

واجهة بيانات عامة تحدد الأعضاء المشتركين التي ينبغي أن تنفذها البيانات الملموسة.

public interface IDataSource

الخصائص

DataType

نوع مصدر البيانات.

DataType DataType { get; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Interface IHadInput

معلومات

واجهة بيانات عامة تحدد بيانات الإدخال التي يجب على الخيارات تنفيذها.

public interface IHaveInput

الخصائص

الإدخال

يحصل أو يضبط بيانات الإدخال.

IData Input { get; set; }

قيمة الخاصية

النطاق: Documentize التجميع: Documentize.dll

Interface IOperationResult

معلومات

واجهة نتيجة العملية العامة التي تحدد الأساليب المشتركة التي يجب أن تنفذها نتيجة مكوّن محدد.

public interface IOperationResult

الخصائص

Data

يحصل على البيانات الخام.

object Data { get; }

قيمة الخاصية

IsFile

تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف إخراج.

bool IsFile { get; }

قيمة الخاصية

IsStream

تشير إلى ما إذا كانت النتيجة تدفقًا إخراجيًا.

bool IsStream { get; }

قيمة الخاصية

IsString

تشير إلى ما إذا كانت النتيجة سلسلة نصية.

bool IsString { get; }

قيمة الخاصية

الطرق

ToFile()

يحاول تحويل النتيجة إلى ملف.

string ToFile()

يُرجِع

string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ وإلا null.

ToStream()

يحاول تحويل النتيجة إلى كائن تدفق.

Stream ToStream()

يُرجِع

Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة تدفقًا؛ وإلا null.

Namespace: Documentize Assembly: Documentize.dll

Interface IPluginOptions

معلومات

واجهة خيارات المكوّن العامة التي تُعرّف الأساليب المشتركة التي يجب على خيارات المكوّن الفعلية تنفيذها.

public interface IPluginOptions

النطاق: Documentize التجميع: Documentize.dll

اختيار الفئة

معلومات

خيار إكمال الدردشة.

public class Choice

الوراثة

object ← Choice

الأعضاء الموروثة

المُنشئات

Choice()

public Choice()

الخصائص

FinishReason

السبب الذي جعل النموذج يتوقف عن توليد الرموز. سيتوقف هذا إذا وصل النموذج إلى نقطة توقف طبيعية أو تسلسل توقف محدد، أو إذا تم الوصول إلى الحد الأقصى لعدد الرموز المحددة في الطلب.

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

قيمة الخاصية

Index

فهرس الخيار في قائمة الخيارات.

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

قيمة الخاصية

Message

رسالة إكمال الدردشة تم توليدها بواسطة النموذج.

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

قيمة الخاصية

Message

Namespace: Documentize Assembly: Documentize.dll

استخدام الفئة

معلومات

إحصائيات الاستخدام لطلب الإكمال.

public class Usage

الوراثة

object ← Usage

الأعضاء الموروثون

المنشئات

Usage()

public Usage()

الخصائص

CompletionTokens

عدد الرموز في الإكمال المُولد.

[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }

قيمة الخاصية

PromptTokens

عدد الرموز في الطلب.

[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }

قيمة الخاصية

TotalTokens

إجمالي عدد الرموز المستخدمة في الطلب (الطلب + الإكمال).

[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

صورة الفئة

معلومات

يمثل إضافة Documentize.Signature. تستخدم لتوقيع مستندات PDF.

[Obsolete("سيتم حذف الفئة قريبًا. يُرجى استخدام فئة PdfSecurity.")]
public static class Signature

الوراثة

object ← Signature

الأعضاء الموروثة

الطرق

Process(SignOptions)

توقيع مستند PDF.

public static ResultContainer Process(SignOptions options)

المعلمات

options SignOptions: كائن خيارات يحتوي على تعليمات العملية.

العائدات

ResultContainer : كائن يحتوي على نتيجة العملية.

الاستثناءات