PageInfoDataProviderBase.GetText(PrintingSystemBase, PageInfoTextBrickBase) Method

Enables you to obtain and customize the text of the Page Info control.

Namespace: DevExpress.XtraPrinting

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public abstract string GetText(
    PrintingSystemBase ps,
    PageInfoTextBrickBase brick
)

VB.NET

Public MustOverride Function GetText(
    ps As PrintingSystemBase,
    brick As PageInfoTextBrickBase
) As String

Parameters

Name	Type	Description
ps	PrintingSystemBase	A PrintingSystemBase object.
brick	PageInfoTextBrickBase	A PageInfoTextBrickBase descendant.

Returns

Type	Description
String	A String value.

Remarks

In the following example, all PageInfo bricks are processed using the PageInfoDataProviderBase class. The GetText method returns information about the current HttpContext user.

C#

using System.Web;
using DevExpress.XtraPrinting;

class CustomPageInfoDataProvider : PageInfoDataProviderBase
{
    readonly HttpContext httpContext;
    public CustomPageInfoDataProvider(HttpContext httpContext)
    {
        this.httpContext = httpContext;
    }

    public override string GetText(PrintingSystemBase ps, PageInfoTextBrickBase brick)
    {
        if (brick.PageInfo != PageInfo.UserName)
        {
            return null;
        }
        if (httpContext == null)
            return "<No Information>";
        var user = httpContext.User;
        if (user == null || user.Identity == null)
            return "<Please enable Forms or Windows security>";
        var identity = user.Identity;
        return identity.IsAuthenticated
            ? identity.Name
            : "<Guest>";
    }
}

VB.NET

Imports DevExpress.XtraPrinting

Friend Class CustomPageInfoDataProvider
    Inherits PageInfoDataProviderBase

    Private ReadOnly httpContext As HttpContext
    Public Sub New(ByVal httpContext As HttpContext)
        Me.httpContext = httpContext
    End Sub

    Public Overrides Function GetText(ByVal ps As PrintingSystemBase,
                                      ByVal brick As PageInfoTextBrickBase) As String
        If brick.PageInfo <> PageInfo.UserName Then
            Return Nothing
        End If
        If httpContext Is Nothing Then
            Return "<No Information>"
        End If
        Dim user = httpContext.User
        If user Is Nothing OrElse user.Identity Is Nothing Then
            Return "<Please enable Forms or Windows security>"
        End If
        Dim identity = user.Identity
        Return If(identity.IsAuthenticated, identity.Name, "<Guest>")
    End Function
End Class

View Example: How to Display the Name of the Current Logged in User in a Report