InsertWorksheetForm Class

Prompts the user to insert worksheets within a workbook.

Namespace: MindFusion.Spreadsheet.WinForms
Assembly: MindFusion.Spreadsheet.WinForms.StandardForms

 Syntax

C#

public class InsertWorksheetForm : Form

Visual Basic

Public Class InsertWorksheetForm
    Inherits Form

 Remarks

This form can be used to prompt the user to insert new sheets in a workbook. To use the form, create an instance of the InsertWorksheetForm class by providing the related workbook and call the ShowDialog method. The user's choice can be obtained from the Position, Index, NumberOfSheets, and SheetName properties. The following image shows the form:

 Example

The code below demonstrates how to use the form to insert worksheets in an existing workbook. The activeSheet variable identifies the Worksheet that is currently active in the view.

C#

var form = new InsertWorksheetForm(workbook);
if (form.ShowDialog(this) == DialogResult.OK)
{
    using (workbook.StartCompositeOperation())
    {
        int index = -1;
        switch (form.Position)
        {

            case InsertWorksheetPosition.AfterActiveSheet:
                index = workbook.Worksheets.IndexOf(activeSheet) + 1;
                break;

            case InsertWorksheetPosition.BeforeActiveSheet:
                index = workbook.Worksheets.IndexOf(activeSheet);
                break;

            case InsertWorksheetPosition.Other:
                index = form.Index;
                break;

        }

        if (form.NumberOfSheets == 1)
        {
            workbook.Worksheets.Insert(index, form.SheetName);
        }
        else
        {
            for (int i = 0; i < form.NumberOfSheets; i++)
                workbook.Worksheets.Insert(index++);
        }
    }
}

Visual Basic

Dim form = New InsertWorksheetForm(workbook)
If form.ShowDialog(Me) = DialogResult.OK Then

    Using workbook.StartCompositeOperation()

        Dim index As Integer = -1
        Select Case form.Position

            Case InsertWorksheetPosition.AfterActiveSheet
                index = workbook.Worksheets.IndexOf(activeSheet) + 1
                Exit Select

            Case InsertWorksheetPosition.BeforeActiveSheet
                index = workbook.Worksheets.IndexOf(activeSheet)
                Exit Select

            Case InsertWorksheetPosition.Other
                index = form.Index
                Exit Select

        End Select

        If form.NumberOfSheets = 1 Then
            workbook.Worksheets.Insert(index, form.SheetName)
        Else
            For i As Integer = 0 To form.NumberOfSheets - 1
                workbook.Worksheets.Insert(index)
                index = index + 1
            Next
        End If

    End Using

End If

 Inheritance Hierarchy

System.Object
    System.MarshalByRefObject
        System.ComponentModel.Component
            System.Windows.Forms.Control
                System.Windows.Forms.ScrollableControl
                    System.Windows.Forms.ContainerControl
                        System.Windows.Forms.Form
                            MindFusion.Spreadsheet.WinForms.InsertWorksheetForm