Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.addon.comparison.CompareResultInfo Class Reference

Inherits SystemIDisposable.

Public Types

enum  CompareResultType {
  CompareResultType.e_CompareResultTypeNone = -1, CompareResultType.e_CompareResultTypeDeleteText = 0, CompareResultType.e_CompareResultTypeInsertText = 1, CompareResultType.e_CompareResultTypeReplaceText = 2,
  CompareResultType.e_CompareResultTypeDeleteImage = 6, CompareResultType.e_CompareResultTypeInsertImage = 7, CompareResultType.e_CompareResultTypeReplaceImage = 8, CompareResultType.e_CompareResultTypeDeletePath = 9,
  CompareResultType.e_CompareResultTypeInsertPath = 10, CompareResultType.e_CompareResultTypeReplacePath = 11, CompareResultType.e_CompareResultTypeDeleteShading = 12, CompareResultType.e_CompareResultTypeInsertShading = 13,
  CompareResultType.e_CompareResultTypeReplaceShading = 14, CompareResultType.e_CompareResultTypeDeleteAnnot = 15, CompareResultType.e_CompareResultTypeInsertAnnot = 16, CompareResultType.e_CompareResultTypeReplaceAnnot = 17,
  CompareResultType.e_CompareResultTypeTextAttriChange = 18
}
 Enumeration for compare result type. More...
 

Public Member Functions

 CompareResultInfo (CompareResultInfo.CompareResultType type, RectFArray rect_array, string diff_contents)
 Constructor, with parameters. More...
 
 CompareResultInfo ()
 Constructor.
 
 CompareResultInfo (CompareResultInfo result_info)
 Constructor, with another result information object. More...
 

Properties

string diff_contents [get, set]
 Different contents as compared result.
 
RectFArray rect_array [get, set]
 Rectangle array which specifies the location of parameter diff_contents in the PDF page to be compared.
 
CompareResultInfo.CompareResultType type [get, set]
 Result type. Please refer to values starting from foxit.addon.comparison.CompareResultInfo.CompareResultType.e_CompareResultTypeNone and this should be one of these values.
 

Detailed Description

This class represents the compare result information.

Member Enumeration Documentation

Enumeration for compare result type.

Values of this enumeration can be used alone.

Enumerator
e_CompareResultTypeNone 

Result type: unsupported or invalid.

e_CompareResultTypeDeleteText 

Result type: delete text.

e_CompareResultTypeInsertText 

Result type: insert text.

e_CompareResultTypeReplaceText 

Result type: replace text.

e_CompareResultTypeDeleteImage 

Result type: delete image.

e_CompareResultTypeInsertImage 

Result type: insert image.

e_CompareResultTypeReplaceImage 

Result type: replace image.

e_CompareResultTypeDeletePath 

Result type: delete path.

e_CompareResultTypeInsertPath 

Result type: insert path.

e_CompareResultTypeReplacePath 

Result type: replace path.

e_CompareResultTypeDeleteShading 

Result type: delete shading.

e_CompareResultTypeInsertShading 

Result type: insert shading.

e_CompareResultTypeReplaceShading 

Result type: replace shading.

e_CompareResultTypeDeleteAnnot 

Result type: delete annotation.

e_CompareResultTypeInsertAnnot 

Result type: insert annotation.

e_CompareResultTypeReplaceAnnot 

Result type: replace annotation.

e_CompareResultTypeTextAttriChange 

(Reserved, not supported yet) Result type: text attribute change.

Constructor & Destructor Documentation

foxit.addon.comparison.CompareResultInfo.CompareResultInfo ( CompareResultInfo.CompareResultType  type,
RectFArray  rect_array,
string  diff_contents 
)
inline

Constructor, with parameters.

Parameters
[in]typeResult type. Please refer to values starting from foxit.addon.comparison.CompareResultInfo.CompareResultType.e_CompareResultTypeNone and this should be one of these values.
[in]rect_arrayRectangle array which specifies the location of parameter diff_contents in the PDF page to be compared.
[in]diff_contentsDifferent contents as compared result.
foxit.addon.comparison.CompareResultInfo.CompareResultInfo ( CompareResultInfo  result_info)
inline

Constructor, with another result information object.

Parameters
[in]result_infoAnother result information object.