Class TextDiffOptions
Implements
Inherited Members
Namespace: pdftron.PDF
Assembly: PDFNetAndroid.dll
Syntax
public class TextDiffOptions : OptionsBase, IDisposable
Constructors
TextDiffOptions()
Declaration
public TextDiffOptions()
Methods
AddIgnoreZonesForPage(RectCollection, Int32)
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 |
System.Int32 | pageNum | the page number the added regions belong to |
Returns
Type | Description |
---|---|
TextDiffOptions |
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 |
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 |
---|---|
System.Boolean | a bool, Whether to use z-order (aka paint order) when comparing text between A and B. On by default.. |
GetOpacityA()
Gets the value OpacityA from the options object The difference opacity for deletions
Declaration
public double GetOpacityA()
Returns
Type | Description |
---|---|
System.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 |
---|---|
System.Double | a double, The difference opacity for insertions in between 0.0 (transparent) and 1.0 (opaque) |
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 |
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 |
SetCompareUsingZOrder(Boolean)
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 |
---|---|---|
System.Boolean | 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 |
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 |
---|---|---|
System.Double | opacity | The difference opacity for deletions in between 0.0 (transparent) and 1.0 (opaque) |
Returns
Type | Description |
---|---|
TextDiffOptions |
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 |
---|---|---|
System.Double | opacity | The difference opacity for insertions in between 0.0 (transparent) and 1.0 (opaque) |
Returns
Type | Description |
---|---|
TextDiffOptions |