Skip to main content

FormFieldNameConflict Class

Contains information about a form field name conflict that the API resolved during a PDF append operation.

Declaration

public class FormFieldNameConflict extends JavaObject

Remarks

Use AppendDocumentResult.getResolvedFieldNameConflicts() method to access form field name conflicts that the API resolved during the append/merge operation.

getTargetField() and getRenamedField() methods identify the target field and the source field with the new name respectively.

// Open a document to append.
try (PdfDocument source = new PdfDocument(
        FileChannel.open(Path.of("Source.pdf")))) {

    // Append the document to the current document.
    AppendDocumentResult result = pdfDocument.appendDocument(source);

    // Check for resolved form field name conflicts.
    for (FormFieldNameConflict conflict : result.getResolvedFieldNameConflicts()) {
        System.out.println("Target field: " + conflict.getTargetField());
        System.out.println("Renamed source field: " + conflict.getRenamedField());
    }
}

Refer to the following help topic for additional information: Merge PDF Documents.

Inherited Members

com.devexpress.system.JavaObject.clone()
com.devexpress.system.JavaObject.equals(java.lang.Object)
com.devexpress.system.JavaObject.hashCode()
com.devexpress.system.JavaObject.initFields()
com.devexpress.system.JavaObject.memberwiseClone()
com.devexpress.system.JavaObject.toString()
java.lang.Object.finalize()
java.lang.Object.getClass()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long,int)

Inheritance

Object
com.devexpress.system.JavaObject
FormFieldNameConflict

Methods

getRenamedField() Method

Returns the source form field with the new name.

Declaration

public FormField getRenamedField()

Returns

Type Description
FormField

The source form field with the new name.

getTargetField() Method

Returns the target form field in the name conflict.

Declaration

public FormField getTargetField()

Returns

Type Description
FormField

The target form field in the name conflict.