PdfFormatItemEventArgs Class

File
wijmo.grid.pdf.js
Module
wijmo.grid.pdf
Base Class
CellRangeEventArgs
Show
   

Represents arguments of the IFlexGridDrawSettings.formatItem callback.

Constructor

Properties

Methods

Constructor

constructor

constructor(p: GridPanel, rng: CellRange, cell: HTMLElement, canvas: PdfPageArea, clientRect: Rect, contentRect: Rect, textTop: number, style: ICellStyle, getFormattedCell?: Function): PdfFormatItemEventArgs

Initializes a new instance of the PdfFormatItemEventArgs class.

Parameters
Returns
PdfFormatItemEventArgs

Properties

cancel

Gets or sets a value that indicates whether the event should be canceled.

Inherited From
CancelEventArgs
Type
boolean

cancelBorders

Gets or sets a value that indicates that default cell borders drawing should be canceled.

Type
boolean

canvas

Gets the canvas to perform the custom painting on.

Type
PdfPageArea

cell

Gets a reference to the element that represents the grid cell being rendered. If IFlexGridDrawSettings.customCellContent is set to true then contains reference to the element that represents the formatted grid cell; otherwise, a null value.

Type
HTMLElement

clientRect

Gets the client rectangle of the cell being rendered in canvas coordinates.

Type
Rect

col

Gets the column affected by this event.

Inherited From
CellRangeEventArgs
Type
number

contentRect

Gets the content rectangle of the cell being rendered in canvas coordinates.

Type
Rect

data

Gets or sets the data associated with the event.

Inherited From
CellRangeEventArgs
Type
any

Static empty

Provides a value to use with events that do not have event data.

Inherited From
EventArgs
Type
EventArgs

panel

Gets the GridPanel affected by this event.

Inherited From
CellRangeEventArgs
Type
GridPanel

range

Gets the CellRange affected by this event.

Inherited From
CellRangeEventArgs
Type
CellRange

row

Gets the row affected by this event.

Inherited From
CellRangeEventArgs
Type
number

style

Gets an object that represents the style of the cell being rendered. If IFlexGridDrawSettings.customCellContent is set to true then the style is inferred from the cell style; othwerwise it contains a combination of the IFlexGridDrawSettings.styles export setting, according to the row type of exported cell.

Type
ICellStyle

textTop

Gets the value that represents the top position of the text of the cell being rendered in canvas coordinates.

Type
number

Methods

getFormattedCell

getFormattedCell(): HTMLElement

Returns a reference to the element that represents the grid cell being rendered. This method is useful when export of custom formatting is disabled, but you need to export custom content for certain cells.

Returns
HTMLElement