Excel.InsertWorksheetOptions interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted.

Remarks

[ API set: ExcelApi 1.13 ]

Properties

positionType

The insert position, in the current workbook, of the new worksheets. See Excel.WorksheetPositionType for details. The default position is "End".
relativeTo

The worksheet in the current workbook that is referenced for the WorksheetPositionType parameter. The default is null. If the relativeTo parameter is not set, worksheets will be inserted based on positionType, at the start or end of the current workbook.
sheetNamesToInsert

The names of individual worksheets to insert. By default, all the worksheets from the source workbook are inserted.

Property Details

positionType

Warning

This API is now deprecated.

The insert position, in the current workbook, of the new worksheets. See Excel.WorksheetPositionType for details. The default position is "End".

positionType?: Excel.WorksheetPositionType | "None" | "Before" | "After" | "Beginning" | "End";

Property Value

Excel.WorksheetPositionType | "None" | "Before" | "After" | "Beginning" | "End"

Remarks

[ API set: ExcelApi 1.13 ]

relativeTo

Warning

This API is now deprecated.

The worksheet in the current workbook that is referenced for the WorksheetPositionType parameter. The default is null. If the relativeTo parameter is not set, worksheets will be inserted based on positionType, at the start or end of the current workbook.

relativeTo?: Worksheet | string;

Property Value

Excel.Worksheet | string

Remarks

[ API set: ExcelApi 1.13 ]

sheetNamesToInsert

Warning

This API is now deprecated.

The names of individual worksheets to insert. By default, all the worksheets from the source workbook are inserted.

sheetNamesToInsert?: string[];

Property Value

string[]

Remarks

[ API set: ExcelApi 1.13 ]