Share via


Report Members (Access)

A Report object refers to a particular Microsoft Access report.

Methods

Name

Description

Circle

The Circle method draws a circle, an ellipse, or an arc on a Report object when the Print event occurs.

Line

The Line method draws lines and rectangles on a Report object when the Print event occurs.

Move

Moves the specified object to the coordinates specified by the argument values.

Print

The Print method prints text on a Report object using the current color and font.

PSet

The PSet method sets a point on a Report object to a specified color when the Print event occurs.

Requery

The Requery method updates the data underlying the specified report by requerying the source of data for the control.

Scale

The Scale method defines the coordinate system for a Report object.

TextHeight

The TextHeight method returns the height of a text string as it would be printed in the current font of a Report object.

TextWidth

The TextWidth method returns the width of a text string as it would be printed in the current font of a Report object.

Properties

Name

Description

ActiveControl

You can use the ActiveControl property together with the Screen object to identify or refer to the control that has the focus. Read-only Control object.

AllowLayoutView

Gets or sets whether the specified report can be used in Layout View. Read/write Boolean.

AllowReportView

Gets or sets whether the user is allowed to enter Report view while using the specified report. Read/write Boolean.

Application

You can use the Application property to access the active Microsoft Access Application object and its related properties. Read-only Application object.

AutoCenter

Returns or sets a Boolean indicating whether a report will be centered automatically in the application window when the form is opened. Read/write.

AutoResize

Returns or sets a Boolean indicating whether a Report window opens automatically sized to display complete records. Read/write.

BorderStyle

Specifies how a control's border appears.Read/write Byte.

Caption

Gets or sets the title of the report in Print Preview. Read/write String.

CloseButton

Specifies whether the Close button on a form is enabled. Read/write Boolean.

ControlBox

Specifies whether a report has a Control menu in Report view. Read/write Boolean.

Controls

Returns the Controls collection of a form, subform, report or section. Read-only Controls.

Count

You can use the Count property to determine the number of items in a specified collection. Read-only Integer.

CurrentRecord

You can use the CurrentRecord property to identify the current record in the recordset being viewed. Read/write Long.

CurrentView

You can use the CurrentView property to determine how a report is currently displayed. Read/write Integer.

CurrentX

You can use the CurrentX property (along with the CurrentY property) to specify the horizontal and vertical coordinates for the starting position of the next printing and drawing method on a report. Read/write Single.

CurrentY

You can use the CurrentY property (along with the CurrentX property) to specify the horizontal and vertical coordinates for the starting position of the next printing and drawing method on a report. Read/write Single.

Cycle

You can use the Cycle property to specify what happens when you press the TAB key and the focus is in the last control on a report. Read/write Byte.

DateGrouping

You can use the DateGrouping property to specify how you want to group dates in a report. Read/write Byte.

DefaultControl

The DefaultControl property returns a Control object with which you can set the default properties for a particular type of control on a particular report. Read-only.

DefaultView

You can use the DefaultView property to specify the opening view of a report. Read/write Byte.

Dirty

You can use the Dirty property to determine whether the current record has been modified since it was last saved. Read/write Boolean.

DisplayOnSharePointSite

Gets or sets whether the specified report can be made available as a view on a Microsoft SharePoint Foundation site. Read/write Byte.

DrawMode

You can use the DrawMode property to specify how the pen (the color used in drawing) interacts with existing background colors on a report when the Line , Circle , or Pset method is used to draw on a report when printing. Read/write Integer.

DrawStyle

You can use the DrawStyle property to specify the line style when using the Line and Circle methods to print lines on reports. Read/write Integer.

DrawWidth

You can use the DrawWidth property to specify the line width for the Line , Circle , and Pset methods to print lines on reports. Read/write Integer.

FastLaserPrinting

You can use the FastLaserPrinting property to specify whether lines and rectangles are replaced by text character lines — similar to the underscore (_) and vertical bar (|) characters — when you print a report using most laser printers. Replacing lines and rectangles with text character lines can make printing much faster. Read/write Boolean.

FillColor

