FieldListNum

Overview

FieldListNum is a class in Aspose.Words FOSS for .NET. Inherits from: Field, IFieldCodeTokenInfoProvider.

Implements the LISTNUM field.

This class provides 4 methods for working with FieldListNum objects in .NET programs. Available methods include: GetFieldCode, Remove, Unlink, Update. All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package. Properties: DisplayResult, End, Format, HasListName, IsDirty, IsLocked, and 8 more.

Properties

NameTypeAccessDescription
ListNamestringRead/WriteGets or sets the name of the abstract numbering definition used for the numbering.
HasListNameboolReadReturns a value indicating whether the name of an abstract numbering definition is provided by the field’s code.
ListLevelstringRead/WriteGets or sets the level in the list, overriding the default behavior of the field.
StartingNumberstringRead/WriteGets or sets the starting value for this field.
StartFieldStartReadGets the node that represents the start of the field.
SeparatorFieldSeparatorReadGets the node that represents the field separator.
EndFieldEndReadGets the node that represents the field end.
TypeFieldTypeReadGets the Microsoft Word field type.
ResultstringRead/WriteGets or sets text that is between the field separator and field end.
DisplayResultstringReadGets the text that represents the displayed field result.
IsLockedboolRead/WriteGets or sets whether the field is locked (should not recalculate its result).
IsDirtyboolRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
FormatFieldFormatReadGets a FieldFormat object that provides typed access to field’s formatting.
LocaleIdintRead/WriteGets or sets the LCID of the field.

Methods

SignatureDescription
Remove()Calls Remove on this FieldListNum instance.
GetFieldCode()Returns text between field start and field separator (or field end if there is no separator).
Update()Performs the field update.
Unlink()Performs the field unlink.

See Also