Documentize Namespace

Classes

Class NameDescription
AddTimestampOptionsتمثل خيارات إضافة الطابع الزمني لملحق Documentize.Timestamp.
CompressOptionsتمثل خيارات الضغط لملحق Documentize.PdfManager.
DecryptionOptionsتمثل خيارات فك التشفير لملحق Documentize.Security.
DirectoryDataSourceتمثل بيانات الدليل لعمليات التحميل والحفظ لملحق.
DocConverterتمثل ملحق Documentize.DocConverter. يستخدم لتحويل مستندات PDF إلى تنسيق DOC/DOCX.
EncryptionOptionsتمثل خيارات التشفير لملحق Documentize.Security.
ExtractFormDataToDsvOptionsتمثل خيارات تصدير قيم الحقول لملحق Documentize.PdfExtractor.
ExtractImagesOptionsتمثل خيارات استخراج الصور لملحق Documentize.PdfExtractor.
ExtractTextOptionsتمثل خيارات استخراج النص لملحق Documentize.PdfExtractor.
FileDataSourceتمثل بيانات الملف لعمليات التحميل والحفظ لملحق.
FileResultتمثل نتيجة العملية في شكل مسار نصي إلى الملف.
FormExporterتمثل ملحق Documentize.FormExporter. يستخدم لتصدير قيم النموذج لمستندات PDF إلى ملف DSV أو CSV.
FormFlattenerتمثل ملحق Documentize.FormFlattener. يستخدم لتسوية الحقول في مستندات PDF.
FormFlattenerOptionsتمثل خيارات تسوية الحقول في المستند بواسطة ملحق Documentize.FormFlattener.
HtmlConverterتمثل ملحق Documentize.HtmlConverter. يستخدم لتحويل مستندات PDF إلى تنسيق HTML ومستندات HTML إلى تنسيق PDF.
HtmlToPdfOptionsتمثل خيارات تحويل HTML إلى PDF لملحق Documentize.HtmlConverter.
ImageExtractorتمثل ملحق Documentize.ImageExtractor. يستخدم لاستخراج الصور من مستندات PDF.
Infoتوفر هذه الفئة معلومات حول بناء المنتج الحالي.
JpegConverterتمثل ملحق Documentize.JpegConverter. يستخدم لتحويل مستندات PDF إلى تنسيق JPEG.
Licenseيوفر طريقة لتعيين الترخيص.
MergeOptionsتمثل خيارات الدمج لملحق Documentize.PdfManager.
Mergerتمثل ملحق Documentize.Merger. يستخدم لدمج مستندات PDF متعددة في مستند PDF واحد.
Messageرسالة إكمال محادثة تم إنشاؤها بواسطة النموذج.
ObjectResultتمثل نتيجة العملية في شكل نص.
OptimizeOptionsتمثل خيارات التحسين لملحق Documentize.PdfManager.
Optimizerتمثل ملحق Documentize.Optimizer. يستخدم للتحسين، والدوران، وإعادة الحجم، وضغط مستندات PDF.
PageInfoتمثل معلومات الصفحة.
PageSizeفئة تمثل حجم الصفحة في مستند PDF.
PdfAConvertOptionsتمثل خيارات تحويل مستندات PDF إلى تنسيق PDF/A باستخدام ملحق Documentize.PdfAConverter.
PdfAConverterتمثل ملحق للتعامل مع تحويل مستندات PDF إلى تنسيق PDF/A ومن أجل التحقق من التوافق مع PDF/A.
PdfAOptionsBaseتمثل الفئة الأساسية لخيارات ملحق Documentize.PdfAConverter. توفر هذه الفئة خصائص وأساليب لتكوين عملية تحويل وتحقق PDF/A.
PdfAValidateOptionsتمثل خيارات للتحقق من امتثال مستندات PDF/A باستخدام ملحق Documentize.PdfAConverter.
PdfAValidationResultتمثل نتيجة عملية التحقق من PDF/A.
PdfChatGptتمثل ملحق PdfChatGpt.
PdfChatGptOptionsتمثل خيارات لملحق Documentize.PdfChatGpt.
PdfChatGptRequestOptionsتمثل خيارات لملحق Documentize.PdfChatGpt.
PdfConverterOptionsتمثل خيارات لملحقات تحويل PDF.
PdfExtractorتمثل ملحق Documentize.PdfExtractor. يستخدم لاستخراج النصوص، والصور، وبيانات النموذج من مستندات PDF.
PdfManagerتمثل ملحق Documentize.PdfManager. يستخدم لدمج، تقسيم، تحسين، تدوير، إعادة حجم، وضغط مستندات PDF وإضافة جدول، وإضافة جدول محتويات لمستندات PDF. يمكن دمج مستندات PDF متعددة في مستند PDF واحد. يمكن تقسيم مستندات PDF إلى صفحات منفصلة. يمكن تحسين، تدوير، إعادة حجم، وضغط مستندات PDF. يمكن تدوير وإعادة حجم صفحات مستند PDF. يمكن إضافة جدول لمستند PDF. يمكن إضافة جدول محتويات لمستندات PDF.
PdfToDocOptionsتمثل خيارات تحويل PDF إلى DOC لملحق Documentize.DocConverter.
PdfToHtmlOptionsتمثل خيارات تحويل PDF إلى HTML لملحق Documentize.HtmlConverter.
PdfToJpegOptionsتمثل خيارات تحويل PDF إلى JPEG لملحق Documentize.JpegConverter.
PdfToPngOptionsتمثل خيارات تحويل PDF إلى PNG لملحق Documentize.PngConverter.
PdfToTiffOptionsتمثل خيارات تحويل PDF إلى TIFF لملحق Documentize.TiffConverter.
PdfToXlsOptionsتمثل خيارات تحويل PDF إلى XLS/XLSX لملحق Documentize.XlsConverter.
PluginBaseOptionsتمثل الخيارات الأساسية للملحقات.
PngConverterتمثل ملحق Documentize.PngConverter. يستخدم لتحويل مستندات PDF إلى تنسيق PNG.
Rectangleفئة تمثل المستطيل.
ResizeOptionsتمثل خيارات إعادة الحجم لملحق Documentize.PdfManager.
ResultContainerتمثل الحاوية التي تحتوي على مجموعة النتائج لمعالجة الملحق.
RotateOptionsتمثل خيارات التدوير لملحق Documentize.PdfManager.
Securityتمثل ملحق Documentize.Security. يستخدم لتشفير وفك تشفير مستندات PDF.
SignOptionsتمثل خيارات التوقيع لملحق Documentize.Signature.
Signatureتمثل ملحق Documentize.Signature. يستخدم لتوقيع مستندات PDF.
SplitOptionsتمثل خيارات التقسيم لملحق Documentize.PdfManager.
Splitterتمثل ملحق Documentize.Splitter. يستخدم لتقسيم مستندات PDF إلى صفحات منفصلة.
StreamDataSourceتمثل مصدر بيانات التدفق لعمليات التحميل والحفظ لملحق.
StreamResultتمثل نتيجة العملية في شكل تدفق.
StringResultتمثل نتيجة العملية في شكل نص.
TableBuilderفئة تمثل الباني لجدول في صفحة PDF.
TableCellBuilderفئة تمثل الباني لخلية الجدول.
TableGeneratorتمثل ملحق Documentize.TableGenerator. يستخدم لإضافة جدول إلى مستند PDF.
TableOptionsتمثل خيارات إضافة جدول إلى المستند بواسطة ملحق Documentize.PdfManager.
TableRowBuilderفئة تمثل الباني لصف الجدول.
TextExtractorتمثل ملحق Documentize.TextExtractor. يستخدم لاستخراج النص من مستندات PDF.
TiffConverterتمثل ملحق Documentize.TiffConverter. يستخدم لتحويل مستندات PDF إلى تنسيق TIFF.
Timestampتمثل ملحق Documentize.Timestamp. يستخدم لإضافة الطابع الزمني إلى الوثيقة.
TocGeneratorتمثل ملحق Documentize.TocGenerator. يستخدم لإضافة جدول محتويات لمستندات PDF.
TocHeadingتمثل خيارات العناوين أو العناوين لجدول المحتويات للمستند بواسطة ملحق Documentize.PdfManager.
TocOptionsتمثل خيارات إضافة جدول محتويات للمستند بواسطة ملحق Documentize.PdfManager.
XlsConverterتمثل ملحق Documentize.XlsConverter. يستخدم لتحويل مستندات PDF إلى تنسيقات XLSX/XLS/CSV/XLSM/ODS.

