Class PDFCProperty

Enumeration of the various configuration properties which can be set for i-net PDFC.

Inheritance
System.Object
PDFCProperty
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: inetsoftware.Pdfc.Config
Assembly: inetsoftware.Pdfc.dll
Syntax
public class PDFCProperty

Constructors

PDFCProperty()

Declaration
public PDFCProperty()

Fields

COMPARE_LINE_STYLES

This is a parameter for any type of line/shape comparison - either paged or continuous. If set to 'true' the styles of all matched lines and shapes will be checked as well.

Declaration
public const string COMPARE_LINE_STYLES = "COMPARE_LINE_STYLES"
Field Value
Type Description
System.String

COMPARE_TEXT_CASE_SENSITIVE

This switch toggles the case sensitivity of the text comparison. If set to 'false', all text elements will be compared as lower case. This cause the comparison to run slightly slower and take some more memory. The conversion to lower case will be performed using the default localization of the runtime.

The default value is 'true'.

Declaration
public const string COMPARE_TEXT_CASE_SENSITIVE = "COMPARE_TEXT_CASE_SENSITIVE"
Field Value
Type Description
System.String

COMPARE_TEXT_STYLES

Specifies a comma-separated list of textstyles. TextStyleType modify the content of PDF files so that comparison of the files can ignore unwanted detail differences. Values should be comma-separated.

Declaration
public const string COMPARE_TEXT_STYLES = "COMPARE_TEXT_STYLES"
Field Value
Type Description
System.String

COMPARE_TYPES

A comma separated list of compare tpes to be included in the comparison.

Declaration
public const string COMPARE_TYPES = "COMPARE_TYPES"
Field Value
Type Description
System.String

CONTINUOUS_COMPARE

Enables / Disable continuous compare.

A setting of true will set the comparison to a mode which ignores the page gaps and compares all content one continuous stream. This mode ignores the absolute position of content element and takes only their relation to each other into account.

A setting of false will compare the documents page by page. This mode allows to check the exact absolute position of the content e.G. for print layouts. But: If there is any shift in the pages, this will cause all further content to be different.

The default is: true - Continuous mode

Declaration
public const string CONTINUOUS_COMPARE = "CONTINUOUS_COMPARE"
Field Value
Type Description
System.String

CONTINUOUS_DETECT_PAGES

Specifies whether the continuous compare can be splited instead of comparing all content at once.

If set to a value greater zero, this specifies how many pages may be added or inserted before the comparison fails to match the content. The larger this value, the more precise the comparison will be. On the downside a large value will increase the memory consumption.

If this value is set to zero, all content will be compared at one. This will give the optimum result on the cost of a maximum memory requirement.

Declaration
public const string CONTINUOUS_DETECT_PAGES = "CONTINUOUS_DETECT_PAGES"
Field Value
Type Description
System.String

CREATE_DIFFIMAGES

Specifies if a PNG image with the marked difference will be created. Such a image will be created for for each pair of pages if there are differences in elements, contained in these pages. The available values are: 'first' to paint only the original page, 'second' to paint only the new page and 'true' to paint both pages. Any other value will disable the difference images. The default value is: false.

Declaration
[Obsolete("This property is since 5.0 obsolete and will be removed in a future version.")]
public const string CREATE_DIFFIMAGES = "CREATE_DIFFIMAGES"
Field Value
Type Description
System.String
See Also

CREATE_ORIGIMAGES

Specifies if a PNG image with the original content will be created for each compared page. The default value is: false.

Declaration
[Obsolete("This property is since 5.0 obsolete and will be removed in a future version.")]
public const string CREATE_ORIGIMAGES = "CREATE_ORIGIMAGES"
Field Value
Type Description
System.String
See Also

CREATE_XORIMAGES

Creates an (negated) XOR image for any pair of pages with differences. The image will be stored as an PNG in the differences directory of the current comparison. If CREATE_DIFFIMAGES is enabled and set to 'true', the XOR image will be drawn onto the image created by CREATE_DIFFIMAGES between the two actual page images.

Declaration
[Obsolete("This property is since 5.0 obsolete and will be removed in a future version.")]
public const string CREATE_XORIMAGES = "CREATE_XORIMAGES"
Field Value
Type Description
System.String
See Also

EXPORT_PDF_ALWAYS

Defines in which cases the PDF export should create an export file. This is only relevant in case the -p option is set when calling the i-net PDFC command line version.

A setting of 

true
will force the export to generate a PDF for any comparison.

A setting of 

false
will advise the export to only generate a PDF if any differences were found during a comparison.

