Worksheet.Range Property

Article
04/26/2013

Gets a Range object that represents a cell or a range of cells.

Namespace: Microsoft.Office.Tools.Excel
Assemblies: Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)
Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Syntax

'Declaration
ReadOnly Property Range As Worksheet_RangeType

Worksheet_RangeType Range { get; }

Property Value

Type: Microsoft.Office.Tools.Excel.Worksheet_RangeType
A Range that represents a cell or a range of cells.

Remarks

The Range property is intended to be used with the following parameters.

Parameter	Description
Cell1	The name of the range in A1-style notation in the language of the application. It can include the range operator (a colon), the intersection operator (a space), or the union operator (a comma). It can also include dollar signs, but they are ignored. You can use a local defined name in any part of the range. If you use a name, the name is assumed to be in the language of the application. This parameter is required.
Cell2	The cell in the lower-right corner of the range. Can be a Range that contains a single cell, an entire column, an entire row, or it can be a string that names a single cell in the language of the application. This parameter is optional.

Cell1

The name of the range in A1-style notation in the language of the application. It can include the range operator (a colon), the intersection operator (a space), or the union operator (a comma). It can also include dollar signs, but they are ignored. You can use a local defined name in any part of the range. If you use a name, the name is assumed to be in the language of the application. This parameter is required.

Cell2

The cell in the lower-right corner of the range. Can be a Range that contains a single cell, an entire column, an entire row, or it can be a string that names a single cell in the language of the application. This parameter is optional.

If you use the Range property without specifying any parameters, it will return a Worksheet_RangeType object that is not intended to be used directly from your code.

Optional Parameters

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

Examples

The following code example demonstrates different ways to use the Range property to access a single cell or multiple cells.

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

Private Sub CompareRangeUsage()

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
        Globals.ThisAddIn.Application.ActiveWorksheet("Sheet1")
    Dim vstoWorksheet As Microsoft.Office.Tools.Excel.Worksheet =
        Globals.Factory.GetVstoObject(NativeWorksheet)

    ' The following line of code specifies a single cell.
    vstoWorksheet.Range("A1").Value2 = "Range 1" 

    ' The following line of code specifies multiple cells.
    vstoWorksheet.Range("A3", "B4").Value2 = "Range 2" 

    ' The following line of code uses an Excel.Range for  
    ' the second parameter of the Range property. 
    Dim range1 As Excel.Range = vstoWorksheet.Range("C8")
    vstoWorksheet.Range("A6", range1).Value2 = "Range 3" 
End Sub

private void CompareRangeUsage()
{                      
    Worksheet vstoWorksheet = Globals.Factory.GetVstoObject(
        this.Application.ActiveWorkbook.Worksheets[1]);
    // The following line of code specifies a single cell.
    vstoWorksheet.Range["A1"].Value2 = "Range 1";

    // The following line of code specifies multiple cells.
    vstoWorksheet.Range["A3", "B4"].Value2 = "Range 2";

    // The following line of code uses an Excel.Range for  
    // the second parameter of the Range property.
    Excel.Range range1 = vstoWorksheet.Range["C8"];
    vstoWorksheet.Range["A6", range1].Value2 = "Range 3";
}

.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.

Share via