What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Configuration Settings
Deprecation Schedule

PdfParagraph()

A PdfParagraph is an object defining a block of text and the associated formatting within a Pdf. To make a new PdfParagraph, call 'addParagraph' on the PdfSection, PdfCell, PdfHeader or PdfFooter, you wish to add the block of text to. [NON-INSTANTIABLE]

new PdfParagraph()
IncisorAPI.js, line 9621

A PdfParagraph is an object defining a block of text and the associated formatting within a Pdf. To make a new PdfParagraph, call 'addParagraph' on the PdfSection, PdfCell, PdfHeader or PdfFooter, you wish to add the block of text to. [NON-INSTANTIABLE]

MEMBERS

bold :boolean
IncisorAPI.js, line 9713

Boolean determining if the text in this PdfParagraph should be bold.

Default Value:
  • false

fontColor :Color
IncisorAPI.js, line 9671

The color of the text in this PdfParagraph.

Default Value:
  • Color(0,0,0,1)

fontName :string
IncisorAPI.js, line 9663

The name of the font that will be used to render the text in this PdfParagraph. This value will default to the defualtFontName value of the containing Pdf. To use a new font, you must define it using "Pdf.defineFont", and also ensure that the associated font files are in the 'Pdf Fonts' directory of the Incisor® application support directory, which can be accessed from the Incisor® menu.

Default Value:
  • defaultFontName

fontSize :number
IncisorAPI.js, line 9678

The height of the pages within this PdfSection. This value will default to the defaultFontSize value of the containing Pdf.

Default Value:
  • defaultFontSize

inheritedTypes :object
IncisorAPI.js, line 9638

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

italic :boolean
IncisorAPI.js, line 9720

Boolean determining if the text in this PdfParagraph should be italicized.

Default Value:
  • false

justificationH :string
IncisorAPI.js, line 9653

The justification of the text in this PdfParagraph. For acceptable values, see 'nc.constants.justfications'.

Default Value:
  • "center"

leftIndent :number
IncisorAPI.js, line 9699

The left indentation amount of this PdfParagraph.

Default Value:
  • 0

rightIndent :number
IncisorAPI.js, line 9706

The right indentation amount of this PdfParagraph.

Default Value:
  • 0

spaceAfter :number
IncisorAPI.js, line 9685

The space size that will be added after this PdfParagraph.

Default Value:
  • 0

spaceBefore :number
IncisorAPI.js, line 9692

The space size that will be added before this PdfParagraph.

Default Value:
  • 0

text :string
IncisorAPI.js, line 9645

The text to be displayed in this PdfParagraph.

Default Value:
  • ""

type :string
IncisorAPI.js, line 9632

Type identifier.

underline :string
IncisorAPI.js, line 9728

The underline type of the text in this PdfPagraph. For acceptable values, see 'nc.constants.pdfUnderlineTypes'.

Default Value:
  • ""

METHODS

addPageField()
IncisorAPI.js, line 9732

Adds a page number to the end of this PdfParagraph.