Interfaces

Interface NameDescription
IDataSourceواجهة بيانات عامة تحدد الأعضاء المشتركين الذين يجب أن تنفذها البيانات الملموسة.
IOperationResultواجهة نتيجة العملية العامة التي تحدد الأساليب المشتركة التي يجب أن تنفذها نتيجة عملية الملحق الملموسة.
IPluginOptionsواجهة خيارات الملحق العامة التي تحدد الأساليب المشتركة التي يجب أن تنفذها خيارات الملحق الملموسة.

Enums

Enum NameDescription
ConvertErrorActionتمثل هذه الفئة الإجراء للأخطاء في التحويل.
ConvertSoftMaskActionيمثل هذا الإجراء الإجراءات لتحويل الصور ذات القناع الناعم.
DataTypeتمثل الأنواع المحتملة للبيانات لعملية الملحق.
DocConversionModeتحدد وضع التحويل للمستند الناتج.
PdfToXlsOptions.ExcelFormatيسمح بتحديد تنسيق ملف xls/xlsx/xml/csv. القيمة الافتراضية هي XLSX.
HtmlMediaTypeتحدد أنواع الوسائط المحتملة المستخدمة أثناء العرض.
HtmlPageLayoutOptionتحدد العلامات التي تحدد مع بعضها خيارات أخرى أحجام وتخطيطات الصفحات.
PdfAStandardVersionتحدد نسخة معيار PDF/A لمستند PDF.
Roleدور مؤلف الرسائل.
Rotationتعداد لقيم التدوير المحتملة.
PdfToHtmlOptions.SaveDataTypeتحدد نوع المخرجات لملف HTML.
TextFormattingModeتحدد الأوضاع المختلفة التي يمكن استخدامها أثناء تحويل مستند PDF إلى نص. انظر فئة Documentize.ExtractTextOptions.
TiffColorDepthتستخدم لتحديد عمق اللون لخيارات Documentize.PdfToTiff.
TiffCompressionتستخدم لتحديد نوع الضغط لخيارات Documentize.PdfToTiff.

Documentize Namespace الأقسام الفرعية

Class AddTimestampOptions

معلومات

يمثل خيارات إضافة الطابع الزمني لملحق Documentize.Timestamp.

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsAddTimestampOptions

التطبيقات

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

المنشئات

AddTimestampOptions(Stream, string, string, string)

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

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

المعلمات

  • pfx Stream: المسار إلى ملف pfx.
  • password string: كلمة المرور لملف pfx.
  • serverUrl string: عنوان خادم الطراز الزمني.
  • serverBasicAuthCredentials string: بيانات اعتماد المصادقة الأساسية، حيث يتم دمج اسم المستخدم وكلمة المرور في سلسلة “username:password”. (اختياري).

AddTimestampOptions(string, string, string, string)

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

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

المعلمات

  • pfx string: المسار إلى ملف pfx.
  • password string: كلمة المرور لملف pfx.
  • serverUrl string: عنوان خادم الطراز الزمني.
  • serverBasicAuthCredentials string: بيانات اعتماد المصادقة الأساسية، حيث يتم دمج اسم المستخدم وكلمة المرور في سلسلة “username:password”. (اختياري).

Namespace: Documentize Assembly: Documentize.dll

Class CompressOptions

معلومات

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

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsCompressOptions

التطبيقات

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

البانيون

CompressOptions()

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

public CompressOptions()

Namespace: Documentize Assembly: Documentize.dll

Class DecryptionOptions

معلومات

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

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsDecryptionOptions

التنفيذات

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

البانيين

DecryptionOptions(string)

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

public DecryptionOptions(string ownerPassword)

المعلمات

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

الخصائص

OwnerPassword

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

public string OwnerPassword { get; set; }

قيمة الخاصية

string

Namespace: Documentize Assembly: Documentize.dll

Class DirectoryDataSource

معلومات

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

public sealed class DirectoryDataSource : IDataSource

Inheritance

objectDirectoryDataSource

Implements

Inherited Members

Constructors

DirectoryDataSource(string)

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

public DirectoryDataSource(string path)

Parameters

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

Properties

DataType

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

public DataType DataType { get; }

Property Value

DataType

Path

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

public string Path { get; }

Property Value

string

Namespace: Documentize Assembly: Documentize.dll

Class DocConverter

معلومات

يمثل مكون Documentize.DocConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق DOC/DOCX.

public static class DocConverter

الوراثة

objectDocConverter

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

أمثلة

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

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

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

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

طرق

Process(PdfToDocOptions)

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

public static ResultContainer Process(PdfToDocOptions options)

المعاملات

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

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

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class EncryptionOptions

معلومات

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

public class EncryptionOptions : PluginBaseOptions, IPluginOptions  

الوراثة

object
PluginBaseOptions
EncryptionOptions

التنفيذ

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

البناة

EncryptionOptions(string, string)

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

public EncryptionOptions(string ownerPassword, string userPassword)  

المعلمات

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

الخصائص

OwnerPassword

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

public string OwnerPassword { get; set; }  

قيمة الخاصية

string

UserPassword

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

public string UserPassword { get; set; }  

قيمة الخاصية

string

namespace: Documentize
Assembly: Documentize.dll

Class ExtractFormDataToDsvOptions

معلومات

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

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsExtractFormDataToDsvOptions

التنفيذ

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

المنشئات

ExtractFormDataToDsvOptions(char, bool)

يهيئ مثيلاً جديدًا من كائن Documentize.ExtractFormDataToDsvOptions.

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

المعاملات

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

الخصائص

AddFieldName

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

public bool AddFieldName { get; set; }

قيمة الخاصية

bool

Delimeter

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

public char Delimeter { get; set; }

قيمة الخاصية

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

معلومات

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

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsExtractImagesOptions

التنفيذ

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

البناة

ExtractImagesOptions()

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

public ExtractImagesOptions()

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

Class ExtractTextOptions

معلومات

تمثل خيارات استخراج النص لـ Documentize.PdfExtractor.

public sealed class ExtractTextOptions

الوراثة

objectExtractTextOptions

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

المنشئات

ExtractTextOptions(TextFormattingMode)

يبدأ مثيلًا جديدًا من كائن Documentize.ExtractTextOptions لوضع تنسيق النص المحدد.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

المعلمات

الخصائص

FormattingMode

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

public TextFormattingMode FormattingMode { get; set; }

قيمة الخاصية

TextFormattingMode

Inputs

يعود ببيانات المدخلات للعملية.

public List<idatasource> Inputs { get; }

قيمة الخاصية

List<IDataSource>

الطرق

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

المعلمات

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

Namespace: Documentize Assembly: Documentize.dll

Class FileDataSource

معلومات

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

public sealed class FileDataSource : IDataSource

الوراثة

objectFileDataSource

ينفذ

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

المُنشئات

FileDataSource(string)

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

public FileDataSource(string path)

المعلمات

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

الخصائص

DataType

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

public DataType DataType { get; }

قيمة الخاصية

DataType

Path

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

public string Path { get; }

قيمة الخاصية

string

Namespace: Documentize Assembly: Documentize.dll

Class FileResult

معلومات

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

public sealed class FileResult : IOperationResult

الوراثة

objectFileResult

تنفذ

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

الخصائص

البيانات

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

public object Data { get; }

قيمة الخاصية

object

IsFile

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

public bool IsFile { get; }

قيمة الخاصية

bool

IsStream

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

public bool IsStream { get; }

قيمة الخاصية

bool

IsString

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

public bool IsString { get; }

قيمة الخاصية

bool

الطرق

ToFile()

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

public string ToFile()

يعيد

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

ToStream()

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

public Stream ToStream()

يعيد

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

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

Class FormExporter

معلومات

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

[Obsolete("يرجى استخدام فئة PdfExtractor. سيتم حذف الفئة قريبًا.")]
public static class FormExporter

وراثة

objectFormExporter

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

الطرق

Process(ExtractFormDataToDsvOptions)

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

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

المعاملات

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class FormExportToDsvOptions

معلومات

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

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsFormExportToDsvOptions

التنفيذ

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

المنشئات

FormExportToDsvOptions(char, bool)

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

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

المعلمات

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

الخصائص

AddFieldName

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

public bool AddFieldName { get; set; }

