TextBox.AutoCompleteSource プロパティ

定義

オート コンプリートで使用する完全な文字列のソースを指定する値を取得または設定します。Gets or sets a value specifying the source of complete strings used for automatic completion.

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; }
member this.AutoCompleteSource : System.Windows.Forms.AutoCompleteSource with get, set
Public Property AutoCompleteSource As AutoCompleteSource

プロパティ値

AutoCompleteSource の値の 1 つ。One of the values of AutoCompleteSource. オプションは、AllSystemSourcesAllUrlFileSystemHistoryListRecentlyUsedListCustomSource、および None です。The options are AllSystemSources, AllUrl, FileSystem, HistoryList, RecentlyUsedList, CustomSource, and None. 既定値は、None です。The default is None.

属性

例外

指定された値が AutoCompleteSource の値の 1 つではありません。The specified value is not one of the values of AutoCompleteSource.

コレクションをTextBoxコントロールのオートコンプリートカスタムソースとして使用する方法を次のコード例に示します。The following code example demonstrates how to use a collection as the auto-complete custom source for a TextBox control. この例の内容は次のとおりです。This example does the following:

  • プロパティを使用して、 TextBoxコントロールがオートコンプリート動作のためにカスタムソースを受け入れることができるようにします。 AutoCompleteSourceUses the AutoCompleteSource property to enable the TextBox control to accept a custom source for its auto-complete behavior.

  • AutoCompleteCustomSourceプロパティを使用して、値のカスタムリストを設定します。Uses the AutoCompleteCustomSource property to set the custom list of values.

  • AutoCompleteModeプロパティを使用して、オートコンプリート候補の表示方法を設定します。Uses the AutoCompleteMode property to set how the auto-complete candidates are displayed.

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

注釈

AutoCompleteCustomSourceAutoCompleteModeおよびTextBoxの各プロパティを使用して、入力したプレフィックスを、保持されているソース内のすべての文字列のプレフィックスと比較することによって、入力文字列を自動的に補完するを作成します。 AutoCompleteSourceUse the AutoCompleteCustomSource, AutoCompleteMode, and AutoCompleteSource properties to create a TextBox that automatically completes input strings by comparing the prefix being entered to the prefixes of all strings in a maintained source. これは、url TextBox 、アドレス、ファイル名、またはコマンドを頻繁に入力するコントロールに役立ちます。This is useful for TextBox controls in which URLs, addresses, file names, or commands will be frequently entered.

AutoCompleteCustomSourceプロパティの使用は省略可能ですが、使用AutoCompleteCustomSourceするにはAutoCompleteSourceプロパティをCustomSourceに設定する必要があります。The use of the AutoCompleteCustomSource property is optional, but you must set the AutoCompleteSource property to CustomSource in order to use AutoCompleteCustomSource.

プロパティとAutoCompleteMode AutoCompleteSourceプロパティを一緒に使用する必要があります。You must use the AutoCompleteMode and AutoCompleteSource properties together.

注意

AutoCompleteSource複数行TextBoxコントロールでは機能しません。AutoCompleteSource does not work on multiline TextBox controls.

注意

オペレーティングシステムによって、一度に表示できるカスタム文字列の数が制限される場合があります。The operating system might limit the number of custom strings that can be displayed at once.

適用対象

こちらもご覧ください