Class PdfHeaderFooterElement

Represents class that provides Pdf header or footer customization options for the Pdf document.

Inheritance

System.Object

PdfHeaderFooterElement

Namespace: Syncfusion.Blazor.Grids

Assembly: Syncfusion.Blazor.dll

Syntax

public class PdfHeaderFooterElement : Object

Constructors

PdfHeaderFooterElement()

Declaration

public PdfHeaderFooterElement()

Properties

ElementStyle

Gets or sets the style of the header or footer content in the exported PDF.

Declaration

public PdfElementStyle ElementStyle { get; set; }

Property Value

Type	Description
PdfElementStyle	An instance of PdfElementStyle.

Remarks

The PdfElementStyle class represents the style that specifies the appearance of text in the header or footer content, such as font color and formatting.

Points

Gets or sets the points for the lines drawn within the header or footer in the exported Pdf.

Declaration

public PdfPoints Points { get; set; }

Property Value

Type	Description
PdfPoints	An instance of PdfPoints representing the coordinates (X1, Y1, X2, Y2) of the lines drawn within the header or footer. The coordinates are defined as follows: `X1` and `Y1` specify the starting coordinates for the line. `X2` and `Y2` specify the ending coordinates for the line.

Remarks

PdfPoints class instance specifies the precise location of the lines within the header or footer.
The lines drawn in the header, coordinates should be greater than the FromTop and Left property values and within the height and width range of the header.
For the footer, the coordinates should be greater than the FromBottom and Left property values and within the height and width range of the footer.
Lines are only drawn when ContentType is set to Line.

Position

Gets or sets the position of the content to be drawn within the header or footer in the exported Pdf.

Declaration

public PdfPosition Position { get; set; }

Property Value

Type	Description
PdfPosition	An instance of PdfPosition representing the horizontal (X) and vertical (Y) alignment of the content within the header or footer.

Remarks

PdfPosition class represents the alignment of the content within the header or footer, specifying the position relative to the header or footer.
The X and Y coordinates should be greater than the FromTop and Left property values and within the height and width range of the header.
For the footer, they should be greater than the FromBottom and Left property values and within the height and width range of the footer.

Size

Gets or sets the size of the header or footer content in the exported Pdf.

Declaration

public PdfSize Size { get; set; }

Property Value

Type	Description
PdfSize	An instance of PdfSize.

Remarks

PdfSize class represents the size that specifies the dimensions of the content within the header or footer.

Type

Gets or sets the type of the header or footer content in the exported Pdf.

Declaration

public ContentType Type { get; set; }

Property Value

Type	Description
ContentType	One of the ContentType enumeration represents the type of the header or footer content in the exported Pdf. The default content type is Syncfusion.Blazor.Grids.ContentType.Image

Remarks

The ContentType specifies the nature of the header or footer content. It can be one of the following:

ContentType.Image: The content is an image.
ContentType.Line: The content is a line.
ContentType.PageNumber: The content is a page number.
ContentType.Text: The content is text.

Value

Gets or sets the value of the header or footer content in the exported Pdf.

Declaration

public object Value { get; set; }

Property Value

Type	Description
System.Object	An object representing the value of the header or footer content.

Remarks

The value specifies the actual header or footer content to be displayed, such as text or image data.