FormField

FormField class

يمثل حقل نموذج واحد.

لمعرفة المزيد، قم بزيارةالعمل مع حقول النموذج مقالة توثيقية.

public class FormField : SpecialChar

الخصائص

اسموصف
CalculateOnExit { get; set; }صحيح إذا تم تحديث المراجع إلى حقل النموذج المحدد تلقائيًا عند الخروج من الحقل.
CheckBoxSize { get; set; }الحصول على حجم مربع الاختيار أو تحديده بالنقاط. يكون له تأثير فقط عندماIsCheckBoxExactSize يكونحقيقي .
Checked { get; set; }الحصول على الحالة المحددة لحقل نموذج خانة الاختيار أو تعيينها. القيمة الافتراضية لهذه الخاصية هيخطأ شنيع .
CustomNodeId { get; set; }يحدد معرف العقدة المخصصة.
Default { get; set; }الحصول على القيمة الافتراضية لحقل نموذج خانة الاختيار أو تعيينها. القيمة الافتراضية لهذه الخاصية هيخطأ شنيع .
virtual Document { get; }الحصول على المستند الذي تنتمي إليه هذه العقدة.
DropDownItems { get; }يوفر الوصول إلى عناصر حقل النموذج المنسدل.
DropDownSelectedIndex { get; set; }الحصول على أو تعيين الفهرس الذي يحدد العنصر المحدد حاليًا في حقل نموذج القائمة المنسدلة.
Enabled { get; set; }صحيح إذا تم تمكين حقل النموذج.
EntryMacro { get; set; }إرجاع أو تعيين اسم ماكرو الإدخال لحقل النموذج.
ExitMacro { get; set; }إرجاع أو تعيين اسم ماكرو للخروج لحقل النموذج.
Font { get; }يوفر الوصول إلى تنسيق الخط لهذا الكائن.
HelpText { get; set; }إرجاع أو تعيين النص المعروض في مربع رسالة عندما يكون حقل النموذج هو التركيز ويقوم المستخدم بالضغط على F1.
IsCheckBoxExactSize { get; set; }الحصول على أو تعيين القيمة المنطقية التي تشير إلى ما إذا كان حجم مربع النص تلقائيًا أو محددًا بشكل صريح.
virtual IsComposite { get; }إرجاعحقيقي إذا كانت هذه العقدة يمكن أن تحتوي على عقد أخرى.
IsDeleteRevision { get; }إرجاع صحيح إذا تم حذف هذا الكائن في Microsoft Word أثناء تمكين تعقب التغييرات.
IsFormatRevision { get; }إرجاع صحيح إذا تم تغيير تنسيق الكائن في Microsoft Word أثناء تمكين تعقب التغييرات.
IsInsertRevision { get; }إرجاع صحيح إذا تم إدراج هذا الكائن في Microsoft Word أثناء تمكين تعقب التغييرات.
IsMoveFromRevision { get; }إرجاعحقيقي إذا تم نقل هذا الكائن (حذفه) في Microsoft Word أثناء تمكين تعقب التغييرات.
IsMoveToRevision { get; }إرجاعحقيقي إذا تم نقل هذا الكائن (إدراجه) في Microsoft Word أثناء تمكين تعقب التغييرات.
MaxLength { get; set; }الحد الأقصى لطول حقل النص. صفر عندما لا يكون الطول محدودًا.
Name { get; set; }الحصول على اسم حقل النموذج أو تعيينه.
NextSibling { get; }يحصل على العقدة التي تلي هذه العقدة مباشرة.
override NodeType { get; }إرجاعFormField .
OwnHelp { get; set; }يحدد مصدر النص الذي يتم عرضه في مربع رسالة عندما يكون التركيز على حقل النموذج ويقوم المستخدم بالضغط على F1.
OwnStatus { get; set; }يحدد مصدر النص الذي يتم عرضه في شريط الحالة عندما يكون حقل النموذج هو التركيز.
ParentNode { get; }يحصل على الأصل المباشر لهذه العقدة.
ParentParagraph { get; }يسترد الأصلParagraph من هذه العقدة.
PreviousSibling { get; }يحصل على العقدة التي تسبق هذه العقدة مباشرة.
Range { get; }إرجاع أRange الكائن الذي يمثل جزء المستند الموجود في هذه العقدة.
Result { get; set; }الحصول على أو تعيين سلسلة تمثل نتيجة حقل النموذج هذا.
StatusText { get; set; }إرجاع أو تعيين النص المعروض في شريط الحالة عندما يكون حقل النموذج هو التركيز.
TextInputDefault { get; set; }الحصول على أو تعيين السلسلة الافتراضية أو تعبير الحساب لحقل نموذج نصي.
TextInputFormat { get; set; }إرجاع أو تعيين تنسيق النص لحقل نموذج نصي.
TextInputType { get; set; }الحصول على أو تعيين نوع حقل النموذج النصي.
Type { get; }إرجاع نوع حقل النموذج.