You use the FillColor property to specify the color that fills in boxes and circles drawn on reports with the Line and Circle methods. You can also use this property with Visual Basic to create special visual effects on custom reports when you print using a color printer or preview the reports on a color monitor. Read/write Long.

FillStyle

You can use the FillStyle property to specify whether a circle or line drawn by the Circle or Line method on a report is transparent, opaque, or filled with a pattern. Read/write Integer.

Filter

You can use the Filter property to specify a subset of records to be displayed when a filter is applied to a form, report query, or table. Read/write String.

FilterOn

You can use the FilterOn property to specify or determine whether the Filter property for a form or report is applied. Read/write Boolean.

FilterOnLoad

Gets or sets whether the filter specified by the Filter property is applied when the report is loaded. Read/write Boolean.

FitToPage

Gets or sets whether the width of the specified report is sized to automatically fit the page. Read/write Boolean.

FontBold

You can use the FontBold property to specify whether a font appears in a bold style in the following situations:

  • When displaying or printing controls on forms and reports.

  • When using the Print method on a report.

Read/write Boolean.

FontItalic

You can use the FontItalic property to specify whether text is italic in the following situations:

  • When displaying or printing controls on forms and reports.

  • When using the Print method on a report.

Read/write Boolean.

FontName

You can use the FontName property to specify the font for text in the following situations:

  • When displaying or printing controls on forms and reports.

  • When using the Print method on a report.

Read/write String.

FontSize

You can use the FontSize property to specify the point size for text in the following situations:

  • When displaying or printing controls on forms and reports.

  • When using the Print method on a report.

Read/write Integer.

FontUnderline

You can use the FontUnderline property to specify whether text is underlined in the following situations:

  • When displaying or printing controls on forms and reports.

  • When using the Print method on a report.

Read/write Integer.

ForeColor

You can use the ForeColor property to specify the color for text in a control. Read/write Long.

FormatCount

You can use the FormatCount property to determine the number of times the OnFormat property has been evaluated for the current section on a report. Read/write Integer.

GridX

You can use the GridX property (along with the GridY property) to specify the horizontal and vertical divisions of the alignment grid in report Design view. Read/write Integer.

GridY

You can use the GridY property (along with the GridX property) to specify the horizontal and vertical divisions of the alignment grid in report Design view. Read/write Integer.

GroupLevel

You can use the GroupLevel property in Visual Basic to refer to the group level you are grouping or sorting on in a report. Read-only GroupLevel object.

GrpKeepTogether

You can use the GrpKeepTogether property to specify whether groups in a multiple column report that have their KeepTogether property for a group set to Whole Group or With First Detail will be kept together by page or by column. Read/write Byte.

HasData

You can use the HasData property to determine if a report is bound to an empty

recordset. Read/write Long.

HasModule

You can use the HasModule property to specify or determine whether a form or report has a class module. Read/write Boolean.

Height

Gets or sets the height of the specified object in twips. Read/write Long.

HelpContextId

The HelpContextID property specifies the context ID of a topic in the custom Help file specified by the HelpFile property setting. Read/write Long.

HelpFile

The name of a help file associated with a report. Read/write String.

Hwnd

You can use the hWnd property to determine the handle (a unique Long Integer value) assigned by Microsoft Windows to the current window. Read/write Long.

InputParameters

You can use the InputParameters property to specify or determine the input parameters that are passed to a SQL statement in the RecordSource property of a form or report or a stored procedure when used as the record source within a Microsoft Access project (.adp). Read/write String.

KeyPreview

You can use the KeyPreview property to specify whether the report-level keyboard event procedures are invoked before a control's keyboard event procedures. Read/write Boolean.

LayoutForPrint

You can use the LayoutForPrint property to specify whether the report uses printer or screen fonts. Read/write Boolean.

Left

You can use the Left property to specify an object's location on a form or report. Read/write Long.

MenuBar

Specifies a custom menu to display for a report. Read/write String.

MinMaxButtons

You can use the MinMaxButtons property to specify whether the Maximize and Minimize buttons will be visible on a report. Read/write Byte.

Modal

You can use the Modal property to specify whether a report opens as a modal window. When a report opens as a modal window, you must close the window before you can move the focus to another object. Read/write Boolean.

Module

You can use the Module property to specify a report module. Read-only Module object.

MouseWheel

Returns or sets a String indicating which macro, event procedure, or user-defined function runs when the MouseWheel event occurs. Read/write.

Moveable

Returns or sets a Boolean indicating whether the specified report can be moved by the user; True if it can be moved. Read/write.

MoveLayout

The MoveLayout property specifies whether Microsoft Access should move to the next printing location on the page. Read/write Boolean.

Name

You can use the Name property to specify or determine the string expression that identifies the name of an object. Read/write String.

NextRecord

The NextRecord property specifies whether a section should advance to the next record. Read/write Boolean.

OnActivate

Sets or returns the value of the On Activate box in the Properties window of a form or report. Read/write String.

OnApplyFilter

Sets or returns the value of the On Apply Filter box in the Properties window of a report. Read/write String.

OnClick

Sets or returns the value of the On Click box in the Properties window. Read/write String.

OnClose

Sets or returns the value of the On Close box in the Properties window of a form or report. Read/write String.

OnCurrent

Sets or returns the value of the On Current box in the Properties window of a report. Read/write String.

OnDblClick

Sets or returns the value of the On Dbl Click box in the Properties window. Read/write String.

OnDeactivate

Sets or returns the value of the On Deactivate box in the Properties window of a form or report. Read/write String.

OnError

Sets or returns the value of the OnError box in the Properties window of a form or report. Read/write String.

OnFilter

Sets or returns the value of the On Filter box in the Properties window of a report. Read/write String.

OnGotFocus

Sets or returns the value of the On Got Focus box in the Properties window of the specified report. Read/write String.

OnKeyDown

Sets or returns the value of the On Key Down box in the Properties window. Read/write String.

OnKeyPress

Sets or returns the value of the On Key Press box in the Properties window. Read/write String.

OnKeyUp

Sets or returns the value of the On Key Up box in the Properties window. Read/write String.

OnLoad

Sets or returns the value of the On Load box in the Properties window of a report. Read/write String.

OnLostFocus

Sets or returns the value of the On Lost Focus box in the Properties window of the specified report. Read/write String.

OnMouseDown

Sets or returns the value of the On Mouse Down box in the Properties window. Read/write String.

OnMouseMove

Sets or returns the value of the On Mouse Move box in the Properties window. Read/write String.

OnMouseUp

Sets or returns the value of the On Mouse Up box in the Properties window. Read/write String.

OnNoData

Sets or returns the value of the On No Data box in the Properties window of a report. Read/write String.

OnOpen

Sets or returns the value of the On Open box in the Properties window of a form or report. Read/write String.

OnPage

Sets or returns the value of the On Page box in the Properties window of a report. Read/write String.

OnResize

Sets or returns the value of the On Resize box in the Properties window of a report. Read/write String.

OnTimer

Sets or returns the value of the On Timer box in the Properties window of a form. Read/write String.

OnUnload

Sets or returns the value of the On Unload box in the Properties window of a form. Read/write String.

OpenArgs

Determines the string expression specified by the OpenArgs argument of the OpenReport method that opened a Report. Read/write Variant.

OrderBy

You can use the OrderBy property to specify how you want to sort records in a report. Read/write String.

OrderByOn

You can use the OrderByOn property to specify whether an object's OrderBy property setting is applied. Read/write Boolean.

OrderByOnLoad

Gets or sets whether the sorting specified by the OrderBy property is applied when the report is loaded. Read/write Boolean.

Orientation

You can use the Orientation property to specify or determine the view orientation. Read/write Byte.

Page

The Page property specifies the current page number when a report is being printed. Read/write Long.

PageFooter

You can use the PageFooter property to specify whether a report's page footer is printed on the same page as a report footer. Read/write Byte.

PageHeader

You can use the PageHeader property to specify whether a report's page header is printed on the same page as a report header. Read/write Byte.

Pages

You can use the Pages property to return information needed to print page numbers in a report. Read/write Integer.

Painting

You can use the Painting property to specify whether a report is repainted. Read/write Boolean.

PaintPalette

