Page History

{description}
{excerpt}A [Workbook|Workbook]  object represents an Excel workbook. To return a  {{Workbook}} object:  Call [ExcelApplication.Create\(\)|ExcelApplication.Create()]  to create a new Excel workbook.  Call [ExcelApplication.Open\(\)|ExcelApplication.Open]  to open an existing Excel workbook.{excerpt}
{signature:C#}
[DefaultMember("Item")]
 public sealed class Workbook : System.Collections.Generic.IEnumerable<Worksheet>
{signature}{signature:vb.net}
<DefaultMember("Item")> _
	Public NotInheritable Class Workbook
		Implements System.Collections.Generic.IEnumerable(Of Worksheet)
{signature}
{example}{code:csharp|title=C#}

          //--- Create a new Workbook
          ExcelApplication xla = new ExcelApplication();
          Workbook wb = xla.Create();

          //--- Open an existing Workbook
          ExcelApplication xla = new ExcelApplication();
          Workbook wb = xla.Open(@"C:\Reports\Report.xls");
        {code}
{code:vb.net|title=vb.net}

          '--- Create a new Workbook
          Dim xla As New ExcelApplication()
          Dim wb As Workbook = xla.Create()

          '--- Open an existing Workbook
          Dim xla As New ExcelApplication()
          Dim wb As Workbook = xla.Open("C:\Reports\Report.xls")
        {code}

{example}
{properties}
||Name||Description||
|[DisplayTabs|Workbook.DisplayTabs]|{excerpt-include:Workbook.DisplayTabs|nopanel=true}|
|[DocumentProperties|Workbook.DocumentProperties]|{excerpt-include:Workbook.DocumentProperties|nopanel=true}|
|[EncryptPassword|Workbook.EncryptPassword]|{excerpt-include:Workbook.EncryptPassword|nopanel=true}|
|[ExcludeMacros|Workbook.ExcludeMacros]|{excerpt-include:Workbook.ExcludeMacros|nopanel=true}|
|[FirstDisplayedTab|Workbook.FirstDisplayedTab]|{excerpt-include:Workbook.FirstDisplayedTab|nopanel=true}|
|[Height|Workbook.Height]|{excerpt-include:Workbook.Height|nopanel=true}|
|[HorizontalPosition|Workbook.HorizontalPosition]|{excerpt-include:Workbook.HorizontalPosition|nopanel=true}|
|[IsProtected|Workbook.IsProtected]|{excerpt-include:Workbook.IsProtected|nopanel=true}|
|[NamedRanges|Workbook.NamedRanges]|{excerpt-include:Workbook.NamedRanges|nopanel=true}|
|[NumberFormat|Workbook.NumberFormat]|{excerpt-include:Workbook.NumberFormat|nopanel=true}|
|[Palette|Workbook.Palette]|{excerpt-include:Workbook.Palette|nopanel=true}|
|[PasswordToModify|Workbook.PasswordToModify]|{excerpt-include:Workbook.PasswordToModify|nopanel=true}|
|[ProtectPasswordHash|Workbook.ProtectPasswordHash]|{excerpt-include:Workbook.ProtectPasswordHash|nopanel=true}|
|[ReadOnly|Workbook.ReadOnly]|{excerpt-include:Workbook.ReadOnly|nopanel=true}|
|[ReadOnlyRecommended|Workbook.ReadOnlyRecommended]|{excerpt-include:Workbook.ReadOnlyRecommended|nopanel=true}|
|[ShowHorizontalScrollBar|Workbook.ShowHorizontalScrollBar]|{excerpt-include:Workbook.ShowHorizontalScrollBar|nopanel=true}|
|[ShowVerticalScrollBar|Workbook.ShowVerticalScrollBar]|{excerpt-include:Workbook.ShowVerticalScrollBar|nopanel=true}|
|[TabRatio|Workbook.TabRatio]|{excerpt-include:Workbook.TabRatio|nopanel=true}|
|[UseRCFormulaNotation|Workbook.UseRCFormulaNotation]|{excerpt-include:Workbook.UseRCFormulaNotation|nopanel=true}|
|[VerticalPosition|Workbook.VerticalPosition]|{excerpt-include:Workbook.VerticalPosition|nopanel=true}|
|[Width|Workbook.Width]|{excerpt-include:Workbook.Width|nopanel=true}|
|[Worksheets|Workbook.Worksheets]|{excerpt-include:Workbook.Worksheets|nopanel=true}|
{indexers}
||Name||Description||
|[Item(Int32)|Workbook.Item(Int32)]|{excerpt-include:Workbook.Item(Int32)|nopanel=true}|
|[Item(String)|Workbook.Item(String)]|{excerpt-include:Workbook.Item(String)|nopanel=true}|

{methods}
||Name||Description||
|[CreateConditionalFormat()|Workbook.CreateConditionalFormat()]|{excerpt-include:Workbook.CreateConditionalFormat()|nopanel=true}|
|[CreateCopyPasteProperties(CopyPasteType)|Workbook.CreateCopyPasteProperties(CopyPasteProperties.CopyPasteType)]|{excerpt-include:Workbook.CreateCopyPasteProperties(CopyPasteProperties.CopyPasteType)|nopanel=true}|
|[CreateDataImportProperties()|Workbook.CreateDataImportProperties()]|{excerpt-include:Workbook.CreateDataImportProperties()|nopanel=true}|
|[CreateDataValidation(ValidationType, ComparisonType, Object)|Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, Object)]|{excerpt-include:Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, Object)|nopanel=true}|
|[CreateDataValidation(ValidationType, ComparisonType, Object, Object)|Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, Object, Object)]|{excerpt-include:Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, Object, Object)|nopanel=true}|
|[CreateDataValidation(ValidationType, ComparisonType, String)|Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, String)]|{excerpt-include:Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, String)|nopanel=true}|
|[CreateDataValidation(ValidationType, ComparisonType, String, String)|Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, String, String)]|{excerpt-include:Workbook.CreateDataValidation(DataValidation.ValidationType, DataValidation.ComparisonType, String, String)|nopanel=true}|
|[CreateDataValidation(ValidationType, Object)|Workbook.CreateDataValidation(DataValidation.ValidationType, Object)]|{excerpt-include:Workbook.CreateDataValidation(DataValidation.ValidationType, Object)|nopanel=true}|
|[CreateDataValidation(ValidationType, String)|Workbook.CreateDataValidation(DataValidation.ValidationType, String)]|{excerpt-include:Workbook.CreateDataValidation(DataValidation.ValidationType, String)|nopanel=true}|
|[CreateNamedRange(Area(), String)|Workbook.CreateNamedRange(Area(), String)]|{excerpt-include:Workbook.CreateNamedRange(Area(), String)|nopanel=true}|
|[CreateNamedRange(String, String)|Workbook.CreateNamedRange(String, String)]|{excerpt-include:Workbook.CreateNamedRange(String, String)|nopanel=true}|
|[CreateNamedStyle(String)|Workbook.CreateNamedStyle(String)]|{excerpt-include:Workbook.CreateNamedStyle(String)|nopanel=true}|
|[CreateRange(String)|Workbook.CreateRange(String)]|{excerpt-include:Workbook.CreateRange(String)|nopanel=true}|
|[CreateRange(Area())|Workbook.CreateRange(Area())]|{excerpt-include:Workbook.CreateRange(Area())|nopanel=true}|
|[CreateStyle()|Workbook.CreateStyle()]|{excerpt-include:Workbook.CreateStyle()|nopanel=true}|
|[GetEnumerator()|Workbook.GetEnumerator()]|{excerpt-include:Workbook.GetEnumerator()|nopanel=true}|
|[GetNamedObject(String)|Workbook.GetNamedObject(String)]|{excerpt-include:Workbook.GetNamedObject(String)|nopanel=true}|
|[GetNamedRange(String)|Workbook.GetNamedRange(String)]|{excerpt-include:Workbook.GetNamedRange(String)|nopanel=true}|
|[GetNamedStyle(String)|Workbook.GetNamedStyle(String)]|{excerpt-include:Workbook.GetNamedStyle(String)|nopanel=true}|
|[GetTextHeight(String, Font, Double)|Workbook.GetTextHeight(String, Font, Double)]|{excerpt-include:Workbook.GetTextHeight(String, Font, Double)|nopanel=true}|
|[GetTextWidth(String, Font, Double)|Workbook.GetTextWidth(String, Font, Double)]|{excerpt-include:Workbook.GetTextWidth(String, Font, Double)|nopanel=true}|
|[Protect(String)|Workbook.Protect(String)]|{excerpt-include:Workbook.Protect(String)|nopanel=true}|
|[Unprotect()|Workbook.Unprotect()]|{excerpt-include:Workbook.Unprotect()|nopanel=true}|