Class LayoutSupportHelper

A printing utility that allows the user to view the watermark page layout on the grid according to the pages that divide the grid for printing.

Inheritance
System.Object
GridPrintDocument
LayoutSupportHelper
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.GridHelperClasses
Assembly: Syncfusion.GridHelperClasses.Windows.dll
Syntax
public class LayoutSupportHelper : GridPrintDocument, IDisposable

Constructors

LayoutSupportHelper(GridControlBase)

Initializes a new instance of the LayoutSupportHelper class.

Declaration
public LayoutSupportHelper(GridControlBase grid)
Parameters
Type Name Description
GridControlBase grid

The GridControlBase whose display is being overlaid.

Properties

LineColor

Gets or sets the color of the overlaid lines.

Declaration
public Color LineColor { get; set; }
Property Value
Type
System.Drawing.Color

LineWidth

Gets or sets the width of the overlaid lines.

Declaration
public int LineWidth { get; set; }
Property Value
Type
System.Int32

PageBreakCols

Gets or sets the list of page break column numbers.

Declaration
public List<int> PageBreakCols { get; set; }
Property Value
Type
System.Collections.Generic.List<System.Int32>

PageBreakRows

Gets or sets the list of page break row numbers.

Declaration
public List<int> PageBreakRows { get; set; }
Property Value
Type
System.Collections.Generic.List<System.Int32>

PageFlow

Gets or sets whether the page numbers are counted horizontally or vertically.

Declaration
public PageFlowDirection PageFlow { get; set; }
Property Value
Type
PageFlowDirection

PageTextFormat

Gets or sets the content of the displayed text string.

Declaration
public string PageTextFormat { get; set; }
Property Value
Type
System.String
Remarks

This string is used as a format in string.Format(PageTextFormat, pageNumber) to provide the string that is overlaid on each page. The default value is "page {0}".

ShowLayoutLines

Gets or sets a value indicating whether print page layout borders are displayed.

Declaration
public bool ShowLayoutLines { get; set; }
Property Value
Type
System.Boolean

TextColor

Gets or sets the color of the overlaid text.

Declaration
public Color TextColor { get; set; }
Property Value
Type
System.Drawing.Color

Methods

OnDrawPageNumber(DrawPageNumberEventArgs)

Raises the DrawPageNumber event.

Declaration
protected virtual void OnDrawPageNumber(DrawPageNumberEventArgs e)
Parameters
Type Name Description
DrawPageNumberEventArgs e

The DrawPageNumberEventArgs that contains the event data.

Events

DrawPageNumber

An event to draw page number in grid.

Declaration
public event DrawPageNumberEventHandler DrawPageNumber
Event Type
Type
DrawPageNumberEventHandler

Explicit Interface Implementations

IDisposable.Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
void IDisposable.Dispose()

Implements

System.IDisposable