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

public static string 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

Inheritance

object ← PluginBaseOptions ← ChatGptRequestOptions

Implements

IPluginOptions

Inherited Members

Constructors

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

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

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

Parameters

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

Properties

ApiKey

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

public string ApiKey { get; set; }

Property Value

ApiUrl

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

public string ApiUrl { get; set; }

Property Value

CancellationToken

رمز الإلغاء.

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

MaxTokens

الحد الأقصى لعدد الرموز في الاستجابة. القيمة الافتراضية هي null، ما يعني عدم حد.

public int? MaxTokens { get; set; }

Property Value

int?

Messages

يحصل على مجموعة من كائنات Documentize.Message أو يعيّنها.

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

Property Value

List<Message>

Remarks

عند إضافة رسائل متعددة إلى الخيارات، يكون ترتيب الرسائل في المجموعة كما يلي:

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

Model

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

public string Model { get; set; }

Property Value

NumberOfChoices

عدد اختيارات إكمال الدردشة التي تُولَّد لكل رسالة إدخال.

public int NumberOfChoices { get; set; }

Property Value

Query

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

public string Query { get; set; }

Property Value

Temperature

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

public double Temperature { get; set; }

Property Value

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

Class Choice

معلومات

خيار إكمال الدردشة.

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

Class CompressOptions

معلومات

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

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← CompressOptions

Implements

IPluginOptions

Inherited Members

Constructors

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

الوراثة

object ← DirectoryData

التنفيذ

IData

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

المنشئات

DirectoryData(string)

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

public DirectoryData(string path)

المعلمات

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

الخصائص

DataType

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

public DataType DataType { get; }

قيمة الخاصية

Path

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

public string Path { get; }

قيمة الخاصية

النطاق: Documentize التجميع: 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

الإرث

object ← DocConverter

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

الطرق

Process(PdfToDocOptions)

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

public static ResultContainer Process(PdfToDocOptions options)

المعاملات

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

الإرجاع

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

الاستثناءات

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

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

الوراثة

object ← PluginBaseOptions ← EncryptOptions

التنفيذ

IPluginOptions

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

المُنشئات

EncryptOptions(string, string)

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

public EncryptOptions(string ownerPassword, string userPassword)

المعلمات

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

الخصائص

OwnerPassword

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

public string OwnerPassword { get; set; }

قيمة الخاصية

UserPassword

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

public string UserPassword { get; set; }

قيمة الخاصية

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

Class ExtractFormDataToDsvOptions

معلومات

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

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implements

IPluginOptions

Inherited Members

Constructors

ExtractFormDataToDsvOptions(char, bool)

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

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

Parameters

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

Properties

AddFieldName

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

public bool AddFieldName { get; set; }

Property Value

Delimiter

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

public char Delimiter { get; set; }

Property Value

char

المساحة الاسمية: Documentize
التجميع: 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; }

قيمة الخاصية

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

Class ExtractTextOptions

معلومات

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

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

الوراثة

object ← OptionsWithInput ← ExtractTextOptions

تنفيذ

IHaveInput

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

البنائيون

ExtractTextOptions(TextFormattingMode)

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

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

المعلمات

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

ExtractTextOptions(IData, TextFormattingMode)

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

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

المعلمات

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

ExtractTextOptions(string, TextFormattingMode)

ـ يinitializes نسخة جديدة من كائن Documentize.ExtractTextOptions مع الملف المحدد.

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

المعلمات

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

ExtractTextOptions(Stream, TextFormattingMode)

ـ يinitializes نسخة جديدة من كائن Documentize.ExtractTextOptions مع التيار المحدد.

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

المعلمات

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

الخصائص

FormattingMode

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

public TextFormattingMode FormattingMode { get; set; }

قيمة الخاصية

TextFormattingMode

Input

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

public override IData Input { get; set; }

قيمة الخاصية

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

Class FileData

معلومات

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

public sealed class FileData : IData

الوراثة

object ← FileData

يُنفّذ

IData

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

المنشئات

FileData(string)

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

public FileData(string path)

المعاملات

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

الخصائص

DataType

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

public DataType DataType { get; }

قيمة الخاصية

Path

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

public string Path { get; }

قيمة الخاصية

الطرق

ToString()

يحول الكائن إلى System.String.

public override string ToString()

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

string : مسار الملف.

Namespace: Documentize Assembly: 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

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

الخصائص

Data

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

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.

Namespace: Documentize Assembly: Documentize.dll

Class FlattenFieldsOptions

معلومات

يمثل خيارات لتسطيح الحقول في المستند بواسطة م компонент Documentize.PdfForm.

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

Property Value

Namespace: Documentize Assembly: 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

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

Namespace: Documentize Assembly: 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

الوراثة

object ← FormFlattener

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

الأساليب

GetFieldNames(string)

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

public static List<string> GetFieldNames(string path)

المعلمات

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

الإرجاع

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

GetFieldNames(Stream)

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

public static List<string> GetFieldNames(Stream stream)

المعلمات

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

الإرجاع

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

Process(FlattenFieldsOptions)

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

public static ResultContainer Process(FlattenFieldsOptions options)

المعلمات

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

الإرجاع

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

الاستثناءات

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

Namespace: Documentize Assembly: 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 لاسترجاع أسماء الحقول من مستند PDF.

public class GetFieldNamesOptions : OptionsWithInput, IHaveInput

الوراثة

object ← OptionsWithInput ← GetFieldNamesOptions

التنفيذ

IHaveInput

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

المنشئات

GetFieldNamesOptions()