The default is false

Declaration
public const string EXPORT_PDF_ALWAYS = "EXPORT_PDF_ALWAYS"
Field Value
Type Description
System.String

FILTER_PATTERNS

The CR-separated list of patterns for the RegExp Filter. Each line has the format:

<filter pattern> | <'text' or 'regexp'> | <'active' or 'inactive'>

The keywords text an regexp toggle between plain text and regular expression matching.

The keywords active an inactive define whether a filter rule should be applied.

If you want to match a multi-line string, please replace the expected line breaks by [[BR]], otherwise the filter will interpret the filter rule as several independent rules.

Declaration
public const string FILTER_PATTERNS = "FILTER_PATTERNS"
Field Value
Type Description
System.String

FILTERS

Defines the filters to be used before the elements of the documents are passed to the comparer.

Please not that filters are plugins. Each filter must be installed, activated in the configuration (server only) and listed in the FILTERS property to be enabled. Furthermore there could be additional properties to a filter. Please refer to the documentation of the filters for details.

Declaration
public const string FILTERS = "FILTERS"
Field Value
Type Description
System.String

Specify the property for header/footer filter.

Declaration
public const string FIXED_FOOTER_SIZE = "FIXED_FOOTER_SIZE"
Field Value
Type Description
System.String

FIXED_HEADER_SIZE

Specify the property for header/footer filter.

Declaration
public const string FIXED_HEADER_SIZE = "FIXED_HEADER_SIZE"
Field Value
Type Description
System.String

IMAGE_CHANGE_AREA

If the image compare block by block with better result. A disadvantages is , it need more performance.

Declaration
public const string IMAGE_CHANGE_AREA = "IMAGE_CHANGE_AREA"
Field Value
Type Description
System.String

IMAGE_SCALE_FACTOR

Defines a scale factor for the generated images (original and difference images). The default is 1 which is no scaling.

Declaration
[Obsolete("This property is since 5.0 obsolete and will be removed in a future version.")]
public const string IMAGE_SCALE_FACTOR = "IMAGE_SCALE_FACTOR"
Field Value
Type Description
System.String

LOG_LEVEL

Specifies the Logging Level. Available values: OFF, ERROR, WARN, INFO, ALL. OFF switches the output completely off. ERROR informs about the serious errors. WARN contains all the messages from ERROR-Level and furthermore, informs about the irregularities during the execution. INFO contains all the messages from WARN-Level and furthermore, describes settings and environment attributes. ALL is used to display the maximal information during the PDFC execution. The default value is: INFO.

Declaration
[Obsolete("This property is since 5.0 obsolete and will be removed in a future version.")]
public const string LOG_LEVEL = "LOG_LEVEL"
Field Value
Type Description
System.String

MAX_ERRORS_PER_FILE

Specifies the maximum number of errors that can occur before the comparison will be stopped for the current PDF file. The default value is: 100. [value: -1 for unlimited]

Declaration
[Obsolete("This property is since 5.0 obsolete and will be removed in a future version.")]
public const string MAX_ERRORS_PER_FILE = "MAX_ERRORS_PER_FILE"
Field Value
Type Description
System.String

TEXT_ALIGN_RATIO

This value is the maximum allowed y-jitter for the text line identification. It's relative to the text height of the respective line. This value can be used to compensate rounding errors of different PDF generators

Declaration
public const string TEXT_ALIGN_RATIO = "TEXT_ALIGN_RATIO"
Field Value
Type Description
System.String

TOLERANCE_BOX_ROUND_EDGES

Specifies the maximum number of pixels (1 pixel is approximately 0.265mm) that a control point of a quadratic Bézier curve may differ in total before it is viewed as a difference. The default value is: 3.

Declaration
public const string TOLERANCE_BOX_ROUND_EDGES = "TOLERANCE_BOX_ROUND_EDGES"
Field Value
Type Description
System.String

TOLERANCE_COLOR

Defines the maximum color difference per RGB or HSB channel for all paints. The value is the absolute difference for HSB and absolute * 255 for RGB. The default value is: 0.01 which is 1%.

Declaration
public const string TOLERANCE_COLOR = "TOLERANCE_COLOR"
Field Value
Type Description
System.String

TOLERANCE_IMAGE_DISTANCE

Specifies the maximum number of pixels that the position of an image can differ before it is viewed as a difference. The default value is: 3.

Declaration
public const string TOLERANCE_IMAGE_DISTANCE = "TOLERANCE_IMAGE_DISTANCE"
Field Value
Type Description
System.String

