NamedRange.End Property

Gets a Microsoft.Office.Interop.Excel.Range that represents the cell at the end of the region that contains the NamedRange control.

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

Syntax

'Declaration
ReadOnly Property End As NamedRange_EndType
    Get

NamedRange_EndType End { get; }

Property Value

Type: Microsoft.Office.Tools.Excel.NamedRange_EndType
A Microsoft.Office.Interop.Excel.Range that represents the cell at the end of the region that contains the NamedRange control.

Remarks

The End property is intended to be used with the following parameter.

If you attempt to use End without specifying any parameters, End will get a NamedRange_EndType object that is part of the Visual Studio infrastructure and is not intended to be used directly from your code.

This property is equivalent to pressing END+UP ARROW, END+DOWN ARROW, END+LEFT ARROW, or END+RIGHT ARROW.

Examples

The following code example creates a NamedRange and then populates a cell to the right to create a boundary for the region of blank columns. It then displays a message box asking if you want to select the end of the region to the right of the NamedRange.

This version is for a document-level customization.

Private endRange As Microsoft.Office.Tools.Excel.NamedRange

Private Sub SelectEnd()
    endRange = Me.Controls.AddNamedRange( _
        Me.Range("B1", "D4"), "endRange")
    Me.Range("H1").Value2 = 123
    endRange.Select()
    If MessageBox.Show("Select end of region to the right?", _
        "End of Region Test", MessageBoxButtons.OKCancel) = _
        DialogResult.OK Then
        Me.endRange.End(Excel.XlDirection.xlToRight).Select()
    End If
End Sub

Microsoft.Office.Tools.Excel.NamedRange endRange;
private void SelectEnd()
{
    endRange = this.Controls.AddNamedRange(
        this.Range["B1", "D4"], "endRange");
    this.Range["H1", missing].Value2 = 123;
    endRange.Select();
    if (MessageBox.Show("Select end of region to the right?", 
        "End of Region Test", MessageBoxButtons.OKCancel) == DialogResult.OK)
    {
        this.endRange.End[Excel.XlDirection.xlToRight].Select();
    }
} 

This version is for an application-level add-in.

Private endRange As NamedRange

Private Sub SelectEnd()

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
Globals.ThisAddIn.Application.ActiveSheet

    Dim vstoWorksheet As Microsoft.Office.Tools.Excel.Worksheet =
            Globals.Factory.GetVstoObject(NativeWorksheet)

    endRange = vstoWorksheet.Controls.AddNamedRange( _
        vstoWorksheet.Range("B1", "D4"), "endRange")
    vstoWorksheet.Range("H1").Value2 = 123
    endRange.Select()
    If System.Windows.Forms.MessageBox.Show( _
        "Select end of region to the right?", _
        "End of Region Test", _
        System.Windows.Forms.MessageBoxButtons.OKCancel) = _
        System.Windows.Forms.DialogResult.OK Then
        Me.endRange.End(Excel.XlDirection.xlToRight).Select()
    End If
End Sub

NamedRange endRange;
private void SelectEnd()
{
    Worksheet vstoWorksheet =
        Globals.Factory.GetVstoObject(this.Application.ActiveWorkbook.Worksheets[1]);
    endRange = vstoWorksheet.Controls.AddNamedRange(
        vstoWorksheet.Range["B1", "D4"], "endRange");
    vstoWorksheet.Range["H1", missing].Value2 = 123;
    endRange.Select();
    if (System.Windows.Forms.MessageBox.Show(
        "Select end of region to the right?",
        "End of Region Test", 
        System.Windows.Forms.MessageBoxButtons.OKCancel) ==
        System.Windows.Forms.DialogResult.OK)
    {
        this.endRange.End[Excel.XlDirection.xlToRight].Select();
    }
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

NamedRange Interface

Microsoft.Office.Tools.Excel Namespace