قيمة الخاصية

bool

Delimeter

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

public char Delimeter { get; set; }

قيمة الخاصية

char

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattener

معلومات

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

public static class FormFlattener

الوراثة

objectFormFlattener

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

أمثلة

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

// إنشاء كائن FormFlattenerOptions لتعيين التعليمات
var options = new FormFlattenerOptions();
// إضافة مسار الملف المدخل
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار الملف الناتج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
FormFlattener.Process(options);

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

// الحصول على أسماء الحقول
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// إنشاء كائن FormFlattenerOptions لتعيين التعليمات
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تخطي 1 حقل.
options.SkipFields.Add(fieldNames[0]);
// تنفيذ العملية
FormFlattener.Process(options);

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

// الحصول على أسماء الحقول
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

الطرق

GetFieldNames(string)

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

public static List<string> GetFieldNames(string path)

المعاملات

  • path string: المسار إلى مستند PDF.

النتائج

List<string>

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

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

public static List<string> GetFieldNames(Stream stream)

المعاملات

  • stream Stream: الدفق مع مستند PDF.

النتائج

List<string>

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

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

public static ResultContainer Process(FormFlattenerOptions options)

المعاملات

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

النتائج

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattenerOptions

معلومات

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

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsFormFlattenerOptions

تنفيذ

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

المنشئات

FormFlattenerOptions()

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

public FormFlattenerOptions()

الخصائص

SkipFields

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

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

قيمة الخاصية

List<string>

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

Class HtmlConverter

معلومات

يمثل ملحق Documentize.HtmlConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق HTML ومسوّدات HTML إلى تنسيق PDF.

public static class HtmlConverter

الوراثة

objectHtmlConverter

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

أمثلة

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

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

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

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

الطرق

Process(PdfToHtmlOptions)

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

