PDFTron WebViewer

Namespace: ContentEdit

Core. ContentEdit

The namespace for APIs dealing with document content editing

Extends

Members

<static> Events

Properties:
Name Type Description
TEXT_CONTENT_UPDATED string Core.ContentEdit.textContentUpdated
SEARCH_AND_REPLACE_STARTED string Core.ContentEdit.searchAndReplaceStarted
SEARCH_AND_REPLACE_TEXT_REPLACED string Core.ContentEdit.searchAndReplaceTextReplaced
SEARCH_AND_REPLACE_TEXT_FOUND string Core.ContentEdit.searchAndReplaceTextFound
SEARCH_AND_REPLACE_ENDED string Core.ContentEdit.searchAndReplaceEnded

<static> Types

Content Edit types.
Properties:
Name Type Description
TEXT string Text type content.
OBJECT string Object type content.

Methods

<static> addNewParagraph(options, content)

Add a new content box
Parameters:
Name Type Description
options object
Properties
Name Type Description
pageNumber number The page number that the content is on
position string The new position of content box, in PDF coordinates
content string The content to add to the content box
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> alignContents(contentEditPlaceholderAnnotation, alignment)

Align text content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.Annotation The annotation that represents the content where the text alignment should be set
alignment string The text alignment to set
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> getContentEditingFonts()

Get a list of fonts available for content editing
Returns:
Resolves after the content has been updated, returns list of fonts
Type
Promise.<Array.<string>>

<static> getDocumentContent(contentEditPlaceholderAnnotation)

Gets the content box data for the passed in annotation. The passed in annotation must be a content edit placeholder annotation.
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.RectangleAnnotation
Returns:
content The document content associated with this content edit placeholder annotation
Type
Promise.<string>
Example
const content = await instance.Core.ContentEdit.getDocumentContent(contentEditPlaceholderAnnotation);

<static> preloadWorker(documentViewer)

Preloads the content editing worker. If this function isn't called then the worker will be loaded when the content editing tool is enabled.
Parameters:
Name Type Description
documentViewer Core.DocumentViewer The DocumentViewer to use as context for the page editing
Returns:
Resolves after the worker has been loaded
Type
Promise.<void>

<static> searchAndReplaceText(options)

A function that will search and replace text inside the document.
Parameters:
Name Type Description
options object
Properties
Name Type Argument Description
toReplace string | RegExp A string or global RegExp object that will be replaced on the page.
replaceWith string The string that replaces the string or RegExp provided in the first parameter.
documentViewer Core.DocumentViewer DocumentViewer instance.
caseSensitive boolean <optional>
 Is case sensitive search.
wholeWord boolean <optional>
 Is serching the whole word.
wildcard boolean <optional>
 Is searching with wildcard word.
regex boolean <optional>
 Is searching with regular expression.
isSingleSearchReplace boolean <optional>
 Is it single search and replace or whole document.
Returns:
Returns promise which will resolve when the operation completes.
Type
Promise.<void>
Example
instance.Core.ContentEdit.searchAndReplaceText({
   toReplace: 'PDF',
   replaceWith: 'DOCX',
   documentViewer: instance.Core.documentViewer
});

<static> setContentFont(contentEditPlaceholderAnnotation, font)

Set font of text content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.Annotation The annotation that represents the content where the font should be set
font string The font to set
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> setContentFontSize(contentEditPlaceholderAnnotation, size)

Set font size of text content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.Annotation The annotation that represents the content where font size should be set
size string The font size to set
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> setTextColor(contentEditPlaceholderAnnotation, color)

Set font color of text content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.Annotation The annotation that represents the content where the text color should be set
color String The color of the text to set
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> toggleBoldContents(contentEditPlaceholderAnnotation)

Bold or unbold text content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.Annotation The annotation that represents the content where bold should be toggled
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> toggleItalicContents(contentEditPlaceholderAnnotation)

Italicize or unitalicize text content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.Annotation The annotation that represents the content where italics should be toggled
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> toggleUnderlineContents(contentEditPlaceholderAnnotation)

Underline or de-underline text content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.Annotation The annotation that represents the content where underline should be toggled
Returns:
Resolves after the content has been updated
Type
Promise.<void>

<static> updateDocumentContent(contentEditPlaceholderAnnotation, content)

Update the document with new content
Parameters:
Name Type Description
contentEditPlaceholderAnnotation Core.Annotations.RectangleAnnotation
content string The new content
Returns:
Resolves after the content has been updated
Type
Promise.<void>
Example
instance.Core.ContentEdit.updateDocumentContent(contentEditPlaceholderAnnotation, 'New content');

addEventListener(type, fn [, options])

Add a handler to the given event name
Parameters:
Name Type Argument Description
type string | number The name of the event to listen to
fn function The handler to be called when the event is triggered
options object <optional>
 Optional options object for addEventListener
Properties
Name Type Description
once boolean If true then the handler will be called only once
Returns:
Returns the object that 'addEventListener' is being called on
Type
object
Example
Core.ContentEdit.addEventListener('textContentUpdated', (originalText, updatedText, boundingBoxCoordinates) => {
  ...
});

removeEventListener( [type] [, fn])

Remove a handler of the given event name
Parameters:
Name Type Argument Description
type string | number <optional>
 The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed
fn function <optional>
 The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed
Returns:
Returns the object that 'removeEventListener' is being called on
Type
object
Example
Core.ContentEdit.removeEventListener();
Core.ContentEdit.removeEventListener('textContentUpdated');
Core.ContentEdit.removeEventListener('textContentUpdated', fn);

trigger(type [, data])

Calls the handlers of the event name with given data
Parameters:
Name Type Argument Description
type string | number event name of which the handlers will be called.
data * <optional>
 data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers
Returns:
Returns the object that 'trigger' is being called on
Type
object
Example
Core.ContentEdit.trigger('textContentUpdated', originalText, updatedText, boundingBoxCoordinates);

Events

editBoxesAvailable

Triggered any time edit boxes are drawn on the page.
Parameters:
Name Type Description
boxes object An array of Content Edit boxes.

textContentUpdated

Triggered when text content of the page is updated.
Parameters:
Name Type Description
originalText string The original text of the selected bounding box.
updatedText string The updated text of the selected bounding box.
boundingBoxCoordinates object The coordinates (top, left, bottom, right) of the bounding box.