TOLERANCE_IMAGE_PIXEL_VALUE

Specifies the maximal allowed discrepancy of pixel values (Double) before it is viewed as a difference. The range of this property is [0,1]. The default value is: 0.05.

Declaration
public const string TOLERANCE_IMAGE_PIXEL_VALUE = "TOLERANCE_IMAGE_PIXEL_VALUE"
Field Value
Type Description
System.String

TOLERANCE_IMAGE_SIZE

Specifies the maximum relative difference that the area spanned by an image may differ before it is viewed as a difference. The default value is: 0.1.

Declaration
public const string TOLERANCE_IMAGE_SIZE = "TOLERANCE_IMAGE_SIZE"
Field Value
Type Description
System.String

TOLERANCE_LINE_POSITION

Specifies the maximum number of pixels that the position of a line or curves can differ per axis before it is viewed as a difference. The default value is: 3.

Declaration
public const string TOLERANCE_LINE_POSITION = "TOLERANCE_LINE_POSITION"
Field Value
Type Description
System.String

TOLERANCE_LINE_SIZE

Specifies the maximum number of pixels that the length of a line can differ in total before it is viewed as a difference. The default value is: 2.

Declaration
public const string TOLERANCE_LINE_SIZE = "TOLERANCE_LINE_SIZE"
Field Value
Type Description
System.String

TOLERANCE_LINE_STYLE

Specifies if a different line dash pattern, describing dashes and gaps used to stroke paths will be viewed as a difference. The default value is: false.

Declaration
public const string TOLERANCE_LINE_STYLE = "TOLERANCE_LINE_STYLE"
Field Value
Type Description
System.String

TOLERANCE_LINE_THICKNESS

Specifies the maximum difference in stroke thickness of two lines or curves before it is viewed as a difference. The default value is: 1 pt (1 pt is approximately 0.353mm).

Declaration
public const string TOLERANCE_LINE_THICKNESS = "TOLERANCE_LINE_THICKNESS"
Field Value
Type Description
System.String

TOLERANCE_PAGE_LEFTCORNER

Specifies the maximum number of pixels that the left or top margin of a page can differ (is the upper left corner of all elements) before it is viewed as a difference. The default value is: 3.

Declaration
public const string TOLERANCE_PAGE_LEFTCORNER = "TOLERANCE_PAGE_LEFTCORNER"
Field Value
Type Description
System.String

TOLERANCE_PAGE_RATIO

Specifies the tolerance for the aspect ratio of the PDF page. The default value is: 0.01.

Declaration
public const string TOLERANCE_PAGE_RATIO = "TOLERANCE_PAGE_RATIO"
Field Value
Type Description
System.String

TOLERANCE_PAGE_SIZE

Specifies the maximum number of pixels that the width or height of a page can differ before it is viewed as a difference. The default value is: 2.

Declaration
public const string TOLERANCE_PAGE_SIZE = "TOLERANCE_PAGE_SIZE"
Field Value
Type Description
System.String

TOLERANCE_TEXT_LOCATION

Specifies the maximum allowed location jitter for matched text elements in pixels. Note, that the value is fractional just like the text coordinates in PDF documents. Any negative value will cause PDFC to ignore the text locations. Default is -1 which is disabled

PLEASE NOTE: This property is meant to confirm identity, it may cause artifact in case of a modified text flow!

Declaration
public const string TOLERANCE_TEXT_LOCATION = "TOLERANCE_TEXT_LOCATION"
Field Value
Type Description
System.String

TOLERANCE_TEXT_SIZE

Defines the maximum relative font size difference for text. The default value is: 0.05 which is 5%

Declaration
public const string TOLERANCE_TEXT_SIZE = "TOLERANCE_TEXT_SIZE"
Field Value
Type Description
System.String

TOLERANCE_UNDERLINE_LENGTH

Specifies the maximum difference in percent, in which the length of underlines may differ before it is viewed as a difference. The default value is: 0.1.

Declaration
public const string TOLERANCE_UNDERLINE_LENGTH = "TOLERANCE_UNDERLINE_LENGTH"
Field Value
Type Description
System.String

USE_PIXEL_MEDIUM_VALUE

Specifies whether i-net PDFC should compare images using the average pixel values instead of single pixel values. The medium value is calculated as a mean value on 9 pixel around the given pixel. The default value is: true.

Declaration
public const string USE_PIXEL_MEDIUM_VALUE = "USE_PIXEL_MEDIUM_VALUE"
Field Value
Type Description
System.String

See Also