public static ResultContainer Process(PdfToHtmlOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Process(HtmlToPdfOptions)

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

public static ResultContainer Process(HtmlToPdfOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

معلومات

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

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsHtmlToPdfOptions

تطبيقات

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

المُنشئون

HtmlToPdfOptions()

يقوم بتهيئة مثيل جديد من كائن Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

الخصائص

BasePath

مسار/رابط الأساس لملف html.

public string BasePath { get; set; }

قيمة الخاصية

string

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

قيمة الخاصية

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

قيمة الخاصية

bool

PageInfo

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

public PageInfo PageInfo { get; set; }

قيمة الخاصية

PageInfo

PageLayoutOption

يحصل على أو يحدد خيار التخطيط.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

قيمة الخاصية

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

معلومات

يمثل ملحق Documentize.ImageExtractor. يُستخدم لاستخراج الصور من مستندات PDF.

[Obsolete("يرجى استخدام فئة PdfExtractor. ستتم إزالة هذه الفئة قريبًا.")]
public static class ImageExtractor

الوراثة

objectImageExtractor

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

الأساليب

Process(ExtractImagesOptions)

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

public static ResultContainer Process(ExtractImagesOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractorOptions

معلومات

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

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsImageExtractorOptions

التنفيذات

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

المنشآت

ImageExtractorOptions()

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

public ImageExtractorOptions()

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

Class JpegConverter

معلومات

يمثل مكون Documentize.JpegConverter. يُستخدم لتحويل مستندات PDF إلى صيغة JPEG.

public static class JpegConverter

الوراثة

objectJpegConverter

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

الأمثلة

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

// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToJpegOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تعيين مسار دليل الإخراج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
JpegConverter.Process(options);

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

// إنشاء كائن PdfToJpegOptions لتحديد التعليمات
var options = new PdfToJpegOptions();
// معالجة الصفحة الأولى فقط
options.PageList = [1];
// تعيين دقة الإخراج إلى 200 DPI
options.OutputResolution = 200;
// تعيين جودة الإخراج إلى 50
options.Quality = 50;
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تعيين مسار دليل الإخراج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
JpegConverter.Process(options);

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

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

الطرق

Process(PdfToJpegOptions)

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

public static ResultContainer Process(PdfToJpegOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class License

معلومات

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

public static class License

الوراثة

objectLicense

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

أمثلة

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

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

الوراثة

objectPluginBaseOptionsMergeOptions

تنفذ

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

المُنشئون

MergeOptions()

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

public MergeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Merger

معلومات

يمثل مكون Documentize.Merger. يستخدم لدمج مستندات PDF متعددة في ملف PDF واحد.

[Obsolete("يرجى استخدام فئة PdfManager. سيتم حذف الفئة قريبًا.")]
public static class Merger

الوراثة

objectMerger

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

الأساليب

Process(MergeOptions)

دمج مستندات PDF.

public static ResultContainer Process(MergeOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

إذا لم يتم ضبط الخيارات.

Namespace: Documentize Assembly: Documentize.dll

Class Message

معلومات

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

public class Message

الوراثة

objectMessage

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

المنشئات

Message()

public Message()

الخصائص

المحتوى

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

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

قيمة الخاصية

string

الدور

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

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

قيمة الخاصية

Role

Namespace: Documentize Assembly: Documentize.dll

Class ObjectResult

معلومات

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

public sealed class ObjectResult : IOperationResult

الوراثة

objectObjectResult

ينفذ

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

الخصائص

البيانات

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

public object Data { get; }

قيمة الخاصية

object

IsFile

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

public bool IsFile { get; }

قيمة الخاصية

bool

IsObject

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

public bool IsObject { get; }

قيمة الخاصية

bool

IsStream

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

public bool IsStream { get; }

قيمة الخاصية

bool

IsString

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

public bool IsString { get; }

قيمة الخاصية

bool

النص

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

public string Text { get; }

قيمة الخاصية

string

الطرق

ToFile()

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

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

الوراثة

objectPluginBaseOptionsOptimizeOptions

ينفذ

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

المنشئون

OptimizeOptions()

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

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

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

Class Optimizer

معلومات

تمثيل مكون Documentize.Optimizer. يُستخدم لتحسين، وتدوير، وتغيير حجم، وضغط مستندات PDF.

[Obsolete("يرجى استخدام فئة PdfManager. سيتم حذف الفئة قريبًا.")]
public static class Optimizer

الوراثة

objectOptimizer

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

الطرق

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 PageInfo

معلومات

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

public class PageInfo : PageSize

الوراثة

objectPageSizePageInfo

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

المنشئات

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

قيمة الخاصية

double

MarginLeft

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

public double MarginLeft { get; set; }

قيمة الخاصية

double

MarginRight

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

public double MarginRight { get; set; }

قيمة الخاصية

double

MarginTop

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

public double MarginTop { get; set; }

قيمة الخاصية

double

Namespace: Documentize Assembly: Documentize.dll

Class PageSize

معلومات

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

public class PageSize

Inheritance

objectPageSize

Derived

Inherited Members

Constructors

PageSize()

Constructor of Documentize.PageSize. A4 sizes by default.

public PageSize()

PageSize(double, double)

Constructor of Documentize.PageSize.

public PageSize(double width, double height)

Parameters

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

Properties

A0

حجم A0 (1189x840 مم).

public static PageSize A0 { get; }

Property Value

PageSize

A1

حجم A1 (840x594 مم).

public static PageSize A1 { get; }

Property Value

PageSize

A2

حجم A2 (594x420 مم).

public static PageSize A2 { get; }

Property Value

PageSize

A3

حجم A3 (420x297 مم).

public static PageSize A3 { get; }

Property Value

PageSize

A4

حجم A4 (297x210 مم).

public static PageSize A4 { get; }

Property Value

PageSize

A5

حجم A5 (210x148 مم).

public static PageSize A5 { get; }

Property Value

PageSize

A6

حجم A6 (148x105 مم).

public static PageSize A6 { get; }

Property Value

PageSize

B5

حجم B5 (250x176 مم).

public static PageSize B5 { get; }

Property Value

PageSize

Height

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

public double Height { get; set; }

Property Value

double

IsLandscape

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

public bool IsLandscape { get; }

Property Value

bool

P11x17

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

public static PageSize P11x17 { get; }

Property Value

PageSize

PageLedger

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

public static PageSize PageLedger { get; }

Property Value

PageSize

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

public static PageSize PageLegal { get; }

Property Value

PageSize

PageLetter

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

public static PageSize PageLetter { get; }

Property Value

PageSize

Width

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

public double Width { get; set; }

Property Value

double

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

معلومات

يمثل مكونًا إضافيًا للتعامل مع تحويل مستندات PDF بصيغة PDF/A وللتحقق من التوافق مع PDF/A.

public static class PdfAConverter

الوراثة

objectPdfAConverter

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

أمثلة

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

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

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

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

// تنفيذ عملية التحويل
PdfAConverter.Process(options);

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

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

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

// تنفيذ عملية التحقق والحصول على النتائج
var resultContainer = PdfAConverter.Process(options);

// تحقق من خاصية resultContainer.ResultCollection للحصول على نتائج التحقق لكل ملف:
for (var i = 0; i &lt; resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // نتيجة التحقق للمستند رقم i
}

طرق

Process(PdfAConvertOptions)

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

public static ResultContainer Process(PdfAConvertOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Process(PdfAValidateOptions)

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

public static ResultContainer Process(PdfAValidateOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConvertOptions

معلومات

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

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

الوراثة

objectPdfAOptionsBasePdfAConvertOptions

تنفيذ

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

المنشئين

PdfAConvertOptions()

public PdfAConvertOptions()

الخصائص

Outputs

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

public List<idatasource> Outputs { get; }

قيمة الخاصية

List<IDataSource>

الأساليب

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

الوراثة

objectPdfAOptionsBase

المشتقات

التنفيذ

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

المُنشئات

PdfAOptionsBase()

protected PdfAOptionsBase()

الخصائص

AlignText

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

public bool AlignText { get; set; }

قيمة الخاصية

bool

الملاحظات

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

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

قيمة الخاصية

bool

ErrorAction

يحصل أو يقوم بتعيين الإجراء المتخذ للأشياء التي لا يمكن تحويلها.

public ConvertErrorAction ErrorAction { get; set; }

قيمة الخاصية

ConvertErrorAction

IccProfileFileName

يحصل أو يقوم بتعيين اسم الملف الخاص بملف تعريف ICC (الاتحاد الدولي للألوان) لاستخدامه في تحويل PDF/A بدلاً من الملف الافتراضي.

public string IccProfileFileName { get; set; }

قيمة الخاصية

string

Inputs

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

public List<idatasource> Inputs { get; }

قيمة الخاصية

List<IDataSource>

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

قيمة الخاصية

bool

LogOutputSource

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

public IDataSource LogOutputSource { get; set; }

قيمة الخاصية

IDataSource

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

قيمة الخاصية

bool

الملاحظات

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

PdfAVersion

يحصل أو يقوم بتعيين إصدار معيار PDF/A الذي سيتم استخدامه للتحقق أو التحويل.

public PdfAStandardVersion PdfAVersion { get; set; }

قيمة الخاصية

PdfAStandardVersion

الملاحظات

يتم استخدام إصدار معيار PDF/A لتحديد مستوى الامتثال للتحقق من PDF/A والتحويل. إذا تم تعيين الإصدار على Documentize.PdfAStandardVersion.Auto، سيتولى النظام تحديد الإصدار المناسب لمعيار PDF/A للتحقق بناءً على بيانات الوثيقة الوصفية. بالنسبة لعملية تحويل PDF/A، فإن Documentize.PdfAStandardVersion.Auto يكون افتراضيًا على إصدار معيار PDF/A-1b.

SoftMaskAction

يحصل أو يقوم بتعيين الإجراء الذي سيتم اتخاذه خلال تحويل الصور ذات القناع الناعم.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

قيمة الخاصية

ConvertSoftMaskAction

الطرق

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

المعاملات

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidateOptions

معلومات

يمثل الخيارات الخاصة بالتحقق من مطابقة PDF/A لوثائق PDF باستخدام مكون Documentize.PdfAConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

الوراثة

objectPdfAOptionsBasePdfAValidateOptions

التنفيذات

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

المنشئات

PdfAValidateOptions()

public PdfAValidateOptions()

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

Class PdfAValidationResult

معلومات

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

public sealed class PdfAValidationResult

الوراثة

objectPdfAValidationResult

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

الحقول

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

قيمة الحقل

IDataSource

IsValid

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

public readonly bool IsValid

قيمة الحقل

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

قيمة الحقل

PdfAStandardVersion

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGpt

معلومات

يمثل برنامج PdfChatGpt.

public static class PdfChatGpt

وراثة

objectPdfChatGpt

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

أمثلة

المثال يوضح كيفية استخدام برنامج PdfChatGpt عن طريق إضافة رسائل إلى الطلب.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // إضافة مسار ملف الإخراج.
options.ApiKey = "Your API key."; // تحتاج إلى تقديم المفتاح للوصول إلى API.
options.MaxTokens = 1000; // الحد الأقصى لعدد الرموز التي سيتم إنشاؤها في إتمام الدردشة.

// إضافة رسائل الطلب.
options.Messages.Add(new Message
{
    Content = "أنت مساعد مفيد.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "ما هو أكبر قطر بيتزا تم صنعه على الإطلاق؟",
    Role = Role.User
});

// معالجة الطلب.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إتمام الدردشة في واجهة برمجة تطبيقات ChatGPT.

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

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // إضافة مسار ملف الإخراج.
options.ApiKey = "Your API key."; // تحتاج إلى تقديم المفتاح للوصول إلى API.
options.MaxTokens = 1000; // الحد الأقصى لعدد الرموز التي سيتم إنشاؤها في إتمام الدردشة.

// إضافة رسالة الطلب.
// في هذه الحالة، تم إضافة رسالة النظام مع Content = "أنت مساعد مفيد." افتراضيًا.
// دور رسالة الاستعلام هو "مستخدم" افتراضيًا.
options.Query = "ما هي أدنى درجة حرارة تم تسجيلها على الأرض؟";

// معالجة الطلب.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إتمام الدردشة في واجهة برمجة تطبيقات ChatGPT.

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

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // إضافة مسار ملف الإخراج.

// إضافة مصدر نص PDF.
// في حالة وجود مصادر متعددة، سيتم إضافة النص من كل وثيقة إلى مجموعة رسائل الطلب
// كرسالة منفصلة مع دور "مستخدم".
options.AddInput(new FileDataSource("TextSource.pdf"));

options.ApiKey = "Your API key."; // تحتاج إلى تقديم المفتاح للوصول إلى API.
options.MaxTokens = 1000; // الحد الأقصى لعدد الرموز التي سيتم إنشاؤها في إتمام الدردشة.

// إضافة رسالة الطلب.
// في هذه الحالة، تم إضافة رسالة النظام مع Content = "أنت مساعد مفيد." افتراضيًا.
// دور رسالة الاستعلام هو "مستخدم" افتراضيًا.
options.Query = "كم عدد الحروف في النص المقدم؟";

// معالجة الطلب.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إتمام الدردشة في واجهة برمجة تطبيقات ChatGPT.

ملاحظات

يتم استخدام 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>

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

الاستثناءات

ArgumentException : InvalidOperationException

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

معلومات

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

public class PdfChatGptOptions : IPluginOptions

الوراثة

objectPdfChatGptOptions

المشتقة

تنفيذ

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

المُنشئون

PdfChatGptOptions()

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

public PdfChatGptOptions()

الخصائص

المدخلات

public List<idatasource> Inputs { get; }

قيمة الخاصية

List<IDataSource>

المخرجات

public List<idatasource> Outputs { get; }

قيمة الخاصية

List<IDataSource>

الطرق

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

التوريث

objectPdfChatGptOptionsPdfChatGptRequestOptions

التنفيذ

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

المنشئات

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

قيمة الخاصية

string

ApiUrl

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

public string ApiUrl { get; set; }

قيمة الخاصية

string

CancellationToken

رمز الإلغاء.

public CancellationToken CancellationToken { get; set; }

قيمة الخاصية

CancellationToken

MaxTokens

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

public int? MaxTokens { get; set; }

قيمة الخاصية

int?

Messages

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

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

قيمة الخاصية

List<Message>

الملاحظات

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

  • الرسالة الأولى (إن وجدت) هي من options.Query، تسبقها الرسالة بمحتوى: “أنت مساعد مفيد."، والدور هو “نظام”.
  • ثم (إن وجدت) يتم إضافة الرسائل من مجموعة options.Messages.
  • تُضاف الرسائل من مصادر الملفات (إن وجدت) في النهاية، كائن رسالة واحد لكل مستند مع دور “مستخدم”. إذا لم يتم تقديم أي رسالة، سيتم رمي ArgumentException.

Model

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

public string Model { get; set; }

قيمة الخاصية

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

قيمة الخاصية

int

Query

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

public string Query { get; set; }

قيمة الخاصية

string

Temperature

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

public double Temperature { get; set; }

قيمة الخاصية

double

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

Class PdfConverterOptions

معلومات

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

public abstract class PdfConverterOptions : IPluginOptions

الوراثة

objectPdfConverterOptions

المشتقات

التنفيذ

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

الخصائص

المدخلات

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

public List<idatasource> Inputs { get; }

قيمة الخاصية

List<IDataSource>

المخرجات

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

public List<idatasource> Outputs { get; }

قيمة الخاصية

List<IDataSource>

الطرق

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

الوراثة

objectPdfExtractor

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

الأمثلة

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

// إنشاء كائن ExtractTextOptions لتحديد التعليمات
var options = new ExtractTextOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تنفيذ العملية
var results = PdfExtractor.ExtractText(options);
// الحصول على النص المستخرج من كائن ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

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

// إنشاء كائن ExtractTextOptions لتحديد TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تنفيذ العملية
var results = PdfExtractor.ExtractText(options);
// الحصول على النص المستخرج من كائن ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

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

// إنشاء كائن ExtractImagesOptions لتحديد التعليمات
var options = new ExtractImagesOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار دليلا الناتج
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// تنفيذ العملية
var results = PdfExtractor.ExtractImages(options);
// الحصول على مسار الصورة الناتجة
var imageExtracted = results.ResultCollection[0].ToFile();

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

// إنشاء كائن ExtractImagesOptions لتحديد التعليمات
var options = new ExtractImagesOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// عدم تحديد الإخراج - سيتم كتابة النتائج إلى التدفقات
// تنفيذ العملية
var results = PdfExtractor.ExtractImages(options);
// الحصول على التدفق
var ms = results.ResultCollection[0].ToStream();
// نسخ البيانات إلى ملف للعرض
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

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

// إنشاء كائن ExtractFormDataToDsvOptions لتحديد التعليمات
var options = new ExtractFormDataToDsvOptions(',', true);
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تحديد مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// تنفيذ العملية
PdfExtractor.ExtractFormData(options);

الأساليب

ExtractFormData(ExtractFormDataToDsvOptions)

استخراج بيانات النموذج من وثيقة PDF.

public static ResultContainer ExtractFormData(ExtractFormDataToDsvOptions options)

المعلمات

العوائد

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

الاستثناءات

ArgumentException

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

ExtractImages(ExtractImagesOptions)

استخراج الصور من وثيقة PDF.

public static ResultContainer ExtractImages(ExtractImagesOptions options)

المعلمات

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

العوائد

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

الاستثناءات

ArgumentException

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

ExtractText(ExtractTextOptions)

استخراج النص من وثيقة PDF.

public static ResultContainer ExtractText(ExtractTextOptions options)

المعلمات

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

العوائد

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

معلومات

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

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

public static class PdfManager

Inheritance

objectPdfManager

Inherited Members

Examples

The example demonstrates how to Merge two PDF documents.

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

The example demonstrates how to Split PDF document.

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

The example demonstrates how to Optimize PDF document.

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

The example demonstrates how to Rotate PDF document.

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

The example demonstrates how to Resize PDF document.

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

The example demonstrates how to Compress PDF document.

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

The example demonstrates how to Add Table to PDF file.

// Configure table options
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Add input file path
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

The example demonstrates how to add Table of Contents to PDF file.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);

The example demonstrates how to add Table of Contents to PDF file with generating bookmarks.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Generate links in bookmarks
options.GenerateBookmarks = true;
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);

The example demonstrates how to add Table of Contents to PDF file and save as stream.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Perform the process
PdfManager.AddTableOfContents(options);

Methods

AddTable(TableOptions)

Add Table to PDF document.

public static ResultContainer AddTable(TableOptions options)

Parameters

  • options TableOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

AddTableOfContents(TocOptions)

Add Table of Contents (TOC) to PDF document.

public static ResultContainer AddTableOfContents(TocOptions options)

Parameters

  • options TocOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Compress(CompressOptions)

Compress PDF document. Try to reduce size of the document.

public static ResultContainer Compress(CompressOptions options)

Parameters

  • options CompressOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Merge(MergeOptions)

Merge PDF documents.

public static ResultContainer Merge(MergeOptions options)

Parameters

  • options MergeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Optimize(OptimizeOptions)

Optimize PDF document. Linearize the document in order to

  • open the first page as quickly as possible;
  • display next page or follow by link to the next page as quickly as possible;
  • display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first);
  • permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed.
public static ResultContainer Optimize(OptimizeOptions options)

Parameters

  • options OptimizeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Resize(ResizeOptions)

Resize Pages of PDF document.

public static ResultContainer Resize(ResizeOptions options)

Parameters

  • options ResizeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Rotate(RotateOptions)

Rotate Pages of PDF document.

public static ResultContainer Rotate(RotateOptions options)

Parameters

  • options RotateOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Split(SplitOptions)

Split PDF document by pages.

public static ResultContainer Split(SplitOptions options)

Parameters

  • options SplitOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

معلومات

يمثل خيارات محول PDF إلى DOC لمكون Documentize.DocConverter.

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

التوريث

objectPluginBaseOptionsPdfToDocOptions

التنفيذات

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

المنشئون

PdfToDocOptions()

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

public PdfToDocOptions()

الخصائص

Mode

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

public DocConversionMode Mode { get; set; }

قيمة الخاصية

DocConversionMode

الملاحظات

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

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfToHtmlOptions

معلومات

تمثل خيارات تحويل PDF إلى HTML لمكون Documentize.HtmlConverter.

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsPdfToHtmlOptions

تنفيذ

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

المُنشئات

PdfToHtmlOptions(SaveDataType)

يُهيئ مثيلًا جديدًا من كائن Documentize.PdfToHtmlOptions لنوع بيانات المخرجات المحدد.

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

المعلمات

الخصائص

OutputDataType

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

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

قيمة الخصيصة

PdfToHtmlOptions.SaveDataType

Namespace: Documentize Assembly: Documentize.dll

Class PdfToJpegOptions

معلومات

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

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsPdfToJpegOptions

التنفيذ

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

البانيين

PdfToJpegOptions()

يبدأ نموذج جديد من كائن Documentize.PdfToJpegOptions.

public PdfToJpegOptions()

الخصائص

OutputResolution

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

public int OutputResolution { get; set; }

قيمة الخاصية

int

PageList

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

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

قيمة الخاصية

List<int>

Quality

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

public int Quality { get; set; }

قيمة الخاصية

int

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

Class PdfToPngOptions

معلومات

تمثل خيارات محول PDF إلى PNG لملحق Documentize.PngConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsPdfToPngOptions

تنفيذ

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

البناة

PdfToPngOptions()

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

public PdfToPngOptions()

الخصائص

OutputResolution

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

public int OutputResolution { get; set; }

قيمة الخاصية

int

PageList

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

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

قيمة الخاصية

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToTiffOptions

معلومات

يمثل خيارات تحويل PDF إلى TIFF لملحق Documentize.TiffConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsPdfToTiffOptions

تنفيذ

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

المُنشئات

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

قيمة الخاصية

bool

OutputResolution

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

public int OutputResolution { get; set; }

قيمة الخاصية

int

PageList

يحصل أو يضبط قائمة الصفحات للعملية.

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

قيمة الخاصية

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

معلومات

يمثل خيارات تحويل PDF إلى XLS/XLSX لمكون Documentize.XlsConverter.

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

الوراثة

objectPdfConverterOptionsPdfToXlsOptions

التنفيذات

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

المنشئات

PdfToXlsOptions()

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

public PdfToXlsOptions()

الخصائص

Format

تنسيق الإخراج.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

قيمة الخاصية

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

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

public bool InsertBlankColumnAtFirst { get; set; }

قيمة الخاصية

bool

MinimizeTheNumberOfWorksheets

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

public bool MinimizeTheNumberOfWorksheets { get; set; }

قيمة الخاصية

bool

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

معلومات

يمثل خيارات أساسية للملحقات.

public class PluginBaseOptions : IPluginOptions

الوراثة

objectPluginBaseOptions

مشتق

تنفذ

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

الخصائص

CloseInputStreams

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

public bool CloseInputStreams { get; set; }

قيمة الخصائص

bool

CloseOutputStreams

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

public bool CloseOutputStreams { get; set; }

قيمة الخصائص

bool

Inputs

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

public List<idatasource> Inputs { get; }

قيمة الخصائص

List<IDataSource>

Outputs

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

public List<idatasource> Outputs { get; }

قيمة الخصائص

List<IDataSource>

الطرق

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

المعلمات

  • dataSource IDataSource: البيانات التي سيتم إضافتها.

AddOutput(IDataSource)

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

public void AddOutput(IDataSource saveDataSource)

المعلمات

  • saveDataSource IDataSource: البيانات التي سيتم إضافتها. :

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

Class PngConverter

معلومات

يمثل مكون Documentize.PngConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق PNG.

public static class PngConverter

الوراثة

objectPngConverter

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

أمثلة

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

// إنشاء كائن PdfToPngOptions لتعيين التعليمات
var options = new PdfToPngOptions();
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تعيين مسار مجلد الإخراج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
PngConverter.Process(options);

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

// إنشاء كائن PdfToPngOptions لتعيين التعليمات
var options = new PdfToPngOptions()
// معالجة الصفحة الأولى فقط
options.PageList = [1];
// تعيين دقة الإخراج إلى 200 DPI
options.OutputResolution = 200;
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تعيين مسار مجلد الإخراج
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// تنفيذ العملية
PngConverter.Process(options);

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

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

الطرق

Process(PdfToPngOptions)

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

public static ResultContainer Process(PdfToPngOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

معلومات

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

public class Rectangle

الوراثة

objectRectangle

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

المنشئون

Rectangle(double, double, double, double)

منشئ المستطيل.

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

المعلمات

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

Namespace: Documentize Assembly: Documentize.dll

Class ResizeOptions

معلومات

يمثل خيارات تغيير الحجم لملحق Documentize.PdfManager.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsResizeOptions

تطبيقات

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

البناة

ResizeOptions()

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

public ResizeOptions()

الخصائص

PageSize

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

public PageSize PageSize { get; set; }

قيمة الخاصية

PageSize

Namespace: Documentize Assembly: Documentize.dll

Class ResultContainer

معلومات

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

public class ResultContainer

الوراثة

objectResultContainer

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

الخصائص

ResultCollection

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

public List<ioperationresult> ResultCollection { get; }

قيمة الخاصية

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Class RotateOptions

معلومات

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

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsRotateOptions

ينفذ

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

المنشئات

RotateOptions()

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

public RotateOptions()

الخصائص

Rotation

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

public Rotation Rotation { get; set; }

قيمة الخاصية

Rotation

Namespace: Documentize Assembly: Documentize.dll

Class Security

معلومات

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

public static class Security

الوراثة

objectSecurity

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

أمثلة

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

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

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

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

الطرق

Process(EncryptionOptions)

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

public static ResultContainer Process(EncryptionOptions options)

المعلمات

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

النتيجة

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

الاستثناءات

ArgumentException

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

Process(DecryptionOptions)

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

public static ResultContainer Process(DecryptionOptions options)

المعلمات

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

النتيجة

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class Signature

معلومات

تمثل إضافة Documentize.Signature. تُستخدم لتوقيع مستندات PDF.

public static class Signature

الوراثة

objectSignature

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

أمثلة

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

// إنشاء كائن SignOptions لتحديد التعليمات
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
Signature.Process(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.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
Signature.Process(options);

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

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تكوين التوقيع غير المرئي
signOptions.Visible = false;
// تنفيذ العملية
Signature.Process(options);

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

// إنشاء كائن SignOptions لتحديد التعليمات
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// معلمات اختيارية
options.Reason = "سببى";
options.Contact = "اتصالي";
options.Location = "مكاني";
options.PageNumber = 3;
// تنفيذ العملية
Signature.Process(options);

الطرق

Process(SignOptions)

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

public static ResultContainer Process(SignOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

معلومات

يمثل خيارات التوقيع لملحق Documentize.Signature.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsSignOptions

التنفيذ

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

البانيين

SignOptions(string, string)

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

public SignOptions(string pfx, string password)

المعلمات

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

SignOptions(Stream, string)

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

public SignOptions(Stream pfx, string password)

المعلمات

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

الخصائص

الاتصال

الاتصال بالتوقيع.

public string Contact { get; set; }

قيمة الخاصية

string

الموقع

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

public string Location { get; set; }

قيمة الخاصية

string

الاسم

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

public string Name { get; set; }

قيمة الخاصية

string

رقم الصفحة

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

public int PageNumber { get; set; }

قيمة الخاصية

int

السبب

سبب التوقيع.

public string Reason { get; set; }

قيمة الخاصية

string

المستطيل

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

public Rectangle Rectangle { get; set; }

قيمة الخاصية

Rectangle

مرئي

الوصول إلى التوقيع.

public bool Visible { get; set; }

قيمة الخاصية

bool

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

Class SplitOptions

معلومات

Represents Split options for Documentize.PdfManager plugin.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsSplitOptions

Implements

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("يرجى استخدام فئة PdfManager. ستتم إزالة الفئة قريبًا.")]
public static class Splitter

Inheritance

objectSplitter

Inherited Members

Methods

Process(SplitOptions)

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

public static ResultContainer Process(SplitOptions options)

Parameters

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

Returns

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

Exceptions

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class StreamDataSource

معلومات

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

public sealed class StreamDataSource : IDataSource

الوراثة

objectStreamDataSource

ينفذ

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

المنشئات

StreamDataSource(Stream)

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

public StreamDataSource(Stream data)

المعلمات

  • data Stream: كائن البث

الخصائص

Data

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

public Stream Data { get; }

قيمة الخاصية

Stream

DataType

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

public DataType DataType { get; }

قيمة الخاصية

DataType

Namespace: Documentize Assembly: Documentize.dll

Class StreamResult

معلومات

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

public sealed class StreamResult : IOperationResult

الوراثة

objectStreamResult

تنفيذ

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

الخصائص

البيانات

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

public object Data { get; }

قيمة الخاصية

object

IsFile

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

public bool IsFile { get; }

قيمة الخاصية

bool

IsStream

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

public bool IsStream { get; }

قيمة الخاصية

bool

IsString

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

public bool IsString { get; }

قيمة الخاصية

bool

الطرق

ToFile()

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

public string ToFile()

يرجع

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

ToStream()

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

public Stream ToStream()

يرجع

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

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

Class StringResult

معلومات

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

public sealed class StringResult : IOperationResult

الوراثة

objectStringResult

ينفذ

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

الخصائص

البيانات

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

public object Data { get; }

قيمة الخاصية

object

IsFile

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

public bool IsFile { get; }

قيمة الخاصية

bool

IsStream

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

public bool IsStream { get; }

قيمة الخاصية

bool

IsString

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

public bool IsString { get; }

قيمة الخاصية

bool

النص

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

public string Text { get; }

قيمة الخاصية

string

الطرق

ToFile()

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

public string ToFile()

المرتجع

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

ToStream()

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

public Stream ToStream()

المرتجع

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

ToString()

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

public override string ToString()

المرتجع

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

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

معلومات

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

public class TableBuilder

الوراثة

objectTableBuilder

المشتقات

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

الطرق

AddRow()

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

public virtual TableRowBuilder AddRow()

الإرجاع

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

AddTable()

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

public TableBuilder AddTable()

الإرجاع

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

InsertPageAfter(int)

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

public TableOptions InsertPageAfter(int page)

المعلمات

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

الإرجاع

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

InsertPageBefore(int)

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

public TableOptions InsertPageBefore(int page)

المعلمات

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

الإرجاع

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

المشغلون

implicit operator TableOptions(TableBuilder)

تحويل الباني Documentize.TableBuilder إلى الخيارات Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)

المعلمات

  • builder TableBuilder: مثيل من Documentize.TableBuilder الحالي.

الإرجاع

TableOptions : نتيجة التحويل إلى PdfGeneratorTableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

معلومات

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

public class TableCellBuilder : TableRowBuilder

الوراثة

objectTableBuilderTableRowBuilderTableCellBuilder

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

الطرق

AddCell()

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

public override TableCellBuilder AddCell()

الإرجاع

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

AddParagraph(params string[])

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

public TableCellBuilder AddParagraph(params string[] paragraphs)

المعاملات

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

الإرجاع

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

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

معلومات

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

[Obsolete("يرجى استخدام فئة PdfManager. سيتم حذف الفئة قريبًا.")]
public static class TableGenerator

وراثة

objectTableGenerator

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

أمثلة

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

// تكوين خيارات الجدول
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("الاسم")
            .AddCell().AddParagraph("العمر")
        .AddRow()
            .AddCell().AddParagraph("بوب")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("سام")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("ساندي")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("توم")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("جيم")
            .AddCell().AddParagraph("27");
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_input.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// تنفيذ العملية
TableGenerator.Process(options);

الطرق

Process(TableOptions)

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

public static ResultContainer Process(TableOptions options)

المعلمات

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

المخرجات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

معلومات

يمثل خيارات إضافة جدول إلى المستند بواسطة ملحق Documentize.PdfManager.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsTableOptions

ينفذ

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

المُنشئون

TableOptions()

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

public TableOptions()

الأساليب

AddTable()

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

public TableBuilder AddTable()

العائدات

TableBuilder : مثيل جديد من Documentize.TableBuilder.

Create()

إنشاء مثيل من Documentize.TableOptions.

public static TableOptions Create()

العائدات

TableOptions : مثيل جديد من Documentize.TableOptions.

InsertPageAfter(int)

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

public TableOptions InsertPageAfter(int page)

المعلمات

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

العائدات

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

InsertPageBefore(int)

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

public TableOptions InsertPageBefore(int page)

المعلمات

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

العائدات

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

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

معلومات

الفئة تمثل مُنشئًا لصف الجدول.

public class TableRowBuilder : TableBuilder

الوراثة

objectTableBuilderTableRowBuilder

مشتق

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

الطرق

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("يرجى استخدام فئة PdfExtractor. سيتم حذف الفئة قريبًا.")]
public static class TextExtractor

الوراثة

objectTextExtractor

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

الطرق

Process(ExtractTextOptions)

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

public static ResultContainer Process(ExtractTextOptions options)

المعلمات

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

العوائد

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractorOptions

معلومات

يمثل خيارات استخراج النص لملحق Documentize.TextExtractor.

public sealed class TextExtractorOptions

الوراثة

objectTextExtractorOptions

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

البانيين

TextExtractorOptions(TextFormattingMode)

يقوم بتهيئة مثيل جديد من كائن Documentize.TextExtractorOptions لوضع تنسيق النص المحدد.

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

المعلمات

الخصائص

FormattingMode

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

public TextFormattingMode FormattingMode { get; set; }

قيمة الخاصية

TextFormattingMode

Inputs

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

public List<idatasource> Inputs { get; }

قيمة الخاصية

List<IDataSource>

الطرق

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

المعلمات

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

Namespace: Documentize Assembly: Documentize.dll

Class TiffConverter

معلومات

يمثل مكون Documentize.TiffConverter. يستخدم لتحويل مستندات PDF إلى تنسيق TIFF.

public static class TiffConverter

الوراثة

objectTiffConverter

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

أمثلة

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

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Perform the process
TiffConverter.Process(options);

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

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

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

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

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

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

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

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

الطرق

Process(PdfToTiffOptions)

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

public static ResultContainer Process(PdfToTiffOptions options)

المعلمات

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

العائدات

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class Timestamp

معلومات

يمثل مكون Documentize.Timestamp. يُستخدم لإضافة الطابع الزمني إلى الوثيقة.

public static class Timestamp  

الوراثة

object
Timestamp

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

أمثلة

المثال يوضح كيفية إضافة الطابع الزمني إلى الوثيقة.

// إنشاء كائن AddTimestampOptions لتعيين التعليمات  
var options = new AddTimestampOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file", "timestamp_server_url");  
// إضافة مسار الملف المدخل  
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));  
// تعيين مسار الملف الناتج  
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));  
// تنفيذ العملية  
Timestamp.Process(options);  

