DS Server

FrameBase Object

Object|Introduced in 28.0

Description

The FrameBase object is the base of the Image, TextFrame and BarcodeFrame object. It implements general frame features like the position in the text, the insertion mode or the distances between the text and the frame.

Syntax

FrameBase

Examples

The following example demonstrates FrameBase in a practical document-editing workflow. The FrameBase object is the base of the Image, TextFrame and BarcodeFrame object. It implements general frame features like the position in the text, the insertion mode or the distances between the text and the frame.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

function inspectFrameBase(frameBase) {
    frameBase.getID(
        function(result) {
            console.log("get id result:", result);
        },
        onTxError
    );
}

Members

Methods

Method	Description
changeZOrder	Changes the frame's z-order.
getAlignment	Gets the frame's horizontal alignment when it is anchored to a paragraph.
getBounds	Gets the frame's bounding rectangle relative to the upper left corner of the document.
getDescriptiveText	Gets the descriptive text for the frame. An empty string indicates that the frame has no such text.
getID	Gets an identifier for the frame. A value of zero indicates that the image, text frame, chart, barcode or drawing has no identifier.
getInsertionMode	Gets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. If the document's text flows around or overwrites the frame, this property also determines whether the image, text frame, chart, barcode or drawing is moved with the text or fixed positioned on a page.
getLocation	Gets, in twips, the frame's current location. If the image, text frame, chart, barcode or drawing is anchored to a paragraph, the location is relative to the paragraph. Otherwise, it is relative to the document. If the frame has a horizontal alignment or if it is inserted inline, this property returns zero. This property cannot be set for images, text frames, charts, barcodes or drawings which are inserted inline.
getMoveable	Gets whether a frame can be moved in the document at run time with the built-in mouse interface.
getName	Gets the name for the frame. An empty string indicates that the frame has no name.
getSize	Gets the frame's size in twips.
getSizeable	Gets whether the frame can be resized at run time with the built-in mouse interface.
getTextDistances	Gets the distances, in twips, between the frame and the document's text.
getTextPosition	Gets the frame's character position in the document's text (one-based).
setAlignment	Sets the frame's horizontal alignment when it is anchored to a paragraph.
setDescriptiveText	Sets a descriptive text for the frame. An empty string or null can be used to delete a previously set text.
setID	Sets an identifier for the frame. It must be a one-based value. A value of zero indicates that the image, text frame, chart, barcode or drawing has no identifier. Zero can also be used to delete a previously set identifier.
setInsertionMode	Sets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. If the document's text flows around or overwrites the frame, this property also determines whether the image, text frame, chart, barcode or drawing is moved with the text or fixed positioned on a page.
setLocation	Sets, in twips, the frame's current location. If the image, text frame, chart, barcode or drawing is anchored to a paragraph, the location is relative to the paragraph. Otherwise, it is relative to the document. If the frame has a horizontal alignment or if it is inserted inline, this property returns zero. This property cannot be set for images, text frames, charts, barcodes or drawings which are inserted inline.
setMoveable	Sets whether a frame can be moved in the document at run time with the built-in mouse interface.
setName	Sets a name for the frame. An empty string indicates that the frame has no name. An empty string can also be used to delete a previously set name.
setSize	Sets the frame's size in twips. For images this property is read only. To change the size of an image in a document, use the setHorizontalScaling and setVerticalScaling methods.
setSizeable	Sets whether the frame can be resized at run time with the built-in mouse interface.
setTextDistances	Sets the distances, in twips, between the frame and the document's text. If a value is set to -1, it is not changed.