Share via


NamedRange.MergeArea Property

Gets a Microsoft.Office.Interop.Excel.Range that represents the merged range containing the NamedRange control.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

Syntax

'Declaration
ReadOnly Property MergeArea As Range
Range MergeArea { get; }

Property Value

Type: Microsoft.Office.Interop.Excel.Range
A Microsoft.Office.Interop.Excel.Range that represents the merged range containing the NamedRange control. If the NamedRange control is not in a merged range, this property returns a Microsoft.Office.Interop.Excel.Range that represents the NamedRange control.

Remarks

The MergeArea property only works on a single-cell range.

Examples

The following code example displays the value of the MergeArea and MergeCells properties of a single-cell NamedRange before and after using the Merge method to merge a multiple-cell NamedRange that contains the single-cell NamedRange.

This example is for a document-level customization.

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

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

        Dim beforeMergeAddress As String = _
            namedRange2.MergeArea.Address(, , _
            Excel.XlReferenceStyle.xlA1, , )

        MessageBox.Show("Before merging, the MergeArea property is '" & _
            beforeMergeAddress & "' and the MergeCells property is " & _
            " '" & namedRange2.MergeCells.ToString() & "'.")

        namedRange1.Select()
        namedRange1.Merge(False)

        Dim afterMergeAddress As String = _
            namedRange2.MergeArea.Address(, , _
            Excel.XlReferenceStyle.xlA1, , )

        MessageBox.Show("After merging, the MergeArea property is '" & _
            afterMergeAddress & "' and the MergeCells property is " & _
            " '" & namedRange2.MergeCells.ToString() & "'.")
    End Sub
private void MergeRange()
{
    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A1", "A5"],
        "namedRange1");

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

    string beforeMergeAddress = namedRange2.MergeArea.get_Address(
        Excel.XlReferenceStyle.xlA1);

    MessageBox.Show("Before merging, the MergeArea property is '" +
        beforeMergeAddress + "' and the MergeCells property is " +
        " '" + namedRange2.MergeCells.ToString() + "'.");

    namedRange1.Select();
    namedRange1.Merge(false);

    string afterMergeAddress = namedRange2.MergeArea.get_Address(
        Excel.XlReferenceStyle.xlA1);

    MessageBox.Show("After merging, the MergeArea property is '" +
        afterMergeAddress + "' and the MergeCells property is " +
        " '" + namedRange2.MergeCells.ToString() + "'.");
}

.NET Framework Security

See Also

Reference

NamedRange Interface

Microsoft.Office.Tools.Excel Namespace