Class

ReportPageNumberLabel

Description

The current page number in a report created with the Report Layout Editor.

Methods

Name

Parameters

Returns

Shared

Constructor

controlName As String

Events

Name

Parameters

Returns

AfterPrinting

BeforePrinting

Enumerations

ReportPageNumberLabel.VerticalAlignment

VerticalAlignment

Specifies the type of vertical alignment of the ReportPageNumberLabel.

Enum

Bottom

Center

Top

Property descriptions

ReportPageNumberLabel.Back

Back As Double

The opacity level of the border.

ReportPageNumberLabel.BackColor

BackColor As Color

The background color for the control. If the control has a HasBackgroundColor property, it must be set to True for the BackgroundColor to be displayed.

This code sets the HasBackgroundColor property and sets the value of the BackgroundColor property:

Me.HasBackgroundColor = True
Me.BackgroundColor = &c110034

ReportPageNumberLabel.Bold

Bold As Boolean

If True, applies the bold style to the control's caption and/or its text content if any.

This example sets the text to Bold.

Me.Bold = True

ReportPageNumberLabel.DataField

DataField As String

The name of the field from the data source to bind to the control.

ReportPageNumberLabel.HasBackColor

HasBackColor As Boolean

If True, the background color is set to BackColor.

ReportPageNumberLabel.Height

Height As Double

The height of the control in Units. Height is relative to the section the control is in.

ReportPageNumberLabel.Italic

Italic As Boolean

If True, applies the italic style to the control's caption and/or its text content if any.

The following sets the Italic property for the control.

Me.Italic = True

ReportPageNumberLabel.Left

Left As Double

The left side of the control in Units. Left is relative to the section the control is in.

ReportPageNumberLabel.Linespacing

Linespacing As Double

The linespacing in points between the lines of text in the label. This assumes that it is a multiline field.

ReportPageNumberLabel.Multiline

Multiline As Boolean

If True, the label can hold more than one line of text and the LineSpacing property is applicable.

ReportPageNumberLabel.Name

Name As String

The name of the object.

ReportPageNumberLabel.PenHeight

PenHeight As Integer

The height in pixels used when drawing lines, ovals, and rectangles.

ReportPageNumberLabel.PenWidth

PenWidth As Integer

The width in pixels used when drawing lines, ovals, and rectangles.

ReportPageNumberLabel.Report

Report As Report

The report to which the object belongs.

ReportPageNumberLabel.Tag

Tag As Variant

A value that can be associated with the ReportPageNumberLabel.

ReportPageNumberLabel.Text

Text As String

The text that is displayed in the label. Used for display purposes only.

ReportPageNumberLabel.TextAlign

TextAlign As TextAlignment

The alignment of the Text.

The choices are:

Value

Description

0

Left

1

Center

2

Right

ReportPageNumberLabel.TextColor

TextColor As Color

Gets or sets the color of the caption or the text content. The default value is black.

The following example sets the TextColor.

Me.TextColor = Color.Red

ReportPageNumberLabel.TextFont

TextFont As String

Name of the font used to display the caption or text content.

You can enter any font that is installed on the computer or the names of the two metafonts, System and SmallSystem.

The System font is the font used by the system software as its default font. Different operating systems use different default fonts. If the system software supports both a large and small System font, you can also specify the SmallSystem font as your TextFont.

On Macintosh, SmallSystem specifies the OS's smaller system font and may make the control smaller in size as well. On Windows and Linux, SmallSystem is the same as System.

ReportPageNumberLabel.TextSize

TextSize As Double

The size of the text, measured in TextUnits.

ReportPageNumberLabel.TextUnit

TextUnit As FontUnits

The unit in which TextSize is measured.

The choices are:

Value

Description

0

Default

1

Pixel

2

Point

3

Inch

4

Millimeter

ReportPageNumberLabel.Top

Top As Double

The top of the control in Units. Top is relative to the section the control is in.

ReportPageNumberLabel.Underline

Underline As Boolean

If True, applies the underline style to the control's caption and/or its text content if any.

ReportPageNumberLabel.VerticalAlign

VerticalAlign As VerticalAlignment

Specifies the type of vertical alignment of the ReportPageNumberLabel.

ReportPageNumberLabel.Visible

Visible As Boolean

If True, the control is visible. The default is True.

ReportPageNumberLabel.Width

Width As Double

The width of the control in Units. Width is relative to the section the control is in.

ReportPageNumberLabel.WordWrap

WordWrap As Boolean

If True, the multiline text will word wrap within the label boundaries.

Method descriptions

ReportPageNumberLabel.Constructor

Constructor(controlName As String)

Note

Constructors are special methods called when you create an object with the New keyword and pass in the parameters above.

Creates a new ReportControl with the passed name.

Event descriptions

ReportPageNumberLabel.AfterPrinting

AfterPrinting

Called after the control has rendered the data for printing.

ReportPageNumberLabel.BeforePrinting

BeforePrinting

Fires before the rendering takes place.

Compatibility

All project types on all supported operating systems.