Documentize Namespace

الفئات

اسم الفئةالوصف
AddTimestampOptionsتمثل خيارات إضافة طابع زمني لملحق Documentize.Timestamp.
CompressOptionsتمثل خيارات الضغط لملحق Documentize.Optimizer.
DecryptionOptionsتمثل خيارات فك التشفير لملحق Documentize.Security.
DirectoryDataSourceتمثل بيانات الدليل لعمليات التحميل والحفظ لملحق.
DocConverterتمثل ملحق Documentize.DocConverter. تستخدم لتحويل مستندات PDF إلى تنسيق DOC/DOCX.
EncryptionOptionsتمثل خيارات التشفير لملحق Documentize.Security.
FileDataSourceتمثل بيانات الملف لعمليات التحميل والحفظ لملحق.
FileResultتمثل نتيجة العملية في شكل مسار سلسلة إلى الملف.
FormExportToDsvOptionsتمثل خيارات تصدير قيم الحقول لملحق Documentize.FormExporter.
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.
ImageExtractorOptionsتمثل خيارات استخراج الصور لملحق Documentize.ImageExtractor.
Infoتوفر الفئة معلومات حول بناء المنتج الحالي.
JpegConverterتمثل ملحق Documentize.JpegConverter. تستخدم لتحويل مستندات PDF إلى تنسيق JPEG.
Licenseتوفر طريقة لتعيين الترخيص.
MergeOptionsتمثل خيارات الدمج لملحق Documentize.Merger.
Mergerتمثل ملحق Documentize.Merger. تستخدم لدمج مستندات PDF متعددة في مستند PDF واحد.
Messageرسالة إكمال دردشة تم إنشاؤها بواسطة النموذج.
ObjectResultتمثل نتيجة العملية في شكل سلسلة.
OptimizeOptionsتمثل خيارات التحسين لملحق Documentize.Optimizer.
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 لمستندات PDF باستخدام ملحق Documentize.PdfAConverter.
PdfAValidationResultتمثل نتيجة عملية التحقق من PDF/A.
PdfChatGptتمثل ملحق PdfChatGpt.
PdfChatGptOptionsتمثل خيارات لملحق Documentize.PdfChatGpt.
PdfChatGptRequestOptionsتمثل خيارات لملحق Documentize.PdfChatGpt.
PdfConverterOptionsتمثل خيارات لملحقات محول 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.Optimizer.
ResultContainerتمثل حاوية تحتوي على مجموعة النتائج من معالجة الملحق.
RotateOptionsتمثل خيارات التدوير لملحق Documentize.Optimizer.
Securityتمثل ملحق Documentize.Security. تستخدم لتشفير وفك تشفير مستندات PDF.
SignOptionsتمثل خيارات التوقيع لملحق Documentize.Signature.
Signatureتمثل ملحق Documentize.Signature. تستخدم لتوقيع مستندات PDF.
SplitOptionsتمثل خيارات التقسيم لملحق Documentize.Splitter.
Splitterتمثل ملحق Documentize.Splitter. تستخدم لتقسيم مستندات PDF إلى صفحات منفصلة.
StreamDataSourceتمثل مصدر البيانات للتيار لعمليات التحميل والحفظ لملحق.
StreamResultتمثل نتيجة العملية في شكل تيار.
StringResultتمثل نتيجة العملية في شكل سلسلة.
TableBuilderفئة تمثل الباني لجدول في صفحة PDF.
TableCellBuilderفئة تمثل الباني لخلية جدول.
TableGeneratorتمثل ملحق Documentize.TableGenerator. تستخدم لإضافة جدول إلى مستند PDF.
TableOptionsتمثل خيارات لإضافة جدول إلى المستند بواسطة ملحق Documentize.TableGenerator.
TableRowBuilderفئة تمثل الباني لصف جدول.
TextExtractorتمثل ملحق Documentize.TextExtractor. تستخدم لاستخراج النص من مستندات PDF.
TextExtractorOptionsتمثل خيارات استخراج النص لملحق Documentize.TextExtractor.
TiffConverterتمثل ملحق Documentize.TiffConverter. تستخدم لتحويل مستندات PDF إلى تنسيق TIFF.
Timestampتمثل ملحق Documentize.Timestamp.
TocGeneratorتمثل ملحق Documentize.TocGenerator. تستخدم لإضافة جدول المحتويات إلى مستندات PDF.
TocHeadingتمثل خيارات العناوين أو العناوين لجدول المحتويات في المستند بواسطة ملحق Documentize.TocGenerator.
TocOptionsتمثل خيارات لإضافة جدول المحتويات إلى المستند بواسطة ملحق Documentize.TocGenerator.
XlsConverterتمثل ملحق Documentize.XlsConverter. تستخدم لتحويل مستندات PDF إلى تنسيق XLSX/XLS.

