All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::PDF::MergeXFDFOptions Class Reference

#include <MergeXFDFOptions.h>

Public Member Functions

 MergeXFDFOptions ()
 
 ~MergeXFDFOptions ()
 
bool GetForce ()
 
MergeXFDFOptionsSetForce (bool value)
 

Detailed Description

Definition at line 9 of file MergeXFDFOptions.h.

Constructor & Destructor Documentation

pdftron::PDF::MergeXFDFOptions::MergeXFDFOptions ( )
pdftron::PDF::MergeXFDFOptions::~MergeXFDFOptions ( )

Member Function Documentation

bool pdftron::PDF::MergeXFDFOptions::GetForce ( )

Gets the value Force from the options object If true, merge will be performed even if the conditions below are true. If false, the MergeXFDF operation will be aborted with exception if one of these conditions is true: 1)xfdf contains annotations with no 'name' attribute 2)annotations in pdf or xfdf have names that are not unique, i.e. multiple annotations in the same document have the same name. In order for the merge operation to work correctly, all the annotations in xfdf need to have a unique 'name' attribute. If pdf document has unnamed annotatations (no 'NM' attribute), xfdf files generated using Apryse SDK will still have names that will allow the MergeXFDF algorithm to work.

Returns
a bool, the current value for Force.
MergeXFDFOptions& pdftron::PDF::MergeXFDFOptions::SetForce ( bool  value)

Sets the value for Force in the options object If true, merge will be performed even if the conditions below are true. If false, the MergeXFDF operation will be aborted with exception if one of these conditions is true: 1)xfdf contains annotations with no 'name' attribute 2)annotations in pdf or xfdf have names that are not unique, i.e. multiple annotations in the same document have the same name. In order for the merge operation to work correctly, all the annotations in xfdf need to have a unique 'name' attribute. If pdf document has unnamed annotatations (no 'NM' attribute), xfdf files generated using Apryse SDK will still have names that will allow the MergeXFDF algorithm to work.

Parameters
value,:the new value for Force
Returns
this object, for call chaining

The documentation for this class was generated from the following file: