مستند سازی فضای نام

محصول

نام محصول.

public const string Product = "Documentize"

مقدار فیلد

InvalidOperationException

فضای نام: Documentize
اسمبلی: Documentize.dll

امضای کلاس

Info

نمایانگر پلاگین 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()

public Signature()

متدها

Process(IPluginOptions)

پردازش Documentize.Signature را با پارامترهای مشخص شده آغاز می‌کند.

public ResultContainer Process(IPluginOptions options)

پارامترها

options IPluginOptions: یک شیء گزینه که شامل دستورالعمل‌ها برای Documentize.Signature است.

بازگشت

ResultContainer: یک شیء ResultContainer که نتیجه عملیات را شامل می‌شود.

استثناها

فضای نام: Documentize
کتابخانه: Documentize.dll

امنیت کلاس

Info

نماینده افزونه Documentize.Security.

public sealed class Security

وراثت

object ← Security

اعضای ارثی

مثال‌ها

این مثال نشان می‌دهد که چگونه یک سند PDF را رمزنگاری کنیم.

// ایجاد امنیت 
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 را رمزگشایی کنیم.

// ایجاد امنیت 
var plugin = new Security();
// ایجاد شیء DecryptionOptions برای تنظیم دستورات
var opt = new DecryptionOptions("123456"));
// افزودن مسیر فایل ورودی
opt.AddInput(new FileDataSource(inputPath));
// تنظیم مسیر فایل خروجی
opt.AddOutput(new FileDataSource(outputPath));
// انجام فرایند
plugin.Process(opt);

سازنده‌ها

Security()

public Security()

متدها

Process(IPluginOptions)

پردازش Documentize.Security را با پارامترهای مشخص شروع می‌کند.

public ResultContainer Process(IPluginOptions options)

پارامترها

options IPluginOptions: شیء گزینه‌هایی حاوی دستورالعمل‌ها برای Documentize.Security.

بازگشت

ResultContainer : شیء ResultContainer حاوی نتیجه عملیات.

استثناها

InvalidOperationException

فضای نام: Documentize کتابخانه: Documentize.dll

اندازه صفحه کلاس

Info

کلاسی که نمایانگر اندازه صفحه در سند PDF است.

public class PageSize

وراثت

object ←
PageSize

مشتق

PageInfo

اعضای به ارث برده شده

سازنده‌ها

PageSize()

سازنده Documentize.PageSize. اندازه A4 به طور پیش‌فرض.

public PageSize()

PageSize(double, double)

سازنده Documentize.PageSize.

public PageSize(double width, double height)

پارامترها

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

خصوصیات

A0

اندازه A0 (1189x840 میلی‌متر).

public static PageSize A0 { get; }

مقدار خصوصیت

A1

اندازه A1 (840x594 میلی‌متر).

public static PageSize A1 { get; }

مقدار خصوصیت

A2

اندازه A2 (594x420 میلی‌متر).

public static PageSize A2 { get; }

مقدار خصوصیت

A3

اندازه A3 (420x297 میلی‌متر).

public static PageSize A3 { get; }

مقدار خصوصیت

A4

اندازه A4 (297x210 میلی‌متر).

public static PageSize A4 { get; }

مقدار خصوصیت

A5

اندازه A5 (210x148 میلی‌متر).

public static PageSize A5 { get; }

مقدار خصوصیت

A6

اندازه A6 (148x105 میلی‌متر).

public static PageSize A6 { get; }

مقدار خصوصیت

B5

اندازه B5 (250x176 میلی‌متر).

public static PageSize B5 { get; }

مقدار خصوصیت

ارتفاع

ارتفاع صفحه را می‌گیرد یا تنظیم می‌کند.

public double Height { get; set; }

مقدار خصوصیت

آیا افقی است؟

چرخش صفحه را می‌گیرد. اگر این افقی باشد، true و اگر این عمودی باشد، false را برمی‌گرداند.

public bool IsLandscape { get; }

مقدار خصوصیت

P11x17

قالب 11x17 اینچ.

public static PageSize P11x17 { get; }

مقدار خصوصیت

صفحه دفتر

اندازه دفتر (432x279 میلی‌متر).

public static PageSize PageLedger { get; }

مقدار خصوصیت

صفحه قانونی

اندازه قانونی (356x216 میلی‌متر).

public static PageSize PageLegal { get; }

مقدار خصوصیت

صفحه نامه

اندازه نامه (279x216 میلی‌متر).

public static PageSize PageLetter { get; }

مقدار خصوصیت

عرض

عرض صفحه را می‌گیرد یا تنظیم می‌کند.

public double Width { get; set; }

مقدار خصوصیت

Namespace: Documentize
Assembly: Documentize.dll

بهینه‌ساز کلاس

Info

نماینده افزونه 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()

public 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 که شامل نتیجه عملیات است.

Namespace: Documentize Assembly: Documentize.dll

پیام کلاس

Info

پیام تکمیل چت که توسط مدل تولید شده است.

public class Message

وراثت

object ←
Message

اعضای وراثت‌یافته

سازنده‌ها

Message()

public Message()

خصوصیات

محتوا

محتویات پیام.

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

مقدار خصوصیت

InvalidOperationException

نقش

نقش نویسنده این پیام را تعیین یا دریافت می‌کند.

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

مقدار خصوصیت

Role

فضای نام: Documentize
کتابخانه: Documentize.dll

تفکیک‌کننده کلاس

Info

نماینده پلاگین Documentize.Splitter. برای جدا کردن اسناد به صفحات جداگانه استفاده می‌شود.

public class 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()

public Splitter()

متدها

Process(IPluginOptions)

فرآیند Documentize.Splitter را با پارامترهای مشخص شده آغاز می‌کند.

public ResultContainer Process(IPluginOptions options)

پارامترها

options IPluginOptions: شیء گزینه‌ای که شامل دستورالعمل‌هایی برای Documentize.Splitter است.

بازگشت

ResultContainer : شیء ResultContainer که نتیجه عملیات را شامل می‌شود.

استثناها

Namespace: Documentize
Assembly: Documentize.dll

چرخش Enum

Info

شمارش مقادیر چرخش ممکن.

public enum Rotation

Fields

None = 0: بدون چرخش.
On180 = 2: چرخش ۱۸۰ درجه.
On270 = 3: چرخش ۲۷۰ درجه به سمت ساعتگرد.
On360 = 4: چرخش ۳۶۰ درجه به سمت ساعتگرد.
On90 = 1: چرخش ۹۰ درجه به سمت ساعتگرد.

Namespace: Documentize Assembly: Documentize.dll

رابط IDataSource

Info

رابط داده عمومی که اعضای مشترکی را تعریف می‌کند که داده‌های ملموس باید پیاده‌سازی کنند.

public interface IDataSource

Properties

DataType

نوع منبع داده.

