CommandButton Members (Access)

This object corresponds to a command button. A command button on a form can start an action or a set of actions. For example, you could create a command button that opens another form. To make a command button do something, you write a macro or event procedure and attach it to the button's OnClick property.

Methods

Name

Description

Move

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

Requery

The Requery method updates the data underlying a specified control that's on the active form by requerying the source of data for the control.

SetFocus

The SetFocus method moves the focus to the specified form, the specified control on the active form, or the specified field on the active datasheet.

SizeToFit

You can use the SizeToFit method to size a control so it fits the text or image that it contains.

Properties

Name

Description

AddColon

Specifies whether a colon follows the text in labels for new controls. Read/write Boolean.

Alignment

Gets or sets how the specified button's caption and picture are aligned. Read/write Byte.

Application

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

AutoLabel

Specifies whether labels are automatically created and attached to new controls. Read/write Boolean.

AutoRepeat

You can use the AutoRepeat property to specify whether an event procedure or macro runs repeatedly while a command button on a form remains pressed in. Read/write Boolean.

BackColor

Gets or sets the interior color of the specified object. Read/write Long.

BackShade

Gets or sets the shade that is applied to the theme color in the BackColor property of the specified object. Read/write Single.

BackStyle

You can use the BackStyle property to specify whether a control will be transparent. Read/write Byte.

BackThemeColorIndex

Gets or sets a value that represents a color in the applied color theme associated with the BackColor property of the specified object. Read/write Long.

BackTint

Gets or sets the tint that is applied to the theme color in the BackColor property of the specified object. Read/write Single.

Bevel

Gets or sets the bevel effect applied to the specified object. Read/write Long.

BorderColor

You can use the BorderColor property to specify the color of a control's border. Read/write Long.

BorderShade

Gets or sets the shade that is applied to the theme color in the BorderColor property of the specified object. Read/write Single.

BorderStyle

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

BorderThemeColorIndex

Gets or sets a value that represents a color in the applied color theme associated with the BorderColor property of the specified object. Read/write Long.

BorderTint

Gets or sets the tint that is applied to the theme color in the BorderColor property of the specified object. Read/write Single.

BorderWidth

You can use the BorderWidth property to specify the width of a control's border. Read/write Byte.

BottomPadding

Gets or sets the amount of space (in inches) between the button and its bottom gridline. Read/write Integer.

Cancel

You can use the Cancel property to specify whether a command button is also the Cancel button on a form. Read/write Boolean.

Caption

Gets or sets the text that appears in the control. Read/write String.

Controls

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

ControlTipText

You can use the ControlTipText property to specify the text that appears in a ScreenTip when you hold the mouse pointer over a control. Read/write String.

ControlType

You can use the ControlType property in Visual Basic to determine the type of a control on a form or report. Read/write Byte.

CursorOnHover

Gets or sets the type of mouse cursor displayed when the user rests the pointer on a button. Read/write AcCursorOnHover.

Default

You can use the Default property to specify whether a command button is the default button on a form. Read/write Boolean.

DisplayWhen

You can use the DisplayWhen property to specify which of a form's controls you want displayed on screen and in print. Read/write Byte.

Enabled

You can use the Enabled property to set or return the status of the conditional format in the FormatCondition object. Read/write Boolean.

EventProcPrefix

Gets or sets the prefix portion of an event procedure name. Read/write String.

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

FontWeight

You can use the DatasheetFontWeight property to specify the line width of the font used to display and print characters for field names and data in Datasheet view. Read/write Integer.

ForeColor

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

ForeShade

Gets or sets the shade that is applied to the theme color in the ForeColor property of the specified object. Read/write Single.

ForeThemeColorIndex

Gets or sets a value that represents a color in the applied color theme associated with the ForeColor property of the specified object. Read/write Long.

ForeTint

Gets or sets the tint that is applied to the theme color in the ForeColor property of the specified object. Read/write Single.

Glow

Gets or sets the Glow effect applied to the specified object. Read/write Long.

