FieldIf Class
Implements the IF field.
Inheritance Hierarchy
SystemObject
  Aspose.Words.FieldsField
    Aspose.Words.FieldsFieldIf

Namespace: Aspose.Words.Fields
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 19.11
Syntax
public class FieldIf : Field

The FieldIf type exposes the following members.

Constructors
  NameDescription
Public methodFieldIf
Initializes a new instance of the FieldIf class
Properties
  NameDescription
Public propertyCode exampleComparisonOperator
Gets or sets the comparison operator.
Public propertyCode exampleDisplayResult
Gets the text that represents the displayed field result.
(Inherited from Field.)
Public propertyCode exampleEnd
Gets the node that represents the field end.
(Inherited from Field.)
Public propertyCode exampleFalseText
Gets or sets the text displayed if the comparison expression is false.
Public propertyCode exampleFormat
Gets a FieldFormat object that provides typed access to field's formatting.
(Inherited from Field.)
Public propertyCode exampleIsDirty
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
(Inherited from Field.)
Public propertyCode exampleIsLocked
Gets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field.)
Public propertyCode exampleLeftExpression
Gets or sets the left part of the comparison expression.
Public propertyCode exampleLocaleId
Gets or sets the LCID of the field.
(Inherited from Field.)
Public propertyCode exampleResult
Gets or sets text that is between the field separator and field end.
(Inherited from Field.)
Public propertyCode exampleRightExpression
Gets or sets the right part of the comparison expression.
Public propertyCode exampleSeparator
Gets the node that represents the field separator. Can be null.
(Inherited from Field.)
Public propertyCode exampleStart
Gets the node that represents the start of the field.
(Inherited from Field.)
Public propertyCode exampleTrueText
Gets or sets the text displayed if the comparison expression is true.
Public propertyCode exampleType
Gets the Microsoft Word field type.
(Inherited from Field.)
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Public methodCode exampleEvaluateCondition
Evaluates the condition.
Protected methodFinalize (Inherited from Object.)
Public methodCode exampleGetFieldCode
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.
(Inherited from Field.)
Public methodCode exampleGetFieldCode(Boolean)
Returns text between field start and field separator (or field end if there is no separator).
(Inherited from Field.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodNeedStoreOldResultNodes (Inherited from Field.)
Public methodCode exampleRemove
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.
(Inherited from Field.)
Public methodToString (Inherited from Object.)
Public methodCode exampleUnlink
Performs the field unlink.
(Inherited from Field.)
Public methodCode exampleUpdate
Performs the field update. Throws if the field is being updated already.
(Inherited from Field.)
Public methodCode exampleUpdate(Boolean)
Performs a field update. Throws if the field is being updated already.
(Inherited from Field.)
Remarks

Compares the values designated by the expressions LeftExpression and RightExpression in comparison using the operator designated by ComparisonOperator.

A field in the following format will be used as a mail merge source: { IF 0 = 0 "{PatientsNameFML}" "" \* MERGEFORMAT }

Examples
Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Write("Statement 1: ");

// Use document builder to insert an if field
FieldIf fieldIf = (FieldIf)builder.InsertField(FieldType.FieldIf, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
fieldIf.LeftExpression = "0";
fieldIf.ComparisonOperator = "=";
fieldIf.RightExpression = "1";
fieldIf.TrueText = "True";
fieldIf.FalseText = "False";

Assert.AreEqual(" IF  0 = 1 True False", fieldIf.GetFieldCode());
Assert.AreEqual(FieldIfComparisonResult.False, fieldIf.EvaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.Write("\nStatement 2: ");
fieldIf = (FieldIf)builder.InsertField(FieldType.FieldIf, true);
fieldIf.LeftExpression = "5";
fieldIf.ComparisonOperator = "=";
fieldIf.RightExpression = "2 + 3";
fieldIf.TrueText = "True";
fieldIf.FalseText = "False";

Assert.AreEqual(" IF  5 = \"2 + 3\" True False", fieldIf.GetFieldCode());
Assert.AreEqual(FieldIfComparisonResult.True, fieldIf.EvaluateCondition());

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.If.docx");
See Also