OfficeWriter Documentation
.
ExcelWriter v8 Docs
Space Shortcuts
Page tree
ConfigureSpace tools

Versions Compared

Old Version 5

changes.mady.by.user Anonymous

Saved on

compared with

New Version Current

changes.mady.by.user Anonymous

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

A Workbook object represents an Excel workbook. To return a Workbook object: Call ExcelApplication.Create() to create a new Excel workbook. Call ExcelApplication.Open() to open an existing Excel workbook.

Signature
C#
C#
[DefaultMember("Item")]
 public sealed class Workbook : System.Collections.Generic.IEnumerable<Worksheet>
{signature}{signature:
}
Signature
vb.net
vb.net
<DefaultMember("Item")> _
	Public NotInheritable Class Workbook
		Implements System.Collections.Generic.IEnumerable(Of Worksheet)
{signature}
{example}{code:csharp|title=C#}
Example
Code Block
csharp
csharp
titleC#


          //--- 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:
 Code Block
vb.net
|title=
vb.net
titlevb.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:
 Properties
Name
Description
DisplayTabs
 Excerpt Include
Workbook.DisplayTabs
Workbook.DisplayTabs
nopaneltrue
DocumentProperties
 Excerpt Include
Workbook.DocumentProperties
Workbook.DocumentProperties
nopaneltrue
EncryptPassword
 Excerpt Include
Workbook.EncryptPassword
Workbook.EncryptPassword
nopaneltrue
ExcludeMacros
 Excerpt Include
Workbook.ExcludeMacros
Workbook.ExcludeMacros
nopaneltrue
FirstDisplayedTab
 Excerpt Include
Workbook.FirstDisplayedTab
Workbook.FirstDisplayedTab
nopaneltrue
Height
 Excerpt Include
Workbook.Height
Workbook.Height
nopaneltrue
HorizontalPosition
 Excerpt Include
Workbook.HorizontalPosition
Workbook.HorizontalPosition
nopaneltrue
IsProtected
 Excerpt Include
Workbook.IsProtected
Workbook.IsProtected
nopaneltrue
NamedRanges
 Excerpt Include
Workbook.NamedRanges
Workbook.NamedRanges
nopaneltrue
NumberFormat
 Excerpt Include
Workbook.NumberFormat
Workbook.NumberFormat
nopaneltrue
Palette
 Excerpt Include
Workbook.Palette
Workbook.Palette
nopaneltrue
PasswordToModify
 Excerpt Include
Workbook.PasswordToModify
Workbook.PasswordToModify
nopaneltrue
ProtectPasswordHash
 Excerpt Include
Workbook.ProtectPasswordHash
Workbook.ProtectPasswordHash
nopaneltrue
ReadOnly
 Excerpt Include
Workbook.ReadOnly
Workbook.ReadOnly
nopaneltrue
ReadOnlyRecommended
 Excerpt Include
Workbook.ReadOnlyRecommended
Workbook.ReadOnlyRecommended
nopaneltrue
ShowHorizontalScrollBar
 Excerpt Include
Workbook.ShowHorizontalScrollBar
Workbook.ShowHorizontalScrollBar
nopaneltrue
ShowVerticalScrollBar
 Excerpt Include
Workbook.ShowVerticalScrollBar
Workbook.ShowVerticalScrollBar
nopaneltrue
TabRatio
 Excerpt Include
Workbook.TabRatio
Workbook.TabRatio
nopaneltrue
UseRCFormulaNotation
 Excerpt Include
Workbook.UseRCFormulaNotation
Workbook.UseRCFormulaNotation
nopaneltrue
VerticalPosition
 Excerpt Include
Workbook.VerticalPosition
Workbook.VerticalPosition
nopaneltrue
Width
 Excerpt Include
Workbook.Width
Workbook.Width
nopaneltrue
Worksheets
 Excerpt Include
Workbook.Worksheets
Workbook.Worksheets
nopaneltrue
 Indexers
Name
Description
Item(Int32)
 Excerpt Include
Workbook.Item(Int32)
Workbook.Item(Int32)
nopaneltrue
Item(String)
 Excerpt Include
Workbook.Item(String)
Workbook.Item(String)
nopaneltrue
 Methods
Name
Description
CreateConditionalFormat()
 Excerpt Include
Workbook.CreateConditionalFormat()
Workbook.CreateConditionalFormat()
nopaneltrue
CreateCopyPasteProperties(CopyPasteType)
 Excerpt Include
Workbook.CreateCopyPasteProperties(CopyPasteProperties.CopyPasteType)
Workbook.CreateCopyPasteProperties(CopyPasteProperties.CopyPasteType)
...
nopanel
...
true
CreateDataImportProperties()
...
 Excerpt Include
Workbook.CreateDataImportProperties()
...
Workbook.CreateDataImportProperties()
...
nopanel
...
true
CreateDataValidation(ValidationType, 
...
 ComparisonType, 
...
 Object)
...
 Excerpt Include
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 Object)
...
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 Object)
...
nopanel
...
true
CreateDataValidation(ValidationType, 
...
 ComparisonType, 
...
 Object, 
...
 Object)
