Control.Dock プロパティ

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

Control.Dock プロパティ

コントロールの境界のうち、親コントロールにドッキングする境界を取得または設定します。また、コントロールのサイズが親コントロール内でどのように変化するかを決定します。

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

Visual Basic (宣言)

<LocalizableAttribute(True)> _
Public Overridable Property
 Dock As DockStyle

Visual Basic (使用法)

Dim instance As Control
Dim value As DockStyle

value = instance.Dock

instance.Dock = value

C#

[LocalizableAttribute(true)] 
public virtual DockStyle Dock { get; set;
 }

C++

[LocalizableAttribute(true)] 
public:
virtual property DockStyle Dock {
    DockStyle get ();
    void set (DockStyle value);
}

J#

/** @property */
public DockStyle get_Dock ()

/** @property */
public void set_Dock (DockStyle value)

JScript

public function get Dock
 () : DockStyle

public function set Dock
 (value : DockStyle)

プロパティ値
DockStyle 値の 1 つ。既定値は None です。

例外

例外の種類	条件
InvalidEnumArgumentException	代入された値が、DockStyle 値ではありません。

解説

親コントロールのサイズ変更に合わせてコントロールのサイズを自動的に変更する方法を定義するには、Dock プロパティを使用します。たとえば、Dock を DockStyle.Left に設定すると、コントロールが親コントロールの左端に揃えて配置され、親コントロールのサイズの変更に合わせてサイズ変更されます。コントロールは、Z オーダーに基づいてドッキングされます。Z オーダーは、フォーム上に配置された各コントロールの Z 軸 (奥行) 方向の視覚的な重なり合いのことです。

コントロールは、親コンテナの 1 つの端にドッキングすることも、すべての端にドッキングして親コンテナ全体を塗りつぶすこともできます。

メモ
Anchor プロパティと Dock プロパティは同時には指定できません。いずれか一方のみを設定でき、一度に両方のプロパティを設定した場合は、最後に設定された方が優先されます。

継承時の注意 派生クラスで Dock プロパティをオーバーライドする場合は、基本クラスの Dock プロパティを使用して、基本の実装を拡張します。それ以外の場合は、すべての実装を提供する必要があります。Dock プロパティの get メソッドと set メソッドの両方をオーバーライドする必要はありません。必要に応じて 1 つだけをオーバーライドできます。

使用例

GroupBox を作成して、共通プロパティの一部を設定するコード例を次に示します。この例では、TextBox を作成し、グループ ボックス内での Location を設定しています。次に、グループ ボックスの Text プロパティを設定して、グループ ボックスをフォームの上部にドッキングします。最後に、Enabled プロパティを false に設定してグループを無効にします。これにより、グループ ボックスに含まれるすべてのコントロールが無効になります。

Visual Basic

' Add a GroupBox to a form and set some of its common properties.
Private Sub AddMyGroupBox()
   ' Create a GroupBox and add a TextBox to it.
   Dim groupBox1 As New
 GroupBox()
   Dim textBox1 As New TextBox()
   textBox1.Location = New Point(15, 15)
   groupBox1.Controls.Add(textBox1)
   
   ' Set the Text and Dock properties of the GroupBox.
   groupBox1.Text = "MyGroupBox"
   groupBox1.Dock = DockStyle.Top
   
   ' Disable the GroupBox (which disables all its child controls)
   groupBox1.Enabled = False
   
   ' Add the Groupbox to the form.
   Me.Controls.Add(groupBox1)
End Sub

C#

// Add a GroupBox to a form and set some of its common properties.
private void AddMyGroupBox()
{
   // Create a GroupBox and add a TextBox to it.
   GroupBox groupBox1 = new GroupBox();
   TextBox textBox1 = new TextBox();
   textBox1.Location = new Point(15, 15);
   groupBox1.Controls.Add(textBox1);

   // Set the Text and Dock properties of the GroupBox.
   groupBox1.Text = "MyGroupBox";
   groupBox1.Dock = DockStyle.Top;

   // Disable the GroupBox (which disables all its child controls)
   groupBox1.Enabled = false;

   // Add the Groupbox to the form.
   this.Controls.Add(groupBox1);
}

C++

   // Add a GroupBox to a form and set some of its common properties.
private:
   void AddMyGroupBox()
   {
      // Create a GroupBox and add a TextBox to it.
      GroupBox^ groupBox1 = gcnew GroupBox;
      TextBox^ textBox1 = gcnew TextBox;
      textBox1->Location = Point(15,15);
      groupBox1->Controls->Add( textBox1 );

      // Set the Text and Dock properties of the GroupBox.
      groupBox1->Text = "MyGroupBox";
      groupBox1->Dock = DockStyle::Top;

      // Disable the GroupBox (which disables all its child controls)
      groupBox1->Enabled = false;

      // Add the Groupbox to the form.
      this->Controls->Add( groupBox1 );
   }

J#

// Add a GroupBox to a form and set some of its common properties.
private void AddMyGroupBox()
{
    // Create a GroupBox and add a TextBox to it.
    GroupBox groupBox1 = new GroupBox();
    TextBox textBox1 = new TextBox();
    textBox1.set_Location(new Point(15, 15));
    groupBox1.get_Controls().Add(textBox1);
    // Set the Text and Dock properties of the GroupBox.
    groupBox1.set_Text("MyGroupBox");
    groupBox1.set_Dock(DockStyle.Top);
    // Disable the GroupBox (which disables all its child controls)
    groupBox1.set_Enabled(false);
    // Add the Groupbox to the form.
    this.get_Controls().Add(groupBox1);
} //AddMyGroupBox

プラットフォーム

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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
Control クラス
Control メンバ
System.Windows.Forms 名前空間
DockStyle
Control.Anchor プロパティ
ScrollableControl.DockPaddingEdges
Layout