ButtonRenderer クラス

定義

ビジュアル スタイルの有無に関係なくボタン コントロールをレンダリングするために使用されるメソッドを提供します。 このクラスは継承できません。

public ref class ButtonRenderer sealed
public sealed class ButtonRenderer
type ButtonRenderer = class
Public NotInheritable Class ButtonRenderer
継承
ButtonRenderer

次のコード例では、 DrawButton メソッドを使用してボタンを描画するカスタム コントロールを作成する方法を示します。 ボタンがクリックされると、コントロールは元のボタンの境界内に小さいボタンを描画し、コントロールは DrawParentBackground メソッドを使用して元のボタンの残りの部分に描画します。

#using <System.dll>
#using <System.Drawing.dll>
#using <System.Windows.Forms.dll>

using namespace System;
using namespace System::Drawing;
using namespace System::Windows::Forms;
using namespace System::Windows::Forms::VisualStyles;

namespace ButtonRendererSample
{
    public ref class CustomButton : public Control
    {
    private:
        Rectangle clickRectangleValue;

    private:
        PushButtonState state;

    public:
        CustomButton()
        {
            __super::Control();
            this->Size = System::Drawing::Size(100, 40);
            this->Location = Point(50, 50);
            this->Font = SystemFonts::IconTitleFont;
            this->Text = "Click here";
            clickRectangleValue = Rectangle();
            state = PushButtonState::Normal;
        }

        // Define the bounds of the smaller pressed button.
    public:
        property Rectangle ClickRectangle
        {
            Rectangle get()
            {
                clickRectangleValue.X = ClientRectangle.X +
                    (int)(.2 * ClientRectangle.Width);
                clickRectangleValue.Y = ClientRectangle.Y +
                    (int)(.2 * ClientRectangle.Height);
                clickRectangleValue.Width = ClientRectangle.Width -
                    (int)(.4 * ClientRectangle.Width);
                clickRectangleValue.Height = ClientRectangle.Height -
                    (int)(.4 * ClientRectangle.Height);

                return clickRectangleValue;
            }
        }

        // Draw the large or small button, depending on the current state.
    protected:
        virtual void OnPaint(PaintEventArgs^ e) override
        {
            __super::OnPaint(e);

            // Draw the smaller pressed button image
            if (state == PushButtonState::Pressed)
            {
                // Set the background color to the parent if visual styles
                // are disabled, because DrawParentBackground will only paint
                // over the control background if visual styles are enabled.
                if (Application::RenderWithVisualStyles)
                {
                    this->BackColor = Color::Azure;
                }
                else
                {
                    this->BackColor = this->Parent->BackColor;
                }


                // If you comment out the call to DrawParentBackground,
                // the background of the control will still be visible
                // outside the pressed button, if visual styles are enabled.
                ButtonRenderer::DrawParentBackground(e->Graphics,
                    ClientRectangle, this);
                ButtonRenderer::DrawButton(e->Graphics, ClickRectangle,
                    this->Text, this->Font, true, state);
            }

            // Draw the bigger unpressed button image.
            else
            {
                ButtonRenderer::DrawButton(e->Graphics, ClientRectangle,
                    this->Text, this->Font, false, state);
            }
        }

        // Draw the smaller pressed button image.
    protected:
        virtual void OnMouseDown(MouseEventArgs^ e) override
        {
            __super::OnMouseDown(e);
            this->Text = "Clicked!";
            state = PushButtonState::Pressed;
            Invalidate();
        }

        // Draw the button in the hot state.
    protected:
        virtual void OnMouseEnter(EventArgs^ e) override
        {
            __super::OnMouseEnter(e);
            this->Text = "Click here";
            state = PushButtonState::Hot;
            Invalidate();
        }

        // Draw the button in the unpressed state.
    protected:
        virtual void OnMouseLeave(EventArgs^ e) override
        {
            __super::OnMouseLeave(e);
            this->Text = "Click here";
            state = PushButtonState::Normal;
            Invalidate();
        }

        // Draw the button hot if the mouse is released on the button.
    protected:
        virtual void OnMouseUp(MouseEventArgs^ e) override
        {
            __super::OnMouseUp(e);
            OnMouseEnter(e);
        }

        // Detect when the cursor leaves the button area while
        // it is pressed.
    protected:
        virtual void OnMouseMove(MouseEventArgs^ e) override
        {
            __super::OnMouseMove(e);

            // Detect when the left mouse button is down and
            // the cursor has left the pressed button area.
            if ((e->Button & ::MouseButtons::Left) == ::MouseButtons::Left &&
                !ClientRectangle.Contains(e->Location) &&
                state == PushButtonState::Pressed)
            {
                OnMouseLeave(e);
            }
        }
    };

