RadioButtonRenderer Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides methods used to render an option button control (also known as a radio button) with or without visual styles. This class cannot be inherited.
public ref class RadioButtonRenderer sealedpublic ref class RadioButtonRenderer abstract sealedpublic sealed class RadioButtonRendererpublic static class RadioButtonRenderertype RadioButtonRenderer = classPublic NotInheritable Class RadioButtonRendererPublic Class RadioButtonRenderer- Inheritance
-
RadioButtonRenderer
Examples
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.
#using <System.Drawing.dll>
#using <System.Windows.Forms.dll>
#using <System.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::Windows::Forms;
using namespace System::Windows::Forms::VisualStyles;
namespace RadioButtonRendererSample
{
public ref class CustomRadioButton : public Control
{
private:
Rectangle textRectangleValue;
private:
bool clicked;
private:
RadioButtonState state;
public:
CustomRadioButton() : Control()
{
textRectangleValue = Rectangle();
state = RadioButtonState::UncheckedNormal;
this->Location = Point(50, 50);
this->Size = System::Drawing::Size(100, 20);
this->Text = "Click here";
this->Font = SystemFonts::IconTitleFont;
}
// Define the text bounds so that the text rectangle
// does not include the radio button.
public:
property Rectangle TextRectangle
{
Rectangle get()
{
Graphics^ g = this->CreateGraphics();
textRectangleValue.X = ClientRectangle.X +
RadioButtonRenderer::GetGlyphSize(g,
RadioButtonState::UncheckedNormal).Width;
textRectangleValue.Y = ClientRectangle.Y;
textRectangleValue.Width = ClientRectangle.Width -
RadioButtonRenderer::GetGlyphSize(g,
RadioButtonState::UncheckedNormal).Width;
textRectangleValue.Height = ClientRectangle.Height;
delete g;
return textRectangleValue;
}
}
// Draw the radio button in the current state.
protected:
virtual void OnPaint(PaintEventArgs^ e) override
{
__super::OnPaint(e);
RadioButtonRenderer::DrawRadioButton(e->Graphics,
ClientRectangle.Location, TextRectangle, this->Text,
this->Font, clicked, state);
}
// Draw the radio button in the checked or unchecked state.
protected:
virtual void OnMouseDown(MouseEventArgs^ e) override
{
__super::OnMouseDown(e);
if (!clicked)
{
clicked = true;
this->Text = "Clicked!";
state = RadioButtonState::CheckedPressed;
Invalidate();
}
else
{
clicked = false;
this->Text = "Click here";
state = RadioButtonState::UncheckedNormal;
Invalidate();
}
}
// Draw the radio button in the hot state.
protected:
virtual void OnMouseHover(EventArgs^ e) override
{
__super::OnMouseHover(e);
state = clicked ? RadioButtonState::CheckedHot :
RadioButtonState::UncheckedHot;
Invalidate();
}
// Draw the radio button in the hot state.
protected:
virtual void OnMouseUp(MouseEventArgs^ e) override
{
__super::OnMouseUp(e);
this->OnMouseHover(e);
}
// Draw the radio button in the normal (i.e. not hot) state
protected:
virtual void OnMouseLeave(EventArgs^ e) override
{
__super::OnMouseLeave(e);
state = clicked ? RadioButtonState::CheckedNormal :
RadioButtonState::UncheckedNormal;
Invalidate();
}
};
public ref class Form1 : public Form
{
public:
Form1() : Form()
{
Controls->Add(gcnew CustomRadioButton());
if (Application::RenderWithVisualStyles)
{
this->Text = "Visual Styles Enabled";
}
else
{
this->Text = "Visual Styles Disabled";
}
}
};
}
[STAThread]
int 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(gcnew RadioButtonRendererSample::Form1());
}
using System;
using System.Drawing;
using System.Windows.Forms;
using System.Windows.Forms.VisualStyles;
namespace RadioButtonRendererSample
{
class Form1 : Form
{
Button button1 = new Button();
public Form1()
: base()
{
CustomRadioButton RadioButton1 = new CustomRadioButton();
button1.Location = new System.Drawing.Point(175, 231);
button1.Size = new System.Drawing.Size(105, 23);
button1.Text = "Toggle Style";
button1.Click += new System.EventHandler(this.button1_Click);
Controls.Add(RadioButton1);
Controls.Add(button1);
if (Application.RenderWithVisualStyles)
this.Text = "Visual Styles Enabled";
else
this.Text = "Visual Styles Disabled";
}
[STAThread]
static void 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());
}
private void button1_Click(object sender, EventArgs e)
{
Application.VisualStyleState =
Application.VisualStyleState ^
VisualStyleState.ClientAndNonClientAreasEnabled;
GroupBoxRenderer.RenderMatchingApplicationState = true;
if (Application.RenderWithVisualStyles)
this.Text = "Visual Styles Enabled";
else
this.Text = "Visual Styles Disabled";
}
}
public class CustomRadioButton : Control
{
private Rectangle textRectangleValue = new Rectangle();
private bool clicked = false;
private RadioButtonState state = RadioButtonState.UncheckedNormal;
public CustomRadioButton()
: base()
{
this.Location = new Point(50, 50);
this.Size = new Size(100, 20);
this.Text = "Click here";
this.Font = SystemFonts.IconTitleFont;
}
// Define the text bounds so that the text rectangle
// does not include the radio button.
public Rectangle TextRectangle
{
get
{
using (Graphics g = this.CreateGraphics())
{
textRectangleValue.X = ClientRectangle.X +
RadioButtonRenderer.GetGlyphSize(g,
RadioButtonState.UncheckedNormal).Width;
textRectangleValue.Y = ClientRectangle.Y;
textRectangleValue.Width = ClientRectangle.Width -
RadioButtonRenderer.GetGlyphSize(g,
RadioButtonState.UncheckedNormal).Width;
textRectangleValue.Height = ClientRectangle.Height;
}
return textRectangleValue;
}
}
// Draw the radio button in the current state.
protected override void OnPaint(PaintEventArgs e)
{
base.OnPaint(e);
RadioButtonRenderer.DrawRadioButton(e.Graphics,
ClientRectangle.Location, TextRectangle, this.Text,
this.Font, clicked, state);
}
// Draw the radio button in the checked or unchecked state.
protected override void OnMouseDown(MouseEventArgs e)
{
base.OnMouseDown(e);
if (!clicked)
{
clicked = true;
this.Text = "Clicked!";
state = RadioButtonState.CheckedPressed;
Invalidate();
}
else
{
clicked = false;
this.Text = "Click here";
state = RadioButtonState.UncheckedNormal;
Invalidate();
}
}
// Draw the radio button in the hot state.
protected override void OnMouseHover(EventArgs e)
{
base.OnMouseHover(e);
state = clicked ? RadioButtonState.CheckedHot :
RadioButtonState.UncheckedHot;
Invalidate();
}
// Draw the radio button in the hot state.
protected override void OnMouseUp(MouseEventArgs e)
{
base.OnMouseUp(e);
this.OnMouseHover(e);
}
// Draw the radio button in the unpressed state.
protected override void OnMouseLeave(EventArgs e)
{
base.OnMouseLeave(e);
state = clicked ? RadioButtonState.CheckedNormal :
RadioButtonState.UncheckedNormal;
Invalidate();
}
}
}
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
' 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
Remarks
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.
Properties
| RenderMatchingApplicationState |
Gets or sets a value indicating whether the renderer uses the application state to determine rendering style. |
Methods
| DrawParentBackground(Graphics, Rectangle, Control) |
Draws the background of a control's parent in the specified area. |
| DrawRadioButton(Graphics, Point, RadioButtonState) |
Draws an option button control (also known as a radio button) in the specified state and location. |
| DrawRadioButton(Graphics, Point, Rectangle, String, Font, Boolean, RadioButtonState) |
Draws an option button control (also known as a radio button) in the specified state and location, with the specified text, and with an optional focus rectangle. |
| DrawRadioButton(Graphics, Point, Rectangle, String, Font, Image, Rectangle, Boolean, RadioButtonState) |
Draws an option button control (also known as a radio button) in the specified state and location, with the specified text and image, and with an optional focus rectangle. |
| DrawRadioButton(Graphics, Point, Rectangle, String, Font, TextFormatFlags, Boolean, RadioButtonState) |
Draws an option button control (also known as a radio button) in the specified state and location, with the specified text and text formatting, and with an optional focus rectangle. |
| DrawRadioButton(Graphics, Point, Rectangle, String, Font, TextFormatFlags, Image, Rectangle, Boolean, RadioButtonState) |
Draws an option button control (also known as a radio button) in the specified state and location; with the specified text, text formatting, and image; and with an optional focus rectangle. |
| GetGlyphSize(Graphics, RadioButtonState) |
Returns the size, in pixels, of the option button (also known as a radio button) glyph. |
| IsBackgroundPartiallyTransparent(RadioButtonState) |
Indicates whether the background of the option button (also known as a radio button) has semitransparent or alpha-blended pieces. |
Applies to
See also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
