FieldFormula
Contents
[
Hide
]FieldFormula class
Implements the = (formula) field.
To learn more, visit the Working with Fields documentation article.
public class FieldFormula : Field
Constructors
Name | Description |
---|---|
FieldFormula() | 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
Calcualtes the result of an expression.
Examples
Shows how to use the formula field to display the result of an equation.
Document doc = new Document();
// Use a field builder to construct a mathematical equation,
// then create a formula field to display the equation's result in the document.
FieldBuilder fieldBuilder = new FieldBuilder(FieldType.FieldFormula);
fieldBuilder.AddArgument(2);
fieldBuilder.AddArgument("*");
fieldBuilder.AddArgument(5);
FieldFormula field = (FieldFormula)fieldBuilder.BuildAndInsert(doc.FirstSection.Body.FirstParagraph);
field.Update();
Assert.AreEqual(" = 2 * 5 ", field.GetFieldCode());
Assert.AreEqual("10", field.Result);
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.FORMULA.docx");
See Also
- class Field
- namespace Aspose.Words.Fields
- assembly Aspose.Words