طرق

Process(AddTimestampOptions)

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

public static ResultContainer Process(AddTimestampOptions options)  

المعلمات

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

يرجع

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

Namespace: Documentize
Assembly: Documentize.dll

Class TocGenerator

معلومات

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

[Obsolete("يرجى استخدام فئة PdfManager. سيتم حذف الفئة قريبًا.")]
public static class TocGenerator

الوراثة

objectTocGenerator

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

أمثلة

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

// إنشاء كائن TocOptions لإعداد التعليمات
var options = new TocOptions();
// تعيين العنوان
options.Title = "جدول المحتويات الخاص بي";
// تصميم العناوين
options.Headings.Add(new TocHeading("المقدمة", 2));
options.Headings.Add(new TocHeading("الفصل الأول", 3));
options.Headings.Add(new TocHeading("الفصل الثاني", 4));
options.Headings.Add(new TocHeading("الفصل الثالث", 5));
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
TocGenerator.Process(options);

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

// إنشاء كائن TocOptions لإعداد التعليمات
var options = new TocOptions();
// تعيين العنوان
options.Title = "جدول المحتويات الخاص بي";
// إنشاء روابط في الإشارات المرجعية
options.GenerateBookmarks = true;
// تصميم العناوين
options.Headings.Add(new TocHeading("المقدمة", 2, false, 1));
options.Headings.Add(new TocHeading("الفصل الأول", 3, true, 1));
options.Headings.Add(new TocHeading("الفصل الثاني", 4, true, 1));
options.Headings.Add(new TocHeading("مثال أ", 4, true, 2));
options.Headings.Add(new TocHeading("مثال ب", 4, true, 2));
options.Headings.Add(new TocHeading("مثال ج", 4, true, 2));
options.Headings.Add(new TocHeading("مثال د", 4, true, 2));
options.Headings.Add(new TocHeading("الفصل الثالث", 5, true, 1));
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين مسار ملف الإخراج
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// تنفيذ العملية
TocGenerator.Process(options);

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

