Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions Class Reference

Represents an options class for comparing documents with side-by-side output. More...

#include "SideBySideComparisonOptions.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API Aspose::Pdf::Comparison::SideBySideComparison::ComparisonMode get_ComparisonMode () const
 Gets and sets a comparison mode. The default value is SideBySideComparison::ComparisonMode::IgnoreSpaces. More...
 
ASPOSE_PDF_SHARED_API void set_ComparisonMode (Aspose::Pdf::Comparison::SideBySideComparison::ComparisonMode value)
 Gets and sets a comparison mode. The default value is SideBySideComparison::ComparisonMode::IgnoreSpaces. More...
 
ASPOSE_PDF_SHARED_API bool get_AdditionalChangeMarks () const
 Get and set the property that determines whether additional change markers are displayed. If set, displays change marks that are not on the current page but are present on another page. If the change lacates between words, the mark may not be positioned exactly relative to the whitespace character. The default value is false. More...
 
ASPOSE_PDF_SHARED_API void set_AdditionalChangeMarks (bool value)
 Get and set the property that determines whether additional change markers are displayed. If set, displays change marks that are not on the current page but are present on another page. If the change lacates between words, the mark may not be positioned exactly relative to the whitespace character. The default value is false. More...
 
ASPOSE_PDF_SHARED_API bool get_ExcludeTables () const
 Get and set the option that determines whether tables are excluded from comparison. This option cannot be set together with ComparisonArea1 and ComparisonArea2. The default value is false. More...
 
ASPOSE_PDF_SHARED_API void set_ExcludeTables (bool value)
 Get and set the option that determines whether tables are excluded from comparison. This option cannot be set together with ComparisonArea1 and ComparisonArea2. The default value is false. More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< Rectangle > & get_ComparisonArea1 () const
 Get and set the comparison area. Used for the first page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options. More...
 
ASPOSE_PDF_SHARED_API void set_ComparisonArea1 (System::SharedPtr< Rectangle > value)
 Get and set the comparison area. Used for the first page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options. More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< Rectangle > & get_ComparisonArea2 () const
 Get and set the comparison area. Used for the second page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options. More...
 
ASPOSE_PDF_SHARED_API void set_ComparisonArea2 (System::SharedPtr< Rectangle > value)
 Get and set the comparison area. Used for the second page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options. More...
 
ASPOSE_PDF_SHARED_API const System::ArrayPtr< System::SharedPtr< Rectangle > > & get_ExcludeAreas1 () const
 Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea1 option. More...
 
ASPOSE_PDF_SHARED_API void set_ExcludeAreas1 (System::ArrayPtr< System::SharedPtr< Rectangle >> value)
 Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea1 option. More...
 
ASPOSE_PDF_SHARED_API const System::ArrayPtr< System::SharedPtr< Rectangle > > & get_ExcludeAreas2 () const
 Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea2 option. More...
 
ASPOSE_PDF_SHARED_API void set_ExcludeAreas2 (System::ArrayPtr< System::SharedPtr< Rectangle >> value)
 Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea2 option. More...
 
ASPOSE_PDF_SHARED_API SideBySideComparisonOptions ()
 Creates an instance of SideBySideComparisonOptions class. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents an options class for comparing documents with side-by-side output.

Constructor & Destructor Documentation

◆ SideBySideComparisonOptions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::SideBySideComparisonOptions ( )

Creates an instance of SideBySideComparisonOptions class.

Member Function Documentation

◆ get_AdditionalChangeMarks()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::get_AdditionalChangeMarks ( ) const

Get and set the property that determines whether additional change markers are displayed. If set, displays change marks that are not on the current page but are present on another page. If the change lacates between words, the mark may not be positioned exactly relative to the whitespace character. The default value is false.

◆ get_ComparisonArea1()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Rectangle>& Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::get_ComparisonArea1 ( ) const

Get and set the comparison area. Used for the first page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options.

◆ get_ComparisonArea2()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Rectangle>& Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::get_ComparisonArea2 ( ) const

Get and set the comparison area. Used for the second page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options.

◆ get_ComparisonMode()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Comparison::SideBySideComparison::ComparisonMode Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::get_ComparisonMode ( ) const

Gets and sets a comparison mode. The default value is SideBySideComparison::ComparisonMode::IgnoreSpaces.

◆ get_ExcludeAreas1()

ASPOSE_PDF_SHARED_API const System::ArrayPtr<System::SharedPtr<Rectangle> >& Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::get_ExcludeAreas1 ( ) const

Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea1 option.

◆ get_ExcludeAreas2()

ASPOSE_PDF_SHARED_API const System::ArrayPtr<System::SharedPtr<Rectangle> >& Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::get_ExcludeAreas2 ( ) const

Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea2 option.

◆ get_ExcludeTables()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::get_ExcludeTables ( ) const

Get and set the option that determines whether tables are excluded from comparison. This option cannot be set together with ComparisonArea1 and ComparisonArea2. The default value is false.

◆ set_AdditionalChangeMarks()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::set_AdditionalChangeMarks ( bool  value)

Get and set the property that determines whether additional change markers are displayed. If set, displays change marks that are not on the current page but are present on another page. If the change lacates between words, the mark may not be positioned exactly relative to the whitespace character. The default value is false.

◆ set_ComparisonArea1()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::set_ComparisonArea1 ( System::SharedPtr< Rectangle value)

Get and set the comparison area. Used for the first page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options.

◆ set_ComparisonArea2()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::set_ComparisonArea2 ( System::SharedPtr< Rectangle value)

Get and set the comparison area. Used for the second page or document in the comparison method. This option can't be setted along with ExcludeTables, ExcludeAreas1 and ExcludeAreas2 options.

◆ set_ComparisonMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::set_ComparisonMode ( Aspose::Pdf::Comparison::SideBySideComparison::ComparisonMode  value)

Gets and sets a comparison mode. The default value is SideBySideComparison::ComparisonMode::IgnoreSpaces.

◆ set_ExcludeAreas1()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::set_ExcludeAreas1 ( System::ArrayPtr< System::SharedPtr< Rectangle >>  value)

Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea1 option.

◆ set_ExcludeAreas2()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::set_ExcludeAreas2 ( System::ArrayPtr< System::SharedPtr< Rectangle >>  value)

Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with ExcludeTables. This option can't be setted along with ComparisonArea2 option.

◆ set_ExcludeTables()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Comparison::SideBySideComparison::SideBySideComparisonOptions::set_ExcludeTables ( bool  value)

Get and set the option that determines whether tables are excluded from comparison. This option cannot be set together with ComparisonArea1 and ComparisonArea2. The default value is false.