توثيق فضاء الاسم الأقسام الفرعية
Builder خلية الجدول
معلومات
الفئة تمثل الباني لخلية الجدول.
public class TableCellBuilder : TableRowBuilder
الوراثة
object ←
TableBuilder ←
TableRowBuilder ←
TableCellBuilder
الأعضاء الموروثة
- TableRowBuilder.AddCell(),
- TableRowBuilder.AddRow(),
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
الطرق
AddCell()
إضافة خلية إلى الجدول.
public override TableCellBuilder AddCell()
العوائد
TableCellBuilder : مثيل من Documentize.TableCellBuilder الحالي.
AddParagraph(params string[])
إضافة فقرات إلى خلية الجدول.
public TableCellBuilder AddParagraph(params string[] paragraphs)
المعلمات
paragraphs
string[]: نص للفقرات.
العوائد
TableCellBuilder : مثيل من Documentize.TableCellBuilder الحالي.
Class PdfChatGpt
public sealed class PdfChatGpt : IDisposable
الوراثة
object ←
PdfChatGpt
يطبق
الأعضاء الموروثة
أمثلة
المثال يوضح كيفية استخدام مكون PdfChatGpt عن طريق إضافة رسائل إلى الطلب.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // إضافة مسار الملف الناتج.
options.ApiKey = "مفتاح API الخاص بك."; // تحتاج إلى تقديم المفتاح للوصول إلى واجهة البرمجة.
options.MaxTokens = 1000; // الحد الأقصى لعدد الرموز التي سيتم توليدها في إتمام المحادثة.
// إضافة رسائل الطلب.
options.Messages.Add(new Message
{
Content = "أنت مساعد مفيد.",
Role = Role.System
});
options.Messages.Add(new Message
{
Content = "ما هو أكبر قطر بيتزا تم صنعه على الإطلاق؟",
Role = Role.User
});
// معالجة الطلب.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إتمام المحادثة لواجهة برمجة ChatGPT.
}
المثال يوضح كيفية استخدام مكون PdfChatGpt عن طريق إضافة رسالة واحدة إلى الطلب.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // إضافة مسار الملف الناتج.
options.ApiKey = "مفتاح API الخاص بك."; // تحتاج إلى تقديم المفتاح للوصول إلى واجهة البرمجة.
options.MaxTokens = 1000; // الحد الأقصى لعدد الرموز التي سيتم توليدها في إتمام المحادثة.
// إضافة رسالة الطلب.
// في هذه الحالة، يتم إضافة رسالة النظام مع المحتوى = "أنت مساعد مفيد." بشكل افتراضي.
// دور رسالة الاستفسار هو "مستخدم" بشكل افتراضي.
options.Query = "ما هي أدنى درجة حرارة تم تسجيلها على الأرض؟";
// معالجة الطلب.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إتمام المحادثة لواجهة برمجة ChatGPT.
}
المثال يوضح كيفية استخدام مكون 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 = "مفتاح API الخاص بك."; // تحتاج إلى تقديم المفتاح للوصول إلى واجهة البرمجة.
options.MaxTokens = 1000; // الحد الأقصى لعدد الرموز التي سيتم توليدها في إتمام المحادثة.
// إضافة رسالة الطلب.
// في هذه الحالة، يتم إضافة رسالة النظام مع المحتوى = "أنت مساعد مفيد." بشكل افتراضي.
// دور رسالة الاستفسار هو "مستخدم" بشكل افتراضي.
options.Query = "كم عدد الأحرف في النص المقدم؟";
// معالجة الطلب.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // كائن إتمام المحادثة لواجهة برمجة ChatGPT.
}
ملاحظات
يستخدم كائن Documentize.PdfChatGpt لإرسال الطلبات إلى ChatGPT مباشرة
أو عن طريق إضافة مصادر ملفات PDF وحفظ الرد إلى المصدر الناتج.
المُنشئون
PdfChatGpt()
يبدأ مثيلًا جديدًا من كائن Documentize.PdfChatGpt.
الطرق
Dispose()
تنفيذ لـ IDisposable. في الواقع، ليس من الضروري لـ PdfChatGpt.
Process(IPluginOptions)
لا يوجد إصدار متزامن من هذه الطريقة. استخدم طريقة ProcessAsync بدلاً من ذلك.
public ResultContainer Process(IPluginOptions options)
المعلمات
العائدات
ResultContainer : #### الاستثناءات
NotImplementedException
ProcessAsync(IPluginOptions)
يبدأ معالجة PdfChatGpt مع المعلمات المحددة.
public Task<resultcontainer> ProcessAsync(IPluginOptions options)
المعلمات
العائدات
Task<ResultContainer>
كائن المهمة يمثل العملية غير المتزامنة.
الاستثناءات
ArgumentException : InvalidOperationException
SetCancellationToken(CancellationToken)
يضبط رمز الإلغاء.
public void SetCancellationToken(CancellationToken cancellationToken)
المعلمات
معلومات
يمثل الوظائف الأساسية لاستخراج النصوص والصور وأنواع أخرى من المحتوى التي قد تحدث على صفحات مستندات PDF.
public abstract class PdfExtractor : IDisposable
الوراثة
object ←
PdfExtractor
المشتقات
ينفذ
الأعضاء الموروثة
أمثلة
يوضح المثال كيفية استخراج محتوى النص من مستند 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 لاستخراج الصور.
المنشئات
الدوال
تنفيذ واجهة IDisposable. في الواقع، ليس من الضروري أن يكون ذلك لكائن PdfExtractor.
يبدأ معالجة PdfExtractor بالمعلمات المحددة.
public ResultContainer Process(IPluginOptions pdfExtractorOptions)
المعلمات
pdfExtractorOptions
IPluginOptions: كائن خيارات يحتوي على تعليمات لـ PdfExtractor.
الإرجاع
ResultContainer : كائن ResultContainer يحتوي على نتيجة الاستخراج.
Enum ConvertErrorAction
معلومات
تمثل هذه الفئة إجراءً لأخطاء التحويل.
public enum ConvertErrorAction
Fields
Enum ConvertSoftMaskAction
معلومات
تمثل هذه العملية إجراءات لتحويل الصور باستخدام القناع الناعم.
public enum ConvertSoftMaskAction
Fields
ConvertToStencilMask = 1
: سيتم تحويل القناع الناعم إلى قناع قالب.Default = 0
: استخدم الاستراتيجية الافتراضية.
Enum HtmlPageLayoutOption
معلومات
يحدد الأعلام التي تحدد مع خيارات أخرى أحجام وتنسيقات الصفحات.
public enum HtmlPageLayoutOption
Fields
FitToWidestContentWidth = 3
: يشير إلى أن عرض الصفحة يتم تحديده من حجم المحتوى نفسه، وليس من عرض الصفحة المحدد.None = 0
: القيمة الافتراضية التي تشير إلى أن HtmlPageLayoutOption لن يؤثر على أحجام وتنسيقات الصفحات.ScaleToPageWidth = 256
: يشير إلى أن محتوى الوثيقة سيتم تحجيمه ليتناسب مع الصفحة.
Enum PdfAStandardVersion
معلومات
يحدد إصدار معيار PDF/A لوثيقة PDF.
public enum PdfAStandardVersion
Fields
Auto = 0
: يتم تحديد إصدار معيار PDF/A تلقائياً.PDF_A_1A = 1
: يحدد إصدار معيار PDF/A-1a.PDF_A_1B = 2
: يحدد إصدار معيار PDF/A-1b.PDF_A_2A = 3
: يحدد إصدار معيار PDF/A-2a.PDF_A_2B = 4
: يحدد إصدار معيار PDF/A-2b.PDF_A_2U = 5
: يحدد إصدار معيار PDF/A-2u.PDF_A_3A = 6
: يحدد إصدار معيار PDF/A-3a.PDF_A_3B = 7
: يحدد إصدار معيار PDF/A-3b.PDF_A_3U = 8
: يحدد إصدار معيار PDF/A-3u.
Enum PdfToHtmlOptions.SaveDataType
معلومات
يحدد نوع المخرج لملف HTML.
public enum PdfToHtmlOptions.SaveDataType
Fields
FileWithEmbeddedResources = 1
: حفظ HTML في ملف مع موارد مضمنةFileWithExternalResources = 0
: حفظ HTML في ملف مع موارد خارجيةStreamWithEmbeddedResources = 2
: حفظ HTML في دفق ملف مع موارد مضمنة
معلومات
يتيح تحديد تنسيق ملف .xlsx أو .xls/xml أو csv. القيمة الافتراضية هي XLSX.
يتيح تحديد تنسيق ملف .xlsx أو .xls/xml أو csv.
القيمة الافتراضية هي XLSX.
public enum PdfToXlsOptions.ExcelFormat
Fields
CSV = 2
: تنسيق ملف القيم المفصولة بفواصل (CSV).ODS = 4
: جدول بيانات المستند المفتوح.XLSM = 3
: تنسيق ملف Office Open XML (.xlsm) المدعوم بالماكرو.XLSX = 1
: تنسيق ملف Office Open XML (.xlsx).XMLSpreadSheet2003 = 0
: تنسيق ملف Excel 2003 XML (.xls).
معلومات
يحدد أوضاعًا مختلفة يمكن استخدامها عند تحويل مستند PDF إلى نص. راجع فئة Documentize.TextExtractorOptions.
public enum TextExtractorOptions.TextFormattingMode
Fields
Plain = 2
: يمثل محتوى نص PDF مع الأخذ في الاعتبار موضع النص النسبي ولكن دون إضافة مسافات إضافية.Pure = 0
: يمثل محتوى نص PDF مع بعض روتينات التنسيق. وهذا يشمل الأخذ في الاعتبار المواقع النسبية وإضافة مسافات إضافية لمحاذاة النص مع عرض الصفحة.Raw = 1
: يمثل محتوى PDF كما هو، أي بدون تنسيق.
XlsConverter فئة
معلومات
يمثل ملحق Documentize.XlsConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق XLSX/XLS.
public sealed class XlsConverter
الوراثة
object ←
XlsConverter
الأعضاء الموروثة
أمثلة
المثال يوضح كيفية تحويل PDF إلى مستند XLSX.
// إنشاء XlsConverter
var plugin = new XlsConverter();
// إنشاء PdfToXlsOptions
var opt = new PdfToXlsOptions();
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath"));
// تعيين مسار ملف الإخراج
opt.AddOutput(new FileDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
البانيات
XlsConverter()
الطرق
Process(PdfToXlsOptions)
يبدأ معالجة Documentize.XlsConverter مع المعلمات المحددة.
public ResultContainer Process(PdfToXlsOptions options)
المعلمات
العائدات
ResultContainer : كائن Documentize.ResultContainer يحتوي على نتيجة العملية.
أمان الفئة
معلومات
يمثل ملحق Documentize.Security.
public sealed class Security
الوراثة
object ←
Security
الأعضاء الموروثة
أمثلة
تعرض هذه المثال كيفية تشفير مستند PDF.
// إنشاء Security
var plugin = new Security();
// إنشاء كائن EncryptionOptions لتحديد التعليمات
var opt = new EncryptionOptions("123456", "qwerty");
// إضافة مسار الملف المدخل
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسار الملف الناتج
opt.AddOutput(new FileDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
تعرض هذه المثال كيفية فك تشفير مستند PDF.
// إنشاء Security
var plugin = new Security();
// إنشاء كائن DecryptionOptions لتحديد التعليمات
var opt = new DecryptionOptions("123456"));
// إضافة مسار الملف المدخل
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسار الملف الناتج
opt.AddOutput(new FileDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
المنشئات
Security()
الطرق
Process(IPluginOptions)
يبدأ معالجة Documentize.Security مع المعلمات المحددة.
public ResultContainer Process(IPluginOptions options)
المعلمات
options
IPluginOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.Security.
يعود
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
الاستثناءات
InvalidOperationException
إضافة خيارات طابع زمني
معلومات
تمثل خيارات إضافة الطابع الزمني لإضافات Documentize.Timestamp.
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
AddTimestampOptions
التنفيذ
الأعضاء الموروثة
المنشئون
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”. (اختياري).
باني الجدول الفئة
معلومات
الفئة تمثل باني للجدول في صفحة PDF.
public class TableBuilder
الوراثة
object ←
TableBuilder
المشتقة
الأعضاء الموروثة
الطرق
AddRow()
إضافة صف جديد إلى الجدول.
public virtual TableRowBuilder AddRow()
Returns
TableRowBuilder : مثيل من Documentize.TableRowBuilder الحالي.
AddTable()
إضافة جدول جديد إلى الوثيقة.
public TableBuilder AddTable()
Returns
TableBuilder : مثيل من Documentize.TableBuilder الحالي.
InsertPageAfter(int)
إدراج صفحة بعد الصفحة المحددة.
public TableOptions InsertPageAfter(int page)
Parameters
page
int: رقم الصفحة لإدراج الجدول بعدها.
Returns
TableOptions : مثيل من Documentize.TableOptions الحالي.
InsertPageBefore(int)
إدراج صفحة قبل الصفحة المحددة.
public TableOptions InsertPageBefore(int page)
Parameters
page
int: رقم الصفحة لإدراج الجدول بعدها.
Returns
TableOptions : مثيل من Documentize.TableOptions الحالي.
المشغلون
implicit operator TableOptions(TableBuilder)
تحويل الباني Documentize.TableBuilder إلى الخيارات Documentize.TableOptions
public static implicit operator TableOptions(TableBuilder builder)
Parameters
builder
TableBuilder: مثيل من Documentize.TableBuilder الحالي.
Returns
TableOptions : نتيجة التحويل إلى PdfGeneratorTableOptions.
باني صف الجدول
معلومات
الفئة تمثل الباني لصف الجدول.
public class TableRowBuilder : TableBuilder
الوراثة
object ←
TableBuilder ←
TableRowBuilder
المشتقات
الأعضاء الموروثة
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
الطرق
AddCell()
إضافة خلية إلى صف الجدول.
public virtual TableCellBuilder AddCell()
العائدات
TableCellBuilder : كائن تم إنشاؤه من Documentize.TableCellBuilder.
AddRow()
تجاوز AddRow.
public override TableRowBuilder AddRow()
العائدات
TableRowBuilder : كائن من Documentize.TableRowBuilder الحالية.
تحسين خيارات الفئة
معلومات
تمثل خيارات التحسين لملحق Documentize.Optimizer.
public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
OptimizeOptions
التنفيذ
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئون
OptimizeOptions()
يُهيئ مثيلًا جديدًا من كائن Documentize.OptimizeOptions مع الخيارات الافتراضية.
تسلسل الوثيقة من أجل
- فتح الصفحة الأولى في أسرع وقت ممكن؛
- عرض الصفحة التالية أو الانتقال عبر الرابط إلى الصفحة التالية في أسرع وقت ممكن؛
- عرض الصفحة بشكل تدريجي عند وصولها عندما يتم تسليم البيانات لصفحة عبر قناة بطيئة (عرض البيانات الأكثر فائدة أولاً)؛
- السماح بتفاعل المستخدم، مثل اتباع الرابط، ليتم تنفيذه حتى قبل أن يتم استلام الصفحة الكاملة وعرضها.
تدوير التعداد
معلومات
التعداد لقيم التدوير المحتملة.
الحقول
None = 0
: غير مُدوَّر.On180 = 2
: مُدَوَّر بزاوية 180 درجة.On270 = 3
: مُدَوَّر بزاوية 270 درجة مع عقارب الساعة.On360 = 4
: مُدَوَّر بزاوية 360 درجة مع عقارب الساعة.On90 = 1
: مُدَوَّر بزاوية 90 درجة مع عقارب الساعة.
ترخيص الفئة
معلومات
يوفر طريقة لتعيين الترخيص.
public static class License
الوراثة
object ←
License
الأعضاء الموروثون
أمثلة
يظهر كيفية تنشيط الترخيص.
// تعيين الترخيص
License.Set("PathToLicense.lic");
طرق
Set(string)
يرخص المكون.
public static void Set(string licenseName)
المعلمات
licenseName
string: يمكن أن يكون اسم ملف كامل أو قصير. استخدم سلسلة فارغة للتبديل إلى وضع التقييم.
توقيع الفئة
معلومات
يُمثل مكون Documentize.Signature.
public sealed class Signature
الوراثة
object ←
Signature
الأعضاء الموروثون
أمثلة
المثال يوضح كيفية توقيع مستند PDF.
// إنشاء توقيع
var plugin = new Signature();
// إنشاء كائن SignOptions لتحديد التعليمات
var opt = new SignOptions(inputPfx, inputPfxPassword);
// إضافة مسار الملف المدخل
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسار الملف الناتج
opt.AddOutput(new FileDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
البانيون
Signature()
الطرق
Process(IPluginOptions)
يبدأ معالجة Documentize.Signature مع المعلمات المحددة.
public ResultContainer Process(IPluginOptions options)
المعلمات
options
IPluginOptions: كائن خيارات يحتوي على التعليمات الخاصة بـ Documentize.Signature.
العائدات
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
الاستثناءات
InvalidOperationException
حجم الصفحة الفئوي
معلومات
فئة تمثل حجم الصفحة في وثيقة PDF.
الوراثة
object ←
PageSize
المشتقات
الأعضاء الموروثة
البناة
PageSize()
منشئ Documentize.PageSize. أحجام A4 بشكل افتراضي.
PageSize(double, double)
منشئ Documentize.PageSize.
public PageSize(double width, double height)
المعلمات
الخصائص
A0
حجم A0 (1189x840 مم).
public static PageSize A0 { get; }
قيمة الخاصية
PageSize
A1
حجم A1 (840x594 مم).
public static PageSize A1 { get; }
قيمة الخاصية
PageSize
A2
حجم A2 (594x420 مم).
public static PageSize A2 { get; }
قيمة الخاصية
PageSize
A3
حجم A3 (420x297 مم).
public static PageSize A3 { get; }
قيمة الخاصية
PageSize
A4
حجم A4 (297x210 مم).
public static PageSize A4 { get; }
قيمة الخاصية
PageSize
A5
حجم A5 (210x148 مم).
public static PageSize A5 { get; }
قيمة الخاصية
PageSize
A6
حجم A6 (148x105 مم).
public static PageSize A6 { get; }
قيمة الخاصية
PageSize
B5
حجم B5 (250x176 مم).
public static PageSize B5 { get; }
قيمة الخاصية
PageSize
الارتفاع
يحصل أو يحدد ارتفاع الصفحة.
public double Height { get; set; }
قيمة الخاصية
double
IsLandscape
يحصل على اتجاه الصفحة. يُرجع صحيح إذا كان هذا هو الاتجاه الأفقي وخاطئ إذا كان عمودي.
public bool IsLandscape { get; }
قيمة الخاصية
bool
P11x17
تنسيق 11x17 بوصة.
public static PageSize P11x17 { get; }
قيمة الخاصية
PageSize
PageLedger
حجم دفتر الأستاذ (432x279 مم).
public static PageSize PageLedger { get; }
قيمة الخاصية
PageSize
PageLegal
الحجم القانوني (356x216 مم).
public static PageSize PageLegal { get; }
قيمة الخاصية
PageSize
PageLetter
حجم الرسالة (279x216 مم).
public static PageSize PageLetter { get; }
قيمة الخاصية
PageSize
العرض
يحصل أو يحدد عرض الصفحة.
public double Width { get; set; }
قيمة الخاصية
double
خيارات PdfAValidate
معلومات
تمثل الخيارات للتحقق من الامتثال لـ PDF/A لوثائق PDF مع ملحق Documentize.PdfAConverter.
public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions
الوراثة
object ←
PdfAOptionsBase ←
PdfAValidateOptions
التنفيذ
الأعضاء الموروثة
- PdfAOptionsBase.AddInput(IDataSource),
- PdfAOptionsBase.Inputs,
- PdfAOptionsBase.PdfAVersion,
- PdfAOptionsBase.IsLowMemoryMode,
- PdfAOptionsBase.LogOutputSource,
- PdfAOptionsBase.ErrorAction,
- PdfAOptionsBase.SoftMaskAction,
- PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
- PdfAOptionsBase.AlignText,
- PdfAOptionsBase.OptimizeFileSize,
- PdfAOptionsBase.IccProfileFileName,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
البناة
PdfAValidateOptions()
public PdfAValidateOptions()
خيارات PdfToDoc
معلومات
تمثل خيارات تحويل PDF إلى DOC لإضافة Documentize.DocConverter.
public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions
الوراثة
object ←
PdfConverterOptions ←
PdfToDocOptions
يتم تطبيقه
الأعضاء الموروثة
- PdfConverterOptions.AddInput(IDataSource),
- PdfConverterOptions.AddOutput(IDataSource),
- PdfConverterOptions.Inputs,
- PdfConverterOptions.Outputs,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئون
PdfToDocOptions()
يمثل تهيئة مثيل جديد من كائن Documentize.PdfToDocOptions مع الخيارات الافتراضية.
خيارات PdfToJpeg
معلومات
تمثل خيارات تحويل PDF إلى JPEG لملحق Documentize.JpegConverter.
public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
PdfToJpegOptions
التنفيذ
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المُنشئون
PdfToJpegOptions()
يهيئ مثيلاً جديداً من كائن Documentize.PdfToJpegOptions.
public PdfToJpegOptions()
الخصائص
OutputResolution
يحصل أو يحدد قيمة دقة الصور الناتجة.
public int OutputResolution { get; set; }
قيمة الخاصية
int
PageList
يحصل أو يحدد قائمة الصفحات للعملية.
public List<int> PageList { get; set; }
قيمة الخاصية
List<int>
Quality
يحصل على جودة المخرجات ويحددها.
public int Quality { get; set; }
قيمة الخاصية
int
خيارات استخراج الصور من الفئة
معلومات
يمثل خيارات استخراج الصور لإضافة Documentize.ImageExtractor.
public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions
الوراثة
object ←
PdfExtractorOptions ←
ImageExtractorOptions
تنفيذ
الأعضاء الموروثة
الملاحظات
يرث وظائف لإضافة بيانات (ملفات، تدفقات) تمثل مستندات PDF المدخلة.
البناة
يوفر مثيل جديد من كائن Documentize.ImageExtractorOptions.
public ImageExtractorOptions()
الخصائص
يُرجع اسم العملية.
public override string OperationName { get; }
قيمة الخاصية
string
خيارات استخراج النص من الفئة
معلومات
يمثل خيارات استخراج النص من الإضافة Documentize.TextExtractor.
public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions
الوراثة
object ←
PdfExtractorOptions ←
TextExtractorOptions
التنفيذات
الأعضاء الموروثة
- PdfExtractorOptions.AddInput(IDataSource),
- PdfExtractorOptions.Inputs,
- PdfExtractorOptions.OperationName,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
أمثلة
تظهر المثال كيفية استخراج محتوى النص من مستند PDF.
// إنشاء كائن TextExtractor لاستخراج محتويات PDF
using (TextExtractor extractor = new TextExtractor())
{
// إنشاء كائن TextExtractorOptions لتعيين TextFormattingMode (نظيف أو خام - افتراضي)
extractorOptions = new TextExtractorOptions(TextExtractorOptions.TextFormattingMode.Pure);
// إضافة مسار ملف الإدخال إلى مصادر البيانات
extractorOptions.AddInput(new FileDataSource(inputPath));
// تنفيذ عملية الاستخراج
ResultContainer resultContainer = extractor.Process(extractorOptions);
// الحصول على النص المستخرج من كائن ResultContainer
string textExtracted = resultContainer.ResultCollection[0].ToString();
}
ملاحظات
يستخدم كائن Documentize.TextExtractorOptions لتعيين Documentize.TextExtractorOptions.TextFormattingMode وخيارات أخرى لعملية استخراج النص.
أيضًا، يرث وظائف لإضافة البيانات (الملفات، التدفقات) التي تمثل مستندات PDF المدخلة.
المنشئون
يبدأ مثيل جديد من كائن Documentize.TextExtractorOptions لوضع تنسيق النص المحدد.
public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)
المعلمات
يبدأ مثيل جديد من كائن Documentize.TextExtractorOptions مع وضع تنسيق النص ‘خام’ (افتراضي).
public TextExtractorOptions()
الخصائص
يحصل على وضع التنسيق.
public TextExtractorOptions.TextFormattingMode FormattingMode { get; }
قيمة الخاصية
TextExtractorOptions.TextFormattingMode
يعيد اسم العملية.
public override string OperationName { get; }
قيمة الخاصية
string
خيارات التشفير للفئة
معلومات
تمثل خيارات التشفير لإضافة 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
خيارات التوقيع في الفئة
معلومات
تمثل خيارات التوقيع لإضافة Documentize.Signature.
public sealed class SignOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
SignOptions
تنفيذ
الأعضاء المتوارثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئون
SignOptions(string, string)
يهيئ عنصر جديد من كائن Documentize.SignOptions مع خيارات افتراضية.
public SignOptions(string pfx, string password)
المعاملات
pfx
string: المسار إلى ملف pfx.password
string: كلمة المرور لملف pfx.
SignOptions(Stream, string)
يهيئ عنصر جديد من كائن Documentize.SignOptions مع خيارات افتراضية.
public SignOptions(Stream pfx, string password)
المعاملات
pfx
Stream: التدفق مع ملف pfx.password
string: كلمة المرور لملف pfx.
الخصائص
الاتصال بالتوقيع.
public string Contact { get; set; }
قيمة الخاصية
string
الموقع
موقع التوقيع.
public string Location { get; set; }
قيمة الخاصية
string
الاسم
اسم حقل التوقيع الموجود.
Null لإنشاء حقل جديد.
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.Merger.
public sealed class MergeOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
MergeOptions
التنفيذ
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئون
MergeOptions()
يقوم بتهيئة مثيل جديد من كائن Documentize.MergeOptions مع الخيارات الافتراضية.
خيارات تحويل Pdf إلى Xls
معلومات
يمثل خيارات تحويل PDF إلى XLSX لإضافة Documentize.XlsConverter.
public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions
الوراثة
object ←
PdfConverterOptions ←
PdfToXlsOptions
التنفيذ
الأعضاء الموروثة
- PdfConverterOptions.AddInput(IDataSource),
- PdfConverterOptions.AddOutput(IDataSource),
- PdfConverterOptions.Inputs,
- PdfConverterOptions.Outputs,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
البناة
PdfToXlsOptions()
يبدأ مثيلًا جديدًا من كائن Documentize.PdfToXlsOptions مع خيارات الافتراضية.
الخصائص
تنسيق المخرجات.
public PdfToXlsOptions.ExcelFormat Format { get; set; }
قيمة الخاصية
PdfToXlsOptions.ExcelFormat
إدراج عمود فارغ أولاً
اضبط على صحيح إذا كنت بحاجة إلى إدراج عمود فارغ كأول عمود في ورقة العمل.
قيمة الافتراضية هي خطأ؛ مما يعني أنه لن يتم إدراج عمود فارغ.
public bool InsertBlankColumnAtFirst { get; set; }
قيمة الخاصية
bool
تقليل عدد أوراق العمل
اضبط على صحيح إذا كنت بحاجة إلى تقليل عدد أوراق العمل في دفتر العمل الناتج.
قيمة الافتراضية هي خطأ؛ مما يعني حفظ كل صفحة PDF كورقة عمل منفصلة.
public bool MinimizeTheNumberOfWorksheets { get; set; }
قيمة الخاصية
bool
خيارات تغيير الحجم للفئة
معلومات
تمثل خيارات تغيير الحجم لإضافة Documentize.Optimizer.
public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
ResizeOptions
التطبيقات
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المُنشئات
ResizeOptions()
يبدأ مثيلًا جديدًا من كائن Documentize.ResizeOptions مع الخيارات الافتراضية.
الخصائص
PageSize
يحصل على أو يحدد حجم الصفحة الجديد.
public PageSize PageSize { get; set; }
قيمة الخاصية
PageSize
خيارات تقسيم الفئة
معلومات
تمثل خيارات التقسيم لإضافات Documentize.Splitter.
public sealed class SplitOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
SplitOptions
التطبيق
الأعضاء الموروثة
المنشئون
SplitOptions()
تهيئة مثيل جديد من كائن Documentize.SplitOptions مع خيارات افتراضية.
خيارات جدول الفئة
معلومات
يمثل خيارات إضافة جدول إلى المستند بواسطة مكون Documentize.TableGenerator.
public sealed class TableOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
TableOptions
تنفيذ
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
الباني
TableOptions()
يبدأ مثيل جديد من كائن Documentize.TableOptions بخيارات افتراضية.
الطرق
AddTable()
إضافة جدول إلى المستند.
public TableBuilder AddTable()
العائدات
TableBuilder : مثيل جديد من Documentize.TableBuilder.
Create()
إنشاء مثيل من Documentize.TableOptions.
public static TableOptions Create()
العائدات
TableOptions : مثيل جديد من Documentize.TableOptions.
InsertPageAfter(int)
إضافة صفحة بعد الصفحة المحددة.
public TableOptions InsertPageAfter(int page)
المعلمات
page
int: رقم الصفحة لإضافة الجدول بعدها.
العائدات
TableOptions : مثيل من Documentize.TableOptions الحالية.
InsertPageBefore(int)
إضافة صفحة قبل الصفحة المحددة.
public TableOptions InsertPageBefore(int page)
المعلمات
page
int: رقم الصفحة لإضافة الجدول بعدها.
العائدات
TableOptions : مثيل من Documentize.TableOptions الحالية.
خيارات دوران الفئة
معلومات
يمثل خيارات الدوران لإضافة Documentize.Optimizer.
public sealed class RotateOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
RotateOptions
التنفيذات
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئات
RotateOptions()
ينشئ مثيلًا جديدًا من كائن Documentize.RotateOptions مع خيارات افتراضية.
الخصائص
Rotation
يحصل على أو يحدد دوران الصفحات الجديدة.
public Rotation Rotation { get; set; }
قيمة الخاصية
Rotation
خيارات فك التشفير
معلومات
تمثل خيارات فك التشفير لملحق Documentize.Security.
public class DecryptionOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
DecryptionOptions
التنفيذات
الأعضاء الموروثين
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئات
DecryptionOptions(string)
يتم تهيئة مثيل جديد من كائن Documentize.DecryptionOptions بخيارات افتراضية.
public DecryptionOptions(string ownerPassword)
المعلمات
ownerPassword
string: كلمة مرور المالك.
الخصائص
OwnerPassword
كلمة مرور المالك.
public string OwnerPassword { get; set; }
قيمة الخاصية
string
خياراتPdfAConvert
معلومات
يمثل الخيارات لتحويل مستندات PDF إلى صيغة PDF/A باستخدام ملحق Documentize.PdfAConverter.
public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions
الوراثة
object ←
PdfAOptionsBase ←
PdfAConvertOptions
ينفذ
الأعضاء الموروثة
- PdfAOptionsBase.AddInput(IDataSource),
- PdfAOptionsBase.Inputs,
- PdfAOptionsBase.PdfAVersion,
- PdfAOptionsBase.IsLowMemoryMode,
- PdfAOptionsBase.LogOutputSource,
- PdfAOptionsBase.ErrorAction,
- PdfAOptionsBase.SoftMaskAction,
- PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
- PdfAOptionsBase.AlignText,
- PdfAOptionsBase.OptimizeFileSize,
- PdfAOptionsBase.IccProfileFileName,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المُنشئون
PdfAConvertOptions()
public PdfAConvertOptions()
الخصائص
النتائج
يحصل على مجموعة من الأهداف المضافة (مصادر البيانات للملف أو التدفق) لحفظ نتائج العمليات.
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
AddOutput(IDataSource)
يضيف هدف حفظ جديد للنتائج.
public void AddOutput(IDataSource dataSource)
المعلمات
dataSource
IDataSource: الهدف (ملف أو مصدر بيانات تدفق) لحفظ نتائج العملية. :
دليل مصدر البيانات للفئة
معلومات
يمثل بيانات الدليل لعمليات التحميل والحفظ لمكون إضافي.
public sealed class DirectoryDataSource : IDataSource
الوراثة
object ←
DirectoryDataSource
ينفذ
الأعضاء الموروثة
البناة
DirectoryDataSource(string)
يقوم بتهيئة بيانات الدليل الجديدة باستخدام المسار المحدد.
public DirectoryDataSource(string path)
المعلمات
path
string: سلسلة تمثل المسار إلى الدليل.
الخصائص
DataType
نوع مصدر البيانات.
public DataType DataType { get; }
قيمة الخاصية
DataType
Path
يحصل على المسار إلى دليل البيانات الحالي.
public string Path { get; }
قيمة الخاصية
string
دمج الفئات
معلومات
يمثل المكون الإضافي Documentize.Merger. يُستخدم لدمج مستندات PDF متعددة في ملف PDF واحد.
public sealed class Merger
الوراثة
object ←
Merger
الأعضاء الموروثة
أمثلة
يظهر المثال كيفية دمج مستندين PDF.
// إنشاء Merger
var plugin = new Merger();
// إنشاء كائن MergeOptions لتعيين التعليمات
var opt = new MergeOptions();
// إضافة مسارات ملفات المدخلات
opt.AddInput(new FileDataSource(inputPath1));
opt.AddInput(new FileDataSource(inputPath2));
// تعيين مسار ملف الإخراج
opt.AddOutput(new FileDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
المنشئات
Merger()
الطرق
Process(MergeOptions)
يبدأ معالجة Documentize.Merger بالمعلمات المحددة.
public ResultContainer Process(MergeOptions options)
المعلمات
options
MergeOptions: كائن الخيارات الذي يحتوي على تعليمات للعملية.
العائدات
ResultContainer : كائن Documentize.ResultContainer يحتوي على نتيجة العملية.
دور التعداد
الحقول
Assistant = 2
System = 1
User = 0
رسالة الفئة
معلومات
رسالة إكمال الدردشة الناتجة عن النموذج.
الوراثة
object ←
Message
الأعضاء الموروثون
المنشئون
Message()
الخصائص
المحتوى
محتويات الرسالة.
[JsonProperty("content")]
public string Content { get; set; }
قيمة الخاصية
string
الدور
يضبط أو يحصل على دور مؤلف هذه الرسالة.
[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }
قيمة الخاصية
Role
طابع زمني للفئة
معلومات
يمثل مكون Documentize.Timestamp.
الوراثة
object ←
Timestamp
الأعضاء الموروثة
أمثلة
توضح هذه المثال كيفية إضافة طابع زمني إلى الوثيقة.
// إنشاء طابع زمني
var plugin = new Timestamp();
// إنشاء كائن AddTimestampOptions لتحديد التعليمات
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource("path_to_pdf"));
// تعيين مسار ملف الإخراج
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// تنفيذ العملية
plugin.Process(opt);
المنشئين
Timestamp()
الطرق
Process(AddTimestampOptions)
يبدأ معالجة Documentize.Timestamp مع المعلمات المحددة.
public ResultContainer Process(AddTimestampOptions options)
المعلمات
Returns
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
فئة CompressOptions
معلومات
يمثل خيارات الضغط للإضافة Documentize.Optimizer.
public sealed class CompressOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
CompressOptions
تنفيذ
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئات
CompressOptions()
يهيئ مثيلًا جديدًا من كائن Documentize.CompressOptions مع خيارات افتراضية.
فئة FileResult
معلومات
يمثل نتيجة العملية في شكل مسار نصي إلى ملف.
public sealed class FileResult : IOperationResult
الوراثة
object ←
FileResult
التنفيذ
الأعضاء الموروثة
الخصائص
البيانات
يحصل على البيانات الخام.
public object Data { get; }
قيمة الخاصية
object
IsFile
يشير إلى ما إذا كانت النتيجة مسارًا إلى ملف إخراج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsStream
يشير إلى ما إذا كانت النتيجة تيار إخراج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
يشير إلى ما إذا كانت النتيجة سلسلة نصية.
public bool IsString { get; }
قيمة الخاصية
bool
الأساليب
ToFile()
يحاول تحويل النتيجة إلى ملف.
العائدات
string : سلسلة تمثل المسار إلى ملف الإخراج إذا كانت النتيجة ملف؛ خلاف ذلك null
.
ToStream()
يحاول تحويل النتيجة إلى كائن تيار.
العائدات
Stream : كائن تيار يمثل بيانات الإخراج إذا كانت النتيجة تيار؛ خلاف ذلك null
.
فئة HtmlToPdfOptions
معلومات
يمثل خيارات تحويل HTML إلى PDF لملحق Documentize.HtmlConverter.
public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
HtmlToPdfOptions
ينفذ
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
البانيين
HtmlToPdfOptions()
يهيئ مثيل جديد من كائن Documentize.HtmlToPdfOptions.
public HtmlToPdfOptions()
الخصائص
BasePath
مسار/عنوان URL الأساسي لملف html.
public string BasePath { get; set; }
قيمة الخاصية
string
يحصل على أو يقرر أنواع الوسائط الممكنة المستخدمة أثناء الريندرينغ.
public HtmlMediaType HtmlMediaType { get; set; }
قيمة الخاصية
HtmlMediaType
IsRenderToSinglePage
يحصل على أو يقرر ريندرينغ الوثيقة بأكملها إلى صفحة واحدة.
public bool IsRenderToSinglePage { get; set; }
قيمة الخاصية
bool
PageInfo
يحصل على أو يقرر معلومات صفحة الوثيقة.
public PageInfo PageInfo { get; set; }
قيمة الخاصية
PageInfo
PageLayoutOption
يحصل على أو يقرر خيار التخطيط.
public HtmlPageLayoutOption PageLayoutOption { get; set; }
قيمة الخاصية
HtmlPageLayoutOption
معلومات
يمثل مكون Documentize.ImageExtractor. يُستخدم لاستخراج الصور من مستندات PDF.
public class ImageExtractor : PdfExtractor, IDisposable
الوراثة
object ←
PdfExtractor ←
ImageExtractor
تطبيق
الأعضاء الموروثة
- PdfExtractor.Process(IPluginOptions),
- PdfExtractor.Dispose(),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
أمثلة
المثال يوضح كيفية استخراج الصور من مستند PDF.
// إنشاء كائن ImageExtractor لاستخراج الصور
using (var plugin = new ImageExtractor())
{
// إنشاء ImageExtractorOptions
var opt = new ImageExtractorOptions();
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// تعيين دليل الإخراج
opt.AddInput(new FileDataSource("D:\\"));
// تنفيذ عملية الاستخراج
var resultContainer = plugin.Process(opt);
// الحصول على الصورة من كائن ResultContainer
var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}
المنشئات
فئة JpegConverter
معلومات
يمثل مكون Documentize.JpegConverter. يستخدم لتحويل مستندات PDF إلى تنسيق JPEG.
public sealed class JpegConverter
الوراثة
object ←
JpegConverter
الأعضاء الموروثة
أمثلة
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق JPEG.
// إنشاء JpegConverter
var plugin = new JpegConverter();
// إنشاء كائن PdfToJpegOptions لتعيين التعليمات
var opt = new PdfToJpegOptions();
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسار ملف الإخراج
opt.AddOutput(new DirectoryDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
المنشئات
JpegConverter()
الأساليب
Process(PdfToJpegOptions)
يبدأ معالجة Documentize.JpegConverter مع المعلمات المحددة.
public ResultContainer Process(PdfToJpegOptions options)
المعلمات
options
PdfToJpegOptions: كائن الخيارات الذي يحتوي على تعليمات لمكون Documentize.JpegConverter.
العودة
ResultContainer : كائن ResultContainer الذي يحتوي على نتيجة العملية.
فئة PdfAOptionsBase
معلومات
يمثل الفئة الأساسية لخيارات المكون الإضافي Documentize.PdfAConverter. توفر هذه الفئة خصائص وطرق لتكوين عملية تحويل PDF/A والتحقق منها.
يمثل الفئة الأساسية لخيارات المكون الإضافي Documentize.PdfAConverter.
توفر هذه الفئة خصائص وطرق لتكوين عملية تحويل PDF/A والتحقق منها.
public abstract class PdfAOptionsBase : IPluginOptions
الوراثة
object ←
PdfAOptionsBase
مشتقة
تنفيذ
الأعضاء الموروثة
البانيين
PdfAOptionsBase()
protected PdfAOptionsBase()
الخصائص
AlignText
يسترجع أو يحدد قيمة تشير إلى ما إذا كانت وسائل إضافية ضرورية للحفاظ على محاذاة النص
خلال عملية تحويل PDF/A.
public bool AlignText { get; set; }
قيمة الخصائص
bool
ملاحظات
عند تعيينها على true، ستقوم عملية التحويل بمحاولة استعادة حدود مقاطع النص الأصلية.
بالنسبة لمعظم الوثائق، لا يوجد حاجة لتغيير هذه الخاصية من القيمة الافتراضية false،
حيث أن محاذاة النص لا تتغير خلال عملية التحويل الافتراضية.
CheckDifferentNamesInFontDictionaries
يسترجع العلامات التي تتحكم في تحويل PDF/A لحالات عندما لا يتوافق مستند PDF المصدر مع مواصفة PDF.
public bool CheckDifferentNamesInFontDictionaries { get; set; }
قيمة الخصائص
bool
ErrorAction
يسترجع أو يحدد الإجراء الذي سيتم اتخاذه بالنسبة للأشياء التي لا يمكن تحويلها.
public ConvertErrorAction ErrorAction { get; set; }
قيمة الخصائص
ConvertErrorAction
IccProfileFileName
يسترجع أو يحدد اسم ملف ملف التعريف (ICC) للتلوين الدولي الذي سيتم استخدامه لتحويل PDF/A بدلاً من
الملف الافتراضي.
public string IccProfileFileName { get; set; }
قيمة الخصائص
string
يسترجع مجموعة من مصادر البيانات
public List<idatasource> Inputs { get; }
قيمة الخصائص
List<IDataSource>
IsLowMemoryMode
يسترجع أو يحدد قيمة تشير إلى ما إذا كان وضع الذاكرة المنخفضة مفعلًا خلال عملية تحويل PDF/A.
public bool IsLowMemoryMode { get; set; }
قيمة الخصائص
bool
LogOutputSource
يسترجع أو يحدد مصدر البيانات لخروج السجل.
public IDataSource LogOutputSource { get; set; }
قيمة الخصائص
IDataSource
OptimizeFileSize
يسترجع أو يحدد قيمة تشير إلى ما إذا كان يجب محاولة تقليل حجم الملف خلال عملية تحويل PDF/A.
public bool OptimizeFileSize { get; set; }
قيمة الخصائص
bool
ملاحظات
عند تعيينها على true، ستقوم عملية التحويل بمحاولة تقليل حجم الملف الناتج.
هذا قد يؤثر على أداء عملية التحويل.
PdfAVersion
يسترجع أو يحدد إصدار معيار PDF/A الذي سيتم استخدامه للتحقق أو التحويل.
public PdfAStandardVersion PdfAVersion { get; set; }
قيمة الخصائص
PdfAStandardVersion
ملاحظات
يتم استخدام إصدار معيار PDF/A لتحديد مستوى الامتثال للتحقق من PDF/A والتحويل.
إذا تم تعيين الإصدار على Documentize.PdfAStandardVersion.Auto، سيقوم النظام تلقائيًا بتحديد
الإصدار المناسب من معيار PDF/A للتحقق بناءً على بيانات تعريف الوثيقة.
في عملية تحويل PDF/A، تكون Documentize.PdfAStandardVersion.Auto هي الافتراضية لإصدار PDF/A-1b.
SoftMaskAction
يسترجع أو يحدد الإجراء الذي سيتم اتخاذه خلال تحويل الصور ذات الأقنعة الناعمة.
public ConvertSoftMaskAction SoftMaskAction { get; set; }
قيمة الخصائص
ConvertSoftMaskAction
الطرق
يضيف مصدر بيانات جديد إلى المجموعة
public void AddInput(IDataSource dataSource)
المعلمات
فئة PdfChatGptOptions
معلومات
يمثل الخيارات لإضافة Documentize.PdfChatGpt.
public class PdfChatGptOptions : IPluginOptions
الوراثة
object ←
PdfChatGptOptions
مشتقات
يُنَفَّذ
الأعضاء الموروثة
المنشآت
PdfChatGptOptions()
يُهيّئ مثيلًا جديدًا من كائن Documentize.PdfChatGptOptions.
public PdfChatGptOptions()
الخصائص
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
المخرجات
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف مصدر بيانات جديد إلى مجموعة بيانات إضافة PdfChatGpt.
public void AddInput(IDataSource dataSource)
المتغيرات
dataSource
IDataSource: مصدر البيانات (ملف أو دفق) للإضافة.
AddOutput(IDataSource)
يضيف مصدر بيانات حفظ جديد إلى مجموعة بيانات إضافة PdfChatGpt.
public void AddOutput(IDataSource saveDataSource)
المتغيرات
saveDataSource
IDataSource: مصدر البيانات (ملف أو دفق) لنتائج عملية الحفظ. :
فئة PdfChatGptRequestOptions
معلومات
تمثل الخيارات لمكون Documentize.PdfChatGpt.
public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions
الوراثة
object ←
PdfChatGptOptions ←
PdfChatGptRequestOptions
تنفيذ
الأعضاء الموروثة
- PdfChatGptOptions.AddInput(IDataSource),
- PdfChatGptOptions.AddOutput(IDataSource),
- PdfChatGptOptions.Inputs,
- PdfChatGptOptions.Outputs,
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
البناة
PdfChatGptRequestOptions()
يقوم بتهيئة مثيل جديد من كائن Documentize.PdfChatGptRequestOptions مع الخيارات الافتراضية.
public PdfChatGptRequestOptions()
PdfChatGptRequestOptions(string, string, string, string)
يقوم بتهيئة مثيل جديد من كائن Documentize.PdfChatGptRequestOptions مع الخيارات.
public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)
المعلمات
الخصائص
ApiKey
يحصل على أو يحدد المفتاح للوصول إلى واجهة برمجة تطبيقات ChatGPT.
public string ApiKey { get; set; }
قيمة الممتلكات
string
<a id=“Documentize_PdfChatGptRequestOptions_A
فئة PdfConverterOptions
معلومات
يمثل خيارات إضافات محولات Pdf.
public abstract class PdfConverterOptions : IPluginOptions
الوراثة
object ←
PdfConverterOptions
المشتقات
التفعيل
الأعضاء الموروثة
الخصائص
يعود بمجموعات بيانات إضافات PdfConverter.
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
المخرجات
يحصل على مجموعة من الأهداف المضافة لحفظ نتائج العمليات.
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف مصدر بيانات جديد إلى مجموعة بيانات إضافات PdfConverter.
public void AddInput(IDataSource dataSource)
المعاملات
dataSource
IDataSource: مصدر البيانات الذي سيتم إضافته.
AddOutput(IDataSource)
يضيف مصدر بيانات جديد إلى مجموعة بيانات PdfToXLSXConverterOptions.
public void AddOutput(IDataSource saveDataSource)
المعاملات
saveDataSource
IDataSource: مصدر البيانات (ملف أو تدفق) لنتائج عمليات الحفظ.
الاستثناءات
NotImplementedException
معلومات
تمثل خيارات لمكونات TextExtractor و ImageExtractor.
public abstract class PdfExtractorOptions : IPluginOptions
التوريث
object ←
PdfExtractorOptions
المشتق
التطبيق
الأعضاء الموروثة
الملاحظات
تحتوي Documentize.PdfExtractorOptions على وظائف أساسية لإضافة بيانات (ملفات، تدفقات) تمثل مستندات PDF المدخلة.
يرجى إنشاء Documentize.TextExtractorOptions أو ImageExtractorOptions بدلًا من ذلك.
الخصائص
تُرجع مجموعة بيانات مكون PdfExtractor.
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
تُرجع اسم العملية
public virtual string OperationName { get; }
قيمة الخاصية
string
الطرق
يضيف مصدر بيانات جديد إلى مجموعة بيانات مكون PdfExtractor.
public void AddInput(IDataSource dataSource)
المعلمات
dataSource
IDataSource: مصدر البيانات الذي سيتم إضافته. :
فئة PdfToHtmlOptions
معلومات
يمثل خيارات تحويل PDF إلى HTML لملحق Documentize.HtmlConverter.
public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions
الوراثة
object ←
PdfConverterOptions ←
PdfToHtmlOptions
يوفر
الأعضاء الموروثة
- PdfConverterOptions.AddInput(IDataSource),
- PdfConverterOptions.AddOutput(IDataSource),
- PdfConverterOptions.Inputs,
- PdfConverterOptions.Outputs,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئات
PdfToHtmlOptions()
يُهيئ مثيلًا جديدًا من كائن Documentize.PdfToHtmlOptions مع الخيارات الافتراضية.
public PdfToHtmlOptions()
PdfToHtmlOptions(SaveDataType)
يُهيئ مثيلًا جديدًا من كائن Documentize.PdfToHtmlOptions لنوع بيانات الإخراج المحدد.
public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)
المعلمات
الخصائص
OutputDataType
يسترجع نوع بيانات الإخراج.
public PdfToHtmlOptions.SaveDataType OutputDataType { get; }
قيمة الخاصية
PdfToHtmlOptions.SaveDataType
فئة PdfToPngOptions
معلومات
تمثل خيارات تحويل PDF إلى PNG لإضافة Documentize.PngConverter.
public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
PdfToPngOptions
تطبيقات
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
الباني
PdfToPngOptions()
initializes a new instance of the Documentize.PdfToPngOptions object.
الخصائص
OutputResolution
Gets or sets the resolution value of the resulting images.
public int OutputResolution { get; set; }
قيمة الخاصية
int
PageList
Gets or sets a list of pages for the process.
public List<int> PageList { get; set; }
قيمة الخاصية
List<int>
فئة PdfToTiffOptions
معلومات
يمثل خيارات محول PDF إلى TIFF للإضافات Documentize.TiffConverter.
public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions
الوراثة
object ←
PluginBaseOptions ←
PdfToTiffOptions
التنفيذ
الأعضاء الموروثة
- PluginBaseOptions.AddInput(IDataSource),
- PluginBaseOptions.AddOutput(IDataSource),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئات
PdfToTiffOptions()
يقوم بتهيئة مثيل جديد لكائن Documentize.PdfToTiffOptions.
public PdfToTiffOptions()
الخصائص
MultiPage
يحصل على علامة تُحدد إمكانية حفظ جميع الصفحات في ملف TIFF متعدد الصفحات.
public bool MultiPage { get; set; }
قيمة الخاصية
bool
OutputResolution
يحصل أو ينشئ قيمة دقة الصور الناتجة.
public int OutputResolution { get; set; }
قيمة الخاصية
int
PageList
يحصل أو ينشئ قائمة بالصفحات للعملية.
public List<int> PageList { get; set; }
قيمة الخاصية
List<int>
فئة PluginBaseOptions
معلومات
يمثل الخيارات الأساسية للمكونات الإضافية.
public class PluginBaseOptions : IPluginOptions
الوراثة
object ←
PluginBaseOptions
المشتقة
- AddTimestampOptions,
- CompressOptions,
- DecryptionOptions,
- EncryptionOptions,
- HtmlToPdfOptions,
- MergeOptions,
- OptimizeOptions,
- PdfToJpegOptions,
- PdfToPngOptions,
- PdfToTiffOptions,
- ResizeOptions,
- RotateOptions,
- SignOptions,
- SplitOptions,
- TableOptions
التنفيذ
الأعضاء الموروثة
الخصائص
إغلاق تدفقات الإدخال بعد اكتمال العملية.
public bool CloseInputStreams { get; set; }
قيمة الخاصية
bool
CloseOutputStreams
إغلاق تدفقات الإخراج بعد اكتمال العملية.
public bool CloseOutputStreams { get; set; }
قيمة الخاصية
bool
يعيد بيانات الإدخال للعملية.
public List<idatasource> Inputs { get; }
قيمة الخاصية
List<IDataSource>
Outputs
يعيد بيانات الإخراج للعملية.
public List<idatasource> Outputs { get; }
قيمة الخاصية
List<IDataSource>
الطرق
يضيف بيانات جديدة إلى المدخلات.
public void AddInput(IDataSource dataSource)
المعلمات
AddOutput(IDataSource)
يضيف بيانات جديدة إلى المخرجات.
public void AddOutput(IDataSource saveDataSource)
المعلمات
فئة StreamDataSource
معلومات
تمثل مصدر بيانات البث لعمليات التحميل والحفظ لملحق.
public sealed class StreamDataSource : IDataSource
الوراثة
object ←
StreamDataSource
تنفيذ
الأعضاء الموروثة
المنشئات
StreamDataSource(Stream)
تهيئ مصدر بيانات تدفق جديد باستخدام كائن التدفق المحدد.
public StreamDataSource(Stream data)
المعلمات
الخصائص
Data
يسترجع كائن التدفق لمصدر البيانات الحالي.
public Stream Data { get; }
قيمة الخاصية
Stream
DataType
نوع مصدر البيانات (تدفق).
public DataType DataType { get; }
قيمة الخاصية
DataType
فئة المستطيل
الوراثة
object ←
Rectangle
الأعضاء الموروثة
المنشئون
Rectangle(double, double, double, double)
منشئ المستطيل.
public Rectangle(double llx, double lly, double urx, double ury)
المعلمات
llx
double: X للزاوية السفلى اليسرى.lly
double: Y للزاوية السفلى اليسرى.urx
double: X للزاوية العليا اليمنى.ury
double: Y للزاوية العليا اليمنى.
محسن الفئة
معلومات
يمثل ملحق Documentize.Optimizer.
public sealed class Optimizer
الوراثة
object ←
Optimizer
الأعضاء الموروثة
أمثلة
يظهر المثال كيفية تحسين مستند PDF.
// إنشاء محسن
var plugin = new Optimizer();
// إنشاء كائن OptimizeOptions لضبط التعليمات
var opt = new OptimizeOptions();
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسار ملف الإخراج
opt.AddOutput(new FileDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
البناة
Optimizer()
الطرق
Process(OptimizeOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public ResultContainer Process(OptimizeOptions options)
المعلمات
options
OptimizeOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.OptimizeOptions.
الإرجاع
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
Process(RotateOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public ResultContainer Process(RotateOptions options)
المعلمات
options
RotateOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.RotateOptions.
الإرجاع
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
Process(ResizeOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public ResultContainer Process(ResizeOptions options)
المعلمات
options
ResizeOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.ResizeOptions.
الإرجاع
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
Process(CompressOptions)
يبدأ معالجة Documentize.Optimizer بالمعلمات المحددة.
public ResultContainer Process(CompressOptions options)
المعلمات
options
CompressOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.CompressOptions.
الإرجاع
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
محول HtmlConverter
معلومات
يمثل مكون Documentize.HtmlConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق HTML ومستندات HTML إلى تنسيق PDF.
public sealed class HtmlConverter : IDisposable
الوراثة
object ←
HtmlConverter
ينفذ
الأعضاء الموروثة
أمثلة
المثال يوضح كيفية تحويل PDF إلى وثيقة HTML.
// أنشئ HtmlConverter
var plugin = new HtmlConverter();
// أنشئ كائن PdfToHtmlOptions لتعيين نوع بيانات المخرجات كملف مع موارد مضمنة
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// أضف مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// عيّن مسار ملف المخرج
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);
المثال يوضح كيفية تحويل HTML إلى وثيقة PDF.
// أنشئ HtmlConverter
var plugin = new HtmlConverter();
// أنشئ HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// أضف مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// عيّن مسار ملف المخرج
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);
المنشئات
HtmlConverter()
الأساليب
Dispose()
تنفيذ IDisposable.
Process(IPluginOptions)
يبدأ معالجة Documentize.HtmlConverter مع المعلمات المحددة.
public ResultContainer Process(IPluginOptions options)
المعلمات
options
IPluginOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.HtmlConverter.
العائدات
ResultContainer : كائن Documentize.ResultContainer يحتوي على نتيجة العملية.
محول PDF/A
معلومات
يمثل مكونًا إضافيًا للتعامل مع تحويل مستندات PDF إلى تنسيق PDF/A والتحقق من توافق PDF/A.
public sealed class PdfAConverter
الوراثة
object ←
PdfAConverter
الأعضاء الموروثة
أمثلة
المثال يوضح كيفية التحقق من توافق مستند 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 < 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()
الطرق
Process(IPluginOptions)
يبدأ عملية تحويل أو تحقق PDF/A مع الخيارات المعطاة.
public ResultContainer Process(IPluginOptions options)
المعلمات
options
IPluginOptions: كائن خيارات يحتوي على تعليمات للمكون الإضافي. يجب أن يكون مثيلًا من Documentize.PdfAConvertOptions: أو Documentize.PdfAValidateOptions class.
العائدات
ResultContainer : كائن Documentize.ResultContainer يحتوي على نتيجة المعالجة.
محول PNG
معلومات
يمثل إضافة Documentize.PngConverter. تستخدم لتحويل مستندات PDF إلى تنسيق PNG.
public sealed class PngConverter
الوراثة
object ←
PngConverter
الأعضاء الموروثة
أمثلة
توضح هذه المثال كيفية تحويل مستند PDF إلى تنسيق PNG.
// إنشاء PngConverter
var plugin = new PngConverter();
// إنشاء كائن PdfToPngOptions لتحديد التعليمات
var opt = new PdfToPngOptions();
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسار ملف الإخراج
opt.AddOutput(new DirectoryDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
المنشئات
PngConverter()
الطرق
Process(PdfToPngOptions)
تبدأ عملية Documentize.PngConverter مع المعلمات المحددة.
public ResultContainer Process(PdfToPngOptions options)
المعلمات
options
PdfToPngOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.PngConverter.
العائدات
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
محول TIFF
معلومات
يمثل إضافة Documentize.TiffConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق TIFF.
public sealed class TiffConverter
الوراثة
object ←
TiffConverter
الأعضاء الموروثة
أمثلة
توضح هذه المثال كيفية تحويل مستند PDF إلى تنسيق TIFF.
// إنشاء TiffConverter
var plugin = new TiffConverter();
// إنشاء كائن PdfToTiffOptions لتحديد التعليمات
var opt = new PdfToTiffOptions();
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسار ملف الإخراج
opt.AddOutput(new DirectoryDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
المنشئات
TiffConverter()
الطرق
Process(PdfToTiffOptions)
يبدأ معالجة Documentize.TiffConverter مع المعلمات المحددة.
public ResultContainer Process(PdfToTiffOptions options)
المعلمات
options
PdfToTiffOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.TiffConverter.
يعود
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
محول مستندات DocConverter
معلومات
يمثل مكون Documentize.DocConverter. يُستخدم لتحويل مستندات PDF إلى تنسيق DOC/DOCX.
public sealed class DocConverter
الوراثة
object ←
DocConverter
الأعضاء الموروثة
أمثلة
يظهر المثال كيفية تحويل مستند PDF إلى تنسيق Doc.
// قم بإنشاء DocConverter
var plugin = new DocConverter();
// قم بإنشاء كائن PdfToDocOptions لتعيين التعليمات
var opt = new PdfToDocOptions();
// أضف مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// حدد مسار ملف الإخراج
opt.AddOutput(new FileDataSource(outputPath));
// نفذ العملية
plugin.Process(opt);
المنشئات
DocConverter()
الدوال
Dispose()
تنفيذ واجهة IDisposable.
Process(PdfToDocOptions)
يبدأ معالجة Documentize.DocConverter بالمعلمات المحددة.
public ResultContainer Process(PdfToDocOptions options)
المعلمات
options
PdfToDocOptions: كائن خيارات يحتوي على تعليمات لمكون Documentize.DocConverter.
الإرجاع
ResultContainer : كائن Documentize.ResultContainer يحتوي على نتيجة العملية.
مستخرج النص فئة
معلومات
يمثل ملحق Documentize.TextExtractor. يُستخدم لاستخراج النص من مستندات PDF.
public class TextExtractor : PdfExtractor, IDisposable
الوراثة
object ←
PdfExtractor ←
TextExtractor
ينفذ
الأعضاء الموروثة
- PdfExtractor.Process(IPluginOptions),
- PdfExtractor.Dispose(),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
أمثلة
المثال يوضح كيفية استخراج محتوى النص من مستند PDF.
// إنشاء كائن TextExtractor لاستخراج النص في محتويات PDF
using (var plugin = new TextExtractor())
{
// إنشاء TextExtractorOptions
var opt = new TextExtractorOptions();
// إضافة مسار الملف الإدخالي
opt.AddInput(new FileDataSource(inputPath));
// تنفيذ عملية الاستخراج
var resultContainer = plugin.Process(opt);
// الحصول على النص المُستخرج من كائن ResultContainer
var textExtracted = resultContainer.ResultCollection[0].ToString();
}
المُنشئات
معلومات الصف
معلومات
يوفر الصف معلومات عن إصدار المنتج الحالي.
الوراثة
object ←
Info
الأعضاء الموروثة
الحقول
AssemblyVersion إصدار التجميع.
قيمة الحقل
string
المنتج
اسم المنتج.
public const string Product = "Documentize"
قيمة الحقل
string
معلومات الصفحة للفئة
public class PageInfo : PageSize
الوراثة
object ←
PageSize ←
PageInfo
الأعضاء الموروثة
- PageSize.Width,
- PageSize.Height,
- PageSize.IsLandscape,
- PageSize.A0,
- PageSize.A1,
- PageSize.A2,
- PageSize.A3,
- PageSize.A4,
- PageSize.A5,
- PageSize.A6,
- PageSize.B5,
- PageSize.PageLetter,
- PageSize.PageLegal,
- PageSize.PageLedger,
- PageSize.P11x17,
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
المنشئات
PageInfo()
منشئ Documentize.PageInfo.
PageInfo(double, double)
منشئ Documentize.PageInfo.
public PageInfo(double width, double height)
المعلمات
الخصائص
MarginBottom
يحصل على أو يحدد قيمة تشير إلى الهامش السفلي.
public double MarginBottom { get; set; }
قيمة الخاصية
double
MarginLeft
يحصل على أو يحدد قيمة تشير إلى الهامش الأيسر.
public double MarginLeft { get; set; }
قيمة الخاصية
double
MarginRight
يحصل على أو يحدد قيمة تشير إلى الهامش الأيمن.
public double MarginRight { get; set; }
قيمة الخاصية
double
MarginTop
يحصل على أو يحدد قيمة تشير إلى الهامش العلوي.
public double MarginTop { get; set; }
قيمة الخاصية
double
مقسم الفئة
معلومات
يمثل ملحق Documentize.Splitter. يستخدم لتقسيم الوثائق إلى صفحات منفصلة.
الوراثة
object ←
Splitter
الأعضاء الموروثة
أمثلة
المثال يوضح كيف يمكن تقسيم مستند PDF.
// إنشاء مقسم
var plugin = new Splitter();
// إنشاء كائن SplitOptions لضبط التعليمات
var opt = new SplitOptions();
// إضافة مسار ملف الإدخال
opt.AddInput(new FileDataSource(inputPath));
// تعيين مسارات ملفات الإخراج
opt.AddOutput(new FileDataSource(outputPath1));
opt.AddOutput(new FileDataSource(outputPath2));
// تنفيذ العملية
plugin.Process(opt);
الباني
Splitter()
الطرق
Process(IPluginOptions)
يبدأ معالجة Documentize.Splitter بالمعلمات المحددة.
public ResultContainer Process(IPluginOptions options)
المعلمات
options
IPluginOptions: كائن خيارات يحتوي على تعليمات لـ Documentize.Splitter.
العائدات
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
الاستثناءات
InvalidOperationException
ملف مصدر البيانات للفئة
معلومات
يمثل بيانات الملفات لعمليات التحميل والحفظ للملحق.
public sealed class FileDataSource : IDataSource
الوراثة
object ←
FileDataSource
التطبيق
الأعضاء الموروثة
المنشئات
FileDataSource(string)
يهيئ مصدر بيانات ملف جديد مع المسار المحدد.
public FileDataSource(string path)
المعلمات
path
string: سلسلة تمثل المسار إلى ملف المصدر.
الخصائص
DataType
نوع مصدر البيانات.
public DataType DataType { get; }
قيمة الخاصية
DataType
Path
يحصل على المسار إلى ملف البيانات الحالية.
public string Path { get; }
قيمة الخاصية
string
مولد الجدول الفئة
معلومات
يمثل ملحق Documentize.TableGenerator. يستخدم لإضافة جدول إلى وثيقة PDF.
public sealed class TableGenerator
الوراثة
object ←
TableGenerator
الأعضاء الموروثة
أمثلة
المثال يوضح كيفية إضافة جدول إلى ملف PDF.
// إنشاء مولد الجدول
var plugin = new TableGenerator();
// إنشاء كائن TableOptions لتعيين التعليمات
TableOptions opt = 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");
// إضافة مسار الملف المدخل
opt.AddInput(new FileDataSource(inputPath1));
// تعيين مسار الملف الناتج
opt.AddOutput(new FileDataSource(outputPath));
// تنفيذ العملية
plugin.Process(opt);
المنشئات
TableGenerator()
الطرق
Process(TableOptions)
يبدأ معالجة Documentize.TableGenerator باستخدام المعاملات المحددة.
public ResultContainer Process(TableOptions options)
المعاملات
options
TableOptions: كائن خيارات يحتوي على تعليمات لمولد Documentize.TableGenerator.
العائدات
ResultContainer : كائن ResultContainer يحتوي على نتيجة العملية.
نتيجة التحقق من PdfA
معلومات
يمثل نتيجة عملية التحقق من PDF/A.
public sealed class PdfAValidationResult
الوراثة
object ←
PdfAValidationResult
الأعضاء الموروثة
الحقول
DataSource يحصل على مصدر البيانات الذي تم التحقق منه.
قيمة الحقل
IDataSource
IsValid
يحصل على قيمة تشير إلى ما إذا كانت عملية التحقق ناجحة.
public readonly bool IsValid
قيمة الحقل
bool
StandardVersion
يحصل على إصدار معيار PDF/A المستخدم للتحقق.
public readonly PdfAStandardVersion StandardVersion
قيمة الحقل
PdfAStandardVersion
نتيجة التدفق للفئة
معلومات
يمثل نتيجة العملية في شكل تدفق.
public sealed class StreamResult : IOperationResult
الوراثة
object ←
StreamResult
تنفذ
الأعضاء الموروثة
الخصائص
البيانات
يحصل على البيانات الخام.
public object Data { get; }
قيمة الخاصية
object
IsFile
يشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsStream
يشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
يشير إلى ما إذا كانت النتيجة سلسلة.
public bool IsString { get; }
قيمة الخاصية
bool
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
يُرجع
string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ وإلا null
.
ToStream()
يحاول تحويل النتيجة إلى كائن تدفق.
يُرجع
Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة تدفقًا؛ وإلا null
.
نتيجة حاوية الفئة
معلومات
يمثل حاوية تحتوي على مجموعة النتائج الناتجة عن معالجة الإضافة.
public class ResultContainer
الوراثة
object ←
ResultContainer
الأعضاء الموروثة
الخصائص
ResultCollection
يحصل على مجموعة نتائج العمليات
public List<ioperationresult> ResultCollection { get; }
قيمة الخاصية
List<IOperationResult>
نتيجة سلسلة الفئة
معلومات
يمثل نتيجة العملية في شكل سلسلة.
public sealed class StringResult : IOperationResult
الوراثة
object ←
StringResult
ينفذ
الأعضاء الموروثة
الخصائص
البيانات
يحصل على البيانات الأولية.
public object Data { get; }
قيمة الخاصية
object
IsFile
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الخرج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsStream
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الخرج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
تشير إلى ما إذا كانت النتيجة سلسلة.
public bool IsString { get; }
قيمة الخاصية
bool
النص
يعيد تمثيل السلسلة للنتيجة.
public string Text { get; }
قيمة الخاصية
string
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
العائدات
string : سلسلة تمثل مسار ملف الخرج إذا كانت النتيجة ملف؛ وإلا null
.
ToStream()
يحاول تحويل النتيجة إلى كائن تدفق.
العائدات
Stream : كائن تدفق يمثل بيانات الخرج إذا كانت النتيجة تدفق؛ وإلا null
.
ToString()
يحاول تحويل النتيجة إلى سلسلة.
public override string ToString()
العائدات
string : سلسلة تمثل محتوى النص إذا كانت النتيجة سلسلة؛ وإلا تعود base.ToString().
نتيجة فئة الكائن
معلومات
يمثل نتيجة العملية في شكل سلسلة.
public sealed class ObjectResult : IOperationResult
الوراثة
object ←
ObjectResult
التنفيذ
الأعضاء الموروثة
الخصائص
البيانات
يحصل على البيانات الخام.
public object Data { get; }
قيمة الخاصية
object
IsFile
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsFile { get; }
قيمة الخاصية
bool
IsObject
تشير إلى ما إذا كانت النتيجة كائنًا.
public bool IsObject { get; }
قيمة الخاصية
bool
IsStream
تشير إلى ما إذا كانت النتيجة مسارًا إلى ملف الإخراج.
public bool IsStream { get; }
قيمة الخاصية
bool
IsString
تشير إلى ما إذا كانت النتيجة سلسلة.
public bool IsString { get; }
قيمة الخاصية
bool
النص
يعيد تمثيل السلسلة للنتيجة.
public string Text { get; }
قيمة الخاصية
string
الأساليب
ToFile()
يحاول تحويل النتيجة إلى ملف.
العائدات
string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ وإلا null
.
ToStream()
يحاول تحويل النتيجة إلى كائن دفق.
العائدات
Stream : كائن دفق يمثل بيانات الإخراج إذا كانت النتيجة دفقًا؛ وإلا null
.
ToString()
يحاول تحويل النتيجة إلى سلسلة.
public override string ToString()
العائدات
string : سلسلة تمثل محتوى النص إذا كانت النتيجة سلسلة؛ وإلا تعيد base.ToString().
نوع الميديا HTML
معلومات
يحدد أنواع الوسائط المحتملة المستخدمة أثناء الإظهار.
public enum HtmlMediaType
الحقول
Print = 0
: طباعة.Screen = 1
: شاشة.
نوع بيانات Enum
معلومات
يمثل الأنواع الممكنة من البيانات لمعالجة الإضافات.
الحقول
Directory = 2
: نوع البيانات هو دليل يمثله المسار إليه.File = 0
: نوع البيانات هو ملف يمثله المسار إليه.Stream = 1
: نوع البيانات هو تدفق.
واجهة IDataSource
معلومات
واجهة بيانات عامة تحدد الأعضاء الشائعة التي ينبغي أن تنفذها البيانات المحددة.
public interface IDataSource
الخصائص
DataType
نوع مصدر البيانات.
DataType DataType { get; }
قيمة الخاصية
DataType
واجهة IOperationResult
معلومات
واجهة نتيجة العملية العامة التي تحدد الطرق الشائعة التي يجب على نتيجة عملية المكون الإضافي الملموس تنفيذها.
public interface IOperationResult
الخصائص
البيانات
تحصل على البيانات الخام.
قيمة الخاصية
object
IsFile
تشير إلى ما إذا كانت النتيجة هي مسار إلى ملف الإخراج.
قيمة الخاصية
bool
IsStream
تشير إلى ما إذا كانت النتيجة هي تدفق إخراج.
قيمة الخاصية
bool
IsString
تشير إلى ما إذا كانت النتيجة عبارة نصية.
قيمة الخاصية
bool
الطرق
ToFile()
يحاول تحويل النتيجة إلى ملف.
العائدات
string : سلسلة تمثل مسار ملف الإخراج إذا كانت النتيجة ملفًا؛ وإلا null
.
ToStream()
يحاول تحويل النتيجة إلى كائن تدفق.
العائدات
Stream : كائن تدفق يمثل بيانات الإخراج إذا كانت النتيجة تدفقًا؛ وإلا null
.
واجهة IPluginOptions
معلومات
واجهة خيار الإضافات العامة التي تعرف الأساليب المشتركة التي يجب أن تنفذها خيارات الإضافات المحددة.
public interface IPluginOptions