WorksheetBase.Move(Object, Object) Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.Excel.v4.0.Utilities.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.

Moves the worksheet to another location in the workbook.

public void Move (object before, object after);

member this.Move : obj * obj -> unit

Public Sub Move (Optional before As Object, Optional after As Object)

Parameters

before: Object

The sheet before which the moved sheet will be placed. You cannot specify Before if you specify After.

after: Object

The sheet after which the moved sheet will be placed. You cannot specify After if you specify Before.

Examples

The following code example uses the Index property to display the index number of the current worksheet before and after moving the worksheet to the last position in the workbook by using the Move method.

This example is for a document-level customization.

private void DisplayIndex()
{
    MessageBox.Show("Before moving, this worksheet is at tab number " +
        this.Index.ToString());

    // Move the worksheet to the last position in the workbook.
    this.Move(missing, 
        Globals.ThisWorkbook.Worksheets[Globals.ThisWorkbook.Worksheets.Count]);

    MessageBox.Show("After moving, this worksheet is at tab number " +
        this.Index.ToString());
}

Private Sub DisplayIndex()
    MsgBox("Before moving, this worksheet is at tab number " & _
        Me.Index.ToString())

    ' Move the worksheet to the last position in the workbook.
    Me.Move(After:=Globals.ThisWorkbook.Worksheets( _
        Globals.ThisWorkbook.Worksheets.Count))

    MsgBox("After moving, this worksheet is at tab number " & _
        Me.Index.ToString())
End Sub

Remarks

If you do not specify either Before or After, Microsoft Office Excel creates a new workbook that contains the moved sheet.

Optional Parameters

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

Applies to

Share via