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 يتم تمثيله في المستند بحرف خاص و يتم وضعه كحرف داخل سطر من النص.

حقل النموذج الكامل في مستند وورد هو بنية معقدة تُمثَّل بعدة عقد x000d_: بداية الحقل، رمز الحقل مثل FORMTEXT، بيانات حقل النموذج، فاصل الحقل، نتيجة حقل x000d_، نهاية الحقل، وعلامة مرجعية. لإنشاء حقول نموذج برمجيًا في مستند وورد، استخدم x000d_InsertCheckBox ، InsertTextInput و InsertComboBoxwhich تأكد من إنشاء جميع عقد حقول النموذج بالترتيب الصحيح وفي حالة مناسبة.

أمثلة

يوضح كيفية تنسيق 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 "select".
doc.Save(ArtifactsDir + "FormFields.Create.html");

أنظر أيضا