DataType DataType { get; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

رابط IPluginOptions

Info

رابط گزینه‌های پلاگین عمومی که روش‌های مشترکی را تعریف می‌کند که گزینه‌های پلاگین خاص باید پیاده‌سازی کنند.

public interface IPluginOptions

فضا: Documentize کتابخانه: Documentize.dll

رابط کاربری IOperationResult

Info

رابط کاربری نتیجه عملیات عمومی که متدهای مشترکی را تعریف می‌کند که نتیجه عملیات پلاگین‌های مشخص باید پیاده‌سازی کنند.

public interface IOperationResult

Properties

Data

Gets raw data.

object Data { get; }

Property Value

IsFile

Indicates whether the result is a path to an output file.

bool IsFile { get; }

Property Value

IsStream

Indicates whether the result is an output stream.

bool IsStream { get; }

Property Value

IsString

Indicates whether the result is a text string.

bool IsString { get; }

Property Value

Methods

ToFile()

Tries to convert the result to the file.

string ToFile()

Returns

string : A string representing the path to the output file if the result is file; otherwise null.

ToStream()

Tries to convert the result to the stream object.

Stream ToStream()

Returns

Stream : A stream object representing the output data if the result is stream; otherwise null.

Namespace: Documentize
Assembly: Documentize.dll

زمان بندی کلاس

Info

نماینده افزونه Documentize.Timestamp.

public class Timestamp

وراثت

object ← 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

صفحه اطلاعات کلاس

Info

نماینده اطلاعات صفحه.

public class PageInfo : PageSize

وراثت

object ← PageSize ← PageInfo

اعضای وراثت‌یافته

سازنده‌ها

PageInfo()

سازنده Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

سازنده Documentize.PageInfo.

public PageInfo(double width, double height)

پارامترها

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

خصوصیات

MarginBottom

یک مقدار که نشان‌دهنده حاشیه پایین است را به‌دست می‌آورد یا تنظیم می‌کند.

public double MarginBottom { get; set; }

مقدار خصوصیت

MarginLeft

یک مقدار که نشان‌دهنده حاشیه چپ است را به‌دست می‌آورد یا تنظیم می‌کند.

public double MarginLeft { get; set; }

مقدار خصوصیت

MarginRight

یک مقدار که نشان‌دهنده حاشیه راست است را به‌دست می‌آورد یا تنظیم می‌کند.

public double MarginRight { get; set; }

مقدار خصوصیت

MarginTop

یک مقدار که نشان‌دهنده حاشیه بالا است را به‌دست می‌آورد یا تنظیم می‌کند.

public double MarginTop { get; set; }

مقدار خصوصیت

Namespace: Documentize Assembly: Documentize.dll

عملیات خطا در تبدیل Enum

Info

این کلاس نمایانگر عمل برای خطاهای تبدیل است.

public enum ConvertErrorAction

فیلدها

حذف = 0
هیچ = 1

فضا نام: Documentize دانشنامه: Documentize.dll

کلاس CompressOptions

Info

نمایندگی گزینه‌های فشرده‌سازی برای پلاگین Documentize.Optimizer.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

ارث‌بری

object ← PluginBaseOptions ← CompressOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای ارث‌برده

سازنده‌ها

CompressOptions()

نمونه جدیدی از شیء Documentize.CompressOptions با گزینه‌های پیش‌فرض را مقداردهی اولیه می‌کند.

public CompressOptions()

فضا نام: Documentize کتابخانه: Documentize.dll

کلاس DecryptionOptions

Info

نمایانگر گزینه‌های رمزگشایی برای افزونه Documentize.Security.

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

وراثت

object ←
PluginBaseOptions ←
DecryptionOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثتی

سازنده‌ها

DecryptionOptions(string)

نمونه جدیدی از شیء Documentize.DecryptionOptions را با گزینه‌های پیش‌فرض مقداردهی اولیه می‌کند.

public DecryptionOptions(string ownerPassword)

پارامترها

ownerPassword string: رمز عبور صاحب.

ویژگی‌ها

OwnerPassword

رمز عبور صاحب.

public string OwnerPassword { get; set; }

مقدار ویژگی

فضای نام: Documentize
کتابخانه: Documentize.dll

کلاس DocConverter

Info

نماینده پلاگین Documentize.DocConverter است. برای تبدیل اسناد PDF به فرمت DOC/DOCX استفاده می‌شود.

public sealed class DocConverter

وراثت

object ← DocConverter

اعضای ارث برده شده

مثال‌ها

این مثال نشان می‌دهد که چگونه یک سند PDF را به فرمت Doc تبدیل کنیم.

// create DocConverter
var plugin = new DocConverter();
// create PdfToDocOptions object to set instructions
var opt = new PdfToDocOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);

سازنده‌ها

DocConverter()

public DocConverter()

متدها

Dispose()

پیاده‌سازی IDisposable.

public void Dispose()

Process(PdfToDocOptions)

فرآیند Documentize.DocConverter را با پارامترهای مشخص شده آغاز می‌کند.

public ResultContainer Process(PdfToDocOptions options)

پارامترها

options PdfToDocOptions: یک شیء گزینه شامل دستورالعمل‌ها برای Documentize.DocConverter.

بازگشت

ResultContainer : یک شیء Documentize.ResultContainer که نتایج عملیات را شامل می‌شود.

Namespace: Documentize Assembly: Documentize.dll

کلاس EncryptionOptions

Info

نمایانگر گزینه‌های رمزنگاری برای پلاگین Documentize.Security.

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

وراثت

object ← PluginBaseOptions ← EncryptionOptions

پیاده‌سازی

IPluginOptions

اعضای به ارث برده شده

سازندگان

EncryptionOptions(string, string)

نمونه جدیدی از شیء Documentize.EncryptionOptions با گزینه‌های پیش‌فرض را初始化 می‌کند.

public EncryptionOptions(string ownerPassword, string userPassword)

پارامترها

ownerPassword string: رمز عبور مالک.
userPassword string: رمز عبور کاربر.

خواص

OwnerPassword

رمز عبور مالک.

public string OwnerPassword { get; set; }

مقدار خواص

UserPassword

رمز عبور کاربر.

public string UserPassword { get; set; }

مقدار خواص

Namespace: Documentize Assembly: Documentize.dll

کلاس FileDataSource

Info

نمایانگر داده‌های فایل برای عملیات بارگذاری و ذخیره‌سازی یک پلاگین.

public sealed class FileDataSource : IDataSource

ارث‌بری

object ←
FileDataSource

پیاده‌سازی‌ها

IDataSource

اعضای ارث‌بری شده

سازنده‌ها

FileDataSource(string)

منبع داده‌های فایل جدیدی را با مسیر مشخص شده راه‌اندازی می‌کند.

public FileDataSource(string path)

پارامترها

path string: یک رشته نمایانگر مسیر به فایل منبع.

ویژگی‌ها

DataType

نوع منبع داده.

public DataType DataType { get; }

مقدار ویژگی

Path

مسیر فایل داده‌های فعلی را دریافت می‌کند.

public string Path { get; }

مقدار ویژگی

فضای نام: Documentize
کتابخانه: Documentize.dll

کلاس FileResult

Info

نتیجه عمل را به شکل مسیر رشته‌ای به فایل نمایش می‌دهد.

public sealed class FileResult : IOperationResult

وراثت

object ← FileResult

پیاده‌سازی‌ها

IOperationResult

اعضای وراثتی

خصوصیات

Data

داده‌های خام را دریافت می‌کند.

public object Data { get; }

مقدار خصوصیت

IsFile

نشان می‌دهد که آیا نتیجه مسیر به یک فایل خروجی است یا خیر.

public bool IsFile { get; }

مقدار خصوصیت

IsStream

نشان می‌دهد که آیا نتیجه یک جریان خروجی است یا خیر.

public bool IsStream { get; }

مقدار خصوصیت

IsString

نشان می‌دهد که آیا نتیجه یک رشته متنی است یا خیر.

public bool IsString { get; }

مقدار خصوصیت

متدها

ToFile()

سعی می‌کند نتیجه را به یک فایل تبدیل کند.

public string ToFile()

بازگشت

string : یک رشته که نشان دهنده مسیر به فایل خروجی است اگر نتیجه فایل باشد؛ در غیر این صورت null.

ToStream()

سعی می‌کند نتیجه را به یک شی جریان تبدیل کند.

public Stream ToStream()

بازگشت

Stream : یک شی جریان که نمایانگر داده‌های خروجی است اگر نتیجه جریان باشد؛ در غیر این صورت null.

فضای نام: Documentize کتابخانه: Documentize.dll

کلاس HtmlConverter

Info

نماینده پلاگین Documentize.HtmlConverter. برای تبدیل اسناد PDF به فرمت HTML و اسناد HTML به فرمت PDF استفاده می‌شود.

public sealed class HtmlConverter : IDisposable

وراثت

object ← HtmlConverter

پیاده‌سازی

IDisposable

اعضای وراثت یافته

مثال‌ها

این مثال نشان می‌دهد که چگونه PDF را به سند HTML تبدیل کنیم.

// create HtmlConverter
var plugin = new HtmlConverter();
// create PdfToHtmlOptions object to set output data type as file with embedded resources
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

این مثال نشان می‌دهد که چگونه HTML را به سند PDF تبدیل کنیم.

// create HtmlConverter
var plugin = new HtmlConverter();
// create HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

سازنده‌ها

HtmlConverter()

