Aspose::Words::Comparing::CompareOptions class

CompareOptions class

Allows to choose advanced options for document comparison operation. To learn more, visit the Compare Documents documentation article.

class CompareOptions : public System::Object

Methods

MethodDescription
CompareOptions()
get_CompareMoves() constSpecifies whether to compare differences in MoveRevision between the two documents. By default move revisions are not produced.
get_Granularity() constSpecifies whether changes are tracked by character or by word. Default value is WordLevel.
get_IgnoreCaseChanges() constTrue indicates that documents comparison is case insensitive. By default comparison is case sensitive.
get_IgnoreComments() constSpecifies whether to compare differences in comments. By default comments are not ignored.
get_IgnoreDmlUniqueId() constSpecifies whether to ignore difference in DrawingML unique Id. Default value is false.
get_IgnoreFields() constSpecifies whether to compare differences in fields. By default fields are not ignored.
get_IgnoreFootnotes() constSpecifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.
get_IgnoreFormatting() constTrue indicates that formatting is ignored. By default document formatting is not ignored.
get_IgnoreHeadersAndFooters() constTrue indicates that headers and footers content is ignored. By default headers and footers are not ignored.
get_IgnoreTables() constSpecifies whether to compare the differences in data contained in tables. By default tables are not ignored.
get_IgnoreTextboxes() constSpecifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.
get_Target() constSpecifies which document shall be used as a target during comparison.
GetType() const override
Is(const System::TypeInfo&) const override
set_CompareMoves(bool)Specifies whether to compare differences in MoveRevision between the two documents. By default move revisions are not produced.
set_Granularity(Aspose::Words::Comparing::Granularity)Setter for Aspose::Words::Comparing::CompareOptions::get_Granularity.
set_IgnoreCaseChanges(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreCaseChanges.
set_IgnoreComments(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreComments.
set_IgnoreDmlUniqueId(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreDmlUniqueId.
set_IgnoreFields(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreFields.
set_IgnoreFootnotes(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreFootnotes.
set_IgnoreFormatting(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreFormatting.
set_IgnoreHeadersAndFooters(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreHeadersAndFooters.
set_IgnoreTables(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreTables.
set_IgnoreTextboxes(bool)Setter for Aspose::Words::Comparing::CompareOptions::get_IgnoreTextboxes.
set_Target(Aspose::Words::Comparing::ComparisonTargetType)Setter for Aspose::Words::Comparing::CompareOptions::get_Target.
static Type()

Examples

Shows how to filter specific types of document elements when making a comparison.

// Create the original document and populate it with various kinds of elements.
auto docOriginal = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(docOriginal);

// Paragraph text referenced with an endnote:
builder->Writeln(u"Hello world! This is the first paragraph.");
builder->InsertFootnote(FootnoteType::Endnote, u"Original endnote text.");

// Table:
builder->StartTable();
builder->InsertCell();
builder->Write(u"Original cell 1 text");
builder->InsertCell();
builder->Write(u"Original cell 2 text");
builder->EndTable();

// Textbox:
SharedPtr<Shape> textBox = builder->InsertShape(ShapeType::TextBox, 150, 20);
builder->MoveTo(textBox->get_FirstParagraph());
builder->Write(u"Original textbox contents");

// DATE field:
builder->MoveTo(docOriginal->get_FirstSection()->get_Body()->AppendParagraph(u""));
builder->InsertField(u" DATE ");

// Comment:
auto newComment = MakeObject<Comment>(docOriginal, u"John Doe", u"J.D.", System::DateTime::get_Now());
newComment->SetText(u"Original comment.");
builder->get_CurrentParagraph()->AppendChild(newComment);

// Header:
builder->MoveToHeaderFooter(HeaderFooterType::HeaderPrimary);
builder->Writeln(u"Original header contents.");

// Create a clone of our document and perform a quick edit on each of the cloned document's elements.
auto docEdited = System::ExplicitCast<Document>(docOriginal->Clone(true));
SharedPtr<Paragraph> firstParagraph = docEdited->get_FirstSection()->get_Body()->get_FirstParagraph();

firstParagraph->get_Runs()->idx_get(0)->set_Text(u"hello world! this is the first paragraph, after editing.");
firstParagraph->get_ParagraphFormat()->set_Style(docEdited->get_Styles()->idx_get(StyleIdentifier::Heading1));
(System::ExplicitCast<Footnote>(docEdited->GetChild(NodeType::Footnote, 0, true)))
    ->get_FirstParagraph()
    ->get_Runs()
    ->idx_get(1)
    ->set_Text(u"Edited endnote text.");
(System::ExplicitCast<Table>(docEdited->GetChild(NodeType::Table, 0, true)))
    ->get_FirstRow()
    ->get_Cells()
    ->idx_get(1)
    ->get_FirstParagraph()
    ->get_Runs()
    ->idx_get(0)
    ->set_Text(u"Edited Cell 2 contents");
(System::ExplicitCast<Shape>(docEdited->GetChild(NodeType::Shape, 0, true)))
    ->get_FirstParagraph()
    ->get_Runs()
    ->idx_get(0)
    ->set_Text(u"Edited textbox contents");
(System::ExplicitCast<FieldDate>(docEdited->get_Range()->get_Fields()->idx_get(0)))->set_UseLunarCalendar(true);
(System::ExplicitCast<Comment>(docEdited->GetChild(NodeType::Comment, 0, true)))
    ->get_FirstParagraph()
    ->get_Runs()
    ->idx_get(0)
    ->set_Text(u"Edited comment.");
docEdited->get_FirstSection()
    ->get_HeadersFooters()
    ->idx_get(HeaderFooterType::HeaderPrimary)
    ->get_FirstParagraph()
    ->get_Runs()
    ->idx_get(0)
    ->set_Text(u"Edited header contents.");

// Comparing documents creates a revision for every edit in the edited document.
// A CompareOptions object has a series of flags that can suppress revisions
// on each respective type of element, effectively ignoring their change.
auto compareOptions = MakeObject<Aspose::Words::Comparing::CompareOptions>();
compareOptions->set_IgnoreFormatting(false);
compareOptions->set_IgnoreCaseChanges(false);
compareOptions->set_IgnoreComments(false);
compareOptions->set_IgnoreTables(false);
compareOptions->set_IgnoreFields(false);
compareOptions->set_IgnoreFootnotes(false);
compareOptions->set_IgnoreTextboxes(false);
compareOptions->set_IgnoreHeadersAndFooters(false);
compareOptions->set_Target(ComparisonTargetType::New);

docOriginal->Compare(docEdited, u"John Doe", System::DateTime::get_Now(), compareOptions);
docOriginal->Save(ArtifactsDir + u"Document.CompareOptions.docx");

See Also

Aspose::Words::Comparing::ComparisonTargetType enum