v5.20192.624
|

IPdfTextMeasurementSettings Interface

Represents the settings used by PdfPageArea.measureText method.

Hierarchy

Properties

Optional align

Determines how text is aligned within the drawing area. The default value is Left.

Optional characterSpacing

characterSpacing: number

Determines the spacing between text characters. The default value is 0.

Optional columnGap

columnGap: number

Determines the spacing between each column, in points. The default value is 18.

Optional columns

columns: number

Determines the number of columns to flow the text into. The default value is 1.

Optional continued

continued: boolean

Indicates whether subsequent text should be continued right after that or it will be a new paragraph. If true, the text settings will be retained between drawText calls. It means that options argument will be merged with the one taken from the previous drawText call.

The default value is false.

Optional ellipsis

ellipsis: any

Determines the character to display at the end of the text when it exceeds the given area.The default value is undefined, that is, ellipsis is not displayed. Set to true to use the default character.

Optional fill

fill: boolean

Indicates whether the text should be filled or not. The default value is true.

Optional height

height: number

Determines the height of the drawing area in points to which the text should be clipped. The default value is undefined which means that the text area will be limited by bottom edge of the body section. Use Infinity to indicate that the text area has an infinite height.

Optional includeLastLineExternalLeading

includeLastLineExternalLeading: boolean

Determines whether the last line external leading value should be included into the measurements result. The default value is true.

Optional indent

indent: number

Determines the value of indentaion in each paragraph of text, in points. The default value is 0.

Optional lineBreak

lineBreak: boolean

Indicates whether line wrapping should be used or not. The property is ignored if IPdfTextSettings.width is defined. The default value is true.

Optional lineGap

lineGap: number

Determines the spacing between lines of text. The default value is 0.

Optional link

link: string

Determines a URL used to create a link annotation (URI action).

Optional paragraphGap

paragraphGap: number

Determines the spacing between paragraphs of text. The default value is 0.

Optional strike

strike: boolean

Indicates whether the text should be striked out or not. The default value is false.

Optional stroke

stroke: boolean

Indicates whether the text should be stroked or not. The default value is false.

Optional underline

underline: boolean

Indicates whether the text should be underlined or not. The default value is false.

Optional width

width: number

Determines the width of the text area in points to which the text should wrap. The default value is undefined which means that the text area will be limited by right margin of the page. Use Infinity to indicate that the text area has an infinite width. If defined, forces the IPdfTextSettings.lineBreak property to be enabled.

Optional wordSpacing

wordSpacing: number

Determines the spacing between words in the text. The default value is 0.