You can use the PaintPalette property to specify a palette to be used by a report. Read/write Variant.

PaletteSource

You can use the PaletteSource property to specify the palette for a report. Read/write String.

Parent

Returns the parent object for the specified object. Read-only.

Picture

You can use the Picture property to specify a bitmap or other type of graphic to be used as a background picture on a report. Read/write String.

PictureAlignment

You can use the PictureAlignment property to specify where a background picture will appear in an image control or on a form or report. Read/write Byte.Read/write.

PictureData

You can use the PictureData property to copy the picture to another object that supports the Picture property. Read/write Variant.

PicturePages

You can use the PicturePages property to specify on which page or pages of a report a picture will be displayed. Read/write Byte.

PicturePalette

You can use the PicturePalette property to specify a palette to be used by a report. Read/write Variant.

PictureSizeMode

You can use the PictureSizeMode property to specify how a picture for a form or report is sized. Read/write Byte.

PictureTiling

You can use the PictureTiling property to specify whether a background picture is tiled across the entire image control, Form window, form, or page of a report. Read/write Boolean.

PictureType

You can use the PictureType property to specify whether Microsoft Access stores an object's picture as a linked or an embedded object. Read/write Byte.

PopUp

Specifies whether a report opens as a pop-up window. Read/write Boolean.

PrintCount

You can use the PrintCount property to identify the number of times the OnPrint property has been evaluated for the current section of a report. Read/write Integer.

Printer

Returns or sets a Printer object representing the default printer on the current system. Read/write.

PrintSection

The PrintSection property specifies whether a section should be printed. Read/write Boolean.

Properties

Returns a reference to a control's Properties collection object. Read-only.

PrtDevMode

You can use the PrtDevMode property to set or return printing device mode information specified for a form or report in the Print dialog box. Read/write Variant.

PrtDevNames

You can use the PrtDevNames property to set or return information about the printer selected in the Print dialog box for a form or report. Read/write Variant.

PrtMip

You can use the PrtMip property in Visual Basic to set or return the device mode information specified for a form or report in the Print dialog box.

RecordLocks

You can use the RecordLocks property to determine how records are locked and what happens when two users try to edit the same record at the same time. Read/write.

Recordset

Returns or sets the ADO Recordset or DAO Recordset object representing the record source for the specified object. Read/write Object.

RecordSource

You can use the RecordSource property to specify the source of the data for a report. Read/write String.

RecordSourceQualifier

Returns or sets a String indicating the SQL Server owner name of the record source for the specified report. Read/write.

Report

You can use the Report property to refer to a report or to refer to the report associated with a subreport control. Read-only Report.

RibbonName

Gets or set the name of the customized ribbon to be displayed when the specified report is loaded. Read/write String.

ScaleHeight

You can use the ScaleHeight property to specify the number of units for the vertical measurement of the page when the Circle , Line , Pset , or Print method is used while a report is printed or previewed, or its output is saved to a file. Read/write Single.

ScaleLeft

You can use the ScaleLeft property to specify the units for the horizontal coordinates that describe the location of the left edge of a page when the Circle , Line , Pset , or Print method is used while a report is previewed, printed, or its output is saved to a file. Read / write Single.

ScaleMode

You can use the ScaleMode property in Visual Basic to specify the unit of measurement for coordinates on a page when the Circle , Line , Pset , or Print method is used while a report is previewed or printed, or its output is saved to a file. Read/write Integer.

ScaleTop

You can use the ScaleTop property to specify the units for the vertical coordinates that describe the location of the top edge of a page when the Circle , Line , Pset , or Print method is used while a report is previewed, printed, or its output is saved to a file. Read / write Single.

ScaleWidth

You can use the ScaleWidth property to specify the number of units for the horizontal measurement of the page when the Circle , Line , Pset , or Print method is used while a report is printed or previewed, or its output is saved to a file. Read/write Single.

ScrollBars

Gets or sets whether scroll bars appear on a report. Read/write Byte.

Section

You can use the Section property to identify a section of a report and provide access to the properties of that section. Read-only Section object.

ServerFilter

You can use the ServerFilter property to specify a subset of records to be displayed when a server filter is applied to a report within a Microsoft Access project (.adp) or database. Read/write String.

