ToolStripItem.OnPaint メソッド

.NET Framework クラス ライブラリ リファレンス

ToolStripItem.OnPaint メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

Paint イベントを発生させます。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Protected Overridable Sub
 OnPaint ( _
    e As PaintEventArgs _
)

Visual Basic (使用法)

Dim e As PaintEventArgs

Me.OnPaint(e)

C#

protected virtual void OnPaint (
    PaintEventArgs e
)

C++

protected:
virtual void OnPaint (
    PaintEventArgs^ e
)

J#

protected void OnPaint (
    PaintEventArgs e
)

JScript

protected function OnPaint (
    e : PaintEventArgs
)

パラメータ

e

イベント データを格納している PaintEventArgs。

解説

イベントが発生すると、デリゲートを使用してイベント ハンドラが呼び出されます。詳細については、「イベントの発生」を参照してください。

OnPaint メソッドを使用すると、デリゲートを結び付けずに、派生クラスでイベントを処理することもできます。派生クラスでイベントを処理する場合は、この手法をお勧めします。

継承時の注意 派生クラスで OnPaint をオーバーライドする場合は、登録されているデリゲートがイベントを受け取ることができるように、基本クラスの OnPaint メソッドを呼び出してください。

使用例

OnPaint メソッドのオーバーライドによるカスタム レンダリングの方法を、次のコード例に示します。このコード例は、ToolStripItem クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' This method defines the painting behavior of the control.
' It performs the following operations:
'
' Computes the layout of the item's image and text.
' Draws the item's background image.
' Draws the item's image.
' Draws the item's text.
'
' Drawing operations are implemented in the 
' RolloverItemRenderer class.
Protected Overrides Sub
 OnPaint(e As PaintEventArgs)
   MyBase.OnPaint(e)
   
   If Not (Me.Owner Is
 Nothing) Then
      ' Find the dimensions of the image and the text 
      ' areas of the item. 
      Me.ComputeImageAndTextLayout()
      
      ' Draw the background. This includes drawing a highlighted 
      ' border when the mouse is in the client area.
      Dim ea As New ToolStripItemRenderEventArgs(e.Graphics,
 Me)
      Me.Owner.Renderer.DrawItemBackground(ea)
      
      ' Draw the item's image. 
      Dim irea As New ToolStripItemImageRenderEventArgs(e.Graphics,
 Me, imageRect)
      Me.Owner.Renderer.DrawItemImage(irea)
      
      ' If the item is on a drop-down, give its
      ' text a different highlighted color.
      Dim highlightColor As Color = IIf(Me.IsOnDropDown,
 Color.Salmon, SystemColors.ControlLightLight)
      
      ' Draw the text, and highlight it if the 
      ' the rollover state is true.
      Dim rea As New ToolStripItemTextRenderEventArgs(e.Graphics,
 Me, MyBase.Text, textRect, IIf(Me.rolloverValue,
 highlightColor, MyBase.ForeColor), MyBase.Font, MyBase.TextAlign)
      Me.Owner.Renderer.DrawItemText(rea)
   End If
 End Sub

C#

// This method defines the painting behavior of the control.
// It performs the following operations:
//
// Computes the layout of the item's image and text.
// Draws the item's background image.
// Draws the item's image.
// Draws the item's text.
//
// Drawing operations are implemented in the 
// RolloverItemRenderer class.
protected override void OnPaint(PaintEventArgs
 e)
{
    base.OnPaint(e);

    if (this.Owner != null)
    {
        // Find the dimensions of the image and the text 
        // areas of the item. 
        this.ComputeImageAndTextLayout();

        // Draw the background. This includes drawing a highlighted
 
        // border when the mouse is in the client area.
        ToolStripItemRenderEventArgs ea = new ToolStripItemRenderEventArgs(
             e.Graphics,
             this);
        this.Owner.Renderer.DrawItemBackground(ea);

        // Draw the item's image. 
        ToolStripItemImageRenderEventArgs irea =
            new ToolStripItemImageRenderEventArgs(
            e.Graphics,
            this,
            imageRect );
        this.Owner.Renderer.DrawItemImage(irea);

        // If the item is on a drop-down, give its
        // text a different highlighted color.
        Color highlightColor = 
            this.IsOnDropDown ?
            Color.Salmon : SystemColors.ControlLightLight;

        // Draw the text, and highlight it if the 
        // the rollover state is true.
        ToolStripItemTextRenderEventArgs rea =
            new ToolStripItemTextRenderEventArgs(
            e.Graphics,
            this,
            base.Text,
            textRect,
            this.rolloverValue ? highlightColor : base.ForeColor
,
            base.Font,
            base.TextAlign);
        this.Owner.Renderer.DrawItemText(rea);
    }
}

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ToolStripItem クラス
ToolStripItem メンバ
System.Windows.Forms 名前空間