    ref class Form1 : public Form
    {
    public:
        Form1()
        {
            __super::Form();
            CustomButton^ Button1 = gcnew CustomButton();
            Controls->Add(Button1);

            if (Application::RenderWithVisualStyles)
            {
                this->Text = "Visual Styles Enabled";
            }
            else
            {
                this->Text = "Visual Styles Disabled";
            }
        }
    };   
}

using namespace ButtonRendererSample;

[STAThread]
int main()
{ 
    // If you do not call EnableVisualStyles below, then
    // ButtonRenderer automatically detects this and draws
    // the button without visual styles.
    Application::EnableVisualStyles();
    Application::Run(gcnew Form1());
}
using System;
using System.Drawing;
using System.Windows.Forms;
using System.Windows.Forms.VisualStyles;

namespace ButtonRendererSample
{
    class Form1 : Form
    {
        public Form1()
            : base()
        {
            CustomButton Button1 = new CustomButton();
            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   
            // ButtonRenderer automatically detects this and draws
            // the button without visual styles.
            Application.EnableVisualStyles();
            Application.Run(new Form1());
        }
    }

    public class CustomButton : Control
    {
        private Rectangle clickRectangleValue = new Rectangle();
        private PushButtonState state = PushButtonState.Normal;

        public CustomButton()
            : base()
        {
            this.Size = new Size(100, 40);
            this.Location = new Point(50, 50);
            this.Font = SystemFonts.IconTitleFont;
            this.Text = "Click here";
        }

        // Define the bounds of the smaller pressed button.
        public Rectangle ClickRectangle
        {
            get
            {
                clickRectangleValue.X = ClientRectangle.X +
                    (int)(.2 * ClientRectangle.Width);
                clickRectangleValue.Y = ClientRectangle.Y +
                    (int)(.2 * ClientRectangle.Height);
                clickRectangleValue.Width = ClientRectangle.Width -
                    (int)(.4 * ClientRectangle.Width);
                clickRectangleValue.Height = ClientRectangle.Height -
                    (int)(.4 * ClientRectangle.Height);

                return clickRectangleValue;
            }
        }

        // Draw the large or small button, depending on the current state.
        protected override void OnPaint(PaintEventArgs e)
        {
            base.OnPaint(e);

            // Draw the smaller pressed button image
            if (state == PushButtonState.Pressed)
            {
                // Set the background color to the parent if visual styles  
                // are disabled, because DrawParentBackground will only paint  
                // over the control background if visual styles are enabled.
                this.BackColor = Application.RenderWithVisualStyles ?
                    Color.Azure : this.Parent.BackColor;

                // If you comment out the call to DrawParentBackground, 
                // the background of the control will still be visible 
                // outside the pressed button, if visual styles are enabled.
                ButtonRenderer.DrawParentBackground(e.Graphics,
                    ClientRectangle, this);
                ButtonRenderer.DrawButton(e.Graphics, ClickRectangle,
                    this.Text, this.Font, true, state);
            }

            // Draw the bigger unpressed button image.
            else
            {
                ButtonRenderer.DrawButton(e.Graphics, ClientRectangle,
                    this.Text, this.Font, false, state);
            }
        }

        // Draw the smaller pressed button image.
        protected override void OnMouseDown(MouseEventArgs e)
        {
            base.OnMouseDown(e);
            this.Text = "Clicked!";
            state = PushButtonState.Pressed;
            Invalidate();
        }

        // Draw the button in the hot state. 
        protected override void OnMouseEnter(EventArgs e)
        {
            base.OnMouseEnter(e);
            this.Text = "Click here";
            state = PushButtonState.Hot;
            Invalidate();
        }