public HtmlConverter()

متدها

Dispose()

پیاده‌سازی IDisposable.

public void Dispose()

Process(IPluginOptions)

پردازش Documentize.HtmlConverter را با پارامترهای مشخص شده آغاز می‌کند.

public ResultContainer Process(IPluginOptions options)

پارامترها

options IPluginOptions: یک شی گزینه حاوی دستورالعمل‌ها برای Documentize.HtmlConverter.

برمی‌گرداند

ResultContainer : یک شی Documentize.ResultContainer که نتیجه عملیات را دربرمی‌گیرد.

فضا نام: Documentize کتابخانه: Documentize.dll

کلاس HtmlToPdfOptions

Info

نمایش دهنده گزینه های مبدل HTML به PDF برای پلاگین Documentize.HtmlConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

وراثت

object ← PluginBaseOptions ← HtmlToPdfOptions

پیاده سازی

IPluginOptions

اعضای به ارث رسیده

سازنده ها

HtmlToPdfOptions()

شئ جدیدی از نوع Documentize.HtmlToPdfOptions را راه اندازی می کند.

public HtmlToPdfOptions()

ویژگی ها

BasePath

مسیر/آدرس پایه برای فایل HTML.

public string BasePath { get; set; }

مقدار ویژگی

HtmlMediaType

نوع های رسانه ای ممکن که در حین رندر استفاده می شوند را دریافت یا تنظیم می کند.

public HtmlMediaType HtmlMediaType { get; set; }

مقدار ویژگی

HtmlMediaType

IsRenderToSinglePage

رندر تمام سند به یک صفحه را دریافت یا تنظیم می کند.

public bool IsRenderToSinglePage { get; set; }

مقدار ویژگی

PageInfo

اطلاعات صفحه سند را دریافت یا تنظیم می کند.

public PageInfo PageInfo { get; set; }

مقدار ویژگی

PageInfo

PageLayoutOption

گزینه طراحی را دریافت یا تنظیم می کند.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

مقدار ویژگی

HtmlPageLayoutOption

فضای نام: Documentize کتابخانه: Documentize.dll

کلاس ImageExtractor

Info

نمایش دهنده پلاگین Documentize.ImageExtractor. برای استخراج تصاویر از مستندات PDF استفاده می‌شود.

public class ImageExtractor : PdfExtractor, IDisposable

وراثت

object ←
PdfExtractor ←
ImageExtractor

پیاده‌سازی‌ها

IDisposable

اعضای به ارث برده شده

مثال‌ها

این مثال نحوه استخراج تصاویر از مستندات 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();  
}

سازنده‌ها

ImageExtractor()

public ImageExtractor()

Namespace: Documentize
Assembly: Documentize.dll

کلاس JpegConverter

Info

نماینده افزونه 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()

public JpegConverter()

متدها

Process(PdfToJpegOptions)

فرآیند Documentize.JpegConverter را با پارامترهای مشخص شروع می‌کند.

public ResultContainer Process(PdfToJpegOptions options)

پارامترها

options PdfToJpegOptions: یک شیء گزینه که شامل دستورالعمل‌ها برای Documentize.JpegConverter است.

بازگشت

ResultContainer : یک شیء ResultContainer که شامل نتیجه عملیات است.

فضای نام: Documentize
کتابخانه: Documentize.dll

کلاس OptimizeOptions

Info

نمایش‌دهنده گزینه‌های بهینه‌سازی برای افزونه Documentize.Optimizer.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

وراثت

object ← PluginBaseOptions ← OptimizeOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای به ارث برده شده

سازنده‌ها

OptimizeOptions()

نمونه جدیدی از شیء Documentize.OptimizeOptions را با گزینه‌های پیش‌فرض مقداردهی می‌کند. مدرک را خطی‌سازی کنید تا

سریع‌ترین زمان ممکن صفحه اول را باز کند؛
صفحه بعدی را به سرعت نمایش دهد یا از طریق لینک به صفحه بعدی رفته و دنبال کند؛
صفحه را به تدریج همان‌طور که دریافت می‌شود نمایش دهد وقتی داده‌های یک صفحه از یک کانال کند انتقال داده می‌شود (اولین داده‌های مفید را نمایش دهد)؛
اجازه تعامل کاربر، مانند دنبال کردن لینک، حتی قبل از دریافت و نمایش کامل صفحه را بدهد.

public OptimizeOptions()

فضای نام: Documentize کتابخانه: Documentize.dll

کلاس PdfAConverter

Info

نماد یک پلاگین برای مدیریت تبدیل اسناد 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 &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

کلاس PdfAConvertOptions

Info

نمایانگر گزینه‌ها برای تبدیل مدارک PDF به فرمت PDF/A با استفاده از پلاگین Documentize.PdfAConverter.

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

ارث‌بری

object ←
PdfAOptionsBase ←
PdfAConvertOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای ارث‌برده

سازنده‌ها

PdfAConvertOptions()

public PdfAConvertOptions()

ویژگی‌ها

Outputs

مجموعه‌ای از اهداف افزوده شده (منابع داده فایل یا جریان) برای ذخیره نتایج عملیات را دریافت می‌کند.

public List<idatasource> Outputs { get; }

مقدار ویژگی

متدها

AddOutput(IDataSource)

هدف جدید برای ذخیره نتیجه را اضافه می‌کند.

public void AddOutput(IDataSource dataSource)

پارامترها

dataSource IDataSource: هدف (منبع داده فایل یا جریان) برای ذخیره نتایج عملیات. :

Namespace: Documentize
Assembly: Documentize.dll

کلاس PdfAOptionsBase

Info

نماینده کلاس پایه برای گزینه‌های پلاگین Documentize.PdfAConverter. این کلاس خواص و متدهایی را برای پیکربندی فرایند تبدیل و اعتبارسنجی PDF/A فراهم می‌کند.

public abstract class PdfAOptionsBase : IPluginOptions

وراثت

object ← PdfAOptionsBase

مشتق شده

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثتی

سازندگان

PdfAOptionsBase()

protected PdfAOptionsBase()

خواص

AlignText

مقداری را برمی‌گرداند یا تنظیم می‌کند که نشان می‌دهد آیا وسایل اضافی برای حفظ تراز متن در طول فرایند تبدیل PDF/A لازم است یا خیر.

public bool AlignText { get; set; }

مقدار ویژگی

یادداشت‌ها

زمانی که به true تنظیم شود، فرایند تبدیل سعی می‌کند تا محدوده‌های قسمت متن اصلی را بازگرداند. برای اکثر مستندات، نیازی به تغییر این ویژگی از مقدار پیش‌فرض false نیست، زیرا تراز متن در طول فرایند تبدیل پیش‌فرض تغییر نمی‌کند.

CheckDifferentNamesInFontDictionaries

پرچم‌هایی را که کنترل تبدیل PDF/A برای مواردی که سند PDF منبع با مشخصات PDF همخوانی ندارد برمی‌گرداند.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

مقدار ویژگی

ErrorAction

عملکردی را که برای اشیایی که نمی‌توانند تبدیل شوند، برمی‌گرداند یا تنظیم می‌کند.

public ConvertErrorAction ErrorAction { get; set; }

مقدار ویژگی

ConvertErrorAction

IccProfileFileName

نام فایل پروفایل ICC (کنسرسیوم رنگ بین‌المللی) را برای استفاده در تبدیل PDF/A به جای پروفایل پیش‌فرض برمی‌گرداند یا تنظیم می‌کند.

public string IccProfileFileName { get; set; }

مقدار ویژگی

Inputs

مجموعه‌ای از منابع داده را برمی‌گرداند

public List<idatasource> Inputs { get; }

مقدار ویژگی

IsLowMemoryMode

مقداری را برمی‌گرداند یا تنظیم می‌کند که نشان می‌دهد آیا حالت کم‌حافظه در طول فرایند تبدیل PDF/A فعال است یا خیر.

public bool IsLowMemoryMode { get; set; }

مقدار ویژگی

LogOutputSource

منبع داده برای خروجی لاگ را برمی‌گرداند یا تنظیم می‌کند.