ينشئ مثيلاً جديداً من فئة Documentize.GetFieldNamesOptions دون تحديد أية معلمات. ينشئ هذا المنشئ كائن خيارات فارغ يمكن تكوينه لاحقاً قبل تنفيذ العملية.

public GetFieldNamesOptions()

GetFieldNamesOptions(string)

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

public GetFieldNamesOptions(string path)

المعلمات

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

GetFieldNamesOptions(Stream)

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

public GetFieldNamesOptions(Stream stream)

المعلمات

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

الخصائص

Input

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

public override IData Input { get; set; }

قيمة الخاصية

النطاق: Documentize التجميع: 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

الوراثة

object ← HtmlConverter

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

الطرق

Process(PdfToHtmlOptions)

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

public static ResultContainer Process(PdfToHtmlOptions options)

المعاملات

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

الإرجاع

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

الاستثناءات

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

Process(HtmlToPdfOptions)

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

public static ResultContainer Process(HtmlToPdfOptions options)

المعاملات

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

الإرجاع

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

الاستثناءات

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

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

Class HtmlToPdfOptions

معلومات

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

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← HtmlToPdfOptions

التنفيذ

IPluginOptions

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

المُنشئات

HtmlToPdfOptions()

تهيئ نسخة جديدة من كائن Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

الخصائص

BasePath

المسار/عنوان URL الأساسي لملف 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.10.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 : كائن يحتوي على نتيجة العملية.

الاستثناءات

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

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

الاستثناءات

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

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

Class Message

معلومات

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

public class Message

الوراثة

object ← Message

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

المُنشئون

Message()

public Message()

الخصائص

Content

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

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

قيمة الخاصية

Role

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

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

قيمة الخاصية

Role

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

Class ObjectResult

معلومات

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

public sealed class ObjectResult : IOperationResult

الوراثة

object ← ObjectResult

التنفيذ

IOperationResult

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

الخصائص

Data

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

public object Data { get; }

قيمة الخاصية

IsFile

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

public bool IsFile { get; }

قيمة الخاصية

IsObject

يدل على ما إذا كانت النتيجة كائنًا.

public bool IsObject { get; }

قيمة الخاصية

IsStream

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

public bool IsStream { get; }

قيمة الخاصية

IsString

يدل على ما إذا كانت النتيجة سلسلة.

public bool IsString { get; }

قيمة الخاصية

Text

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

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.

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

الوراثة

object ← Optimizer

الأعضاء المُورَّثة

الطرق

Process(OptimizeOptions)

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

public static ResultContainer Process(OptimizeOptions options)

المعلمات

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

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

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

Process(RotateOptions)

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

public static ResultContainer Process(RotateOptions options)

المعلمات

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

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

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

Process(ResizeOptions)

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

public static ResultContainer Process(ResizeOptions options)

المعلمات

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

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

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

Process(CompressOptions)

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

public static ResultContainer Process(CompressOptions options)

المعلمات

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

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

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

Namespace: Documentize
Assembly: Documentize.dll

Class OptionsWithInput

معلومات

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

public abstract class OptionsWithInput : IHaveInput

الوراثة

object ← OptionsWithInput

المشتقات

التنفيذ

IHaveInput

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

الحقول

input
```
protected IData input
```

قيمة الحقل

الخصائص

Input

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

public virtual IData Input { get; set; }

قيمة الخاصية

Namespace: Documentize
Assembly: Documentize.dll

Class OptionsWithInputAndOutput

معلومات

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

public abstract class OptionsWithInputAndOutput : OptionsWithInput, IHaveInput

الوراثة

object ← OptionsWithInput ← OptionsWithInputAndOutput

المشتقة

التطبيق

IHaveInput

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

الحقول

output

protected IData output

قيمة الحقل

الخصائص

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

الوراثة

object ←
PageSize

المشتقة

PageInfo

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

البُنّاؤون

PageSize()

البناء الخاص بـ Documentize.PageSize. الحجم الافتراضي هو A4.

public PageSize()

PageSize(double, double)

البناء الخاص بـ Documentize.PageSize.

public PageSize(double width, double height)

المعلمات

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

الخصائص

A0

حجم A0 (1189×840 مم).

public static PageSize A0 { get; }

قيمة الخاصية

A1

حجم A1 (840×594 مم).

public static PageSize A1 { get; }

قيمة الخاصية

A2

حجم A2 (594×420 مم).

public static PageSize A2 { get; }

قيمة الخاصية

A3

حجم A3 (420×297 مم).

public static PageSize A3 { get; }

قيمة الخاصية

A4

حجم A4 (297×210 مم).

public static PageSize A4 { get; }

قيمة الخاصية

A5

حجم A5 (210×148 مم).

public static PageSize A5 { get; }

قيمة الخاصية

A6

حجم A6 (148×105 مم).

public static PageSize A6 { get; }

قيمة الخاصية

B5

حجم B5 (250×176 مم).

public static PageSize B5 { get; }

قيمة الخاصية

Height

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

public double Height { get; set; }

قيمة الخاصية

IsLandscape

الحصول على وضعية الصفحة. تُعيد true إذا كانت الوضعية أفقية (Landscape) و false إذا كانت رأسية (Portrait).

public bool IsLandscape { get; }

قيمة الخاصية

P11x17

تنسيق 11×17 بوصة.

public static PageSize P11x17 { get; }

قيمة الخاصية

PageLedger

حجم Ledger (432×279 مم).

public static PageSize PageLedger { get; }

قيمة الخاصية

PageLegal

حجم Legal (356×216 مم).

