Class MergeXFDFOptions

Inheritance

object

OptionsBase

MergeXFDFOptions

Inherited Members

OptionsBase.mObjSet

OptionsBase.ColorPtToNumber(ColorPt)

OptionsBase.ColorPtFromNumber(double)

OptionsBase.GetArray(string)

OptionsBase.PutNumber(string, double)

OptionsBase.PutBool(string, bool)

OptionsBase.PutText(string, string)

OptionsBase.PutRect(string, Rect)

OptionsBase.PushBackNumber(string, double)

OptionsBase.PushBackBool(string, bool)

OptionsBase.PushBackText(string, string)

OptionsBase.PushBackRect(string, Rect)

OptionsBase.RectFromArray(Obj)

OptionsBase.insertRectCollection(string, RectCollection, int)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class MergeXFDFOptions : OptionsBase

Constructors

MergeXFDFOptions()

Constructor.

Declaration

public MergeXFDFOptions()

Methods

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.

Declaration

public bool GetForce()

Returns

Type

Description

bool

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.

GetUseNonStandardRotation()

Gets the value UseNonStandardRotation from the options object. Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.

Declaration

public bool GetUseNonStandardRotation()

Returns

Type	Description
bool	Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.

SetForce(bool)

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.

Declaration

public MergeXFDFOptions SetForce(bool value)

Parameters

Type	Name	Description
bool	value	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

Type	Description
MergeXFDFOptions	This object, for call chaining.

SetUseNonStandardRotation(bool)

Sets the value for UseNonStandardRotation in the options object. Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.

Declaration

public MergeXFDFOptions SetUseNonStandardRotation(bool value)

Parameters

Type	Name	Description
bool	value	Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.

Returns

Type	Description
MergeXFDFOptions	This object, for call chaining.