DataGridViewColumn.GetPreferredWidth メソッド

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

DataGridViewColumn.GetPreferredWidth メソッド

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

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

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

Visual Basic (宣言)

Public Overridable Function
 GetPreferredWidth ( _
    autoSizeColumnMode As DataGridViewAutoSizeColumnMode, _
    fixedHeight As Boolean _
) As Integer

Visual Basic (使用法)

Dim instance As DataGridViewColumn
Dim autoSizeColumnMode As DataGridViewAutoSizeColumnMode
Dim fixedHeight As Boolean
Dim returnValue As Integer

returnValue = instance.GetPreferredWidth(autoSizeColumnMode, fixedHeight)

C#

public virtual int GetPreferredWidth (
    DataGridViewAutoSizeColumnMode autoSizeColumnMode,
    bool fixedHeight
)

C++

public:
virtual int GetPreferredWidth (
    DataGridViewAutoSizeColumnMode autoSizeColumnMode, 
    bool fixedHeight
)

J#

public int GetPreferredWidth (
    DataGridViewAutoSizeColumnMode autoSizeColumnMode, 
    boolean fixedHeight
)

JScript

public function GetPreferredWidth (
    autoSizeColumnMode : DataGridViewAutoSizeColumnMode, 
    fixedHeight : boolean
) : int

パラメータ

autoSizeColumnMode

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

fixedHeight

現在の行の高さに基づいて列の幅を計算する場合は true。行の高さが調整されることを見込んで幅を計算する場合は false。

戻り値
列の適切な幅 (ピクセル単位)。

例外

例外の種類	条件
ArgumentException	autoSizeColumnMode が NotSet、None、または Fill です。
InvalidEnumArgumentException	autoSizeColumnMode が有効な DataGridViewAutoSizeColumnMode 値ではありません。

解説

このプロパティは、DataGridView コントロールの、内容に基づく自動サイズ変更機能で、列の適切な幅を決定するために使用されます。

fixedHeight パラメータ値を false にすると、セルの幅に対する高さの比率が理想的となるような行の高さの計算値に基づいて、列幅を計算します。セルの内容が複数の行に折り返されるようにするには、セルに対して有効なセル スタイルの WrapMode プロパティ値を True に設定する必要があります。

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

プラットフォーム

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

参照

関連項目
DataGridViewColumn クラス
DataGridViewColumn メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataGridViewAutoSizeColumnMode 列挙体
GetPreferredHeight
DataGridViewCellStyle.WrapMode プロパティ