public static PageSize PageLegal { get; }

قيمة الخاصية

PageLetter

حجم Letter (279×216 مم).

public static PageSize PageLetter { get; }

قيمة الخاصية

Width

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

public double Width { get; set; }

قيمة الخاصية

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

Class PdfAConverter

معلومات

يمثل مكوّنًا إضافيًا للتعامل مع تحويل مستندات PDF إلى تنسيق PDF/A وللتحقق من توافق 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

Inheritance

object ← PdfAOptionsBase

Derived

Implements

IPluginOptions

Inherited Members

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

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

public bool AlignText { get; set; }

Property Value

Remarks

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

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }

Property Value

Inputs

Gets collection of data.

public List<idata> Inputs { get; }

Property Value

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Property Value

LogOutputSource

Gets or sets the data source for the log output.

public IData LogOutputSource { get; set; }

Property Value

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Property Value

Remarks

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

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

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

SoftMaskAction

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

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IData)

Adds new data to the collection

public void AddInput(IData data)

Parameters

data IData: Input data.

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAValidateOptions

معلومات

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

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

الوراثة

object ← PdfAOptionsBase ← PdfAValidateOptions

التنفيذ

IPluginOptions

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

البُنى

PdfAValidateOptions()

public PdfAValidateOptions()

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

Class PdfAValidationResult

معلومات

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

public sealed class PdfAValidationResult

الوراثة

object ←
PdfAValidationResult

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

الحقول

Data

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

public readonly IData Data

قيمة الحقل

IsValid

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

public readonly bool IsValid

قيمة الحقل

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

قيمة الحقل

PdfAStandardVersion

Namespace: Documentize
Assembly: 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

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

المُنشئون

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.

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

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

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Convert(PdfToXlsOptions)

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

public static ResultContainer Convert(PdfToXlsOptions options)

المعلمات

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

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

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

الأمثلة

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

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

يوضح المثال كيفية تحويل PDF إلى مستند XLS مع تحديد الصيغة.

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Convert(PdfToHtmlOptions)

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

public static ResultContainer Convert(PdfToHtmlOptions options)

المعلمات

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

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

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

الأمثلة

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Convert(HtmlToPdfOptions)

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

public static ResultContainer Convert(HtmlToPdfOptions options)

المعلمات

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

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

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

الأمثلة

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Convert(PdfToJpegOptions)

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

public static ResultContainer Convert(PdfToJpegOptions options)

المعلمات

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

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

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

الأمثلة

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

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

يوضح المثال كيفية تحويل مستند PDF إلى صيغة JPEG مع ضبط الصفحات، الدقة، والجودة.

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

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Convert(PdfToPngOptions)

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

public static ResultContainer Convert(PdfToPngOptions options)

المعلمات

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

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

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

الأمثلة

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

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

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

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

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Convert(PdfToTiffOptions)

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

public static ResultContainer Convert(PdfToTiffOptions options)

المعلمات

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

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

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

الأمثلة

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

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

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

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

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

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

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

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

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Convert(PdfToPdfAOptions)

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

public static ResultContainer Convert(PdfToPdfAOptions options)

المعلمات

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

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

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

الأمثلة

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

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

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

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Validate(PdfAValidateOptions)

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

public static ResultContainer Validate(PdfAValidateOptions options)

المعلمات

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

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

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

الأمثلة

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

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

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

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

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

الاستثناءات

ArgumentException
إذا لم يتم تعيين options.

Namespace: Documentize
Assembly: 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

الوراثة

object ← PdfExtractor

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

الطرق

Extract(ExtractTextOptions)

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

public static string Extract(ExtractTextOptions options)

المعلمات

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

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

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

أمثلة

المثال يوضح كيفية استخراج محتوى النص من ملف 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));

الاستثناءات

إذا لم يتم تعيين الـ options.

Extract(ExtractImagesOptions)

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

public static ResultContainer Extract(ExtractImagesOptions options)

المعلمات

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

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

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

أمثلة

المثال يوضح كيفية استخراج الصور من مستند 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);
}

الاستثناءات

إذا لم يتم تعيين الـ options.

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

الاستثناءات

إذا لم يتم تعيين الـ options.

Extract(ExtractPropertiesOptions)

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

public static PdfProperties Extract(ExtractPropertiesOptions options)

المعلمات

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

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

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

أمثلة

المثال يوضح كيفية استخراج الخصائص (FileName, Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) من ملف 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;

المثال يوضح كيفية استخراج الخصائص (Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) من تدفق 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"));

الاستثناءات

إذا لم يتم تعيين الـ options.

الـ Namespace: Documentize
الـ Assembly: Documentize.dll

Class PdfForm

معلومات

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

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

public static class PdfForm

Inheritance

object ← PdfForm

Inherited Members

Methods

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

Exceptions

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

Flatten(FlattenFieldsOptions)

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

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parameters

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

Returns

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

Examples

يوضح المثال كيفية تسطيح الحقول في ملف 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);

Exceptions

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

GetNames(GetFieldNamesOptions)

استرجاع أسماء جميع الحقول التفاعلية في مستند PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Parameters

options GetFieldNamesOptions: نسخة من Documentize.GetFieldNamesOptions تُحدِّد مصدر الإدخال (مسار ملف أو تدفق) والتعليمات الخاصة بالعملية.

Returns

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

Examples

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

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

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

// Create GetFieldNamesOptions object to set instructions
var options = new GetFieldNamesOptions("path_to_your_pdf_file.pdf");
// Perform the process and get names
var fieldNames = PdfForm.GetNames(options);

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

