|
Aspose::Words::Fields::FieldCompare Class Reference
Implements the COMPARE field.
- Examples
Shows how to compare expressions using a COMPARE field.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"3");
field->set_ComparisonOperator(u"<");
field->set_RightExpression(u"2");
field->Update();
// The COMPARE field displays a "0" or a "1", depending on its statement's truth.
// The result of this statement is false so that this field will display a "0".
ASSERT_EQ(u" COMPARE 3 < 2", field->GetFieldCode());
ASSERT_EQ(u"0", field->get_Result());
builder->Writeln();
field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->Update();
// This field displays a "1" since the statement is true.
ASSERT_EQ(u" COMPARE 5 = \"2 + 3\"", field->GetFieldCode());
ASSERT_EQ(u"1", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.COMPARE.docx");
#include <Aspose.Words.Cpp/Fields/FieldCompare.h>
Inheritance diagram for Aspose::Words::Fields::FieldCompare:
Public Member Functions | |
| String | get_ComparisonOperator () |
| Gets or sets the comparison operator. 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... | |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_ComparisonOperator (String value) |
| Setter for get_ComparisonOperator. More... | |
| void | set_LeftExpression (String value) |
| Setter for get_LeftExpression. More... | |
| void | set_RightExpression (String value) |
| Setter for get_RightExpression. More... | |
| Public Member Functions inherited from Field | |
| String | get_DisplayResult () |
| Gets the text that represents the displayed field result. More... | |
| SharedPtr< FieldEnd > | get_End () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldEnd > | get_FieldEnd () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldStart > | get_FieldStart () const |
| Gets the node that represents the start of the field. More... | |
| SharedPtr< FieldFormat > | get_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< FieldSeparator > | get_Separator () |
| Gets the node that represents the field separator. Can be null. More... | |
| SharedPtr< FieldStart > | get_Start () const |
| Gets the node that represents the start of the field. More... | |
| virtual FieldType | get_Type () |
| 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< Node > | 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. 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 (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 TypeInfo & | Type () |
| Static Public Member Functions inherited from Field | |
| static const TypeInfo & | Type () |
Member Function Documentation
◆ get_ComparisonOperator()
| System::String Aspose::Words::Fields::FieldCompare::get_ComparisonOperator | ( | ) |
Gets or sets the comparison operator.
- Examples
Shows how to compare expressions using a COMPARE field.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"3");
field->set_ComparisonOperator(u"<");
field->set_RightExpression(u"2");
field->Update();
// The COMPARE field displays a "0" or a "1", depending on its statement's truth.
// The result of this statement is false so that this field will display a "0".
ASSERT_EQ(u" COMPARE 3 < 2", field->GetFieldCode());
ASSERT_EQ(u"0", field->get_Result());
builder->Writeln();
field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->Update();
// This field displays a "1" since the statement is true.
ASSERT_EQ(u" COMPARE 5 = \"2 + 3\"", field->GetFieldCode());
ASSERT_EQ(u"1", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.COMPARE.docx");
◆ get_LeftExpression()
| System::String Aspose::Words::Fields::FieldCompare::get_LeftExpression | ( | ) |
Gets or sets the left part of the comparison expression.
- Examples
Shows how to compare expressions using a COMPARE field.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"3");
field->set_ComparisonOperator(u"<");
field->set_RightExpression(u"2");
field->Update();
// The COMPARE field displays a "0" or a "1", depending on its statement's truth.
// The result of this statement is false so that this field will display a "0".
ASSERT_EQ(u" COMPARE 3 < 2", field->GetFieldCode());
ASSERT_EQ(u"0", field->get_Result());
builder->Writeln();
field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->Update();
// This field displays a "1" since the statement is true.
ASSERT_EQ(u" COMPARE 5 = \"2 + 3\"", field->GetFieldCode());
ASSERT_EQ(u"1", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.COMPARE.docx");
◆ get_RightExpression()
| System::String Aspose::Words::Fields::FieldCompare::get_RightExpression | ( | ) |
Gets or sets the right part of the comparison expression.
- Examples
Shows how to compare expressions using a COMPARE field.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"3");
field->set_ComparisonOperator(u"<");
field->set_RightExpression(u"2");
field->Update();
// The COMPARE field displays a "0" or a "1", depending on its statement's truth.
// The result of this statement is false so that this field will display a "0".
ASSERT_EQ(u" COMPARE 3 < 2", field->GetFieldCode());
ASSERT_EQ(u"0", field->get_Result());
builder->Writeln();
field = System::DynamicCast<FieldCompare>(builder->InsertField(FieldType::FieldCompare, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->Update();
// This field displays a "1" since the statement is true.
ASSERT_EQ(u" COMPARE 5 = \"2 + 3\"", field->GetFieldCode());
ASSERT_EQ(u"1", field->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.COMPARE.docx");
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_ComparisonOperator()
| void Aspose::Words::Fields::FieldCompare::set_ComparisonOperator | ( | System::String | value | ) |
◆ set_LeftExpression()
| void Aspose::Words::Fields::FieldCompare::set_LeftExpression | ( | System::String | value | ) |
◆ set_RightExpression()
| void Aspose::Words::Fields::FieldCompare::set_RightExpression | ( | System::String | value | ) |
◆ Type()
|
static |