FieldListNum

FieldListNum class

تنفذ حقل LISTNUM .

public class FieldListNum : Field

المنشئون

اسم وصف
FieldListNum() Default_Constructor

الخصائص

اسم وصف
DisplayResult { get; } يحصل على النص الذي يمثل نتيجة الحقل المعروض.
End { get; } يحصل على العقدة التي تمثل نهاية الحقل.
Format { get; } يحصل على أFieldFormat كائن يوفر وصولاً مكتوبًا إلى تنسيق الحقل.
HasListName { get; } إرجاع قيمة تشير إلى ما إذا كان اسم تعريف الترقيم المجرد مقدمًا من خلال رمز الحقل.
IsDirty { get; set; } الحصول على أو تحديد ما إذا كانت النتيجة الحالية للحقل لم تعد صحيحة (قديمة) بسبب التعديلات الأخرى التي تم إجراؤها على المستند.
IsLocked { get; set; } تحديد ما إذا كان الحقل مغلقًا أم لا (يجب عدم إعادة حساب النتيجة).
ListLevel { get; set; } الحصول على المستوى في القائمة أو تعيينه ، متجاوزًا السلوك الافتراضي للحقل.
ListName { get; set; } الحصول على أو تحديد اسم تعريف الترقيم المجرد المستخدم للترقيم.
LocaleId { get; set; } الحصول على أو تحديد LCID للحقل.
Result { get; set; } الحصول على أو تعيين النص الموجود بين فاصل الحقل ونهاية الحقل.
Separator { get; } يحصل على العقدة التي تمثل فاصل المجال. يمكن أن يكون فارغًا.
Start { get; } يحصل على العقدة التي تمثل بداية الحقل.
StartingNumber { get; set; } الحصول على أو تعيين قيمة البداية لهذا الحقل.
virtual Type { get; } يحصل على نوع حقل Microsoft Word .

طُرق

اسم وصف
GetFieldCode() إرجاع النص بين بداية الحقل وفاصل الحقل (أو نهاية الحقل إذا لم يكن هناك فاصل) . يتم تضمين كل من رمز الحقل ونتيجة الحقل للحقول الفرعية.
GetFieldCode(bool) إرجاع النص بين بداية الحقل وفاصل الحقل (أو نهاية الحقل إذا لم يكن هناك فاصل) .
Remove() يزيل الحقل من المستند. إرجاع عقدة بعد الحقل مباشرة. إذا كانت نهاية الحقل هي آخر child من العقدة الأصلية ، يتم إرجاع فقرته الأصلية. إذا تمت إزالة الحقل بالفعل ، يعود لا شيء .
Unlink() يقوم بإلغاء ربط الحقل.
Update() يقوم بالتحديث الميداني. يرمي إذا تم تحديث الحقل بالفعل.
Update(bool) يقوم بإجراء تحديث ميداني. يرمي إذا تم تحديث الحقل بالفعل.

أمثلة

يوضح كيفية ترقيم الفقرات باستخدام حقول LISTNUM.

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

// تعرض حقول LISTNUM رقمًا يتزايد في كل حقل LISTNUM.
// تحتوي هذه الحقول أيضًا على مجموعة متنوعة من الخيارات التي تتيح لنا استخدامها لمحاكاة القوائم المرقمة.
FieldListNum field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);

// تبدأ القوائم في العد عند 1 افتراضيًا ، ولكن يمكننا تعيين هذا الرقم على قيمة مختلفة ، مثل 0.
// سيعرض هذا الحقل "0)".
field.StartingNumber = "0";
builder.Writeln("Paragraph 1");

Assert.AreEqual(" LISTNUM  \\s 0", field.GetFieldCode());

 // تحتفظ حقول LISTNUM بأعداد منفصلة لكل مستوى قائمة.
// إدراج حقل LISTNUM في نفس الفقرة مثل حقل LISTNUM آخر
// يزيد من مستوى القائمة بدلاً من العدد.
// سيستمر الحقل التالي في العد الذي بدأناه أعلاه ويعرض القيمة "1" في مستوى القائمة 1.
builder.InsertField(FieldType.FieldListNum, true);

// سيبدأ هذا الحقل في العد عند مستوى القائمة 2. وسيعرض القيمة "1".
builder.InsertField(FieldType.FieldListNum, true);

// سيبدأ هذا الحقل في العد عند مستوى القائمة 3. وسيعرض القيمة "1".
// مستويات القائمة المختلفة لها تنسيق مختلف ،
// لذلك ستعرض هذه الحقول مجتمعة قيمة "1) أ) ط)".
builder.InsertField(FieldType.FieldListNum, true);
builder.Writeln("Paragraph 2");

// سيواصل حقل LISTNUM التالي الذي ندرجه العد على مستوى القائمة
// أن حقل LISTNUM السابق كان قيد التشغيل.
// يمكننا استخدام خاصية "ListLevel" للانتقال إلى مستوى قائمة مختلف.
// إذا ظل حقل LISTNUM هذا في مستوى القائمة 3 ، فسيتم عرض "ii)" ،
// ولكن نظرًا لأننا نقلناه إلى مستوى القائمة 2 ، فإنه يستمر في العد عند هذا المستوى ويعرض "ب)".
field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);
field.ListLevel = "2";
builder.Writeln("Paragraph 3");

Assert.AreEqual(" LISTNUM  \\l 2", field.GetFieldCode());

// يمكننا تعيين خاصية ListName للحصول على الحقل لمضاهاة نوع حقل AUTONUM مختلف.
// "NumberDefault" يحاكي AUTONUM ، "OutlineDefault" يحاكي AUTONUMOUT ،
// و "LegalDefault" يحاكي حقول AUTONUMLGL.
// اسم القائمة "OutlineDefault" مع 1 كرقم البداية سينتج عنه عرض "I.".
field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);
field.StartingNumber = "1";
field.ListName = "OutlineDefault";
builder.Writeln("Paragraph 4");

Assert.IsTrue(field.HasListName);
Assert.AreEqual(" LISTNUM  OutlineDefault \\s 1", field.GetFieldCode());

// لا ينتقل ListName من الحقل السابق ، لذلك سنحتاج إلى تعيينه لكل حقل جديد.
// هذا الحقل يواصل العد باسم قائمة مختلف ويعرض "II.".
field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);
field.ListName = "OutlineDefault";
builder.Writeln("Paragraph 5");

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.LISTNUM.docx");

أنظر أيضا