الواجهات

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

التعدادات

اسم التعدادالوصف
ConvertErrorActionتمثل هذه الفئة الإجراء الخاص بأخطاء التحويل.
ConvertSoftMaskActionيمثل هذا الإجراء الإجراءات الخاصة بتحويل الصور ذات القناع الناعم.
DataTypeيمثل الأنواع الممكنة للبيانات لمعالجة الملحق.
PdfToXlsOptions.ExcelFormatيسمح بتحديد تنسيق ملف xls/xlsx/xml/csv. القيمة الافتراضية هي XLSX.
HtmlMediaTypeيحدد أنواع الوسائط الممكنة المستخدمة أثناء العرض.
HtmlPageLayoutOptionيحدد العلامات التي تحدد مع خيارات أخرى أحجام وتصميم الصفحات.
PdfAStandardVersionيحدد إصدار معيار PDF/A لمستند PDF.
Roleدور مؤلف الرسائل.
Rotationتعداد لقيم التدوير الممكنة.
PdfToHtmlOptions.SaveDataTypeيحدد نوع ملف HTML الناتج.
TextFormattingModeيحدد أوضاع مختلفة يمكن استخدامها أثناء تحويل مستند PDF إلى نص. انظر فئة Documentize.TextExtractorOptions.
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.Optimizer.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsCompressOptions

التنفيذ

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

البانيون

CompressOptions()

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

public CompressOptions()

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

الوراثة

objectDocConverter

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

أمثلة

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

// Initialize the DocConverter
var plugin = new DocConverter();
// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_input.doc"));
// Perform the process
plugin.Process(options);

المنشئات

DocConverter()

public DocConverter()

الطرق

Dispose()

تنفيذ لـ IDisposable.

public void Dispose()

Process(PdfToDocOptions)

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

public 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 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.

public static class FormExporter

الوراثة

objectFormExporter

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

أمثلة

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

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

طرق

Process(FormExportToDsvOptions)

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

public static ResultContainer Process(FormExportToDsvOptions options)

المعلمات

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

العائدات

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.

public static class ImageExtractor

الوراثة

objectImageExtractor

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

الأمثلة

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

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

الطرق

Process(ImageExtractorOptions)

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

public static ResultContainer Process(ImageExtractorOptions options)

المعلمات

العائدات

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.Merger.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsMergeOptions

ينفذ

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

المنشئات

MergeOptions()

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

public MergeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Merger

معلومات

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

public static class Merger

الوراثة

objectMerger

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

أمثلة

يظهر المثال كيفية دمج مستندين PDF.

// 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
Merger.Process(options);

الطرق

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.Optimizer.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsOptimizeOptions

يتم تنفيذها بواسطة

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

المنشئات

OptimizeOptions()

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

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

Namespace: Documentize Assembly: Documentize.dll

Class Optimizer

معلومات

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

public static class Optimizer

الوراثة

objectOptimizer

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

الأمثلة

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

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

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

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

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

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

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

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

طرق

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 sealed class PdfAConverter

الوراثة

objectPdfAConverter

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

أمثلة

مثال يوضح كيفية التحقق من توافق مستند 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 plugin = new PdfAConverter();

// تشغيل التحقق والحصول على النتائج
var resultContainer = plugin.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
}

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

// إنشاء مثيل المكون الإضافي
var plugin = new PdfAConverter();

// تشغيل التحويل
plugin.Process(options);

المنشئات

PdfAConverter()

public PdfAConverter()

الطرق

Process(IPluginOptions)

يبدأ عملية تحويل أو تحقق PDF/A مع الخيارات المحددة.

public ResultContainer Process(IPluginOptions options)

المعلمات

  • options IPluginOptions: كائن خيارات يحتوي على تعليمات للمكون الإضافي. يجب أن يكون مثيلًا من فئة Documentize.PdfAConvertOptions: أو Documentize.PdfAValidateOptions.

العائدات

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

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 sealed class PdfChatGpt : IDisposable

الوراثة

objectPdfChatGpt

التنفيذات

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

أمثلة

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

using (var plugin = new 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 = "You are a helpful assistant.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "What is the biggest pizza diameter ever made?",
        Role = Role.User
    });

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

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إكمال دردشة ChatGPT API.
}

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

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

    // إضافة رسالة الطلب.
    // في هذه الحالة، تتم إضافة رسالة النظام بمحتوى = "You are a helpful assistant." بشكل افتراضي.
    // دور رسالة الاستعلام هو "مستخدم" افتراضياً.
    options.Query = "What is the lowest temperature recorded on the Earth?";

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

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إكمال دردشة ChatGPT API.
}

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