// Prepare input stream
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
// Get field names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions(inputStream));

يوضح المثال كيفية تعيين خاصية Input في فئة Documentize.GetFieldNamesOptions. يمكن أن يكون هذا مفيدًا في عمليات الحلقة دون إنشاء نسخة جديدة.

var options = new GetFieldNamesOptions();
// Set input from a file
options.Input = new FileData("path_to_your_pdf_file.pdf");
// Or set input from a stream
// options.Input = new StreamData(stream);
var results = PdfForm.GetNames(options);

Remove(RemoveFieldsOptions) : Remove Fields from PDF document.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parameters

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

Returns

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

Examples

يوضح المثال كيفية إزالة الحقول من ملف 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);

Exceptions

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

معلومات

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

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

public static class PdfManager

Inheritance

object ← PdfManager

Inherited Members

Methods

AddTable(TableOptions)

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

public static ResultContainer AddTable(TableOptions options)

Parameters

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

Returns

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

Examples

المثال يوضح كيفية إضافة جدول إلى ملف 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"));
options.AddOutput(new FileData("path_to_output.pdf"));
PdfManager.AddTable(options);

Exceptions

إذا لم يتم تعيين options.

AddTableOfContents(TocOptions)

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

public static ResultContainer AddTableOfContents(TocOptions options)

Parameters

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

Returns

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

Examples

المثال يوضح كيفية إضافة فهرس إلى ملف 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();
options.Title = "My Table of Contents";
options.GenerateBookmarks = true;
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
PdfManager.AddTableOfContents(options);

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

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

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

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

Exceptions

إذا لم يتم تعيين options.

Compress(CompressOptions)

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

public static ResultContainer Compress(CompressOptions options)

Parameters

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

Returns

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

Examples

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

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

Exceptions

إذا لم يتم تعيين options.

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

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

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Parameters

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

Returns

Task<ResultContainer>

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

Examples

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

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key.";
options.MaxTokens = 1000;

options.Messages.Add(new Message
{
    Content = "You are a helpful assistant.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "What is the biggest pizza diameter ever made?",
    Role = Role.User
});

var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion;

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

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
options.ApiKey = "Your API key.";
options.MaxTokens = 1000;

options.Query = "What is the lowest temperature recorded on the Earth?";

var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion;

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

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
options.AddInput(new FileData("TextSource.pdf"));
options.ApiKey = "Your API key.";
options.MaxTokens = 1000;

options.Query = "How many letters in the provided text?";

var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion;

Exceptions

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

Merge(MergeOptions)

دمج ملفات PDF.

public static ResultContainer Merge(MergeOptions options)

Parameters

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

Returns

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

Examples

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

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

Exceptions

إذا لم يتم تعيين options.

Optimize(OptimizeOptions)

تحسين ملف PDF.
تحسين تدفق المستند بحيث:

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

public static ResultContainer Optimize(OptimizeOptions options)

Parameters

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

Returns

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

Examples

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

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

Exceptions

إذا لم يتم تعيين options.

Resize(ResizeOptions)

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

public static ResultContainer Resize(ResizeOptions options)

Parameters

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

Returns

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

Examples

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

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

Exceptions

إذا لم يتم تعيين options.

Rotate(RotateOptions)

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

public static ResultContainer Rotate(RotateOptions options)

Parameters

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

Returns

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

Examples

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

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

Exceptions

إذا لم يتم تعيين options.

Split(SplitOptions)

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

public static ResultContainer Split(SplitOptions options)

Parameters

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

Returns

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

Examples

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

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

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

using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream1 = new MemoryStream();
using var outputStream2 = new MemoryStream();

var options = new SplitOptions();
options.AddInput(inputStream);
options.AddOutput(outputStream1);
options.AddOutput(outputStream2);
options.CloseOutputStreams = false;
PdfManager.Split(options);

Exceptions

إذا لم يتم تعيين 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.
يعيد System.DateTime.MinValue إذا لم يكن للمستند قيمة.

public DateTime Created { get; set; }

قيمة الخاصية

DateTime

FileName

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

public string FileName { get; set; }

قيمة الخاصية

Keywords

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

public string Keywords { get; set; }

قيمة الخاصية

Modified

يحصل أو يعيّن تاريخ تعديل PDF.
يعيد System.DateTime.MinValue إذا لم يكن للمستند قيمة.

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

قيمة الخاصية

المجال: Documentize التجميع: 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.

// إنشاء كائن DecryptOptions لتحديد التعليمات
var options = new DecryptOptions("123456");
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
PdfSecurity.Decrypt(options);

الاستثناءات

إذا لم يتم تحديد options.

Encrypt(EncryptOptions)

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

public static ResultContainer Encrypt(EncryptOptions options)

المعاملات

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

الإرجاع

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

أمثلة

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

// إنشاء كائن EncryptOptions لتحديد التعليمات
var options = new EncryptOptions("123456", "qwerty");
// إضافة مسار ملف الإدخال
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
PdfSecurity.Encrypt(options);

الاستثناءات

إذا لم يتم تحديد options.

Sanitize(SanitizeOptions)

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

public static ResultContainer Sanitize(SanitizeOptions options)

المعاملات

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

الإرجاع

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

أمثلة

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

// إنشاء كائن SanitizeOptions لتحديد ملفات الإدخال والإخراج
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

// إعداد تدفقات الإدخال والإخراج
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream = new MemoryStream();
// إنشاء كائن SanitizeOptions لتحديد تدفقات الإدخال والإخراج
var options = new SanitizeOptions(inputStream, outputStream);
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

