DataGridViewColumnCollection.GetColumnsWidth メソッド

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

DataGridViewColumnCollection.GetColumnsWidth メソッド

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

指定したフィルタ条件に一致する列をすべて表示するために必要な幅をピクセル単位で返します。

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

Visual Basic (宣言)

Public Function GetColumnsWidth ( _
    includeFilter As DataGridViewElementStates _
) As Integer

Visual Basic (使用法)

Dim instance As DataGridViewColumnCollection
Dim includeFilter As DataGridViewElementStates
Dim returnValue As Integer

returnValue = instance.GetColumnsWidth(includeFilter)

C#

public int GetColumnsWidth (
    DataGridViewElementStates includeFilter
)

C++

public:
int GetColumnsWidth (
    DataGridViewElementStates includeFilter
)

J#

public int GetColumnsWidth (
    DataGridViewElementStates includeFilter
)

JScript

public function GetColumnsWidth (
    includeFilter : DataGridViewElementStates
) : int

パラメータ

includeFilter

適用する包含フィルタを表す DataGridViewElementStates 値のビットごとの組み合わせ。

戻り値
フィルタ条件に一致する列をすべて表示するために必要な幅 (ピクセル単位)。

例外

例外の種類	条件
ArgumentException	includeFilter が、DataGridViewElementStates 値の有効なビットごとの組み合わせではありません。

使用例

このメソッドの使用方法を次のコード例に示します。次の例は「方法 : Windows フォームの DataGridView コントロールの行の外観をカスタマイズする」で取り上げている例の一部です。

Visual Basic

' Paints the custom selection background for selected rows.
Sub dataGridView1_RowPrePaint(ByVal sender
 As Object, _
    ByVal e As DataGridViewRowPrePaintEventArgs)
 _
    Handles dataGridView1.RowPrePaint

    ' Do not automatically paint the focus rectangle.
    e.PaintParts = e.PaintParts And Not DataGridViewPaintParts.Focus

    ' Determine whether the cell should be painted with the 
    ' custom selection background.
    If (e.State And DataGridViewElementStates.Selected)
 = _
        DataGridViewElementStates.Selected Then

        ' Calculate the bounds of the row.
        Dim rowBounds As New
 Rectangle( _
            Me.dataGridView1.RowHeadersWidth, e.RowBounds.Top,
 _
            Me.dataGridView1.Columns.GetColumnsWidth( _
            DataGridViewElementStates.Visible) - _
            Me.dataGridView1.HorizontalScrollingOffset + 1, _
            e.RowBounds.Height)

        ' Paint the custom selection background.
        Dim backbrush As New
 _
            System.Drawing.Drawing2D.LinearGradientBrush(rowBounds, _
            Me.dataGridView1.DefaultCellStyle.SelectionBackColor,
 _
            e.InheritedRowStyle.ForeColor, _
            System.Drawing.Drawing2D.LinearGradientMode.Horizontal)
        Try
            e.Graphics.FillRectangle(backbrush, rowBounds)
        Finally
            backbrush.Dispose()
        End Try
    End If

End Sub 'dataGridView1_RowPrePaint

C#

// Paints the custom selection background for selected rows.
void dataGridView1_RowPrePaint(object sender,
        DataGridViewRowPrePaintEventArgs e)
{
    // Do not automatically paint the focus rectangle.
    e.PaintParts &= ~DataGridViewPaintParts.Focus;

    // Determine whether the cell should be painted
    // with the custom selection background.
    if ((e.State & DataGridViewElementStates.Selected) ==
                DataGridViewElementStates.Selected)
    {
        // Calculate the bounds of the row.
        Rectangle rowBounds = new Rectangle(
            this.dataGridView1.RowHeadersWidth, e.RowBounds.Top
,
            this.dataGridView1.Columns.GetColumnsWidth(
                DataGridViewElementStates.Visible) -
            this.dataGridView1.HorizontalScrollingOffset + 1,
            e.RowBounds.Height);

        // Paint the custom selection background.
        using (Brush backbrush =
            new System.Drawing.Drawing2D.LinearGradientBrush(rowBounds
,
                this.dataGridView1.DefaultCellStyle.SelectionBackColor
,
                e.InheritedRowStyle.ForeColor,
                System.Drawing.Drawing2D.LinearGradientMode.Horizontal))
        {
            e.Graphics.FillRectangle(backbrush, rowBounds);
        }
    }
}

プラットフォーム

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

参照

関連項目
DataGridViewColumnCollection クラス
DataGridViewColumnCollection メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataGridViewColumn クラス
DataGridViewElementStates