MEMBERS

bottomMargin :number

IncisorAPI.js, line 10394

The size of the bottom margin of the pages within this PdfTextFrame.

Default Value:

• 0

height :number

IncisorAPI.js, line 10401

The height of this PdfTextFrame.

Default Value:

• 0

inheritedTypes :object

IncisorAPI.js, line 10366

Dictionary object listing all of the types this object is compatible with.

leftMargin :number

IncisorAPI.js, line 10373

The size of the left margin of the pages within this PdfTextFrame.

Default Value:

• 0

rightMargin :number

IncisorAPI.js, line 10380

The size of the right margin of the pages within this PdfTextFrame.

Default Value:

• 0

topMargin :number

IncisorAPI.js, line 10387

The size of the top margin of the pages within this PdfTextFrame.

Default Value:

• 0

type :string

IncisorAPI.js, line 10360

Type identifier.

width :number

IncisorAPI.js, line 10408

The width of this PdfTextFrame.

Default Value:

• 0

METHODS

addImage(imagePath, isPathRelative (opt), justificationH (opt), justificationV (opt)) returns {PdfImage}

IncisorAPI.js, line 10426

Adds a new Image to this PdfTextFrame and returns it.

Parameters:

Name	Type	Attributes	Default	Description
imagePath	string			The path of the image being added within this PdfTextFrame.
isPathRelative	boolean	<optional>		Bool stating if the given path is relative to the project path or an absolute path. If an absolute path is used that is outside of the project directory, the 'allowUniversalFileIO' item in application settings must be set to true. [DEFAULT: true]
justificationH	string	<optional>		The horizontal justification of the image being added to this PdfTextFrame. For acceptable values, see 'nc.constants.justfications'. [DEFAULT: "center"]
justificationV	string	<optional>		The vertical justification of the image being added to this PdfTextFrame. For acceptable values, see 'nc.constants.justfications'. [DEFAULT: "center"]

Returns:

PdfImage

addParagraph() returns {PdfParagraph}

IncisorAPI.js, line 10415

Adds a new PdfParagraph to this PdfTextFrame and returns it. A PdfParagraph is simply a block of text.

Returns:

PdfParagraph

addTable(numRows, numCols, columnWidths) returns {PdfTable}

IncisorAPI.js, line 10436

Adds a new PdfTable to this PdfTextFrame and returns it.

Parameters:

Name	Type	Attributes	Default	Description
numRows	number			The number of rows to add to this PdfTextFrame.
numCols	number			The number of columns to add to each PdfRow in this PdfTextFrame.
columnWidths	Array.<number> | number			An array containing the desired widths for each column in this PdfTextFrame.

Returns:

PdfTable