FieldInfo
Contents
[
Hide
]FieldInfo class
Implements the INFO field.
To learn more, visit the Working with Fields documentation article.
public class FieldInfo : Field
Constructors
| Name | Description |
|---|---|
| FieldInfo() | 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. |
| InfoType { get; set; } | Gets or sets the type of the document property to insert. |
| 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. |
| NewValue { get; set; } | Gets or sets an optional value that updates the property. |
| 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
Inserts information about a document property.
Examples
Shows how to work with INFO fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Set a value for the "Comments" built-in property and then insert an INFO field to display that property's value.
doc.BuiltInDocumentProperties.Comments = "My comment";
FieldInfo field = (FieldInfo)builder.InsertField(FieldType.FieldInfo, true);
field.InfoType = "Comments";
field.Update();
Assert.AreEqual(" INFO Comments", field.GetFieldCode());
Assert.AreEqual("My comment", field.Result);
builder.Writeln();
// Setting a value for the field's NewValue property and updating
// the field will also overwrite the corresponding built-in property with the new value.
field = (FieldInfo)builder.InsertField(FieldType.FieldInfo, true);
field.InfoType = "Comments";
field.NewValue = "New comment";
field.Update();
Assert.AreEqual(" INFO Comments \"New comment\"", field.GetFieldCode());
Assert.AreEqual("New comment", field.Result);
Assert.AreEqual("New comment", doc.BuiltInDocumentProperties.Comments);
doc.Save(ArtifactsDir + "Field.INFO.docx");
See Also
- class Field
- namespace Aspose.Words.Fields
- assembly Aspose.Words
