PdfRunningTitleDeclarativeContent Class

File
wijmo.pdf.js
Module
wijmo.pdf

Represents the declarative content of the running title.

Constructor

Properties

Methods

Constructor

constructor

constructor(text?: string, font?: PdfFont, brushOrColor?: any): PdfRunningTitleDeclarativeContent

Initializes a new instance of the PdfRunningTitleDeclarativeContent class.

Parameters
Returns
PdfRunningTitleDeclarativeContent

Properties

brush

Gets or sets the brush used to fill the text.

Type
PdfBrush

font

Gets or sets the font of the text.

Type
PdfFont

text

Gets or sets the text of the running title.

May contain up to 3 tabular characters ('\t') which are used for separating the text into the parts that will be aligned within the page area using left, center and right alignment. Two kinds of macros are supported, '&[Page]' and '&[Pages]'. The former one designates the current page index while the latter one designates the page count.

For example, for the first page of a document having ten pages, the following string:

'&[Page]\\&[Pages]\theader\t&[Page]\\&[Pages]'

will be translated to:

'1\10 header 1\10'
Type
string

Methods

clone

clone(): PdfRunningTitleDeclarativeContent

Creates a copy of this PdfRunningTitleDeclarativeContent.

Returns
PdfRunningTitleDeclarativeContent

equals

equals(value: PdfRunningTitleDeclarativeContent): boolean

Determines whether the specified PdfRunningTitleDeclarativeContent instance is equal to the current one.

Parameters
Returns
boolean