public IDataSource LogOutputSource { get; set; }

مقدار ویژگی

IDataSource

OptimizeFileSize

مقداری را برمی‌گرداند یا تنظیم می‌کند که نشان می‌دهد آیا باید سعی شود تا اندازه فایل در طول فرآیند تبدیل PDF/A کاهش یابد یا خیر.

public bool OptimizeFileSize { get; set; }

مقدار ویژگی

یادداشت‌ها

زمانی که به true تنظیم شود، فرایند تبدیل سعی می‌کند تا اندازه فایل حاصل را به حداقل برساند. این ممکن است بر عملکرد فرایند تبدیل تأثیر بگذارد.

PdfAVersion

نسخه استاندارد PDF/A را که قرار است برای اعتبارسنجی یا تبدیل استفاده شود، برمی‌گرداند یا تنظیم می‌کند.

public PdfAStandardVersion PdfAVersion { get; set; }

مقدار ویژگی

PdfAStandardVersion

یادداشت‌ها

نسخه استاندارد PDF/A برای تعیین سطح انطباق برای اعتبارسنجی و تبدیل PDF/A استفاده می‌شود. اگر نسخه به Documentize.PdfAStandardVersion.Auto تنظیم شود، سیستم به‌صورت خودکار نسخه استاندارد PDF/A مناسب را برای اعتبارسنجی بر اساس متاداده سند تعیین خواهد کرد. برای فرایند تبدیل PDF/A، Documentize.PdfAStandardVersion.Auto به نسخه استاندارد PDF/A-1b به‌صورت پیش‌فرض تنظیم می‌شود.

SoftMaskAction

عملکردی را که قرار است در طول تبدیل تصاویر با ماسک‌های نرم انجام شود، برمی‌گرداند یا تنظیم می‌کند.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

مقدار ویژگی

ConvertSoftMaskAction

متدها

AddInput(IDataSource)

منبع داده جدیدی را به مجموعه اضافه می‌کند

public void AddInput(IDataSource dataSource)

پارامترها

dataSource IDataSource:

Namespace: Documentize Assembly: Documentize.dll

کلاس PdfAValidationResult

Info

نمایانگر نتیجه یک فرآیند اعتبارسنجی PDF/A است.

public sealed class PdfAValidationResult

وراثت

object ← PdfAValidationResult

اعضای ارثی

فیلدها

DataSource منبع داده‌ای که اعتبارسنجی شده است را دریافت می‌کند.

مقدار فیلد

IDataSource

IsValid

مقداری را دریافت می‌کند که نشان می‌دهد اعتبارسنجی موفقیت‌آمیز بوده است.

public readonly bool IsValid

مقدار فیلد

ArgumentException : InvalidOperationException

StandardVersion

نسخه استاندارد PDF/A که برای اعتبارسنجی استفاده می‌شود را دریافت می‌کند.

public readonly PdfAStandardVersion StandardVersion

مقدار فیلد

PdfAStandardVersion

فضا نام: Documentize کتابخانه: Documentize.dll

کلاس PdfChatGpt

Info

نماینده پلاگین PdfChatGpt.

public sealed class PdfChatGpt : IDisposable

وراثت

object ← PdfChatGpt

پیاده‌سازی‌ها

IDisposable

اعضای ارث‌برده شده

مثال‌ها

این مثال نشان می‌دهد چگونه می‌توان از پلاگین PdfChatGpt استفاده کرد و پیام‌هایی به درخواست اضافه کرد.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // مسیر فایل خروجی را اضافه کنید.
    options.ApiKey = "کلید API شما."; // شما باید کلید را برای دسترسی به 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; // شیء تکمیل چت API ChatGPT.
}

این مثال نشان می‌دهد چگونه می‌توان از پلاگین PdfChatGpt استفاده کرد و یک پیام به درخواست اضافه کرد.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // مسیر فایل خروجی را اضافه کنید.
    options.ApiKey = "کلید API شما."; // شما باید کلید را برای دسترسی به API ارائه دهید.
    options.MaxTokens = 1000; // حداکثر تعداد توکن‌هایی که باید در تکمیل چت تولید شود.

    // پیام درخواست را اضافه کنید.
    // در این حالت، پیام سیستم با Content = "شما یک دستیار مفید هستید." به‌صورت پیش‌فرض اضافه می‌شود.
    // نقش پیام سوال "کاربر" به‌صورت پیش‌فرض است.
    options.Query = "پایین‌ترین دمای ثبت‌شده در زمین چیست؟";

    // درخواست را پردازش کنید.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // شیء تکمیل چت API ChatGPT.
}

این مثال نشان می‌دهد چگونه می‌توان از پلاگین PdfChatGpt استفاده کرد و فایل‌هایی را به‌عنوان منبع پیام اضافه کرد.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // مسیر فایل خروجی را اضافه کنید.

    // منبع متن PDF را اضافه کنید.
    // در صورت وجود منابع متعدد، متن فایل هر سند به collections پیام درخواست
    // به‌عنوان پیام جداگانه با نقش "کاربر" اضافه خواهد شد.
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "کلید API شما."; // شما باید کلید را برای دسترسی به API ارائه دهید.
    options.MaxTokens = 1000; // حداکثر تعداد توکن‌هایی که باید در تکمیل چت تولید شود.

    // پیام درخواست را اضافه کنید.
    // در این حالت، پیام سیستم با Content = "شما یک دستیار مفید هستید." به‌صورت پیش‌فرض اضافه می‌شود.
    // نقش پیام سوال "کاربر" به‌صورت پیش‌فرض است.
    options.Query = "چند حرف در متن ارائه‌شده وجود دارد؟";

    // درخواست را پردازش کنید.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // شیء تکمیل چت API ChatGPT.
}

توضیحات

شیء 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>

شیء کار که نماینده عملیات ناهمزمان است.

استثناها

SetCancellationToken(CancellationToken)

توکن لغو را تنظیم می‌کند.

public void SetCancellationToken(CancellationToken cancellationToken)

پارامترها

cancellationToken CancellationToken: توکن لغو.

فضای نام: Documentize کتابخانه: Documentize.dll

کلاس PdfChatGptOptions

Info

نمایش‌دهنده گزینه‌های پلاگین Documentize.PdfChatGpt.

public class PdfChatGptOptions : IPluginOptions

اعضای وراثتی

سازنده‌ها

PdfChatGptOptions()

یک نمونه جدید از شیء Documentize.PdfChatGptOptions را ایجاد می‌کند.

public PdfChatGptOptions()

ویژگی‌ها

ورودی‌ها

public List<idatasource> Inputs { get; }

مقدار ویژگی

لیست<IDataSource>

خروجی‌ها

public List<idatasource> Outputs { get; }

مقدار ویژگی

لیست<IDataSource>

متدها

AddInput(IDataSource)

منبع داده جدیدی به مجموعه داده‌های پلاگین PdfChatGpt اضافه می‌کند.

public void AddInput(IDataSource dataSource)

پارامترها

dataSource IDataSource: منبع داده (فایل یا استریم) برای اضافه کردن.

AddOutput(IDataSource)

منبع داده ذخیره جدیدی به مجموعه داده‌های پلاگین PdfChatGpt اضافه می‌کند.

public void AddOutput(IDataSource saveDataSource)

پارامترها

saveDataSource IDataSource: منبع داده (فایل یا استریم) برای نتایج عملیات ذخیره‌سازی.

فضا نام: Documentize کتابخانه: Documentize.dll

کلاس PdfChatGptRequestOptions

Info

نمایانگر گزینه‌ها برای افزونه Documentize.PdfChatGpt.

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

وراثت

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای به ارث برده شده

سازنده‌ها

PdfChatGptRequestOptions()

نمونه جدیدی از شیء Documentize.PdfChatGptRequestOptions را با گزینه‌های پیش‌فرض راه‌اندازی می‌کند.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

نمونه جدیدی از شیء Documentize.PdfChatGptRequestOptions را با گزینه‌ها راه‌اندازی می‌کند.

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

پارامترها

apiKey string: کلید دسترسی به 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; }

مقدار ویژگی

ApiUrl

URL API ChatGPT را دریافت یا تنظیم می‌کند.

