FieldIncludeText
Overview
FieldIncludeText is a class in Aspose.Words FOSS for .NET.
Inherits from: Field, IFieldCodeTokenInfoProvider, IFieldIncludeTextCode.
Implements the INCLUDETEXT field.
This class provides 4 methods for working with FieldIncludeText 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: BookmarkName, DisplayResult, Encoding, End, Format, IsDirty, and 13 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
SourceFullName | string | Read/Write | Gets or sets the location of the document using an IRI. |
BookmarkName | string | Read/Write | Gets or sets the name of the bookmark in the document to include. |
LockFields | bool | Read/Write | Gets or sets whether to prevent fields in the included document from being updated. |
TextConverter | string | Read/Write | Gets or sets the name of the text converter for the format of the included file. |
NamespaceMappings | string | Read/Write | Gets or sets the namespace mappings for XPath queries. |
XslTransformation | string | Read/Write | Gets or sets the location of XSL Transformation to format XML data. |
XPath | string | Read/Write | Gets or sets XPath for the desired portion of the XML file. |
Encoding | string | Read/Write | Gets or sets the encoding applied to the data within the referenced file. |
MimeType | string | Read/Write | Gets or sets the MIME type of the referenced file. |
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. |