Class

ReportLabel

Description

An text label in a report created with the Report Layout Editor.

Properties

Name	Type	Read-Only
Back	Double
BackColor	Color
Bold	Boolean
DataField	String
HasBackColor	Boolean
Height	Double
Italic	Boolean
Left	Double
Linespacing	Double
Multiline	Boolean
Name	String	✓
PenHeight	Integer
PenWidth	Integer
Report	Report
Tag	Variant
Text	String
TextAlign	TextAlignment
TextColor	Color
TextFont	String
TextSize	Double
TextUnit	FontUnits
Top	Double
Underline	Boolean
VerticalAlign	VerticalAlignment
Visible	Boolean
Width	Double
WordWrap	Boolean

Methods

Name	Parameters	Returns	Shared
Constructor	controlName As String

Events

Name	Parameters	Returns
AfterPrinting
BeforePrinting

Enumerations

ReportLabel.VerticalAlignment

VerticalAlignment

Specifies the type of vertical alignment of the ReportLabel.

Enum
Bottom
Center
Top

Property descriptions

ReportLabel.Border

Back As Double

The opacity level of the border.

ReportLabel.BackColor

BackColor As Color

The background color for the object. If the control has a HasBackColor property, it must be set to True to have the BackColor displayed.

ReportLabel.Bold

Bold As Boolean

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

Mac apps can only display font styles that are available. You cannot force a font to display in bold or italic if it does not have bold or italic variations available. In this situation, the Bold property will not affect the font.

ReportLabel.DataField

DataField As String

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

ReportLabel.HasBackColor

HasBackColor As Boolean

If True, the background color specified by BackColor is shown.

ReportLabel.Height

Height As Double

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

ReportLabel.Italic

Italic As Boolean

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

Mac apps can only display font styles that are available. You cannot force a font to display in bold or italic if it does not have bold or italic variations available. In this situation, the Italic property will not affect the font.

ReportLabel.Left

Left As Double

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

ReportLabel.Linespacing

Linespacing As Double

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

ReportLabel.Multiline

Multiline As Boolean

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

ReportLabel.Name

Name As String

The name of the object.

ReportLabel.PenHeight

PenHeight As Integer

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

ReportLabel.PenWidth

PenWidth As Integer

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

ReportLabel.Report

Report As Report

The report to which the object belongs.

ReportLabel.Tag

Tag As Variant

A value that can be associated with the ReportLabel.

ReportLabel.Text

Text As String

The text of the label.

ReportLabel.TextAlign

TextAlign As TextAlignment

The alignment of the Text.

The choices are:

Value	Description
0	Left
1	Center
2	Right

ReportLabel.TextColor

TextColor As Color

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

ReportLabel.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.

ReportLabel.TextSize

TextSize As Double

The size of the text, measured in TextUnits.

ReportLabel.TextUnit

TextUnit As FontUnits

The unit in which TextSize is measured.

ReportLabel.Top

Top As Double

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

ReportLabel.Underline

Underline As Boolean

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

ReportLabel.VerticalAlign

VerticalAlign As VerticalAlignment

Specifies the type of vertical alignment of the ReportLabel.

ReportLabel.Visible

Visible As Boolean

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

ReportLabel.Width

Width As Double

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

ReportLabel.WordWrap

WordWrap As Boolean

If True, the multiline text will wordwrap within the Field boundaries.

Method descriptions

ReportLabel.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

ReportLabel.AfterPrinting

AfterPrinting

Called after the control has rendered the data for printing.

ReportLabel.BeforePrinting

BeforePrinting

Fires before the rendering takes place.

Compatibility

All project types on all supported operating systems.