FieldAutoNum
Contents
[
Hide
]FieldAutoNum class
Implements the AUTONUM field.
To learn more, visit the Working with Fields documentation article.
public class FieldAutoNum : Field
Constructors
| Name | Description |
|---|---|
| FieldAutoNum() | The default constructor. |
Properties
| Name | Description |
|---|---|
| DisplayResult { get; } | Gets the text that represents the displayed field result. |
| End { get; } | Gets the node that represents the field end. |
| Format { get; } | Gets a FieldFormat object that provides typed access to field’s formatting. |
| IsDirty { get; set; } | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| IsLocked { get; set; } | Gets or sets whether the field is locked (should not recalculate its result). |
| LocaleId { get; set; } | Gets or sets the LCID of the field. |
| Result { get; set; } | Gets or sets text that is between the field separator and field end. |
| Separator { get; } | Gets the node that represents the field separator. Can be null. |
| SeparatorCharacter { get; set; } | Gets or sets the separator character to be used. |
| Start { get; } | Gets the node that represents the start of the field. |
| virtual Type { get; } | Gets the Microsoft Word field type. |
Methods
| Name | Description |
|---|---|
| GetFieldCode() | 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. |
| GetFieldCode(bool) | Returns text between field start and field separator (or field end if there is no separator). |
| virtual Remove() | 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. |
| Unlink() | Performs the field unlink. |
| Update() | Performs the field update. Throws if the field is being updated already. |
| Update(bool) | Performs a field update. Throws if the field is being updated already. |
Remarks
Inserts an automatic number.
Examples
Shows how to number paragraphs using autonum fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Each AUTONUM field displays the current value of a running count of AUTONUM fields,
// allowing us to automatically number items like a numbered list.
// This field will display a number "1.".
FieldAutoNum field = (FieldAutoNum)builder.InsertField(FieldType.FieldAutoNum, true);
builder.Writeln("\tParagraph 1.");
Assert.That(field.GetFieldCode(), Is.EqualTo(" AUTONUM "));
field = (FieldAutoNum)builder.InsertField(FieldType.FieldAutoNum, true);
builder.Writeln("\tParagraph 2.");
// The separator character, which appears in the field result immediately after the number,is a full stop by default.
// If we leave this property null, our second AUTONUM field will display "2." in the document.
Assert.That(field.SeparatorCharacter, Is.Null);
// We can set this property to apply the first character of its string as the new separator character.
// In this case, our AUTONUM field will now display "2:".
field.SeparatorCharacter = ":";
Assert.That(field.GetFieldCode(), Is.EqualTo(" AUTONUM \\s :"));
doc.Save(ArtifactsDir + "Field.AUTONUM.docx");
See Also
- class Field
- namespace Aspose.Words.Fields
- assembly Aspose.Words