using (var plugin = new 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; // الحد الأقصى لعدد الرموز التي ستولد في إكمال الدردشة.

    // إضافة رسالة الطلب.
    // في هذه الحالة، تتم إضافة رسالة النظام بمحتوى = "You are a helpful assistant." بشكل افتراضي.
    // دور رسالة الاستعلام هو "مستخدم" افتراضياً.
    options.Query = "How many letters in the provided text?";

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

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إكمال دردشة ChatGPT API.
}

ملاحظات

يستخدم كائن Documentize.PdfChatGpt لإرسال طلبات إلى ChatGPT مباشرةً أو عن طريق إضافة مصادر ملفات PDF وحفظ الرد في مصدر الخرج.

البناة

PdfChatGpt()

يبدأ مثيل جديد من كائن Documentize.PdfChatGpt.

public PdfChatGpt()

الطرق

Dispose()

تنفيذ IDisposable. في الواقع، ليس من الضروري لمكون PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

الطريقة ليس لديها نسخة متزامنة. استخدم طريقة ProcessAsync بدلاً من ذلك.

public ResultContainer Process(IPluginOptions options)

المعاملات

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

يرجع

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

NotImplementedException

ProcessAsync(IPluginOptions)

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

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

المعاملات

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

يرجع

Task<ResultContainer>

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

الاستثناءات

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

يحدد رمز إلغاء.

public void SetCancellationToken(CancellationToken cancellationToken)

المعاملات

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.

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: المفتاح للوصول إلى API ChatGPT.
  • model string: اسم نموذج ChatGPT. النموذج الافتراضي هو: gpt-3.5-turbo-1106:
  • apiUrl string: عنوان URL لـ API ChatGPT. عنوان URL الافتراضي هو: https://api.openai.com/v1/chat/completions.
  • query string: سلسلة الطلب إلى ChatGPT.

الخصائص

ApiKey

يُعيد أو يحدد المفتاح للوصول إلى API ChatGPT.

public string ApiKey { get; set; }

قيمة الخاصية

string

ApiUrl

يُعيد أو يحدد عنوان URL لـ API ChatGPT.

public string ApiUrl { get; set; }

قيمة الخاصية

string

MaxTokens

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

public int? MaxTokens { get; set; }

قيمة الخاصية

int?

Messages

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

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

قيمة الخاصية

List<Message>

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverterOptions

معلومات

تمثل الخيارات لملحقات محول 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

معلومات

يمثل الوظائف الأساسية لاستخراج النصوص والصور وأنواع أخرى من المحتوى التي قد تحدث على صفحات مستندات PDF.

public abstract class PdfExtractor : IDisposable

الوراثة

objectPdfExtractor

المشتقات

ينفذ

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

أمثلة

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

// إنشاء كائن TextExtractor لاستخراج محتويات PDF
using (TextExtractor extractor = new TextExtractor())
{
    // إنشاء كائن TextExtractorOptions لتعيين التعليمات
    textExtractorOptions = new TextExtractorOptions();

    // إضافة مسار ملف الإدخال
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // إجراء عملية الاستخراج
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

    // الحصول على النص المستخرج من كائن ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

الملاحظات

يستخدم كائن Documentize.TextExtractor لاستخراج النصوص، أو Documentize.ImageExtractor لاستخراج الصور.

المنشئات

PdfExtractor()

protected PdfExtractor()

الدوال

Dispose()

تنفيذ واجهة IDisposable. في الواقع، ليس من الضروري أن يكون ذلك لكائن PdfExtractor.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

المعلمات

  • pdfExtractorOptions IPluginOptions: كائن خيارات يحتوي على تعليمات لـ PdfExtractor.

الإرجاع

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

معلومات

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

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

الوراثة

objectPdfConverterOptionsPdfToDocOptions

التطبيق

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

المنشئات

PdfToDocOptions()

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

public PdfToDocOptions()

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

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

public List<idatasource> Inputs { get; }

قيمة الخاصية

List<IDataSource>

Outputs

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

public List<idatasource> Outputs { get; }

قيمة الخاصية

List<IDataSource>

الطرق

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

المعلمات

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

AddOutput(IDataSource)

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

public void AddOutput(IDataSource saveDataSource)

المعلمات

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

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

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.Optimizer.

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

معلومات

Represents Documentize.Signature plugin. Used to Sign PDF documents.

public static class Signature

Inheritance

objectSignature

Inherited Members

Examples

The example demonstrates how to sign PDF document.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "passwprd_of_your_pfx_file");
// 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
Signature.Process(options);

The example demonstrates how to sign PDF document with extra options.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "passwprd_of_your_pfx_file");
// 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"));
// Optional parameters
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Perform the process
Signature.Process(options);

Methods