public string ApiUrl { get; set; }

مقدار ویژگی

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

مقدار ویژگی

NumberOfChoices

تعداد انتخاب‌های تکمیل چت که برای هر پیام ورودی باید ایجاد شود.

public int NumberOfChoices { get; set; }

مقدار ویژگی

Query

رشته درخواست به ChatGPT را دریافت یا تنظیم می‌کند. اگر خالی نباشد، این اولین پیام در مجموعه است که در درخواست ارسال خواهد شد.

public string Query { get; set; }

مقدار ویژگی

Temperature

دمای نمونه‌گیری که باید استفاده شود، بین 0 و 2. مقادیر بالاتر مانند 0.8 خروجی را تصادفی‌تر خواهد کرد در حالی که مقادیر پایین‌تر مانند 0.2 آن را متمرکز و تعیین‌کننده‌تر خواهد کرد. مقدار پیش‌فرض 1 است.

public double Temperature { get; set; }

مقدار ویژگی

فضای نام: Documentize کتابخانه: Documentize.dll

کلاس PdfConverterOptions

Info

نمایش دهنده گزینه‌ها برای پلاگین‌های تبدیل Pdf.

public abstract class PdfConverterOptions : IPluginOptions

وراثت

object ←
PdfConverterOptions

مشتق

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثتی

ویژگی‌ها

ورودی‌ها

مجموعه داده‌های پلاگین PdfConverterOptions را برمی‌گرداند.

public List<idatasource> Inputs { get; }

مقدار ویژگی

خروجی‌ها

مجموعه اهداف اضافه شده برای ذخیره نتایج عملیات را دریافت می‌کند.

public List<idatasource> Outputs { get; }

مقدار ویژگی

متدها

AddInput(IDataSource)

یک منبع داده جدید به مجموعه داده‌های پلاگین PdfConverter اضافه می‌کند.

public void AddInput(IDataSource dataSource)

پارامترها

dataSource IDataSource: منبع داده‌ای که باید اضافه شود.

AddOutput(IDataSource)

یک منبع داده جدید به مجموعه داده‌های پلاگین PdfToXLSXConverterOptions اضافه می‌کند.

public void AddOutput(IDataSource saveDataSource)

پارامترها

saveDataSource IDataSource: منبع داده (فایل یا جریان) برای ذخیره نتایج عملیات.

استثناها

NotImplementedException

فضای نام: Documentize
کتابخانه: Documentize.dll

کلاس PdfExtractorOptions

Info

نمایانگر گزینه‌ها برای پلاگین‌های TextExtractor و ImageExtractor.

public abstract class PdfExtractorOptions : IPluginOptions

وراثت

object ← PdfExtractorOptions

مشتق‌شده

پیاده‌سازی‌ها

IPluginOptions

اعضای ارثی

توضیحات

Documentize.PdfExtractorOptions شامل توابع پایه برای افزودن داده‌ها (فایل‌ها، جریانات) نمایانگر اسناد PDF ورودی است. لطفاً به جای این گزینه‌ها، Documentize.TextExtractorOptions یا ImageExtractorOptions را ایجاد کنید.

ویژگی‌ها

ورودی‌ها

مجموعه داده‌های پلاگین PdfExtractor را باز می‌گرداند.

public List<idatasource> Inputs { get; }

ارزش ویژگی

نام عملیات

نام عملیات را باز می‌گرداند.

public virtual string OperationName { get; }

ارزش ویژگی

PdfToHtmlOptions.SaveDataType

متدها

AddInput(IDataSource)

منبع داده جدیدی را به مجموعه داده‌های پلاگین PdfExtractor اضافه می‌کند.

public void AddInput(IDataSource dataSource)

پارامترها

dataSource IDataSource: منبع داده‌ای که باید اضافه شود. :

فضای نام: Documentize اسمبل: Documentize.dll

کلاس PdfToDocOptions

Info

نمایش دهنده گزینه‌های تبدیل PDF به DOC برای پلاگین Documentize.DocConverter.

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

وراثت

object ←
PdfConverterOptions ←
PdfToDocOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثت‌پذیر

سازنده‌ها

PdfToDocOptions()

نمونه جدیدی از شیء Documentize.PdfToDocOptions را با گزینه‌های پیش‌فرض راه‌اندازی می‌کند.

public PdfToDocOptions()

فضا نام: Documentize
Assembly: Documentize.dll

کلاس PdfToHtmlOptions

Info

نمایانگر گزینه‌های مبدل PDF به HTML برای پلاگین Documentize.HtmlConverter است.

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions

وراثت

object ←
PdfConverterOptions ←
PdfToHtmlOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثت یافته

سازنده‌ها

PdfToHtmlOptions()

یک نمونه جدید از شیء Documentize.PdfToHtmlOptions را با گزینه‌های پیش‌فرض اولیه می‌کند.

public PdfToHtmlOptions()

PdfToHtmlOptions(SaveDataType)

یک نمونه جدید از شیء Documentize.PdfToHtmlOptions را برای نوع داده خروجی مشخص شده اولیه می‌کند.

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)

پارامترها

outputDataType PdfToHtmlOptions.SaveDataType: نوع داده خروجی.

ویژگی‌ها

OutputDataType

نوع داده خروجی را دریافت می‌کند.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

مقدار ویژگی

فضای نام: Documentize
Assembl: Documentize.dll

کلاس PdfToJpegOptions

Info

نمایانگر گزینه‌های تبدیل PDF به JPEG برای پلاگین Documentize.JpegConverter است.

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

ارث‌بری

object ←
PluginBaseOptions ←
PdfToJpegOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای ارث‌برشده

سازنده‌ها

PdfToJpegOptions()

یک نمونه جدید از شی Documentize.PdfToJpegOptions را راه‌اندازی می‌کند.

public PdfToJpegOptions()

خصوصیات

OutputResolution

مقدار وضوح تصاویر حاصل را دریافت یا تنظیم می‌کند.

public int OutputResolution { get; set; }

مقدار خصوصیت

PageList

یک لیست از صفحات برای فرآیند را دریافت یا تنظیم می‌کند.

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

مقدار خصوصیت

List<int>

Quality

کیفیت خروجی را دریافت و تنظیم می‌کند.

public int Quality { get; set; }

مقدار خصوصیت

فضای نام: Documentize
مجموه: Documentize.dll

کلاس PdfToPngOptions

Info

نمایانگر گزینه‌های تبدیل PDF به PNG برای پلاگین Documentize.PngConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

وراثت

object ←
PluginBaseOptions ←
PdfToPngOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثت‌یافته

سازنده‌ها

PdfToPngOptions()

یک نمونه جدید از شیء Documentize.PdfToPngOptions را راه‌اندازی می‌کند.

public PdfToPngOptions()

ویژگی‌ها

OutputResolution

مقدار رزولوشن تصاویر حاصل را دریافت یا تنظیم می‌کند.

public int OutputResolution { get; set; }

مقدار ویژگی

PageList

لیستی از صفحات برای فرآیند را دریافت یا تنظیم می‌کند.

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

مقدار ویژگی

List<int>

فضا نام: Documentize
اسمبل: Documentize.dll

کلاس PdfToTiffOptions

Info

نمایانگر گزینه‌های تبدیل PDF به TIFF برای پلاگین Documentize.TiffConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

وراثت

object ← PluginBaseOptions ← PdfToTiffOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثتی

سازنده‌ها

PdfToTiffOptions()

یک نمونه جدید از شیء Documentize.PdfToTiffOptions را ایجاد می‌کند.

public PdfToTiffOptions()

ویژگی‌ها

MultiPage

پرچم‌ای را دریافت و تنظیم می‌کند که اجازه می‌دهد تمام صفحات در یک tiff چندصفحه‌ای ذخیره شوند.

public bool MultiPage { get; set; }

مقدار ویژگی

OutputResolution

مقدار وضوح تصاویر حاصل را دریافت یا تنظیم می‌کند.

public int OutputResolution { get; set; }

مقدار ویژگی

PdfToXlsOptions.ExcelFormat

PageList

