Class TextDiffOptions
Inherited Members
Namespace: pdftron.PDF
Assembly: PDFNet.dll
Syntax
public class TextDiffOptions : OptionsBase
Constructors
TextDiffOptions()
Constructor.
Declaration
public TextDiffOptions()
Methods
AddIgnoreZonesForPage(RectCollection, int)
Adds a collection of ignorable regions for the given page Optional list of page areas that will be not be processed
Declaration
public TextDiffOptions AddIgnoreZonesForPage(RectCollection regions, int pageNum)
Parameters
Type | Name | Description |
---|---|---|
RectCollection | regions | optional list of page areas to be excluded from analysis |
int | pageNum | the page number the added regions belong to |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
GetColorA()
Gets the value ColorA from the options object The difference color for deletions
Declaration
public ColorPt GetColorA()
Returns
Type | Description |
---|---|
ColorPt | a ColorPt^, The difference color for deletions in the form of R, G, B |
GetColorB()
Gets the value ColorB from the options object The difference color for insertions
Declaration
public ColorPt GetColorB()
Returns
Type | Description |
---|---|
ColorPt | a ColorPt^, The difference color for insertions in the form of R, G, B |
GetCompareStyles()
Gets the value CompareStyles from the options object Whether to highlight text style differences. Off by default. Text style includes font, size, bold, italic and text color. For example, if a word is italic in document A and is bold in document B, we can highlight the location of the word in both documents.
Declaration
public bool GetCompareStyles()
Returns
Type | Description |
---|---|
bool | a bool, Whether to highlight text style differences. Off by default. |
GetCompareUsingZOrder()
Gets the value CompareUsingZOrder from the options object Whether to use z-order (aka paint order) when comparing text between A and B. On by default.
Declaration
public bool GetCompareUsingZOrder()
Returns
Type | Description |
---|---|
bool | a bool, Whether to use z-order (aka paint order) when comparing text between A and B. On by default.. |
GetExtraMoveColor()
Gets the value ExtraMoveColor from the options object The difference color for extra moves
Declaration
public ColorPt GetExtraMoveColor()
Returns
Type | Description |
---|---|
ColorPt | a ColorPt^, The difference color for extra moves in the form of R, G, B |
GetExtraMoveHighlight()
Gets the value ExtraMoveHighlight from the options object Whether to highlight text in between short-distance moves when comparing text between A and B. Off by default.
Declaration
public bool GetExtraMoveHighlight()
Returns
Type | Description |
---|---|
bool | a bool, Whether to highlight text in between short-distance moves when comparing text between A and B. Off by default. |
GetExtraMoveOpacity()
Gets the value ExtraMoveOpacity from the options object The difference opacity for extra moves
Declaration
public double GetExtraMoveOpacity()
Returns
Type | Description |
---|---|
double | a double, The difference opacity for extra moves in between 0.0 (transparent) and 1.0 (opaque) |
GetOpacityA()
Gets the value OpacityA from the options object The difference opacity for deletions
Declaration
public double GetOpacityA()
Returns
Type | Description |
---|---|
double | a double, The difference opacity for deletions in between 0.0 (transparent) and 1.0 (opaque) |
GetOpacityB()
Gets the value OpacityB from the options object The difference opacity for insertions
Declaration
public double GetOpacityB()
Returns
Type | Description |
---|---|
double | a double, The difference opacity for insertions in between 0.0 (transparent) and 1.0 (opaque) |
GetShowPlaceholders()
Gets the value ShowPlaceholders from the options object Whether to show placeholder annotations. On by default. Placeholders are insertion locations in document A and deletion locations in document B. For example, if a word is removed from document B, we can highlight the location of the original word in document A, but there is no word to highlight in B (it's removed). In this case a small "placeholder" annotation is placed in B to identify the location of the removal.
Declaration
public bool GetShowPlaceholders()
Returns
Type | Description |
---|---|
bool | a bool, Whether to show placeholder annotations. On by default. |
SetColorA(ColorPt)
Sets the value for ColorA in the options object The difference color for deletions
Declaration
public TextDiffOptions SetColorA(ColorPt color)
Parameters
Type | Name | Description |
---|---|---|
ColorPt | color | The difference color for deletions in the form of R, G, B |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetColorB(ColorPt)
Sets the value for ColorB in the options object The difference color for insertions
Declaration
public TextDiffOptions SetColorB(ColorPt color)
Parameters
Type | Name | Description |
---|---|---|
ColorPt | color | The difference color for insertions in the form of R, G, B |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetCompareStyles(bool)
Sets the value for CompareStyles in the options object Whether to highlight text style differences. Off by default. Text style includes font, size, bold, italic and text color. For example, if a word is italic in document A and is bold in document B, we can highlight the location of the word in both documents.
Declaration
public TextDiffOptions SetCompareStyles(bool value)
Parameters
Type | Name | Description |
---|---|---|
bool | value | Whether to highlight text style differences. Off by default. |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetCompareUsingZOrder(bool)
Sets the value for CompareUsingZOrder in the options object Whether to use z-order (aka paint order) when comparing text between A and B. On by default.
Declaration
public TextDiffOptions SetCompareUsingZOrder(bool value)
Parameters
Type | Name | Description |
---|---|---|
bool | value | Whether to use z-order (aka paint order) when comparing text between A and B. On by default. |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetExtraMoveColor(ColorPt)
Sets the value for ExtraMoveColor in the options object The difference color for extra moves
Declaration
public TextDiffOptions SetExtraMoveColor(ColorPt color)
Parameters
Type | Name | Description |
---|---|---|
ColorPt | color | The difference color for extra moves in the form of R, G, B |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetExtraMoveHighlight(bool)
Sets the value for ExtraMoveHighlight in the options object Whether to highlight text in between short-distance moves when comparing text between A and B. Off by default.
Declaration
public TextDiffOptions SetExtraMoveHighlight(bool value)
Parameters
Type | Name | Description |
---|---|---|
bool | value | Whether to highlight text in between short-distance moves when comparing text between A and B. Off by default. |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetExtraMoveOpacity(double)
Sets the value for ExtraMoveOpacity in the options object The difference opacity for extra moves
Declaration
public TextDiffOptions SetExtraMoveOpacity(double opacity)
Parameters
Type | Name | Description |
---|---|---|
double | opacity | The difference opacity for extra moves in between 0.0 (transparent) and 1.0 (opaque) |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetOpacityA(double)
Sets the value for OpacityA in the options object The difference opacity for deletions
Declaration
public TextDiffOptions SetOpacityA(double opacity)
Parameters
Type | Name | Description |
---|---|---|
double | opacity | The difference opacity for deletions in between 0.0 (transparent) and 1.0 (opaque) |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetOpacityB(double)
Sets the value for OpacityB in the options object The difference opacity for insertions
Declaration
public TextDiffOptions SetOpacityB(double opacity)
Parameters
Type | Name | Description |
---|---|---|
double | opacity | The difference opacity for insertions in between 0.0 (transparent) and 1.0 (opaque) |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |
SetShowPlaceholders(bool)
Sets the value for ShowPlaceholders in the options object Whether to show placeholder annotations. On by default. Placeholders are insertion locations in document A and deletion locations in document B. For example, if a word is removed from document B, we can highlight the location of the original word in document A, but there is no word to highlight in B (it's removed). In this case a small "placeholder" annotation is placed in B to identify the location of the removal.
Declaration
public TextDiffOptions SetShowPlaceholders(bool value)
Parameters
Type | Name | Description |
---|---|---|
bool | value | Whether to show placeholder annotations. On by default. |
Returns
Type | Description |
---|---|
TextDiffOptions | this object, for call chaining |