Process(SignOptions)

Sign PDF document.

public static ResultContainer Process(SignOptions options)

Parameters

  • options SignOptions: 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 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

معلومات

يمثل خيارات التقسيم لملحق Documentize.Splitter.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

الوراثة

objectPluginBaseOptionsSplitOptions

ينفذ

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

المُنشئات

SplitOptions()

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

public SplitOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Splitter

معلومات

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

public static class Splitter

الوراثة

objectSplitter

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

أمثلة

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

// 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
Splitter.Process(options);

طرق

Process(SplitOptions)

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

public static ResultContainer Process(SplitOptions options)

المعلمات

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

العوائد

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

الاستثناءات

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.

public sealed class TableGenerator

الوراثة

objectTableGenerator

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

أمثلة

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

// Initialize the TableGenerator
var plugin = new TableGenerator();
// Configure table options
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");
// 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
plugin.Process(options);

البانيات

TableGenerator()

public TableGenerator()

الطرق

Process(TableOptions)

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

public ResultContainer Process(TableOptions options)

المعلمات

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

العوائد

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

الاستثناءات

ArgumentException

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

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

معلومات

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

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.

public static class TextExtractor

الوراثة

objectTextExtractor

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

أمثلة

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

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

الطرق

Process(TextExtractorOptions)

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

public static ResultContainer Process(TextExtractorOptions options)

المعلمات

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

العائدات

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 class Timestamp

الوراثة

objectTimestamp

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

أمثلة

المثال يوضح كيفية إضافة Timestamp إلى الوثيقة.

// create Timestamp
var plugin = new Timestamp();
// create AddTimestampOptions object to set instructions
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// add input file path
opt.AddInput(new FileDataSource("path_to_pdf"));
// set output file path
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// perform the process
plugin.Process(opt);

المنشئات

Timestamp()

public Timestamp()

الطرق

Process(AddTimestampOptions)

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

public ResultContainer Process(AddTimestampOptions options)

المعلمات

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

الإرجاع

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

Namespace: Documentize Assembly: Documentize.dll

Class TocGenerator

معلومات

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

public static class TocGenerator

الوراثة

objectTocGenerator

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

أمثلة

توضح هذه المثال كيفية إضافة جدول محتويات إلى ملف 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);

الطرق

Process(TocOptions)

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

public static ResultContainer Process(TocOptions options)

المعلمات

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

العائدات

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

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

معلومات

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

public class TocHeading

الوراثة

objectTocHeading

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

البُناة

TocHeading(string, int, bool, int)

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

public TocHeading(string text, int pageNumber, 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.TocGenerator.

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.

public static class XlsConverter

الوراثة

objectXlsConverter

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

أمثلة

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

// 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_pdf_file.pdf"));
// Perform the process
XlsConverter.Process(options);

الطرق

Process(PdfToXlsOptions)

تحول مستند PDF إلى تنسيق XLSX/XLS.

public static ResultContainer Process(PdfToXlsOptions options)

المعاملات

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

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

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

الاستثناءات

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 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: جدول بيانات Open Document.
  • XLSM = 3: تنسيق ملف Office Open XML (.xlsm) الممكّن للماكرو.
  • XLSX = 1: تنسيق ملف Office Open XML (.xlsx).
  • XMLSpreadSheet2003 = 0: تنسيق ملف Excel 2003 XML (.xls).

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/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.TextExtractorOptions.

public enum TextFormattingMode

Fields

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

Namespace: Documentize Assembly: Documentize.dll

12‏/08‏/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

فئة PdfExtractorOptions

معلومات

تمثل خيارات لمكونات TextExtractor و ImageExtractor.

public abstract class PdfExtractorOptions : IPluginOptions

التوريث

objectPdfExtractorOptions

المشتق

التطبيق

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

الملاحظات

تحتوي Documentize.PdfExtractorOptions على وظائف أساسية لإضافة بيانات (ملفات، تدفقات) تمثل مستندات PDF المدخلة. يرجى إنشاء Documentize.TextExtractorOptions أو ImageExtractorOptions بدلًا من ذلك.

الخصائص

المدخلات

تُرجع مجموعة بيانات مكون PdfExtractor.

public List<idatasource> Inputs { get; }

قيمة الخاصية

List<IDataSource>

OperationName

تُرجع اسم العملية

public virtual string OperationName { get; }

قيمة الخاصية

string

الطرق

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

المعلمات

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

Namespace: Documentize Assembly: Documentize.dll

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

معلومات

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

public static class Info

الوراثة

objectInfo

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

الحقول

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

قيمة الحقل

string

المنتج

اسم المنتج.

public const string Product = "Documentize"

قيمة الحقل

string

Namespace: Documentize Assembly: Documentize.dll

 عربي