// إنشاء كائن TocOptions لإعداد التعليمات
var options = new TocOptions();
// تعيين العنوان
options.Title = "جدول المحتويات الخاص بي";
// تصميم العناوين
options.Headings.Add(new TocHeading("المقدمة", 2, false, 1));
// إضافة مسار ملف الإدخال
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// تعيين تيار الإخراج 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// تنفيذ العملية
TocGenerator.Process(options);

الأساليب

Process(TocOptions)

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

public static ResultContainer Process(TocOptions options)

المعلمات

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

يرجع

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

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

معلومات

يمثل الخيارات للعناوين أو الأسماء في جدول المحتويات لتوثيقها بواسطة ملحق Documentize.PdfManager.

public class TocHeading

الوراثة

objectTocHeading

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

المُنشئات

TocHeading(string, int, bool, int)

يُهيئ مثيلًا جديدًا من Documentize.TocHeading.

public TocHeading(string text = "", int pageNumber = 1, bool generateNumbering = false, int level = 1)

المعلمات

  • text string: نص العنوان.
  • pageNumber int: رقم الصفحة للرابط.
  • generateNumbering bool: استخدام توليد الأرقام.
  • level int: المستوى.

الخصائص

GenerateNumbering

استخدام توليد الأرقام. إذا كانت true، فيجب إجراء الترقيم تلقائيًا؛ خلاف ذلك، يجب إجراء الترقيم يدويًا.

