Label.PreferredWidth プロパティ

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

Label.PreferredWidth プロパティ

コントロールの適切な幅を取得します。

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property PreferredWidth As Integer

Visual Basic (使用法)

Dim instance As Label
Dim value As Integer

value = instance.PreferredWidth

C#

public virtual int PreferredWidth { get;
 }

C++

public:
virtual property int PreferredWidth {
    int get ();
}

J#

/** @property */
public int get_PreferredWidth ()

JScript

public function get PreferredWidth
 () : int

プロパティ値
単一行のテキストが表示されることを想定したコントロールの幅 (ピクセル単位)。

解説

このプロパティはテキストの長さを返しますが、行の折り返しについては考慮しません。たとえば、幅が 300 ピクセルのテキストは、幅が 100 ピクセルしかない Label では 3 行あれば表示できます。このような場合でも PreferredWidth プロパティは、幅として 300 ピクセルを返します。このプロパティを PreferredHeight プロパティと一緒に使用すると、Label コントロールのテキストを問題なく表示できます。AutoSize プロパティを使用すると、テキストとフォント サイズに基づいて、Label コントロールの高さと幅を自動的に調整できます。

メモ
Label コントロールの BorderStyle プロパティが BorderStyle.None に設定されている場合、境界線がないため、PreferredWidth プロパティが返す値は通常より大きな値になります。

使用例

境界が 3 次元で、ImageList プロパティおよび ImageIndex プロパティを使用して表示されるイメージを持つ Label コントロールの作成方法を次のコード例に示します。このコントロールには、ニーモニック文字を指定したキャプションも表示されます。このコードの例では、PreferredHeight プロパティと PreferredWidth プロパティを使用して、表示するフォーム上の Label コントロールのサイズを適切に設定します。この例では、imageList1 という名前の ImageList が作成され、2 つのイメージが読み込まれている必要があります。また、このコードがフォーム内にあり、そのフォームのコードに System.Drawing 名前空間が追加されている必要もあります。

Visual Basic

Public Sub CreateMyLabel()
    ' Create an instance of a Label.
    Dim label1 As New Label()
       
    ' Set the border to a three-dimensional border.
    label1.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D
    ' Set the ImageList to use for displaying an image.
    label1.ImageList = imageList1
    ' Use the second image in imageList1.
    label1.ImageIndex = 1
    ' Align the image to the top left corner.
    label1.ImageAlign = ContentAlignment.TopLeft
     
    ' Specify that the text can display mnemonic characters.
    label1.UseMnemonic = True
    ' Set the text of the control and specify a mnemonic character.
    label1.Text = "First &Name:"
       
    ' Set the size of the control based on the PreferredHeight and PreferredWidth
 values. 
    label1.Size = New Size(label1.PreferredWidth, label1.PreferredHeight)

    '...Code to add the control to the form...
End Sub

C#

public void CreateMyLabel()
{
   // Create an instance of a Label.
   Label label1 = new Label();

   // Set the border to a three-dimensional border.
   label1.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
   // Set the ImageList to use for displaying an image.
   label1.ImageList = imageList1;
   // Use the second image in imageList1.
   label1.ImageIndex = 1;
   // Align the image to the top left corner.
   label1.ImageAlign = ContentAlignment.TopLeft;

   // Specify that the text can display mnemonic characters.
   label1.UseMnemonic = true;
   // Set the text of the control and specify a mnemonic character.
   label1.Text = "First &Name:";
   
   /* Set the size of the control based on the PreferredHeight and PreferredWidth
 values. */
   label1.Size = new Size (label1.PreferredWidth, label1.PreferredHeight);

   //...Code to add the control to the form...
}

C++

public:
   void CreateMyLabel()
   {
      // Create an instance of a Label.
      Label^ label1 = gcnew Label;
      
      // Set the border to a three-dimensional border.
      label1->BorderStyle = System::Windows::Forms::BorderStyle::Fixed3D;
      // Set the ImageList to use for displaying an image.
      label1->ImageList = imageList1;
      // Use the second image in imageList1.
      label1->ImageIndex = 1;
      // Align the image to the top left corner.
      label1->ImageAlign = ContentAlignment::TopLeft;
      
      // Specify that the text can display mnemonic characters.
      label1->UseMnemonic = true;
      // Set the text of the control and specify a mnemonic character.
      label1->Text = "First &Name:";
      
      /* Set the size of the control based on the PreferredHeight and PreferredWidth
 values. */
      label1->Size = System::Drawing::Size( label1->PreferredWidth, label1->PreferredHeight
 );
      
      //...Code to add the control to the form...
   }

J#

public void CreateMyLabel()
{
    // Create an instance of a Label.
    Label label1 = new Label();
    // Set the border to a three-dimensional border.
    label1.set_BorderStyle(System.Windows.Forms.BorderStyle.Fixed3D);
    // Set the ImageList to use for displaying an image.
    label1.set_ImageList(imageList1);
    // Use the second image in imageList1.
    label1.set_ImageIndex(1);
    // Align the image to the top left corner.
    label1.set_ImageAlign(ContentAlignment.TopLeft);
    // Specify that the text can display mnemonic characters.
    label1.set_UseMnemonic(true);
    // Set the text of the control and specify a mnemonic character.
    label1.set_Text("First &Name:");
    /* Set the size of the control based on the PreferredHeight
       and PreferredWidth values. */
    label1.set_Size(new Size(label1.get_PreferredWidth(), 
        label1.get_PreferredHeight()));
    //...Code to add the control to the form...
} //CreateMyLabel 

JScript

public function CreateMyLabel()
{
   // Create an instance of a Label.
   var label1 : Label = new Label();

   // Set the border to a three-dimensional border.
   label1.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
   // Set the ImageList to use for displaying an image.
   label1.ImageList = imageList1;
   // Use the second image in imageList1.
   label1.ImageIndex = 1;
   // Align the image to the top left corner.
   label1.ImageAlign = ContentAlignment.TopLeft;

   // Specify that the text can display mnemonic characters.
   label1.UseMnemonic = true;
   // Set the text of the control and specify a mnemonic character.
   label1.Text = "First &Name:";
   
   /* Set the size of the control based on the PreferredHeight and PreferredWidth
 values. */
   label1.Size = new System.Drawing.Size (label1.PreferredWidth,
 label1.PreferredHeight);

   //...Code to add the control to the form...
}

プラットフォーム

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

参照

関連項目
Label クラス
Label メンバ
System.Windows.Forms 名前空間
Label.PreferredHeight プロパティ
Label.AutoSize プロパティ