public class SideBySideComparisonOptions extends Object
Represents an options class for comparing documents with side-by-side output.
Constructor and Description |
---|
SideBySideComparisonOptions()
Creates an instance of
SideBySideComparisonOptions class. |
Modifier and Type | Method and Description |
---|---|
boolean |
getAdditionalChangeMarks()
Get and set the property that determines whether additional change markers are displayed.
|
Rectangle |
getComparisonArea1()
Get and set the comparison area.
|
Rectangle |
getComparisonArea2()
Get and set the comparison area.
|
int |
getComparisonMode()
Gets and sets a comparison mode.
|
Rectangle[] |
getExcludeAreas1()
Get and set the exclude areas.
|
Rectangle[] |
getExcludeAreas2()
Get and set the exclude areas.
|
boolean |
getExcludeTables()
Get and set the option that determines whether tables are excluded from comparison.
|
void |
setAdditionalChangeMarks(boolean value)
Get and set the property that determines whether additional change markers are displayed.
|
void |
setComparisonArea1(Rectangle value)
Get and set the comparison area.
|
void |
setComparisonArea2(Rectangle value)
Get and set the comparison area.
|
void |
setComparisonMode(int value)
Gets and sets a comparison mode.
|
void |
setExcludeAreas1(Rectangle[] value)
Get and set the exclude areas.
|
void |
setExcludeAreas2(Rectangle[] value)
Get and set the exclude areas.
|
void |
setExcludeTables(boolean value)
Get and set the option that determines whether tables are excluded from comparison.
|
public SideBySideComparisonOptions()
Creates an instance of SideBySideComparisonOptions
class.
public final int getComparisonMode()
Gets and sets a comparison mode.
The default value is ComparisonMode.IgnoreSpaces
.
public final void setComparisonMode(int value)
Gets and sets a comparison mode.
The default value is ComparisonMode.IgnoreSpaces
.
value
- ComparisonMode elementpublic final boolean getAdditionalChangeMarks()
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
.
public final void setAdditionalChangeMarks(boolean 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
.
value
- boolean valuepublic final boolean getExcludeTables()
Get and set the option that determines whether tables are excluded from comparison.
This option cannot be set together with ComparisonArea1
(getComparisonArea1()
/setComparisonArea1(Rectangle)
) and ComparisonArea2
(getComparisonArea2()
/setComparisonArea2(Rectangle)
).
The default value is false
.
public final void setExcludeTables(boolean value)
Get and set the option that determines whether tables are excluded from comparison.
This option cannot be set together with ComparisonArea1
(getComparisonArea1()
/setComparisonArea1(Rectangle)
) and ComparisonArea2
(getComparisonArea2()
/setComparisonArea2(Rectangle)
).
The default value is false
.
value
- boolean valuepublic final Rectangle getComparisonArea1()
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
(getExcludeTables()
/setExcludeTables(boolean)
), ExcludeAreas1
(getExcludeAreas1()
/setExcludeAreas1(Rectangle[])
) and ExcludeAreas2
(getExcludeAreas2()
/setExcludeAreas2(Rectangle[])
) options.
public final void setComparisonArea1(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
(getExcludeTables()
/setExcludeTables(boolean)
), ExcludeAreas1
(getExcludeAreas1()
/setExcludeAreas1(Rectangle[])
) and ExcludeAreas2
(getExcludeAreas2()
/setExcludeAreas2(Rectangle[])
) options.
value
- Rectangle instancepublic final Rectangle getComparisonArea2()
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
(getExcludeTables()
/setExcludeTables(boolean)
), ExcludeAreas1
(getExcludeAreas1()
/setExcludeAreas1(Rectangle[])
) and ExcludeAreas2
(getExcludeAreas2()
/setExcludeAreas2(Rectangle[])
) options.
public final void setComparisonArea2(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
(getExcludeTables()
/setExcludeTables(boolean)
), ExcludeAreas1
(getExcludeAreas1()
/setExcludeAreas1(Rectangle[])
) and ExcludeAreas2
(getExcludeAreas2()
/setExcludeAreas2(Rectangle[])
) options.
value
- Rectangle instancepublic final Rectangle[] getExcludeAreas1()
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
(getExcludeTables()
/setExcludeTables(boolean)
). This option can't be setted along with ComparisonArea1
(getComparisonArea1()
/setComparisonArea1(Rectangle)
) option.
public final void setExcludeAreas1(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
(getExcludeTables()
/setExcludeTables(boolean)
). This option can't be setted along with ComparisonArea1
(getComparisonArea1()
/setComparisonArea1(Rectangle)
) option.
value
- array of Rectangle instancespublic final Rectangle[] getExcludeAreas2()
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
(getExcludeTables()
/setExcludeTables(boolean)
). This option can't be setted along with ComparisonArea2
(getComparisonArea2()
/setComparisonArea2(Rectangle)
) option.
public final void setExcludeAreas2(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
(getExcludeTables()
/setExcludeTables(boolean)
). This option can't be setted along with ComparisonArea2
(getComparisonArea2()
/setComparisonArea2(Rectangle)
) option.
value
- Rectangle instanceCopyright © 2025 Aspose. All Rights Reserved.