یک لیست از صفحات برای فرآیند را دریافت یا تنظیم می‌کند.

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

مقدار ویژگی

List<int>

Namespace: Documentize Assembly: Documentize.dll

کلاس PdfToXlsOptions

Info

نمایانگر گزینه‌های تبدیل PDF به XLSX برای پلاگین Documentize.XlsConverter.

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

وراثت

object ←
PdfConverterOptions ←
PdfToXlsOptions

پیاده‌سازی

IPluginOptions

اعضای به‌وراثت‌رسیده

سازنده‌ها

PdfToXlsOptions()

یک نمونه جدید از شیء Documentize.PdfToXlsOptions را با گزینه‌های پیش‌فرض راه‌اندازی می‌کند.

public PdfToXlsOptions()

ویژگی‌ها

Format

فرمت خروجی.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

مقدار ویژگی

InsertBlankColumnAtFirst

اگر نیاز به درج ستون خالی به عنوان اولین ستون برگه کاری دارید، مقدار true را تنظیم کنید.
مقدار پیش‌فرض false است؛ به این معنی که ستون خالی درج نخواهد شد.

public bool InsertBlankColumnAtFirst { get; set; }

مقدار ویژگی

MinimizeTheNumberOfWorksheets

اگر نیاز به حداقل کردن تعداد برگه‌های کاری در کتاب کار حاصل دارید، مقدار true را تنظیم کنید.
مقدار پیش‌فرض false است؛ به این معنی که هر صفحه PDF به عنوان یک برگه کاری جداگانه ذخیره می‌شود.

public bool MinimizeTheNumberOfWorksheets { get; set; }

مقدار ویژگی

فضای نام: Documentize
کتابخانه: Documentize.dll

کلاس PluginBaseOptions

Info

نماینده گزینه‌های پایه برای پلاگین‌ها.

public class PluginBaseOptions : IPluginOptions

وراثت

object ← PluginBaseOptions

مشتق شده

پیاده‌سازی شده

IPluginOptions

اعضای وراثت یافته

ویژگی‌ها

CloseInputStreams

بستن جریان‌های ورودی پس از اتمام عملیات.

public bool CloseInputStreams { get; set; }

مقدار ویژگی

CloseOutputStreams

بستن جریان‌های خروجی پس از اتمام عملیات.

public bool CloseOutputStreams { get; set; }

مقدار ویژگی

Inputs

داده‌های ورودی برای عملیات را بازگردانی می‌کند.

public List<idatasource> Inputs { get; }

مقدار ویژگی

Outputs

داده‌های خروجی برای عملیات را بازگردانی می‌کند.

public List<idatasource> Outputs { get; }

مقدار ویژگی

متدها

AddInput(IDataSource)

داده جدیدی به ورودی‌ها اضافه می‌کند.

public void AddInput(IDataSource dataSource)

پارامترها

dataSource IDataSource: داده‌ای که باید اضافه شود.

AddOutput(IDataSource)

داده جدیدی به خروجی‌ها اضافه می‌کند.

public void AddOutput(IDataSource saveDataSource)

پارامترها

saveDataSource IDataSource: داده‌ای که باید اضافه شود. :

فضای نام: Documentize مجمع: Documentize.dll

کلاس PngConverter

Info

نمایانگر افزونه 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()

public PngConverter()

متدها

Process(PdfToPngOptions)

فرآیند Documentize.PngConverter را با پارامترهای مشخص شده آغاز می‌کند.

public ResultContainer Process(PdfToPngOptions options)

پارامترها

options PdfToPngOptions: یک شیء گزینه که شامل دستورالعمل‌هایی برای Documentize.PngConverter است.

بازگشت

ResultContainer : یک شیء ResultContainer که شامل نتیجه عملیات است.

فضای نام: Documentize کتابخانه: Documentize.dll

کلاس StreamDataSource

Info

نشان‌دهنده منبع داده جریان برای عملیات بارگذاری و ذخیره‌سازی یک پلاگین است.

public sealed class StreamDataSource : IDataSource

وراثت

object ← StreamDataSource

پیاده‌سازی‌ها

IDataSource

اعضای وراثت یافته

سازنده‌ها

StreamDataSource(Stream)

منبع داده جریان جدیدی را با شیء جریان مشخص‌شده مقداردهی اولیه می‌کند.

public StreamDataSource(Stream data)

پارامترها

data Stream: شیء جریان

ویژگی‌ها

Data

شیء جریان منبع داده جاری را دریافت می‌کند.

public Stream Data { get; }

ارزش ویژگی

Stream

DataType

نوع منبع داده (جریان).

public DataType DataType { get; }

ارزش ویژگی

TextExtractorOptions.TextFormattingMode

فضای نام: Documentize کتابخانه: Documentize.dll

کلاس TableCellBuilder

Info

کلاس نمایانگر سازنده برای سلول جدول است.

public class TableCellBuilder : TableRowBuilder

وراثت

object ←
TableBuilder ←
TableRowBuilder ←
TableCellBuilder

اعضای به ارث برده شده

متدها

AddCell()

سلول را به جدول اضافه کنید.

public override TableCellBuilder AddCell()

بازگشت

TableCellBuilder : نمونه‌ای از Documentize.TableCellBuilder فعلی.

AddParagraph(params string[])

پارگراف‌ها را به سلول جدول اضافه کنید.

public TableCellBuilder AddParagraph(params string[] paragraphs)

پارامترها

paragraphs string[]: متن برای پارگراف‌ها.

بازگشت

TableCellBuilder : نمونه‌ای از Documentize.TableCellBuilder فعلی.

Namespace: Documentize
Assembly: Documentize.dll

کلاس TableGenerator

Info

نماینده پلاگین Documentize.TableGenerator. برای اضافه کردن جدول به یک سند PDF استفاده می‌شود.

public sealed class TableGenerator

وراثت

object ← TableGenerator

اعضای به ارث برده شده

مثال‌ها

این مثال نشان می‌دهد که چگونه جدول را به فایل PDF اضافه کنیم.

// ایجاد TableGenerator
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()

public TableGenerator()

متدها

Process(TableOptions)

پردازش Documentize.TableGenerator را با پارامترهای مشخص شده شروع می‌کند.

public ResultContainer Process(TableOptions options)

پارامترها

options TableOptions: یک شیء گزینه شامل دستورالعمل‌ها برای Documentize.TableGenerator.

بازگشت

ResultContainer : یک شیء ResultContainer که شامل نتیجه عملیات است.

فضای نام: Documentize اسمبلی: Documentize.dll

کلاس TableRowBuilder

Info

کلاس نمایانگر سازنده برای ردیف جدول.

public class TableRowBuilder : TableBuilder

وراثت

object ← TableBuilder ← TableRowBuilder

مشتق

TableCellBuilder

اعضای وراثت یافته

متدها

AddCell()

اضافه کردن سلول به ردیف جدول.

public virtual TableCellBuilder AddCell()

بازگشت

TableCellBuilder : نمونه‌ای از Documentize.TableCellBuilder ایجاد شده.

AddRow()

Override کردن AddRow.

public override TableRowBuilder AddRow()

بازگشت

TableRowBuilder : نمونه‌ای از Documentize.TableRowBuilder جاری.

فضا: Documentize کتابخانه: Documentize.dll

کلاس TextExtractor

Info

نمایش دهنده افزونه Documentize.TextExtractor. برای استخراج متن از اسناد PDF استفاده می‌شود.

public class TextExtractor : PdfExtractor, IDisposable

وراثت

object ← PdfExtractor ← TextExtractor

پیاده‌سازی‌ها

IDisposable

اعضای ارث‌بری

مثال‌ها

این مثال نحوه استخراج محتوای متنی سند 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();
}

ساختارها

TextExtractor()

public TextExtractor()

فضاهای نام: Documentize کتابخانه: Documentize.dll

کلاس TextExtractorOptions

Info

نماد گزینه‌های استخراج متن برای پلاگین Documentize.TextExtractor.

public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions

وراثت

object ← PdfExtractorOptions ← TextExtractorOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وارثت‌یافته

مثال‌ها

این مثال نشان می‌دهد که چگونه محتویات متن سند 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 ورودی هستند، به ارث می‌برد.