        // Draw the button in the unpressed state.
        protected override void OnMouseLeave(EventArgs e)
        {
            base.OnMouseLeave(e);
            this.Text = "Click here";
            state = PushButtonState.Normal;
            Invalidate();
        }

        // Draw the button hot if the mouse is released on the button. 
        protected override void OnMouseUp(MouseEventArgs e)
        {
            base.OnMouseUp(e);
            OnMouseEnter(e);
        }

        // Detect when the cursor leaves the button area while 
        // it is pressed.
        protected override void OnMouseMove(MouseEventArgs e)
        {
            base.OnMouseMove(e);

            // Detect when the left mouse button is down and   
            // the cursor has left the pressed button area. 
            if ((e.Button & MouseButtons.Left) == MouseButtons.Left &&
                !ClientRectangle.Contains(e.Location) &&
                state == PushButtonState.Pressed)
            {
                OnMouseLeave(e);
            }
        }
    }
}
Imports System.Drawing
Imports System.Windows.Forms
Imports System.Windows.Forms.VisualStyles

Namespace ButtonRendererSample
    Class Form1
        Inherits Form

        Public Sub New()
            Dim Button1 As New CustomButton()
            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  
            ' ButtonRenderer automatically detects this and draws
            ' the button without visual styles.
            Application.EnableVisualStyles()
            Application.Run(New Form1())
        End Sub
    End Class

    Public Class CustomButton
        Inherits Control

        Private clickRectangleValue As New Rectangle()
        Private state As PushButtonState = PushButtonState.Normal

        Public Sub New()
            With Me
                Size = New Size(100, 40)
                Location = New Point(50, 50)
                Font = SystemFonts.IconTitleFont
                Text = "Click here"
            End With
        End Sub

        ' Define the bounds of the smaller pressed button.
        Public ReadOnly Property ClickRectangle() As Rectangle
            Get
                With clickRectangleValue
                    .X = Me.ClientRectangle.X + CInt(0.2 * _
                        Me.ClientRectangle.Width)
                    .Y = Me.ClientRectangle.Y + CInt(0.2 * _
                        Me.ClientRectangle.Height)
                    .Width = Me.ClientRectangle.Width - _
                        CInt(0.4 * Me.ClientRectangle.Width)
                    .Height = Me.ClientRectangle.Height - _
                        CInt(0.4 * Me.ClientRectangle.Height)
                End With
                Return clickRectangleValue
            End Get
        End Property

        ' Draw the large or small button, depending on the current state.
        Protected Overrides Sub OnPaint(ByVal e As PaintEventArgs)
            MyBase.OnPaint(e)

            ' Draw the smaller pressed button image.
            If state = PushButtonState.Pressed Then
                ' Set the background color to the parent if visual styles  
                ' are disabled, because DrawParentBackground will only paint  
                ' over the control background if visual styles are enabled.
                If Application.RenderWithVisualStyles Then
                    Me.BackColor = Color.Azure
                Else
                    Me.BackColor = Me.Parent.BackColor
                End If

                ' If you comment out the call to DrawParentBackground,   
                ' the background of the control will still be visible 
                ' outside the pressed button, if visual styles are enabled.
                ButtonRenderer.DrawParentBackground(e.Graphics, _
                    Me.ClientRectangle, Me)
                ButtonRenderer.DrawButton(e.Graphics, ClickRectangle, _
                    Me.Text, Me.Font, True, state)

            ' Draw the bigger unpressed button image.
            Else
                ButtonRenderer.DrawButton(e.Graphics, Me.ClientRectangle, _
                    Me.Text, Me.Font, False, state)
            End If
        End Sub

        ' Draw the smaller pressed button image.
        Protected Overrides Sub OnMouseDown(ByVal e As MouseEventArgs)
            MyBase.OnMouseDown(e)
            With Me
                .Text = "Clicked!"
                .state = PushButtonState.Pressed
            End With
            Invalidate()
        End Sub

        ' Draw the button in the hot state. 
        Protected Overrides Sub OnMouseEnter(ByVal e As EventArgs)
            MyBase.OnMouseEnter(e)
            With Me
                .Text = "Click here"
                .state = PushButtonState.Hot
            End With
            Invalidate()
        End Sub

        ' Draw the button in the unpressed state.
        Protected Overrides Sub OnMouseLeave(ByVal e As EventArgs)
            MyBase.OnMouseLeave(e)
            With Me
                .Text = "Click here"
                .state = PushButtonState.Normal
            End With
            Invalidate()
        End Sub

        ' Draw the button hot if the mouse is released on the button.
        Protected Overrides Sub OnMouseUp(ByVal e As MouseEventArgs)
            MyBase.OnMouseUp(e)
            OnMouseEnter(e)
        End Sub

        ' Detect when the cursor leaves the button area while it 
        ' is pressed.
        Protected Overrides Sub OnMouseMove(ByVal e As MouseEventArgs)
            MyBase.OnMouseMove(e)

            ' Detect when the left mouse button is down and   
            ' the cursor has left the pressed button area. 
            If (e.Button And MouseButtons.Left) = MouseButtons.Left And Not _
                Me.ClientRectangle.Contains(e.Location) And _
                state = PushButtonState.Pressed Then
                OnMouseLeave(e)
            End If
        End Sub

    End Class