public bool GenerateNumbering { get; set; }

قيمة الخاصية

bool

Level

المستوى. يستخدم لتوليد الأرقام.

public int Level { get; set; }

قيمة الخاصية

int

PageNumber

رقم الصفحة للرابط.

public int PageNumber { get; set; }

قيمة الخاصية

int

Text

نص العنوان.

public string Text { get; set; }

قيمة الخاصية

string

Namespace: Documentize Assembly: Documentize.dll

Class TocOptions

معلومات

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

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsTocOptions

ينفذ

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

المُنشئات

TocOptions()

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

public TocOptions()

الخصائص

GenerateBookmarks

استخدام إنشاء العلامات. إذا تم تعيين true فسيتم مسح العلامات وإنشاؤها بواسطة العناوين؛ وإلا، فلن تتغير العلامات.

public bool GenerateBookmarks { get; set; }

قيمة الخاصية

bool

Headings

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

public List<tocheading> Headings { get; set; }

قيمة الخاصية

List<TocHeading>

Title

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

public string Title { get; set; }

قيمة الخاصية

string

Namespace: Documentize Assembly: Documentize.dll

Class XlsConverter

معلومات

يمثل ملحق Documentize.XlsConverter. يُستخدم لتحويل مستندات PDF إلى صيغ XLSX/XLS/CSV/XLSM/ODS.