// إعداد تدفق الإخراج
using var outputStream = new MemoryStream();
// إنشاء كائن SanitizeOptions لتحديد ملف الإدخال وتدفق الإخراج
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", outputStream);
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

// إعداد تدفق الإخراج
using var outputStream = new MemoryStream();
// إنشاء كائن SanitizeOptions
var options = new SanitizeOptions();
// تعيين ملف الإدخال
options.Input = new FileData("path_to_your_pdf_file.pdf");
// تعيين تدفق الإخراج
options.Output = new StreamData(outputStream);
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

// إنشاء كائن SanitizeOptions لتحديد ملفات الإدخال والإخراج
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveMetadata = false;
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

// إنشاء كائن SanitizeOptions لتحديد ملفات الإدخال والإخراج
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveAttachments = false;
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

// إنشاء كائن SanitizeOptions لتحديد ملفات الإدخال والإخراج
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// تشغيل التحويل وتحديد DPI
options.ConvertPagesToImages = true;
options.ImageDpi = 200;
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

// إنشاء كائن SanitizeOptions لتحديد ملفات الإدخال والإخراج
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveJavaScriptsAndActions = false;
// تنفيذ العملية
PdfSecurity.Sanitize(options);

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

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

الاستثناءات

إذا لم يتم تحديد options.

Sign(SignOptions)

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

public static ResultContainer Sign(SignOptions options)

المعاملات

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

الإرجاع

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

أمثلة

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

// إنشاء كائن SignOptions لتحديد التعليمات
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// تنفيذ العملية
PdfSecurity.Sign(options);

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

// إعداد التدفقات
using var pdfStreamInput = File.OpenRead(@"path_to_your_pdf_file.pdf");
using var pfxStreamInput = File.OpenRead(@"path_to_your_pfx_file.pfx");
using var pdfStreamOutput = new MemoryStream();
// إنشاء كائن SignOptions لتحديد التعليمات
var options = new SignOptions(pdfStreamInput, pdfStreamOutput, pfxStreamInput, "password_of_your_pfx_file");
// تنفيذ العملية
PdfSecurity.Sign(options);

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

// إنشاء كائن SignOptions لتحديد التعليمات
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// تعيين مسارات ملفات الإدخال والإخراج
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// تنفيذ العملية
PdfSecurity.Sign(options);

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

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
// تعيين مسارات ملفات الإدخال والإخراج
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// تنفيذ العملية
PdfSecurity.Sign(options);

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

// إنشاء كائن SignOptions لتحديد التعليمات
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// تكوين توقيع غير مرئي
options.Visible = false;
// تنفيذ العملية
PdfSecurity.Sign(options);

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

// إنشاء كائن SignOptions لتحديد التعليمات
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf","path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// معاملات اختيارية
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// تنفيذ العملية
PdfSecurity.Sign(options);

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

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

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

// إنشاء كائن SignOptions لتحديد الطابع الزمني
var options = new SignOptions(new TimestampOptions("server_url"));
// تعيين مسارات ملفات الإدخال والإخراج
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// تنفيذ العملية
PdfSecurity.Sign(options);

الاستثناءات

PdfToHtmlOptions.SaveDataType

إذا لم يتم تحديد options.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

معلومات

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

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToDocOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToDocOptions()

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

public PdfToDocOptions()

Properties

Mode

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

public DocConversionMode Mode { get; set; }

Property Value

DocConversionMode

Remarks

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

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

Namespace: Documentize
Assembly: 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.
كلما كان الرقم أقل، زاد الضغط وبالتالي انخفضت جودة الصورة.
القيمة 0 تعطي أدنى جودة، والقيمة 100 تعطي أعلى جودة.

public int Quality { get; set; }

نوع القيمة

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

Class PdfToPdfAOptions

معلومات

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

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

الوراثة

object ←
PdfAOptionsBase ←
PdfToPdfAOptions

التنفيذ

IPluginOptions

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

المُنشئات

PdfToPdfAOptions()

public PdfToPdfAOptions()

الخصائص

Outputs

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

public List<IData> Outputs { get; }

قيمة الخاصية

الأساليب

AddOutput(IData)

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

public void AddOutput(IData data)

المعاملات

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

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

Class PdfToPngOptions

معلومات

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

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

الوراثة

object ← PluginBaseOptions ← PdfToPngOptions

التنفيذ

IPluginOptions

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

المُنشئات

PdfToPngOptions()

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

public PdfToPngOptions()

الخصائص

OutputResolution

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

public int OutputResolution { get; set; }

قيمة الخاصية

PageList

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

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

قيمة الخاصية

List<int>

النطاق: Documentize
التجميعة: 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>

المجال: Documentize
التجميع: 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

الوراثة

object ← PluginBaseOptions

المشتقة

تنفيذ

IPluginOptions

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

الخصائص

CloseInputStreams

إغلاق التيارات الواردة بعد اكتمال العملية.

public bool CloseInputStreams { get; set; }

قيمة الخاصية

CloseOutputStreams

إغلاق التيارات الصادرة بعد اكتمال العملية.

public bool CloseOutputStreams { get; set; }

قيمة الخاصية

Inputs

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

public List<IData> Inputs { get; }

قيمة الخاصية

Outputs

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

public List<IData> Outputs { get; }

قيمة الخاصية

الطرق

AddInput(IData)

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

public void AddInput(IData data)

المعلمات

data IData: البيانات التي تُضاف.

AddOutput(IData)

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

public void AddOutput(IData data)

المعلمات

data IData: البيانات التي تُضاف.

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

الاستثناءات

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

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

Class Rectangle

معلومات

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

public class Rectangle

الوراثة

object ← Rectangle

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

المُنشئات

Rectangle(double, double, double, double)

منشئ الـ Rectangle.

public Rectangle(double llx, double lly, double urx, double ury)

المعلمات

llx double: إحداثي X للزاوية السفلية اليسرى.
lly double: إحداثي Y للزاوية السفلية اليسرى.
urx double: إحداثي X للزاوية العليا اليمنى.
ury double: إحداثي Y للزاوية العليا اليمنى.

النطاق: Documentize التجميع: 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>

النطاق: Documentize
التجميع: 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

Inheritance

object ← OptionsWithInput ← OptionsWithInputAndOutput ← SanitizeOptions

Implements

IHaveInput

Inherited Members

Constructors

SanitizeOptions()

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

public SanitizeOptions()

SanitizeOptions(IData, IData)

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

public SanitizeOptions(IData inputData, IData outputData = null)

Parameters

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

SanitizeOptions(string, string)

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

public SanitizeOptions(string inputFile, string outputFile)

Parameters

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

SanitizeOptions(Stream, Stream)

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

public SanitizeOptions(Stream inputStream, Stream outputStream)

Parameters

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

SanitizeOptions(string, Stream)

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

public SanitizeOptions(string inputFile, Stream outputStream)

Parameters

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

SanitizeOptions(Stream, string)

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

public SanitizeOptions(Stream inputStream, string outputFile)

Parameters

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

Properties

ConvertPagesToImages

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

public bool ConvertPagesToImages { get; set; }

Property Value

FlattenForms

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

public bool FlattenForms { get; set; }

Property Value

FlattenLayers

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

public bool FlattenLayers { get; set; }

Property Value

ImageDpi

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

public int ImageDpi { get; set; }

Property Value

Input

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

public override IData Input { get; set; }

Property Value

Output

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

public override IData Output { get; set; }

Property Value

RemoveAnnotations

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

public bool RemoveAnnotations { get; set; }

Property Value

RemoveAttachments

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

public bool RemoveAttachments { get; set; }

Property Value

RemoveJavaScriptsAndActions

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

public bool RemoveJavaScriptsAndActions { get; set; }

Property Value

RemoveMetadata

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

public bool RemoveMetadata { get; set; }

Property Value

RemoveSearchIndexAndPrivateInfo

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

public bool RemoveSearchIndexAndPrivateInfo { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class Security

معلومات

يمثل المكوّن الإضافي Documentize.Security. يُستخدم لتشفير وفك تشفير مستندات PDF.

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

الوراثة

object ←
Security

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

الدوال

Process(EncryptOptions)

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

public static ResultContainer Process(EncryptOptions options)

المعاملات

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

الإرجاع

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

الاستثناءات

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

Process(DecryptOptions)

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

public static ResultContainer Process(DecryptOptions options)

المعاملات

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

الإرجاع

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

الاستثناءات

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

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

Class Signature

معلومات

يمثل مكوّن Documentize.Signature. يُستخدم لتوقيع مستندات PDF.

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

الوراثة

object ← Signature

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

الطرق

Process(SignOptions)

توقيع مستند PDF.

public static ResultContainer Process(SignOptions options)

المعاملات

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

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

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

الاستثناءات

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

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

Class SignOptions

معلومات

يمثل خيارات التوقيع لمكون Documentize.PdfSecurity.

public sealed class SignOptions : OptionsWithInputAndOutput, IHaveInput

الوراثة

object ← OptionsWithInput ← OptionsWithInputAndOutput ← SignOptions

التنفيذ

IHaveInput

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

المنشئون

SignOptions(Stream, string)

إنشاء كائن جديد من Documentize.SignOptions مع تحديد تدفق pfx وكلمة المرور.

public SignOptions(Stream pfx, string password)

المعلمات

pfx Stream: تدفق يحتوي على ملف pfx.
password string: كلمة المرور لملف pfx.

SignOptions(string, string)

إنشاء كائن جديد من Documentize.SignOptions مع تحديد ملف pfx وكلمة المرور.

public SignOptions(string pfx, string password)

المعلمات

pfx string: مسار ملف pfx.
password string: كلمة المرور لملف pfx.

SignOptions(IData, IData, IData, string)

إنشاء كائن جديد من Documentize.SignOptions مع تحديد بيانات الإدخال، الإخراج، pfx وكلمة المرور.

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

المعلمات

inputData IData: بيانات الإدخال.
outputData IData: بيانات الإخراج.
pfxData IData: بيانات ملف pfx.
password string: كلمة المرور للملف.

SignOptions(string, string, string, string)

إنشاء كائن جديد من Documentize.SignOptions مع تحديد ملفات الإدخال، الإخراج، pfx وكلمة المرور.

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

المعلمات

inputFile string: مسار ملف الإدخال.
outputFile string: مسار ملف الإخراج.
pfxFile string: مسار ملف pfx.
pfxPassword string: كلمة المرور للملف.

SignOptions(Stream, Stream, Stream, string)

إنشاء كائن جديد من Documentize.SignOptions مع تحديد تدفقات الإدخال، الإخراج، pfx والكلمة السرية.

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

المعلمات

inputStream Stream: تدفق ملف الإدخال.
outputStream Stream: تدفق ملف الإخراج.
pfxStream Stream: تدفق ملف pfx.
pfxPassword string: كلمة المرور للملف.

SignOptions(TimestampOptions)

إنشاء كائن جديد من Documentize.SignOptions مع تحديد Timestamp. يمكنك تعيين الطابع الزمني للمستند كتوقيع منفصل.

public SignOptions(TimestampOptions timestampOptions)

المعلمات

timestampOptions TimestampOptions: يُستخدم الطابع الزمني لإنشاء توقيع طابع زمني دون الحاجة إلى شهادة.

الخصائص

Contact

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

public string Contact { get; set; }

نوع الخاصية

Input

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

public override IData Input { get; set; }

نوع الخاصية

Location

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

public string Location { get; set; }

نوع الخاصية

Name

اسم حقل التوقيع الموجود. Null لإنشاء حقل جديد.

public string Name { get; set; }

نوع الخاصية

Output

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

public override IData Output { get; set; }

نوع الخاصية

PageNumber

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

public int PageNumber { get; set; }

نوع الخاصية

Pfx

التدفق الذي يحتوي على بيانات PFX.

public Stream Pfx { get; set; }

نوع الخاصية

Stream

PfxPassword

كلمة المرور الخاصة بـ Documentize.SignOptions.Pfx.

public string PfxPassword { get; set; }

نوع الخاصية

Reason

سبب التوقيع.

public string Reason { get; set; }

نوع الخاصية

Rectangle

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

public Rectangle Rectangle { get; set; }

نوع الخاصية

Rectangle

TimestampOptions

خيارات الطابع الزمني. يُستخدم الطابع الزمني لإنشاء توقيع طابع زمني دون الحاجة إلى شهادة. إذا تم تعيين الخاصية وتم توفير شهادة إلى منشئ Documentize.SignOptions، سيتم إضافة طابع زمني مدمج إلى التوقيع الرقمي. إذا تم تعيين الخاصية ولكن لم تُوفر شهادة إلى المنشئ، سيُضاف الطابع الزمني كتوقيع منفصل.

public TimestampOptions TimestampOptions { get; set; }

نوع الخاصية

TimestampOptions

Visible

رؤية التوقيع. القيمة الافتراضية هي true.

public bool Visible { get; set; }

نوع الخاصية

Namespace: Documentize
Assembly: Documentize.dll

Class SplitOptions

معلومات

يمثل خيارات التقسيم لمكوّن Documentize.PdfManager.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← SplitOptions

Implements

IPluginOptions

Inherited Members

Constructors

SplitOptions()

Initializes a new instance of the Documentize.SplitOptions object with default options.

public SplitOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Splitter

معلومات

يمثل إضافة Documentize.Splitter. يُستخدم لتقسيم مستندات PDF إلى صفحات منفصلة.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
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

الوراثة

object ← StreamData

التنفيذ

IData

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

المنشئات

StreamData(Stream)

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

public StreamData(Stream data)

المعلمات

data Stream: كائن التيار

الخصائص

Data

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

public Stream Data { get; }

قيمة الخاصية

Stream

DataType

نوع البيانات (تيار).

public DataType DataType { get; }

قيمة الخاصية

نطاق الاسم: Documentize التجميع: 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 StringResult

معلومات

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

public sealed class StringResult : IOperationResult

Inheritance

object ← StringResult

Implements

IOperationResult

Inherited Members

Properties

Data

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

public object Data { get; }

Property Value

IsFile

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

public bool IsFile { get; }

Property Value

IsStream

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

public bool IsStream { get; }

Property Value

IsString

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

public bool IsString { get; }

Property Value

Text

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

public string Text { get; }

Property Value

Methods

ToFile()

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

public string ToFile()

Returns

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

ToStream()

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

public Stream ToStream()

Returns

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

ToString()

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

public override string ToString()

Returns

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

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

Class TableBuilder

معلومات

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

public class TableBuilder

Inheritance

object ← TableBuilder

Derived

TableRowBuilder

Inherited Members

Methods

AddRow()

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

public virtual TableRowBuilder AddRow()

Returns

TableRowBuilder : نسخة من Documentize.TableRowBuilder الحالي.

AddTable()

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

public TableBuilder AddTable()

Returns

TableBuilder : نسخة من Documentize.TableBuilder الحالي.

InsertPageAfter(int)

إدراج صفحة بعد الصفحة المحددة.

public TableOptions InsertPageAfter(int page)

Parameters

page int: رقم الصفحة التي يُراد إدراج الجدول بعدها.

Returns

TableOptions : نسخة من Documentize.TableOptions الحالي.

InsertPageBefore(int)

إدراج صفحة قبل الصفحة المحددة.

public TableOptions InsertPageBefore(int page)

Parameters

page int: رقم الصفحة التي يُراد إدراج الجدول قبلها.

Returns

TableOptions : نسخة من Documentize.TableOptions الحالي.

Operators

implicit operator TableOptions(TableBuilder)

تحويل منشئ Documentize.TableBuilder إلى خيارات Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)

Parameters

builder TableBuilder: نسخة من Documentize.TableBuilder الحالي.

Returns

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 الحالية.

المساحة الاسمية: Documentize
التجميع: 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 plugin.

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 الحالية.

المساحة الاسمية: Documentize
التجميع: 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

الوراثة

object ← TiffConverter

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

الطرق

Process(PdfToTiffOptions)

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

public static ResultContainer Process(PdfToTiffOptions options)

المعاملات

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

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

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

الاستثناءات

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

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

قيمة الخاصية

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

Class TocGenerator

معلومات

يمثل مكون Documentize.TocGenerator. يُستخدم لإضافة جدول محتويات إلى مستندات PDF.

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

الوراثة