End Namespace

注釈

ButtonRenderer クラスは、ボタン コントロールのレンダリングに使用できる一連のstatic メソッドを提供します。 コントロールのレンダリングは、コントロールのユーザー インターフェイスを描画することを指します。 ボタンを描画するには、 DrawButton メソッドのいずれかを使用します。 これらのメソッドは、テキストの描画やボタン上の画像など、さまざまなオプションを提供します。

オペレーティング システムでビジュアル スタイルが有効になっていて、visual スタイルが現在のアプリケーションに適用されている場合、 DrawButton は現在の表示スタイルでボタンを描画します。 それ以外の場合、DrawButton はクラシック Windows スタイルでボタンを描画します。 これは、オペレーティング システムの現在のビジュアル スタイル設定に自動的に一致するカスタム コントロールを描画する場合に便利です。

このクラスは、System.Windows.Forms.VisualStyles.VisualStyleRenderer クラスによって公開される要素のいずれかに設定されているSystem.Windows.Forms.VisualStyles.VisualStyleElement.Button.PushButtonの機能をラップします。 詳細については、「 表示スタイルを使用したコントロールのレンダリング」を参照してください

プロパティ

名前 説明
RenderMatchingApplicationState

レンダラーがアプリケーションの状態を使用してレンダリング スタイルを決定するかどうかを示す値を取得または設定します。

メソッド

名前 説明
DrawButton(Graphics, Rectangle, Boolean, PushButtonState)

ボタン コントロールを指定した状態と境界に描画し、オプションのフォーカス四角形を使用します。

DrawButton(Graphics, Rectangle, Image, Rectangle, Boolean, PushButtonState)

ボタン コントロールを、指定したイメージを使用して、オプションのフォーカス四角形を使用して、指定した状態と境界内に描画します。

DrawButton(Graphics, Rectangle, PushButtonState)

指定した状態と境界にボタン コントロールを描画します。

DrawButton(Graphics, Rectangle, String, Font, Boolean, PushButtonState)

指定したテキストと、オプションのフォーカス四角形を使用して、指定した状態と境界内にボタン コントロールを描画します。

DrawButton(Graphics, Rectangle, String, Font, Image, Rectangle, Boolean, PushButtonState)

指定したテキストと画像、およびオプションのフォーカス四角形を使用して、指定した状態と境界内にボタン コントロールを描画します。

DrawButton(Graphics, Rectangle, String, Font, TextFormatFlags, Boolean, PushButtonState)

指定したテキストとテキストの書式設定、およびオプションのフォーカス四角形を使用して、指定した状態と境界内にボタン コントロールを描画します。

DrawButton(Graphics, Rectangle, String, Font, TextFormatFlags, Image, Rectangle, Boolean, PushButtonState)

指定した状態と境界にボタン コントロールを描画します。指定されたテキスト、テキストの書式設定、および画像を使用する。とオプションのフォーカス四角形を使用します。

DrawParentBackground(Graphics, Rectangle, Control)

コントロールの親の背景を指定された領域に描画します。

Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
IsBackgroundPartiallyTransparent(PushButtonState)

ボタンの背景に半透明またはアルファブレンドされた部分があるかどうかを示します。

MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください