FieldSymbol

Overview

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

Implements a SYMBOL field.

This class provides 4 methods for working with FieldSymbol 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: CharacterCode, DisplayResult, DontAffectsLineSpacing, End, FontName, FontSize, and 11 more.

Properties

NameTypeAccessDescription
CharacterCodestringRead/WriteGets or sets the character’s code point value in decimal or hexadecimal.
FontNamestringRead/WriteGets or sets the name of the font of the character retrieved by the field.
FontSizestringRead/WriteGets or sets the size in points of the font of the character retrieved by the field.
IsAnsiboolRead/WriteGets or sets whether the character code is interpreted as the value of an ANSI character.
IsUnicodeboolRead/WriteGets or sets whether the character code is interpreted as the value of a Unicode character.
IsShiftJisboolRead/WriteGets or sets whether the character code is interpreted as the value of a SHIFT-JIS character.
DontAffectsLineSpacingboolRead/WriteGets or sets whether the character retrieved by the field affects the line spacing of the paragraph.
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
GetFieldCode()Returns text between field start and field separator (or field end if there is no separator).
Remove()Removes the field from the document.
Update()Performs the field update.
Unlink()Performs the field unlink.

See Also