DrawListViewItemEventArgs.State プロパティ

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

DrawListViewItemEventArgs.State プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

描画する ListViewItem の現在の状態を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 State As ListViewItemStates

Visual Basic (使用法)

Dim instance As DrawListViewItemEventArgs
Dim value As ListViewItemStates

value = instance.State

C#

public ListViewItemStates State { get; }

C++

public:
property ListViewItemStates State {
    ListViewItemStates get ();
}

J#

/** @property */
public ListViewItemStates get_State ()

JScript

public function get State
 () : ListViewItemStates

プロパティ値
ListViewItem の現在の状態を示す ListViewItemStates 値のビットごとの組み合わせ。

解説

このプロパティを使用して、描画する ListViewItem が特定の状態にあるかどうかをチェックします。このプロパティでは、項目の基本的な状態情報のみが得られます。たとえばこのプロパティを使用して、項目が選択されているか、オンになっているか、フォーカスを持っているかどうかを判断できます。さらに詳細な情報が必要な場合は、Item プロパティを使用して項目を取得し、そのプロパティを直接チェックします。

使用例

ListView コントロールのカスタム描画を提供するアプリケーションで、State プロパティを使用する方法を次のコード例に示します。この例では、ListView.DrawItem イベントのハンドラは項目全体の背景を描画します。詳細ビュー以外のすべてのビューでは、このハンドラによって前景テキストも描画されます。詳細ビューでは、ListView.DrawSubItem イベントで前景テキストが描画されます。

コード全体については、DrawListViewItemEventArgs の概要のリファレンス トピックを参照してください。

Visual Basic

' Draws the backgrounds for entire ListView items.
Private Sub listView1_DrawItem(ByVal
 sender As Object, _
    ByVal e As DrawListViewItemEventArgs) _
    Handles listView1.DrawItem

    If Not (e.State And
 ListViewItemStates.Selected) = 0 Then

        ' Draw the background for a selected item.
        e.Graphics.FillRectangle(Brushes.Maroon, e.Bounds)
        e.DrawFocusRectangle()

    Else

        ' Draw the background for an unselected item.
        Dim brush As New
 LinearGradientBrush(e.Bounds, Color.Orange, _
            Color.Maroon, LinearGradientMode.Horizontal)
        Try
            e.Graphics.FillRectangle(brush, e.Bounds)
        Finally
            brush.Dispose()
        End Try

    End If

    ' Draw the item text for views other than the Details view.
    If Not Me.listView1.View
 = View.Details Then
        e.DrawText()
    End If

End Sub

C#

// Draws the backgrounds for entire ListView items.
private void listView1_DrawItem(object sender
,
    DrawListViewItemEventArgs e)
{
    if ((e.State & ListViewItemStates.Selected) != 0)
    {
        // Draw the background and focus rectangle for a selected item.
        e.Graphics.FillRectangle(Brushes.Maroon, e.Bounds);
        e.DrawFocusRectangle();
    }
    else
    {
        // Draw the background for an unselected item.
        using (LinearGradientBrush brush =
            new LinearGradientBrush(e.Bounds, Color.Orange,
            Color.Maroon, LinearGradientMode.Horizontal))
        {
            e.Graphics.FillRectangle(brush, e.Bounds);
        }
    }

    // Draw the item text for views other than the Details view.
    if (listView1.View != View.Details)
    {
        e.DrawText();
    }
}

C++

   // Draws the backgrounds for entire ListView items.
private:
   void listView1_DrawItem( Object^ /*sender*/, DrawListViewItemEventArgs^
 e )
   {
      if ( (e->State & ListViewItemStates::Selected) !=
 (ListViewItemStates)0 )
      {
         // Draw the background for a selected item.
         e->Graphics->FillRectangle( Brushes::Maroon, e->Bounds );
         e->DrawFocusRectangle();
      }
      else
      {
         // Draw the background for an unselected item.
         LinearGradientBrush^ myBrush = gcnew LinearGradientBrush( e->Bounds,Color::Orange,Color::Maroon,LinearGradientMode::Horizontal
 );
         try
         {
            e->Graphics->FillRectangle( myBrush, e->Bounds );
         }
         finally
         {
            if ( myBrush )
               delete (IDisposable^)myBrush;
         }
      }

      if ( listView1->View != View::Details )
      {
         e->DrawText();
      }
   }

J#

// Draws the backgrounds for the column header row and for entire
// ListView items.
private void myListView_DrawItem(Object sender,
 DrawListViewItemEventArgs e)
{
    // Draw the background for the column header row.
    if (e.get_ItemIndex() == -1) {
        e.get_Item().set_BackColor(Color.get_Black());
        e.DrawBackground();
    }
    // Draw the background for a selected item.
    else {
        if (Convert.ToInt32((e.get_State() & ListViewItemStates.Selected))
            != 0) {
            e.get_Graphics().FillRectangle(Brushes.get_Maroon(),
                e.get_Bounds());
            e.DrawFocusRectangle();
        }
        // Draw the background for an unselected item.
        else {
            LinearGradientBrush myBrush = new LinearGradientBrush(
                e.get_Bounds(), Color.get_Orange(), Color.get_Maroon(),
                LinearGradientMode.Horizontal);
            try {
                e.get_Graphics().FillRectangle(myBrush, e.get_Bounds());
            }
            finally {
                myBrush.Dispose();
            }    
        }
    }
    // Draw the item text for views other than the Details view.
    if (!(((ListView)sender).get_View().Equals(View.Details)))
 {
        e.DrawText();
    }
} //myListView_DrawItem

プラットフォーム

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

参照

関連項目
DrawListViewItemEventArgs クラス
DrawListViewItemEventArgs メンバ
System.Windows.Forms 名前空間
DrawListViewItemEventArgs.Item プロパティ
ListView
ListView.DrawItem
ListViewItem
ListViewItemStates