DS Server

FrameInfo Object

Object|Introduced in 28.0

Description

Information about a frame.

Syntax

{
   id: <Number>,
   location: <Point>,
   name: <String>,
   textPosition: <Number>
}

Examples

The following example demonstrates FrameInfo in a practical document-editing workflow. Information about a frame.

function inspectFrameInfo(frameInfo) {
    console.log("id:", frameInfo.id);
    console.log("location:", frameInfo.location);
    console.log("name:", frameInfo.name);
    console.log("text position:", frameInfo.textPosition);
}

Members

Properties

PropertyDescription
idThe frame's identifier.
locationThe frame's location in twips.
nameThe frame's name.
textPositionThe frame's character position in the document's text (one-based).