Aspose::Words::Fields::FieldIf Class Reference

Detailed Description

Implements the IF field.

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.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF 0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF 5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

#include <Aspose.Words.Cpp/Fields/FieldIf.h>

+ Inheritance diagram for Aspose::Words::Fields::FieldIf:

Public Member Functions

FieldIfComparisonResult EvaluateCondition ()
 Evaluates the condition. More...
 
String get_ComparisonOperator ()
 Gets or sets the comparison operator. More...
 
SharedPtr< FieldEndget_End () override
 Gets the node that represents the field end. More...
 
String get_FalseText ()
 Gets or sets the text displayed if the comparison expression is false. More...
 
String get_LeftExpression ()
 Gets or sets the left part of the comparison expression. More...
 
String get_RightExpression ()
 Gets or sets the right part of the comparison expression. More...
 
SharedPtr< FieldSeparatorget_Separator () override
 Gets the node that represents the field separator. Can be null. More...
 
SharedPtr< FieldStartget_Start () override
 Gets the node that represents the start of the field. More...
 
String get_TrueText ()
 Gets or sets the text displayed if the comparison expression is true. More...
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
void set_ComparisonOperator (const String &value)
 Setter for get_ComparisonOperator. More...
 
void set_FalseText (const String &value)
 Setter for get_FalseText. More...
 
void set_LeftExpression (const String &value)
 Setter for get_LeftExpression. More...
 
void set_RightExpression (const String &value)
 Setter for get_RightExpression. More...
 
void set_TrueText (const String &value)
 Setter for get_TrueText. More...
 
- Public Member Functions inherited from Field
String get_DisplayResult ()
 Gets the text that represents the displayed field result. More...
 
SharedPtr< FieldEndget_End () const
 Gets the node that represents the field end. More...
 
SharedPtr< FieldEndget_FieldEnd () const
 Gets the node that represents the field end. More...
 
SharedPtr< FieldStartget_FieldStart () const
 Gets the node that represents the start of the field. More...
 
SharedPtr< FieldFormatget_Format ()
 Gets a FieldFormat object that provides typed access to field's formatting. More...
 
bool get_IsDirty ()
 Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. More...
 
bool get_IsLocked ()
 Gets or sets whether the field is locked (should not recalculate its result). More...
 
int32_t get_LocaleId ()
 Gets or sets the LCID of the field. More...
 
String get_Result ()
 Gets or sets text that is between the field separator and field end. More...
 
SharedPtr< FieldSeparatorget_Separator ()
 Gets the node that represents the field separator. Can be null. More...
 
SharedPtr< FieldStartget_Start () const
 Gets the node that represents the start of the field. More...
 
virtual FieldType get_Type () const
 Gets the Microsoft Word field type. More...
 
String 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. More...
 
String GetFieldCode (bool includeChildFieldCodes)
 Returns text between field start and field separator (or field end if there is no separator). More...
 
SharedPtr< NodeRemove ()
 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. More...
 
void set_IsDirty (bool value)
 Setter for get_IsDirty. More...
 
void set_IsLocked (bool value)
 Setter for get_IsLocked. More...
 
void set_LocaleId (int32_t value)
 Setter for get_LocaleId. More...
 
void set_Result (const String &value)
 Setter for get_Result. More...
 
bool Unlink ()
 Performs the field unlink. More...
 
void Update ()
 Performs the field update. Throws if the field is being updated already. More...
 
void Update (bool ignoreMergeFormat)
 Performs a field update. Throws if the field is being updated already. More...
 

Static Public Member Functions

static const TypeInfoType ()
 
- Static Public Member Functions inherited from Field
static const TypeInfoType ()
 

Member Function Documentation

◆ EvaluateCondition()

Aspose::Words::Fields::FieldIfComparisonResult Aspose::Words::Fields::FieldIf::EvaluateCondition ( )

Evaluates the condition.

Returns
A FieldIfComparisonResult value that represents the result of the condition evaluation.
Examples

Shows how to insert an IF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF 0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF 5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

◆ get_ComparisonOperator()

System::String Aspose::Words::Fields::FieldIf::get_ComparisonOperator ( )

Gets or sets the comparison operator.

Examples

Shows how to insert an IF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF 0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF 5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

◆ get_End()

System::SharedPtr<Aspose::Words::Fields::FieldEnd> Aspose::Words::Fields::FieldIf::get_End ( )
override

Gets the node that represents the field end.

◆ get_FalseText()

System::String Aspose::Words::Fields::FieldIf::get_FalseText ( )

Gets or sets the text displayed if the comparison expression is false.

Examples

Shows how to insert an IF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF 0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF 5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

◆ get_LeftExpression()

System::String Aspose::Words::Fields::FieldIf::get_LeftExpression ( )

Gets or sets the left part of the comparison expression.

Examples

Shows how to insert an IF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF 0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF 5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

◆ get_RightExpression()

System::String Aspose::Words::Fields::FieldIf::get_RightExpression ( )

Gets or sets the right part of the comparison expression.

Examples

Shows how to insert an IF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF 0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF 5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

◆ get_Separator()

System::SharedPtr<Aspose::Words::Fields::FieldSeparator> Aspose::Words::Fields::FieldIf::get_Separator ( )
override

Gets the node that represents the field separator. Can be null.

◆ get_Start()

System::SharedPtr<Aspose::Words::Fields::FieldStart> Aspose::Words::Fields::FieldIf::get_Start ( )
override

Gets the node that represents the start of the field.

◆ get_TrueText()

System::String Aspose::Words::Fields::FieldIf::get_TrueText ( )

Gets or sets the text displayed if the comparison expression is true.

Examples

Shows how to insert an IF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF 0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF 5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Fields::FieldIf::GetType ( ) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ Is()

virtual bool Aspose::Words::Fields::FieldIf::Is ( const System::TypeInfo target) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ set_ComparisonOperator()

void Aspose::Words::Fields::FieldIf::set_ComparisonOperator ( const System::String value)

◆ set_FalseText()

void Aspose::Words::Fields::FieldIf::set_FalseText ( const System::String value)

◆ set_LeftExpression()

void Aspose::Words::Fields::FieldIf::set_LeftExpression ( const System::String value)

◆ set_RightExpression()

void Aspose::Words::Fields::FieldIf::set_RightExpression ( const System::String value)

◆ set_TrueText()

void Aspose::Words::Fields::FieldIf::set_TrueText ( const System::String value)

◆ Type()

static const System::TypeInfo& Aspose::Words::Fields::FieldIf::Type ( )
static