RadioButtonRenderer Class
Assembly: System.Windows.Forms (in system.windows.forms.dll)
The RadioButtonRenderer class provides a set of static methods that can be used to render an option button control. Rendering a control refers to drawing the user interface of a control. To draw an option button, use one of the DrawRadioButton methods. These methods provide a variety of options, such as drawing text or an image with the option button.
If visual styles are enabled in the operating system and visual styles are applied to the current application, DrawRadioButton will draw the option button with the current visual style. Otherwise, DrawRadioButton will draw the option button with the classic Windows style. This is useful if you are drawing a custom control that should automatically match the current visual style setting of the operating system.
This class wraps the functionality of a System.Windows.Forms.VisualStyles.VisualStyleRenderer that is set to one of the elements exposed by the System.Windows.Forms.VisualStyles.VisualStyleElement.Button.RadioButton class. For more information, see Rendering Controls with Visual Styles.
Windows XP Home Edition, Windows XP Professional x64 Edition, Windows Server 2003 Platform Note: Visual styles are supported only on these platforms.
The following code example demonstrates how to write a custom control that uses the DrawRadioButton method to draw an option button that responds to mouse clicks.
Imports System Imports System.Drawing Imports System.Windows.Forms Imports System.Windows.Forms.VisualStyles Namespace RadioButtonRendererSample Class Form1 Inherits Form Dim WithEvents button1 As Button Public Sub New() Dim RadioButton1 As New CustomRadioButton() button1 = New Button Me.button1.Location = New System.Drawing.Point(185, 231) Me.button1.Size = New System.Drawing.Size(105, 23) Me.button1.Text = "Toggle Styles" Controls.Add(RadioButton1) Controls.Add(button1) If Application.RenderWithVisualStyles Then Me.Text = "Visual Styles Enabled" Else Me.Text = "Visual Styles Disabled" End If End Sub <STAThread()> _ Shared Sub Main() ' If you do not call EnableVisualStyles below, then ' RadioButtonRenderer.DrawRadioButton automatically detects ' this and draws the radio button without visual styles. Application.EnableVisualStyles() Application.Run(New Form1()) End Sub ' Match application style and toggle visual styles off ' and on for the application. Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) _ Handles button1.Click RadioButtonRenderer.RenderMatchingApplicationState = True Application.VisualStyleState = _ Application.VisualStyleState Xor _ VisualStyleState.ClientAndNonClientAreasEnabled If Application.RenderWithVisualStyles Then Me.Text = "Visual Styles Enabled" Else Me.Text = "Visual Styles Disabled" End If End Sub End Class Public Class CustomRadioButton Inherits Control Private textRectangleValue As New Rectangle() Private clicked As Boolean = False Private state As RadioButtonState = RadioButtonState.UncheckedNormal Public Sub New() With Me .Location = New Point(50, 50) .Size = New Size(100, 20) .Text = "Click here" .Font = SystemFonts.IconTitleFont End With End Sub 'New ' Define the text bounds so that the text rectangle ' does not include the radio button. Public ReadOnly Property TextRectangle() As Rectangle Get Using g As Graphics = Me.CreateGraphics() With textRectangleValue .X = Me.ClientRectangle.X + _ RadioButtonRenderer.GetGlyphSize(g, _ RadioButtonState.UncheckedNormal).Width .Y = Me.ClientRectangle.Y .Width = Me.ClientRectangle.Width - _ RadioButtonRenderer.GetGlyphSize(g, _ RadioButtonState.UncheckedNormal).Width .Height = Me.ClientRectangle.Height End With End Using Return textRectangleValue End Get End Property ' Draw the radio button in the current state. Protected Overrides Sub OnPaint(ByVal e As PaintEventArgs) MyBase.OnPaint(e) RadioButtonRenderer.DrawRadioButton(e.Graphics, _ Me.ClientRectangle.Location, TextRectangle, Me.Text, _ Me.Font, clicked, state) End Sub ' Draw the radio button in the checked or unchecked state. Protected Overrides Sub OnMouseDown(ByVal e As MouseEventArgs) MyBase.OnMouseDown(e) If Not clicked Then clicked = True Me.Text = "Clicked!" state = RadioButtonState.CheckedPressed Invalidate() Else clicked = False Me.Text = "Click here" state = RadioButtonState.UncheckedNormal Invalidate() End If End Sub ' Draw the radio button in the hot state. Protected Overrides Sub OnMouseHover(ByVal e As EventArgs) MyBase.OnMouseHover(e) If clicked Then state = RadioButtonState.CheckedHot Else state = RadioButtonState.UncheckedHot End If Invalidate() End Sub ' Draw the radio button in the hot state. Protected Overrides Sub OnMouseUp(ByVal e As MouseEventArgs) MyBase.OnMouseUp(e) Me.OnMouseHover(e) End Sub ' Draw the radio button in the unpressed state. Protected Overrides Sub OnMouseLeave(ByVal e As EventArgs) MyBase.OnMouseLeave(e) If clicked Then state = RadioButtonState.CheckedNormal Else state = RadioButtonState.UncheckedNormal End If Invalidate() End Sub End Class End Namespace
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.