NamedRange.Offset Property

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.

Gets a Range that is offset from the NamedRange control.

public:
 property Microsoft::Office::Tools::Excel::NamedRange_OffsetType ^ Offset { Microsoft::Office::Tools::Excel::NamedRange_OffsetType ^ get(); };

public Microsoft.Office.Tools.Excel.NamedRange_OffsetType Offset { get; }

member this.Offset : Microsoft.Office.Tools.Excel.NamedRange_OffsetType

Public ReadOnly Property Offset As NamedRange_OffsetType

Property Value

NamedRange_OffsetType

A Range that is offset from the NamedRange control.

Examples

The following code example creates a NamedRange and then adds text to a cell offset from the NamedRange by three columns and three cells.

This version is for a document-level customization.

Microsoft.Office.Tools.Excel.NamedRange offsetRange;
private void ActivateOffset()
{
    offsetRange = this.Controls.AddNamedRange(
         this.Range["B1"], "offsetRange");

    Excel.Range activateRange =
        (Excel.Range)this.offsetRange.Offset[3, 3];
    offsetRange.Value2 = "Original range.";
    activateRange.Value2 = "Offset range.";
    activateRange.Select();
}

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

Private Sub ActivateOffset()
    offsetRange = Me.Controls.AddNamedRange( _
        Me.Range("B1"), "offsetRange")

    Dim activateRange As Excel.Range = _
        CType(Me.offsetRange.Offset(3, 3), Excel.Range)
    offsetRange.Value2 = "Original range."
    activateRange.Value2 = "Offset range."
    activateRange.Select()
End Sub

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

Remarks

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

Parameter	Description
`RowOffset`	The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward. The default value is 0.
`ColumnOffset`	The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left. The default value is 0.

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

Optional Parameters

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

Applies to