Wiki Markup |
---|
{description} {excerpt}The [Worksheet|Worksheet] class represents a single Excel worksheet. {excerpt} {signature:C#} [DefaultMember("Item")] public class Worksheet {signature}{signature:vb.net} <DefaultMember("Item")> _ Public Class Worksheet {signature} {remarks} To add a Worksheet to a Workbook, call [Workbook.Worksheets.CreateWorksheet\(\)|Worksheets.CreateWorksheet]. To get an existing Worksheet call [Workbook.Worksheets\[index or name\]|Worksheets.Item]. {remarks} {example} {code:csharp|title=C#} //--- Create a new Worksheet ExcelApplication xla = new ExcelApplication(); Workbook wb = xla.Create(); Worksheet ws = wb.Worksheets.CreateWorksheet("Sheet2"); //--- Get an existing Worksheet by index ExcelApplication xla = new ExcelApplication(); Workbook wb = xla.Create(); Worksheet ws = wb.Worksheets[0]; //--- Get an existing Worksheet by name ExcelApplication xla = new ExcelApplication(); Workbook wb = xla.Create(); Worksheet ws = wb.Worksheets["Sheet1"]; {code} {code:vb.net|title=vb.net} '--- Create a new Worksheet Dim xla As New ExcelApplication() Dim wb As Workbook = xla.Create() Dim ws As Worksheet = wb.Worksheets.CreateWorksheet("Sheet2") '--- Get an existing Worksheet by index Dim xla As New ExcelApplication() Dim wb As Workbook = xla.Create() Dim ws As Worksheet = wb.Worksheets(0) '--- Get an existing Worksheet by name Dim xla As New ExcelApplication() Dim wb As Workbook = xla.Create() Dim ws As Worksheet = wb.Worksheets("Sheet2") {code} {example} {properties} || Name || Description || | [Cells|Worksheet.Cells] | {excerpt-include:Worksheet.Cells|nopanel=true} | | [Charts|Worksheet.Charts] | {excerpt-include:Worksheet.Charts|nopanel=true} | | [Comments|Worksheet.Comments] | {excerpt-include:Worksheet.Comments|nopanel=true} | | [FirstShownColumn|Worksheet.FirstShownColumn] | {excerpt-include:Worksheet.FirstShownColumn|nopanel=true} | | [FirstShownRow|Worksheet.FirstShownRow] | {excerpt-include:Worksheet.FirstShownRow|nopanel=true} | | [FreezePanes|Worksheet.FreezePanes] | {excerpt-include:Worksheet.FreezePanes|nopanel=true} | | [GridlinesColor|Worksheet.GridlinesColor] | {excerpt-include:Worksheet.GridlinesColor|nopanel=true} | | [Hyperlinks|Worksheet.Hyperlinks] | {excerpt-include:Worksheet.Hyperlinks|nopanel=true} | | [IsProtected|Worksheet.IsProtected] | {excerpt-include:Worksheet.IsProtected|nopanel=true} | | [IsSelected|Worksheet.IsSelected] | {excerpt-include:Worksheet.IsSelected|nopanel=true} | | [Name|Worksheet.Name] | {excerpt-include:Worksheet.Name|nopanel=true} | | [NamedRanges|Worksheet.NamedRanges] | {excerpt-include:Worksheet.NamedRanges|nopanel=true} | | [PageSetup|Worksheet.PageSetup] | {excerpt-include:Worksheet.PageSetup|nopanel=true} | | [Pictures|Worksheet.Pictures] | {excerpt-include:Worksheet.Pictures|nopanel=true} | | [PopulatedCells|Worksheet.PopulatedCells] | {excerpt-include:Worksheet.PopulatedCells|nopanel=true} | | [Position|Worksheet.Position] | {excerpt-include:Worksheet.Position|nopanel=true} | | [ProtectPasswordHash|Worksheet.ProtectPasswordHash] | {excerpt-include:Worksheet.ProtectPasswordHash|nopanel=true} | | [ShapeGroups|Worksheet.ShapeGroups] | {excerpt-include:Worksheet.ShapeGroups|nopanel=true} | | [Shapes|Worksheet.Shapes] | {excerpt-include:Worksheet.Shapes|nopanel=true} | | [SheetProtection|Worksheet.SheetProtection] | {excerpt-include:Worksheet.SheetProtection|nopanel=true} | | [ShowFormulas|Worksheet.ShowFormulas] | {excerpt-include:Worksheet.ShowFormulas|nopanel=true} | | [ShowGridlines|Worksheet.ShowGridlines] | {excerpt-include:Worksheet.ShowGridlines|nopanel=true} | | [ShowRowColHeaders|Worksheet.ShowRowColHeaders] | {excerpt-include:Worksheet.ShowRowColHeaders|nopanel=true} | | [ShowZeroValues|Worksheet.ShowZeroValues] | {excerpt-include:Worksheet.ShowZeroValues|nopanel=true} | | [StandardHeight|Worksheet.StandardHeight] | {excerpt-include:Worksheet.StandardHeight|nopanel=true} | | [StandardWidth|Worksheet.StandardWidth] | {excerpt-include:Worksheet.StandardWidth|nopanel=true} | | [StandardWidthInChars|Worksheet.StandardWidthInChars] | {excerpt-include:Worksheet.StandardWidthInChars|nopanel=true} | | [SummaryColumns|Worksheet.SummaryColumns] | {excerpt-include:Worksheet.SummaryColumns|nopanel=true} | | [SummaryRows|Worksheet.SummaryRows] | {excerpt-include:Worksheet.SummaryRows|nopanel=true} | | [TabColor|Worksheet.TabColor] | {excerpt-include:Worksheet.TabColor|nopanel=true} | | [Workbook|Worksheet.Workbook] | {excerpt-include:Worksheet.Workbook|nopanel=true} | | [ViewState|Worksheet.ViewState] | {excerpt-include:Worksheet.ViewState|nopanel=true} | | [Visibility|Worksheet.Visibility] | {excerpt-include:Worksheet.Visibility|nopanel=true} | | [ZoomPercentage|Worksheet.ZoomPercentage] | {excerpt-include:Worksheet.ZoomPercentage|nopanel=true} | {indexers} || Name || Description || | [Item(Int32, Int32)|Worksheet.Item(Int32, Int32)] | {excerpt-include:Worksheet.Item(Int32, Int32)|nopanel=true} | | [Item(String)|Worksheet.Item(String)] | {excerpt-include:Worksheet.Item(String)|nopanel=true} | {methods} || Name || Description || | [CopyPaste(Cell, Area)|Worksheet.CopyPaste(Cell, Area)] | {excerpt-include:Worksheet.CopyPaste(Cell, Area)|nopanel=true} | | [CopyPaste(Cell, Area, CopyPasteProperties)|Worksheet.CopyPaste(Cell, Area, CopyPasteProperties)] | {excerpt-include:Worksheet.CopyPaste(Cell, Area, CopyPasteProperties)|nopanel=true} | | [CopyPaste(Int32, Int32, Area)|Worksheet.CopyPaste(Int32, Int32, Area)] | {excerpt-include:Worksheet.CopyPaste(Int32, Int32, Area)|nopanel=true} | | [CopyPaste(Int32, Int32, Area, CopyPasteProperties)|Worksheet.CopyPaste(Int32, Int32, Area, CopyPasteProperties)] | {excerpt-include:Worksheet.CopyPaste(Int32, Int32, Area, CopyPasteProperties)|nopanel=true} | | [CopyPaste(String, Area, CopyPasteProperties)|Worksheet.CopyPaste(String, Area, CopyPasteProperties)] | {excerpt-include:Worksheet.CopyPaste(String, Area, CopyPasteProperties)|nopanel=true} | | [CopyPaste(String, Area)|Worksheet.CopyPaste(String, Area)] | {excerpt-include:Worksheet.CopyPaste(String, Area)|nopanel=true} | | [CreateAnchor(Int32, Int32, Double, Double)|Worksheet.CreateAnchor(Int32, Int32, Double, Double)] | {excerpt-include:Worksheet.CreateAnchor(Int32, Int32, Double, Double)|nopanel=true} | | [CreateArea(Int32, Int32, Int32, Int32)|Worksheet.CreateArea(Int32, Int32, Int32, Int32)] | {excerpt-include:Worksheet.CreateArea(Int32, Int32, Int32, Int32)|nopanel=true} | | [CreateArea(String)|Worksheet.CreateArea(String)] | {excerpt-include:Worksheet.CreateArea(String)|nopanel=true} | | [CreateAreaOfColumns(Int32, Int32)|Worksheet.CreateAreaOfColumns(Int32, Int32)] | {excerpt-include:Worksheet.CreateAreaOfColumns(Int32, Int32)|nopanel=true} | | [CreateAreaOfRows(Int32, Int32)|Worksheet.CreateAreaOfRows(Int32, Int32)] | {excerpt-include:Worksheet.CreateAreaOfRows(Int32, Int32)|nopanel=true} | | [CreateNamedRange(Int32, Int32, Int32, Int32, String)|Worksheet.CreateNamedRange(Int32, Int32, Int32, Int32, String)] | {excerpt-include:Worksheet.CreateNamedRange(Int32, Int32, Int32, Int32, String)|nopanel=true} | | [CreateNamedRange(String, String)|Worksheet.CreateNamedRange(String, String)] | {excerpt-include:Worksheet.CreateNamedRange(String, String)|nopanel=true} | | [CreateRange(String)|Worksheet.CreateRange(String)] | {excerpt-include:Worksheet.CreateRange(String)|nopanel=true} | | [DeleteColumn(Int32)|Worksheet.DeleteColumn(Int32)] | {excerpt-include:Worksheet.DeleteColumn(Int32)|nopanel=true} | | [DeleteColumns(Int32, Int32)|Worksheet.DeleteColumns(Int32, Int32)] | {excerpt-include:Worksheet.DeleteColumns(Int32, Int32)|nopanel=true} | | [DeleteRow(Int32)|Worksheet.DeleteRow(Int32)] | {excerpt-include:Worksheet.DeleteRow(Int32)|nopanel=true} | | [DeleteRows(Int32, Int32)|Worksheet.DeleteRows(Int32, Int32)] | {excerpt-include:Worksheet.DeleteRows(Int32, Int32)|nopanel=true} | | [GetColumnProperties(Int32)|Worksheet.GetColumnProperties(Int32)] | {excerpt-include:Worksheet.GetColumnProperties(Int32)|nopanel=true} | | [GetNamedObject(String)|Worksheet.GetNamedObject(String)] | {excerpt-include:Worksheet.GetNamedObject(String)|nopanel=true} | | [GetNamedRange(String)|Worksheet.GetNamedRange(String)] | {excerpt-include:Worksheet.GetNamedRange(String)|nopanel=true} | | [GetRowProperties(Int32)|Worksheet.GetRowProperties(Int32)] | {excerpt-include:Worksheet.GetRowProperties(Int32)|nopanel=true} | | [GroupColumns(Int32, Int32, Boolean)|Worksheet.GroupColumns(Int32, Int32, Boolean)] | {excerpt-include:Worksheet.GroupColumns(Int32, Int32, Boolean)|nopanel=true} | | [GroupRows(Int32, Int32, Boolean)|Worksheet.GroupRows(Int32, Int32, Boolean)] | {excerpt-include:Worksheet.GroupRows(Int32, Int32, Boolean)|nopanel=true} | | [ImportData(Object()(), Cell)|Worksheet.ImportData(Object()(), Cell)] | {excerpt-include:Worksheet.ImportData(Object()(), Cell)|nopanel=true} | | [ImportData(Object()(), String(), Cell, DataImportProperties)|Worksheet.ImportData(Object()(), String(), Cell, DataImportProperties)] | {excerpt-include:Worksheet.ImportData(Object()(), String(), Cell, DataImportProperties)|nopanel=true} | | [ImportData(System.Data.DataTable, Cell)|Worksheet.ImportData(System.Data.DataTable, Cell)] | {excerpt-include:Worksheet.ImportData(System.Data.DataTable, Cell)|nopanel=true} | | [ImportData(System.Data.DataTable, Cell, DataImportProperties)|Worksheet.ImportData(System.Data.DataTable, Cell, DataImportProperties)] | {excerpt-include:Worksheet.ImportData(System.Data.DataTable, Cell, DataImportProperties)|nopanel=true} | | [ImportData(System.Data.DataView, Cell)|Worksheet.ImportData(System.Data.DataView, Cell)] | {excerpt-include:Worksheet.ImportData(System.Data.DataView, Cell)|nopanel=true} | | [ImportData(System.Data.DataView, Cell, DataImportProperties)|Worksheet.ImportData(System.Data.DataView, Cell, DataImportProperties)] | {excerpt-include:Worksheet.ImportData(System.Data.DataView, Cell, DataImportProperties)|nopanel=true} | | [ImportData(Object(,), Cell)|Worksheet.ImportData(Object(,), Cell)] | {excerpt-include:Worksheet.ImportData(Object(,), Cell)|nopanel=true} | | [ImportData(Object(,), String(), Cell, DataImportProperties)|Worksheet.ImportData(Object(,), String(), Cell, DataImportProperties)] | {excerpt-include:Worksheet.ImportData(Object(,), String(), Cell, DataImportProperties)|nopanel=true} | | [ImportData(System.Data.IDataReader, Cell)|Worksheet.ImportData(System.Data.IDataReader, Cell)] | {excerpt-include:Worksheet.ImportData(System.Data.IDataReader, Cell)|nopanel=true} | | [ImportData(System.Data.IDataReader, Cell, DataImportProperties)|Worksheet.ImportData(System.Data.IDataReader, Cell, DataImportProperties)] | {excerpt-include:Worksheet.ImportData(System.Data.IDataReader, Cell, DataImportProperties)|nopanel=true} | | [InsertColumn(Int32)|Worksheet.InsertColumn(Int32)] | {excerpt-include:Worksheet.InsertColumn(Int32)|nopanel=true} | | [InsertColumn(Int32, ColumnInsertBehavior)|Worksheet.InsertColumn(Int32, Style.ColumnInsertBehavior)] | {excerpt-include:Worksheet.InsertColumn(Int32, Style.ColumnInsertBehavior)|nopanel=true} | | [InsertColumn(Int32, ColumnInsertBehavior, ColumnInsertBehavior)|Worksheet.InsertColumn(Int32, Style.ColumnInsertBehavior, Style.ColumnInsertBehavior)] | {excerpt-include:Worksheet.InsertColumn(Int32, Style.ColumnInsertBehavior, Style.ColumnInsertBehavior)|nopanel=true} | | [InsertColumns(Int32, Int32)|Worksheet.InsertColumns(Int32, Int32)] | {excerpt-include:Worksheet.InsertColumns(Int32, Int32)|nopanel=true} | | [InsertColumns(Int32, Int32, ColumnInsertBehavior)|Worksheet.InsertColumns(Int32, Int32, Style.ColumnInsertBehavior)] | {excerpt-include:Worksheet.InsertColumns(Int32, Int32, Style.ColumnInsertBehavior)|nopanel=true} | | [InsertColumns(Int32, Int32, ColumnInsertBehavior, ColumnInsertBehavior)|Worksheet.InsertColumns(Int32, Int32, Style.ColumnInsertBehavior, Style.ColumnInsertBehavior)] | {excerpt-include:Worksheet.InsertColumns(Int32, Int32, Style.ColumnInsertBehavior, Style.ColumnInsertBehavior)|nopanel=true} | | [InsertHorizontalPageBreak(Cell)|Worksheet.InsertHorizontalPageBreak(Cell)] | {excerpt-include:Worksheet.InsertHorizontalPageBreak(Cell)|nopanel=true} | | [InsertRow(Int32)|Worksheet.InsertRow(Int32)] | {excerpt-include:Worksheet.InsertRow(Int32)|nopanel=true} | | [InsertRow(Int32, RowInsertBehavior)|Worksheet.InsertRow(Int32, Style.RowInsertBehavior)] | {excerpt-include:Worksheet.InsertRow(Int32, Style.RowInsertBehavior)|nopanel=true} | | [InsertRow(Int32, RowInsertBehavior, RowInsertBehavior)|Worksheet.InsertRow(Int32, Style.RowInsertBehavior, Style.RowInsertBehavior)] | {excerpt-include:Worksheet.InsertRow(Int32, Style.RowInsertBehavior, Style.RowInsertBehavior)|nopanel=true} | | [InsertRows(Int32, Int32)|Worksheet.InsertRows(Int32, Int32)] | {excerpt-include:Worksheet.InsertRows(Int32, Int32)|nopanel=true} | | [InsertRows(Int32, Int32, RowInsertBehavior)|Worksheet.InsertRows(Int32, Int32, Style.RowInsertBehavior)] | {excerpt-include:Worksheet.InsertRows(Int32, Int32, Style.RowInsertBehavior)|nopanel=true} | | [InsertRows(Int32, Int32, RowInsertBehavior, RowInsertBehavior)|Worksheet.InsertRows(Int32, Int32, Style.RowInsertBehavior, Style.RowInsertBehavior)] | {excerpt-include:Worksheet.InsertRows(Int32, Int32, Style.RowInsertBehavior, Style.RowInsertBehavior)|nopanel=true} | | [InsertVerticalPageBreak(Cell)|Worksheet.InsertVerticalPageBreak(Cell)] | {excerpt-include:Worksheet.InsertVerticalPageBreak(Cell)|nopanel=true} | | [Protect(String)|Worksheet.Protect(String)] | {excerpt-include:Worksheet.Protect(String)|nopanel=true} | | [Select()|Worksheet.Select()] | {excerpt-include:Worksheet.Select()|nopanel=true} | | [UngroupColumns(Int32, Int32)|Worksheet.UngroupColumns(Int32, Int32)] | {excerpt-include:Worksheet.UngroupColumns(Int32, Int32)|nopanel=true} | | [UngroupRows(Int32, Int32)|Worksheet.UngroupRows(Int32, Int32)] | {excerpt-include:Worksheet.UngroupRows(Int32, Int32)|nopanel=true} | | [Unprotect()|Worksheet.Unprotect()] | {excerpt-include:Worksheet.Unprotect()|nopanel=true} | {extensionMethods} {introducedin:7.5} || Overload || Description || | [ImportData(Cell, Microsoft.SharePoint.SPList, DataImportProperties)|SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList, DataImportProperties)] | {excerpt-include:SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList, DataImportProperties)|nopanel=true} | | [ImportData(Cell, Microsoft.SharePoint.SPList)|SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList)] | {excerpt-include:SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList)|nopanel=true} | | [ImportData(Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)|SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)] | {excerpt-include:SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)|nopanel=true} | | [ImportData(Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)|SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)] | {excerpt-include:SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)|nopanel=true} | {classes} || Name || Description || | [Constants|Worksheet.Constants] | {excerpt-include:Worksheet.Constants|nopanel=true} | | [SheetViewState|Worksheet.SheetViewState] | {excerpt-include:Worksheet.SheetViewState|nopanel=true} | | [SheetVisibility|Worksheet.SheetVisibility] | {excerpt-include:Worksheet.SheetVisibility|nopanel=true} | | [SummaryColumnsLocation|Worksheet.SummaryColumnsLocation] | {excerpt-include:Worksheet.SummaryColumnsLocation|nopanel=true} | | [SummaryRowsLocation|Worksheet.SummaryRowsLocation] | {excerpt-include:Worksheet.SummaryRowsLocation|nopanel=true} | |
Page History
Overview
Content Tools