Back to Devexpress

CreateAreaEventArgs Class

corelibraries-devexpress-dot-xtraprinting-e8d2f7ef.md

latest5.8 KB
Original Source

CreateAreaEventArgs Class

Provides data for all area creation events.

Namespace : DevExpress.XtraPrinting

Assembly : DevExpress.Printing.v25.2.Core.dll

NuGet Package : DevExpress.Printing.Core

Declaration

csharp
public class CreateAreaEventArgs :
    EventArgs
vb
Public Class CreateAreaEventArgs
    Inherits EventArgs

CreateAreaEventArgs is the data class for the following events:

Show 14 events

Remarks

An area creation event occurs on document creation. The CreateAreaEventArgs.Graph property provides a BrickGraphics class instance. Property values of the BrickGraphics object returned by this property define the default values for properties of different brick types - determining the appearance of a specific brick. These properties include: TextBrick.Font, VisualBrick.BorderColor, BrickGraphics.BorderWidth, VisualBrick.BackColor, etc. If a user sets these properties to a specific value, the default values are overridden.

Example

The following example demonstrates how to write a LinkBase.CreateMarginalHeaderArea event handler. The handler will not work unless you write a LinkBase.CreateDetailArea event handler.

csharp
using System.Drawing;
using DevExpress.XtraPrinting;
// ...

private void link1_CreateMarginalHeaderArea(object sender, CreateAreaEventArgs e) {
    string format = "Page {0} of {1}";
    e.Graph.Font = e.Graph.DefaultFont;
    e.Graph.BackColor = Color.Transparent;

    RectangleF r = new RectangleF(0, 0, 0, e.Graph.Font.Height);

    PageInfoBrick brick = e.Graph.DrawPageInfo(PageInfo.NumberOfTotal, format, 
        Color.Black, r, BorderSide.None);
    brick.Alignment = BrickAlignment.Far;
    brick.AutoWidth = true;

    brick = e.Graph.DrawPageInfo(PageInfo.DateTime, "", Color.Black, r, BorderSide.None);
    brick.Alignment = BrickAlignment.Near;
    brick.AutoWidth = true;
}
vb
Imports System.Drawing
Imports DevExpress.XtraPrinting
' ...

Private Sub Link1_CreateMarginalHeaderArea(ByVal sender As Object, ByVal e As _
CreateAreaEventArgs) Handles Link1.CreateMarginalHeaderArea

    Dim Format As String = "Page {0} of {1}"
    e.Graph.Font = e.Graph.DefaultFont
    e.Graph.BackColor = Color.Transparent

    Dim r As New RectangleF(0, 0, 0, e.Graph.Font.Height)

    Dim Brick As PageInfoBrick = e.Graph.DrawPageInfo(PageInfo.NumberOfTotal, Format, _
        Color.Black, r, BorderSide.None)
    Brick.Alignment = BrickAlignment.Far
    Brick.AutoWidth = True

    Brick = e.Graph.DrawPageInfo(PageInfo.DateTime, "", Color.Black, r, BorderSide.None)
    Brick.Alignment = BrickAlignment.Near
    Brick.AutoWidth = True
End Sub

Inheritance

Object EventArgs CreateAreaEventArgs

See Also

CreateAreaEventArgs Members

Document Creation Approaches

DevExpress.XtraPrinting Namespace