سازنده‌ها

TextExtractorOptions(TextFormattingMode)

یک نمونه جدید از شی Documentize.TextExtractorOptions را برای حالت فرمت متن مشخص شده، راه‌اندازی می‌کند.

public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)

پارامترها

formattingMode TextExtractorOptions.TextFormattingMode: مقدار حالت فرمت متن.

TextExtractorOptions()

یک نمونه جدید از شی Documentize.TextExtractorOptions را با حالت فرمت متن ‘خام’ (پیش‌فرض) راه‌اندازی می‌کند.

public TextExtractorOptions()

خواص

FormattingMode

حالت فرمت را دریافت می‌کند.

public TextExtractorOptions.TextFormattingMode FormattingMode { get; }

مقدار خاصیت

OperationName

نام عملیات را برمی‌گرداند.

public override string OperationName { get; }

مقدار خاصیت

فضا نام: Documentize کتابخانه: Documentize.dll

کلاس TiffConverter

Info

نماینده پلاگین Documentize.TiffConverter. برای تبدیل اسناد PDF به فرمت TIFF استفاده می‌شود.

public sealed class TiffConverter

وراثت

object ← TiffConverter

اعضای وراثت یافته

مثال‌ها

این مثال نشان می‌دهد که چگونه می‌توان یک سند PDF را به فرمت TIFF تبدیل کرد.

// create TiffConverter
var plugin = new TiffConverter();
// create PdfToTiffOptions object to set instructions
var opt = new PdfToTiffOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new DirectoryDataSource(outputPath));
// perform the process
plugin.Process(opt);

سازنده‌ها

TiffConverter()

public TiffConverter()

متدها

Process(PdfToTiffOptions)

پردازش Documentize.TiffConverter را با پارامترهای مشخص آغاز می‌کند.

public ResultContainer Process(PdfToTiffOptions options)

پارامترها

options PdfToTiffOptions: یک شیء گزینه که شامل دستورالعمل‌های برای Documentize.TiffConverter است.

بازگشت می‌دهد

ResultContainer : یک شیء ResultContainer که شامل نتیجه عملیات است.

Namespace: Documentize Assembly: Documentize.dll

کلاس XlsConverter

Info

نماینده پلاگین 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()

public XlsConverter()

متدها

Process(PdfToXlsOptions)

پردازش Documentize.XlsConverter را با پارامترهای مشخص شده آغاز می‌کند.

public ResultContainer Process(PdfToXlsOptions options)

پارامترها

options PdfToXlsOptions: یک شیء گزینه که شامل دستورات برای عملیات است.

بازگشت

ResultContainer : یک شیء Documentize.ResultContainer که شامل نتیجه عملیات است.

Namespace: Documentize Assembly: Documentize.dll

کلاس مستطیل

Info

کلاس نماینده مستطیل است.

public class Rectangle

وراثت

object ← Rectangle

اعضای وارث

سازنده‌ها

Rectangle(double, double, double, double)

سازنده کلاس مستطیل.

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

پارامترها

llx double: X ناحیه پایین سمت چپ.
lly double: Y ناحیه پایین سمت چپ.
urx double: X ناحیه بالای سمت راست.
ury double: Y ناحیه بالای سمت راست.

فضای نام: Documentize کتابخانه: Documentize.dll

گزینه های استخراج تصویر کلاس

Info

نمایانگر گزینه های استخراج تصاویر برای پلاگین Documentize.ImageExtractor.

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions

وراثت

object ←
PdfExtractorOptions ←
ImageExtractorOptions

پیاده سازی

IPluginOptions

اعضای ارث بری شده

توضیحات

این توابعی برای اضافه کردن داده ها (فایل ها، جریانات) را که نمایانگر اسناد ورودی PDF هستند، به ارث می برد.

سازنده ها

ImageExtractorOptions()

یک نمونه جدید از شی Documentize.ImageExtractorOptions را راه اندازی می کند.

public ImageExtractorOptions()

ویژگی ها

OperationName

نام عملیات را برمی گرداند.

public override string OperationName { get; }

مقدار ویژگی

Namespace: Documentize
Assembly: Documentize.dll

گزینه‌های افزودن زمان‌سنجی کلاس

Info

نماینده گزینه‌های افزودن زمان‌سنجی برای پلاگین Documentize.Timestamp.

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

وراثت

object ← PluginBaseOptions ← AddTimestampOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای به ارث برده شده

سازنده‌ها

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” ترکیب شده‌اند. (اختیاری).

فضای نام: Documentize کتابخانه: Documentize.dll

گزینه‌های امضا کلاس

Info

نمایش‌دهنده گزینه‌های امضا برای پلاگین Documentize.Signature.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

وراثت

object ←
PluginBaseOptions ←
SignOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای ارث‌بری‌شده

سازنده‌ها

SignOptions(string, string)

یک نمونه جدید از شیء Documentize.SignOptions با گزینه‌های پیش‌فرض را مقداردهی اولیه می‌کند.

public SignOptions(string pfx, string password)

پارامترها

pfx string: مسیر فایل pfx.
password string: رمز عبور فایل pfx.

SignOptions(Stream, string)

یک نمونه جدید از شیء Documentize.SignOptions با گزینه‌های پیش‌فرض را مقداردهی اولیه می‌کند.

public SignOptions(Stream pfx, string password)

پارامترها

pfx Stream: جریانی با فایل pfx.
password string: رمز عبور فایل pfx.

ویژگی‌ها

Contact

تماس امضا.

public string Contact { get; set; }

مقدار ویژگی

Location

محل امضا.

public string Location { get; set; }

مقدار ویژگی

Name

نام فیلد امضای موجود.
برای ایجاد یک فیلد جدید، مقدار آن را null قرار دهید.

public string Name { get; set; }

مقدار ویژگی

PageNumber

شماره صفحه‌ای که امضا روی آن انجام شده است.

public int PageNumber { get; set; }

مقدار ویژگی

Reason

دلیل امضا.

public string Reason { get; set; }

مقدار ویژگی

Rectangle

مستطیل امضا.

public Rectangle Rectangle { get; set; }

مقدار ویژگی

Rectangle

Visible

قابلیت مشاهده امضا.

public bool Visible { get; set; }

مقدار ویژگی

فضای نام: Documentize
assemblies: Documentize.dll

گزینه‌های تغییر اندازه کلاس

Info

نمایانگر گزینه‌های تغییر اندازه برای افزونه Documentize.Optimizer.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

وراثت

object ←
PluginBaseOptions ←
ResizeOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای به‌ ارث‌ رسیده

سازنده‌ها

ResizeOptions()

یک نمونه جدید از شیء Documentize.ResizeOptions را با گزینه‌های پیش‌فرض اولیه‌گذاری می‌کند.

public ResizeOptions()

ویژگی‌ها

PageSize

اندازه صفحه جدید را می‌گیرد یا تنظیم می‌کند.

public PageSize PageSize { get; set; }

مقدار ویژگی

فضای نام: Documentize
مجموعه: Documentize.dll

گزینه‌های تقسیم کلاس

Info

نمایندگی گزینه‌های تقسیم برای پلاگین Documentize.Splitter.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

وراثت

object ←
PluginBaseOptions ←
SplitOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای ارث‌برده

سازنده‌ها

SplitOptions()

یک نمونه جدید از شیء Documentize.SplitOptions را با گزینه‌های پیش‌فرض مقداردهی اولیه می‌کند.

public SplitOptions()

نام‌فضا: Documentize
کتابخانه: Documentize.dll

گزینه‌های جدول کلاس

Info

نماد گزینه‌ها برای افزودن جدول به سند با پلاگین Documentize.TableGenerator.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

وراثت

object ← PluginBaseOptions ← TableOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثتی

سازنده‌ها

TableOptions()

یک نمونه جدید از شی Documentize.TableOptions را با گزینه‌های پیش‌فرض مقداردهی اولیه می‌کند.

public TableOptions()

متدها

AddTable()

افزودن جدول به سند.

public TableBuilder AddTable()

خروجی

TableBuilder : نمونه جدیدی از Documentize.TableBuilder.

