Click or drag to resize

append Method

Append additional PDF (or other supported data) to the end of the PdfWebControl document.

Syntax
JavaScript
function append(key);

Parameters

key

Type: String

Append data key for use with a PdfIntegrationProvider which implements the ProcessAppendDataRequest method; or

a data URL (e.g. "data:application/pdf;base64,JVBE..."); or

Return Value

Type: Boolean

true if successful; otherwise, false.

Remarks

If no key is specified (or key is an empty string), the append dialog will be shown instead of doing an append using the key.

This method will return false if the append fails (or append dialog can not be shown).

The document must be fully rendered in order for this method to succeed.

If a key is specified, unsaved changes made to the current document will be saved to the server prior to it being appended. You can use the getHasUnsavedChanges Method to determine if the current document has unsaved changes.

Examples

Append a PDF file using a key:

JavaScript
var myApi = new PdfWebControlApi("PdfWebControl1"); // where "PdfWebControl1" is the ID (ClientID) assigned to the PdfWebControl instance
myApi.append("my_key");

Show the append dialog:

JavaScript
var myApi = new PdfWebControlApi("PdfWebControl1"); // where "PdfWebControl1" is the ID (ClientID) assigned to the PdfWebControl instance
myApi.append();
See Also