DataGridViewRow.GetPreferredHeight メソッド

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

DataGridViewRow.GetPreferredHeight メソッド

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

指定した基準に基づいて、指定した行の適切な高さを計算します。

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

Visual Basic (宣言)

Public Overridable Function
 GetPreferredHeight ( _
    rowIndex As Integer, _
    autoSizeRowMode As DataGridViewAutoSizeRowMode, _
    fixedWidth As Boolean _
) As Integer

Visual Basic (使用法)

Dim instance As DataGridViewRow
Dim rowIndex As Integer
Dim autoSizeRowMode As DataGridViewAutoSizeRowMode
Dim fixedWidth As Boolean
Dim returnValue As Integer

returnValue = instance.GetPreferredHeight(rowIndex, autoSizeRowMode, fixedWidth)

C#

public virtual int GetPreferredHeight (
    int rowIndex,
    DataGridViewAutoSizeRowMode autoSizeRowMode,
    bool fixedWidth
)

C++

public:
virtual int GetPreferredHeight (
    int rowIndex, 
    DataGridViewAutoSizeRowMode autoSizeRowMode, 
    bool fixedWidth
)

J#

public int GetPreferredHeight (
    int rowIndex, 
    DataGridViewAutoSizeRowMode autoSizeRowMode, 
    boolean fixedWidth
)

JScript

public function GetPreferredHeight (
    rowIndex : int, 
    autoSizeRowMode : DataGridViewAutoSizeRowMode, 
    fixedWidth : boolean
) : int

パラメータ

rowIndex

適切な高さを計算する行のインデックス。

autoSizeRowMode

自動サイズ設定モードを指定する DataGridViewAutoSizeRowMode。

fixedWidth

固定のセル幅に対する適切な高さを計算する場合は true。それ以外の場合は false。

戻り値
行の適切な高さ (ピクセル単位)。

例外

例外の種類	条件
InvalidEnumArgumentException	autoSizeRowMode が有効な DataGridViewAutoSizeRowMode 値ではありません。
ArgumentOutOfRangeException	rowIndex が有効な範囲 (0 ～ コントロールの行数 - 1) 内にありません。

解説

このプロパティは、DataGridView コントロールの、内容に基づく自動サイズ変更機能で、行の適切な高さを決定するために使用されます。rowIndex の値を使用して、共有行の実際の行インデックスを指定できます(共有行の Index プロパティ値は -1 です)。

fixedWidth パラメータ値を false にすると、セルの幅に対する高さの比率が理想的となるような列幅の計算値に基づいて、行の高さを計算します。

セルの内容が複数の行に折り返されるようにするには、セルに対して有効なセル スタイルの WrapMode プロパティ値を True に設定する必要があります。

自動サイズ変更の詳細については、「Windows フォーム DataGridView コントロールのサイズ変更オプション」を参照してください。

使用例

GetPreferredHeight メソッドを使用して、サイズ変更された行の新しい埋め込みを決定するコード例を次に示します。次のコード例は、「方法 : Windows フォームの DataGridView コントロールの行の外観をカスタマイズする」で示されている例の一部です。

Visual Basic

' Adjusts the padding when the user changes the row height so that 
' the normal cell content is fully displayed and any extra
' height is used for the content that spans multiple columns.
Sub dataGridView1_RowHeightChanged(ByVal sender
 As Object, _
    ByVal e As DataGridViewRowEventArgs) _
    Handles dataGridView1.RowHeightChanged

    ' Calculate the new height of the normal cell content.
    Dim preferredNormalContentHeight As Int32
 = _
        e.Row.GetPreferredHeight(e.Row.Index, _
        DataGridViewAutoSizeRowMode.AllCellsExceptHeader, True)
 - _
        e.Row.DefaultCellStyle.Padding.Bottom()

    ' Specify a new padding.
    Dim newPadding As Padding = e.Row.DefaultCellStyle.Padding
    newPadding.Bottom = e.Row.Height - preferredNormalContentHeight
    e.Row.DefaultCellStyle.Padding = newPadding

End Sub

C#

// Adjusts the padding when the user changes the row height so that
 
// the normal cell content is fully displayed and any extra
// height is used for the content that spans multiple columns.
void dataGridView1_RowHeightChanged(object sender,
    DataGridViewRowEventArgs e)
{
    // Calculate the new height of the normal cell content.
    Int32 preferredNormalContentHeight =
        e.Row.GetPreferredHeight(e.Row.Index, 
        DataGridViewAutoSizeRowMode.AllCellsExceptHeader, true)
 -
        e.Row.DefaultCellStyle.Padding.Bottom;

    // Specify a new padding.
    Padding newPadding = e.Row.DefaultCellStyle.Padding;
    newPadding.Bottom = e.Row.Height - preferredNormalContentHeight;
    e.Row.DefaultCellStyle.Padding = newPadding;
}

プラットフォーム

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

参照

関連項目
DataGridViewRow クラス
DataGridViewRow メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataGridViewAutoSizeRowMode 列挙体
DataGridViewCellStyle.WrapMode プロパティ
GetPreferredWidth
その他の技術情報
方法 : Windows フォームの DataGridView コントロールの行の外観をカスタマイズする
Windows フォーム DataGridView コントロールのサイズ変更オプション
Windows フォーム DataGridView コントロールを拡張するための推奨される手順