Class

ReportField

Description

A field used to print data 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

ReportField.TextAlignment

TextAlignment

Specifies the side of to which the text is aligned.

Enum

Center

Left

Right

ReportField.VerticalAlignment

VerticalAlignment

Specifies the side to which the vertical axis of the ReportField is aligned.

Enum

Bottom

Center

Top

Property descriptions

ReportField.Back

Back As Double

The opacity level of the border.

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

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

ReportField.DataField

DataField As String

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

ReportField.DefaultEncoding

DefaultEncoding As TextEncoding

The TextEncoding of the control. The default is UTF-8.

If you need to change this, do so in the BeforePrinting event using a statement such as:

Me.DefaultEncoding = Encodings.UTF16

ReportField.HasBackColor

HasBackColor As Boolean

If True, the background color is set to BackColor.

ReportField.Height

Height As Double

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

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

ReportField.Left

Left As Double

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

ReportField.Linespacing

Linespacing As Double

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

ReportField.Multiline

Multiline As Boolean

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

ReportField.Name

Name As String

The name of the object.

ReportField.OutputFormat

OutputFormat As String

The mask used to format the value. This uses the same mask values as the Format command.

ReportField.Report

Report As Report

The report to which the object belongs.

ReportField.Tag

Tag As Variant

A value that can be associated with the ReportField.

ReportField.PenHeight

PenHeight As Integer

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

ReportField.PenWidth

PenWidth As Integer

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

ReportField.SummaryFunc

SummaryFunc As String

The summary function type to be used to process the datafield values as a group.

Currently, the only function type is:

Value

Description

0

Sum

ReportField.SummaryType

SummaryType As String

Determines the type of total to be calculated by the SummaryFunc.

The choices are:

Value

None

Grand Total

Page Total

Subtotal

Page Count

ReportField.Text

Text As String

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

ReportField.TextAlign

TextAlign As TextAlignment

The alignment of the Text.

ReportField.TextColor

TextColor As Color

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

ReportField.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".

ReportField.TextSize

TextSize As Double

The size of the text, measured in TextUnits.

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

ReportField.Top

Top As Double

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

ReportField.Underline

Underline As Boolean

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

ReportField.VerticalAlign

VerticalAlign As VerticalAlignment

Specifies the type of vertical alignment of the ReportField.

ReportField.Visible

Visible As Boolean

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

ReportField.Width

Width As Double

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

ReportField.WordWrap

WordWrap As Boolean

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

Method descriptions

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

ReportField.AfterPrinting

AfterPrinting

Called after the control has rendered the data for printing.

ReportField.BeforePrinting

BeforePrinting

Fires before the rendering takes place.

Compatibility

All project types on all supported operating systems.