Shape

Returns a String representing the shape command corresponding to the sorting and grouping of the specified report. Read-only.

ShortcutMenuBar

You can use the ShortcutMenuBar property to specify the shortcut menu that will appear when you right-click on the specified object. Read/write String.

ShowPageMargins

Gets or sets whether page margins are displayed when the specified report is in Layout view. Read/write Boolean.

Tag

Stores extra information about a form, report, section, or control needed by a Microsoft Access application. Read/write String.

TimerInterval

You can use the TimerInterval property to specify the interval, in milliseconds, between Timer events on a report. Read/write Long.

Toolbar

Specifies a custom toolbar to display for a report. Read/write String.

Top

You can use the Top property to specify an object's location on a form or report. Read/write Long. .

UseDefaultPrinter

Returns or sets a Boolean indicating whether the specified report uses the default printer for the system; True if the form or report uses the default printer. Read/write.

Visible

Returns or sets whether the object is visible. Read/write Boolean.

Width

Gets or sets the width of the specified object in twips. Read/write Integer.

WindowHeight

Returns the height of a report in twips. Read-only Integer.

WindowLeft

Returns an Integer indicating the screen position in twips of the left edge of a report relative to the left edge of the Microsoft Access window. Read-only.

WindowTop

Returns an Integer indicating the screen position in twips of the top edge of a report relative to the top of the Microsoft Access window. Read-only.

WindowWidth

Returns the width of a report in twips. Read-only Integer.

Events

Name

Description

Activate

The Activate event occurs when a report receives the focus and becomes the active window.

ApplyFilter

Occurs when a filter is applied to a report.

Click

The Click event occurs when the user presses and then releases a mouse button over a report.

Close

The Close event occurs when a report is closed and removed from the screen.

Current

Occurs when the focus moves to a record, making it the current record, or when the report is refreshed or requeried.

DblClick

The DblClick event occurs when the user presses and releases the left mouse button twice over an report within the double-click time limit of the system.

Deactivate

The Deactivate event occurs when a report loses the focus to a Table, Query, Form, Report, Macro, or Module window, or to the Database window.

Error

The Error event occurs when a run-time error is produced in Microsoft Access when a report has the focus.

Filter

Occurs when the user opens a filter window by clicking Advanced Filter/Sort.

GotFocus

The GotFocus event occurs when the report receives the focus.

KeyDown

The KeyDown event occurs when the user presses a key while a report has the focus. This event also occurs if you send a keystroke to a report by using the SendKeys action in a macro or the SendKeys statement in Visual Basic.

KeyPress

The KeyPress event occurs when the user presses and releases a key or key combination that corresponds to an ANSI code while a report has the focus. This event also occurs if you send an ANSI keystroke to a report by using the SendKeys action in a macro or the SendKeys statement in Visual Basic.

KeyUp

The KeyUp event occurs when the user releases a key while a report has the focus. This event also occurs if you send a keystroke to a report by using the SendKeys action in a macro or the SendKeys statement in Visual Basic.

Load

Occurs when a report is opened and its records are displayed.

LostFocus

The LostFocus event occurs when the specified object loses the focus.

MouseDown

The MouseDown event occurs when the user presses a mouse button.

MouseMove

The MouseMove event occurs when the user moves the mouse.

MouseUp

The MouseUp event occurs when the user releases a mouse button.

MouseWheel

Occurs when the user rolls the mouse wheel in Report view or Layout view.

NoData

The NoData event occurs after Microsoft Access formats a report for printing that has no data (the report is bound to an empty recordset), but before the report is printed. You can use this event to cancel printing of a blank report.

Open

The Open occurs before a report is previewed or printed.

Page

The Page event occurs after Microsoft Access formats a page of a report for printing, but before the page is printed. You can use this event to draw a border around the page, or add other graphic elements to the page.

Resize

The Resize event occurs when a report is opened and whenever the size of a report changes.

Timer

The Timer event occurs for a report at regular intervals as specified by the report's TimerInterval property.

Unload

The Unload event occurs after a report is closed but before it's removed from the screen.