FieldLink
Overview
FieldLink is a class in Aspose.Words FOSS for .NET.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the LINK field.
This class provides 4 methods for working with FieldLink 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: AutoUpdate, DisplayResult, End, Format, FormatUpdateType, InsertAsBitmap, and 16 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
ProgId | string | Read/Write | Gets or sets the application type of the link information. |
SourceFullName | string | Read/Write | Gets or sets the name and location of the source file. |
SourceItem | string | Read/Write | Gets or sets the portion of the source file that’s being linked. |
AutoUpdate | bool | Read/Write | Gets or sets whether to update this field automatically. |
InsertAsBitmap | bool | Read/Write | Gets or sets whether to insert the linked object as a bitmap. |
IsLinked | bool | Read/Write | Gets or sets whether to reduce the file size by not storing graphics data with the document. |
FormatUpdateType | string | Read/Write | Gets or sets a way the linked object updates its formatting. |
InsertAsHtml | bool | Read/Write | Gets or sets whether to insert the linked object as HTML format text. |
InsertAsPicture | bool | Read/Write | Gets or sets whether to insert the linked object as a picture. |
InsertAsRtf | bool | Read/Write | Gets or sets whether to insert the linked object in rich-text format (RTF). |
InsertAsText | bool | Read/Write | Gets or sets whether to insert the linked object in text-only format. |
InsertAsUnicode | bool | Read/Write | Gets or sets whether to insert the linked object as Unicode text. |
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. |