FieldAddIn
Contents
[
Hide
]FieldAddIn class
Implements the ADDIN field.
public class FieldAddIn : Field
Constructors
| Name | Description |
|---|---|
| FieldAddIn() | 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). |
| 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. |
Remarks
Contains data created by an add-in.
Examples
Shows how to process an ADDIN field.
Document doc = new Document(MyDir + "Field sample - ADDIN.docx");
// Aspose.Words does not support inserting ADDIN fields, but we can still load and read them.
FieldAddIn field = (FieldAddIn)doc.Range.Fields[0];
Assert.AreEqual(" ADDIN \"My value\" ", field.GetFieldCode());
See Also
- class Field
- namespace Aspose.Words.Fields
- assembly Aspose.Words