Gradient

Gets or sets the gradient fill applied to the specified object. Read/write Long.

GridlineColor

Gets or sets the color of the gridline for the specified command button. Read/write Long.

GridlineShade

Gets or sets the shade applied to the theme color in the GridlineColor property of the specified object. Read/write Single.

GridlineStyleBottom

Gets or sets the bottom gridline style of the specified button. Read/write Byte.

GridlineStyleLeft

Gets or sets the width of the bottom gridline for the specified button. Read/write Byte.

GridlineStyleRight

Gets or sets the right gridline style of the specified button. Read/write Byte.

GridlineStyleTop

Gets or sets the top gridline style of the specified button. Read/write Byte.

GridlineThemeColorIndex

Gets or sets the theme color index that represents a color in the applied color theme associated with the GridlineColor property of the specified object. Read/write Long.

GridlineTint

Gets or sets the tint applied to the theme color in the GridlineColor property of the specified object. Read/write Single.

GridlineWidthBottom

Gets or sets the width of the bottom gridline for the specified button. Read/write Byte.

GridlineWidthLeft

Gets or sets the width of the left gridline for the specified button. Read/write Byte.

GridlineWidthRight

Gets or sets the width of the right gridline for the specified button. Read/write Byte.

GridlineWidthTop

Gets or sets the width of the top gridline for the specified button. Read/write Byte.

Height

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

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.

HorizontalAnchor

Gets or sets an AcHorizontalAnchor constant that indicates how the button is anchored horizontally within its layout. Read/write.

HoverColor

Gets or sets the color displayed on the control when the user rests the mouse cursor over it. Read/write Long.

HoverForeColor

Gets or sets the color of the text displayed on the control when the user rests the mouse cursor over it. Read/write Long.

HoverForeShade

Gets or sets the shade applied to the theme color in the HoverForeColor property of the specified object. Read/write Single.

HoverForeThemeColorIndex

Gets or sets the theme color index that represents a color in the applied color theme associated with the HoverForeColor property of the specified object. Read/write Long.

HoverForeTint

Gets or sets the tint applied to the theme color in the HoverForeColor property of the specified object. Read/write Single.

HoverShade

Gets or sets the shade that is applied to the theme color in the HoverColor property of the specified object. Read/write Single.

HoverThemeColorIndex

Gets or sets the theme color index that represents a color in the applied color theme associated with the HoverColor property of the specified object. Read/write Long.

HoverTint

Gets or sets the tint applied to the theme color in the HoverColor property of the specified object. Read/write Single.

Hyperlink

You can use the Hyperlink property to return a reference to a Hyperlink object. You can use the Hyperlink property to access the properties and methods of a control's hyperlink. Read-only.

HyperlinkAddress

You can use the HyperlinkAddress property to specify or determine the path to an object, document, Web page or other destination for a hyperlink associated with a the specified control. Read/write String.

HyperlinkSubAddress

You can use the HyperlinkSubAddress property to specify or determine a location within the target document specified by the HyperlinkAddress property. Read/write String.

InSelection

You can use the InSelection property to determine or specify whether a control on a form in Design view is selected. Read/write Boolean.

IsVisible

You can use the IsVisible property in to determine whether a control on a report is visible. Read/write Boolean.

LabelAlign

The property specifies the text alignment within attached labels on new controls. Read/write Byte.

LabelX

The LabelX property (along with the LabelY property) specifies the placement of the label for a new control. Read/write Integer.

LabelY

The LabelY property (along with the LabelX property) specifies the placement of the label for a new control. Read/write Integer.

Layout

Returns the type of layout for the specified button. Read-only AcLayoutType.

LayoutID

Returns the unique identifier for the layout that contains the specified button. Read-only Long.

Left

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

LeftPadding

Gets or sets the amount of space (in inches) between the button and its left gridline. Read/write Integer.

Name

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

ObjectPalette

The ObjectPalette property specifies the palette in the application used to create A bitmap or other graphic that is loaded into the specified control by using the Picture property. Read/write Variant.

