NamedRange.ApplyNames Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.Excel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Applies names to the cells in the NamedRange control.

public object ApplyNames (object Names, object IgnoreRelativeAbsolute, object UseRowColumnNames, object OmitColumn, object OmitRow, Microsoft.Office.Interop.Excel.XlApplyNamesOrder Order = Microsoft.Office.Interop.Excel.XlApplyNamesOrder.xlRowThenColumn, object AppendLast);

abstract member ApplyNames : obj * obj * obj * obj * obj * Microsoft.Office.Interop.Excel.XlApplyNamesOrder * obj -> obj

Public Function ApplyNames (Optional Names As Object, Optional IgnoreRelativeAbsolute As Object, Optional UseRowColumnNames As Object, Optional OmitColumn As Object, Optional OmitRow As Object, Optional Order As XlApplyNamesOrder = Microsoft.Office.Interop.Excel.XlApplyNamesOrder.xlRowThenColumn, Optional AppendLast As Object) As Object

Parameters

Names: Object

An array of the names to be applied. If this argument is omitted, all names on the sheet are applied to the range.

IgnoreRelativeAbsolute: Object

true to replace references with names, regardless of the reference types of either the names or references; false to replace absolute references only with absolute names, relative references only with relative names, and mixed references only with mixed names. The default value is true.

UseRowColumnNames: Object

true to use the names of row and column ranges that contain the specified range if names for the range cannot be found; false to ignore the OmitColumn and OmitRow arguments. The default value is true.

OmitColumn: Object

true to replace the entire reference with the row-oriented name. The column-oriented name can be omitted only if the referenced cell is in the same column as the formula and is within a row-oriented named range. The default value is true.

OmitRow: Object

true to replace the entire reference with the column-oriented name. The row-oriented name can be omitted only if the referenced cell is in the same row as the formula and is within a column-oriented named range. The default value is true.

Order: XlApplyNamesOrder

Determines which range name is listed first when a cell reference is replaced by a row-oriented and column-oriented range name.Can be one of these XlApplyNamesOrder constants: xlColumnThenRow xlRowThenColumn

AppendLast: Object

true to replace the definitions of the names in Names and also replace the definitions of the last names that were defined; false to replace the definitions of the names in Names only. The default value is false.

Returns

Object

Examples

The following code example uses the ApplyNames method to apply a set of names to a NamedRange control.

This example is for a document-level customization.

private void AddNames()
{
    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A1", "A5"],
        "namedRange1");

    string[] s = new string[] { "One", "Two", "Three", "Four", "Five" };
    namedRange1.ApplyNames(s, true, true, true, true,
        Excel.XlApplyNamesOrder.xlColumnThenRow, false);
}

Private Sub AddNames()
    Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange _
        = Me.Controls.AddNamedRange(Me.Range("A1", "A5"), _
        "namedRange1")

    Dim s() As String = {"One", "Two", "Three", "Four", "Five"}
    namedRange1.ApplyNames(s, True, True, True, True, _
        Excel.XlApplyNamesOrder.xlColumnThenRow, False)
End Sub

Remarks

You can use the Array function to create the list of names for the Names argument.

If you want to apply names to the entire sheet, use Cells.ApplyNames.

You cannot "unapply" names; to delete names, use the Delete method.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to