FieldUnknown
Contents
[
Hide
]FieldUnknown class
Implements an unknown or unrecognized field.
To learn more, visit the Working with Fields documentation article.
public class FieldUnknown : Field
Constructors
| Name | Description |
|---|---|
| FieldUnknown() | The default constructor. |
Properties
| Name | Description |
|---|---|
| DisplayResult { get; } | Gets the text that represents the displayed field result. |
| End { get; } | Gets the node that represents the field end. |
| Format { get; } | Gets a FieldFormat object that provides typed access to field’s formatting. |
| IsDirty { get; set; } | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| IsLocked { get; set; } | Gets or sets whether the field is locked (should not recalculate its result). |
| LocaleId { get; set; } | Gets or sets the LCID of the field. |
| Result { get; set; } | Gets or sets text that is between the field separator and field end. |
| Separator { get; } | Gets the node that represents the field separator. Can be null. |
| Start { get; } | Gets the node that represents the start of the field. |
| virtual Type { get; } | Gets the Microsoft Word field type. |
Methods
| Name | Description |
|---|---|
| GetFieldCode() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. |
| GetFieldCode(bool) | Returns text between field start and field separator (or field end if there is no separator). |
| virtual Remove() | Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null. |
| Unlink() | Performs the field unlink. |
| Update() | Performs the field update. Throws if the field is being updated already. |
| Update(bool) | Performs a field update. Throws if the field is being updated already. |
Examples
Shows how to work with ‘FieldNone’ field in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a field that does not denote an objective field type in its field code.
Field field = builder.InsertField(" NOTAREALFIELD //a");
// The "FieldNone" field type is reserved for fields such as these.
Assert.That(field.Type, Is.EqualTo(FieldType.FieldNone));
// We can also still work with these fields and assign them as instances of the FieldUnknown class.
FieldUnknown fieldUnknown = (FieldUnknown)field;
Assert.That(fieldUnknown.GetFieldCode(), Is.EqualTo(" NOTAREALFIELD //a"));
See Also
- class Field
- namespace Aspose.Words.Fields
- assembly Aspose.Words