object ← TocGenerator

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

أمثلة

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

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new 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);

يوضح المثال كيفية إضافة جدول محتويات إلى ملف 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
TocGenerator.Process(options);

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

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Add input file path
options.AddInput(new 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; }

قيمة الخاصية

المجال: Documentize المجمع: 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; }

قيمة الخاصية

Namespace: Documentize
Assembly: Documentize.dll

Class Usage

معلومات

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

public class Usage

Inheritance

الوراثة

object ← Usage

Inherited Members

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

Constructors

المُنشئات

Usage()

public Usage()

Properties

الخصائص

CompletionTokens

عدد الرموز في النص المُولد.

[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }

Property Value

قيمة الخاصية

PromptTokens

عدد الرموز في الطلب.

[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }

Property Value

قيمة الخاصية

TotalTokens

العدد الإجمالي للرموز المستخدمة في الطلب (الطلب + الإكمال).

[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }

Property Value

قيمة الخاصية

Namespace: Documentize Assembly: 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

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

Enum ConvertSoftMaskAction

معلومات

تمثل هذه العملية إجراءات تحويل الصور ذات القناع الناعم.

public enum ConvertSoftMaskAction

Fields

ConvertToStencilMask = 1: سيتم تحويل القناع الناعم إلى قناع استنسل.
Default = 0: استخدم الاستراتيجية الافتراضية.

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

Enum DataType

معلومات

يمثل الأنواع المحتملة للبيانات لمعالجة المكوّن.

public enum DataType

الحقول

Directory = 2: نوع البيانات هو دليل يُمثَّل بالمسار الخاص به.
File = 0: نوع البيانات هو ملف يُمثَّل بالمسار الخاص به.
Stream = 1: نوع البيانات هو تدفق.

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

Enum DocConversionMode

معلومات

يحدد وضع التحويل للمستند الناتج.

public enum DocConversionMode
{
    // members defined below
}

الحقول

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: شاشة.

النطاق: Documentize التجميع: 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.

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

Enum PdfToHtmlOptions.SaveDataType

معلومات

تحدد نوع إخراج ملف HTML.

public enum PdfToHtmlOptions.SaveDataType

الحقول

FileWithEmbeddedResources = 1: حفظ HTML إلى ملف مع موارد مدمجة
FileWithExternalResources = 0: حفظ HTML إلى ملف مع موارد خارجية
StreamWithEmbeddedResources = 2: حفظ HTML إلى تدفق ملف مع موارد مدمجة

Namespace: Documentize
Assembly: Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

معلومات

يسمح بتحديد تنسيق ملف xls/xlsx/xml/csv. القيمة الافتراضية هي XLSX.

يسمح بتحديد تنسيق ملف xls/xlsx/xml/csv.
القيمة الافتراضية هي XLSX.

public enum PdfToXlsOptions.ExcelFormat

الحقول

CSV = 2: تنسيق ملف القيم المفصولة بفواصل (.csv).
ODS = 4: جدول بيانات مستند مفتوح (Open Document Spreadsheet).
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

الحقول

Assistant = 2
System = 1
User = 0

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

Enum Rotation

معلومات

عدد القيم الممكنة للدوران.

public enum Rotation

الحقول

None = 0: غير مُدوَّر.
On180 = 2: مُدوَّر بزاوية 180 درجة.
On270 = 3: مُدوَّر بزاوية 270 درجة مع عقرب الساعة.
On360 = 4: مُدوَّر بزاوية 360 درجة مع عقرب الساعة.
On90 = 1: مُدوَّر بزاوية 90 درجة مع عقرب الساعة.

المساحة الاسمية: Documentize
التجميع: 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

الحقول

Flatten = 2: تمثيل محتوى PDF مع تجزئات نصية موضعية حسب إحداثياتها. وهو مشابه أساسًا لوضع “Raw”. لكن بينما يركز “Raw” على الحفاظ على بنية تجزئات النص (العوامل) في المستند، يركز “Flatten” على الحفاظ على النص بالترتيب الذي يُقرأ به.
Pure = 0: يمثل محتوى نص PDF مع بعض الروتينات التنسيقية. ويتضمن أخذ المواقع النسبية في الاعتبار وإضافة مسافات إضافية لمحاذاة النص إلى عرض الصفحة.
Raw = 1: يمثل محتوى PDF كما هو، أي بدون تنسيق.

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

Enum TiffColorDepth

معلومات

يُستخدم لتحديد عمق اللون لخيار Documentize.PdfToTiffOptions.

public enum TiffColorDepth

الحقول

Format1bpp = 4: 1 بت لكل بكسل.
Format24bpp = 1: 24 بت لكل بكسل. RGB.
Format32bpp = 0: 32 بت لكل بكسل. يُستخدم بشكل افتراضي.
Format4bpp = 3: 4 بت لكل بكسل.
Format8bpp = 2: 8 بت لكل بكسل.

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

Enum TiffCompression

معلومات

يُستخدم لتحديد نوع الضغط لـ Documentize.PdfToTiffOptions.

public enum TiffCompression

Fields

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

الخصائص

DataType

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

DataType DataType { get; }

قيمة الخاصية

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

Interface IDataSource

معلومات

واجهة بيانات عامة تحدد الأعضاء المشتركين التي ينبغي أن تنفذها البيانات الملموسة.

public interface IDataSource

الخصائص

DataType

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

DataType DataType { get; }

قيمة الخاصية

Namespace: Documentize Assembly: Documentize.dll

Interface IHaveInput

معلومات

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

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

قيمة الخاصية