FieldStyleRef
Overview
FieldStyleRef is a class in Aspose.Words FOSS for .NET.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the STYLEREF field.
This class provides 4 methods for working with FieldStyleRef 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, InsertParagraphNumber, InsertParagraphNumberInFullContext, InsertParagraphNumberInRelativeContext, and 11 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
StyleName | string | Read/Write | Gets or sets the name of the style by which the text to search for is formatted. |
SearchFromBottom | bool | Read/Write | Gets or sets whether to search from the bottom of the current page, rather from the top. |
InsertParagraphNumber | bool | Read/Write | Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document. |
InsertRelativePosition | bool | Read/Write | Gets or sets whether to insert the relative position of the referenced paragraph. |
InsertParagraphNumberInRelativeContext | bool | Read/Write | Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context. |
SuppressNonDelimiters | bool | Read/Write | Gets or sets whether to suppress non-delimiter characters. |
InsertParagraphNumberInFullContext | bool | Read/Write | Gets or sets whether to insert the paragraph number of the referenced paragraph in full context. |
Start | FieldStart | Read | Gets the node that represents the start of the field. |
Separator | FieldSeparator | Read | Gets the node that represents the field separator. |
End | FieldEnd | Read | Gets the node that represents the field end. |
Type | FieldType | Read | Gets the Microsoft Word field type. |
Result | string | Read/Write | Gets or sets text that is between the field separator and field end. |
DisplayResult | string | Read | Gets the text that represents the displayed field result. |
IsLocked | bool | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
IsDirty | bool | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
Format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
LocaleId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
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. |