OldValue

You can use the OldValue property to determine the unedited value of a bound control. Read-only Variant.

OnClick

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

OnDblClick

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

OnEnter

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

OnExit

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

OnGotFocus

Sets or returns the value of the On Got Focus box in the Properties window of the specified object. 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.

OnLostFocus

Sets or returns the value of the On Lost Focus box in the Properties window of the specified object. 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.

OnPush

Sets or returns the value of the On Click box in the Properties window of a command button. 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 displayed on the specified control. Read/write String.

PictureCaptionArrangement

Gets or sets how the specified button's caption is arranged in relation to its picture. Read/write AcPictureCaptionArrangement.

PictureData

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

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.

PressedColor

Gets or sets the color displayed on the control when the user clicks it. Read/write Long.

PressedForeColor

Gets or sets the color of the text displayed on the control when the user clicks it. Read/write Long.

PressedForeShade

Gets or sets the shade applied to the theme color in the PressedForeColor property of the specified object. Read/write Single.

PressedForeThemeColorIndex

Gets or sets the theme color index that represents a color in the applied color theme associated with the PressedForeColor property of the specified object. Read/write Long.

PressedForeTint

Gets or sets the tint applied to the theme color in the PressedForeColor property of the specified object. Read/write Single.

PressedShade

Gets or sets the shade that is applied to the theme color in the PressedColor property of the specified object. Read/write Single.

PressedThemeColorIndex

Gets or sets the theme color index that represents a color in the applied color theme associated with the PressedColor property of the specified object. Read/write Long.

PressedTint

Gets or sets the tint applied to the theme color in the PressedColor property of the specified object. Read/write Single.

Properties

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

QuickStyle

Gets or sets the Quick Style that is applied to the specified object. Read/write Long.

ReadingOrder

You can use the ReadingOrder property to specify or determine the reading order of words in text. Read/write Byte.

RightPadding

Gets or sets the amount of space (in inches) between the button and its right gridline. Read/write Integer.

Section

You can identify these controls by the section of a form or report where the control appears. Read/write Integer.

Shadow

Gets or sets the Shadow effect applied to the specified object. Read/write Long.

Shape

Returns or sets the shape of the specified button. Read/write Long.

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.

SoftEdges

Gets or sets the Soft Edges effect applied to the specified object. Read/write Long.

StatusBarText

You can use the StatusBarText property to specify the text that is displayed in the status bar when a control is selected. Read/write String.

TabIndex

You can use the TabIndex property to specify a control's place in the tab order on a form or report. Read/write Integer.

TabStop

You can use the TabStop property to specify whether you can use the TAB key to move the focus to a control. Read/write Boolean.

Tag

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

ThemeFontIndex

Gets or sets the font index that represents a font in the applied theme associated with the FontName property of the specified object. Read/write Long.

Top

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

TopPadding

Gets or sets the amount of space (in inches) between the button and its top gridline. Read/write Integer.

Transparent

You can use the Transparent property to specify whether a command button is solid or transparent. Read/write Boolean.

UseTheme

Gets or sets whether the specified object will utilize formatting styles defined in Office Document Themes. Read/write Boolean.

VerticalAnchor

Gets or sets an AcVerticalAnchor constant that indicates how the specified button is anchored vertically within its layout. 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.

Events

Name

Description

Click

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

DblClick

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

Enter

The Enter event occurs before a control actually receives the focus from a control on the same form or report.

Exit

The Exit event occurs just before a control loses the focus to another control on the same form or report.

GotFocus

The GotFocus event occurs when the specified object receives the focus.

KeyDown

The KeyDown event occurs when the user presses a key while a form or control has the focus. This event also occurs if you send a keystroke to a form or control 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 form or control has the focus. This event also occurs if you send an ANSI keystroke to a form or control 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 form or control has the focus. This event also occurs if you send a keystroke to a form or control by using the SendKeys action in a macro or the SendKeys statement in Visual Basic.

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.