[]
DEMOS DOCS API
DOWNLOAD NEED HELP? BOOK DEMO
(Showing Draft Content)

PdfFormatItemEventArgs Class

PdfFormatItemEventArgs Class

Represents arguments of the IFlexGridDrawSettings.formatItem callback.

Heirarchy

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the PdfFormatItemEventArgs class.

    Parameters

    • p: any

      GridPanel that contains the range.

    • rng: any

      Range of cells affected by the event.

    • cell: HTMLElement

      Element that represents the grid cell to be rendered.

    • canvas: PdfPageArea

      Canvas to perform the custom painting on.

    • clientRect: Rect

      Object that represents the client rectangle of the grid cell to be rendered in canvas coordinates.

    • contentRect: Rect

      Object that represents the content rectangle of the grid cell to be rendered in canvas coordinates.

    • style: ICellStyle

      Object that represents the style of the grid cell to be rendered.

    • getFormattedCell: Object

      Callback function that should return the grid cell when the getFormattedCell method is called.

    • getTextRect: Object

      Callback function that should return the text rectangle of the grid cell to be rendered in canvas coordinates.

    Returns PdfFormatItemEventArgs

Properties

cancel

cancel: boolean

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

cancelBorders

cancelBorders: boolean

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

canvas

canvas: PdfPageArea

Gets the canvas to perform the custom painting on.

cell

cell: HTMLElement

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.

clientRect

clientRect: Rect

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

col

col: number

Gets the column affected by this event.

contentRect

contentRect: Rect

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

data

data: any

Gets or sets the data associated with the event.

panel

panel: GridPanel

Gets the GridPanel affected by this event.

range

range: CellRange

Gets the CellRange affected by this event.

row

row: number

Gets the row affected by this event.

style

style: ICellStyle

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.

tagContent

tagContent: IPdfTagContent | IPdfTag

Gets or sets a reference to a marked structure content of the cell.

If user produces Tagged PDF and draws the cell content manually, then he can mark the cell content and return a reference to the structure content via this property. The returned item will be incorporated into the document's structure tree.

For example:

args.tagContent = args.canvas.beginTagContent(wijmo.pdf.PdfTagType.P);
args.canvas.drawText('Some text', x, y);
args.canvas.endTagContent();

textTop

textTop: number

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

Static empty

empty: EventArgs

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

Methods

drawBackground

  • Draws the background of the cell with the specified brush or color, or, if it is not specified, with the value of the {@link style.backgroundColor} property.

    Parameters

    • Optional brush: PdfBrush | Color | string

      The brush or color to use.

    Returns void

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