FieldListNum Class

Implements the LISTNUM field.

Inheritance Hierarchy

Namespace:  Aspose.Words.Fields
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 20.8.0


public class FieldListNum : Field

The FieldListNum type exposes the following members.


Public methodFieldListNum
Initializes a new instance of the FieldListNum class


Public propertyCode exampleDisplayResult
Gets the text that represents the displayed field result.
(Inherited from Field.)
Public propertyCode exampleEnd
Gets the node that represents the field end.
(Inherited from Field.)
Public propertyCode exampleFormat
Gets a FieldFormat object that provides typed access to field's formatting.
(Inherited from Field.)
Public propertyCode exampleHasListName
Returns a value indicating whether the name of an abstract numbering definition is provided by the field's code.
Public propertyCode exampleIsDirty
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
(Inherited from Field.)
Public propertyCode exampleIsLocked
Gets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field.)
Public propertyCode exampleListLevel
Gets or sets the level in the list, overriding the default behavior of the field.
Public propertyCode exampleListName
Gets or sets the name of the abstract numbering definition used for the numbering.
Public propertyCode exampleLocaleId
Gets or sets the LCID of the field.
(Inherited from Field.)
Public propertyCode exampleResult
Gets or sets text that is between the field separator and field end.
(Inherited from Field.)
Public propertyCode exampleSeparator
Gets the node that represents the field separator. Can be null.
(Inherited from Field.)
Public propertyCode exampleStart
Gets the node that represents the start of the field.
(Inherited from Field.)
Public propertyCode exampleStartingNumber
Gets or sets the starting value for this field.
Public propertyCode exampleType
Gets the Microsoft Word field type.
(Inherited from Field.)


Public methodEquals (Inherited from Object.)
Public methodCode exampleGetFieldCode
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
(Inherited from Field.)
Public methodCode exampleGetFieldCode(Boolean)
Returns text between field start and field separator (or field end if there is no separator).
(Inherited from Field.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodCode exampleRemove
Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
(Inherited from Field.)
Public methodToString (Inherited from Object.)
Public methodCode exampleUnlink
Performs the field unlink.
(Inherited from Field.)
Public methodCode exampleUpdate
Performs the field update. Throws if the field is being updated already.
(Inherited from Field.)
Public methodCode exampleUpdate(Boolean)
Performs a field update. Throws if the field is being updated already.
(Inherited from Field.)


Shows how to number paragraphs with LISTNUM fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a list num field using a document builder
FieldListNum field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);

// Lists start counting at 1 by default, but we can change this number at any time
// In this case, we'll do a zero-based count
field.StartingNumber = "0";
builder.Writeln("Paragraph 1");

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

// Placing several list num fields in one paragraph increases the list level instead of the current number,
// in this case resulting in "1)a)i)", list level 3
builder.InsertField(FieldType.FieldListNum, true);
builder.InsertField(FieldType.FieldListNum, true);
builder.InsertField(FieldType.FieldListNum, true);
builder.Writeln("Paragraph 2");

// The list level resets with new paragraphs, so to keep counting at a desired list level, we need to set the ListLevel property accordingly
field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);
field.ListLevel = "3";
builder.Writeln("Paragraph 3");

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

field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);

// Setting this property to this particular value will emulate the AUTONUMOUT field
field.ListName = "OutlineDefault";

Assert.AreEqual(" LISTNUM  OutlineDefault", field.GetFieldCode());

// Start counting from 1
field.StartingNumber = "1";
builder.Writeln("Paragraph 4");

// Our fields keep track of the count automatically, but the ListName needs to be set with each new field
field = (FieldListNum)builder.InsertField(FieldType.FieldListNum, true);
field.ListName = "OutlineDefault";
builder.Writeln("Paragraph 5");

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

See Also