TextBoxBase.Multiline プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

TextBoxBase.Multiline プロパティ

このコントロールが複数行テキストボックスコントロールかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

<LocalizableAttribute(True)> _
Public Overridable Property
 Multiline As Boolean

Visual Basic (使用法)

Dim instance As TextBoxBase
Dim value As Boolean

value = instance.Multiline

instance.Multiline = value

[LocalizableAttribute(true)] 
public virtual bool Multiline { get;
 set; }

C++

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

/** @property */
public boolean get_Multiline ()

/** @property */
public void set_Multiline (boolean value)

JScript

public function get Multiline
 () : boolean

public function set Multiline
 (value : boolean)

プロパティ値
コントロールが複数行テキストボックスコントロールである場合は true。それ以外の場合は false。既定値は false です。

解説

複数行テキストボックスでは、コントロールに複数行のテキストを表示できます。WordWrap プロパティが true に設定されている場合、複数行テキストボックスに入力されたテキストは、コントロール内の次の行に折り返されます。WordWrap プロパティが false に設定されている場合、複数行テキストボックスコントロールに入力されたテキストは、改行が行われるまで同じ行に表示されます。

改行文字として使用できる定数を次に示します。

Environment.NewLine
ControlChars.CrLf
vbCrLf (Visual Basic のみ)

ScrollBars プロパティを使用すると、テキストボックスにスクロールバーを追加したり、水平スクロールバーまたは垂直スクロールバー (あるいはその両方) を表示したりできます。ユーザーはスクロールバーを使用してコントロールに収まらないテキストをスクロールできます。

メモ
Multiline プロパティの既定値は false であるため、TextBox のサイズを変更した場合でも、TextBox の既定のサイズは、フォントのサイズに合わせて決定されます。TextBox のサイズを一定にするには、Multiline プロパティを true に設定します。

メモ
日本語のオペレーティングシステムでは、Multiline プロパティを true に設定すると、PasswordChar プロパティを設定した場合にパスワードのテキストが表示されるため、システムセキュリティが低下します。このため、日本語のオペレーティングシステムで PasswordChar プロパティを設定する場合は、Multiline プロパティを false に設定します。

メモ

日本語のオペレーティングシステムでは、Multiline プロパティを true に設定すると、PasswordChar プロパティを設定した場合にパスワードのテキストが表示されるため、システムセキュリティが低下します。このため、日本語のオペレーティングシステムで PasswordChar プロパティを設定する場合は、Multiline プロパティを false に設定します。

メモ
このプロパティは、RichTextBox コントロール以外のすべての派生クラスで、既定で false に設定されています。

RichTextBox コントロールでは、RichTextBox.Multiline プロパティによって、コントロールが自動的にサイズ変更されるかどうかが次のように決定されます。

RichTextBox.AutoSize が true に設定されており、RichTextBox.Multiline が true に設定されている場合、RichTextBox は自動的にサイズ変更されません。
RichTextBox.AutoSize が true に設定されており、RichTextBox.Multiline が false に設定されている場合、RichTextBox は自動的にサイズ変更されます。

使用例

派生クラス TextBox を使用して、垂直スクロールバーのある複数行 TextBox コントロールを作成するコード例を次に示します。この例では、AcceptsTab、AcceptsReturn、WordWrap の各プロパティも使用して、テキストドキュメントを作成しやすいように複数行テキストボックスコントロールを設定します。

Visual Basic

Public Sub CreateMyMultilineTextBox()
    ' Create an instance of a TextBox control.
    Dim textBox1 As New
 TextBox()
    
    ' Set the Multiline property to true.
    textBox1.Multiline = True
    ' Add vertical scroll bars to the TextBox control.
    textBox1.ScrollBars = ScrollBars.Vertical
    ' Allow the RETURN key in the TextBox control.
    textBox1.AcceptsReturn = True
    ' Allow the TAB key to be entered in the TextBox control.
    textBox1.AcceptsTab = True
    ' Set WordWrap to true to allow text to wrap to the next line.
    textBox1.WordWrap = True
    ' Set the default text of the control.
    textBox1.Text = "Welcome!" & Environment.NewLine
 & "Second Line"
End Sub

public void CreateMyMultilineTextBox()
 {
    // Create an instance of a TextBox control.
    TextBox textBox1 = new TextBox();
    
    // Set the Multiline property to true.
    textBox1.Multiline = true;
    // Add vertical scroll bars to the TextBox control.
    textBox1.ScrollBars = ScrollBars.Vertical;
    // Allow the RETURN key in the TextBox control.
    textBox1.AcceptsReturn = true;
    // Allow the TAB key to be entered in the TextBox control.
    textBox1.AcceptsTab = true;
    // Set WordWrap to true to allow text to wrap to the next line.
    textBox1.WordWrap = true;
    // Set the default text of the control.
    textBox1.Text = "Welcome!" + Environment.NewLine + "Second Line";
 }

C++

public:
   void CreateMyMultilineTextBox()
   {
      // Create an instance of a TextBox control.
      TextBox^ textBox1 = gcnew TextBox;
      
      // Set the Multiline property to true.
      textBox1->Multiline = true;
      // Add vertical scroll bars to the TextBox control.
      textBox1->ScrollBars = ScrollBars::Vertical;
      // Allow the RETURN key in the TextBox control.
      textBox1->AcceptsReturn = true;
      // Allow the TAB key to be entered in the TextBox control.
      textBox1->AcceptsTab = true;
      // Set WordWrap to true to allow text to wrap to the next line.
      textBox1->WordWrap = true;
      // Set the default text of the control.
      textBox1->Text = "Welcome!" + Environment::NewLine + "Second
 Line";
   }

public void CreateMyMultilineTextBox()
{
    // Create an instance of a TextBox control.
    TextBox textBox1 = new TextBox();
    // Set the Multiline property to true.
    textBox1.set_Multiline(true);
    // Add vertical scroll bars to the TextBox control.
    textBox1.set_ScrollBars(ScrollBars.Vertical);
    // Allow the RETURN key in the TextBox control.
    textBox1.set_AcceptsReturn(true);
    // Allow the TAB key to be entered in the TextBox control.
    textBox1.set_AcceptsTab(true);
    // Set WordWrap to true to allow text to wrap to the next line.
    textBox1.set_WordWrap(true);
    // Set the default text of the control.
    textBox1.set_Text("Welcome!" + Environment.get_NewLine()
        + "Second Line");
} //CreateMyMultilineTextBox