Field
نمای کلی
Field یک کلاس در Aspose.PDF FOSS برای .NET است. ارث می‌برد از: Aspose.Pdf.Annotations.WidgetAnnotation، IEnumerable<Aspose.Pdf.Annotations.WidgetAnnotation>.
نمایانگر یک فیلد فرم.
این کلاس 26 متد برای کار با اشیای Field در برنامه‌های .NET فراهم می‌کند. متدهای موجود شامل: Accept، ChangeAfterResize، Clone، CopyTo، ExecuteFieldJavaScript، ExportToJson، ExportValueToJson، Field، Flatten، GetCheckedStateName، GetEnumerator، GetRectangle و 7 متد دیگر. تمام اعضای عمومی پس از نصب بسته Aspose.PDF FOSS برای .NET برای هر برنامه .NET قابل دسترسی هستند. ویژگی‌ها: Action، Actions، ActiveState، Alignment، AlternateName، AnnotationFlags و 72 مورد دیگر.
خواص
| نام | نوع | دسترسی | توضیح |
|---|---|---|---|
Type | FieldType | خواندن | نوع فیلد. |
FullName | string? | خواندن | نام کامل فیلد. |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | خواندن/نوشتن | تغییر ترازبندی افقی مخصوص متن که بر ظاهر ویجت فیلد اعمال می‌شود. |
PageIndex | int | خواندن | اندیس یک‌پایه صفحه‌ای که ویجت این فیلد را در اختیار دارد. |
PartialName | string? | خواندن/نوشتن | نام جزئی فیلد (/T). |
NormalAppearance | XForm? | خواندن | ظاهر “Normal” فیلد (ورودی /AP /N). |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | خواندن | جریان‌های ظاهر ویجت فیلد (ورودی /AP)، که بر اساس نام ظاهر کلید شده‌اند. |
OnActivated | Annotations.PdfAction? | خواندن/نوشتن | عملی که هنگام فعال شدن این فیلد اجرا می‌شود (ورودی /A). |
Value | string? | خواندن/نوشتن | مقدار فیلد (/V). |
Count | int | خواندن | تعداد فرزندان در آرایه /Kids این فیلد — یا فیلدهای فرزند (گره‌های سلسله‌مراتبی) یا حاشیه‌نویسی‌های ویجت (یک فیلد انتهایی با چندین ویجت بصری، مانند یک چک‌باکس/رادیو گروهی). |
Fields | Field[] | خواندن | فرزندان نوع فیلد این فیلد به صورت یک آرایه اسنپ‌شات — دسترسی‌گر راحتی که فیلدها را روی فرم بازتاب می‌دهد. |
DefaultValue | string? | خواندن | مقدار پیش‌فرض (/DV). |
AlternateName | string? | خواندن/نوشتن | نام فیلد جایگزین / راهنمای ابزار (/TU entry). |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | خواندن/نوشتن | پرچم‌های حاشیه‌گذاری ویجت (/F entry)، مثلاً. |
TabOrder | int | خواندن/نوشتن | شاخص ترتیب تب برای این فیلد. |
IsReadOnly | bool | خواندن | آیا فیلد فقط‌خواندنی است. |
ReadOnly | bool | خواندن/نوشتن | آیا فیلد فقط‌خواندنی است (نام مستعار قابل تنظیم برای API parity). |
IsRequired | bool | خواندن | آیا فیلد الزامی است. |
Characteristics | Aspose.Pdf.Annotations.Characteristics | خواندن | ویژگی‌های ظاهری (رنگ‌های حاشیه / پس‌زمینه، چرخش ویجت). |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | خواندن/نوشتن | ظاهر پیش‌فرض (قلم، اندازه، رنگ) فیلد — معادل سطح فیلد WidgetAnnotation. |
Rect | Rectangle? | خواندن/نوشتن | مستطیل فیلد. |
Color | Color | خواندن/نوشتن | رنگ فیلد (در رشته ظاهر پیش‌فرض /DA به صورت RGB ذخیره می‌شود). |
AnnotationIndex | int | خواندن/نوشتن | موقعیت تب به‌صورت 1-مبنایی ویجت این field در آرایه /Annots صفحه — ترتیب آرایه، ترتیب تب‌های صفحه است. |
FitIntoRectangle | bool | خواندن/نوشتن | پرچم سراسری: وقتی true باشد، مقدار field به‌صورت خودکار برای متناسب شدن با مستطیل widget آن تغییر اندازه می‌یابد. |
IsGroup | bool | خواندن | این که آیا این field یک container/group از child fields است یا خیر. |
IsSharedField | bool | خواندن/نوشتن | آیا این فیلد به یک گروه shared-fields تعلق دارد. |
IsSynchronized | bool | خواندن | آیا مجموعه thread-safe است. |
SyncRoot | object | خواندن | ریشهٔ همگام‌سازی؛ این نمونه را برمی‌گرداند. |
MaxFontSize | double | خواندن/نوشتن | حداکثر اندازهٔ قلم که توسط auto-fit ظاهر فیلد استفاده می‌شود. |
MinFontSize | double | خواندن/نوشتن | حداقل اندازهٔ قلم که توسط تنظیم خودکار ظاهر فیلد استفاده می‌شود. |
MappingName | string? | خواندن/نوشتن | نام نگاشتی که توسط اسکریپت‌های خارجی برای شناسایی فیلد استفاده می‌شود. |
AnnotationType | AnnotationType | خواندن | همیشه ویجت. |
Border | Border? | خواندن/نوشتن | عرض حاشیه، سبک و الگوی خط تیره از واژه‌نامه BS ویجت استخراج می‌شود (فیلدهای فرم حاشیه خود را در آنجا نگه می‌دارند، نه در /Border). |
Actions | AnnotationActionCollection | خواندن | اسلات‌های عملکرد برای درخت /AA ویجت. |
Exportable | bool | خواندن/نوشتن | اینکه آیا مقدار ویجت باید هنگام ارسال فرم صادر شود. |
Highlighting | HighlightingMode | خواندن/نوشتن | حالت برجسته‌سازی بصری که هنگام کلیک کاربر بر روی ویجت استفاده می‌شود (/H entry). |
Parent | Forms.Field? | خواندن | فیلد والد وقتی این ویجت فرزند بصری یک فیلد AcroForm باشد. |
Required | bool | خواندن/نوشتن | این که آیا ویجت باید پیش از ارسال پر شود (/Ff bit 2). |
HighlightMode | string | خواندن | حالت برجسته (/H entry). |
DefaultAppearanceString | string? | خواندن | رشتهٔ ظاهر پیش‌فرض (/DA entry). |
FieldValue | string? | خواندن | مقدار فیلد (/V entry). |
DefaultFieldValue | string? | خواندن | مقدار پیش‌فرض فیلد (/DV entry). |
FieldType | string? | خواندن | نوع فیلد (/FT entry). |
InnerRect | Rectangle? | خواندن | مستطیل حاشیه‌نویسی که توسط ورودی /RD (تفاوت‌های مستطیل) درون‌ریخته می‌شود — ناحیه‌ای که واقعاً داخل Rect کشیده می‌شود. |
Width | double | خواندن/نوشتن | عرض مستطیل حاشیه‌نویسی. |
Height | double | خواندن/نوشتن | ارتفاع مستطیل حاشیه‌نویسی. |
ActiveState | string? | خواندن/نوشتن | وضعیت ظاهر فعال فعلی (/AS entry). |
Alignment | TextAlignment | خواندن/نوشتن | ترازبندی متن (برای حاشیه‌نویسی‌های متن آزاد / ویجت که متن غنی حمل می‌کنند). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | خواندن/نوشتن | ترازبندی افقی (در کنار Alignment نمایان می‌شود؛ هر دو به‌صورت مستقل قابل تنظیم هستند). |
States | AppearanceDictionary | خواندن | لغت‌نامه ظاهر-وضعیت (زیرلغت‌نامهٔ هر وضعیت از AP/N، مثلاً. |
UpdateAppearanceOnConvert | bool | خواندن/نوشتن | اینکه آیا جریان ظاهر هنگام ذخیرهٔ حاشیه‌نویسی در یک سند تبدیل‌شده بازسازی شود. |
UseFontSubset | bool | خواندن/نوشتن | آیا فونت جاسازی‌شده (در صورت وجود) باید به‌صورت زیرمجموعه‌سازی شود. |
Contents | string? | خواندن/نوشتن | محتوای حاشیه‌نویسی (متن). |
Opacity | double | خواندن/نوشتن | شفافیت حاشیه‌نویسی (0.0 = شفاف، 1.0 = مات). |
InteriorColor | Color? | خواندن/نوشتن | رنگ داخلی حاشیه‌نویسی (/IC entry، برای حاشیه‌نویسی‌های دایره/مربع/خط). |
Title | string? | خواندن/نوشتن | عنوان حاشیه‌نویسی (نویسنده برای حاشیه‌نویسی‌های markup). |
Name | string? | خواندن/نوشتن | نام حاشیه‌نویسی (شناسهٔ یکتا — ورودی /NM). |
Subject | string? | خواندن/نوشتن | موضوع حاشیه‌نویسی (ورودی /Subj). |
ModifiedDate | string? | خواندن | تاریخ تغییر. |
Modified | DateTime | خواندن/نوشتن | تاریخ /M (modified) به‌عنوان یک DateTime تایپ‌شده. |
AnnotationFlags | AnnotationFlags | خواندن/نوشتن | نام مستعار تایپ‌شده‌ای از Flags که با سطح عمومی مطابقت دارد و AnnotationFlags را به‌عنوان یک ویژگی نمایش می‌دهد. |
Action | PdfAction? | خواندن/نوشتن | عملی که با این حاشیه‌نویسی (/A entry) مرتبط است. |
Author | string? | خواندن | نویسندهٔ حاشیه‌نویسی (/T entry). |
AnnotationState | string? | خواندن | وضعیت حاشیه‌نویسی (/State entry)، به عنوان مثال. |
AnnotationStateModel | string? | خواندن | مدل وضعیت حاشیه‌نویسی (/StateModel entry)، به عنوان مثال. |
ReplyType | string? | خواندن | نوع پاسخ (/RT entry)، مثلاً. |
InReplyTo | Annotation? | خواندن/نوشتن | حاشیه‌نویسی که این مورد به آن پاسخ می‌دهد (ورودی /IRT). |
QuadPoints | Point[] | خواندن/نوشتن | QuadPoints به‌صورت آرایه‌ای از مقادیر Point. |
Page | Page? | خواندن | صفحه‌ای که مالک این حاشیه‌نویسی است، یا null زمانی که قابل حل نیست (مثلاً. |
VerticalAlignment | VerticalAlignment | خواندن/نوشتن | تراز عمودی به این پاراگراف اعمال شد. |
Margin | MarginInfo | خواندن/نوشتن | اطلاعات حاشیه بیرونی به این پاراگراف اعمال شد. |
IsFirstParagraphInColumn | bool | خواندن/نوشتن | پاراگراف را مجبور کنید که در یک ستون جدید شروع شود. |
IsKeptWithNext | bool | خواندن/نوشتن | این پاراگراف را در همان صفحه‌ای که پاراگراف بعدی است، نگه دارید. |
IsInNewPage | bool | خواندن/نوشتن | پاراگراف را مجبور کنید که در صفحه جدیدی آغاز شود. |
IsInLineParagraph | bool | خواندن/نوشتن | پرچم پاراگراف درون‌خطی (خط جدیدی ایجاد نمی‌کند). |
HyperlinkText | string? | خواندن/نوشتن | هدف ابرمتنی به‌صورت رشته‌ای قدیمی. |
Hyperlink | Hyperlink? | خواندن/نوشتن | تزئین ابرمتنی با نوع خاص بر روی پاراگراف اعمال شده است. |
ZIndex | int | خواندن/نوشتن | اندیس Z-order که توسط رندرر DOM استفاده می‌شود. |
روش ها
| امضا | توضیح |
|---|---|
Field(doc: Document) | یک فیلد ایجاد کنید که به سندی متصل باشد. |
GetEnumerator() | برای فرزندان این فیلد در آرایهٔ /Kids، حاشیه‌نویسی‌های ویجت را تکرار می‌کند. |
CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int) | حاشیه‌نویسی‌های ویجت را در یک آرایه، با شروع از اندیس، کپی کنید. |
CopyTo(array: Field[], index: int) | کودکان این فیلد (به‌صورت نمونه‌های Field) را در یک آرایه، با شروع از اندیس، کپی کنید. |
ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction) | عمل JavaScript ارائه شده را بر این فیلد اجرا کنید. |
ExportToJson(stream: Stream) | این فیلد را به JSON (یک شیء FieldExportingData منفرد) از طریق استریم ارائه‌شده سریالایز کنید. |
ExportToJson(fileName: string) | این فیلد را به یک فایل JSON سریالایز کنید. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | این فیلد را به JSON از طریق جریان ارائه‌شده سریالایز کنید. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | این فیلد را به یک فایل JSON سریالایز کنید. |
ExportValueToJson(outputJsonStream: Stream, indented: bool) | نام، پرچم‌ها و مقدار فیلد را به یک جریان JSON بنویسید. |
Flatten() | این فیلد را صاف کنید — مقدار آن را به محتوای صفحه‌ای ثابت تبدیل کنید. |
GetWidgetEnumerator() | شمارنده‌ای که به WidgetAnnotation تایپ شده است. |
ImportValueFromJson(inputJsonStream: Stream) | مقدار این فیلد را از یک جریان JSON بخوانید. |
ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string) | مقدار فیلد نام‌گذاری‌شده را از یک جریان JSON بخوانید — یک شیء فیلد تک (احتمالاً به‌صورت تو در تو از طریق ChildFields) یا آرایه‌ای از آن‌ها — و مقدار ورودی‌ای که مسیر نقطه‌دار آن با fieldFullNameInJSON مطابقت دارد، اعمال کنید. |
Recalculate() | مقدار فیلد را از اسکریپت محاسبه‌اش دوباره محاسبه کنید. |
SetPosition(point: Aspose.Pdf.Point) | مستطیل اولین ویجت فیلد را به نقطه ارائه‌شده (گوشهٔ بالا-چپ) منتقل کنید. |
WidgetAnnotation(doc: Document) | Programmatic ctor — یک حاشیه‌نویسی ویجت ساده که به خوانندهٔ سند مرتبط است ایجاد می‌کند. |
ExportToJson(stream: System.IO.Stream) | فیلد این ویجت را به‌عنوان JSON به یک جریان سریال‌سازی کنید. |
ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?) | فیلد این ویجت را به‌عنوان یک شیء FieldExportingData JSON واحد به یک جریان سریال‌سازی کنید. |
GetCheckedStateName() | نام وضعیت ظاهر را برمی‌گرداند که حالت “on” / “checked” این ویجت را نشان می‌دهد (معمولاً “Yes”)، که از کلیدهای دیکشنری /AP/N استخراج می‌شود (هر چیزی که “Off” نباشد). |
Accept(visitor: AnnotationSelector) | متد Accept(visitor) را بر روی این نمونهٔ Field فراخوانی می‌کند. |
GetRectangle(considerRotation: bool) | مستطیل محدود‌کننده توسط considerRotation تنظیم می‌شود. |
ChangeAfterResize(transform: Matrix) | بعد از اینکه کاربر صفحه یا مستطیل میزبان را تغییر اندازه داد، هندسه حاشیه‌نویسی را تنظیم کنید. |
UpdateAppearances() | جریان ظاهر نرمال (/AP /N) را بر پایه هندسه و رنگ‌های فعلی حاشیه‌نویسی بازتولید کنید. |
WriteXfdf(writer: System.Xml.XmlWriter) | این حاشیه‌نویسی را به‌عنوان عنصر XFDF برای نويسنده سریال‌سازی کنید (PDF 32000 §12.7.8 / XFDF 3.0). |
Clone() | تکثیر سطحی — کپی‌های وضعیت اسکالر/مرجع-اشتراکی را تولید می‌کند. |
