Class
DesktopBevelButton
Description
Used for creating a bevel button. A DesktopBevelButton can use text, a graphic, a pop-up menu, or several of these interface elements in combination.
Properties
Name |
Type |
Read-Only |
Shared |
|---|---|---|---|
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
Methods
Name |
Parameters |
Returns |
Shared |
|---|---|---|---|
FileType As String |
|||
Type As String |
|||
theReceiver As ActionNotificationReceiver |
|||
x As Integer, y As Integer, width As Integer, height As Integer, immediately As Boolean = False |
|||
theReceiver As ActionNotificationReceiver |
|||
Events
Name |
Parameters |
Returns |
|---|---|---|
Base As DesktopMenuItem, x As Integer, y As Integer |
||
HitItem As DesktopMenuItem |
||
obj As DragItem, Action As DragItem.Types |
||
obj As DragItem, Action As DragItem.Types |
||
x As Integer, y As Integer, obj As DragItem, Action As DragItem.Types |
||
Obj As DragItem Action As DragItem.Types |
||
Key As String |
||
Key As String |
||
selectedItem As DesktopMenuItem |
||
X As Integer, Y As Integer, DeltaX As Integer, DeltaY As Integer |
||
Enumerations
DesktopBevelButton.BevelStyles
BevelStyles
All available bevel styles.
Value |
Description |
|---|---|
Small |
Small bevel |
Normal |
Normal bevel |
Large |
Large bevel |
Rounded |
Rounded bevel (macOS only) |
None |
No Bevel (Windows only) |
Round |
Round (macOS only) |
LargeRound |
Large Round (macOS only) |
Disclosure |
Disclosure (macOS only) |
DesktopBevelButton.ButtonStyles
ButtonStyles
All available button styles.
Value |
Description |
|---|---|
PushButton |
Remains in the down position until mouse is released. |
ToggleButton |
Remains in the down position until clicked again. |
StickyButton |
Remains in the down position when clicked. |
DesktopBevelButton.CaptionAlignments
CaptionAlignments
All available caption alignments.
Value |
Description |
|---|---|
Left |
Flush left (Default) |
Right |
Flush right |
SystemDirection |
The user's OS-defined direction |
Centered |
Center |
DesktopBevelButton.CaptionPositions
CaptionPositions
All available caption positions.)
Value |
Description |
|---|---|
SystemDirection |
User's OS-defined system direction (Default) |
Normal |
Normally |
RightOfIcon |
To the right of icon |
LeftOfIcon |
To the left of the icon |
BelowIcon |
Below the icon |
AboveIcon |
Above the icon |
DesktopBevelButton.IconAlignments
IconAlignments
All available icon alignments.
Value |
Description |
|---|---|
SystemDirection |
The user's OS-defined system direction (Default) |
Centered |
Center |
Left |
Left |
Right |
Right |
Top |
Top |
Bottom |
Bottom |
TopLeft |
Top left |
BottomLeft |
Bottom left |
TopRight |
Top right |
BottomRight |
Bottom right |
Property descriptions
DesktopBevelButton.Active
Active As Boolean
Indicates whether the control is active.
This property is read-only.
Active is False when the control's window is not in the foreground. When a DesktopWindow is deactivated, its controls are automatically deactivated unless AllowAutoDeactivate is set to False.
DesktopBevelButton.AllowAutoDeactivate
AllowAutoDeactivate As Boolean
Determines whether the control should be deactivated (on macOS) when the parent window is deactivated. The default is True.
DesktopBevelButton.AllowFocus
AllowFocus As Boolean
If True, the button will be included in the Tab order and can accept the focus. The events FocusReceived and FocusLost are called at the appropriate times.
This code enables the AllowFocus property. It is in the Opening event of the control.
Me.AllowFocus = True
DesktopBevelButton.AllowTabStop
AllowTabStop As Boolean
If True, the control is in the Tab Order and accepts the focus when the user tabs into it. The default is True. If False, the user cannot tab into it to give it the focus. However, the control can gain the focus by other means, such as the user's clicking on it or by setting the focus in code.
This example removes the control from the Tab Order:
Me.AllowTabStop = False
DesktopBevelButton.BackgroundColor
BackgroundColor As ColorGroup
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 = Color.Red
DesktopBevelButton.BevelStyle
BevelStyle As Integer
The bevel style. This property affects the appearance and in some cases the shape of the DesktopBevelButton.
This example sets the Bevel property to Round.
Me.BevelStyle = DesktopBevelButton.BevelStyles.Round
DesktopBevelButton.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.
This code in any event of a DesktopBevelButton makes the Caption property bold:
Me.Bold = True
DesktopBevelButton.ButtonStyle
ButtonStyle As Integer
The style of the button.
This code changes the button to a "Toggles" button.
Me.ButtonStyle = DesktopBevelButton.ButtonStyles.ToggleButton
DesktopBevelButton.Caption
Caption As String
The caption of a control.
This property can be set inside the IDE or programmatically.
To set an accelerator character, precede the character in the Caption with an ampersand. In order to show an ampersand in the Caption, use two ampersands in a row.
This code sets the caption of the control to "OK".
Me.Caption = "OK"
This code in the Pressed event handler for a DesktopBevelButton changes the text of the button each time it is clicked:
If Me.Caption = "Blue" Then
Me.Caption = "Red"
Else
Me.Caption = "Blue"
End If
DesktopBevelButton.CaptionAlignment
CaptionAlignment As Integer
The alignment of the caption.
The following code sets the alignment to right. It is in the Opening event of the control.
Me.CaptionAlignment = DesktopBevelButton.CaptionAlignments.Right
DesktopBevelButton.CaptionDelta
CaptionDelta As Integer
The distance (in pixels) of the caption from the left of the button.
The following example moves the caption 10 pixels from the left.
Me.Caption = "Caption"
Me.CaptionAlign = 0 ' left
Me.CaptionDelta = 10
DesktopBevelButton.CaptionPosition
CaptionPosition As Integer
The position of the caption relative to the icon.
This code positions the caption to the right of the icon. The image, "Woof", is an image that has been added to the project.
Me.Caption = "Fido"
Me.CaptionAlignment = BevelButton.CaptionAlignments.Left
Me.CaptionDelta = 10
Me.icon = Woof
Me.CaptionPosition = BevelButton.CaptionPositions.RightOfIcon
DesktopBevelButton.Enabled
Enabled As Boolean
Determines if the control should be enabled when the owning window is opened.
A disabled control cannot be clicked and cannot receive the focus.
This example disables the control.
Me.Enabled = False
DesktopBevelButton.FontName
FontName As String
Name of the font used to display the caption.
You can enter any installed font 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 FontName.
On macOS, "SmallSystem" specifies the smaller system font and may make the control smaller in size as well. On Windows and Linux, "SmallSystem" is the same as "System".
This code (in any DesktopBevelButton event) sets the FontName property.
Me.FontName = "Helvetica"
DesktopBevelButton.FontSize
FontSize As Single
Point size of the font used to display the caption.
If you enter zero as the FontSize, your app will use the font size that works best for the platform on which it is running.
This code (in any DesktopBevelButton event) sets the font size to 16 points.
Me.FontUnit = FontUnits.Point
Me.FontSize = 16
DesktopBevelButton.FontUnit
FontUnit As FontUnits
The units in which Font size is measured.
DesktopBevelButton.Handle
Handle As Ptr
Returns a handle to the control.
This property is read-only.
For interfacing with Mac APIs using Declares, DesktopControl.Handle returns NSViews (except for DesktopToolbar).
On Windows returns the HWND of the control.
On Linux it returns a GtkWidget.
The following gets a handle to the control.
Var p As Ptr = Me.Handle
DesktopBevelButton.HasBackgroundColor
HasBackgroundColor As Boolean
If True, the BackgroundColor color will be visible. The BackgroundColor is visible only on Windows and Linux.
The following code sets the BackgroundColor.
Me.HasBackgroundColor = True
Me.BackgroundColor = Color.Red
DesktopBevelButton.Height
Height As Integer
The height (in points) of the control.
This example sets the height of the control to 100:
Me.Height = 100
DesktopBevelButton.Icon
Icon As Picture
The name of the graphic to use as the icon.
Drag the graphic to the Project Editor or import it using File > Import. Icon supports pictures from any source, including those created at runtime with the Picture constructor. It also supports transparency, either by setting the Transparent property of the Picture to 1 or via the Picture's Mask.
The following code places an icon in the DesktopBevelButton, aligns it, and specifies the placement of the caption. The image, "DatabaseQuery," has been added to the project.
Me.Icon = DatabaseQuery
Me.IconAlign = 6
Me.CaptionAlign = 0
Me.CaptionPlacement = 2
Me.IconDX = 2
Me.IconDY = 1
DesktopBevelButton.IconAlignment
IconAlignment As Integer
The alignment of the Icon within the DesktopBevelButton.
The following code places an icon in the DesktopBevelButton, aligns it, and specifies the position of the caption. The graphic, "DatabaseQueryIcon," has been added to the project.
Me.Icon = DatabaseQueryIcon
Me.IconAlignment = DesktopBevelButton.IconAlignments.TopLeft
Me.CaptionAlignment = DesktopBevelButton.CaptionAlignments.Left
Me.CaptionPosition = DesktopBevelButton.CaptionPositions.RightOfIcon
Me.IconDeltaX = 2
Me.IconDeltaY = 1
DesktopBevelButton.IconDeltaX
IconDeltaX As Integer
The distance (in points) from left or right, depending on alignment. If center alignment is chosen, IconDeltaX does nothing.
The following code places an icon in the DesktopBevelButton, aligns it, and specifies the position of the caption. The graphic, "DatabaseQueryIcon," has been added to the project.
Me.Icon = DatabaseQueryIcon
Me.IconAlignment = DesktopBevelButton.IconAlignments.TopLeft
Me.CaptionAlignment = DesktopBevelButton.CaptionAlignments.Left
Me.CaptionPosition = DesktopBevelButton.CaptionPositions.RightOfIcon
Me.IconDeltaX = 2
Me.IconDeltaY = 1
DesktopBevelButton.IconDeltaY
IconDeltaY As Integer
The distance (in points) from top or bottom, depending on alignment. If center alignment is chosen, IconDeltaY does nothing.
The following code places an icon in the DesktopBevelButton, aligns it, and specifies the position of the caption. The graphic, "DatabaseQueryIcon," has been added to the project.
Me.Icon = DatabaseQueryIcon
Me.IconAlignment = DesktopBevelButton.IconAlignments.TopLeft
Me.CaptionAlignment = DesktopBevelButton.CaptionAlignments.Left
Me.CaptionPosition = DesktopBevelButton.CaptionPositions.RightOfIcon
Me.IconDeltaX = 2
Me.IconDeltaY = 1
DesktopBevelButton.Index
Index As Integer
If the control is used in a control set, this specifies the control's index in the set.
This property is read-only.
DesktopBevelButton.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.
This code in any event of a DesktopBevelButton makes italic the Caption property:
Me.Italic = True
DesktopBevelButton.Left
Left As Integer
The distance from the left side of the control to the left side of its containing window or container.
The following example moves the control 100 points from the left side of the window:
Me.Left = 150
DesktopBevelButton.LockBottom
LockBottom As Boolean
Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning window.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockBottom = True
DesktopBevelButton.LockLeft
LockLeft As Boolean
Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning window.
LockLeft and Locktop default to True when you add a new control to a window. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockLeft has no effect unless LockRight is True.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockLeft = True
DesktopBevelButton.LockRight
LockRight As Boolean
Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning window.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockRight = True
DesktopBevelButton.LockTop
LockTop As Boolean
Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning window.
LockTop and LockLeft default to True when you add a control to a window. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockTop has no effect unless LockBottom is True.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockTop = True
DesktopBevelButton.Menu
Menu As DesktopMenuItem
The button's drop-down menu.
This code in the Opening event handler of a DesktopBevelButton adds a menu to it. The first menu item is numbered zero.
Var months() As String = Array("January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December")
Me.Caption = "Month"
Me.CaptionAlignment = DesktopBevelButton.CaptionAlignments.Left
Me.MenuStyle = DesktopBevelButton.MenuStyles.Right
Var myMenu As New DesktopMenuItem
For Each m As String In months
myMenu.AddMenu(New DesktopMenuItem(m))
Next
Me.Menu = myMenu
This code in the MenuSelected event handler displays the selected menu:
MessageBox(selectedItem.Text)
DesktopBevelButton.MenuStyle
MenuStyle As MenuStyles
The style of the button's menu.
The following code sets the style of the button's menu to Down.
Me.MenuStyle = DesktopBevelButton.MenuStyles.Down
DesktopBevelButton.MouseCursor
MouseCursor As MouseCursor
The cursor to be displayed while the mouse is within the control and both the DesktopApplication and DesktopWindow class's MouseCursor properties are Nil.
If the DesktopApplication class's MouseCursor property is not Nil or the DesktopWindow's MouseCursor property is not Nil, then any control's MouseCursor property is ignored. You can use a cursor stored in the Cursors module. On Macintosh, you can also obtain a MouseCursor from a resource file.
This line in the Opening event of the control sets the default cursor to the finger pointer.
Me.MouseCursor = System.Cursors.FingerPointer
DesktopBevelButton.Name
Name As String
The name of the control. Set the name of the control in the Inspector.
This property is read-only.
DesktopBevelButton.PanelIndex
PanelIndex As Integer
If the control has been placed on a DesktopTabPanel or DesktopPagePanel control, this is the panel (page/tab) that the control is on. If the control is not on a panel, it returns -1.
The first panel is numbered zero. If the control has been placed on a panel of a DesktopTabPanel or DesktopPagePanel control, it returns the panel number. If the control is not on a DesktopPagePanel or DesktopTabPanel, it returns -1. If you change the PanelIndex to a nonexistent panel, the control will disappear until you give it a PanelIndex value that corresponds to a panel that exists.
If you are looking to change the currently selected panel (page/tab), use DesktopPagePanel.
This code displays the panel index of the control that is on the page.
MessageBox(Me.SelectedPanelIndex.ToString)
DesktopBevelButton.Parent
Parent As Object
Used to get and set the control's parent control or window.
If the control is on the window, the Parent will be the Window. If the control is on the container, the Parent will be the container. If the control is completed enclosed by another control, the Parent will be that control.
If you do not want the enclosing control to be the parent, set the Parent property of that control to Nil to make it the Window.
If the parent control is somehow in another window, an InvalidParentException will occur.
The following example sets the parent of the control to the window.
Me.Parent = Nil
DesktopBevelButton.Scope
Scope As Integer
Used to determine whether access to the control is Public (0) or Private (2). The default is Public.
This property is read-only.
Note
This is a designtime-only property and thus can only be set in the Inspector and is not accessible via code.
If the Scope of a control is set to Private, it cannot be accessed from outside its parent window.
DesktopBevelButton.TabIndex
TabIndex As Integer
The control's position in the Tab Order. The control with whose TabIndex is 0 will get the focus first.
On macOS, only controls where you enter data from the keyboard typically get the focus. In order to manually set focus to controls that don't allow keyboard entry, go to System Preferences, click on the Keyboard icon then on the Shortcuts tab and then check the Use keyboard navigation to move focus between controls checkbox.
This example sets the control's TabIndex.
Me.TabIndex = 2
DesktopBevelButton.TextColor
TextColor As ColorGroup
Gets or sets the color of the caption or the text content. The default value is black.
The following example sets the TextColor to red.
Me.TextColor = Color.Red
DesktopBevelButton.Tooltip
Tooltip As String
Text of help message displayed as a Windows or Linux "tooltip" or macOS help tag.
The tip/tag is displayed when the user hovers the mouse cursor over the control.
This example adds a tooltip to a control:
Me.Tooltip = "Click to bark."
DesktopBevelButton.Top
Top As Integer
The distance from the top of the control to the top of its containing window or container.
This example sets the top of the control to 140 points from the top of the window:
Me.Top = 140
DesktopBevelButton.Transparent
Transparent As Boolean
Determines whether the control is transparent on Windows. The default is False. Has no effect on macOS or Linux.
Transparent controls draw more slowly and use more memory in order to cache the background. Unless you absolutely require transparency, leave this set to False.
For projects that were created prior to 2018r1, this property defaults to True to emulate previous behavior. Consider changing it to False to improve performance if you do not require transparency.
DesktopBevelButton.Underline
Underline As Boolean
If True, applies the underline style to the control's caption and/or its text content if any.
This code underlines the control's text or caption property.
Me.Underline = True
This code in any event of a DesktopBevelButton underlines the Caption property:
Me.Underline = True
Me.Caption = "underlined"
DesktopBevelButton.Value
Value As Boolean
If True, the button appears depressed.
This code is in the Pressed event of a DesktopCheckBox. It toggles the state of the DesktopBevelButton depending on whether the DesktopCheckBox was checked.
If Me.Value Then
BevelButton1.Value = True
Else
BevelButton1.Value = False
End If
DesktopBevelButton.Visible
Visible As Boolean
Determines whether the control is visible when its owning window is opened. The default is True: the control is visible.
The following code makes the control invisible:
Me.Visible = False
DesktopBevelButton.Width
Width As Integer
The width (in points) of the control.
The following example resizes the control:
Me.Width = 200
DesktopBevelButton.Window
Window As DesktopWindow
The control's parent window.
This property is read-only.
This code gets the parent window's Title property.
MessageBox(Me.Window.Title)
Method descriptions
DesktopBevelButton.AcceptFileDrop
AcceptFileDrop(FileType As String)
Permits documents of type FileType to be dropped on the control. FileType must be a file type that you defined in via the FileType class or the File Type Sets Editor.
This code in the Opening event makes it possible for the user to drop either a picture or a file that is a jpeg image. The File Type Sets editor was used to define the “image/jpeg” file type. It is one of the “Common File Types” that is available in the editor.
Me.AcceptPictureDrop
Me.AcceptFileDrop("image/jpeg")
To restrict file drops to just folders (and not files), you can put this code in the DragEnter event:
If Not obj.FolderItem.IsFolder Then Return True
DesktopBevelButton.AcceptPictureDrop
AcceptPictureDrop
Permits pictures to be dropped on the control.
If a control should accept pictures in a drag and drop, then AcceptPictureDrop needs to be called prior to the drop. Typically, it is in the Opening event of the control itself. For example, the line:
Me.AcceptPictureDrop
in the Opening event of the control that will receive the dragged pictures is needed. When the picture is dropped, the DropObject event is called and this is where you will put your code to handle the drop.
Opening Event:
Me.AcceptPictureDrop
DropObject Event:
If obj.PictureAvailable Then
Me.Backdrop = obj.Picture
End If
DesktopBevelButton.AcceptRawDataDrop
AcceptRawDataDrop(Type As String)
Permits data (of the Type specified) to be dropped on the control.
The following specfies a generic file type defined in the File Type Sets editor.
Me.AcceptRawDataDrop("????")
DesktopBevelButton.AcceptTextDrop
AcceptTextDrop
Permits text to be dropped on the control.
This line in the Opening event of a control that can accept dragged text.
Me.AcceptTextDrop
DesktopBevelButton.AddActionNotificationReceiver
AddActionNotificationReceiver(theReceiver As ActionNotificationReceiver)
Registers an ActionNotificationReceiver.
DesktopBevelButton.Close
Close
Closes a control.
Closing a control permanently removes the control from memory, making it impossible to access. You can close both non-indexed controls and indexed controls. When you close an indexed control, the indexes for the remaining controls will shift downward so that the indexes start with zero and are consecutive.
The following code closes the control. When this is executed from a visible control, the control disappears from the window.
Me.Close
DesktopBevelButton.DrawInto
DrawInto(g As Graphics, x As Integer, y As Integer)
Draws the contents of the control into the specified Graphics context. The parameters x and y are the coordinates of the top, left corner.
Note
DrawInto will only work if the control is on a window or container.
This example draws the current control into the Graphics of a Picture and then displays it as the Backdrop of a Canvas:
Var p As New Picture(Me.Width, Me.Height)
Me.DrawInto(p.Graphics, 0, 0)
Canvas1.Backdrop = p
DesktopBevelButton.Refresh
Refresh(immediately As Boolean = False)
Redraws the portion specified of the contents of the control the next time the OS redraws the control or immediately if True is passed.
If you are calling this so frequently that you experience a slowdown in your code, pass True for the immediately parameter.
Calling this method causes the Render event to fire.
Refresh the entire area immediately:
Me.Refresh(True)
DesktopBevelButton.Refresh
Refresh(x As Integer, y As Integer, width As Integer, height As Integer, immediately As Boolean = False)
Redraws the portion specified of the contents of the control the next time the OS redraws the control or immediately if True is passed.
Refresh a portion of the area the next time the OS redraws the control:
Me.Refresh(100, 150, 200, 300)
DesktopBevelButton.RemoveActionNotificationReceiver
RemoveActionNotificationReceiver(theReceiver As ActionNotificationReceiver)
Unregisters an ActionNotificationReceiver.
DesktopBevelButton.SetFocus
SetFocus
If applicable, sets the focus to the DesktopUIControl. KeyDown events are directed to the control.
If the control cannot get the focus on the platform on which the application is running, SetFocus does nothing. The SetFocus method of the DesktopWindow class or the ClearFocus method can be used to remove the focus from the control that currently has the focus, leaving no control with the focus.
Note
On the Mac you need Full Keyboard Access turned on in System Preferences (Keyboard->Shortcuts) in order to manually set focus to non-text controls.
The following example in the Opening event sets the focus to the that control. If another control has the focus when this line is executed, then the user sees this control gets the focus.
Me.SetFocus
Event descriptions
DesktopBevelButton.Closing
Closing
The control is closing.
DesktopBevelButton.ConstructContextualMenu
ConstructContextualMenu(Base As DesktopMenuItem, x As Integer, y As Integer) As Boolean
This event is called when it is appropriate to display a contextual menu for the control.
This event handler is the recommended way to handle contextual menus because this event figures out whether the user has requested the contextual menu, regardless of how they did it. Depending on platform, it might be in the MouseUp or MouseDown event and it might be a right+click or by pressing the contextual menu key on the keyboard, for example.
Base is analogous to the menu bar for the contextual menu. Any items you add to Base will be shown as menu items. If you return False, the event is passed up the parent hierarchy.
If you return True, the contextual menu is displayed. The parameters x and y are the mouse locations. If the event was fired because of a non-mouse event, then x and y are both set to -1. See the example of a contextual menu in the following section.
The following ConstructContextualMenu event handler builds a menu with three menu items plus a submenu with three additional menu items.
' Add some items
base.AddMenu(New DesktopMenuItem("Test 1"))
base.AddMenu(New DesktopMenuItem("Test 2"))
base.AddMenu(New DesktopMenuItem("Test 3"))
' Add a Separator
base.AddMenu(New DesktopMenuItem(DesktopMenuItem.TextSeparator))
' Add a sub menu
Var submenu As New DesktopMenuItem("SubMenu")
submenu.AddMenu(New DesktopMenuItem("SubMenu Test 1"))
submenu.AddMenu(New DesktopMenuItem("SubMenu Test 2"))
submenu.AddMenu(New DesktopMenuItem("SubMenu Test 3"))
base.AddMenu(submenu)
' Add a Separator
base.AddMenu(New DesktopMenuItem(DesktopMenuItem.TextSeparator))
Return True
DesktopBevelButton.ContextualMenuItemSelected
ContextualMenuItemSelected(HitItem As DesktopMenuItem) As Boolean
Fires when a contextual menuitem selectedItem was selected but the MenuItemSelected event and the MenuHandler for the DesktopMenuItem did not handle the menu selection.
This event gives you a chance to handle the menu selection by inspecting the menuitem's Text or Tag properties to see which item was selected. Use this in conjunction with ConstructContextualMenu if you have not specified the MenuItemSelected event or the Menu Handler for the items on the contextual menu. See the example of a contextual menu in the examples for the DesktopUIControl class.
Return True if this event has handled the item the user chose from the contextual menu. Returning False will cause the control's parent to execute its ContextualMenuItemSelected event. This can be handy if you have the same contextual menu for several controls who share the same Parent (several on the same window for example). By returning False you can handle them all in a single event.
This simple event handler displays the value of the selected menu item.
If selectedItem <> Nil Then MessageBox(selectedItem.Text)
Return True
DesktopBevelButton.DragEnter
DragEnter(obj As DragItem, Action As DragItem.Types) As Boolean
Fires when the passed DragItem enters the DesktopUIControl.
Returns a Boolean. Return True from this event to prevent the drop from occurring.
The Action parameter specifies the type of drag action.
To restrict file drops to just folders (and not files), you can put this code in the DragEnter event:
If Not obj.FolderItem.IsFolder Then Return True
DesktopBevelButton.DragExit
DragExit(obj As DragItem, Action As DragItem.Types)
Fires when the passed DragItem exits the DesktopUIControl.
The Obj parameter is the item being dragged. The Action parameter specifies the type of drag action.
DesktopBevelButton.DragOver
DragOver(x As Integer, y As Integer, obj As DragItem, Action As DragItem.Types) As Boolean
Fires when the DragItem is over the DesktopUIControl.
The Obj parameter is the object being dragged. The coordinates x and y are relative to the DesktopUIControl. Returns a Boolean. Return True from this event to prevent the drop from occurring.
The Action parameter specifies the type of drag action, which is typically done by holding down a modifier key (Shift, Alt, Option, Command, etc.) while doing the drag.
DesktopBevelButton.DropObject
DropObject(Obj As DragItem Action As DragItem.Types)
The item represented by Obj has been dropped on the control.
The Obj parameter is the object being dragged. The Action parameter specifies the type of drag action.
The following DropObject event handler can handle either a dropped picture or a dropped file. The type of file that it can handle needs to have been specified in a call to AcceptFileDrop prior to the drop, for example, in the Opening event.
If Obj.PictureAvailable Then
Me.Image = obj.Picture
ElseIf Obj.FolderItemAvailable Then
Me.Image = Picture.Open(obj.FolderItem)
End If
DesktopBevelButton.FocusLost
FocusLost
The control has lost the focus.
Note
On macOS, controls other than text fields and lists will accept and lose focus only if the full keyboard access option is enabled in System Preferences/Keyboard.
DesktopBevelButton.FocusReceived
FocusReceived
The control has received the focus and has a selection rectangle around it.
Note
On macOS, controls other than text fields and lists will accept focus only if the full keyboard access option is enabled in System Preferences/Keyboard.
DesktopBevelButton.KeyDown
KeyDown(Key As String) As Boolean
The user has pressed the Key passed while the control has the focus.
Returning True prevents the KeyDown event on the parent control (usually the window) from executing. Returning False results in the execution of the KeyDown event of the parent control.
DesktopBevelButton.KeyUp
KeyUp(Key As String)
Fires when the passed Key is released in the control that has the focus.
It is not guaranteed to be the same key that received the KeyDown event.
DesktopBevelButton.MenuSelected
MenuSelected(selectedItem As DesktopMenuItem)
The user has selected a menu item from the button's menu.
DesktopBevelButton.MouseDown
MouseDown(X As Integer, Y As Integer) As Boolean
The mouse button was pressed inside the control's region at the location passed in to x, y.
This event fires repeatedly while the mouse button is being held down.
The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the control.
Return True if you are going to handle the MouseDown. In such a case:
The Pressed event, if any, will not execute and the state of the object will not change.
You will receive the MouseUp event.
If you return False, the system handles the MouseDown so the MouseUp event handler do not get called.
The MouseDown event uses the DragItem constructor when the user drags the contents of the control. It is:
Var d As DragItem
d = New DragItem(Self, Me.Left, Me.Top, Me.Width, Me.Height)
d.Picture = Me.Image
d.Drag ' Allow the drag
DesktopBevelButton.MouseDrag
MouseDrag(X As Integer, Y As Integer)
The mouse button was pressed inside the control and moved (dragged) at the location local to the control passed in to x, y.
This event fires repeatedly while the mouse button is down regardless of whether or not the mouse coordinates are changing.
This event will not occur unless you return True in the MouseDown event.
DesktopBevelButton.MouseEnter
MouseEnter
The mouse has entered the area of the control.
DesktopBevelButton.MouseExit
MouseExit
The mouse has left the area of the control.
DesktopBevelButton.MouseMove
MouseMove(X As Integer, Y As Integer)
The mouse has moved within the control to the coordinates passed. The coordinates are local to the control, not to the window.
DesktopBevelButton.MouseUp
MouseUp(X As Integer, Y As Integer)
The mouse button was released. Use the x and y parameters to determine if the mouse button was released within the control's boundaries.
Note
This event will not occur unless you return True in the MouseDown event. The return value is ignored.
The parameters x and y are local coordinates, i.e. they represent the position of the mouse click relative to the upper-left corner or the control. Mouse clicks that are released to the left or above a control are negative.
DesktopBevelButton.MouseWheel
MouseWheel(X As Integer, Y As Integer, DeltaX As Integer, DeltaY As Integer) As Boolean
The mouse wheel has been moved.
The parameters X and Y are the mouse coordinates relative to the control that has received the event. The parameters DeltaX and DeltaY hold the number of scroll lines the wheel has been moved horizontally and vertically, as defined by the operating system. DeltaX is positive when the user scrolls right and negative when scrolling to the left. DeltaY is positive when the user scrolls down and negative when scrolling up.
Returns a Boolean. Return True to prevent the event from propagating further.
DesktopBevelButton.Opening
Opening
The control is about to be displayed. Use this event to initialize a control.
The Opening event is called after the Constructor.
Be warned that initializing control property values using the Constructor instead of the Opening event may result in those property values being overwritten by what is set in the Inspector. For best results, use the Opening event for control initialization rather than the control Constructor.
If the control is supposed to handle drag and drop, you need to tell it which type of item it needs to be able to handle. The following example informs the control that pictures and files can be dropped on it. The type of the file it needs to support is specified via the File Types Editor.
Sub Opening()
Me.AcceptPictureDrop
Me.AcceptFileDrop("JPEG")
End Sub
DesktopBevelButton.Pressed
Pressed
The DesktopBevelButton has been pressed.
This code displays text in a DesktopLabel when the button is pressed.
TextField1.Text = Me.TrueWindow.Title
Notes
Note
On macOS, DesktopBevelButton is not a native control and does not automatically change its appearance in dark mode.
A DesktopBevelButton can display a graphic, a label (caption), or both.
The "No Bevel" option for the BevelStyle property is functional only on Microsoft Windows. On platforms with cursor, the button appears to have no border until the cursor enters the bounds of the BevelButton control. Then the outline of the button appears. On non-Windows systems, the "No Bevel" option has the same appearance of "Small Bevel."
Sample code
The following code places an icon in the DesktopBevelButton, aligns it, and specifies the position of the caption. The graphic, "DatabaseQueryIcon," has been added to the project.
Me.Icon = DatabaseQueryIcon
Me.IconAlignment = DesktopBevelButton.IconAlignments.TopLeft
Me.CaptionAlignment = DesktopBevelButton.CaptionAlignments.Left
Me.CaptionPosition = DesktopBevelButton.CaptionPositions.RightOfIcon
Me.IconDeltaX = 2
Me.IconDeltaY = 1
The following code creates a bevel button menu.
Var months() As String = Array("January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December")
me.Caption = "Month"
me.CaptionAlignment = DesktopBevelButton.CaptionAlignments.Left
me.MenuStyle = DesktopBevelButton.MenuStyles.Right
Var myMenu As New DesktopMenuItem
For Each m As String In months
myMenu.AddMenu(New DesktopMenuItem(m))
Next m
me.Menu = myMenu
The following line of code in the DesktopBevelButton's MenuSelected event handler sets the DesktopBevelButton caption to the value that the user selects:
Me.Caption = SelectedItem.Text
Compatibility
Desktop projects on all supported operating systems.
See also
DesktopUIControl parent class; DesktopComboBox, DesktopPopupMenu, DesktopButton controls.