public static class XlsConverter

Inheritance

objectXlsConverter

Inherited Members

Examples

The example demonstrates how to convert PDF to XLSX document.

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

The example demonstrates how to convert PDF to XLS document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileDataSource("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 FileDataSource("path_to_result_xlsx_file.xls"));
// Perform the process
XlsConverter.Process(options);

Methods

Process(PdfToXlsOptions)

Converts PDF document into XLSX/XLS/CSV/XLSM/ODS formats.

public static ResultContainer Process(PdfToXlsOptions options)

Parameters

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

Returns

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

Exceptions

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

معلومات

هذه الفئة تمثل الإجراء للأخطاء في التحويل.

public enum ConvertErrorAction

Fields

  • Delete = 0
  • None = 1

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum ConvertSoftMaskAction

معلومات

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

public enum ConvertSoftMaskAction

Fields

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

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum DataType

معلومات

يمثل الأنواع الممكنة للبيانات لمعالجة المكونات الإضافية.

public enum DataType

Fields

  • Directory = 2: نوع البيانات هو دليل يُمثل بواسطة المسار إليه.
  • File = 0: نوع البيانات هو ملف يُمثل بواسطة المسار إليه.
  • Stream = 1: نوع البيانات هو دفق.

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum DocConversionMode

معلومات

تحديد وضع تحويل الوثيقة الناتجة.

public enum DocConversionMode

الفئات

  • Flow = 1: وضع التعرف الكامل، حيث يقوم المحرك بأداء التجميع والتحليل متعدد المستويات لاستعادة نية مؤلف الوثيقة الأصلية وإنتاج وثيقة قابلة للتحرير بشكل كامل. السلبيات هي أن الوثيقة الناتجة قد تبدو مختلفة عن ملف PDF الأصلي.
  • TextBox = 0: هذا الوضع سريع وجيد للحفاظ على الشكل الأصلي لملف PDF، ولكن قابلية تحرير الوثيقة الناتجة قد تكون محدودة. كل كتلة نصية مرئية مجمعة في ملف PDF الأصلي يتم تحويلها إلى مربع نص في الوثيقة الناتجة. هذا يحقق تشابهاً أقصى بين الوثيقة الناتجة وملف PDF الأصلي. ستبدو الوثيقة الناتجة جيدة، لكنها ستتكون بالكامل من صناديق نصية وقد يجعل ذلك تحرير الوثيقة في Microsoft Word صعباً للغاية. هذا هو الوضع الافتراضي.

Namespace: Documentize Assembly: Documentize.dll

09‏/09‏/2025

Enum HtmlMediaType

معلومات

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

public enum HtmlMediaType

Fields

  • Print = 0: طباعة.
  • Screen = 1: شاشة.

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum HtmlPageLayoutOption

معلومات

تحدد الأعلام التي معًا تحدد خيارات أخرى أحجام وتنسيقات الصفحات.

public enum HtmlPageLayoutOption

Fields

  • FitToWidestContentWidth = 3: تشير إلى أن عرض الصفحة يتم تحديده من حجم المحتوى نفسه، وليس من عرض الصفحة المحدد.
  • None = 0: القيمة الافتراضية التي تشير إلى أن HtmlPageLayoutOption لن تؤثر على أحجام وتنسيقات الصفحات.
  • ScaleToPageWidth = 256: تشير إلى أن محتوى الوثيقة سيتم تغيير مقاسه ليناسب الصفحة.

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum PdfAStandardVersion

معلومات

يحدد إصدار معيار PDF/A لوثيقة PDF.

public enum PdfAStandardVersion

Fields

  • Auto = 0: يتم تحديد إصدار معيار PDF/A تلقائيًا.
  • PDF_A_1A = 1: يحدد إصدار معيار PDF/A-1a.
  • PDF_A_1B = 2: يحدد إصدار معيار PDF/A-1b.
  • PDF_A_2A = 3: يحدد إصدار معيار PDF/A-2a.
  • PDF_A_2B = 4: يحدد إصدار معيار PDF/A-2b.
  • PDF_A_2U = 5: يحدد إصدار معيار PDF/A-2u.
  • PDF_A_3A = 6: يحدد إصدار معيار PDF/A-3a.
  • PDF_A_3B = 7: يحدد إصدار معيار PDF/A-3b.
  • PDF_A_3U = 8: يحدد إصدار معيار PDF/A-3u.

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum PdfToHtmlOptions.SaveDataType

معلومات

يحدد نوع مخرج ملف HTML.

public enum PdfToHtmlOptions.SaveDataType

Fields

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

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum PdfToXlsOptions.ExcelFormat

معلومات

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

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

public enum PdfToXlsOptions.ExcelFormat

Fields

  • CSV = 2: تنسيق ملف القيم مفصولة بفواصل (.csv).
  • ODS = 4: جدول بيانات المستند المفتوح.
  • XLSM = 3: تنسيق ملف Office Open XML (.xlsm) المدعوم بالماكرو.
  • XLSX = 1: تنسيق ملف Office Open XML (.xlsx).
  • XMLSpreadSheet2003 = 0: تنسيق ملف Excel 2003 XML (.xls).

Namespace: Documentize Assembly: Documentize.dll

09‏/09‏/2025

Enum Role

معلومات

دور مؤلف الرسائل.

public enum Role

Fields

  • Assistant = 2
  • System = 1
  • User = 0

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum Rotation

معلومات

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

public enum Rotation

Fields

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

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

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

29‏/12‏/2024

Enum TextFormattingMode

معلومات

يحدد أوضاع مختلفة يمكن استخدامها أثناء تحويل مستند PDF إلى نص. انظر إلى فئة Documentize.ExtractTextOptions.

public enum TextFormattingMode

Fields

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

Namespace: Documentize Assembly: Documentize.dll

13‏/10‏/2025

Enum TiffColorDepth

معلومات

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

public enum TiffColorDepth

الحقول

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

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Enum TiffCompression

معلومات

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

public enum TiffCompression

الحقول

  • CCITT3 = 2: يحدد مخطط ضغط CCITT3. يمكن تمريره إلى مشفر CCITT3 كمعامل ينتمي إلى فئة الضغط.
  • CCITT4 = 1: يحدد مخطط ضغط CCITT4. يمكن تمريره إلى مشفر CCITT4 كمعامل ينتمي إلى فئة الضغط.
  • LZW = 0: يحدد مخطط ضغط LZW. يمكن تمريره إلى مشفر Tiff كمعامل ينتمي إلى فئة الضغط.
  • None = 4: يحدد عدم وجود ضغط. يمكن تمريره إلى مشفر Tiff كمعامل ينتمي إلى فئة الضغط.
  • RLE = 3: يحدد مخطط ضغط RLE. يمكن تمريره إلى مشفر RLE كمعامل ينتمي إلى فئة الضغط.

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/2025

Interface IDataSource

معلومات

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

public interface IDataSource

الخصائص

DataType

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

DataType DataType { get; }

قيمة الخاصية

DataType

Namespace: Documentize Assembly: Documentize.dll

Interface IOperationResult

معلومات

واجهة نتيجة العملية العامة التي تحدد الطرق المشتركة التي يجب على نتائج عملية المكون المحدد تنفيذها.

public interface IOperationResult

الخصائص

البيانات

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

object Data { get; }

قيمة الخاصية

object

IsFile

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

bool IsFile { get; }

قيمة الخاصية

bool

IsStream

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

bool IsStream { get; }

قيمة الخاصية

bool

IsString

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

bool IsString { get; }

قيمة الخاصية

bool

الطرق

ToFile()

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

string ToFile()

الإرجاع

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

ToStream()

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

Stream ToStream()

الإرجاع

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

Namespace: Documentize Assembly: Documentize.dll

Interface IPluginOptions

معلومات

واجهة خيارات الإضافات العامة التي تحدد الطرق الشائعة التي يجب على خيارات الإضافات المحددة تنفيذها.

public interface IPluginOptions

Namespace: Documentize Assembly: Documentize.dll

معلومات الفئة

معلومات

تقدم الفئة معلومات حول بناء المنتج الحالي.

public static class Info

الوراثة

objectInfo

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

الحقول

  • AssemblyVersion إصدار التجميع.

قيمة الحقل

string

المنتج

اسم المنتج.

public const string Product = "Documentize"

قيمة الحقل

string

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

 عربي