NamedRange.AutoComplete(String) Method

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.dll

Gets an AutoComplete match from the list.

public:
 System::String ^ AutoComplete(System::String ^ String);

public string AutoComplete (string String);

abstract member AutoComplete : string -> string

Public Function AutoComplete (String As String) As String

Parameters

String

String

The string to complete.

Returns

String

An AutoComplete match from the list.

Examples

The following code example demonstrates how to use the AutoComplete method. The example first sets the value of cell A1 to the string "Martha lives on a vineyard" and creates a NamedRange control in cell A2. The example then uses the AutoComplete method to obtain an AutoComplete match from the substring "Ma" and places the matching value in the NamedRange.

This example is for a document-level customization.

private void FindMarthaInTheRange()
{
    this.Range["A1"].Value2 = "Martha lives on a vineyard";

    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A2"],
        "namedRange1");

    namedRange1.AddComment("This is Martha's range.");
    namedRange1.Value2 = namedRange1.AutoComplete("Ma");

    if (MessageBox.Show("Clear the range?", "Test",
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        namedRange1.Clear();
    }
}

Private Sub FindMarthaInTheRange()
    Me.Range("A1").Value2 = "Martha lives on a vineyard"

    Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange _
        = Me.Controls.AddNamedRange(Me.Range("A2"), _
        "namedRange1")

    namedRange1.AddComment("This is Martha's range.")
    namedRange1.Value2 = namedRange1.AutoComplete("Ma")

    If MessageBox.Show("Clear the range?", "Test", _
        MessageBoxButtons.YesNo) = DialogResult.Yes Then
        namedRange1.Clear()
    End If
End Sub

Remarks

If there is no AutoComplete match or if more than one entry in the list matches the string to complete, this method returns an empty string.

This method works even if the AutoComplete feature is disabled.