DS Server

HeaderFooterEventArgs Object

Object|Introduced in 28.0

Description

The event argument header and footer related events.

Syntax

{
   connectedToPrevious: <Boolean>,
   distance: <Number>,
   type: <HeaderFooterType>
}

Examples

The following example demonstrates HeaderFooterEventArgs in a practical document-editing workflow. The event argument header and footer related events.

function handleHeaderFooter(args) {
    console.log("connected to previous:", args.connectedToPrevious);
    console.log("distance:", args.distance);
    console.log("type:", args.type);
}

Members

Properties

PropertyDescription
connectedToPreviousSpecifies whether the header or footer is connected to previous section.
distanceThe distance, in twips, of a header or footer to the top or bottom of the page.
typeThe type of the header or footer.

Further Reading