Aspose::Words::CompareOptions Class Reference

Detailed Description

Allows to choose advanced options for document comparison operation.

#include <Aspose.Words.Cpp/Model/Comparer/CompareOptions.h>

+ Inheritance diagram for Aspose::Words::CompareOptions:

Public Member Functions

 CompareOptions ()
 
Granularity get_Granularity () const
 Specifies whether changes are tracked by character or by word. Default value is WordLevel. More...
 
bool get_IgnoreCaseChanges () const
 True indicates that documents comparison is case insensitive. By default comparison is case sensitive. More...
 
bool get_IgnoreComments () const
 Specifies whether to compare differences in comments. By default comments are not ignored. More...
 
bool get_IgnoreFields () const
 Specifies whether to compare differences in fields. By default fields are not ignored. More...
 
bool get_IgnoreFootnotes () const
 Specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored. More...
 
bool get_IgnoreFormatting () const
 True indicates that formatting is ignored. By default document formatting is not ignored. More...
 
bool get_IgnoreHeadersAndFooters () const
 True indicates that headers and footers content is ignored. By default headers and footers are not ignored. More...
 
bool get_IgnoreTables () const
 Specifies whether to compare the differences in data contained in tables. By default tables are not ignored. More...
 
bool get_IgnoreTextboxes () const
 Specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored. More...
 
ComparisonTargetType get_Target () const
 Specifies which document shall be used as a target during comparison. More...
 
void set_Granularity (Granularity value)
 Setter for get_Granularity. More...
 
void set_IgnoreCaseChanges (bool value)
 Setter for get_IgnoreCaseChanges. More...
 
void set_IgnoreComments (bool value)
 Setter for get_IgnoreComments. More...
 
void set_IgnoreFields (bool value)
 Setter for get_IgnoreFields. More...
 
void set_IgnoreFootnotes (bool value)
 Setter for get_IgnoreFootnotes. More...
 
void set_IgnoreFormatting (bool value)
 Setter for get_IgnoreFormatting. More...
 
void set_IgnoreHeadersAndFooters (bool value)
 Setter for get_IgnoreHeadersAndFooters. More...
 
void set_IgnoreTables (bool value)
 Setter for get_IgnoreTables. More...
 
void set_IgnoreTextboxes (bool value)
 Setter for get_IgnoreTextboxes. More...
 
void set_Target (ComparisonTargetType value)
 Specifies which document shall be used as a target during comparison. More...
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Constructor & Destructor Documentation

◆ CompareOptions()

Aspose::Words::CompareOptions::CompareOptions ( )

Member Function Documentation

◆ get_Granularity()

Aspose::Words::Granularity Aspose::Words::CompareOptions::get_Granularity ( ) const

Specifies whether changes are tracked by character or by word. Default value is WordLevel.

◆ get_IgnoreCaseChanges()

bool Aspose::Words::CompareOptions::get_IgnoreCaseChanges ( ) const

True indicates that documents comparison is case insensitive. By default comparison is case sensitive.

◆ get_IgnoreComments()

bool Aspose::Words::CompareOptions::get_IgnoreComments ( ) const

Specifies whether to compare differences in comments. By default comments are not ignored.

◆ get_IgnoreFields()

bool Aspose::Words::CompareOptions::get_IgnoreFields ( ) const

Specifies whether to compare differences in fields. By default fields are not ignored.

◆ get_IgnoreFootnotes()

bool Aspose::Words::CompareOptions::get_IgnoreFootnotes ( ) const

Specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.

◆ get_IgnoreFormatting()

bool Aspose::Words::CompareOptions::get_IgnoreFormatting ( ) const

True indicates that formatting is ignored. By default document formatting is not ignored.

◆ get_IgnoreHeadersAndFooters()

bool Aspose::Words::CompareOptions::get_IgnoreHeadersAndFooters ( ) const

True indicates that headers and footers content is ignored. By default headers and footers are not ignored.

◆ get_IgnoreTables()

bool Aspose::Words::CompareOptions::get_IgnoreTables ( ) const

Specifies whether to compare the differences in data contained in tables. By default tables are not ignored.

◆ get_IgnoreTextboxes()

bool Aspose::Words::CompareOptions::get_IgnoreTextboxes ( ) const

Specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.

◆ get_Target()

Aspose::Words::ComparisonTargetType Aspose::Words::CompareOptions::get_Target ( ) const

Specifies which document shall be used as a target during comparison.

◆ set_Granularity()

void Aspose::Words::CompareOptions::set_Granularity ( Aspose::Words::Granularity  value)

◆ set_IgnoreCaseChanges()

void Aspose::Words::CompareOptions::set_IgnoreCaseChanges ( bool  value)

◆ set_IgnoreComments()

void Aspose::Words::CompareOptions::set_IgnoreComments ( bool  value)

◆ set_IgnoreFields()

void Aspose::Words::CompareOptions::set_IgnoreFields ( bool  value)

◆ set_IgnoreFootnotes()

void Aspose::Words::CompareOptions::set_IgnoreFootnotes ( bool  value)

◆ set_IgnoreFormatting()

void Aspose::Words::CompareOptions::set_IgnoreFormatting ( bool  value)

◆ set_IgnoreHeadersAndFooters()

void Aspose::Words::CompareOptions::set_IgnoreHeadersAndFooters ( bool  value)

◆ set_IgnoreTables()

void Aspose::Words::CompareOptions::set_IgnoreTables ( bool  value)

◆ set_IgnoreTextboxes()

void Aspose::Words::CompareOptions::set_IgnoreTextboxes ( bool  value)

◆ set_Target()

void Aspose::Words::CompareOptions::set_Target ( Aspose::Words::ComparisonTargetType  value)

Specifies which document shall be used as a target during comparison.