Create()

ایجاد نمونه‌ای از Documentize.TableOptions.

public static TableOptions Create()

خروجی

TableOptions : نمونه جدیدی از Documentize.TableOptions.

InsertPageAfter(int)

درج صفحه بعد از صفحه مشخص شده.

public TableOptions InsertPageAfter(int page)

پارامترها

page int: شماره صفحه برای درج جدول بعد از آن.

خروجی

TableOptions : نمونه‌ای از Documentize.TableOptions فعلی.

InsertPageBefore(int)

درج صفحه قبل از صفحه مشخص شده.

public TableOptions InsertPageBefore(int page)

پارامترها

page int: شماره صفحه برای درج جدول قبل از آن.

خروجی

TableOptions : نمونه‌ای از Documentize.TableOptions فعلی.

فضای نام: Documentize کتابخانه: Documentize.dll

گزینه‌های چرخش کلاس

Info

نمایانگر گزینه‌های چرخش برای افزونه Documentize.Optimizer.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

وراثت

object ←
PluginBaseOptions ←
RotateOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای وراثت یافته

سازندگان

RotateOptions()

یک نمونه جدید از شیء Documentize.RotateOptions را با گزینه‌های پیش‌فرض اولیه‌گذاری می‌کند.

public RotateOptions()

ویژگی‌ها

Rotation

چرخش صفحات جدید را دریافت یا تنظیم می‌کند.

public Rotation Rotation { get; set; }

مقدار ویژگی

Rotation

فضای نام: Documentize
کتابخانه: Documentize.dll

گزینه‌های راستی‌آزمایی PdfA

Info

نشان‌دهنده گزینه‌ها برای راستی‌آزمایی انطباق PDF/A اسناد PDF با پلاگین Documentize.PdfAConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

وراثت

object ← PdfAOptionsBase ← PdfAValidateOptions

پیاده‌سازی‌ها

IPluginOptions

اعضای به ارث‌برده شده

سازنده‌ها

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize Assembly: Documentize.dll

مجوز کلاس

Info

روش‌هایی را برای تنظیم مجوز فراهم می‌کند.

public static class License

وراثت

object ← License

اعضای وراثتی

مثال‌ها

نحوه فعال‌سازی یک مجوز را نشان می‌دهد.

// تنظیم مجوز
License.Set("PathToLicense.lic");

روش‌ها

Set(string)

اجزای را مجوز می‌دهد.

public static void Set(string licenseName)

پارامترها

licenseName string: می‌تواند یک نام فایل کامل یا کوتاه باشد. برای رفتن به حالت ارزیابی از رشته خالی استفاده کنید.

فضا نام: Documentize کتابخانه: Documentize.dll

منبع داده دایرکتوری کلاس

Info

نمایانگر داده‌های دایرکتوری برای عملیات بارگذاری و ذخیره یک پلاگین.

public sealed class DirectoryDataSource : IDataSource

وراثت

object ← DirectoryDataSource

پیاده‌سازی‌ها

IDataSource

اعضای ارث‌بری شده

سازنده‌ها

DirectoryDataSource(string)

داده‌های دایرکتوری جدید را با مسیر مشخص شده مقداردهی می‌کند.

public DirectoryDataSource(string path)

پارامترها

path string: رشته‌ای که مسیر دایرکتوری را نمایان می‌کند.

ویژگی‌ها

DataType

نوع منبع داده.

public DataType DataType { get; }

مقدار ویژگی

Path

مسیر دایرکتوری داده‌های کنونی را باز می‌گرداند.

public string Path { get; }

مقدار ویژگی

فضا‌نام: Documentize کتابخانه: Documentize.dll

نتیجه جریان کلاس

Info

نتیجه عملیات را به صورت جریان نمایش می‌دهد.

public sealed class StreamResult : IOperationResult

وراثت

object ← StreamResult

پیاده‌سازی‌ها

IOperationResult

اعضای ارثی

ویژگی‌ها

داده

داده خام را دریافت می‌کند.

public object Data { get; }

مقداری از ویژگی

IsFile

تعیین می‌کند که آیا نتیجه مسیری به یک فایل خروجی است یا خیر.

public bool IsFile { get; }

مقداری از ویژگی

IsStream

تعیین می‌کند که آیا نتیجه مسیری به یک فایل خروجی است یا خیر.

public bool IsStream { get; }

مقداری از ویژگی

IsString

تعیین می‌کند که آیا نتیجه یک رشته است یا خیر.

public bool IsString { get; }

مقداری از ویژگی

متدها

ToFile()

سعی می‌کند نتیجه را به یک فایل تبدیل کند.

public string ToFile()

بازگشت

string : یک رشته که مسیری به فایل خروجی را نشان می‌دهد اگر نتیجه فایل باشد؛ در غیر این صورت null.

ToStream()

سعی می‌کند نتیجه را به یک شیء جریان تبدیل کند.

public Stream ToStream()

بازگشت

Stream : یک شیء جریان که داده‌های خروجی را نشان می‌دهد اگر نتیجه جریان باشد؛ در غیر این صورت null.

فضای نام: Documentize Assembly: Documentize.dll

نتیجه رشته کلاس

Info

نتیجه عملیات را به شکل رشته نمایش می‌دهد.

public sealed class StringResult : IOperationResult

وراثت

object ← StringResult

پیاده‌سازی‌ها

IOperationResult

اعضای ارثی

خصوصیات

داده

داده خام را دریافت می‌کند.

public object Data { get; }

مقدار خصوصیت

IsFile

معیّن می‌کند که آیا نتیجه مسیری به یک فایل خروجی است یا خیر.

public bool IsFile { get; }

مقدار خصوصیت

IsStream

معیّن می‌کند که آیا نتیجه مسیری به یک فایل خروجی است یا خیر.

public bool IsStream { get; }

مقدار خصوصیت

IsString

معیّن می‌کند که آیا نتیجه یک رشته است یا خیر.

public bool IsString { get; }

مقدار خصوصیت

متن

نمایش رشته‌ای از نتیجه را باز می‌گرداند.

public string Text { get; }

مقدار خصوصیت

متدها

ToFile()

سعی می‌کند نتیجه را به یک فایل تبدیل کند.

public string ToFile()

بازگشت

string : یک رشته که نمایانگر مسیر به فایل خروجی است اگر نتیجه فایل باشد؛ در غیر این صورت null Return می‌کند.

ToStream()

سعی می‌کند نتیجه را به یک شیء جریان تبدیل کند.

public Stream ToStream()

بازگشت

Stream : یک شیء جریان که نمایانگر داده‌های خروجی است اگر نتیجه جریان باشد؛ در غیر این صورت null Return می‌کند.

ToString()

سعی می‌کند نتیجه را به یک رشته تبدیل کند.

public override string ToString()

بازگشت

string : یک رشته که نمایانگر محتوای متنی است اگر نتیجه رشته باشد؛ در غیر این صورت base.ToString(). را باز می‌گرداند.

فضای نام: Documentize کتابخانه: Documentize.dll

نتیجه شیء کلاس

Info

نتیجه عملیات را به صورت رشته نمایش می‌دهد.

public sealed class ObjectResult : IOperationResult

وراثت

object ← ObjectResult

پیاده‌سازی‌ها

IOperationResult

اعضای وراثتی

ویژگی‌ها

داده

داده خام را دریافت می‌کند.

public object Data { get; }

مقدار ویژگی

IsFile

نشان می‌دهد که آیا نتیجه یک مسیر به یک فایل خروجی است.

public bool IsFile { get; }

مقدار ویژگی

IsObject

نشان می‌دهد که آیا نتیجه یک شیء است.

public bool IsObject { get; }

مقدار ویژگی

IsStream

نشان می‌دهد که آیا نتیجه یک مسیر به یک فایل خروجی است.

public bool IsStream { get; }

مقدار ویژگی

IsString

نشان می‌دهد که آیا نتیجه یک رشته است.

public bool IsString { get; }

مقدار ویژگی

متن

نمایش رشته‌ای از نتیجه را برمی‌گرداند.

public string Text { get; }

مقدار ویژگی