DS Server

HyphenateWordEventArgs Object

Object|Introduced in 28.0

Description

The event argument for a word-hyphenation related event.

Syntax

{
   word: <string>,
   maxDividePos: <Number>,
   dividePos: <Number>
}

Examples

The following example demonstrates HyphenateWordEventArgs in a practical document-editing workflow. The event argument for a word-hyphenation related event.

function handleHyphenateWord(args) {
    console.log("word:", args.word);
    console.log("max divide pos:", args.maxDividePos);
    console.log("divide pos:", args.dividePos);
}

Members

Properties

PropertyDescription
dividePosThe position at which the word should be divided.
maxDividePosThe maximum dividing position.
wordThe word to hyphenate.