طُرق

اسموصف
override Accept(DocumentVisitor)يقبل الزائر.
Clone(bool)إنشاء نسخة مكررة من العقدة.
GetAncestor(NodeType)يحصل على السلف الأول للمحددNodeType .
GetAncestor(Type)الحصول على السلف الأول لنوع الكائن المحدد.
override GetText()الحصول على الحرف الخاص الذي تمثله هذه العقدة.
NextPreOrder(Node)الحصول على العقدة التالية وفقًا لخوارزمية اجتياز شجرة الطلب المسبق.
PreviousPreOrder(Node)الحصول على العقدة السابقة وفقًا لخوارزمية اجتياز شجرة الطلب المسبق.
Remove()يزيل نفسه من الأصل.
RemoveField()إزالة حقل النموذج بالكامل، وليس فقط الحرف الخاص لحقل النموذج.
SetTextInputValue(object)يطبق تنسيق النص المحدد فيTextInputFormat ويخزن القيمة فيهاResult .
ToString(SaveFormat)تصدير محتوى العقدة إلى سلسلة بالتنسيق المحدد.
ToString(SaveOptions)تصدير محتوى العقدة إلى سلسلة باستخدام خيارات الحفظ المحددة.

ملاحظات

يوفر Microsoft Word حقول النموذج التالية: مربع الاختيار وإدخال النص والقائمة المنسدلة (مربع التحرير والسرد).

FormFieldهي عقدة مضمّنة ويمكن أن تكون تابعة فقط لـParagraph.

FormField يتم تمثيله في المستند بحرف خاص و يتم وضعه كحرف داخل سطر من النص.

يعد حقل النموذج الكامل في مستند Word عبارة عن بنية معقدة يتم تمثيلها بعدة عقد : بداية الحقل، ورمز الحقل مثل FORMTEXT، وبيانات حقل النموذج، وفاصل الحقل، ونتيجة الحقل ، ونهاية الحقل، والإشارة المرجعية. لإنشاء حقول نموذج برمجياً في مستند Word، استخدم InsertCheckBoxInsertTextInput و InsertComboBox who تأكد من إنشاء كافة عقد حقل النموذج بالترتيب الصحيح وفي الحالة المناسبة.

أمثلة

يوضح كيفية تنسيق FormField بأكمله، بما في ذلك قيمة الحقل.

Document doc = new Document(MyDir + "Form fields.docx");

FormField formField = doc.Range.FormFields[0];
formField.Font.Bold = true;
formField.Font.Size = 24;
formField.Font.Color = Color.Red;

formField.Result = "Aspose.FormField";

doc = DocumentHelper.SaveOpen(doc);

Run formFieldRun = doc.FirstSection.Body.FirstParagraph.Runs[1];

Assert.AreEqual("Aspose.FormField", formFieldRun.Text);
Assert.AreEqual(true, formFieldRun.Font.Bold);
Assert.AreEqual(24, formFieldRun.Font.Size);
Assert.AreEqual(Color.Red.ToArgb(), formFieldRun.Font.Color.ToArgb());

يوضح كيفية إدراج مربع التحرير والسرد.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Write("Please select a fruit: ");

// أدخل مربع التحرير والسرد الذي سيسمح للمستخدم باختيار خيار من مجموعة من السلاسل.
FormField comboBox = builder.InsertComboBox("MyComboBox", new[] { "Apple", "Banana", "Cherry" }, 0);

Assert.AreEqual("MyComboBox", comboBox.Name);
Assert.AreEqual(FieldType.FieldFormDropDown, comboBox.Type);
Assert.AreEqual("Apple", comboBox.Result);

// سيظهر حقل النموذج على شكل علامة html "تحديد".
doc.Save(ArtifactsDir + "FormFields.Create.html");

أنظر أيضا