...
 Excerpt Include
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 Object, 
...
 Object)
...
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 Object, 
...
 Object)
...
nopanel
...
true
CreateDataValidation(ValidationType, 
...
 ComparisonType, 
...
 String)
...
 Excerpt Include
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 String)
...
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 String)
...
nopanel
...
true
CreateDataValidation(ValidationType, 
...
 ComparisonType, 
...
 String, 
...
 String)
...
 Excerpt Include
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 String, 
...
 String)
...
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 DataValidation.ComparisonType, 
...
 String, 
...
 String)
...
nopanel
...
true
CreateDataValidation(ValidationType, 
...
 Object)
...
 Excerpt Include
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 Object)
...
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 Object)
...
nopanel
...
true
CreateDataValidation(ValidationType, 
...
 String)
...
 Excerpt Include
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 String)
...
Workbook.CreateDataValidation(DataValidation.ValidationType, 
...
 String)
...
nopanel
...
true
CreateNamedRange(Area(), 
...
 String)
...
 Excerpt Include
Workbook.CreateNamedRange(Area(), 
...
 String)
...
Workbook.CreateNamedRange(Area(), 
...
 String)
...
nopanel
...
true
CreateNamedRange(String, 
...
 String)
...
 Excerpt Include
Workbook.CreateNamedRange(String, 
...
 String)
...
Workbook.CreateNamedRange(String, 
...
 String)
...
nopanel
...
true
CreateNamedStyle(String)
...
 Excerpt Include
Workbook.CreateNamedStyle(String)
...
Workbook.CreateNamedStyle(String)
...
nopanel
...
true
CreateRange(String)
...
 Excerpt Include
Workbook.CreateRange(String)
...
Workbook.CreateRange(String)
...
nopanel
...
true
CreateRange(Area())
...
 Excerpt Include
Workbook.CreateRange(Area())
...
Workbook.CreateRange(Area())
...
nopanel
...
true
CreateStyle()
...
 Excerpt Include
Workbook.CreateStyle()
...
Workbook.CreateStyle()
...
nopanel
...
true
GetEnumerator()
...
 Excerpt Include
Workbook.GetEnumerator()
...
Workbook.GetEnumerator()
...
nopanel
...
true
GetNamedObject(String)
...
 Excerpt Include
Workbook.GetNamedObject(String)
...
Workbook.GetNamedObject(String)
...
nopanel
...
true
GetNamedRange(String)
...
 Excerpt Include
Workbook.GetNamedRange(String)
...
Workbook.GetNamedRange(String)
...
nopanel
...
true
GetNamedStyle(String)
...
 Excerpt Include
Workbook.GetNamedStyle(String)
...
Workbook.GetNamedStyle(String)
...
nopanel
...
true
GetTextHeight(String, 
...
 Font, 
...
 Double)
...
 Excerpt Include
Workbook.GetTextHeight(String, 
...
 Font, 
...
 Double)
...
Workbook.GetTextHeight(String, 
...
 Font, 
...
 Double)
...
nopanel
...
true
GetTextWidth(String, 
...
 Font, 
...
 Double)
...
 Excerpt Include
Workbook.GetTextWidth(String, 
...
 Font, 
...
 Double)
...
Workbook.GetTextWidth(String, 
...
 Font, 
...
 Double)
...
nopanel
...
true
Protect(String)
...
 Excerpt Include
Workbook.Protect(String)
...
Workbook.Protect(String)
...
nopanel
...
true
Unprotect()
...
 Excerpt Include
Workbook.Unprotect()
...
Workbook.Unprotect()
...
nopanel
...
true
...