TextBox.AutoCompleteSource プロパティ

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

オート コンプリートで使用する完全な文字列のソースを指定する値を取得または設定します。

public:
 property System::Windows::Forms::AutoCompleteSource AutoCompleteSource { System::Windows::Forms::AutoCompleteSource get(); void set(System::Windows::Forms::AutoCompleteSource value); };

[System.ComponentModel.Browsable(true)]
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.TextBoxAutoCompleteSourceConverter))]
public System.Windows.Forms.AutoCompleteSource AutoCompleteSource { get; set; }

[<System.ComponentModel.Browsable(true)>]
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.TextBoxAutoCompleteSourceConverter))>]
member this.AutoCompleteSource : System.Windows.Forms.AutoCompleteSource with get, set

Public Property AutoCompleteSource As AutoCompleteSource

プロパティ値

AutoCompleteSource

AutoCompleteSource の値の 1 つです。 オプションは、AllSystemSources、AllUrl、FileSystem、HistoryList、RecentlyUsedList、CustomSource、および None です。 既定値は、None です。

属性

BrowsableAttribute TypeConverterAttribute

例外

InvalidEnumArgumentException

指定された値が AutoCompleteSource の値の 1 つではありません。

例

次のコード例では、コントロールのオートコンプリート カスタム ソースとしてコレクションを使用する方法を TextBox 示します。 この例の内容は次のとおりです。

• プロパティを AutoCompleteSource 使用して、コントロールが TextBox 自動完了動作のカスタム ソースを受け入れるようにします。

• プロパティを AutoCompleteCustomSource 使用して、値のカスタム リストを設定します。

• プロパティを AutoCompleteMode 使用して、オートコンプリート候補の表示方法を設定します。

private void Form1_Load(object sender, EventArgs e)
{
    // Create the list to use as the custom source. 
    var source = new AutoCompleteStringCollection();
    source.AddRange(new string[]
                    {
                        "January",
                        "February",
                        "March",
                        "April",
                        "May",
                        "June",
                        "July",
                        "August",
                        "September",
                        "October",
                        "November",
                        "December"
                    });

    // Create and initialize the text box.
    var textBox = new TextBox
                  {
                      AutoCompleteCustomSource = source,
                      AutoCompleteMode = 
                          AutoCompleteMode.SuggestAppend,
                      AutoCompleteSource =
                          AutoCompleteSource.CustomSource,
                      Location = new Point(20, 20),
                      Width = ClientRectangle.Width - 40,
                      Visible = true
                  };

    // Add the text box to the form.
    Controls.Add(textBox);
}

Private Sub Form1_Load(ByVal sender As System.Object, _
                       ByVal e As System.EventArgs) Handles MyBase.Load

    ' Create the list to use as the custom source.
    Dim MySource As New AutoCompleteStringCollection()
    MySource.AddRange(New String() _
                        { _
                            "January", _
                            "February", _
                            "March", _
                            "April", _
                            "May", _
                            "June", _
                            "July", _
                            "August", _
                            "September", _
                            "October", _
                            "November", _
                            "December" _
                        })

    ' Create and initialize the text box.
    Dim MyTextBox As New TextBox()
    With MyTextBox
        .AutoCompleteCustomSource = MySource
        .AutoCompleteMode = AutoCompleteMode.SuggestAppend
        .AutoCompleteSource = AutoCompleteSource.CustomSource
        .Location = New Point(20, 20)
        .Width = Me.ClientRectangle.Width - 40
        .Visible = True
    End With

    ' Add the text box to the form.
    Me.Controls.Add(MyTextBox)
End Sub

注釈

、AutoCompleteMode、および の各プロパティをAutoCompleteCustomSource使用して、 を作成TextBoxし、入力されるプレフィックスとAutoCompleteSource、保守されているソース内のすべての文字列のプレフィックスを比較して、入力文字列を自動的に完了します。 これは、URL、アドレス、ファイル名、またはコマンドを頻繁に入力するコントロールに役立ちます TextBox 。

プロパティのAutoCompleteCustomSource使用は省略可能ですが、 を使用AutoCompleteCustomSourceするには、 プロパティを AutoCompleteSource にCustomSource設定する必要があります。

プロパティと AutoCompleteSource プロパティを一緒にAutoCompleteMode使用する必要があります。

注意

AutoCompleteSource は、複数行 TextBox のコントロールでは機能しません。

注意

オペレーティング システムでは、一度に表示できるカスタム文字列の数が制限される場合があります。

こちらもご覧ください

• AutoCompleteCustomSource
• AutoCompleteMode