Manual Excel Componentone

ComponentOne
Excel for .NET
Copyright 1987-2013 GrapeCity, Inc. All rights reserved.

ComponentOne, a division of GrapeCity
201 South Highland Avenue, Third Floor
Pittsburgh, PA 15206 USA
Internet:
[email protected]
Web site:
http://www.componentone.com
Sales
E-mail: [email protected]
Telephone: 1.800.858.2739 or 1.412.681.4343 (Pittsburgh, PA USA Office)
Trademarks
The ComponentOne product name is a trademark and ComponentOne is a registered trademark of GrapeCity, Inc. All other
trademarks used herein are the properties of their respective owners.
Warranty
ComponentOne warrants that the original CD (or diskettes) are free from defects in material and workmanship, assuming
normal use, for a period of 90 days from the date of purchase. If a defect occurs during this time, you may return the defective
CD (or disk) to ComponentOne, along with a dated proof of purchase, and ComponentOne will replace it at no charge. After
90 days, you can obtain a replacement for a defective CD (or disk) by sending it and a check for $25 (to cover postage and
handling) to ComponentOne.
Except for the express warranty of the original CD (or disks) set forth here, ComponentOne makes no other warranties, express
or implied. Every attempt has been made to ensure that the information contained in this manual is correct as of the time it was
written. We are not responsible for any errors or omissions. ComponentOnes liability is limited to the amount you paid for the
product. ComponentOne is not liable for any special, consequential, or other damages for any reason.
Copying and Distribution
While you are welcome to make backup copies of the software for your own use and protection, you are not permitted to make
copies for the use of anyone else. We put a lot of time and effort into creating this product, and we appreciate your support in
seeing that it is used by licensed users only.
This manual was produced using ComponentOne Doc-To-Help.
Table of Contents
ComponentOne Excel for .NET Overview ........................................................................................... 3
Help with ComponentOne Studio for WinForms............................................................................ 3
Migrating an Excel for .NET Project to Visual Studio 2005 ............................................................. 3
Excel for .NET Limitations ............................................................................................................... 4
Key Features........................................................................................................................................ 5
Excel for .NET QuickStart .................................................................................................................... 6
Step 1 of 4: Setting up the Project .................................................................................................. 7
Step 2 of 4: Adding Content to a C1XLBook.................................................................................... 7
Step 3 of 4: Formatting the Content ............................................................................................... 8
Step 4 of 4: Saving and Opening the XLS File ................................................................................ 10
Using Excel for .NET .......................................................................................................................... 11
Creating Documents ..................................................................................................................... 12
Worksheets ................................................................................................................................... 15
Rows and Columns ........................................................................................................................ 16
Cells ............................................................................................................................................... 16
Styles ............................................................................................................................................. 17
Excel for .NET Frequently Asked Questions ...................................................................................... 17
Excel for .NET Task-Based Help ......................................................................................................... 18
Adding Content to a Workbook .................................................................................................... 19
Merging Cells ................................................................................................................................ 21
Formatting Cells ............................................................................................................................ 22
Copying Rows from One Book to Another .................................................................................... 24
Adding an Image to a Cell ............................................................................................................. 26
Adding a Comment to a Cell ......................................................................................................... 33
Adding a Page Break to a Worksheet ........................................................................................... 35
Setting the Calculation Mode for a Workbook ............................................................................. 36
Importing and Exporting OpenXml Files ....................................................................................... 38
Creating Subtotals......................................................................................................................... 40
Saving and Loading CSV Files ........................................................................................................ 43
Excel for .NET Samples ...................................................................................................................... 47

API Reference.................................................................................................................................... 49
C1.C1Excel.4 Assembly ................................................................................................................. 49
Overview ................................................................................................................................... 49
Namespaces .............................................................................................................................. 50
C1.C1Excel Namespace ......................................................................................................... 50
C1.Win.Localization Namespace ......................................................................................... 543
ComponentOne Excel for .NET Overview

Your Excel data is just a simple command away from any of your .NET applications with
ComponentOne Excel for .NET you don't even need to have Microsoft Excel installed! Create or
load XLS files for Excel 97 and later. Excel for .NET supports the new Office 2007 OpenXml format,
which allows you to save smaller, compressed XLSX files.
The main component in Excel for .NET is the C1XLBook object, which represents an Excel
workbook containing one or more sheets. Use the C1XLBook to load existing Excel files or create
new ones. Then add sheets, styles, hyperlinks, images, headers and footers, page breaks and more.
When you are done, save the C1XLBook to a file or a Stream and youre done. Anyone with a copy
of Excel can access your data. Its that easy!
See Also
Help with ComponentOne Studio for WinForms
Migrating an Excel for .NET Project to Visual Studio 2005
Excel for .NET Limitations
Help with ComponentOne Studio for WinForms
Getting Started
For information on installing ComponentOne Studio for WinForms, licensing, technical support,
namespaces and creating a project with the control, please visit Getting Started with Studio for
WinForms.
What's New
For a list of the latest features added to ComponentOne Studio for WinForms, visit What's New in
Studio for WinForms.
Migrating an Excel for .NET Project to Visual Studio 2005

To migrate a project using ComponentOne components to Visual Studio 2005, there are two main
steps that must be performed. First, you must convert your project to Visual Studio 2005, which
includes removing any references to a previous assembly and adding a reference to the new
assembly. Secondly, the .licx file, or licensing file, must be updated in order for the project to run
correctly.
To convert the project:

1.
Open Visual Studio 2005 and select File, Open Project.
2.
3.
4.
5.
6.
7.
8.
Locate the .sln file for the project that you wish to convert to Visual Studio 2005. Select it
and click Open. The Visual Studio Conversion Wizard appears.
Click Next.
Select Yes, create a backup before converting to create a backup of your current project
and click Next.
Click Finish to convert your project to Visual Studio 2005. The Conversion Complete
window appears.
Click Show the conversion log when the wizard is closed if you want to view the
conversion log.
Click Close. The project opens. Now you must remove references to any of the previous
ComponentOne .dlls and add references to the new ones.
Go to the Solution Explorer (View | Solution Explorer), select the project, and click the
Show All Files button.
Note: The Show All Files button does not appear in the Solution Explorer toolbar if the
Solution project node is selected.
9.
Expand the References node, right-click C1.Common and select Remove. Also remove
c1.c1excel the same way.
10. Right-click the References node and select Add Reference.
11. Browse and select C1.C1Excel.2.dll. Click OK to add it to the project.
To update the .licx file:

1.
2.
3.
4.
1. In the Solution Explorer, right-click the licenses.licx file and select Delete.
2. Click OK to permanently delete licenses.licx. The project must be rebuilt to create a new,
updated version of the .licx file.
3. Click the Start Debugging button to compile and run the project. The new .licx file may
not be visible in the Solution Explorer.
4. Select File, Close to close the form and then double-click the Form.vb or Form.cs file in
the Solution Explorer to reopen it. The new licenses.licx file appears in the list of files.
The migration process is complete.
Excel for .NET Limitations
There is no support for the PivotTable declaration.

There is no support for macros.
When saving a formatted cell using the Fill property from an .xlsx to an .xls file, an
ArgumentException is thrown if the rows and columns in the .xlsx format are more than the
maximum for the .xls format.
C1Excel does not support RTF (with bold/italic/underline text) records.
A chart object is not saved when a BIFF8 file is loaded and saved using C1Excel.
There is no support for the Protect Structure/Windows:
When ComponentOne Excel for .NET is used to load a Microsoft Excel file that is
password protected for Structure/Windows: a "Central dir not found" exception or
FileLoadException may occur.
The following image shows how a workbook has been password protected for Structure
and Windows in Microsoft Excel 2010:
Key Features
The following are some of the main features of ComponentOne Excel for .NET that you may find
useful:
Save or load a workbook with one command

Excel for .NET is easy-to-use, allowing you to use a single command to load or save a
workbook and manipulate sheets as if they were grid controls.
Read and write data in individual cells

After loading or creating a C1XLBook, you can access data in individual sheets as if they
were a simple grid. For example:
XLSheet sheet = C1XLBook.Sheets[0];
sheet[0, 0].Value = DateTime.Now;
Format the data in each cell.
The format associated with each cell is as easy to access as the data stored in the cell. For
example:
XLStyle style = new XLStyle(c1XLBook1);
style.Format = "dd-MM-yyyy";
style.Font = new Font("Courier New", 14);
XLSheet sheet = C1XLBook.Sheets[0];
sheet[0, 0].Value = DateTime.Now;
sheet[0, 0].Style = style;
Use Excel for .NET to export to XLS files

Other ComponentOne components use Excel for .NET to export XLS files. For example,
C1Report uses Excel for .NET to create XLS versions of reports so they can be viewed and
edited by anyone with a copy of Microsoft Excel.
Reads and writes .xls and .xlsx files without using Microsoft Excel
Excel for .NET reads and writes .xls (Excel 97 and later) and xlsx (OpenXml format) files, the
latter of which can be reused and easily exchanged or compressed to create smaller file
sizes. You don't even need to have Microsoft Excel installed.
Create and position images within a cell

Not only can you add images to cells, but now you can specify the cell size, the position of
the image within the cell and whether the image is scaled, clipped, or stretched to fit the
cell.
Save and load files to and from streams

Workbooks can now be directly read to and written from memory streams with new
overloads for the Load and the Save methods so you no longer have to use temporary files.
Add images to the header and footer of a sheet

Use properties in the XLPrintSettings class to add images to the left, center, or right part of
a sheet's header or footer.
Excel for .NET QuickStart

This quick start guide will familiarize you with some of the features of Excel for .NET. In this quick
start you will learn how to add a C1XLBook to the project, add formatted data to the workbook, and
save and open the XLS file.
See Also
6
Step 1 of 4: Setting up the Project

Step 2 of 4: Adding Content to a C1XLBook
Step 3 of 4: Formatting the Content
Step 4 of 4: Saving and Opening the XLS File
Step 1 of 4: Setting up the Project

In this step you will add a C1XLBook component to your form. Each book is composed of one or
more sheets.
1. Create a new .NET 2.0 project.
2. In the Toolbox, double-click the C1XLBook icon to add the C1XLBook component to
your project. The C1XLBook component will appear in the component tray below the form.
3. Double-click the form to add the Form1_Load event and switch to code view.
4. Add the Imports (Visual Basic) or using (C#) statement to the code at the top of the
form so you can use all names within the C1.C1Excel namespace.
To write code in Visual Basic
Visual Basic
Copy Code
Imports C1.C1Excel
To write code in C#
C#
Copy Code
using C1.C1Excel;
Now that you have a C1XLBook, you can begin adding content to it.
Step 2 of 4: Adding Content to a C1XLBook

While you are still in code view in the Visual Studio project, add the following code within the
Form_Load event created in Step 1 of 4. This code will add content to the Excel workbook.
Visual Basic
Copy Code
' Add content to the sheet.
Dim i As Integer
Dim sheet as XLSheet = C1XLBook1.Sheets(0)
For i = 0 To 9
sheet(i, 0).Value = (i + 1) * 10
sheet(i, 1).Value = (i + 1) * 100
sheet(i, 2).Value = (i + 1) * 1000
Next i
To write code in C#
C#
Copy Code
// Add content to the sheet.

int i;
C1.C1Excel.XLSheet sheet = c1XLBook1.Sheets[0];
for (i = 0; i <= 9; i++)
{
sheet[i, 0].Value = (i + 1) * 10;
sheet[i, 1].Value = (i + 1) * 100;
sheet[i, 2].Value = (i + 1) * 1000;
}
The first ten rows in the first three columns of the XLS file will be populated with numbers when you
run the project.
Step 3 of 4: Formatting the Content

Next we will format the content using styles. The code in this step should be added after the code
from Step 2 of 4 within the Form_Load event.
1.
Add the following code to create two new styles: style1 and style2.
Visual Basic
Copy Code
'Add style 1.
Dim style1 As New XLStyle(C1XLBook1)
style1.Font = New Font("Tahoma", 9, FontStyle.Bold)

style1.ForeColor = Color.RoyalBlue
' Add style 2.
style2.Font = New Font("Tahoma", 9, FontStyle.Italic)
style2.BackColor = Color.RoyalBlue
style2.ForeColor = Color.White
To write code in C#
Title Text
Copy Code
// Add style 1.
XLStyle style1 = new XLStyle(c1XLBook1);
style1.Font = new Font("Tahoma", 9, FontStyle.Bold);
style1.ForeColor = Color.RoyalBlue;
// Add style 2.
style2.Font = new Font("Tahoma", 9, FontStyle.Italic);
style2.BackColor = Color.RoyalBlue;
style2.ForeColor = Color.White;
2.
Then add the following code to apply the new styles to the content.
Visual Basic
Copy Code
For i = 0 To 9
' Apply styles to the content.
If (i + 1) Mod 2 = 0 Then
sheet(i, 0).Style = style2
Else

End If
Next i
To write code in C#
C#
Copy Code
for (i = 0; i <= 9; i++)

{
// Apply styles to the content.
if ((i + 1) % 2 == 0)
{
sheet[i, 0].Style = style2;
}
else
{
}
}
Step 4 of 4: Saving and Opening the XLS File

Finally, add the following code to save and load the Excel workbook. This code should be added
after the code from Step 3 of 4 within the Form_Load event.
Visual Basic
Copy Code
C1XLBook1.Save("c:\mybook.xls")
10
System.Diagnostics.Process.Start("C:\mybook.xls")
To write code in C#
C#
Copy Code
c1XLBook1.Save(@"c:\mybook.xls");
System.Diagnostics.Process.Start(@"c:\mybook.xls");
Run the program and observe:
Formatted content is added to the workbook.

Congratulations! You've completed the Excel for .NET quick start.
Using Excel for .NET

The following topics explain how to create an XLS file, as well as describe the main Excel for .NET
classes used to create the components that make up the file, which include worksheets, rows and
columns, cells and styles.
11
See Also
Creating Documents
Worksheets
Rows and Columns
Cells
Styles
Creating Documents
To create a new XLS file using Excel for .NET, three steps are required:
1.
2.
3.
Add a C1XLBook component to your project or create a C1XLBook object in code. Each
book is composed of one or more sheets (XLSheet objects).
Add content to the sheets. Each sheet contains cells (XLCell objects) that have a Value and a
Style property.
Save the book to a file using the Save method.
For example, the following code creates a new Excel file with a single sheet containing numbers
from 1 to 100. Note that if you add the C1XLBook component to a form, you can skip the code in
step 1.
Visual Basic
Copy Code
' step 1: create a new workbook

Dim C1XLBook1 As New C1XLBook()
' step 2: write content into some cells
Dim sheet As XLSheet = C1XLBook1.Sheets(0)
Dim i As Integer
For i = 0 To 99
sheet(i, 0).Value = i + 1
Next i
' step 3: save the file
C1XLBook1.Save("c:\temp\hello.xls")
To write code in C#
12
C#
Copy Code
// step 1: create a new workbook

C1XLBook c1XLBook1 = new C1XLBook();
// step 2: write content into some cells
XLSheet sheet = c1XLBook1.Sheets[0];
for (int i = 0; i < 100; i++)
{
sheet[i, 0].Value = i + 1;
}
// step 3: save the file
c1XLBook1.Save(@"c:\temp\hello.xls");
Step 2 is the most interesting one. The code starts by retrieving an XLSheet object that represents
the single worksheet in the new Excel workbook. This sheet is created automatically when you add
or create a new C1XLBook. Then the code uses the sheet indexer to reference cells in the sheet and
assign them values from 1 to 100.
Note that the indexer in the XLSheet object automatically creates cells, if necessary. This makes it
easy to fill worksheets that you create. If you want to find out the sheet dimensions, use the sheet's
Rows.Count and Columns.Count properties.
Of course, you are not limited to assigning values to cells. You can also use styles to format the
cells. Just create one or more XLStyle objects and assign them to cells much like you did values. This
revised version of the code above creates a sheet where even numbers are shown in bold red
characters and odd numbers in italic blue. Note that if you add the C1XLBook component to the
form, you can skip the code in step 1.
Visual Basic
Copy Code
' step 1: create a new workbook

Dim C1XLBook1 As New C1XLBook()
' step 2: create styles for odd and even values
Dim styleOdd As New XLStyle(C1XLBook1)
styleOdd.Font = New Font("Tahoma", 9, FontStyle.Italic)
styleOdd.ForeColor = Color.Blue
Dim styleEven As New XLStyle(C1XLBook1)
13
styleEven.Font = New Font("Tahoma", 9, FontStyle.Bold)

styleEven.ForeColor = Color.Red
' step 3: write content and styles into some cells
Dim i As Integer
For i = 0 To 99
Dim cell As XLCell = sheet(i, 0)
cell.Value = i + 1
If (i + 1) Mod 2 = 0 Then
cell.Style = styleEven
Else
cell.Style = styleOdd
EndIf
Next i
' step 4: save the file
C1XLBook1.Save("c:\temp\hello.xls")
To write code in C#
C#
Copy Code
// step 1: create a new workbook

C1XLBook c1XLBook1 = new C1XLBook();
// step 2: create styles for odd and even values
XLStyle styleOdd
= new XLStyle(c1XLBook1);
styleOdd.Font
= new Font("Tahoma", 9, FontStyle.Italic);
styleOdd.ForeColor
= Color.Blue;
XLStyle styleEven
= new XLStyle(c1XLBook1);
styleEven.Font
= new Font("Tahoma", 9, FontStyle.Bold);
styleEven.ForeColor = Color.Red;
// step 3: write content and styles into some cells
for (int i = 0; i < 100; i++)
{
XLCell cell = sheet[i, 0];
cell.Value = i + 1;
cell.Style = ((i+1) % 2 == 0)? styleEven: styleOdd;
}
14
// step 4: save the file

c1XLBook1.Save(@"c:\temp\hello.xls");
The code is similar. The main difference is the new step 2, which creates styles for odd and even
cells. The new styles are assigned to cells in step 3, along with the cell values.
This is what the file created by the code above looks like when opened in Microsoft Excel:
Worksheets
Worksheets are the individual grids contained in an Excel file. They are represented by XLSheet
objects accessible through the Sheets property in the C1XLBook class. Each sheet has a name and
contains a collection of rows and columns. Individual cells can be accessed using the XLSheet
indexer, which takes row and column indices.
The Rows and Columns collections in the XLSheet object extend automatically when you use their
indexers. For example, if you write the following code and the sheet has fewer than 1001 rows, new
rows will be automatically added, and a valid row will be returned. The same applies to XLColumn
and XLCell indexers. This is different from the behavior of most collection indexers in .NET, but it
makes it very easy to create and populate XLSheet objects.
Visual Basic
Copy Code
15
Dim row As XLRow = sheet.Rows(1000)
To write code in C#
C#
Copy Code

XLRow row = sheet.Rows[1000];
Rows and Columns

The XLSheet object contains collections of rows and columns that expose each individual row and
column on the sheet. The exposed XLRow and XLColumn objects allow you to assign the size
(column width, row height), visibility, and style for each row and column on the sheet. If you don't
assign any of these values, the sheet's defaults will be used (see the DefaultRowHeight and
DefaultColumnWidth properties).
The default dimensions for XLRow and XLColumn objects are 1, which means use the sheet's
default values.
Cells
The XLSheet object also contains cells that can be accessed using an indexer that takes row and
column indices. The cells are represented by XLCell objects that contain the cell value and style.
As with rows and columns, the cell indexer also extends the sheet automatically. For example, write:
Visual Basic
Copy Code
Dim cell As XLCell = sheet(10, 10)
To write code in C#
C#
Copy Code
XLCell cell = sheet[10,10];
16
If the sheet has fewer than 11 rows and 11 columns, rows and columns will be added and a valid
XLCell object will be returned.
Because the sheet expands automatically, this indexer will never return a null reference. If you want
to check whether a particular cell exists on the sheet and you don't want to create the cell
inadvertently, use the sheet's GetCell method instead of the indexer.
XLCell objects have a Value property that contains the cell contents. This property is of type object
and it may contain strings, numeric, Boolean, DateTime, or null objects. Other types of objects
cannot be saved into Excel files.
XLCell objects also have a Style property that defines the appearance of the cell. If the Style
property is set to null, the cell is displayed using the default style. Otherwise, it should be set to an
XLStyle object that defines the appearance of the cell (font, alignment, colors, format, and so on).
Styles
The XLStyle class defines the appearance of a cell, row, or column on a sheet. XLStyle includes
properties that specify style elements such as the font, alignment, colors, and format used to
display cell values. Not all style elements need to be defined in every XLStyle object. For example, if
an XLStyle specifies only a format, then the cell is displayed using the specified format and default
settings for the other style elements (font, alignment, and so on).
Excel for .NET Frequently Asked Questions

The following questions were compiled from frequently asked user questions about Excel for .NET.
Does Excel for .NET support creating or adding formulas or named ranges?
Yes, Excel for .NET supports formulas and named ranges.
Full support for binary parsing and creating formulas was added in the 2009 v2 release of the
ComponentOne Studios. For example, suppose you have the following C# code:
To write code in C#
C#
Copy Code
private void Form1_Load(object sender, EventArgs e)

{
sheet[4, 1].Value = "apples and oranges";
sheet[5, 1].Value = "apples an";
sheet[5, 1].Formula = "LEFT(B5,9)";
17
// <-- result of the formula
System.Diagnostics.Process.Start(@"c:\mybook.xls");
}
When the program runs, the resulting spreadsheet looks like the following:
The formula gets the information stored in column B5 and nine characters starting from the left, or
"apples an".
Can Excel for .NET be used on an ASP.NET 2.0 page?

Yes it can, but there is an extra step to perform in order to be able to use Excel for .NET and other
non GUI .NET controls in an ASP.NET 2.0 page. You must go to View|Component Designer from
the main menu, or select "View Component Designer" from the context menu of the design view of
an .aspx page. This will display an area where you can drag and drop the C1XLBook component to
add it to your Web form.
Excel for .NET Task-Based Help

The task-based help assumes that you are familiar with programming in Visual Studio .NET. By
following the steps outlined in the Help, you will be able to create projects demonstrating a variety
of Excel for .NET features and get a good sense of what Excel for .NET can do.
Each task-based help topic also assumes that you have created a new .NET project and added the
appropriate directives (using C1.C1Excel; for C#; Imports C1.C1Excel for Visual Basic) to the code.
See Also
Adding Content to a Workbook
Merging Cells
Formatting Cells
Copying Rows from One Book to Another
18
Adding an Image to a Cell

Adding a Comment to a Cell
Adding a Page Break to a Worksheet
Setting the Calculation Mode for a Workbook
Importing and Exporting OpenXml Files
Creating Subtotals
Saving and Loading CSV Files
Adding Content to a Workbook

To create a new workbook and add values to the first ten cells, complete the following steps:
1.
2.
Double-click the C1XLBook component in the Toolbox to add it to your form.

Add values to the first ten cells:
Visual Basic
Copy Code

Dim i As Integer
For i = 0 To 9
sheet(i,0).Value = i + 1
Next i
To write code in C#
C#
Copy Code

for (int i = 0; i <= 9; i++)
{
sheet[i,0].Value = i + 1;
}
3.
Save and open the book:
19

Visual Basic
Copy Code
To write code in C#
C#
Copy Code
System.Diagnostics.Process.Start(@"C:\mybook.xls");
20
Merging Cells
Cells can be merged using the C1Excel.MergedCells property and providing the range of cells to be
merged together. Merged cells can be used for inspecting, adding, or clearing merged ranges in a
sheet. Each merged range is represented by the C1.C1Excel.XLCellRange object. Cell merges are
preserved when adding and removing rows or columns.
To merge cells, complete the following steps:
1.
2.

Use the following code to create two XLCellRanges (_ColRange and _RowRange) and add
them to the MergedCells collection. The code will also apply styles to the merged cells. You
can add this code to the Form1_Load event, for example:
To write code in C#
C#
Copy Code

{
//Select range to Merge
XLCellRange _ColRange = new C1.C1Excel.XLCellRange(4, 6, 0, 8);
XLCellRange _RowRange = new C1.C1Excel.XLCellRange(9, 21, 3, 4);
//Set Text for Merged Cells
c1XLBook1.Sheets[0][4, 0].Value = "Merged Cells";
c1XLBook1.Sheets[0][9, 3].Value = "Merged Cells";
//Merge Cells
c1XLBook1.Sheets[0].MergedCells.Add(_ColRange);
c1XLBook1.Sheets[0].MergedCells.Add(_RowRange);
//Define and Apply Styles for Merged Cells
XLStyle _Colstyle = new C1.C1Excel.XLStyle(c1XLBook1);
_Colstyle.BackColor = Color.Yellow;
XLStyle _Rowstyle = new XLStyle(c1XLBook1);
_Rowstyle.BackColor = Color.LightBlue;
c1XLBook1.Sheets[0][4, 0].Style = _Colstyle;
c1XLBook1.Sheets[0][9, 3].Style = _Rowstyle;
//Save and open the book
}
21
Formatting Cells
1.
2.

Create a new style and assign the style some properties:
Visual Basic
Copy Code

style1.ForeColor = Color.Gold
style1.BackColor = Color.Blue
style1.Format = "$ .00"
To write code in C#
C#
Copy Code

style1.ForeColor = Color.Gold;
style1.BackColor = Color.Blue;
style1.Format = "$ .00";
3.
Add some content and apply the style to the cells in the first column of the sheet:
22

Visual Basic
Copy Code

Dim i As Integer
For i = 0 To 9
Next i
To write code in C#
C#
Copy Code

int i;
for (i = 0; i <= 9; i++)
{
}
4.

Visual Basic
Copy Code
To write code in C#
C#
Copy Code
23
Copying Rows from One Book to Another

To copy the rows of a sheet from one book to a second book, complete the following steps:
1.
Load an existing book:

Visual Basic
Copy Code
Dim wb As New C1XLBook()

wb.Load("C:\test.xls")
To write code in C#
C#
Copy Code
24
C1XLBook wb = new C1XLBook();

wb.Load(@"C:\test.xls");
2.
Create a new XLSheet:

Visual Basic
Copy Code
Dim xb As New C1XLBook()

xb.Sheets.Add("Test")
To write code in C#
C#
Copy Code
C1XLBook xb = new C1XLBook();

xb.Sheets.Add("Test");
3.
Copy each row from the sheet of the existing book to new XLSheet:
Visual Basic
Copy Code
Dim source As XLSheet = wb.Sheets(0)

Dim dest As XLSheet = xb.Sheets("Test")
Dim row As Integer, col As Integer
For row = 0 To source.Rows.Count - 1
For col = 0 To source.Columns.Count - 1
dest(row, col).Value = source(row, col).Value
Next col
Next row
To write code in C#
25
C#
Copy Code
XLSheet source = wb.Sheets[0];

XLSheet dest = xb.Sheets("Test");
for (int row = 0; row <= source.Rows.Count - 1; row++)
{
for (int col = 0; col <= source.Columns.Count - 1; col++)
{
dest[row, col].Value = source[row, col].Value;
}
}
4.
Save and open the new book:

Visual Basic
Copy Code
xb.Save("C:\test2.xls")
System.Diagnostics.Process.Start("C:\test2.xls")
To write code in C#
C#
Copy Code
xb.Save(@"c:\test2.xls");
System.Diagnostics.Process.Start(@"C:\test2.xls");
Adding an Image to a Cell

Images can be added to a sheet or cell using one of the following methods. Click a link below for
detailed steps on performing this task.
Method 1: Assign an image directly to a cell's XLCell.Value property.
26
Using this method, the image is added to the sheet and kept at its original size. The upper left
corner of the image coincides with the upper left corner of the specified cell.
1.
Load an existing workbook or add some content to a new workbook.

Visual Basic
Copy Code
Dim wb As New C1XLBook

wb.Load("C:\Project\WorkBook1.xls")
To write code in C#
C#
Copy Code

wb.Load(@"C:\Project\WorkBook1.xls");
2.
Specify the image and assign it to the cell's Value property.

Visual Basic
Copy Code
Dim img As Image = Image.FromFile("C:\Project\MyImage.bmp")

Dim sheet As XLSheet = wb.Sheets("Forecasting Report")
sheet(0, 0).Value = img
To write code in C#
C#
Copy Code
Image img = Image.FromFile(@"C:\Project\MyImage.bmp");

XLSheet sheet = wb.Sheets("Forecasting Report");
sheet[0,0].Value = img;
27
3.
Save and open the new book:

Visual Basic
Copy Code
wb.Save("C:\Project\WorkBook1.xls ")
System.Diagnostics.Process.Start("C:\Project\WorkBook1.xls")
To write code in C#
C#
Copy Code
wb.Save(@"C:\Project\WorkBook1.xls");
System.Diagnostics.Process.Start(@"C:\Project\WorkBook1.xls");
In this example, the image replaces the value in the first cell, and it appears at its original size in the
first cell.
Method 2: Create an XLPictureShape object, set its properties, and assign it to a cell's XLCell.Value
property.
This second method allows you to customize the image by specifying its size, rotation angle,
brightness, contrast, border, and more.
1.

28
Visual Basic
Copy Code

To write code in C#
C#
Copy Code

2.
Create an XLPictureShape object, set some of its properties and assign it to a cell's Value
property.
Visual Basic
Copy Code

Dim pic As New XLPictureShape(img, 1500, 1500)
pic.Rotation = 30.0F
pic.LineColor = Color.DarkRed
pic.LineWidth = 100
' assign the pic to the first cell of the specified sheet
sheet(0, 0).Value = pic
To write code in C#
C#
Copy Code
Image img = Image.FromFile(imageFileName);

XLPictureShape pic = new XLPictureShape(img, 1500, 1500);
pic.Rotation = 30.0f;
29
pic.LineColor = Color.DarkRed;
pic.LineWidth = 100;
// assign the pic to the first cell of the specified sheet
sheet[0,0].Value = pic;
3.
Save and open the book.

Visual Basic
Copy Code
To write code in C#
C#
Copy Code
In this example, the image replaces the value in the first cell, is rotated 30, and has a dark red
border. Since we have specified the horizontal and vertical position of the image, it does not appear
in the first cell.
30
Method 3: Create an XLPictureShape object, set its properties, and add it to a sheet's
ShapeCollection.
This method uses the XLPictureShape constructor to specify the image boundaries in sheet
coordinates. The shape is added directly to the sheet's ShapeCollection, rather than to a specific
cell.
1.

Visual Basic
Copy Code

To write code in C#
C#
Copy Code

2.
Create an XLPictureShape object, set some of its properties and assign it to a sheet's
ShapeCollection.
Visual Basic
Copy Code

Dim pic As New XLPictureShape(img, 3000, 3500, 2500, 900)
pic.Rotation = 30.0F
pic.LineColor = Color.DarkRed
pic.LineWidth = 100
' add the pic to specified sheet's ShapeCollection
sheet.Shapes.Add(pic)
31
To write code in C#
C#
Copy Code
Image img = Image.FromFile(@"C:\Project\MyImage.bmp");

XLPictureShape pic = new XLPictureShape(img, 3000, 3500, 2500, 900);
pic.Rotation = 30.0f;
pic.LineColor = Color.DarkRed;
pic.LineWidth = 100;
// add the pic to specified sheet's ShapeCollection
sheet.Shapes.Add(pic)
3.
Save and open the book.

Visual Basic
Copy Code
To write code in C#
C#
Copy Code
In this example, the shape was added to the sheet's ShapeCollection; therefore, the image does not
replace the value in the first cell. Here we specified the height and width of the image, as well as the
horizontal and vertical positioning.
32
Adding a Comment to a Cell

1.
2.

Add text to a cell in the worksheet using the following code:
Visual Basic
Copy Code
C1XLBook1.Sheets(0)(2, 3).Value = "test"
To write code in C#
C#
Copy Code
c1XLBook1.Sheets[0][2, 3].Value = "test";
3.
Add a comment to the XLCommentCollection and create a box to show it in using the
following code:
33
Visual Basic
Copy Code
C1XLBook1.Sheets(0).Comments.Add(2, 3, "John", "Test comment")

C1XLBook1.Sheets(0).Comments(0).TextBox.Rectangle = New Rectangle(220, 210, 1900,
1200)
To write code in C#
C#
Copy Code
c1XLBook1.Sheets[0].Comments.Add(2, 3, "John", "Test comment");

c1XLBook1.Sheets[0].Comments[0].TextBox.Rectangle = new Rectangle(220, 210, 1900,
1200);
4.

Visual Basic
Copy Code
To write code in C#
C#
Copy Code
34
5.
Run the program. The spreadsheet will open and look similar to the following:
Adding a Page Break to a Worksheet

You can easily add page breaks in rows and columns for files in OpenXML (.xlsx) format using the
PageBreak and PageBreak properties.
1.
2.

Add some text values and page breaks using the following code:
Visual Basic
Copy Code
C1XLBook1.Sheets(0)(2, 3).Value = "page1"

C1XLBook1.Sheets(0).Rows(2).PageBreak = True
C1XLBook1.Sheets(0)(0, 1).Value = "test1"
C1XLBook1.Sheets(0)(0, 2).Value = "test2"
C1XLBook1.Sheets(0).Columns(1).PageBreak = True
C1XLBook1.Sheets(0)(3, 3).Value = "page2"
' Save and open the .xlsx file
C1XLBook1.Save("c:\Save.xlsx")
System.Diagnostics.Process.Start("c:\Save.xlsx")
35
To write code in C#
C#
Copy Code
c1XLBook1.Sheets[0][2, 3].Value = "page1";

c1XLBook1.Sheets[0].Rows[2].PageBreak = true;
c1XLBook1.Sheets[0][0, 1].Value = "test1";
c1XLBook1.Sheets[0][0, 2].Value = "test2";
c1XLBook1.Sheets[0].Columns[1].PageBreak = true;
c1XLBook1.Sheets[0][3, 3].Value = "page2";
// Save and open the .xlsx file
c1XLBook1.Save(@"c:\Save.xlsx");
System.Diagnostics.Process.Start(@"c:\Save.xlsx");
3.
4.
Run the project to open the .xlsx file.

In Excel, select the Page Layout tab, and select the Print checkbox under Gridlines. The
worksheet should look similar to the following:
Setting the Calculation Mode for a Workbook

The CalculationMode property specifies the calculation mode for all formulas in the workbook. The
CalculationMode enumeration provides three options: Manual (you manually perform the
calculation), Auto (the calculation is automatically performed), or AutoNoTable (the calculation is
performed except on tables).
To set the calculation mode, follow these steps:
1.
2.

Add a simple formula using the following code:
Visual Basic
Copy Code
Dim sheet As XLSheet = c1XLBook1.Sheets(0)
36
' simple formula

sheet(7, 0).Value = "Formula: 5!"
sheet(7, 1).Value = 122
sheet(7, 1).Formula = "1*2*3*4*5"
c1XLBook1.CalculationMode = CalculationMode.Auto
c1XLBook1.Save("c:\Save.xlsx")
System.Diagnostics.Process.Start("c:\Save.xlsx")
To write code in C#
C#
Copy Code

// simple formula
sheet[7, 0].Value = "Formula: 5!";
sheet[7, 1].Value = 122;
sheet[7, 1].Formula = "1*2*3*4*5";
c1XLBook1.CalculationMode = CalculationMode.Auto;
c1XLBook1.Save(@"c:\Save.xlsx");
System.Diagnostics.Process.Start(@"c:\Save.xlsx");
3.
Run the project to open the Excel file. Notice that the value for the cell in (7,1) is 120, or the
total of 1*2*3*4*5, not 122, since we set the CalculationMode to Auto.
37
Importing and Exporting OpenXml Files

ComponentOne Excel for .NET can now read and write Microsoft Excel 2007 OpenXml files.
OpenXml is an open, standards-based format introduced by Microsoft in Office 2007. OpenXml files
are easier to manipulate by applications because OpenXml is based on XML and is publicly
documented, as opposed to proprietary binary formats, such as BIFF8. OpenXml files contain a
number of XML files compressed using Zip compression. Because they are compressed, OpenXml
files are usually much smaller than traditional document files, such as .doc and .xls files.
Excel for .NET can load and save data and formatting information in OpenXml files; however,
formulas are not loaded or saved. They are copied in BIFF format as opaque, which is not supported
by the OpenXML format at this time. If you load files containing formulas and then save them, the
formulas will be removed. This is in contrast to the traditional .xls, or BIFF8, format, which preserves
the formulas.
To support the OpenXml format, the C1XLBook Load and Save methods received overloads that
take a FileFormat parameter that is used to specify the file format to use when loading or saving
files.
If the file name is not specified, then Excel for .NET infers the file format from the file name
extension: files with an "XLSX" and "ZIP" extension are loaded and saved as OpenXml files, by
default. Other files are loaded and saved as BIFF8, or .xls, format.
For example:
To write code in C#
C#
Copy Code
//load and save relying on file extension

c1Excel1.Load("somefile.xls"); // load biff 8 file
c1Excel1.Save("somefile.xlsx"); // save file as OpenXml
c1Excel1.Save("somefile.zip"); // save file as OpenXml
// load and save specifying the FileFormat
c1Excel1.Load("somefile.xls", FileFormat.Biff8);
c1Excel1.Save("somefile.xlsx", FileFormat.OpenXml);
You can also specify the format when loading or saving files to and from streams. If the FileFormat
is not specified, then Excel for .NET uses the BIFF8 format as a default.
Note that there is a small behavior change implied here. Consider the statement below:
C1Excel1.Save("somefile.xlsx");
38
In previous versions of Excel for .NET, this would save a BIFF8 file (with the wrong extension). Now,
this will save an OpenXml file (with the correct extension). If you have code like this in your
applications, you should change it to the following when upgrading:
To write code in C#
C#
Copy Code
// deliberately save file with wrong extension

C1Excel1.Save("somefile.xlsx", FileFormat.Biff8);
To export a book to an OpenXml file, complete the

following steps:
1.
Load an existing book:

Visual Basic
Copy Code

wb.Load("C:\test.xlsx")
' or
wb.Load("C:\test.xlsx", C1.C1Excel.FileFormat.OpenXml)
To write code in C#
C#
Copy Code

wb.Load(@"C:\test.xlsx");
// or
wb.Load(@"C:\test.xlsx", C1.C1Excel.FileFormat.OpenXml);
2.
Export the book to an OpenXml Format file:
39

Visual Basic
Copy Code

' Add some content
Dim sheet As XLSheet = wb.Sheets(0)
Dim i As Integer
For i = 0 To 9
Next i
' Export to OpenXml Format file
wb.Save("C:\test.xlsx")
' or
' Export to OpenXml Format file
wb.Save("C:\test.xlsx", C1.C1Excel.FileFormat.OpenXml)
To write code in C#
C#
Copy Code

// Add some content
XLSheet sheet = wb.Sheets[0];
for (int i = 0; i <= 9; i++)
{
}
// Export to OpenXml Format file
wb.Save(@"C:\test.xlsx");
// or
// Export to OpenXml Format file
wb.Save(@"C:\test.xlsx", C1.C1Excel.FileFormat.OpenXml);
Creating Subtotals
The following code provides an example of how to format the cells of a book.
40
1.
2.
3.
1. Double-click the C1XLBook component in the Toolbox to add it to your form.

Select View | Code and add one of the following statements at the top of the form:
o Import C1.C1Excel (Visual Basic)
o using C1.C1Excel; (C#)
Add the following code to the Form_Load event:
Visual Basic
Copy Code
Private Sub Form1_Load(sender As Object, e As EventArgs)

Dim book As New C1XLBook()
Dim sheet As XLSheet = book.Sheets(0)
Dim totalStyle As New XLStyle(book)
totalStyle.Font = New Font(book.DefaultFont, FontStyle.Bold)
sheet(2, 1).Value = "Number"
sheet(2, 2).Value = "ID"
sheet.Rows(3).OutlineLevel = 2
sheet.Rows(3).Visible = False
sheet.Rows(4).Visible = False
sheet(5, 1).Value = "12 Total"
sheet(5, 1).Style = totalStyle
sheet(5, 2).Formula = "SUBTOTAL(9,C4:C5)"
sheet(7, 1).Value = "34 Total"
sheet(8, 1).Value = "Grand Total"
41

book.Save("c:\mybook.xls")
End Sub
To write code in C#
C#
Copy Code

{
C1XLBook book = new C1XLBook();
XLSheet sheet = book.Sheets[0];
XLStyle totalStyle = new XLStyle(book);
totalStyle.Font = new Font(book.DefaultFont, FontStyle.Bold);
sheet[2, 1].Value = "Number";
sheet[2, 2].Value = "ID";
sheet.Rows[3].OutlineLevel = 2;
sheet.Rows[3].Visible = false;
sheet.Rows[4].Visible = false;
sheet[5, 1].Value = "12 Total";
sheet[5, 1].Style = totalStyle;
sheet[5, 2].Formula = "SUBTOTAL(9,C4:C5)";
sheet[7, 1].Value = "34 Total";
42

sheet[8, 1].Value = "Grand Total";
book.Save(@"c:\mybook.xls");
}
4.
Run the program. The spreadsheet will open and look similar to the following:
The SUBTOTAL formulas get the sum of the specified rows.
Saving and Loading CSV Files

ComponentOne Excel for .NET supports saving and loading comma-separated values (CSV) files.
CSV is a common file format that stores tabular data, including numbers and text, in plain text form
for easy readability.
The following code provides an example of how to save and load a .csv file.
1.
2.
3.

Select View | Code and add one of the following statements at the top of the form:
o Import C1.C1Excel (Visual Basic)
o using C1.C1Excel; (C#)
Add the following code to the Form_Load event to create a sheet with 10 values and save
the workbook to .csv format:
43
Visual Basic
Copy Code

For i As Integer = 0 To 9
sheet(i, 1).Value = 10 i;
Next
sheet.SaveCsv("c:\test.csv")
System.Diagnostics.Process.Start("C:\test.csv")
End Sub
To write code in C#
C#
Copy Code

{
for (int i = 0; i <= 9; i++)
{
sheet[i, 1].Value = 10 - i;
}
sheet.SaveCsv(@"c:\test.csv");
System.Diagnostics.Process.Start(@"C:\test.csv");
}
44
4.
Press F5 to run the project and view the .csv file:
5.
Add some new values to the test.csv file. You'll need to save again in order to save the new
values to the file. You can do this by adding code for the LoadCsv and SaveCsv methods to
the Form1_Load event so it now looks like this:
Visual Basic
Copy Code

sheet(i, 1).Value = 10 1
Next
sheet.LoadCsv("c:\test.csv")
sheet(i, 1).Value = 10 -1
Next
System.Diagnostics.Process.Start("C:\test.csv")
End Sub
To write code in C#
45
C#
Copy Code

{
for (int i = 0; i <= 9; i++)
{
sheet[i, 1].Value = 10 i;
}
sheet.LoadCsv(@"c:\test.csv");
for (int i = 10; i <= 19; i++)
{
sheet[i, 1].Value = 20 i;
}
System.Diagnostics.Process.Start(@"C:\test.csv");
}
6.
Press F5 to run the project again and view the .csv file:
46
Excel for .NET Samples

Please be advised that this ComponentOne software tool is accompanied by various sample
projects and/or demos which may make use of other development tools included with the
ComponentOne Studios.
Samples can be accessed from the ComponentOne Sample Explorer. To view samples, on the
desktop, click the Start button and then click All Programs | ComponentOne | Studio for
WinForms (or Studio for ASP.NET) | Samples | Excel Samples.
Click one of the following links to view a list of Excel for .NET samples:
Sample
Description
AutoSizeColumns The sample loops through all cells measuring their contents, then sets the
column widths based on the widest entry. This sample takes into account the cell
contents, format and font. It does not account for content wrapping or merging.
This sample uses the C1XLBook component.
CellBorders
The sample allows you to create borders around arbitrary ranges. You can
control border width, style, color, and so on When you are done creating the
borders, click the last button on the toolbar to export the grid to Excel, including
the custom borders. This sample uses the C1FlexGrid, C1XLBook, and the
Microsoft ImageList components.
CombineSheets
This sample scans all the .xls files in a folder, clones the first sheet, renames it
with the file name, and adds the cloned sheets to a master workbook. It then
saves the combined workbook into a file and opens that. This sample uses the
C1XLBook component.
ExcelPictures
This sample creates a workbook with several sheets: "Images" shows a random
collection of images. "Types" shows images of different types. "Borders" shows
images with different border styles. "Alignment" shows how to align and scale
images within cells. "Properties" shows the effect of additional image properties
such as brightness, grayscale, and so on. This sample uses the C1XLBook
component.
47
FlexGridExcel
Demonstrates how to load and save XLS files. This sample uses the C1FlexGrid
and C1XLBook components.
HelloWorld
This sample actually does more than save a "Hello World" document. It shows
how to create workbooks, assign names to the worksheets, create styles and
assign them to cells, assign content to cells, and save workbooks.. This sample
uses the C1XLBook component.
PrintSettings
This sample has a Load button that opens an existing XLS file and shows the
print settings for the first sheet. You can modify the print settings, then click the
Save button to save a new file (in the c:\temp folder). The new file is then
displayed in Excel . This sample uses the C1XLBook component.
To write code in C#
Sample
Description
AutoSizeColumns The sample loops through all cells measuring their contents, then sets the
column widths based on the widest entry. This sample takes into account the cell
contents, format and font. It does not account for content wrapping or merging.
This sample uses the C1XLBook component.
CellBorders
The sample allows you to create borders around arbitrary ranges. You can
control border width, style, color, and so on When you are done creating the
borders, click the last button on the toolbar to export the grid to Excel, including
the custom borders. This sample uses the C1FlexGrid, C1XLBook, and the
Microsoft ImageList components.
ColorPalette
This sample shows the Excel color palette, including the colors and their RGB
value. It uses both the C1XLBook and C1FlexGrid components. Note that this
sample is not available at http://helpcentral.componentone.com/Samples.aspx.
CombineSheets
This sample scans all the .xls files in a folder, clones the first sheet, renames it
with the file name, and adds the cloned sheets to a master workbook. It then
saves the combined workbook into a file and opens that. This sample uses the
48
C1XLBook component.
FlexGrid
Demonstrates how to load and save XLS files. This sample uses the C1FlexGrid
and C1XLBook components.
HelloWorld
This sample actually does more than save a "Hello World" document. It shows
how to create workbooks, assign names to the worksheets, create styles and
assign them to cells, assign content to cells, and save workbooks.. This sample
uses the C1XLBook component.
PrintSettings
This sample has a Load button that opens an existing XLS file and shows the
print settings for the first sheet. You can modify the print settings, then click the
Save button to save a new file (in the c:\temp folder). The new file is then
displayed in Excel . This sample uses the C1XLBook component.
API Reference
The following topics contain the API reference for ComponentOne Excel for .NET.
See Also
C1.C1Excel.4 Assembly
Overview
Namespaces
Namespace
Description
C1.C1Excel
C1.Win.Localization
49
Namespaces
C1.C1Excel Namespace
Overview
Classes
Class
Description
C1XLBook
Represents an Excel workbook containing one or more worksheets.

Contains methods for loading and saving XLS files, and exposes a
collection of XLSheet objects that represent the individual
worksheets.
ShapeCollection
Represents a collection of XLShape objects on an XLSheet.
Strings
Static class containing UI strings used by the designer.
XLCell
Represents individual cells in an XLSheet and provides properties for

getting and setting the cell Value, Style, and Hyperlink.
XLCellRange
Represents a range of XLCell objects in an XLSheet.
XLCellRangeCollection
Represents a collection of XLCellRange objects on an XLSheet.
XLColumn
Represents a column in a worksheet. This class provides properties

for setting the column's width, style, and visibility.
XLColumnCollection
Represents a collection of XLColumn objects that represent the

individual columns in each XLSheet.
XLComment
Represents a comment associated with a cell.
XLCommentCollection
Represents a collection of XLComment objects in a XLSheet.
XLCommentShape
Represents a text shape embedded in an XLSheet.
50
XLNamedRange
Represents a named range of XLCell objects on one or several

worksheets.
XLNamedRangeCollection Represents a collection of XLNamedRange objects.

XLOpaqueShape
Represents a shape that was inserted in the sheet using Excel and is
preserved but not fully exposed by the C1XLBook component.
XLPictureShape
Represents an Image embedded in an XLSheet.
XLPrintSettings
Provides options and settings for printing XLSheet objects.
XLRow
Represents a row in a worksheet, provides properties for setting the

row's height, style, and visibility.
XLRowCollection
Represents a collection of XLRow objects that represent the

individual rows in each XLSheet.
XLShape
Represents a shape embedded in an XLSheet.
XLSheet
Represents individual worksheets in an Excel workbook (C1XLBook).
XLSheetCollection
Collection of XLSheet objects that represent the individual

worksheets in a C1XLBook.
XLStyle
Contains style elements used to define the appearance of the cells.
XLTextShape
Represents a common text shape embedded in an XLSheet.
Enumerations
Enumeration
Description
CalculationMode
Specifies calculation mode for all formulas in the workbook.
51
CompatibilityMode
Specifies limits to sheet size that correspond to specific

versions of Microsoft Excel.
ConsolidationFunction
Specifies consolidation function for sheet subtotals.
FileFormat
Specifies the file format to use when loading or saving

workbooks.
ImageScaling
Specifies how images are scaled within spreadsheet cells.
XLAlignHorzEnum
Specifies how to align cell content horizontally within a cell.
XLAlignVertEnum
Specifies how to align cell content vertically within a cell.
XLDiagonalFlags
Specifies the type of diagonal line to draw across the cells.
XLHorizTextAlign
Specifies horizontal text alignment.
XLLineStyleEnum
Specifies the line style used for the cell borders.
XLPatternEnum
Specifies the pattern used to fill the cell background.
XLPictureViewType
Specifies how images should be displayed (color, grayscale, or

black and white).
XLRangeType
The range type.
XLReferenceMode
The reference mode.
XLReferenceType
The reference type.
XLShapeDashedLineStyleEnum Specifies the dash style of borders drawn around XLShape

objects.
XLShapeLineStyleEnum
Specifies the style of borders drawn around XLShape objects.
52
XLTextOrientation
Specifies text orientation.
XLVertTextAlign
Specifies vertical text alignment.
See Also
Reference
Classes
C1XLBook
Contains methods for loading and saving XLS files, and exposes a collection of XLSheet objects that
represent the individual worksheets.
Object Model
Syntax
Visual Basic (Declaration)
<System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.ComponentM
odel.Design.IDesigner", DesignerTypeName="C1.C1Excel.Design.C1XLBookDesigner,
C1.C1Excel.4.Design, Version=4.1.20133.280")>
<System.ComponentModel.LicenseProviderAttribute(System.ComponentModel.LicensePro
vider)>
<System.Drawing.ToolboxBitmapAttribute()>
Public Class C1XLBook
Inherits System.ComponentModel.Component
C#
[System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.ComponentM
C1.C1Excel.4.Design, Version=4.1.20133.280")]
[System.ComponentModel.LicenseProviderAttribute(System.ComponentModel.LicensePro
53
vider)]
[System.Drawing.ToolboxBitmapAttribute()]
public class C1XLBook : System.ComponentModel.Component
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
C1.C1Excel.C1XLBook
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008
(Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later),
Windows Server 2003 SP2
See Also
Reference
C1XLBook Members
Overview
Contains methods for loading and saving XLS files, and exposes a collection of XLSheet objects that
represent the individual worksheets.
Object Model
Syntax
<System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.ComponentM
C1.C1Excel.4.Design, Version=4.1.20133.280")>
<System.ComponentModel.LicenseProviderAttribute(System.ComponentModel.LicensePro
54
vider)>
<System.Drawing.ToolboxBitmapAttribute()>
Public Class C1XLBook
Inherits System.ComponentModel.Component
C#
[System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.ComponentM
C1.C1Excel.4.Design, Version=4.1.20133.280")]
[System.ComponentModel.LicenseProviderAttribute(System.ComponentModel.LicensePro
vider)]
[System.Drawing.ToolboxBitmapAttribute()]
public class C1XLBook : System.ComponentModel.Component
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
C1.C1Excel.C1XLBook
Requirements
See Also
Reference
C1XLBook Members
Members
Properties Methods Events
The following tables list the members exposed by C1XLBook.
Public Constructors
55
Name
Description
C1XLBook Constructor Creates a new instance of the C1XLBook class. The new workbook
contains a single empty XLSheet called "Sheet1".
Top
Public Properties
Name
Description
Author
Gets or sets the name of the person, company, or application that created
this C1XLBook.
CalculationMode
Gets or sets the formula calculation mode.
CompatibilityMode Gets or sets a value determining the limits on sheet size and the number of
styles allowed per workbook.
Container
(Inherited from System.ComponentModel.Component)
DefaultFont
Gets or sets the default font object for the C1XLBook.
IsLoading
Determines whether the workbook is currently loading.
KeepFormulas
Specifies whether the component should store formulas read from

XLS/XLSX files and write them back when saving the file.
NamedRanges
Gets the collection of XLNamedRange objects for the current workbook.
OpaqueCopy
Gets or sets a value specifying whether the component should copy nonmain BIFF records as opaque when loading and saving XLS files.
Palette
Gets or sets color palette of this workbook.
Sheets
Gets a collection of XLSheet objects that represent the worksheets in the
56
C1XLBook.
Site
Top
Public Methods
Name
Description
Clear
Clears the C1XLBook, restoring the initial state with a single XLSheet
called "Sheet1".
Clone
Creates a copy of this C1Excel book.
CreateObjRef
(Inherited from System.MarshalByRefObject)
Dispose
GetLifetimeService
InitializeLifetimeService (Inherited from System.MarshalByRefObject)

Load
Overloaded. Loads an Excel worksheet from a file.
PixelsToTwips
Converts a pixel measurement into twips (1/20th of a point).
Save
Overloaded. Saves the worksheet to a file.
ToString
TwipsToPixels
Converts a twip measurement into screen pixels.
Top
Public Events
57
Name
Description
Disposed
Top
See Also
Reference
C1XLBook Class
C1XLBook Constructor
Creates a new instance of the C1XLBook class. The new workbook contains a single empty XLSheet
called "Sheet1".
Syntax
Public Function New()
C#
public C1XLBook()
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Methods
For a list of all members of this type, see C1XLBook members.
Public Methods
58
Name
Description
Clear
Clears the C1XLBook, restoring the initial state with a single XLSheet
called "Sheet1".
Clone
CreateObjRef
Dispose
GetLifetimeService
InitializeLifetimeService (Inherited from System.MarshalByRefObject)

Load
Overloaded. Loads an Excel worksheet from a file.
PixelsToTwips
Save
Overloaded. Saves the worksheet to a file.
ToString
TwipsToPixels
Top
See Also
Reference
C1XLBook Class
Clear Method
Clears the C1XLBook, restoring the initial state with a single XLSheet called "Sheet1".
Syntax
59

Public Sub Clear()
C#
public void Clear()
Remarks
The Clear method restores the C1XLBook object to its initial state, with a single empty sheet called
"Sheet1" and the DefaultFont set to 10pt Arial.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Clone Method
Syntax
Public Function Clone() As C1XLBook
C#
public C1XLBook Clone()
Return Value
A new C1XLBook object with the same contents and formatting as this book.
Requirements
60
See Also
Reference
C1XLBook Class
C1XLBook Members
Load Method
Loads an Excel worksheet from a file.
Overload List
Overload
Description
Load(String)
Load(String,Boolean)
Load(String,FileFormat)
Load(String,FileFormat,Boolean)
Load(Stream)
Loads the worksheet from a stream.
Load(Stream,Boolean)
Load(Stream,FileFormat)
Load(Stream,FileFormat,Boolean) Loads the worksheet from a stream.
Requirements
61
See Also
Reference
C1XLBook Class
C1XLBook Members
Load(String) Method
Name of the file that contains the worksheet.
Syntax
Public Overloads Sub Load( _
ByVal fileName As System.String _
)
C#
public void Load(
System.string fileName
)
Parameters
fileName
Remarks
Component One Excel infers the file format automatically based on the file name extension.
"XLSX" and "ZIP" files are loaded as OpenXml; all others are loaded as Biff8 files ("xls").
If the file doesn't exist, is locked, or is not a valid Excel file, an exception is thrown.
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server
2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1
or later), Windows Server 2003 SP2
62
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Load(String,Boolean) Method
True to load data into the sheets; False to read the sheet names only.
Syntax
ByVal fileName As System.String, _
ByVal fillSheets As System.Boolean _
)
C#
public void Load(
System.string fileName,
System.bool fillSheets
)
Parameters
fileName
fillSheets
Requirements
63
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows
Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core
supported with SP1 or later), Windows Server 2003 SP2
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Load(String,FileFormat) Method
FileFormat value that specifies the file format.
Syntax
ByVal format As FileFormat _
)
C#
public void Load(
FileFormat format
)
Parameters
fileName
format
64
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Load(String,FileFormat,Boolean) Method
Syntax
ByVal format As FileFormat, _
)
C#
public void Load(
FileFormat format,
)
Parameters
fileName
65

format
fillSheets
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3,
Windows Server 2008 (Server Core not supported), Windows Server 2008 R2
(Server Core supported with SP1 or later), Windows Server 2003 SP2
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Load(Stream) Method
System.IO.Stream that contains the worksheet.
Syntax
ByVal stream As System.IO.Stream _
)
C#
public void Load(
System.IO.Stream stream
)
Parameters
stream
66
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Load(Stream,Boolean) Method
Syntax
ByVal stream As System.IO.Stream, _
)
C#
public void Load(
System.IO.Stream stream,
)
Parameters
stream
67
fillSheets
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Load(Stream,FileFormat) Method
Syntax
)
C#
public void Load(
FileFormat format
)
Parameters
stream
68

format
Remarks
Loading the worksheets without their data is much faster than loading the entire
workbook. This is useful in situations where you want to examine the contents of the file
(for example, to ensure that you will not overwrite an existing sheet).
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Load(Stream,FileFormat,Boolean) Method
Syntax
ByVal format As FileFormat, _
)
69
C#
public void Load(
FileFormat format,
)
Parameters
stream
format
fillSheets
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
PixelsToTwips Method
Measurement in screen pixels.
Syntax
70
Public Shared Function PixelsToTwips( _

ByVal pix As System.Double _
) As System.Integer
C#
public static System.int PixelsToTwips(
System.double pix
)
Parameters
pix
Return Value
Measurement in twips.
Remarks
Excel stores measurements in twips (1/20th of a point), a resolution-independent unit. .NET
controls, on the other hand, usually express measurements in pixels. This method provides an
easy way to convert pixel measurements into twips using the current screen resolution.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
TwipsToPixels Method
Save Method
Saves the worksheet to a file.
Overload List
71
Overload
Description
Save(String)
Save(String,FileFormat)
Save(Stream)
Saves the worksheet into a stream.
Save(Stream,FileFormat) Saves the worksheet into a stream.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Save(String) Method
Name of the file to save.
Syntax
Public Overloads Sub Save( _
)
C#
public void Save(
)
72
Parameters
fileName
Remarks
The format used to save the file is automatically determined by the file name extension. "Xlsx"
and "zip" files are saved as OpenXml; all others are saved as Biff8 files ("xls").
If the file can't be created, an exception is thrown. This typically indicates that the file is
currently open by another application (such as Microsoft Excel).
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Save(String,FileFormat) Method
FileFormat value that specifies the type of file to save.
Syntax
)
73
C#
public void Save(
FileFormat format
)
Parameters
fileName
format
FileFormat value that specifies the type of file to save.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Overload List
Save(Stream) Method
Example
System.IO.Stream where the worksheet is saved.

Syntax
)
74
C#
public void Save(
)
Parameters
stream
Remarks
This method allows saving the workbook directly into streams without using temporary files.
Typical uses include saving books to web page response streams or mail attachment streams.
Example
The code below saves a C1XLBook into a System.IO.MemoryStream, clears the book, then
loads it back from the same stream.
C#
// save book into new MemoryStream

MemoryStream ms = new MemoryStream();
_book.Save(ms);
// clear book
_book.Clear();
// load it back from the MemoryStream
ms.Position = 0;
_book.Load(ms);
Requirements
See Also
Reference
75
C1XLBook Class
C1XLBook Members
Overload List
Save(Stream,FileFormat) Method
FileFormat value that specifies the format to save the worksheet in.
Syntax
)
C#
public void Save(
FileFormat format
)
Parameters
stream
format
FileFormat value that specifies the format to save the worksheet in.
Requirements
See Also
76
Reference
C1XLBook Class
C1XLBook Members
Overload List
TwipsToPixels Method
Syntax
Public Shared Function TwipsToPixels( _
ByVal twip As System.Double _
) As System.Integer
C#
public static System.int TwipsToPixels(
System.double twip
)
Parameters
twip
Return Value
Remarks
Excel stores measurements in twips (1/20th of a point), a resolution-independent unit. .NET
controls, on the other hand, usually express measurements in pixels. This method provides an
easy way to convert pixel measurements into twips using the current screen resolution.
PixelsToTwips
Requirements
77
See Also
Reference
C1XLBook Class
C1XLBook Members
Properties
For a list of all members of this type, see C1XLBook members.
Public Properties
Name
Description
Author
Gets or sets the name of the person, company, or application that created
this C1XLBook.
CalculationMode
CompatibilityMode Gets or sets a value determining the limits on sheet size and the number of
styles allowed per workbook.
Container
DefaultFont
IsLoading
KeepFormulas
Specifies whether the component should store formulas read from

XLS/XLSX files and write them back when saving the file.
NamedRanges
OpaqueCopy
Gets or sets a value specifying whether the component should copy non-
78
main BIFF records as opaque when loading and saving XLS files.
Palette
Sheets
Gets a collection of XLSheet objects that represent the worksheets in the

C1XLBook.
Site
Top
See Also
Reference
C1XLBook Class
Author Property
Gets or sets the name of the person, company, or application that created this C1XLBook.
Syntax
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSerializ
ationVisibility.Hidden)>
<System.ComponentModel.BrowsableAttribute(False)>
Public Property Author As System.String
C#
[System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSerializ
ationVisibility.Hidden)]
[System.ComponentModel.BrowsableAttribute(false)]
public System.string Author {get; set;}
Requirements
79
See Also
Reference
C1XLBook Class
C1XLBook Members
CalculationMode Property
Syntax
Public Property CalculationMode As CalculationMode
C#
public CalculationMode CalculationMode {get; set;}
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
CompatibilityMode Property
Gets or sets a value determining the limits on sheet size and the number of styles allowed per
workbook.
Syntax
80

<C1DescriptionAttribute("Determines the limits on sheet size and the number of
styles allowed per workbook.")>
<System.ComponentModel.DefaultValueAttribute()>
Public Property CompatibilityMode As CompatibilityMode
C#
[C1DescriptionAttribute("Determines the limits on sheet size and the number of
styles allowed per workbook.")]
[System.ComponentModel.DefaultValueAttribute()]
public CompatibilityMode CompatibilityMode {get; set;}
Remarks
This property allows you to specify which version of Microsoft Excel you want your workbooks to be
compatible with.
Excel2003 mode allows you to create sheets with up to 65,536 rows and 256 columns. Excel2007
mode allows you to create sheets with up to 1,048,576 rows and 18,278 columns.
Note that the XLS file format is limited by the Excel2003 limits. If you use the Excel2007 mode and
create large sheets, save them into OpenXml files instead of XLS.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
DefaultFont Property
Syntax
81

Public Property DefaultFont As System.Drawing.Font
C#
public System.Drawing.Font DefaultFont {get; set;}
Remarks
You can assign any font to any cell using XLStyle objects. Cells that have no associated custom
styles or have styles that do not define a custom font are displayed using the book's default font.
The DefaultFont property is initially set to 10 pt Arial.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
IsLoading Property
Syntax
82
Public ReadOnly Property IsLoading As System.Boolean
C#
public System.bool IsLoading {get;}
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
KeepFormulas Property
Specifies whether the component should store formulas read from XLS/XLSX files and write them
back when saving the file.
Syntax
<C1DescriptionAttribute("Specifies whether the component should preserve
formulas when loading and saving XLS/XLSX files.")>
Public Property KeepFormulas As System.Boolean
C#
[C1DescriptionAttribute("Specifies whether the component should preserve
formulas when loading and saving XLS/XLSX files.")]
public System.bool KeepFormulas {get; set;}
83
Remarks
Setting this property to true allows you to load existing XLS/XLSX files, modify the values in some
cells, and save the file preserving the formulas. This is the default setting.
Setting this property to false causes the component to remove the formulas in the book when it is
loaded. Saving the file in this case will retain the last calculated values but will remove the formulas.
Assigning any value to a cell will clear the formula in the cell.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
NamedRanges Property
Syntax
Public ReadOnly Property NamedRanges As XLNamedRangeCollection
C#
public XLNamedRangeCollection NamedRanges {get;}
Requirements
84
See Also
Reference
C1XLBook Class
C1XLBook Members
OpaqueCopy Property
Gets or sets a value specifying whether the component should copy non-main BIFF records as
opaque when loading and saving XLS files.
Syntax
<C1DescriptionAttribute("Specifies whether the component should copy non-main
BIFF records as opaque when loading and saving XLS files.")>
Public Property OpaqueCopy As System.Boolean
C#
[C1DescriptionAttribute("Specifies whether the component should copy non-main
BIFF records as opaque when loading and saving XLS files.")]
public System.bool OpaqueCopy {get; set;}
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
85
Palette Property
Syntax
Public Property Palette As System.Drawing.Color()
C#
public System.Drawing.Color[] Palette {get; set;}
Remarks
The palette must be more 8 items (first 8 colors is standard pallete: Black, White, Red, Green, Blue,
Yellow, Magenta, Cyan).
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
Sheets Property
Gets a collection of XLSheet objects that represent the worksheets in the C1XLBook.
Syntax
86

Public ReadOnly Property Sheets As XLSheetCollection
C#
public XLSheetCollection Sheets {get;}
Remarks
The XLSheetCollection returned has methods for counting, enumerating, adding and removing
sheets from the C1XLBook.
Requirements
See Also
Reference
C1XLBook Class
C1XLBook Members
ShapeCollection
Object Model
Syntax
<System.Reflection.DefaultMemberAttribute("Item")>
Public Class ShapeCollection
87
C#
[System.Reflection.DefaultMemberAttribute("Item")]
public class ShapeCollection
System.Object
C1.C1Excel.ShapeCollection
Requirements
See Also
Reference
ShapeCollection Members
Overview
Object Model
Syntax
Public Class ShapeCollection
C#
public class ShapeCollection
88
System.Object
C1.C1Excel.ShapeCollection
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by ShapeCollection.
Public Properties
Name
Description
Count
Gets count items in collection.
Item
Gets the XLShape object at the specified position in the collection.
Sheet
Gets the Sheet object that owns the collection.
Top
Public Methods
Name
Description
Add
Appends an XLShape object to the collection.
Contains
Overloaded. Checks whether the collection contains a specific XLShape

object.
89
IndexOf
Overloaded. Gets the position of an XLShape object in the collection.
Insert
Inserts an XLShape object at a specific position in the collection.
Remove
Overloaded. Removes an XLShape object from the collection.
Top
See Also
Reference
ShapeCollection Class
Methods
For a list of all members of this type, see ShapeCollection members.
Public Methods
Name
Description
Add
Contains
Overloaded. Checks whether the collection contains a specific XLShape

object.
IndexOf
Overloaded. Gets the position of an XLShape object in the collection.
Insert
Remove
Overloaded. Removes an XLShape object from the collection.
Top
See Also
Reference
90
Add Method
XLShape object to add to the collection.
Syntax
Public Function Add( _
ByVal shape As XLShape _
) As XLShape
C#
public XLShape Add(
XLShape shape
)
Parameters
shape
XLShape object to add to the collection.
Return Value
A reference to the object if it was successfully added to the collection, or null if the object
could not be added to the collection (usually because it overlaps another cell range already in
the collection).
Requirements
See Also
Reference
Contains Method
Checks whether the collection contains a specific XLShape object.
91
Overload List
Overload
Description
Contains(XLShape) Checks whether the collection contains a specific XLShape object.

Contains(Int32)
Requirements
See Also
Reference
Contains(XLShape) Method
XLShape object to look for.
Syntax
Public Overloads Function Contains( _
) As System.Boolean
C#
public System.bool Contains(
XLShape shape
)
Parameters
shape
92
Return Value
True if the collection contains the range, False otherwise.
Requirements
See Also
Reference
Overload List
Contains(Int32) Method
The identifier of the object to look for.
Syntax
ByVal id As System.Integer _
) As System.Boolean
C#
System.int id
)
Parameters
id
Return Value
93
Requirements
See Also
Reference
Overload List
IndexOf Method
Gets the position of an XLShape object in the collection.
Overload List
Overload
Description
IndexOf(XLShape)
IndexOf(Int32)
Requirements
See Also
Reference
IndexOf(XLShape) Method
94
Syntax
Public Overloads Function IndexOf( _
) As System.Integer
C#
public System.int IndexOf(
XLShape shape
)
Parameters
shape
Return Value
The position of the object in the collection, or -1 if the object is not a member of the
collection.
Requirements
See Also
Reference
Overload List
IndexOf(Int32) Method
Syntax
95

) As System.Integer
C#
System.int id
)
Parameters
id
Return Value
collection.
Requirements
See Also
Reference
Overload List
Insert Method
Position where the object will be inserted.
Object to insert in the collection.
Syntax
96

Public Overridable Function Insert( _
ByVal index As System.Integer, _
) As XLShape
C#
public virtual XLShape Insert(
System.int index,
XLShape shape
)
Parameters
index
shape
Return Value
A reference to the object if it was successfully added to the collection, or null if the
object could not be added to the collection (usually because it overlaps another cell
range already in the collection).
Requirements
See Also
Reference
Remove Method
Removes an XLShape object from the collection.
97
Overload List
Overload
Description
Remove(XLShape) Removes an XLShape object from the collection.

Remove(Int32)
Requirements
See Also
Reference
Remove(XLShape) Method
XLShape object to remove from the collection.
Syntax
Public Overloads Function Remove( _
) As System.Boolean
C#
public System.bool Remove(
XLShape shape
)
Parameters
shape
98
XLShape object to remove from the collection.
Requirements
See Also
Reference
Overload List
Remove(Int32) Method
The identifier of the object to remove from the collection.
Syntax
) As System.Boolean
C#
System.int id
)
Parameters
id
The identifier of the object to remove from the collection.
Requirements
99
See Also
Reference
Overload List
Properties
For a list of all members of this type, see ShapeCollection members.
Public Properties
Name
Description
Count
Item
Sheet
Top
See Also
Reference
Count Property
Syntax
Public ReadOnly Property Count As System.Integer
100
C#
public System.int Count {get;}
Requirements
See Also
Reference
Item Property
Syntax
Public ReadOnly Default Property Item( _
ByVal index As System.Integer _
) As XLShape
C#
public XLShape this[
System.int index
]; {get;}
Parameters
index
Requirements
101
See Also
Reference
Sheet Property
Syntax
Public ReadOnly Property Sheet As XLSheet
C#
public XLSheet Sheet {get;}
Requirements
See Also
Reference
Strings
Object Model
Syntax
102
Public MustInherit NotInheritable Class Strings

C#
public static class Strings
System.Object
C1.C1Excel.Strings
Requirements
See Also
Reference
Strings Members
Overview
Object Model
Syntax
Public MustInherit NotInheritable Class Strings
C#
public static class Strings
103
System.Object
C1.C1Excel.Strings
Requirements
See Also
Reference
Strings Members
Members
Properties
The following tables list the members exposed by Strings.
Public Properties
Name
Description
BadFormatRunDataLenFmt
BadOpenXmlFile
BadParamInSheetCtor
BadParamInStyleCtor
CannotCreateStorageFile
CannotCreateStorageStream
CannotCreateStream
CannotOpenStorageFile
104
CannotOpenStream
CannotSaveBookTooManyCols
CannotSaveBookTooManyRows
CannotSaveBookTooManyStyles
CannotSaveEmptyBook
CannotSaveWithoutSheets
CannotSeekToEndOfStream
CannotSetStreamLength
ColumnAlreadyInSheet
ColumnFromOtherSheet
DuplicateSheetName
FilePasswordProtected
InvalidFileFormat
InvalidSheetName
MaxNoOfSheetsExceeded
NamedRangeAlreadyInBook
NegativeStartIndexOfCellRange
ResourceManager
105
RowAlreadyInSheet
RowFromOtherSheet
ShapeAlreadyInSheet
SheetAlreadyInBook
SheetFromOtherBook
SheetNameInUse
SheetNotFoundFmt
TooManyColsFmt
TooManyRowsFmt
UICulture
WorkbookMustBeLoaded
Top
See Also
Reference
Strings Class
Properties
For a list of all members of this type, see Strings members.
Public Properties
Name
Description
106
BadFormatRunDataLenFmt
BadOpenXmlFile
BadParamInSheetCtor
BadParamInStyleCtor
CannotCreateStorageFile
CannotCreateStorageStream
CannotCreateStream
CannotOpenStorageFile
CannotOpenStream
CannotSaveBookTooManyCols
CannotSaveBookTooManyRows
CannotSaveBookTooManyStyles
CannotSaveEmptyBook
CannotSaveWithoutSheets
CannotSeekToEndOfStream
CannotSetStreamLength
ColumnAlreadyInSheet
ColumnFromOtherSheet
107
DuplicateSheetName
FilePasswordProtected
InvalidFileFormat
InvalidSheetName
MaxNoOfSheetsExceeded
NamedRangeAlreadyInBook
NegativeStartIndexOfCellRange
ResourceManager
RowAlreadyInSheet
RowFromOtherSheet
ShapeAlreadyInSheet
SheetAlreadyInBook
SheetFromOtherBook
SheetNameInUse
SheetNotFoundFmt
TooManyColsFmt
TooManyRowsFmt
UICulture
108
WorkbookMustBeLoaded
Top
See Also
Reference
Strings Class
BadFormatRunDataLenFmt Property
Syntax
Public Shared ReadOnly Property BadFormatRunDataLenFmt As System.String
C#
public static System.string BadFormatRunDataLenFmt {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
BadOpenXmlFile Property
Syntax
Public Shared ReadOnly Property BadOpenXmlFile As System.String
C#
109
public static System.string BadOpenXmlFile {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
BadParamInSheetCtor Property
Syntax
Public Shared ReadOnly Property BadParamInSheetCtor As System.String
C#
public static System.string BadParamInSheetCtor {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
BadParamInStyleCtor Property
Syntax
110
Public Shared ReadOnly Property BadParamInStyleCtor As System.String

C#
public static System.string BadParamInStyleCtor {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotCreateStorageFile Property
Syntax
Public Shared ReadOnly Property CannotCreateStorageFile As System.String
C#
public static System.string CannotCreateStorageFile {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
111
CannotCreateStorageStream Property
Syntax
Public Shared ReadOnly Property CannotCreateStorageStream As System.String
C#
public static System.string CannotCreateStorageStream {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotCreateStream Property
Syntax
Public Shared ReadOnly Property CannotCreateStream As System.String
C#
public static System.string CannotCreateStream {get;}
Requirements
See Also
Reference
112
Strings Class
Strings Members
CannotOpenStorageFile Property
Syntax
Public Shared ReadOnly Property CannotOpenStorageFile As System.String
C#
public static System.string CannotOpenStorageFile {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotOpenStream Property
Syntax
Public Shared ReadOnly Property CannotOpenStream As System.String
C#
public static System.string CannotOpenStream {get;}
Requirements
113
See Also
Reference
Strings Class
Strings Members
CannotSaveBookTooManyCols Property
Syntax
Public Shared ReadOnly Property CannotSaveBookTooManyCols As System.String
C#
public static System.string CannotSaveBookTooManyCols {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotSaveBookTooManyRows Property
Syntax
Public Shared ReadOnly Property CannotSaveBookTooManyRows As System.String
C#
public static System.string CannotSaveBookTooManyRows {get;}
Requirements
114
See Also
Reference
Strings Class
Strings Members
CannotSaveBookTooManyStyles Property
Syntax
Public Shared ReadOnly Property CannotSaveBookTooManyStyles As System.String
C#
public static System.string CannotSaveBookTooManyStyles {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotSaveEmptyBook Property
Syntax
Public Shared ReadOnly Property CannotSaveEmptyBook As System.String
C#
115
public static System.string CannotSaveEmptyBook {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotSaveWithoutSheets Property
Syntax
Public Shared ReadOnly Property CannotSaveWithoutSheets As System.String
C#
public static System.string CannotSaveWithoutSheets {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotSeekToEndOfStream Property
Syntax
116
Public Shared ReadOnly Property CannotSeekToEndOfStream As System.String

C#
public static System.string CannotSeekToEndOfStream {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
CannotSetStreamLength Property
Syntax
Public Shared ReadOnly Property CannotSetStreamLength As System.String
C#
public static System.string CannotSetStreamLength {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
117
ColumnAlreadyInSheet Property
Syntax
Public Shared ReadOnly Property ColumnAlreadyInSheet As System.String
C#
public static System.string ColumnAlreadyInSheet {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
ColumnFromOtherSheet Property
Syntax
Public Shared ReadOnly Property ColumnFromOtherSheet As System.String
C#
public static System.string ColumnFromOtherSheet {get;}
Requirements
See Also
Reference
118
Strings Class
Strings Members
DuplicateSheetName Property
Syntax
Public Shared ReadOnly Property DuplicateSheetName As System.String
C#
public static System.string DuplicateSheetName {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
FilePasswordProtected Property
Syntax
Public Shared ReadOnly Property FilePasswordProtected As System.String
C#
public static System.string FilePasswordProtected {get;}
Requirements
119
See Also
Reference
Strings Class
Strings Members
InvalidFileFormat Property
Syntax
Public Shared ReadOnly Property InvalidFileFormat As System.String
C#
public static System.string InvalidFileFormat {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
InvalidSheetName Property
Syntax
Public Shared ReadOnly Property InvalidSheetName As System.String
C#
public static System.string InvalidSheetName {get;}
Requirements
120
See Also
Reference
Strings Class
Strings Members
MaxNoOfSheetsExceeded Property
Syntax
Public Shared ReadOnly Property MaxNoOfSheetsExceeded As System.String
C#
public static System.string MaxNoOfSheetsExceeded {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
NamedRangeAlreadyInBook Property
Syntax
Public Shared ReadOnly Property NamedRangeAlreadyInBook As System.String
C#
121
public static System.string NamedRangeAlreadyInBook {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
NegativeStartIndexOfCellRange Property
Syntax
Public Shared ReadOnly Property NegativeStartIndexOfCellRange As System.String
C#
public static System.string NegativeStartIndexOfCellRange {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
ResourceManager Property
Syntax
122
Public Shared Property ResourceManager As System.Resources.ResourceManager

C#
public static System.Resources.ResourceManager ResourceManager {get; set;}
Requirements
See Also
Reference
Strings Class
Strings Members
RowAlreadyInSheet Property
Syntax
Public Shared ReadOnly Property RowAlreadyInSheet As System.String
C#
public static System.string RowAlreadyInSheet {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
123
RowFromOtherSheet Property
Syntax
Public Shared ReadOnly Property RowFromOtherSheet As System.String
C#
public static System.string RowFromOtherSheet {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
ShapeAlreadyInSheet Property
Syntax
Public Shared ReadOnly Property ShapeAlreadyInSheet As System.String
C#
public static System.string ShapeAlreadyInSheet {get;}
Requirements
See Also
Reference
124
Strings Class
Strings Members
SheetAlreadyInBook Property
Syntax
Public Shared ReadOnly Property SheetAlreadyInBook As System.String
C#
public static System.string SheetAlreadyInBook {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
SheetFromOtherBook Property
Syntax
Public Shared ReadOnly Property SheetFromOtherBook As System.String
C#
public static System.string SheetFromOtherBook {get;}
Requirements
125
See Also
Reference
Strings Class
Strings Members
SheetNameInUse Property
Syntax
Public Shared ReadOnly Property SheetNameInUse As System.String
C#
public static System.string SheetNameInUse {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
SheetNotFoundFmt Property
Syntax
Public Shared ReadOnly Property SheetNotFoundFmt As System.String
C#
public static System.string SheetNotFoundFmt {get;}
Requirements
126
See Also
Reference
Strings Class
Strings Members
TooManyColsFmt Property
Syntax
Public Shared ReadOnly Property TooManyColsFmt As System.String
C#
public static System.string TooManyColsFmt {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
TooManyRowsFmt Property
Syntax
Public Shared ReadOnly Property TooManyRowsFmt As System.String
C#
127
public static System.string TooManyRowsFmt {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
UICulture Property
Syntax
Public Shared ReadOnly Property UICulture As System.Globalization.CultureInfo
C#
public static System.Globalization.CultureInfo UICulture {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
WorkbookMustBeLoaded Property
Syntax
128
Public Shared ReadOnly Property WorkbookMustBeLoaded As System.String

C#
public static System.string WorkbookMustBeLoaded {get;}
Requirements
See Also
Reference
Strings Class
Strings Members
XLCell
Example
Represents individual cells in an XLSheet and provides properties for getting and setting the cell
Value, Style, and Hyperlink.
Object Model
Syntax
Public Class XLCell
C#
public class XLCell
Remarks
To create cells, use the XLSheet indexer (Item property). If the cell already exists, the reference will
be returned as usual. If not, the sheet will create the cell (as well as rows and columns if necessary)
and will return a reference to the new cell.
129
Because it creates cells automatically, the indexer is especially useful when creating and populating
sheets.
Example
For example, the code below creates a new C1XLBook, then populates the first sheet with a 10 by
10 multiplication table: Note how the code simply accesses the cells using the indexer. There's no
need to create any rows, columns, or cells. The indexer takes care of all that automatically.
C#

for (int r = 0; r < 10; r++)
{
for (int c = 0; c < 10; c++)
{
XLCell cell = sheet[r, c];
cell.Value = (r+1) * (c+1);
}
}
book.Save(@"c:\temp\test.xls");
System.Object
C1.C1Excel.XLCell
Requirements
See Also
Reference
XLCell Members
Overview
Example
Represents individual cells in an XLSheet and provides properties for getting and setting the cell
Value, Style, and Hyperlink.
130
Object Model
Syntax
Public Class XLCell
C#
public class XLCell
Remarks
To create cells, use the XLSheet indexer (Item property). If the cell already exists, the reference will
be returned as usual. If not, the sheet will create the cell (as well as rows and columns if necessary)
and will return a reference to the new cell.
Because it creates cells automatically, the indexer is especially useful when creating and populating
sheets.
Example
For example, the code below creates a new C1XLBook, then populates the first sheet with a 10 by
10 multiplication table: Note how the code simply accesses the cells using the indexer. There's no
need to create any rows, columns, or cells. The indexer takes care of all that automatically.
C#

for (int r = 0; r < 10; r++)
{
for (int c = 0; c < 10; c++)
{
XLCell cell = sheet[r, c];
cell.Value = (r+1) * (c+1);
}
}
book.Save(@"c:\temp\test.xls");
131
System.Object
C1.C1Excel.XLCell
Requirements
See Also
Reference
XLCell Members
Members
Properties Methods
The following tables list the members exposed by XLCell.
Public Properties
Name
Description
Formula
Gets or sets a string that specifies a formula of the cell.
Hyperlink
Gets or sets a string that specifies an action to take when the cell is clicked.
Style
Gets or sets the XLStyle object associated with the cell.
Text
Gets the string representation of the current cell value.
Value
Gets or sets the value stored in the cell.
Top
Public Methods
Name
Description
132
Clone
Creates a copy of the current cell, including the value.
SetValue
Sets the Value and Style properties of a cell.
Top
See Also
Reference
XLCell Class
Methods
For a list of all members of this type, see XLCell members.
Public Methods
Name
Description
Clone
SetValue
Top
See Also
Reference
XLCell Class
Clone Method
Syntax
Public Function Clone() As XLCell
133
C#
public XLCell Clone()
Return Value
A new XLCell object that is a copy of the current instance.
Remarks
The formula of the cell is cloned only as part of a row, a worksheet or a workbook.
Requirements
See Also
Reference
XLCell Class
XLCell Members
SetValue Method
New cell value.
New cell style.
Syntax
Public Sub SetValue( _
ByVal value As System.Object, _
ByVal style As XLStyle _
)
C#
public void SetValue(
134
System.object value,
XLStyle style
)
Parameters
value
New cell value.
style
New cell style.
Remarks
This method allows you to set the Value and Style properties of a cell simultaneously.
This can make your code more compact and easier to maintain. For example: // set
cell value and style (short version) sheet[0,0].SetValue("Hello",
styleBold); // set cell value and style (longer version)
sheet[0,0].Value = "Hello"; sheet[0,0].Style = styleBold;
Requirements
See Also
Reference
XLCell Class
XLCell Members
Properties
For a list of all members of this type, see XLCell members.
Public Properties
Name
Description
Formula
135
Hyperlink
Style
Text
Value
Top
See Also
Reference
XLCell Class
Formula Property
Syntax
Public Property Formula As System.String
C#
public System.string Formula {get; set;}
Requirements
See Also
Reference
XLCell Class
XLCell Members
136
Hyperlink Property
Syntax
Public Property Hyperlink As System.String
C#
public System.string Hyperlink {get; set;}
Remarks
Hyperlinks may contain URLs that when clicked open a browser window and navigate to the
specified site (for example, "http://www.componentone.com"). They may also contain references to
files that are launched by the application associated with the file type (for example, "readme.doc").
Finally, hyperlinks can be used to send e-mails (for example, "mailto:[email protected]").
Each cell may contain a hyperlink and a value. However, if you assign a hyperlink to a cell that has
no value (Value == null), then the hyperlink text is automatically assigned to the cell value as well.
Requirements
See Also
Reference
XLCell Class
XLCell Members
Style Property
Syntax
Public Property Style As XLStyle
137
C#
public XLStyle Style {get; set;}
Remarks
The appearance of each cell is defined by one or more XLStyle objects.
When displaying a cell, Excel combines the row, column, and cell styles and merges the style
elements defined in each one in order to determine how the cell should be displayed.
The precedence of the styles is: (1) cell, (2) row, (3) column, (4) default style. For example, if a cell
style defines the font and background color, those will be applied regardless of the settings in the
row and column styles. If the row style defines an alignment, that will be applied regardless of the
column style, and so on.
The cell style may be null, in which case the cell is displayed using the other styles available or the
default book style if no others are available.
Requirements
See Also
Reference
XLCell Class
XLCell Members
Text Property
Syntax
Public ReadOnly Property Text As System.String
C#
public System.string Text {get;}
138
Requirements
See Also
Reference
XLCell Class
XLCell Members
Value Property
Syntax
Public Property Value As System.Object
C#
public System.object Value {get; set;}
Remarks
The value may contain strings, numeric, Boolean, DateTime, or null objects. Other types of objects
cannot be saved in Excel files.
DateTime values are internally converted into doubles, and stored in the sheet as such. The only
way to tell the difference between a DateTime value and a double in Excel is by way of the format
associated with the cell (XLStyle.Format property).
Requirements
See Also
Reference
139
XLCell Class
XLCell Members
XLCellRange
Object Model
Syntax
Public Class XLCellRange
C#
public class XLCellRange
System.Object
C1.C1Excel.XLCellRange
Requirements
See Also
Reference
XLCellRange Members
Overview
Object Model
140
Syntax
Public Class XLCellRange
C#
public class XLCellRange
System.Object
C1.C1Excel.XLCellRange
Requirements
See Also
Reference
XLCellRange Members
Members
Properties Methods
The following tables list the members exposed by XLCellRange.
Public Constructors
Name
Description
XLCellRange Constructor Overloaded.

Top
141
Public Properties
Name
Description
Book
Gets a reference to the parent C1XLBook object.
ColumnCount
Gets the number of columns in the range.
ColumnFrom
Gets the index of the left column in the range.
ColumnFromRef
Gets the reference type of the left column in the range.
ColumnTo
Gets or sets the index of the last column in the range.
ColumnToRef
Gets the reference type of the right column in the range.
IsEmpty
Determines whether the range is empty.
RangeType
Gets or sets a type (default, indirect or offset) for this cell range.
RowCount
Gets the number of rows in the range.
RowFrom
Gets the index of the top row in the range.
RowFromRef
Gets the reference type of the top row in the range.
RowTo
Gets or sets the index of the last row in the range.
RowToRef
Gets the reference type of the bottom row in the range.
SheetCount
Gets the number of sheets in the range.
SheetFrom
Gets the index of the first sheet in the range.
Sheets
Gets an array of XLSheet objects.
142
SheetTo
Gets or sets the index of the last sheet in the range.
Style
Gets or sets the XLStyle object associated with this range of cells.
Value
Gets or sets the complex value associated with this range of cells.
Top
Public Methods
Name
Description
Clone
Creates a copy of this cell range.
Contains
Overloaded. Determines whether the range contains a specific cell.
Intersects
Determines whether the range intersects another range.
ToString
Returns a reference string that represents the range.
Top
See Also
Reference
XLCellRange Class
XLCellRange Constructor
Overload List
Descript
Overload
ion
XLCellRange Constructor()
Creates
an
instance
of an
143
XLCellR
ange
object
containi
ng an
empty
range.
XLCellRange Constructor(Int32,Int32,Int32,Int32)
Creates
an
instance
of an
XLCellR
ange
object
containi
ng a
specifie
d
range.
XLCellRange Constructor(XLSheet,Int32,Int32,Int32,Int32)
Creates
an
instance
of an
XLCellR
ange
object
containi
ng a
specifie
d
range.
144
XLCellRange
Creates
Constructor(XLSheet,Int32,Int32,Int32,Int32,XLReferenceType,XLReferenceType,XLReferenc an
eType,XLReferenceType)
instance
of an
XLCellR
ange
object
containi
ng a
specifie
d
range.
XLCellRange Constructor(XLSheet,Int32,Int32,XLReferenceType,XLReferenceType)
Creates
an
instance
of an
XLCellR
ange
object
containi
ng a
specifie
d
range.
XLCellRange
Creates
Constructor(Int32,Int32,Int32,Int32,Int32,Int32,XLReferenceType,XLReferenceType,XLRefer
an
enceType,XLReferenceType)
instance
of an
XLCellR
ange
object
containi
145
ng a
specifie
d
range.
XLCellRange Constructor(XLSheet,String)
Creates
an
instance
of an
XLCellR
ange
object
containi
ng a
specifie
d
range.
XLCellRange Constructor(C1XLBook,String)
Creates
an
instance
of an
XLCellR
ange
object
containi
ng a
specifie
d
range.
Requirements
146
See Also
Reference
XLCellRange Class
XLCellRange Members
XLCellRange Constructor()
Creates an instance of an XLCellRange object containing an empty range.
Syntax
C#
public XLCellRange()
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
Overload List
XLCellRange Constructor(Int32,Int32,Int32,Int32)
Top row in the range.
Bottom row in the range.
Left column in the range.
Right column in the range.
Creates an instance of an XLCellRange object containing a specified range.
Syntax
147

Public Function New( _
ByVal rowFrom As System.Integer, _
ByVal rowTo As System.Integer, _
ByVal colFrom As System.Integer, _
ByVal colTo As System.Integer _
)
C#
public XLCellRange(
System.int rowFrom,
System.int rowTo,
System.int colFrom,
System.int colTo
)
Parameters
rowFrom
rowTo
colFrom
colTo
Requirements
See Also
Reference
148
XLCellRange Class
XLCellRange Members
Overload List
XLCellRange Constructor(XLSheet,Int32,Int32,Int32,Int32)
The XLSheet of this cell range.
Syntax
ByVal sheet As XLSheet, _
)
C#
public XLCellRange(
XLSheet sheet,
System.int rowFrom,
System.int rowTo,
System.int colFrom,
System.int colTo
)
Parameters
sheet
149
rowFrom
rowTo
colFrom
colTo
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP
SP3, Windows Server 2008 (Server Core not supported), Windows Server
2008 R2 (Server Core supported with SP1 or later), Windows Server 2003
SP2
See Also
Reference
XLCellRange Class
XLCellRange Members
Overload List
XLCellRange
Constructor(XLSheet,Int32,Int32,Int32,Int32,XLReferenceType,XLReferenceType,XLReferenceType,XL
ReferenceType)
The reference type of the top row in the range.
The reference type of the bottom row in the range.
150
The reference type of the left column in the range.

The reference type of the right column in the range.
Syntax
ByVal colTo As System.Integer, _
ByVal rowFromRef As XLReferenceType, _
ByVal rowToRef As XLReferenceType, _
ByVal colFromRef As XLReferenceType, _
ByVal colToRef As XLReferenceType _
)
C#
public XLCellRange(
XLSheet sheet,
System.int rowFrom,
System.int rowTo,
System.int colFrom,
System.int colTo,
XLReferenceType rowFromRef,
XLReferenceType rowToRef,
XLReferenceType colFromRef,
XLReferenceType colToRef
)
Parameters
sheet
rowFrom
151

rowTo
colFrom
colTo
rowFromRef
rowToRef
colFromRef
colToRef
Requirements
Target Platforms: Windows 7, Windows Vista SP1
or later, Windows XP SP3, Windows Server 2008
(Server Core not supported), Windows Server 2008
R2 (Server Core supported with SP1 or later),
See Also
Reference
XLCellRange Class
XLCellRange Members
Overload List
XLCellRange Constructor(XLSheet,Int32,Int32,XLReferenceType,XLReferenceType)
The XLSheet of the range.
152
The row in the range equal one cell.

The column in the range equal one cell.
The reference type of the row.
The reference type of the column.
Syntax
ByVal ws As XLSheet, _
ByVal row As System.Integer, _
ByVal col As System.Integer, _
ByVal rowRef As XLReferenceType, _
ByVal colRef As XLReferenceType _
)
C#
public XLCellRange(
XLSheet ws,
System.int row,
System.int col,
XLReferenceType rowRef,
XLReferenceType colRef
)
Parameters
ws
The XLSheet of the range.
row
The row in the range equal one cell.
col
The column in the range equal one cell.
153
rowRef
The reference type of the row.
colRef
The reference type of the column.
Requirements
SP2
See Also
Reference
XLCellRange Class
XLCellRange Members
Overload List
XLCellRange
Constructor(Int32,Int32,Int32,Int32,Int32,Int32,XLReferenceType,XLReferenceType,XLReferenceType,
XLReferenceType)
First index of the XLSheet of the range.
Last index of the XLSheet of the range.
154
Syntax
ByVal sheetFrom As System.Integer, _
ByVal sheetTo As System.Integer, _
ByVal colTo As System.Integer, _
ByVal rowFromRef As XLReferenceType, _
ByVal rowToRef As XLReferenceType, _
ByVal colFromRef As XLReferenceType, _
ByVal colToRef As XLReferenceType _
)
C#
public XLCellRange(
System.int sheetFrom,
System.int sheetTo,
System.int rowFrom,
System.int rowTo,
System.int colFrom,
System.int colTo,
XLReferenceType rowFromRef,
XLReferenceType rowToRef,
XLReferenceType colFromRef,
XLReferenceType colToRef
)
Parameters
sheetFrom
First index of the XLSheet of the range.
sheetTo
Last index of the XLSheet of the range.
rowFrom
155

rowTo
colFrom
colTo
rowFromRef
rowToRef
colFromRef
colToRef
Requirements
Target Platforms: Windows 7, Windows
Vista SP1 or later, Windows XP SP3, Windows
Server 2008 (Server Core not supported),
Windows Server 2008 R2 (Server Core
supported with SP1 or later), Windows Server
2003 SP2
See Also
Reference
XLCellRange Class
XLCellRange Members
Overload List
156
XLCellRange Constructor(XLSheet,String)
The owner sheet for the range.
The text presentation of a specified range without sheets.
Syntax
ByVal reference As System.String _
)
C#
public XLCellRange(
XLSheet sheet,
System.string reference
)
Parameters
sheet
The owner sheet for the range.
reference
The text presentation of a specified range without sheets.
Requirements
See Also
Reference
157
XLCellRange Class
XLCellRange Members
Overload List
XLCellRange Constructor(C1XLBook,String)
The owner workbook for the range.
The text presentation of a specified range.
Syntax
ByVal book As C1XLBook, _
ByVal reference As System.String _
)
C#
public XLCellRange(
C1XLBook book,
System.string reference
)
Parameters
book
The owner workbook for the range.
reference
The text presentation of a specified range.
Requirements
See Also
158
Reference
XLCellRange Class
XLCellRange Members
Overload List
Methods
For a list of all members of this type, see XLCellRange members.
Public Methods
Name
Description
Clone
Contains
Overloaded. Determines whether the range contains a specific cell.
Intersects
ToString
Top
See Also
Reference
XLCellRange Class
Clone Method
Syntax
Public Function Clone() As XLCellRange
C#
public XLCellRange Clone()
159
Return Value
A new XLCellRange object that is a copy of the current instance.
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
Contains Method
Determines whether the range contains a specific cell.
Overload List
Overload
Description
Contains(XLSheet,Int32,Int32) Determines whether the range contains a specific cell.

Contains(XLCellRange)
Determines whether the range contains a specific range.
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
Contains(XLSheet,Int32,Int32) Method
160
Syntax
ByVal col As System.Integer _
) As System.Boolean
C#
XLSheet sheet,
System.int row,
System.int col
)
Parameters
sheet
row
col
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
Overload List
Contains(XLCellRange) Method
Determines whether the range contains a specific range.
Syntax
161

ByVal cr As XLCellRange _
) As System.Boolean
C#
XLCellRange cr
)
Parameters
cr
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
Overload List
Intersects Method
Syntax
Public Function Intersects( _
) As System.Boolean
C#
public System.bool Intersects(
162
XLCellRange cr
)
Parameters
cr
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
ToString Method
Syntax
Public Overrides Function ToString() As System.String
C#
public override System.string ToString()
Return Value
A reference string that represents the range.
Requirements
See Also
163
Reference
XLCellRange Class
XLCellRange Members
Properties
For a list of all members of this type, see XLCellRange members.
Public Properties
Name
Description
Book
ColumnCount
ColumnFrom
ColumnFromRef
ColumnTo
ColumnToRef
IsEmpty
RangeType
RowCount
RowFrom
RowFromRef
RowTo
RowToRef
164
SheetCount
SheetFrom
Sheets
SheetTo
Style
Value
Top
See Also
Reference
XLCellRange Class
Book Property
Syntax
Public ReadOnly Property Book As C1XLBook
C#
public C1XLBook Book {get;}
Requirements
See Also
165
Reference
XLCellRange Class
XLCellRange Members
ColumnCount Property
Syntax
Public ReadOnly Property ColumnCount As System.Integer
C#
public System.int ColumnCount {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
ColumnFrom Property
Syntax
Public ReadOnly Property ColumnFrom As System.Integer
C#
public System.int ColumnFrom {get;}
Requirements
166
See Also
Reference
XLCellRange Class
XLCellRange Members
ColumnFromRef Property
Syntax
Public ReadOnly Property ColumnFromRef As XLReferenceType
C#
public XLReferenceType ColumnFromRef {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
ColumnTo Property
Syntax
167
Public Property ColumnTo As System.Integer

C#
public System.int ColumnTo {get; set;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
ColumnToRef Property
Syntax
Public ReadOnly Property ColumnToRef As XLReferenceType
C#
public XLReferenceType ColumnToRef {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
168
IsEmpty Property
Syntax
Public ReadOnly Property IsEmpty As System.Boolean
C#
public System.bool IsEmpty {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
RangeType Property
Syntax
Public Property RangeType As XLRangeType
C#
public XLRangeType RangeType {get; set;}
Requirements
169
See Also
Reference
XLCellRange Class
XLCellRange Members
RowCount Property
Syntax
Public ReadOnly Property RowCount As System.Integer
C#
public System.int RowCount {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
RowFrom Property
Syntax
Public ReadOnly Property RowFrom As System.Integer
C#
170
public System.int RowFrom {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
RowFromRef Property
Syntax
Public ReadOnly Property RowFromRef As XLReferenceType
C#
public XLReferenceType RowFromRef {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
RowTo Property
Syntax
171

Public Property RowTo As System.Integer
C#
public System.int RowTo {get; set;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
RowToRef Property
Syntax
Public ReadOnly Property RowToRef As XLReferenceType
C#
public XLReferenceType RowToRef {get;}
Requirements
See Also
Reference
172
XLCellRange Class
XLCellRange Members
SheetCount Property
Syntax
Public ReadOnly Property SheetCount As System.Integer
C#
public System.int SheetCount {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
SheetFrom Property
Syntax
Public ReadOnly Property SheetFrom As System.Integer
C#
public System.int SheetFrom {get;}
Requirements
173
See Also
Reference
XLCellRange Class
XLCellRange Members
Sheets Property
Syntax
Public ReadOnly Property Sheets As XLSheet()
C#
public XLSheet[] Sheets {get;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
SheetTo Property
Syntax
174
Public Property SheetTo As System.Integer

C#
public System.int SheetTo {get; set;}
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
Style Property
Syntax
C#
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
175
Value Property
Syntax
Public Property Value As System.Object
C#
public System.object Value {get; set;}
Remarks
The value may contain strings, numeric, Boolean, DateTime, or null objects. Other types of objects
cannot be saved in Excel files.
Requirements
See Also
Reference
XLCellRange Class
XLCellRange Members
XLCellRangeCollection
Object Model
Syntax
176
Public Class XLCellRangeCollection

C#
public class XLCellRangeCollection
System.Object
C1.C1Excel.XLCellRangeCollection
Requirements
See Also
Reference
XLCellRangeCollection Members
Overview
Object Model
Syntax
Public Class XLCellRangeCollection
C#
public class XLCellRangeCollection
177
System.Object
C1.C1Excel.XLCellRangeCollection
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLCellRangeCollection.
Public Properties
Name
Description
ActiveIndex
Gets or sets the active index in the collection.
Book
Count
Gets the number of XLCellRange objects in the collection.
Item
Gets the XLCellRange object at the specified position in the collection.
Sheet
Gets the XLSheet object that owns the collection.
Top
Public Methods
178
Name
Description
Add
Overloaded. Appends an XLCellRange object to the collection.
Clear
Removes all XLCellRange objects from the collection.
Contains
Checks whether the collection contains a specific XLCellRange object.
IndexOf
Gets the position of an XLCellRange object in the collection.
Insert
Inserts an XLCellRange object at a specific position in the collection.
Remove
Removes an XLCellRange object from the collection.
RemoveAt
Removes an XLCellRange object at a specific position from the collection.
Top
See Also
Reference
XLCellRangeCollection Class
Methods
For a list of all members of this type, see XLCellRangeCollection members.
Public Methods
Name
Description
Add
Overloaded. Appends an XLCellRange object to the collection.
Clear
Contains
179
IndexOf
Insert
Remove
RemoveAt
Top
See Also
Reference
Add Method
Appends an XLCellRange object to the collection.
Overload List
Overload
Description
Add(XLCellRange)
Add(Int32,Int32,Int32,Int32) Creates an XLCellRange object and appends it to the collection.
Requirements
See Also
Reference
180
Add(XLCellRange) Method
XLCellRange object to add to the collection.
Syntax
Public Overloads Function Add( _
) As XLCellRange
C#
public XLCellRange Add(
XLCellRange cr
)
Parameters
cr
XLCellRange object to add to the collection.
Return Value
could not be added to the collection (usually because it overlaps another cell range already in
the collection).
Requirements
See Also
Reference
Overload List
181
Add(Int32,Int32,Int32,Int32) Method
Index of the top row in the cell range.
Index of the left column in the cell range.
Number of rows in the cell range.
Number of columns in the cell range.
Creates an XLCellRange object and appends it to the collection.
Syntax
ByVal rowIndex As System.Integer, _
ByVal colIndex As System.Integer, _
ByVal rowCount As System.Integer, _
ByVal colCount As System.Integer _
) As XLCellRange
C#
public XLCellRange Add(
System.int rowIndex,
System.int colIndex,
System.int rowCount,
System.int colCount
)
Parameters
rowIndex
Index of the top row in the cell range.
colIndex
Index of the left column in the cell range.
rowCount
Number of rows in the cell range.
colCount
182
Number of columns in the cell range.
Return Value
A reference to the object if it was successfully added to the collection, or null
if the object could not be added to the collection (usually because it overlaps
another cell range already in the collection).
Requirements
See Also
Reference
Overload List
Clear Method
Syntax
Public Sub Clear()
C#
public void Clear()
Requirements
See Also
Reference
183
Contains Method
XLCellRange object to look for.
Syntax
Public Function Contains( _
) As System.Boolean
C#
XLCellRange cr
)
Parameters
cr
Return Value
Requirements
See Also
Reference
184
IndexOf Method
Syntax
Public Function IndexOf( _
) As System.Integer
C#
XLCellRange cr
)
Parameters
cr
Return Value
collection.
Requirements
See Also
Reference
Insert Method
185

Syntax
Public Function Insert( _
) As XLCellRange
C#
public XLCellRange Insert(
System.int index,
XLCellRange cr
)
Parameters
index
cr
Return Value
object could not be added to the collection (usually because it overlaps another cell
Requirements
See Also
Reference
186
Remove Method
XLCellRange object to remove from the collection.
Syntax
Public Sub Remove( _
)
C#
public void Remove(
XLCellRange cr
)
Parameters
cr
XLCellRange object to remove from the collection.
Requirements
See Also
Reference
RemoveAt Method
Index of the object to remove from the collection.
187
Syntax
Public Sub RemoveAt( _
)
C#
public void RemoveAt(
System.int index
)
Parameters
index
Requirements
See Also
Reference
Properties
For a list of all members of this type, see XLCellRangeCollection members.
Public Properties
Name
Description
ActiveIndex
188
Book
Count
Item
Sheet
Top
See Also
Reference
ActiveIndex Property
Syntax
Public Property ActiveIndex As System.Integer
C#
public System.int ActiveIndex {get; set;}
Requirements
See Also
Reference
189
Book Property
Syntax
C#
Requirements
See Also
Reference
Count Property
Syntax
C#
Requirements
190
See Also
Reference
Item Property
Syntax
) As XLCellRange
C#
public XLCellRange this[
System.int index
]; {get;}
Parameters
index
Requirements
See Also
Reference
Sheet Property
Syntax
191

C#
Requirements
See Also
Reference
XLColumn
Represents a column in a worksheet. This class provides properties for setting the column's width,
style, and visibility.
Object Model
Syntax
Public Class XLColumn
C#
public class XLColumn
Remarks
The XLColumn objects do not contain any data. If you remove a column from the collection, the
data will be lost. If you later re-insert that same column back into the collection, the column will be
blank.
192
System.Object
C1.C1Excel.XLColumn
Requirements
See Also
Reference
XLColumn Members
Overview
Represents a column in a worksheet. This class provides properties for setting the column's width,
style, and visibility.
Object Model
Syntax
Public Class XLColumn
C#
public class XLColumn
Remarks
blank.
193
System.Object
C1.C1Excel.XLColumn
Requirements
See Also
Reference
XLColumn Members
Members
Properties Methods
The following tables list the members exposed by XLColumn.
Public Constructors
Name
Description
XLColumn Constructor Creates a new instance of the XLColumn class.

Top
Public Properties
Name
Description
Book
Collapsed
Gets or sets collapsed flag for the column.
IsSubtotal
Gets whether the column is subtotal.
OutlineLevel
Gets or sets subtotal outline level for the column.
194
PageBreak
Gets or sets whether there will be a forced page break after this column.
Sheet
Gets a reference to the parent XLSheet object.
Style
Gets or sets the XLStyle object that determines the appearance of the
column.
Visible
Gets or sets whether the column is visible.
Width
Gets or sets the width of the column, in twips.
Top
Public Methods
Name
Description
Clone
Creates a new XLColumn object that is a copy of the current instance.
Top
See Also
Reference
XLColumn Class
XLColumn Constructor
Creates a new instance of the XLColumn class.
Syntax
C#
public XLColumn()
195
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
Methods
For a list of all members of this type, see XLColumn members.
Public Methods
Name
Description
Clone
Top
See Also
Reference
XLColumn Class
Clone Method
Syntax
Public Function Clone() As XLColumn
C#
public XLColumn Clone()
196
Return Value
A new XLColumn object that is a copy of the current instance.
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
Properties
For a list of all members of this type, see XLColumn members.
Public Properties
Name
Description
Book
Collapsed
IsSubtotal
OutlineLevel
PageBreak
Sheet
Style
Gets or sets the XLStyle object that determines the appearance of the
column.
Visible
197
Width
Top
See Also
Reference
XLColumn Class
Book Property
Syntax
C#
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
Collapsed Property
Syntax
198
Public Property Collapsed As System.Boolean

C#
public System.bool Collapsed {get; set;}
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
IsSubtotal Property
Syntax
Public ReadOnly Property IsSubtotal As System.Boolean
C#
public System.bool IsSubtotal {get;}
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
199
OutlineLevel Property
Syntax
Public Property OutlineLevel As System.Integer
C#
public System.int OutlineLevel {get; set;}
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
PageBreak Property
Syntax
Public Property PageBreak As System.Boolean
C#
public System.bool PageBreak {get; set;}
Requirements
200
See Also
Reference
XLColumn Class
XLColumn Members
Sheet Property
Syntax
C#
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
Style Property
Gets or sets the XLStyle object that determines the appearance of the column.
Syntax
C#
201
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
Visible Property
Syntax
Public Property Visible As System.Boolean
C#
public System.bool Visible {get; set;}
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
Width Property
Syntax
202

Public Property Width As System.Integer
C#
public System.int Width {get; set;}
Remarks
A value of -1 indicates that the column should be displayed using the sheet's
XLSheet.DefaultColumnWidth.
To convert between pixels and twips, use the C1XLBook.TwipsToPixels and PixelsToTwips methods.
Requirements
See Also
Reference
XLColumn Class
XLColumn Members
XLColumnCollection
Example
Represents a collection of XLColumn objects that represent the individual columns in each XLSheet.
Object Model
Syntax
Public Class XLColumnCollection
203
C#
public class XLColumnCollection
Remarks
The collection has methods for counting, enumerating, adding, and removing columns from the
collection.
blank.
Example
Note that you can create columns automatically by using the sheet's indexer. For example, the
following code retrieves the cell at coordinates (3,3) and in doing so automatically creates four rows
and four columns automatically:
C#

XLCell
cell = sheet[3,3]; // creates 4 rows and 4 columns
System.Object
C1.C1Excel.XLColumnCollection
Requirements
See Also
Reference
XLColumnCollection Members
Overview
Example
204
Represents a collection of XLColumn objects that represent the individual columns in each XLSheet.
Object Model
Syntax
Public Class XLColumnCollection
C#
public class XLColumnCollection
Remarks
The collection has methods for counting, enumerating, adding, and removing columns from the
collection.
blank.
Example
Note that you can create columns automatically by using the sheet's indexer. For example, the
C#

XLCell
cell = sheet[3,3]; // creates 4 rows and 4 columns
System.Object
C1.C1Excel.XLColumnCollection
205
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLColumnCollection.
Public Properties
Name
Description
Book
Count
Gets the number of items in the collection.
Frozen
Gets or sets the number of frozen columns in the collection.
Item
Returns a reference to the XLColumn object at the specified index.
Sheet
Top
Public Methods
Name
Description
Add
Overloaded. Creates a new XLColumn object and adds it to the collection.
206
Clear
Removes all items from the collection.
Contains
Determines whether an XLColumn is a member of the collection.
IndexOf
Gets the index of a given XLRow object in the collection.
Insert
Overloaded. Creates a new XLColumn object and inserts it at a specific

position in the collection.
Remove
Removes an XLColumn object from the collection.
RemoveAt
Removes the XLColumn object at a given position from the collection.
Top
See Also
Reference
XLColumnCollection Class
Methods
>
Name
Description
Add
Overloaded. Creates a new XLColumn object and adds it to the collection.
Clear
Contains
IndexOf
Insert
Overloaded. Creates a new XLColumn object and inserts it at a specific

position in the collection.
Remove
RemoveAt
207
Top
See Also
Reference
Add Method
Creates a new XLColumn object and adds it to the collection.
Overload List
Overload
Description
Add()
Add(XLColumn)
Adds an XLColumn object to the collection.
Requirements
See Also
Reference
Add() Method
Syntax
Public Overloads Function Add() As XLColumn
208
C#
public XLColumn Add()
Return Value
A reference to the new XLColumn object.
Requirements
See Also
Reference
Overload List
Add(XLColumn) Method
The item to add to the collection.
Adds an XLColumn object to the collection.
Syntax
ByVal col As XLColumn _
) As XLColumn
C#
public XLColumn Add(
XLColumn col
)
Parameters
col
209
Return Value
A reference to the item that was added to the collection (in this case, always the col
parameter).
Requirements
See Also
Reference
Overload List
Clear Method
Syntax
Public Sub Clear()
C#
public void Clear()
Requirements
See Also
Reference
210
Contains Method
Item to look for.
Syntax
) As System.Boolean
C#
XLColumn col
)
Parameters
col
Item to look for.
Return Value
True if the collection contains the item, False otherwise.
Requirements
See Also
Reference
211
IndexOf Method
Item to look for.
Syntax
) As System.Integer
C#
XLColumn col
)
Parameters
col
Item to look for.
Return Value
The position of the item in the collection, or -1 if the item is not a member of the collection.
Requirements
See Also
Reference
Insert Method
Creates a new XLColumn object and inserts it at a specific position in the collection.
212
Overload List
Overload
Description
Insert(Int32)
Creates a new XLColumn object and inserts it at a specific position in the

collection.
Insert(Int32,XLColumn) Inserts an XLColumn object at a specific position in the collection.
Requirements
See Also
Reference
Insert(Int32) Method
Position where the new item will be inserted.
Creates a new XLColumn object and inserts it at a specific position in the collection.
Syntax
Public Overloads Function Insert( _
) As XLColumn
C#
public XLColumn Insert(
System.int index
)
Parameters
213
index
Return Value
A reference to the new item.
Requirements
See Also
Reference
Overload List
Insert(Int32,XLColumn) Method
Position where the item will be inserted.
Item that will be inserted.
Inserts an XLColumn object at a specific position in the collection.
Syntax
) As XLColumn
C#
public XLColumn Insert(
System.int index,
XLColumn col
)
214
Parameters
index
col
Return Value
A reference to the item that was added to the collection.
Remarks
The maximum number of XLColumn objects in an XLSheet is 256. This is a limitation
imposed by Excel 2003 and below.
For Excel 2007 and above, the maximum number of XLColumn objects in an XLSheet is
18,278.
Requirements
See Also
Reference
Overload List
Remove Method
Item to be removed from the collection.
Syntax
215
Public Function Remove( _

) As XLColumn
C#
public XLColumn Remove(
XLColumn col
)
Parameters
col
Return Value
A reference to the item that was removed.
Requirements
See Also
Reference
RemoveAt Method
Index of the item to remove from the collection.
Syntax
Public Function RemoveAt( _
) As XLColumn
216
C#
public XLColumn RemoveAt(
System.int index
)
Parameters
index
Return Value
A reference to the item that was removed from the collection.
Requirements
See Also
Reference
Properties
For a list of all members of this type, see XLColumnCollection members.
Public Properties
Name
Description
Book
Count
Frozen
217
Item
Sheet
Top
See Also
Reference
Book Property
Syntax
C#
Requirements
See Also
Reference
Count Property
Syntax
218

C#
Requirements
See Also
Reference
Frozen Property
Syntax
Public Property Frozen As System.Integer
C#
public System.int Frozen {get; set;}
Remarks
Frozen columns are displayed on the right side of the sheet and do not scroll horizontally. They are
useful for displaying row headers.
Requirements
219
See Also
Reference
Item Property
Syntax
) As XLColumn
C#
public XLColumn this[
System.int index
]; {get;}
Parameters
index
Remarks
The indexer will create a new XLColumn object at the specified position if necessary. It never
returns null.
Requirements
See Also
Reference
220
Sheet Property
Syntax
C#
Requirements
See Also
Reference
XLComment
Object Model
Syntax
Public Class XLComment
C#
221
public class XLComment
System.Object
C1.C1Excel.XLComment
Requirements
See Also
Reference
XLComment Members
Overview
Object Model
Syntax
Public Class XLComment
C#
public class XLComment
System.Object
C1.C1Excel.XLComment
Requirements
222
See Also
Reference
XLComment Members
Members
Properties Methods
The following tables list the members exposed by XLComment.
Public Constructors
Name
Description
XLComment Constructor Creates an instance of a XLComment object containing a specified

range.
Top
Public Properties
Name
Description
Author
Gets a author for this comment.
Cell
Gets a reference to the cell for this comment.
ColumnIndex
Gets or sets the column index of the comment.
IsShow
Gets or sets the show flag of the comment.
RowIndex
Gets or sets the row index of the comment.
Sheet
223
TextBox
Gets a reference to the XLCommentShape object with context.
Top
Public Methods
Name
Description
Clone
Creates a new XLComment object that is a copy of the current instance.
Top
See Also
Reference
XLComment Class
XLComment Constructor
Row that the comment applies to.
Column that the comment applies to.
Comment author.
Comment content.
Creates an instance of a XLComment object containing a specified range.
Syntax
ByVal col As System.Integer, _
ByVal author As System.String, _
ByVal text As System.String _
)
C#
224
public XLComment(
System.int row,
System.int col,
System.string author,
System.string text
)
Parameters
row
Row that the comment applies to.
col
Column that the comment applies to.
author
Comment author.
text
Comment content.
Requirements
See Also
Reference
XLComment Class
XLComment Members
Methods
>
Name
Clone
Description
Top
225
See Also
Reference
XLComment Class
Clone Method
Syntax
Public Function Clone() As XLComment
C#
public XLComment Clone()
Return Value
A new XLComment object that is a copy of the current instance.
Requirements
See Also
Reference
XLComment Class
XLComment Members
Properties
For a list of all members of this type, see XLComment members.
Public Properties
Name
Description
226
Author
Cell
ColumnIndex
IsShow
RowIndex
Sheet
TextBox
Top
See Also
Reference
XLComment Class
Author Property
Syntax
Public ReadOnly Property Author As System.String
C#
public System.string Author {get;}
Requirements
227
See Also
Reference
XLComment Class
XLComment Members
Cell Property
Syntax
Public ReadOnly Property Cell As XLCell
C#
public XLCell Cell {get;}
Remarks
A reference to the XLCell object at the comment coordinates, or null if there is no cell at the
specified position.
Requirements
See Also
Reference
XLComment Class
XLComment Members
ColumnIndex Property
Syntax
228

Public Property ColumnIndex As System.Integer
C#
public System.int ColumnIndex {get; set;}
Requirements
See Also
Reference
XLComment Class
XLComment Members
IsShow Property
Syntax
Public Property IsShow As System.Boolean
C#
public System.bool IsShow {get; set;}
Requirements
See Also
Reference
229
XLComment Class
XLComment Members
RowIndex Property
Syntax
Public Property RowIndex As System.Integer
C#
public System.int RowIndex {get; set;}
Requirements
See Also
Reference
XLComment Class
XLComment Members
Sheet Property
Syntax
C#
Requirements
230
See Also
Reference
XLComment Class
XLComment Members
TextBox Property
Syntax
Public ReadOnly Property TextBox As XLCommentShape
C#
public XLCommentShape TextBox {get;}
Requirements
See Also
Reference
XLComment Class
XLComment Members
XLCommentCollection
Object Model
231
Syntax
Public Class XLCommentCollection
C#
public class XLCommentCollection
System.Object
C1.C1Excel.XLCommentCollection
Requirements
See Also
Reference
XLCommentCollection Members
Overview
Object Model
Syntax
232
Public Class XLCommentCollection

C#
public class XLCommentCollection
System.Object
C1.C1Excel.XLCommentCollection
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLCommentCollection.
Public Properties
Name
Description
Count
Gets the number of XLComment objects in the collection.
Item
Gets the XLComment object at the specified position in the collection.
Sheet
Top
Public Methods
233
Name
Description
Add
Overloaded. Appends an XLComment object to the collection.
Clear
Removes all XLComment objects from the collection.
Contains
Checks whether the collection contains a specific XLComment object.
IndexOf
Gets the index of a specific XLComment object in the collection.
Insert
Inserts an XLComment object at a specific position in the collection.
Remove
Removes an XLComment object from the collection.
RemoveAt
Removes an XLComment object at a specific position from the collection.
Top
See Also
Reference
XLCommentCollection Class
Methods
>
Name
Description
Add
Overloaded. Appends an XLComment object to the collection.
Clear
Contains
IndexOf
Insert
Remove
234
RemoveAt
Top
See Also
Reference
Add Method
Appends an XLComment object to the collection.
Overload List
Overload
Description
Add(XLComment)
Add(Int32,Int32,String)
Creates an XLComment object and appends it to the

collection.
Add(Int32,Int32,String,String)
Creates an XLComment object and appends it to the

collection.
Add(Int32,Int32,String,String,Boolean) Creates an XLComment object and appends it to the

collection.
Requirements
See Also
Reference
235
Add(XLComment) Method
The XLComment object to add to the collection.
Syntax
ByVal comment As XLComment _
) As XLComment
C#
public XLComment Add(
XLComment comment
)
Parameters
comment
The XLComment object to add to the collection.
Return Value
could not be added to the collection (usually because it overlaps another comment already in
the collection).
Requirements
See Also
Reference
Overload List
236
Add(Int32,Int32,String) Method
Index of the top row in the comment.
Index of the left column in the comment.
The author of the comment.
Creates an XLComment object and appends it to the collection.
Syntax
ByVal author As System.String _
) As XLComment
C#
System.string author
)
Parameters
rowIndex
colIndex
author
Return Value
object could not be added to the collection (usually because it overlaps another
comment already in the collection).
237
Requirements
See Also
Reference
Overload List
Add(Int32,Int32,String,String) Method
The context of the comment.
Syntax
) As XLComment
C#
System.string text
238
Parameters
rowIndex
colIndex
author
text
The context of the comment.
Return Value
if the object could not be added to the collection (usually because it overlaps
another comment already in the collection).
Requirements
See Also
Reference
Overload List
Add(Int32,Int32,String,String,Boolean) Method
The text of the comment.
239
Flag indicating whether to convert author and text to RTF format.

Syntax
ByVal text As System.String, _
ByVal toRtf As System.Boolean _
) As XLComment
C#
System.string text,
System.bool toRtf
)
Parameters
rowIndex
colIndex
author
text
The text of the comment.
toRtf
240
Flag indicating whether to convert author and text to RTF format.
Return Value
A reference to the object if it was successfully added to the collection, or
null if the object could not be added to the collection (usually because it
overlaps another comment already in the collection).
Requirements
SP2
See Also
Reference
Overload List
Clear Method
Syntax
Public Sub Clear()
C#
public void Clear()
Requirements
See Also
Reference
241
Contains Method
The XLComment object to look for.
Syntax
) As System.Boolean
C#
XLComment comment
)
Parameters
comment
Return Value
True if the collection contains the comment, false otherwise.
Requirements
See Also
Reference
242
IndexOf Method
Syntax
) As System.Integer
C#
XLComment comment
)
Parameters
comment
Return Value
collection.
Requirements
See Also
Reference
Insert Method
243

Syntax
) As XLComment
C#
public XLComment Insert(
System.int index,
XLComment comment
)
Parameters
index
comment
Return Value
object could not be added to the collection (usually because it overlaps another
comment already in the collection).
Requirements
See Also
Reference
244
Remove Method
The XLComment object to remove from the collection.
Syntax
Public Sub Remove( _
)
C#
public void Remove(
XLComment comment
)
Parameters
comment
The XLComment object to remove from the collection.
Requirements
See Also
Reference
RemoveAt Method
245
Syntax
)
C#
System.int index
)
Parameters
index
Requirements
See Also
Reference
Properties
For a list of all members of this type, see XLCommentCollection members.
Public Properties
Name
Description
Count
246
Item
Sheet
Top
See Also
Reference
Count Property
Syntax
C#
Requirements
See Also
Reference
Item Property
Syntax
247

) As XLComment
C#
public XLComment this[
System.int index
]; {get;}
Parameters
index
Requirements
See Also
Reference
Sheet Property
Syntax
C#
Requirements
248
See Also
Reference
XLCommentShape
Object Model
Syntax
Public Class XLCommentShape
Inherits XLTextShape
C#
public class XLCommentShape : XLTextShape
System.Object
C1.C1Excel.XLShape
C1.C1Excel.XLTextShape
C1.C1Excel.XLCommentShape
Requirements
See Also
249
Reference
XLCommentShape Members
Overview
Object Model
Syntax
Public Class XLCommentShape
Inherits XLTextShape
C#
public class XLCommentShape : XLTextShape
System.Object
C1.C1Excel.XLShape
Requirements
See Also
Reference
250
Members
Properties Methods
The following tables list the members exposed by XLCommentShape.
Public Constructors
Name
Description
XLCommentShape Constructor Overloaded.

Top
Public Properties
Name
Description
Bidirectional
Gets or sets a bidirectional count of text shape of this XLTextShape.

(Inherited from C1.C1Excel.XLTextShape)
BottomMargin
Gets or sets the bottom margin of this XLTextShape, in twips. (Inherited from
C1.C1Excel.XLTextShape)
Column
Gets the index of the column to which the shape is attached. (Inherited from
C1.C1Excel.XLShape)
DashedLineStyle
Gets or sets the dash style of the line or border around the shape. (Inherited
from C1.C1Excel.XLShape)
HorizAlign
Gets or sets a horizontal alignment of the text in this XLTextShape. (Inherited

from C1.C1Excel.XLTextShape)
Hyperlink
Gets or sets the hyperlink associated with the shape. (Inherited from
C1.C1Excel.XLShape)
Id
Gets the unique identifier of the shape. (Inherited from C1.C1Excel.XLShape)
251
IsEmpty
Overridden. Determines whether the shape is empty.
LeftMargin
Gets or sets the left margin area of this XLTextShape, in twips. (Inherited
LineColor
Gets or sets the color of the border around the shape. (Inherited from
C1.C1Excel.XLShape)
LineStyle
Gets or sets the style of the line or border around the shape. (Inherited from
C1.C1Excel.XLShape)
LineWidth
Gets or sets the width of the border around the shape, in twips. (Inherited
Locked
Gets or sets a locked of this XLTextShape. (Inherited from

Orientation
Gets or sets a orientation of this XLTextShape. (Inherited from

Rectangle
Gets or sets the rectangle that contains the shape, in twips. (Inherited from
C1.C1Excel.XLShape)
RightMargin
Gets or sets the right margin of this XLTextShape, in twips. (Inherited from
Rotation
Gets or sets the rotation of the shape, in degrees. (Inherited from

C1.C1Excel.XLShape)
Row
Gets the index of the row to which the shape is attached. (Inherited from
C1.C1Excel.XLShape)
Sheet
Gets a reference to the parent XLSheet object. (Inherited from

C1.C1Excel.XLShape)
252
Text
Gets or sets a reference to the text string contained in this XLTextShape.

TextId
Gets or sets a text identifier of this XLTextShape. (Inherited from

TextScale
Gets or sets a text scale of this XLTextShape. (Inherited from

TextToFit
Gets or sets a fit to shape of the text flag of this XLTextShape. (Inherited
TopMargin
Gets or sets the top margin of this XLTextShape, in twips. (Inherited from
VertAlign
Gets or sets a vertical alignment of the text in this XLTextShape. (Inherited

Visible
Determines whether the shape is visible.
Workbook
Gets a reference to the parent C1XLBook object. (Inherited from

C1.C1Excel.XLShape)
Wrapped
Gets or sets a wrapped text of this XLTextShape. (Inherited from

Top
Public Methods
Name
Description
Clone
Creates a new XLShape object that is a copy of the current instance.

(Inherited from C1.C1Excel.XLShape)
Top
253
See Also
Reference
XLCommentShape Class
XLCommentShape Constructor
Overload List
Overload
Description
XLCommentShape Constructor(String,Int32,Int32)
Initializes a new instance of an

XLCommentShape.
XLCommentShape Constructor(String,Int32,Int32,Int32,Int32) Initializes a new instance of an

XLCommentShape.
XLCommentShape Constructor(String,Rectangle)

XLCommentShape.
XLCommentShape Constructor(String)

XLCommentShape.
Requirements
See Also
Reference
XLCommentShape Constructor(String,Int32,Int32)
The text contained in the new XLCommentShape.
The horizontal position of the new shape with respect to the cell, in twips.
254
The vertical position of the new shape with respect to the cell, in twips.
Initializes a new instance of an XLCommentShape.
Syntax
ByVal x As System.Integer, _
ByVal y As System.Integer _
)
C#
public XLCommentShape(
System.string text,
System.int x,
System.int y
)
Parameters
text
x
y
Requirements
See Also
Reference
255
Overload List
XLCommentShape Constructor(String,Int32,Int32,Int32,Int32)
The horizontal position of the image with respect to the cell, in twips.
The vertical position of the image with respect to the cell, in twips.
The width of the image, in twips.
The height of the image, in twips.
Syntax
ByVal y As System.Integer, _
ByVal width As System.Integer, _
ByVal height As System.Integer _
)
C#
System.string text,
System.int x,
System.int y,
System.int width,
System.int height
)
Parameters
text
256
x
y
width
height
Requirements
SP2
See Also
Reference
Overload List
XLCommentShape Constructor(String,Rectangle)
The rectangle that specifies the image size and position with respect to the cell, in twips.
Syntax
ByVal rc As System.Drawing.Rectangle _
257
)
C#
System.string text,
System.Drawing.Rectangle rc
)
Parameters
text
rc
Requirements
See Also
Reference
Overload List
XLCommentShape Constructor(String)
Syntax
)
258
C#
System.string text
)
Parameters
text
Requirements
See Also
Reference
Overload List
Properties
For a list of all members of this type, see XLCommentShape members.
Public Properties
Name
Description
Bidirectional

BottomMargin
Gets or sets the bottom margin of this XLTextShape, in twips. (Inherited from
Column
C1.C1Excel.XLShape)
259
DashedLineStyle
HorizAlign
Gets or sets a horizontal alignment of the text in this XLTextShape. (Inherited

Hyperlink
C1.C1Excel.XLShape)
Id
IsEmpty
LeftMargin
Gets or sets the left margin area of this XLTextShape, in twips. (Inherited
LineColor
C1.C1Excel.XLShape)
LineStyle
C1.C1Excel.XLShape)
LineWidth
Locked
Gets or sets a locked of this XLTextShape. (Inherited from

Orientation
Gets or sets a orientation of this XLTextShape. (Inherited from

Rectangle
C1.C1Excel.XLShape)
RightMargin
Gets or sets the right margin of this XLTextShape, in twips. (Inherited from
260
Rotation

C1.C1Excel.XLShape)
Row
C1.C1Excel.XLShape)
Sheet

C1.C1Excel.XLShape)
Text

TextId
Gets or sets a text identifier of this XLTextShape. (Inherited from

TextScale
Gets or sets a text scale of this XLTextShape. (Inherited from

TextToFit
Gets or sets a fit to shape of the text flag of this XLTextShape. (Inherited
TopMargin
Gets or sets the top margin of this XLTextShape, in twips. (Inherited from
VertAlign
Gets or sets a vertical alignment of the text in this XLTextShape. (Inherited

Visible
Workbook

C1.C1Excel.XLShape)
Wrapped
Gets or sets a wrapped text of this XLTextShape. (Inherited from
261
Top
See Also
Reference
IsEmpty Property
Determines whether the shape is empty.
Syntax
Public Overrides ReadOnly Property IsEmpty As System.Boolean
C#
public override System.bool IsEmpty {get;}
Requirements
See Also
Reference
Visible Property
Syntax
262

C#
Requirements
See Also
Reference
XLNamedRange
Represents a named range of XLCell objects on one or several worksheets.
Object Model
Syntax
Public Class XLNamedRange
C#
public class XLNamedRange
System.Object
C1.C1Excel.XLNamedRange
Requirements
263
See Also
Reference
XLNamedRange Members
Overview
Represents a named range of XLCell objects on one or several worksheets.
Object Model
Syntax
Public Class XLNamedRange
C#
public class XLNamedRange
System.Object
C1.C1Excel.XLNamedRange
Requirements
See Also
Reference
264
Members
Properties Methods
The following tables list the members exposed by XLNamedRange.
Public Properties
Name
Description
Book
CellRange
Gets a reference to the XLCellRange object that determines which cells are
contained in the current named range.
CellRanges
Gets a reference to array of the XLCellRange objects that determines which

cells are contained in the current named range.
Comment
Gets or sets the comment text associated with the current named range.
IsBuiltInName
Determines whether the range has a built-in name.
IsEmpty
Determines whether the current range is empty.
IsNameOnly
Determines whether the current named range has a valid name but does not
define a range.
Name
Gets or sets the name of the current named range.
Top
Public Methods
Name
Description
Clone
Creates a new XLNamedRange object that is a copy of the current instance.
265
Contains
Top
See Also
Reference
XLNamedRange Class
Methods
>
Name
Description
Clone
Contains
Top
See Also
Reference
XLNamedRange Class
Clone Method
Syntax
Public Function Clone() As XLNamedRange
C#
public XLNamedRange Clone()
Return Value
A new XLNamedRange object that is a copy of the current instance.
266
Requirements
See Also
Reference
XLNamedRange Class
Contains Method
The worksheet containing the cell.
The row index of the cell.
The column index of the cell.
Syntax
ByVal col As System.Integer _
) As System.Boolean
C#
XLSheet sheet,
System.int row,
System.int col
)
Parameters
sheet
The worksheet containing the cell.
267
row
The row index of the cell.
col
The column index of the cell.
Return Value
True if the current named range contains the specified cell, false otherwise.
Requirements
See Also
Reference
XLNamedRange Class
Properties
For a list of all members of this type, see XLNamedRange members.
Public Properties
Name
Description
Book
CellRange
Gets a reference to the XLCellRange object that determines which cells are
contained in the current named range.
CellRanges
Gets a reference to array of the XLCellRange objects that determines which

cells are contained in the current named range.
Comment
268
IsBuiltInName
IsEmpty
IsNameOnly
Determines whether the current named range has a valid name but does not
define a range.
Name
Top
See Also
Reference
XLNamedRange Class
Book Property
Syntax
C#
Requirements
See Also
Reference
XLNamedRange Class
269
CellRange Property
Gets a reference to the XLCellRange object that determines which cells are contained in the current
named range.
Syntax
Public ReadOnly Property CellRange As XLCellRange
C#
public XLCellRange CellRange {get;}
Requirements
See Also
Reference
XLNamedRange Class
CellRanges Property
Gets a reference to array of the XLCellRange objects that determines which cells are contained in
the current named range.
Syntax
Public ReadOnly Property CellRanges As XLCellRange()
C#
public XLCellRange[] CellRanges {get;}
Requirements
270
See Also
Reference
XLNamedRange Class
Comment Property
Syntax
Public Property Comment As System.String
C#
public System.string Comment {get; set;}
Requirements
See Also
Reference
XLNamedRange Class
IsBuiltInName Property
Syntax
271
Public ReadOnly Property IsBuiltInName As System.Boolean

C#
public System.bool IsBuiltInName {get;}
Requirements
See Also
Reference
XLNamedRange Class
IsEmpty Property
Syntax
Public ReadOnly Property IsEmpty As System.Boolean
C#
public System.bool IsEmpty {get;}
Requirements
See Also
Reference
XLNamedRange Class
272
IsNameOnly Property
Determines whether the current named range has a valid name but does not define a range.
Syntax
Public ReadOnly Property IsNameOnly As System.Boolean
C#
public System.bool IsNameOnly {get;}
Requirements
See Also
Reference
XLNamedRange Class
Name Property
Syntax
Public Property Name As System.String
C#
public System.string Name {get; set;}
Requirements
273
See Also
Reference
XLNamedRange Class
XLNamedRangeCollection
Represents a collection of XLNamedRange objects.
Object Model
Syntax
Public Class XLNamedRangeCollection
C#
public class XLNamedRangeCollection
System.Object
C1.C1Excel.XLNamedRangeCollection
Requirements
See Also
Reference
XLNamedRangeCollection Members
274
Overview
Represents a collection of XLNamedRange objects.
Object Model
Syntax
Public Class XLNamedRangeCollection
C#
public class XLNamedRangeCollection
System.Object
C1.C1Excel.XLNamedRangeCollection
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLNamedRangeCollection.
Public Properties
275
Name
Description
Book
Count
Gets the number of XLNamedRange objects in the collection.
Item
Overloaded. Gets a reference to the XLNamedRange object at the specified

index. Returns null if an invalid index is specified.
Top
Public Methods
Name
Description
Add
Overloaded. Appends an XLNamedRange object to the collection.
Clear
Removes all XLNamedRange objects from the collection.
Contains
Overloaded. Checks whether the collection contains a specific

XLNamedRange object.
IndexOf
Overloaded. Gets the position of an XLNamedRange object in the

collection.
Insert
Inserts an XLNamedRange object at a specific position in the collection.
Remove
Overloaded. Removes an XLNamedRange object from the collection.
RemoveAt
Removes an XLNamedRange object at a specific position from the

collection.
Top
See Also
Reference
276
XLNamedRangeCollection Class
Methods
>
Name
Description
Add
Overloaded. Appends an XLNamedRange object to the collection.
Clear
Contains
IndexOf
Overloaded. Checks whether the collection contains a specific

XLNamedRange object.
Overloaded. Gets the position of an XLNamedRange object in the
collection.
Insert
Remove
Overloaded. Removes an XLNamedRange object from the collection.
RemoveAt
Removes an XLNamedRange object at a specific position from the

collection.
Top
See Also
Reference
Add Method
Appends an XLNamedRange object to the collection.
Overload List
Overload
Description
Add(XLNamedRange)
277
Add(String,XLCellRange)
Creates an XLNamedRange object and appends it to

the collection.
Add(String,XLCellRange[])

the collection.
Add(String,XLSheet,Int32,Int32)

the collection. This overload creates a range containing
a single cell.
Add(String,Int32,Int32,Int32,Int32)

the collection. This overload allows you to create a 3-D
reference to the same range of cells on multiple
worksheets.
Add(String,XLSheet,Int32,Int32,Int32,Int32) Creates an XLNamedRange object and appends it to

the collection.
Requirements
See Also
Reference
Add(XLNamedRange) Method
The XLNamedRange object to add to the collection.
Syntax
278

ByVal namedRange As XLNamedRange _
) As XLNamedRange
C#
public XLNamedRange Add(
XLNamedRange namedRange
)
Parameters
namedRange
The XLNamedRange object to add to the collection.
Return Value
could not be added (usually because it overlaps another cell range already in the collection).
Requirements
See Also
Reference
Overload List
Add(String,XLCellRange) Method
The name of the named range to create.
The XLCellRange to include in the named range.
Creates an XLNamedRange object and appends it to the collection.
Syntax
279

ByVal name As System.String, _
ByVal cellRange As XLCellRange _
) As XLNamedRange
C#
System.string name,
XLCellRange cellRange
)
Parameters
name
cellRange
The XLCellRange to include in the named range.
Return Value
object could not be added (usually because it overlaps another cell range already in the
collection).
Requirements
See Also
Reference
Overload List
Add(String,XLCellRange[]) Method
The array of XLCellRange to include in the named range.
280
Syntax
ByVal cellRanges() As XLCellRange _
) As XLNamedRange
C#
System.string name,
XLCellRange[] cellRanges
)
Parameters
name
cellRanges
The array of XLCellRange to include in the named range.
Return Value
collection).
Requirements
See Also
Reference
281
Overload List
Add(String,XLSheet,Int32,Int32) Method
The name of XLNamedRange object.
The worksheet the range belongs to.
The row index of the cell in the range.
The column index of the cell in the range.
Creates an XLNamedRange object and appends it to the collection. This overload creates a range
containing a single cell.
Syntax
ByVal colIndex As System.Integer _
) As XLNamedRange
C#
System.string name,
XLSheet sheet,
System.int colIndex
)
Parameters
name
sheet
The worksheet the range belongs to.
282
rowIndex
The row index of the cell in the range.
colIndex
The column index of the cell in the range.
Return Value
if the object could not be added (usually because it overlaps another cell
Requirements
See Also
Reference
Overload List
Add(String,Int32,Int32,Int32,Int32) Method
The index of the first XLSheet to include.
The index of the last XLSheet to include.
The index of the top row in the cell range.
The index of the left column in the cell range.
Creates an XLNamedRange object and appends it to the collection. This overload allows you to
create a 3-D reference to the same range of cells on multiple worksheets.
Syntax
283

ByVal firstSheetIndex As System.Integer, _
ByVal lastSheetIndex As System.Integer, _
) As XLNamedRange
C#
System.string name,
System.int firstSheetIndex,
System.int lastSheetIndex,
System.int colIndex
)
Parameters
name
firstSheetIndex
The index of the first XLSheet to include.
lastSheetIndex
The index of the last XLSheet to include.
rowIndex
colIndex
Return Value
A reference to the object if it was successfully added to the collection, or
null if the object could not be added (usually because it overlaps
another cell range already in the collection).
284
Requirements
SP2
See Also
Reference
Overload List
Add(String,XLSheet,Int32,Int32,Int32,Int32) Method
The worksheet containing the range.
The number of rows in the cell range.
The number of columns in the cell range.
Syntax
ByVal rowCount As System.Integer, _
ByVal colCount As System.Integer _
) As XLNamedRange
C#
285

System.string name,
XLSheet sheet,
System.int rowCount,
System.int colCount
)
Parameters
name
sheet
The worksheet containing the range.
rowIndex
colIndex
rowCount
The number of rows in the cell range.
colCount
The number of columns in the cell range.
Return Value
A reference to the object if it was successfully added to the
collection, or null if the object could not be added (usually because
it overlaps another cell range already in the collection).
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later,
Windows XP SP3, Windows Server 2008 (Server Core not
supported), Windows Server 2008 R2 (Server Core supported with
SP1 or later), Windows Server 2003 SP2
286
See Also
Reference
Overload List
Clear Method
Syntax
Public Sub Clear()
C#
public void Clear()
Requirements
See Also
Reference
Contains Method
Checks whether the collection contains a specific XLNamedRange object.
Overload List
Overload
Description
Contains(XLNamedRange) Checks whether the collection contains a specific XLNamedRange

object.
287
Contains(String)
Checks whether the collection contains an XLNamedRange object with

the specified name.
Requirements
See Also
Reference
Contains(XLNamedRange) Method
The XLNamedRange object to look for.
Checks whether the collection contains a specific XLNamedRange object.
Syntax
) As System.Boolean
C#
)
Parameters
namedRange
Return Value
True if the collection contains the range, false otherwise.
288
Requirements
See Also
Reference
Overload List
Contains(String) Method
The name of the XLNamedRange object to look for.
Checks whether the collection contains an XLNamedRange object with the specified name.
Syntax
ByVal name As System.String _
) As System.Boolean
C#
System.string name
)
Parameters
name
Return Value
True if the collection contains the range, false otherwise.
Requirements
289
See Also
Reference
Overload List
IndexOf Method
Gets the position of an XLNamedRange object in the collection.
Overload List
Overload
Description
IndexOf(XLNamedRange) Gets the position of an XLNamedRange object in the collection.

IndexOf(String)
Gets the position of an XLNamedRange object with the specified name in

the collection.
Requirements
See Also
Reference
IndexOf(XLNamedRange) Method
Gets the position of an XLNamedRange object in the collection.
Syntax
290

ByVal nr As XLNamedRange _
) As System.Integer
C#
XLNamedRange nr
)
Parameters
nr
Return Value
collection.
Requirements
See Also
Reference
Overload List
IndexOf(String) Method
Gets the position of an XLNamedRange object with the specified name in the collection.
Syntax
291

) As System.Integer
C#
System.string name
)
Parameters
name
Return Value
collection.
Requirements
See Also
Reference
Overload List
Insert Method
The position where the object will be inserted.
The named range to insert in the collection.
Syntax
292

) As XLNamedRange
C#
public XLNamedRange Insert(
System.int index,
)
Parameters
index
The position where the object will be inserted.
namedRange
The named range to insert in the collection.
Return Value
collection).
Requirements
See Also
Reference
Remove Method
Removes an XLNamedRange object from the collection.
293
Overload List
Overload
Description
Remove(XLNamedRange) Removes an XLNamedRange object from the collection.

Remove(String)
Removes an XLNamedRange object with the specified name from the

collection.
Requirements
See Also
Reference
Remove(XLNamedRange) Method
The XLNamedRange object to remove from the collection.
Removes an XLNamedRange object from the collection.
Syntax
ByVal nr As XLNamedRange _
) As System.Boolean
C#
XLNamedRange nr
)
Parameters
294
nr
The XLNamedRange object to remove from the collection.
Return Value
True if the object was removed, false if it was not a member of the collection.
Requirements
See Also
Reference
Overload List
Remove(String) Method
The name of the range to remove from the collection (case-insensitive).
Removes an XLNamedRange object with the specified name from the collection.
Syntax
Public Overloads Sub Remove( _
)
C#
public void Remove(
System.string name
)
Parameters
name
The name of the range to remove from the collection (case-insensitive).
295
Requirements
See Also
Reference
Overload List
RemoveAt Method
The index of the object to remove from the collection.
Removes an XLNamedRange object at a specific position from the collection.
Syntax
)
C#
System.int index
)
Parameters
index
The index of the object to remove from the collection.
Requirements
296
See Also
Reference
Properties
For a list of all members of this type, see XLNamedRangeCollection members.
Public Properties
Name
Description
Book
Count
Item
Overloaded. Gets a reference to the XLNamedRange object at the specified

index. Returns null if an invalid index is specified.
Top
See Also
Reference
Book Property
Syntax
C#
297
Requirements
See Also
Reference
Count Property
Syntax
C#
Requirements
See Also
Reference
Item Property
Gets a reference to the XLNamedRange object at the specified index. Returns null if an invalid index
is specified.
Overload List
298
Overload
Description
Item(Int32)
Gets a reference to the XLNamedRange object at the specified index. Returns

null if an invalid index is specified.
Item(String)
Gets a reference to the XLNamedRange object with the specified name. Returns
null if an object with the specified name could not be found in the collection.
Requirements
See Also
Reference
Item(Int32) Property
Gets a reference to the XLNamedRange object at the specified index. Returns null if an invalid index
is specified.
Syntax
Public Overloads ReadOnly Property Item( _
) As XLNamedRange
C#
public XLNamedRange Item(
System.int index
) {get;}
Parameters
index
299
Requirements
See Also
Reference
Overload List
Item(String) Property
Gets a reference to the XLNamedRange object with the specified name. Returns null if an object
with the specified name could not be found in the collection.
Syntax
) As XLNamedRange
C#
public XLNamedRange Item(
System.string name
) {get;}
Parameters
name
Requirements
See Also
300
Reference
Overload List
XLOpaqueShape
Represents a shape that was inserted in the sheet using Excel and is preserved but not fully exposed
by the C1XLBook component.
Object Model
Syntax
Public Class XLOpaqueShape
Inherits XLShape
C#
public class XLOpaqueShape : XLShape
Remarks
C1ExcelBook can load and save all types of shapes present in Excel sheets.
However, only image shapes are fully exposed (as XLPictureShape objects).
All other object types are loaded and saved as XLOpaqueShape objects that cannot be modified.
These include graphical elements (such as lines, rectangles, and arcs), VBA controls (such as edit
boxes, and buttons), and comments.
System.Object
C1.C1Excel.XLShape
C1.C1Excel.XLOpaqueShape
Requirements
301
See Also
Reference
XLOpaqueShape Members
Overview
Represents a shape that was inserted in the sheet using Excel and is preserved but not fully exposed
by the C1XLBook component.
Object Model
Syntax
Public Class XLOpaqueShape
Inherits XLShape
C#
public class XLOpaqueShape : XLShape
Remarks
C1ExcelBook can load and save all types of shapes present in Excel sheets.
However, only image shapes are fully exposed (as XLPictureShape objects).
All other object types are loaded and saved as XLOpaqueShape objects that cannot be modified.
These include graphical elements (such as lines, rectangles, and arcs), VBA controls (such as edit
boxes, and buttons), and comments.
302
System.Object
C1.C1Excel.XLShape
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLOpaqueShape.
Public Properties
Name
Description
Column
C1.C1Excel.XLShape)
DashedLineStyle
Hyperlink
C1.C1Excel.XLShape)
Id
IsEmpty
LineColor
303
C1.C1Excel.XLShape)
LineStyle
C1.C1Excel.XLShape)
LineWidth
Rectangle
C1.C1Excel.XLShape)
Rotation

C1.C1Excel.XLShape)
Row
C1.C1Excel.XLShape)
Sheet

C1.C1Excel.XLShape)
Workbook

C1.C1Excel.XLShape)
Top
Public Methods
Name
Description
Clone

Top
See Also
Reference
304
XLOpaqueShape Class
Properties
For a list of all members of this type, see XLOpaqueShape members.
Public Properties
Name
Description
Column
C1.C1Excel.XLShape)
DashedLineStyle
Hyperlink
C1.C1Excel.XLShape)
Id
IsEmpty
LineColor
C1.C1Excel.XLShape)
LineStyle
C1.C1Excel.XLShape)
LineWidth
Rectangle
C1.C1Excel.XLShape)
Rotation

C1.C1Excel.XLShape)
305
Row
C1.C1Excel.XLShape)
Sheet

C1.C1Excel.XLShape)
Workbook

C1.C1Excel.XLShape)
Top
See Also
Reference
XLOpaqueShape Class
IsEmpty Property
Syntax
C#
Requirements
See Also
Reference
XLOpaqueShape Class
306
XLPictureShape
Object Model
Syntax
Public Class XLPictureShape
Inherits XLShape
C#
public class XLPictureShape : XLShape
Remarks
XLPictureShape derives from the generic XLShape class to expose properties of images embedded
in sheets. These properties include the actual Image as well as information on how it should be
displayed, including Brightness, Contrast, and clipping information.
You can add images to cells simply by assigning Image objects directly to the Value property of
XLCell objects. In this case, C1XLBook will create and initialize an XLPictureShape automatically.
However, this method does not provide a lot of flexibility in terms of aligning, scaling, and clipping
the image.
A more flexible option is to create an XLPictureShape object in code, using the constructor that
takes alignment and scaling parameters, and then assign this XLPictureShape object to a cell's
Value property.
System.Object
C1.C1Excel.XLShape
C1.C1Excel.XLPictureShape
Requirements
307
See Also
Reference
XLPictureShape Members
Overview
Object Model
Syntax
Public Class XLPictureShape
Inherits XLShape
C#
public class XLPictureShape : XLShape
Remarks
XLPictureShape derives from the generic XLShape class to expose properties of images embedded
in sheets. These properties include the actual Image as well as information on how it should be
displayed, including Brightness, Contrast, and clipping information.
You can add images to cells simply by assigning Image objects directly to the Value property of
XLCell objects. In this case, C1XLBook will create and initialize an XLPictureShape automatically.
However, this method does not provide a lot of flexibility in terms of aligning, scaling, and clipping
the image.
A more flexible option is to create an XLPictureShape object in code, using the constructor that
takes alignment and scaling parameters, and then assign this XLPictureShape object to a cell's
Value property.
308
System.Object
C1.C1Excel.XLShape
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLPictureShape.
Public Constructors
Name
Description
XLPictureShape Constructor Overloaded.

Top
Public Properties
Name
Description
BottomClip
Gets or sets the bottom clipping area of this XLPictureShape, in twips.
Brightness
Gets or sets the brightness of this XLPictureShape (between 0 and 1).
BrightnessInPercents Gets or sets the brightness in percents of this XLPictureShape (between -
309
100 and 100).

Column
Gets the index of the column to which the shape is attached. (Inherited
Contrast
Gets or sets the contrast of this XLPictureShape (between 0 and 1).
ContrastInPercents
Gets or sets the contrast in percents of this XLPictureShape (between 100 and 100).
DashedLineStyle
Gets or sets the dash style of the line or border around the shape.
FileName
Gets or sets the file name of this XLPictureShape.
Hyperlink
C1.C1Excel.XLShape)
Id
Gets the unique identifier of the shape. (Inherited from

C1.C1Excel.XLShape)
Image
Gets a reference to the Image contained in this XLPictureShape.
ImageSize
Gets image size in twips.
IsEmpty
LeftClip
Gets or sets the left clipping area of this XLPictureShape, in twips.
LineColor
C1.C1Excel.XLShape)
LineStyle
Gets or sets the style of the line or border around the shape. (Inherited
310
LineWidth
Rectangle
Gets or sets the rectangle that contains the shape, in twips. (Inherited
RightClip
Gets or sets the right clipping area of this XLPictureShape, in twips.
Rotation

C1.C1Excel.XLShape)
Row
C1.C1Excel.XLShape)
Sheet

C1.C1Excel.XLShape)
TopClip
Gets or sets the top clipping area of this XLPictureShape, in twips.
Transparent
Gets or sets the transparent color of this XLPictureShape.
ViewType
Gets or sets whether this XLPictureShape should be displayed in color,

grayscale, or black and white.
Workbook

C1.C1Excel.XLShape)
Top
Public Methods
Name
Description
Clone

Top
311
See Also
Reference
XLPictureShape Class
XLPictureShape Constructor
Overload List
Overload
Description
XLPictureShape Constructor(Image,Int32,Int32)
Initializes a new instance

of an XLPictureShape.
XLPictureShape Constructor(Image,Int32,Int32,Int32,Int32)

XLPictureShape Constructor(Image,Rectangle)

XLPictureShape Constructor(Image)

XLPictureShape Constructor(Image,Size,ContentAlignment,ImageScaling) Initializes a new instance

XLPictureShape Constructor(XLSheet,Image,Int32,Int32,Int32,Int32)

Requirements
See Also
Reference
312
XLPictureShape Constructor(Image,Int32,Int32)
Example
The image contained in the new XLPictureShape.

Initializes a new instance of an XLPictureShape.
Syntax
ByVal img As System.Drawing.Image, _
ByVal y As System.Integer _
)
C#
public XLPictureShape(
System.Drawing.Image img,
System.int x,
System.int y
)
Parameters
img
x
y
313
Example
The code below adds an image to a cell. The image is rendered in its original size,
and is indented from the top left corner of the cell by 30 twips:
C#
// get sheet and cell

XLSheet sheet = c1ExcelBook1.Sheets[0];
XLCell cell = sheet[row, col];
// build XLPictureShape
XLPictureShape pic = new XLPictureShape(image, 30, 30);
// assign XLPictureShape to cell
cell.Value = pic;
Requirements

See Also
Reference
Overload List
XLPictureShape Constructor(Image,Int32,Int32,Int32,Int32)
Example

Syntax
314

)
C#
System.int x,
System.int y,
System.int width,
System.int height
)
Parameters
img
x
y
width
height
Example
The code below adds an image to a cell. The image is drawn within a
rectangle centered on a cell with a 60 twip edge around it:
315
C#

// calculate cell size to align picture
Rectangle rc = new Rectangle(0, 0
sheet.Columns[col].Width,
sheet.Rows[row].Height);
// add 60 twip edge
rc.Inflate(-60, -60);
XLPictureShape pic = new XLPictureShape(image,
rc.X, rc.Y, rc.Width, rc.Height);
cell.Value = pic;
Requirements

SP2
See Also
Reference
Overload List
XLPictureShape Constructor(Image,Rectangle)
Example

Syntax
316

ByVal rc As System.Drawing.Rectangle _
)
C#
System.Drawing.Rectangle rc
)
Parameters
img
rc
Example
The code below adds an image to a cell. The image is drawn within a rectangle centered
on a cell with a 60 twip edge around it:
C#

Rectangle rc = new Rectangle(0, 0
// add 60 twip edge
rc.Inflate(-60, -60);
XLPictureShape pic = new XLPictureShape(image, rc);
cell.Value = pic;
Requirements
317
See Also
Reference
Overload List
XLPictureShape Constructor(Image)
Syntax
ByVal img As System.Drawing.Image _
)
C#
System.Drawing.Image img
)
Parameters
img
Requirements
See Also
318
Reference
Overload List
XLPictureShape Constructor(Image,Size,ContentAlignment,ImageScaling)
Example
The Image contained in the new XLPictureShape.

The size of the cell that will contain the image, in pixels (used for aligning the image).
A System.Drawing.ContentAlignment value that specifies the position of the image in the cell.
An ImageScaling value that specifies the image scaling within the cell.
Syntax
ByVal cellSize As System.Drawing.Size, _
ByVal align As System.Drawing.ContentAlignment, _
ByVal scale As ImageScaling _
)
C#
System.Drawing.Size cellSize,
System.Drawing.ContentAlignment align,
ImageScaling scale
)
Parameters
img
The Image contained in the new XLPictureShape.
cellSize
319
The size of the cell that will contain the image, in pixels (used for aligning the image).
align
A System.Drawing.ContentAlignment value that specifies the position of the image in the
cell.
scale
An ImageScaling value that specifies the image scaling within the cell.
Remarks
This constructor automatically calculates the image size, position, and clipping
based on the cell and image sizes and on the given alignment and scaling
parameters.
Example
The code below adds an image to a cell. The image is centered within the cell
and scaled to fill the cell while preserving its aspect ratio.
C#

Size cellSize = new Size(
XLPictureShape pic = new XLPictureShape(
image,
cellSize,
ContentAlignment.MiddleCenter,
ImageScaling.Scale);
cell.Value = pic;
Requirements

320
See Also
Reference
Overload List
XLPictureShape Constructor(XLSheet,Image,Int32,Int32,Int32,Int32)
XLSheet object that owns the new shape.
The horizontal position of the image with respect to the sheet, in twips.
The vertical position of the image with respect to the sheet, in twips.
Syntax
)
C#
XLSheet sheet,
System.int x,
System.int y,
System.int width,
321
System.int height
)
Parameters
sheet
XLSheet object that owns the new shape.
img
x
The horizontal position of the image with respect to the sheet, in twips.
y
The vertical position of the image with respect to the sheet, in twips.
width
height
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later,
Windows XP SP3, Windows Server 2008 (Server Core not
supported), Windows Server 2008 R2 (Server Core supported with
SP1 or later), Windows Server 2003 SP2
See Also
Reference
Overload List
Properties
>
322
Name
Description
BottomClip
Brightness
BrightnessInPercents
Column
Contrast
ContrastInPercents
DashedLineStyle
FileName
Hyperlink
Id
Gets or sets the brightness in percents of this XLPictureShape (between 100 and 100).
Gets the index of the column to which the shape is attached. (Inherited
Gets or sets the contrast in percents of this XLPictureShape (between -100
and 100).
C1.C1Excel.XLShape)
Gets the unique identifier of the shape. (Inherited from
C1.C1Excel.XLShape)
Image
ImageSize
IsEmpty
LeftClip
LineColor
LineStyle
LineWidth
C1.C1Excel.XLShape)
Gets or sets the style of the line or border around the shape. (Inherited
323
Rectangle
RightClip
Rotation
Row
Sheet
C1.C1Excel.XLShape)
C1.C1Excel.XLShape)
C1.C1Excel.XLShape)
C1.C1Excel.XLShape)
TopClip
Transparent
ViewType
Workbook
Gets or sets whether this XLPictureShape should be displayed in color,

grayscale, or black and white.
C1.C1Excel.XLShape)
Top
See Also
Reference
BottomClip Property
Syntax
Public Property BottomClip As System.Integer
C#
324
public System.int BottomClip {get; set;}
Requirements
See Also
Reference
Brightness Property
Syntax
Public Property Brightness As System.Single
C#
public System.float Brightness {get; set;}
Requirements
See Also
Reference
BrightnessInPercents Property
Gets or sets the brightness in percents of this XLPictureShape (between -100 and 100).
Syntax
325

Public Property BrightnessInPercents As System.Single
C#
public System.float BrightnessInPercents {get; set;}
Requirements
See Also
Reference
Contrast Property
Syntax
Public Property Contrast As System.Single
C#
public System.float Contrast {get; set;}
Requirements
See Also
Reference
326
ContrastInPercents Property
Gets or sets the contrast in percents of this XLPictureShape (between -100 and 100).
Syntax
Public Property ContrastInPercents As System.Single
C#
public System.float ContrastInPercents {get; set;}
Requirements
See Also
Reference
FileName Property
Syntax
Public Property FileName As System.String
C#
public System.string FileName {get; set;}
Requirements
327
See Also
Reference
Image Property
Syntax
Public ReadOnly Property Image As System.Drawing.Image
C#
public System.Drawing.Image Image {get;}
Requirements
See Also
Reference
ImageSize Property
Syntax
328
Public ReadOnly Property ImageSize As System.Drawing.Size

C#
public System.Drawing.Size ImageSize {get;}
Requirements
See Also
Reference
IsEmpty Property
Syntax
C#
Requirements
See Also
Reference
329
LeftClip Property
Syntax
Public Property LeftClip As System.Integer
C#
public System.int LeftClip {get; set;}
Requirements
See Also
Reference
RightClip Property
Syntax
Public Property RightClip As System.Integer
C#
public System.int RightClip {get; set;}
Requirements
330
See Also
Reference
TopClip Property
Syntax
Public Property TopClip As System.Integer
C#
public System.int TopClip {get; set;}
Requirements
See Also
Reference
Transparent Property
Syntax
Public Property Transparent As System.Drawing.Color
C#
331
public System.Drawing.Color Transparent {get; set;}
Requirements
See Also
Reference
ViewType Property
Gets or sets whether this XLPictureShape should be displayed in color, grayscale, or black and
white.
Syntax
Public Property ViewType As XLPictureViewType
C#
public XLPictureViewType ViewType {get; set;}
Requirements
See Also
Reference
XLPrintSettings
332
Object Model
Syntax
Public Class XLPrintSettings
C#
public class XLPrintSettings
Remarks
The settings are applied to each sheet and are accessible through the sheet's XLSheet.PrintSettings
property.
Note that C1XLBook does not provide any printing services. The settings are used when printing the
sheet from Excel.
System.Object
C1.C1Excel.XLPrintSettings
Requirements
See Also
Reference
XLPrintSettings Members
Overview
333
Object Model
Syntax
Public Class XLPrintSettings
C#
public class XLPrintSettings
Remarks
The settings are applied to each sheet and are accessible through the sheet's XLSheet.PrintSettings
property.
Note that C1XLBook does not provide any printing services. The settings are used when printing the
sheet from Excel.
System.Object
C1.C1Excel.XLPrintSettings
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLPrintSettings.
334
Public Constructors
Name
Description
XLPrintSettings Constructor Creates a new instance of the XLPrintSettings class.

Top
Public Properties
Name
Description
AutoScale
Gets or sets the scaling mode used for printed output.
BlackAndWhite
Gets or sets whether to print the sheet in monochrome mode.
CenterHorizontal
Gets or sets whether the sheet should be centered horizontally on the

page when printed.
CenterVertical
Gets or sets whether the sheet should be centered vertically on the page
when printed.
Copies
Gets or sets the number of copies to print.
DraftQuality
Gets or sets whether to print the sheet in draft quality mode.
FitPagesAcross
Fit the sheet to this number of pages across (0 means use as many as
needed).
FitPagesDown
Fit the sheet to this number of pages down (0 means use as many as
needed).
Footer
Gets or sets the string to be displayed as a page footer when the sheet is
printed.
FooterPictureCenter Gets or sets the System.Drawing.Image or XLPictureShape for the
335
center part of the footer.

FooterPictureLeft
Gets or sets the System.Drawing.Image or XLPictureShape for the left

part of the footer.
FooterPictureRight
Gets or sets the System.Drawing.Image or XLPictureShape for the right

part of the footer.
Header
Gets or sets the string to be displayed as a page header when the sheet
is printed.
HeaderPictureCenter Gets or sets the System.Drawing.Image or XLPictureShape for the

center part of the header.
HeaderPictureLeft

part of the header.
HeaderPictureRight

part of the header.
Landscape
Gets or sets whether to print the sheet in landscape mode.
MarginBottom
Gets or sets the bottom margin, in inches. Set to a negative value to use
the default margin.
MarginFooter
Gets or sets the footer margin, in inches. Set to a negative value to use
the default margin.
MarginHeader
Gets or sets the header margin, in inches. Set to a negative value to use
the default margin.
MarginLeft
Gets or sets the left margin, in inches. Set to a negative value to use the
default margin.
MarginRight
Gets or sets the right margin, in inches. Set to a negative value to use the
336
default margin.
MarginTop
Gets or sets the top margin, in inches. Set to a negative value to use the
default margin.
PaperKind
Gets or sets the paper size to use when printing the sheet.
PrintGridlines
Gets or sets whether the gridlines will be printed.
PrintHeaders
Gets or sets whether row and column headers (the areas with row
numbers and column letters) will be printed.
PrintPagesInRows
Gets or sets whether to print the pages in rows (across first) or in

columns (down first).
ScalingFactor
Gets or sets the scaling factor (in percent) to use when printing the
sheet.
StartPage
Gets or sets the initial page number to use when printing the sheet.
Top
Public Methods
Name
Description
Clone
Creates a new XLPrintSettings object that is a copy of the current instance.
Top
See Also
Reference
XLPrintSettings Class
XLPrintSettings Constructor
Creates a new instance of the XLPrintSettings class.
337
Syntax
C#
public XLPrintSettings()
Requirements
See Also
Reference
Methods
For a list of all members of this type, see XLPrintSettings members.
Public Methods
Name
Description
Clone
Top
See Also
Reference
Clone Method
338
Syntax
Public Function Clone() As XLPrintSettings
C#
public XLPrintSettings Clone()
Return Value
A new XLPrintSettings object that is a copy of the current instance.
Requirements
See Also
Reference
Properties
>
Name
Description
AutoScale
BlackAndWhite
CenterHorizontal
CenterVertical
Copies
Gets or sets whether the sheet should be centered horizontally on the

page when printed.
Gets or sets whether the sheet should be centered vertically on the page
when printed.
339
DraftQuality
FitPagesAcross
FitPagesDown
Footer
FooterPictureCenter
FooterPictureLeft
FooterPictureRight
Header
HeaderPictureCenter
HeaderPictureLeft
HeaderPictureRight
Landscape
MarginBottom
MarginFooter
MarginHeader

Fit the sheet to this number of pages across (0 means use as many as
needed).
Fit the sheet to this number of pages down (0 means use as many as
needed).
Gets or sets the string to be displayed as a page footer when the sheet is
printed.
Gets or sets the System.Drawing.Image or XLPictureShape for the center
part of the footer.
part of the footer.
part of the footer.
Gets or sets the string to be displayed as a page header when the sheet is
printed.
Gets or sets the System.Drawing.Image or XLPictureShape for the center
part of the header.
part of the header.
part of the header.
Gets or sets the bottom margin, in inches. Set to a negative value to use
the default margin.
Gets or sets the footer margin, in inches. Set to a negative value to use the
default margin.
Gets or sets the header margin, in inches. Set to a negative value to use
the default margin.
340
MarginLeft
MarginRight
MarginTop
Gets or sets the left margin, in inches. Set to a negative value to use the
default margin.
Gets or sets the right margin, in inches. Set to a negative value to use the
default margin.
Gets or sets the top margin, in inches. Set to a negative value to use the
default margin.
PaperKind
PrintGridlines
PrintHeaders
PrintPagesInRows
Gets or sets whether row and column headers (the areas with row numbers
and column letters) will be printed.
Gets or sets whether to print the pages in rows (across first) or in columns
(down first).
ScalingFactor
Gets or sets the scaling factor (in percent) to use when printing the sheet.
StartPage
Top
See Also
Reference
AutoScale Property
Syntax
Public Property AutoScale As System.Boolean
C#
public System.bool AutoScale {get; set;}
341
Remarks
If AutoScale is set to true, then the printed sheet will be automatically scaled to fit the number of
pages specified by the FitPagesAcross and FitPagesDown properties.
If AutoScale is set to false, then the printed sheet will be scaled according to the value of the
ScalingFactor property.
Requirements
See Also
Reference
BlackAndWhite Property
Syntax
Public Property BlackAndWhite As System.Boolean
C#
public System.bool BlackAndWhite {get; set;}
Requirements
See Also
Reference
342
CenterHorizontal Property
Gets or sets whether the sheet should be centered horizontally on the page when printed.
Syntax
Public Property CenterHorizontal As System.Boolean
C#
public System.bool CenterHorizontal {get; set;}
Requirements
See Also
Reference
CenterVertical Property
Gets or sets whether the sheet should be centered vertically on the page when printed.
Syntax
Public Property CenterVertical As System.Boolean
C#
public System.bool CenterVertical {get; set;}
Requirements
343
See Also
Reference
Copies Property
Syntax
Public Property Copies As System.Integer
C#
public System.int Copies {get; set;}
Requirements
See Also
Reference
DraftQuality Property
Syntax
344
Public Property DraftQuality As System.Boolean

C#
public System.bool DraftQuality {get; set;}
Requirements
See Also
Reference
FitPagesAcross Property
Fit the sheet to this number of pages across (0 means use as many as needed).
Syntax
Public Property FitPagesAcross As System.Integer
C#
public System.int FitPagesAcross {get; set;}
Remarks
Causes C1Excel to select "fit to page" print mode, ignoring the value of the ScalingFactor property.
Setting the FitPagesAcross or FitPagesDown properties automatically sets the AutoScale property to
true, causing C1Excel to calculate the scaling factor based on the given number of pages and to
ignore the value of the ScalingFactor property.
Requirements
345
See Also
Reference
FitPagesDown Property
Fit the sheet to this number of pages down (0 means use as many as needed).
Syntax
Public Property FitPagesDown As System.Integer
C#
public System.int FitPagesDown {get; set;}
Remarks
Setting the FitPagesAcross or FitPagesDown properties automatically sets the AutoScale property to
true, causing C1Excel to calculate the scaling factor based on the given number of pages and to
ignore the value of the ScalingFactor property.
Requirements
See Also
Reference
Footer Property
Gets or sets the string to be displayed as a page footer when the sheet is printed.
Syntax
346

Public Property Footer As System.String
C#
public System.string Footer {get; set;}
Remarks
The footer string has the same structure and embedded commands as the header string. See the
Header property for details.
Requirements
See Also
Reference
FooterPictureCenter Property
Gets or sets the System.Drawing.Image or XLPictureShape for the center part of the footer.
Syntax
Public Property FooterPictureCenter As System.Object
C#
public System.object FooterPictureCenter {get; set;}
Requirements
347
See Also
Reference
FooterPictureLeft Property
Gets or sets the System.Drawing.Image or XLPictureShape for the left part of the footer.
Syntax
Public Property FooterPictureLeft As System.Object
C#
public System.object FooterPictureLeft {get; set;}
Requirements
See Also
Reference
FooterPictureRight Property
Gets or sets the System.Drawing.Image or XLPictureShape for the right part of the footer.
Syntax
Public Property FooterPictureRight As System.Object
C#
348
public System.object FooterPictureRight {get; set;}
Requirements
See Also
Reference
Header Property
Example
Gets or sets the string to be displayed as a page header when the sheet is printed.
Syntax
Public Property Header As System.String
C#
public System.string Header {get; set;}
Remarks
The header string may contain special commands, i.e. placeholders for the page number, current
date, or text formatting attributes. Most of these fields are represented by single letters with a
leading ampersand ("&").
The page header is divided into 3 sections: left, center, and right. Each section is introduced by a
special command ("&L", "&C", and "&R"). All text and all commands following are part of the
selected section.
The following commands are available:
&L Start of the left section
&C Start of the centered section
349
&R Start of the right section

&P Current page number
&N Page count
&D Current date
&T Current time
&A Sheet name
&F File name without path
&Z File path without file name
&G Picture (file name)
&B Bold toggle
&I Italic toggle
&U Underline toggle
&E Double underline toggle
&S Strikeout toggle
&X Superscript toggle
&Y Subscript toggle
&"[FontName]" Set new font
&"[FontName,FontStyle]" Set new font with specified style. The style is in most cases "Regular",
"Bold", "Italic", or "Bold Italic".
&[fontheight] Set font height in points.
Example
The code below creates a header with left, center, and right portions.
C#
PrintSettings ps = sheet.PrintSettings;
ps.Header = "&LHeader Left&CHeader Center&RHeader Right";
Requirements
350
See Also
Reference
HeaderPictureCenter Property
Gets or sets the System.Drawing.Image or XLPictureShape for the center part of the header.
Syntax
Public Property HeaderPictureCenter As System.Object
C#
public System.object HeaderPictureCenter {get; set;}
Requirements
See Also
Reference
HeaderPictureLeft Property
Gets or sets the System.Drawing.Image or XLPictureShape for the left part of the header.
Syntax
351
Public Property HeaderPictureLeft As System.Object

C#
public System.object HeaderPictureLeft {get; set;}
Requirements
See Also
Reference
HeaderPictureRight Property
Gets or sets the System.Drawing.Image or XLPictureShape for the right part of the header.
Syntax
Public Property HeaderPictureRight As System.Object
C#
public System.object HeaderPictureRight {get; set;}
Requirements
See Also
Reference
352
Landscape Property
Syntax
Public Property Landscape As System.Boolean
C#
public System.bool Landscape {get; set;}
Requirements
See Also
Reference
MarginBottom Property
Gets or sets the bottom margin, in inches. Set to a negative value to use the default margin.
Syntax
Public Property MarginBottom As System.Double
C#
public System.double MarginBottom {get; set;}
Requirements
353
See Also
Reference
MarginFooter Property
Gets or sets the footer margin, in inches. Set to a negative value to use the default margin.
Syntax
Public Property MarginFooter As System.Double
C#
public System.double MarginFooter {get; set;}
Requirements
See Also
Reference
MarginHeader Property
Gets or sets the header margin, in inches. Set to a negative value to use the default margin.
Syntax
Public Property MarginHeader As System.Double
C#
354
public System.double MarginHeader {get; set;}
Requirements
See Also
Reference
MarginLeft Property
Gets or sets the left margin, in inches. Set to a negative value to use the default margin.
Syntax
Public Property MarginLeft As System.Double
C#
public System.double MarginLeft {get; set;}
Requirements
See Also
Reference
MarginRight Property
Gets or sets the right margin, in inches. Set to a negative value to use the default margin.
Syntax
355

Public Property MarginRight As System.Double
C#
public System.double MarginRight {get; set;}
Requirements
See Also
Reference
MarginTop Property
Gets or sets the top margin, in inches. Set to a negative value to use the default margin.
Syntax
Public Property MarginTop As System.Double
C#
public System.double MarginTop {get; set;}
Requirements
See Also
Reference
356
PaperKind Property
Syntax
Public Property PaperKind As System.Drawing.Printing.PaperKind
C#
public System.Drawing.Printing.PaperKind PaperKind {get; set;}
Requirements
See Also
Reference
PrintGridlines Property
Syntax
Public Property PrintGridlines As System.Boolean
C#
public System.bool PrintGridlines {get; set;}
Requirements
357
See Also
Reference
PrintHeaders Property
Gets or sets whether row and column headers (the areas with row numbers and column letters) will
be printed.
Syntax
Public Property PrintHeaders As System.Boolean
C#
public System.bool PrintHeaders {get; set;}
Requirements
See Also
Reference
PrintPagesInRows Property
Gets or sets whether to print the pages in rows (across first) or in columns (down first).
Syntax
358

Public Property PrintPagesInRows As System.Boolean
C#
public System.bool PrintPagesInRows {get; set;}
Requirements
See Also
Reference
ScalingFactor Property
Gets or sets the scaling factor (in percent) to use when printing the sheet.
Syntax
Public Property ScalingFactor As System.Integer
C#
public System.int ScalingFactor {get; set;}
Remarks
Setting the ScalingFactor property automatically sets the AutoScale property to false, causing
C1Excel to use the selected scaling factor and to ignore the value of the FitPagesAcross and
FitPagesDown properties.
Requirements
359
See Also
Reference
StartPage Property
Syntax
Public Property StartPage As System.Integer
C#
public System.int StartPage {get; set;}
Requirements
See Also
Reference
XLRow
Represents a row in a worksheet, provides properties for setting the row's height, style, and
visibility.
Object Model
360
Syntax
Public Class XLRow
C#
public class XLRow
System.Object
C1.C1Excel.XLRow
Requirements
See Also
Reference
XLRow Members
Overview
Represents a row in a worksheet, provides properties for setting the row's height, style, and
visibility.
Object Model
Syntax
Public Class XLRow
361
C#
public class XLRow
System.Object
C1.C1Excel.XLRow
Requirements
See Also
Reference
XLRow Members
Members
Properties Methods
The following tables list the members exposed by XLRow.
Public Constructors
Name
Description
XLRow Constructor Creates a new instance of the XLRow class.

Top
Public Properties
Name
Description
Book
Collapsed
Gets or sets collapsed flag for the row.
362
Height
Gets or sets the height of the row, in twips.
IsSubtotal
Gets whether the row is subtotal.
OutlineLevel
Gets or sets subtotal outline level for the row.
PageBreak
Gets or sets whether there will be a forced page break after this row.
Sheet
Style
Gets or sets the XLStyle object that determines the appearance of the row.
Visible
Gets or sets whether the row is visible.
Top
Public Methods
Name
Description
Clone
Creates a new XLRow object that is a copy of the current instance.
Top
See Also
Reference
XLRow Class
XLRow Constructor
Creates a new instance of the XLRow class.
Syntax
363
C#
public XLRow()
Requirements
See Also
Reference
XLRow Class
XLRow Members
Methods
For a list of all members of this type, see XLRow members.
Public Methods
Name
Description
Clone
Top
See Also
Reference
XLRow Class
Clone Method
Syntax
Public Function Clone() As XLRow
364
C#
public XLRow Clone()
Return Value
A new XLRow object that is a copy of the current instance.
Requirements
See Also
Reference
XLRow Class
XLRow Members
Properties
For a list of all members of this type, see XLRow members.
Public Properties
Name
Description
Book
Collapsed
Height
IsSubtotal
OutlineLevel
PageBreak
365
Sheet
Style
Visible
Top
See Also
Reference
XLRow Class
Book Property
Syntax
C#
Requirements
See Also
Reference
XLRow Class
XLRow Members
Collapsed Property
366
Syntax
Public Property Collapsed As System.Boolean
C#
public System.bool Collapsed {get; set;}
Requirements
See Also
Reference
XLRow Class
XLRow Members
Height Property
Syntax
Public Property Height As System.Integer
C#
public System.int Height {get; set;}
Remarks
A value of -1 causes the row to be displayed using the sheet's XLSheet.DefaultRowHeight if cells of
the row not contain data, otherwise this height of the row depended from used font of the data.
To convert between pixels and twips, use the C1XLBook.TwipsToPixels and PixelsToTwips methods.
Requirements
367
See Also
Reference
XLRow Class
XLRow Members
IsSubtotal Property
Syntax
Public ReadOnly Property IsSubtotal As System.Boolean
C#
public System.bool IsSubtotal {get;}
Requirements
See Also
Reference
XLRow Class
XLRow Members
OutlineLevel Property
Syntax
368
Public Property OutlineLevel As System.Integer

C#
public System.int OutlineLevel {get; set;}
Requirements
See Also
Reference
XLRow Class
XLRow Members
PageBreak Property
Example
Syntax
Public Property PageBreak As System.Boolean
C#
public System.bool PageBreak {get; set;}
Example
The code below inserts forced page breaks at every 10th row on a sheet, and clears the breaks at all
other rows.
C#

for (int r = 0; r < sheet.Rows.Count; r++)
{
sheet.Rows[r].PageBreak = (r > 0 && r % 10 == 0);
}
369
Requirements
See Also
Reference
XLRow Class
XLRow Members
Sheet Property
Syntax
C#
Requirements
See Also
Reference
XLRow Class
XLRow Members
Style Property
Syntax
370

C#
Requirements
See Also
Reference
XLRow Class
XLRow Members
Visible Property
Syntax
C#
Requirements
See Also
Reference
371
XLRow Class
XLRow Members
XLRowCollection
Example
Represents a collection of XLRow objects that represent the individual rows in each XLSheet.
Object Model
Syntax
Public Class XLRowCollection
C#
public class XLRowCollection
Remarks
The collection has methods for counting, enumerating, adding, and removing rows from the
collection.
Example
Note that you can create rows automatically by using the sheet's indexer. For example, the
C#

sheet = book.Sheets[0];
XLCell cell
= sheet[3,3]; // creates 4 rows and 4 columns
System.Object
C1.C1Excel.XLRowCollection
372
Requirements
See Also
Reference
XLRowCollection Members
Overview
Example
Represents a collection of XLRow objects that represent the individual rows in each XLSheet.
Object Model
Syntax
Public Class XLRowCollection
C#
public class XLRowCollection
Remarks
The collection has methods for counting, enumerating, adding, and removing rows from the
collection.
Example
Note that you can create rows automatically by using the sheet's indexer. For example, the
373
C#

sheet = book.Sheets[0];
XLCell cell
= sheet[3,3]; // creates 4 rows and 4 columns
System.Object
C1.C1Excel.XLRowCollection
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLRowCollection.
Public Properties
Name
Description
Book
Count
Frozen
Gets or sets the number of frozen rows in the collection.
Item
Returns a reference to the XLRow object at the specified index.
Sheet
Top
374
Public Methods
Name
Description
Add
Overloaded. Creates a new XLRow object and adds it to the collection.
Clear
Contains
Determines whether an XLRow is a member of the collection.
IndexOf
Insert
Overloaded. Creates a new XLRow object and inserts it at a specific position

in the collection.
Remove
Removes an XLRow object from the collection.
RemoveAt
Removes the XLRow object at a given position from the collection.
Top
See Also
Reference
XLRowCollection Class
Methods
For a list of all members of this type, see XLRowCollection members.
Public Methods
Name
Description
Add
Overloaded. Creates a new XLRow object and adds it to the collection.
Clear
375
Contains
IndexOf
Insert
Overloaded. Creates a new XLRow object and inserts it at a specific position

in the collection.
Remove
RemoveAt
Top
See Also
Reference
Add Method
Creates a new XLRow object and adds it to the collection.
Overload List
Overload
Description
Add()
Add(XLRow)
Adds an XLRow object to the collection.
Requirements
See Also
Reference
376
Add() Method
Syntax
Public Overloads Function Add() As XLRow
C#
public XLRow Add()
Return Value
A reference to the new XLRow object.
Requirements
See Also
Reference
Overload List
Add(XLRow) Method
Adds an XLRow object to the collection.
Syntax
377
ByVal row As XLRow _

) As XLRow
C#
public XLRow Add(
XLRow row
)
Parameters
row
Return Value
A reference to the item that was added to the collection (in this case, always the row
parameter).
Requirements
See Also
Reference
Overload List
Clear Method
Syntax
Public Sub Clear()
C#
378
public void Clear()
Requirements
See Also
Reference
Contains Method
Item to look for.
Syntax
) As System.Boolean
C#
XLRow row
)
Parameters
row
Item to look for.
Return Value
True if the collection contains the item, False otherwise.
Requirements
379
See Also
Reference
IndexOf Method
Item to look for.
Syntax
) As System.Integer
C#
XLRow row
)
Parameters
row
Item to look for.
Return Value
The position of the item in the collection, or -1 if the item is not a member of the collection.
Requirements
380
See Also
Reference
Insert Method
Creates a new XLRow object and inserts it at a specific position in the collection.
Overload List
Overload
Description
Insert(Int32)
Creates a new XLRow object and inserts it at a specific position in the

collection.
Insert(Int32,XLRow) Inserts an XLRow object at a specific position in the collection.
Requirements
See Also
Reference
Creates a new XLRow object and inserts it at a specific position in the collection.
Syntax
381

) As XLRow
C#
public XLRow Insert(
System.int index
)
Parameters
index
Return Value
A reference to the new item.
Requirements
See Also
Reference
Overload List
Insert(Int32,XLRow) Method
Inserts an XLRow object at a specific position in the collection.
Syntax
382

) As XLRow
C#
public XLRow Insert(
System.int index,
XLRow row
)
Parameters
index
row
Return Value
A reference to the item that was added to the collection.
Remarks
The maximum number of XLRow objects in a XLSheet is 65,536. This is a limitation
imposed by Excel 2003 and below.
For Excel 2007 and above, the maximum number of XLRow objects in an XLSheet is
1,048,576.
Requirements
See Also
Reference
Overload List
383
Remove Method
Syntax
Public Function Remove( _
) As XLRow
C#
public XLRow Remove(
XLRow row
)
Parameters
row
Return Value
A reference to the item that was removed.
Requirements
See Also
Reference
RemoveAt Method
384
Syntax
Public Function RemoveAt( _
) As XLRow
C#
public XLRow RemoveAt(
System.int index
)
Parameters
index
Return Value
A reference to the item that was removed from the collection.
Requirements
See Also
Reference
Properties
For a list of all members of this type, see XLRowCollection members.
Public Properties
Name
Description
385
Book
Count
Frozen
Item
Sheet
Top
See Also
Reference
Book Property
Syntax
C#
Requirements
See Also
Reference
386
Count Property
Syntax
C#
Requirements
See Also
Reference
Frozen Property
Syntax
Public Property Frozen As System.Integer
C#
public System.int Frozen {get; set;}
Remarks
387
Frozen rows are displayed on the top of the sheet and do not scroll vertically. They are useful for
displaying column headers.
Requirements
See Also
Reference
Item Property
Syntax
) As XLRow
C#
public XLRow this[
System.int index
]; {get;}
Parameters
index
Remarks
The indexer will create a new XLRow object at the specified position if necessary. It never
returns null.
Requirements
388
See Also
Reference
Sheet Property
Syntax
C#
Requirements
See Also
Reference
XLShape
Object Model
389
Syntax
Public MustInherit Class XLShape
C#
public abstract class XLShape
Remarks
Excel sheets may contain many types of embedded shapes, including images, graphical elements,
controls, and comments.
The XLShape abstract class contains information that is common to all shape types, including the
shape's location (Sheet, Row, Column, Rectangle, Rotation), the type of border drawn around the
shape (LineWidth, LineColor, LineStyle), the Rotation applied to the shape, and Hyperlink
information.
The XLPictureShape class derives from XLShape and is used to embed images in sheets.
System.Object
C1.C1Excel.XLShape
Requirements
See Also
Reference
XLShape Members
390
Overview
Object Model
Syntax
Public MustInherit Class XLShape
C#
public abstract class XLShape
Remarks
Excel sheets may contain many types of embedded shapes, including images, graphical elements,
controls, and comments.
The XLShape abstract class contains information that is common to all shape types, including the
shape's location (Sheet, Row, Column, Rectangle, Rotation), the type of border drawn around the
shape (LineWidth, LineColor, LineStyle), the Rotation applied to the shape, and Hyperlink
information.
The XLPictureShape class derives from XLShape and is used to embed images in sheets.
System.Object
C1.C1Excel.XLShape
Requirements
391
See Also
Reference
XLShape Members
Members
Properties Methods
The following tables list the members exposed by XLShape.
Public Properties
Name
Description
Column
Gets the index of the column to which the shape is attached.
DashedLineStyle
Hyperlink
Gets or sets the hyperlink associated with the shape.
Id
Gets the unique identifier of the shape.
IsEmpty
LineColor
Gets or sets the color of the border around the shape.
LineStyle
Gets or sets the style of the line or border around the shape.
LineWidth
Gets or sets the width of the border around the shape, in twips.
Rectangle
Gets or sets the rectangle that contains the shape, in twips.
Rotation
Gets or sets the rotation of the shape, in degrees.
Row
Gets the index of the row to which the shape is attached.
392
Sheet
Workbook
Top
Public Methods
Name
Description
Clone
Top
See Also
Reference
XLShape Class
Methods
For a list of all members of this type, see XLShape members.
Public Methods
Name
Description
Clone
Top
See Also
Reference
XLShape Class
Clone Method
393
Syntax
Public Function Clone() As XLShape
C#
public XLShape Clone()
Return Value
A new XLShape object that is a copy of the current instance.
Requirements
See Also
Reference
XLShape Class
XLShape Members
Properties
For a list of all members of this type, see XLShape members.
Public Properties
Name
Description
Column
DashedLineStyle
Hyperlink
Id
394
IsEmpty
LineColor
LineStyle
LineWidth
Rectangle
Rotation
Row
Sheet
Workbook
Top
See Also
Reference
XLShape Class
Column Property
Syntax
Public ReadOnly Property Column As System.Integer
C#
public System.int Column {get;}
Requirements
395
See Also
Reference
XLShape Class
XLShape Members
DashedLineStyle Property
Syntax
Public Property DashedLineStyle As XLShapeDashedLineStyleEnum
C#
public XLShapeDashedLineStyleEnum DashedLineStyle {get; set;}
Requirements
See Also
Reference
XLShape Class
XLShape Members
Hyperlink Property
Syntax
396
Public Property Hyperlink As System.String

C#
public System.string Hyperlink {get; set;}
Remarks
If you set this property to a URL, clicking the shape in Excel will open the browser and navigate to
the URL.
Requirements
See Also
Reference
XLShape Class
XLShape Members
Id Property
Syntax
Public ReadOnly Property Id As System.Integer
C#
public System.int Id {get;}
Requirements
See Also
397
Reference
XLShape Class
XLShape Members
IsEmpty Property
Syntax
Public MustOverride ReadOnly Property IsEmpty As System.Boolean
C#
public abstract System.bool IsEmpty {get;}
Requirements
See Also
Reference
XLShape Class
XLShape Members
LineColor Property
Syntax
Public Property LineColor As System.Drawing.Color
C#
public System.Drawing.Color LineColor {get; set;}
Requirements
398
See Also
Reference
XLShape Class
XLShape Members
LineStyle Property
Syntax
Public Property LineStyle As XLShapeLineStyleEnum
C#
public XLShapeLineStyleEnum LineStyle {get; set;}
Requirements
See Also
Reference
XLShape Class
XLShape Members
LineWidth Property
Syntax
399
Public Property LineWidth As System.Single

C#
public System.float LineWidth {get; set;}
Requirements
See Also
Reference
XLShape Class
XLShape Members
Rectangle Property
Syntax
Public Property Rectangle As System.Drawing.Rectangle
C#
public System.Drawing.Rectangle Rectangle {get; set;}
Requirements
See Also
Reference
XLShape Class
XLShape Members
400
Rotation Property
Syntax
Public Property Rotation As System.Single
C#
public System.float Rotation {get; set;}
Requirements
See Also
Reference
XLShape Class
XLShape Members
Row Property
Syntax
Public ReadOnly Property Row As System.Integer
C#
public System.int Row {get;}
Requirements
401
See Also
Reference
XLShape Class
XLShape Members
Sheet Property
Syntax
C#
Requirements
See Also
Reference
XLShape Class
XLShape Members
Workbook Property
Syntax
Public ReadOnly Property Workbook As C1XLBook
C#
402
public C1XLBook Workbook {get;}
Requirements
See Also
Reference
XLShape Class
XLShape Members
XLSheet
Example
Object Model
Syntax
Public Class XLSheet
C#
public class XLSheet
Remarks
Provides indexers to get or set the value of individual cells (XLCell) and to access the Rows and
Columns on the sheet.
Example
403
Use the C1XLBookC1XLBook.Sheets indexer to get an individual sheet. For example, the code below
gets a reference to the first sheet on the book, then prints the number of rows and columns on the
sheet:
C#

Debug.WriteLine("Sheet has {0} rows and {1} columns",
sheet.Rows.Count, sheet.Columns.Count);
System.Object
C1.C1Excel.XLSheet
Requirements
See Also
Reference
XLSheet Members
Overview
Example
Object Model
Syntax
Public Class XLSheet
404
C#
public class XLSheet
Remarks
Provides indexers to get or set the value of individual cells (XLCell) and to access the Rows and
Columns on the sheet.
Example
Use the C1XLBookC1XLBook.Sheets indexer to get an individual sheet. For example, the code below
gets a reference to the first sheet on the book, then prints the number of rows and columns on the
sheet:
C#

Debug.WriteLine("Sheet has {0} rows and {1} columns",
sheet.Rows.Count, sheet.Columns.Count);
System.Object
C1.C1Excel.XLSheet
Requirements
See Also
Reference
XLSheet Members
Members
Properties Methods
The following tables list the members exposed by XLSheet.
405
Public Properties
Name
Description
Book
Gets a reference to the C1XLBook that owns the sheet.
ColumnMaxLevel
Gets maximum outline level for columns.
Columns
Gets a reference to sheet's column collection.
Comments
Gets an XLCommentCollection that contains the collection of comments

that on the sheet.
DefaultColumnWidth Gets or sets the default column width for the sheet (in twips).
DefaultRowHeight
Gets or sets the default row height for the sheet (in twips).
GridColor
Gets or sets the color used to display gridlines.
Item
Gets the cell at a specified position on the sheet, creating a new cell if
necessary.
Locked
Gets or sets a value that determines if the sheet is locked for editing.
MaxOutlineLevel
Gets the maximum subtotals outline level for rows or columns.
MergedCells
Gets an XLCellRangeCollection that contains the collection of cells that

are merged on the sheet.
Name
Gets or sets the name of the XLSheet.
OutlinesBelow
Gets or sets a value indicating the vertical location of outline buttons.
OutlinesRight
Gets or sets a value indicating the horizontal location of outline

buttons.
406
PrintSettings
Gets or sets an XLPrintSettings object that controls how the sheet is

printed.
RowMaxLevel
Gets maximum outline level for rows.
Rows
Gets a reference to the sheet's row collection.
Scale
Gets or sets the view scale of this worksheet using percentages.
SelectedCells

are selected on the sheet.
Shapes
Gets a reference to the ShapeCollection for the sheet.
ShowGridLines
Gets or sets whether Excel should show the grid lines when displaying
the sheet.
ShowHeaders
Gets or sets whether Excel should show the row and column headers
when displaying the sheet.
ShowZeros
Gets or sets whether Excel should show the zero values on the sheet.
TabColor
Gets or sets the color used to display the tab of this sheet.
TotalsBelowData
Gets whether Excel should show the subtotals data when displaying the
sheet.
Visible
Gets or sets the sheet's visibility.
Top
Public Methods
Name
Description
Clone
Creates a copy of this sheet.
407
CopyFormula
Copies the formula from a source cell to a destination cell, adjusting

relative references.
GetCell
Gets a reference to a cell at the specified coordinates or null if the cell

doesn't exist.
GetFormattedText
Gets formatted text is using XLStyle format value of the cell.
GetRangeToRepeat Returns a value indicating whether print titles are specified for this
worksheet. (Print titles are rows repeated at top, and columns repeated at
left of each page when the sheet is printed.) Output parameters indicate
the indices of title rows and columns.
Load
Overloaded. Loads the Excel worksheet from a file.
LoadCsv
Overloaded. Loads data from a file containing comma-separated values

(.csv) into the current sheet.
SaveCsv
Overloaded. Saves data from the current sheet into a comma-separated

values (.csv) formatted file.
SetRangeToRepeat Specifies the range of rows and columns to use as print titles for this
left of each page when the sheet is printed.)
Top
See Also
Reference
XLSheet Class
Methods
For a list of all members of this type, see XLSheet members.
Public Methods
408
Name
Description
Clone
CopyFormula
Copies the formula from a source cell to a destination cell, adjusting

relative references.
GetCell
Gets a reference to a cell at the specified coordinates or null if the cell

doesn't exist.
GetFormattedText
GetRangeToRepeat Returns a value indicating whether print titles are specified for this
left of each page when the sheet is printed.) Output parameters indicate
the indices of title rows and columns.
Load
Overloaded. Loads the Excel worksheet from a file.
LoadCsv
Overloaded. Loads data from a file containing comma-separated values

(.csv) into the current sheet.
SaveCsv
Overloaded. Saves data from the current sheet into a comma-separated

values (.csv) formatted file.
SetRangeToRepeat Specifies the range of rows and columns to use as print titles for this
left of each page when the sheet is printed.)
Top
See Also
Reference
XLSheet Class
409
Clone Method
Example
Syntax
Public Function Clone() As XLSheet
C#
public XLSheet Clone()
Return Value
A new XLSheet object with the same contents and formatting as this sheet.
Remarks
After cloning a sheet, you must rename it and then add it to the book (duplicate names are not
allowed).
This method is useful for applications that generate books with a large number of similar sheets.
Example
The code below loads a book that contains a template sheet, creates 12 copies of that sheet,
removes the template sheet, then saves the file with a new name.
C#
// load book with template sheet

_c1xl.Load(@"c:\temp\template.xls");
// create 12 copies of the template sheet
XLSheet templateSheet = _c1xl.Sheets["Template"];
for (int month = 1; month <= 12; month++)
{
XLSheet newSheet = templateSheet.Clone();
newSheet.Name = month.ToString(); // rename clone
newSheet[0,0].Value = month;
// make changes
_c1xl.Sheets.Add(newSheet);
// add clone to book
}
// remove the template sheet and save with new name
_c1xl.Sheets.Remove("Template");
410
_c1xl.Save(@"C:\temp\expense_report.xls");
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
CopyFormula Method
The row index of a source cell with exist formula.
The column index of a source cell with exist formula.
The row index of a destination cell for copies the formula.
The column index of a destination cell for copies the formula.
Copies the formula from a source cell to a destination cell, adjusting relative references.
Syntax
Public Sub CopyFormula( _
)
C#
public void CopyFormula(
System.int rowFrom,
System.int colFrom,
System.int rowTo,
System.int colTo
411
Parameters
rowFrom
The row index of a source cell with exist formula.
colFrom
The column index of a source cell with exist formula.
rowTo
The row index of a destination cell for copies the formula.
colTo
The column index of a destination cell for copies the formula.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
GetCell Method
Index of the row.
Index of the column.
Gets a reference to a cell at the specified coordinates or null if the cell doesn't exist.
Syntax
Public Function GetCell( _
412

) As XLCell
C#
public XLCell GetCell(
System.int colIndex
)
Parameters
rowIndex
Index of the row.
colIndex
Return Value
A reference to the XLCell object at the specified coordinates, or null if there is no cell at
the specified position.
Remarks
To populate new sheets, use the C1XLBook.Sheets indexer instead.
The indexer will automatically create new rows, columns, and cells as needed, and will
never return null.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
413
GetFormattedText Method
Index of the row.
Syntax
Public Function GetFormattedText( _
) As System.String
C#
public System.string GetFormattedText(
System.int colIndex
)
Parameters
rowIndex
Index of the row.
colIndex
Return Value
The formatted text of the cell with row and column indexes.
Requirements
See Also
Reference
414
XLSheet Class
XLSheet Members
GetRangeToRepeat Method
OUT: index of the first title row (repeated at top).
OUT: index of the last title row (repeated at top).
OUT: index of the first title column (repeated at left).
OUT: index of the last title column (repeated at left).
Returns a value indicating whether print titles are specified for this worksheet. (Print titles are rows
repeated at top, and columns repeated at left of each page when the sheet is printed.) Output
parameters indicate the indices of title rows and columns.
Syntax
Public Function GetRangeToRepeat( _
ByRef rowFrom As System.Integer, _
ByRef rowTo As System.Integer, _
ByRef colFrom As System.Integer, _
ByRef colTo As System.Integer _
) As System.Boolean
C#
public System.bool GetRangeToRepeat(
out System.int rowFrom,
out System.int rowTo,
out System.int colFrom,
out System.int colTo
)
Parameters
rowFrom
OUT: index of the first title row (repeated at top).
rowTo
OUT: index of the last title row (repeated at top).
415
colFrom
OUT: index of the first title column (repeated at left).
colTo
OUT: index of the last title column (repeated at left).
Return Value
True if title rows or columns are specified for this sheet, false otherwise.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Load Method
Loads the Excel worksheet from a file.
Overload List
Overload
Description
Load(String,Boolean)
Load(Stream,Boolean) Loads the Excel worksheet from a stream.
Requirements
See Also
416
Reference
XLSheet Class
XLSheet Members
Load(String,Boolean) Method
True to finish loading from the workbook; False to load data into the other worksheets.
Syntax
ByVal last As System.Boolean _
)
C#
public void Load(
System.bool last
)
Parameters
fileName
last
Remarks
It was previously necessary to load the workbook from the stream without filling the
worksheets.
Requirements
417
See Also
Reference
XLSheet Class
XLSheet Members
Overload List
Load(Stream,Boolean) Method
Loads the Excel worksheet from a stream.
Syntax
ByVal last As System.Boolean _
)
C#
public void Load(
System.bool last
)
Parameters
stream
last
418
Remarks
It was previously necessary to load the workbook from the stream without filling the
worksheets.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Overload List
LoadCsv Method
Loads data from a file containing comma-separated values (.csv) into the current sheet.
Overload List
Overload
Description
LoadCsv(String)
Loads data from a file containing comma-separated values (.csv) into the
current sheet.
LoadCsv(Stream)
Loads data from a stream containing comma-separated values (.csv) into the
current sheet.
Requirements
See Also
Reference
419
XLSheet Class
XLSheet Members
LoadCsv(String) Method
The name of a file containing data in .csv format.
Loads data from a file containing comma-separated values (.csv) into the current sheet.
Syntax
Public Overloads Sub LoadCsv( _
)
C#
public void LoadCsv(
)
Parameters
fileName
The name of a file containing data in .csv format.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Overload List
LoadCsv(Stream) Method
A stream containing data in .csv format.
Loads data from a stream containing comma-separated values (.csv) into the current sheet.
420
Syntax
Public Overloads Sub LoadCsv( _
)
C#
public void LoadCsv(
)
Parameters
stream
A stream containing data in .csv format.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Overload List
SaveCsv Method
Saves data from the current sheet into a comma-separated values (.csv) formatted file.
Overload List
Overload
Description
SaveCsv(String)
Saves data from the current sheet into a comma-separated values (.csv)
421
formatted file.
SaveCsv(Stream)
Saves data from the current sheet into a comma-separated values (.csv)
formatted stream.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
SaveCsv(String) Method
The target (.csv) file name.
Saves data from the current sheet into a comma-separated values (.csv) formatted file.
Syntax
Public Overloads Sub SaveCsv( _
)
C#
public void SaveCsv(
)
Parameters
fileName
The target (.csv) file name.
422
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Overload List
SaveCsv(Stream) Method
The target stream.
Saves data from the current sheet into a comma-separated values (.csv) formatted stream.
Syntax
Public Overloads Sub SaveCsv( _
)
C#
public void SaveCsv(
)
Parameters
stream
The target stream.
Requirements
423
See Also
Reference
XLSheet Class
XLSheet Members
Overload List
SetRangeToRepeat Method
Index of the first title row (repeated at top).
Index of the last title row (repeated at top).
Index of the first title column (repeated at left).
Index of the last title column (repeated at left).
Specifies the range of rows and columns to use as print titles for this worksheet. (Print titles are
rows repeated at top, and columns repeated at left of each page when the sheet is printed.)
Syntax
Public Sub SetRangeToRepeat( _
)
C#
public void SetRangeToRepeat(
System.int rowFrom,
System.int rowTo,
System.int colFrom,
System.int colTo
)
Parameters
rowFrom
Index of the first title row (repeated at top).
424
rowTo
Index of the last title row (repeated at top).
colFrom
Index of the first title column (repeated at left).
colTo
Index of the last title column (repeated at left).
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Properties
For a list of all members of this type, see XLSheet members.
Public Properties
Name
Description
Book
ColumnMaxLevel
Columns
Comments
Gets an XLCommentCollection that contains the collection of comments

that on the sheet.
DefaultColumnWidth Gets or sets the default column width for the sheet (in twips).
425
DefaultRowHeight
GridColor
Item
Gets the cell at a specified position on the sheet, creating a new cell if
necessary.
Locked
MaxOutlineLevel
MergedCells

are merged on the sheet.
Name
OutlinesBelow
OutlinesRight
Gets or sets a value indicating the horizontal location of outline

buttons.
PrintSettings
Gets or sets an XLPrintSettings object that controls how the sheet is

printed.
RowMaxLevel
Rows
Scale
SelectedCells

are selected on the sheet.
Shapes
426
ShowGridLines
Gets or sets whether Excel should show the grid lines when displaying
the sheet.
ShowHeaders
Gets or sets whether Excel should show the row and column headers
when displaying the sheet.
ShowZeros
TabColor
TotalsBelowData
Gets whether Excel should show the subtotals data when displaying the
sheet.
Visible
Top
See Also
Reference
XLSheet Class
Book Property
Syntax
C#
Requirements
427
See Also
Reference
XLSheet Class
XLSheet Members
ColumnMaxLevel Property
Syntax
Public ReadOnly Property ColumnMaxLevel As System.Integer
C#
public System.int ColumnMaxLevel {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Columns Property
Syntax
428
Public ReadOnly Property Columns As XLColumnCollection

C#
public XLColumnCollection Columns {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Comments Property
Gets an XLCommentCollection that contains the collection of comments that on the sheet.
Syntax
Public ReadOnly Property Comments As XLCommentCollection
C#
public XLCommentCollection Comments {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
429
DefaultColumnWidth Property
Gets or sets the default column width for the sheet (in twips).
Syntax
Public Property DefaultColumnWidth As System.Integer
C#
public System.int DefaultColumnWidth {get; set;}
Remarks
You can set the width of individual rows using the XLColumn class. Any columns that do not have a
custom width assigned to them will be displayed using the sheet's DefaultColumnWidth.
The DefaultColumnWidth property is expressed in twips (1/20th of a point), rather than pixels. This
allows sheets to maintain their aspect regardless of the resolution of the display.
To convert twips into pixels, use the C1XLBook.TwipsToPixels method in C1XLBook. To convert
pixels into twips, use the PixelsToTwips method.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
DefaultRowHeight Property
Syntax
430
Public Property DefaultRowHeight As System.Integer

C#
public System.int DefaultRowHeight {get; set;}
Remarks
You can set the height of individual rows using the XLRow class. Any rows that do not have a
custom height assigned to them will be displayed using the sheet's DefaultRowHeight.
The DefaultRowHeight property is expressed in twips (1/20th of a point), rather than pixels. This
allows sheets to maintain their aspect regardless of the resolution of the display.
To convert twips into pixels, use the C1XLBook.TwipsToPixels method in C1XLBook. To convert
pixels into twips, use the PixelsToTwips method.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
GridColor Property
Syntax
Public Property GridColor As System.Drawing.Color
C#
public System.Drawing.Color GridColor {get; set;}
Remarks
431
Set this property to Color.Transparent to display the grid lines using the default color.
To hide the grid lines, set the ShowGridLines property to false.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Item Property
Gets the cell at a specified position on the sheet, creating a new cell if necessary.
Syntax
) As XLCell
C#
public XLCell this[
System.int colIndex
]; {get;}
Parameters
rowIndex
colIndex
Remarks
432
If the specified cell doesn't exist when the indexer is invoked, the sheet will be expanded
and a new cell will be created, then returned. This makes it easy to create and populate
sheets.
If you want to determine whether a specific cell has been defined, use the GetCell
method instead.
The indexer is generally more useful when creating and populating sheets. The GetCell
method is more useful when loading existing sheets.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Locked Property
Example
Syntax
Public Property Locked As System.Boolean
C#
public System.bool Locked {get; set;}
Remarks
Sheets and styles can be locked. By default, sheets are unlocked and styles are locked. This
combination allows users to edit the cells in Excel.
To protect a cell against editing in Excel, both the sheet and the cell style must have the Locked
property set to true.
433
To lock most cells on a sheet and allow editing of only a few cells, lock the sheet, then create an
unlocked style and assign it to the cells that should be editable.
Example
The code below creates a data entry sheet. Most cells are locked, except for the ones where the
user is supposed to enter data.
C#
// start with a single locked sheet

_c1xl.Clear();
XLSheet sheet = _c1xl.Sheets[0];
sheet.Locked = true;
// create an unlocked style
XLStyle dataEntry = new XLStyle(_c1xl);
dataEntry.Locked = false;
dataEntry.BackColor = Color.Beige;
// create data entry titles
sheet[0,0].Value = "Name:";
sheet[1,0].Value = "Address:";
sheet[2,0].Value = "Phone #:";
create data entry cells (unlocked)
sheet[0,1].Style = dataEntry;
// save the book
_c1xl.Save(@"c:\temp\Protected.xls");
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
MaxOutlineLevel Property
434
Syntax
Public ReadOnly Property MaxOutlineLevel As System.Integer
C#
public System.int MaxOutlineLevel {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
MergedCells Property
Gets an XLCellRangeCollection that contains the collection of cells that are merged on the sheet.
Syntax
Public ReadOnly Property MergedCells As XLCellRangeCollection
C#
public XLCellRangeCollection MergedCells {get;}
Remarks
The collection has methods for inspecting, adding, or clearing merged ranges in a sheet. Each
merged range is represented by an XLCellRange object.
Requirements
435
See Also
Reference
XLSheet Class
XLSheet Members
Name Property
Syntax
Public Property Name As System.String
C#
public System.string Name {get; set;}
Remarks
When you open a workbook in Excel, the sheet names appear in the tabs below the work area.
Sheet names can be used as indexers, so they should be unique.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
OutlinesBelow Property
436
Syntax
Public Property OutlinesBelow As System.Boolean
C#
public System.bool OutlinesBelow {get; set;}
Remarks
If this property is set to true, outline buttons are located below the outline group, otherwise they
are located above the outline group.
Th default value is true
.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
OutlinesRight Property
Gets or sets a value indicating the horizontal location of outline buttons.
Syntax
Public Property OutlinesRight As System.Boolean
C#
public System.bool OutlinesRight {get; set;}
437
Remarks
If this property is set to true, outline buttons are located to the right the outline group, otherwise
they are located to the left of the outline group.
Th default value is true
.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
PrintSettings Property
Example
Gets or sets an XLPrintSettings object that controls how the sheet is printed.
Syntax
Public Property PrintSettings As XLPrintSettings
C#
public XLPrintSettings PrintSettings {get; set;}
Example
The code below creates a header for the sheet and sets the orientation to landscape:
C#
XLPrintSettings pp = sheet.PrintSettings();
pp.Landscape = true;
pp.Header = "&LLeft Header&CCenter Header&RRight Header";
438
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
RowMaxLevel Property
Syntax
Public ReadOnly Property RowMaxLevel As System.Integer
C#
public System.int RowMaxLevel {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Rows Property
Syntax
439

Public ReadOnly Property Rows As XLRowCollection
C#
public XLRowCollection Rows {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Scale Property
Syntax
Public Property Scale As System.Integer
C#
public System.int Scale {get; set;}
Requirements
See Also
Reference
440
XLSheet Class
XLSheet Members
SelectedCells Property
Gets an XLCellRangeCollection that contains the collection of cells that are selected on the sheet.
Syntax
Public ReadOnly Property SelectedCells As XLCellRangeCollection
C#
public XLCellRangeCollection SelectedCells {get;}
Remarks
The collection has methods for inspecting, adding, or clearing merged ranges in a sheet. Each
selected range is represented by an XLCellRange object.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Shapes Property
Syntax
Public ReadOnly Property Shapes As ShapeCollection
C#
441
public ShapeCollection Shapes {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
ShowGridLines Property
Gets or sets whether Excel should show the grid lines when displaying the sheet.
Syntax
Public Property ShowGridLines As System.Boolean
C#
public System.bool ShowGridLines {get; set;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
ShowHeaders Property
Gets or sets whether Excel should show the row and column headers when displaying the sheet.
Syntax
442

Public Property ShowHeaders As System.Boolean
C#
public System.bool ShowHeaders {get; set;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
ShowZeros Property
Syntax
Public Property ShowZeros As System.Boolean
C#
public System.bool ShowZeros {get; set;}
Requirements
See Also
Reference
443
XLSheet Class
XLSheet Members
TabColor Property
Syntax
Public Property TabColor As System.Drawing.Color
C#
public System.Drawing.Color TabColor {get; set;}
Remarks
Set this property to Color.Transparent to display the sheet tab using the default color.
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
TotalsBelowData Property
Gets whether Excel should show the subtotals data when displaying the sheet.
Syntax
<System.ObsoleteAttribute()>
Public ReadOnly Property TotalsBelowData As System.Boolean
C#
444
[System.ObsoleteAttribute()]
public System.bool TotalsBelowData {get;}
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
Visible Property
Syntax
C#
Requirements
See Also
Reference
XLSheet Class
XLSheet Members
XLSheetCollection
Example
445
Collection of XLSheet objects that represent the individual worksheets in a C1XLBook.
Object Model
Syntax
Public Class XLSheetCollection
C#
public class XLSheetCollection
Remarks
Provides methods and properties for counting, enumerating, adding, and removing sheets from the
workbook.
Example
Use the C1XLBookC1XLBook.Sheets property to get the book's sheet collection. For example, the
code below gets a reference to the first sheet on the book and then prints the sheet's name:
C#

Debug.WriteLine(sheet.Name);
System.Object
C1.C1Excel.XLSheetCollection
Requirements
446
See Also
Reference
XLSheetCollection Members
Overview
Example
Collection of XLSheet objects that represent the individual worksheets in a C1XLBook.
Object Model
Syntax
Public Class XLSheetCollection
C#
public class XLSheetCollection
Remarks
Provides methods and properties for counting, enumerating, adding, and removing sheets from the
workbook.
Example
Use the C1XLBookC1XLBook.Sheets property to get the book's sheet collection. For example, the
code below gets a reference to the first sheet on the book and then prints the sheet's name:
C#

Debug.WriteLine(sheet.Name);
447
System.Object
C1.C1Excel.XLSheetCollection
Requirements
See Also
Reference
Members
Properties Methods
The following tables list the members exposed by XLSheetCollection.
Public Properties
Name
Description
Book
Gets a reference to the C1XLBook that owns the collection.
Count
Gets the number of XLSheet objects in the collection.
FirstIndex
Gets or sets the index of the sheet that is initially opened when a C1XLBook
file is loaded into Excel.
Item
Overloaded. Gets the XLSheet at a given position in the collection.
SelectedIndex
Gets or sets the index of the sheet that is selected when a C1XLBook file is
loaded into Excel.
Top
Public Methods
448
Name
Description
Add
Overloaded. Creates a new XLSheet and appends it to the collection.
Clear
Contains
Overloaded. Determines whether the collection contains a specific XLSheet

object.
IndexOf
Overloaded. Gets the index of a given XLSheet in the collection.
Insert
Overloaded. Creates a new XLSheet and inserts it at a specific position in the

collection.
Remove
Overloaded. Removes an XLSheet from the collection.
RemoveAt
Removes the XLSheet at a specific index from the collection.
Top
See Also
Reference
XLSheetCollection Class
Methods
For a list of all members of this type, see XLSheetCollection members.
Public Methods
Name
Description
Add
Overloaded. Creates a new XLSheet and appends it to the collection.
Clear
449
Contains
Overloaded. Determines whether the collection contains a specific XLSheet

object.
IndexOf
Overloaded. Gets the index of a given XLSheet in the collection.
Insert
Overloaded. Creates a new XLSheet and inserts it at a specific position in the

collection.
Remove
Overloaded. Removes an XLSheet from the collection.
RemoveAt
Top
See Also
Reference
Add Method
Creates a new XLSheet and appends it to the collection.
Overload List
Overload
Description
Add()
Add(XLSheet)
Appends an existing XLSheet to the collection.
Add(String)
Creates a new XLSheet with a given name and appends it to the collection.
Requirements
450
See Also
Reference
Add() Method
Syntax
Public Overloads Function Add() As XLSheet
C#
public XLSheet Add()
Return Value
A reference to the new XLSheet object.
Requirements
See Also
Reference
Overload List
Add(XLSheet) Method
The object to add to the collection.
Appends an existing XLSheet to the collection.
Syntax
451

ByVal sheet As XLSheet _
) As XLSheet
C#
public XLSheet Add(
XLSheet sheet
)
Parameters
sheet
The object to add to the collection.
Return Value
A reference to the object that was added to the collection (in this case, always the sheet
parameter).
Requirements
See Also
Reference
Overload List
Add(String) Method
The name of the new XLSheet.
Creates a new XLSheet with a given name and appends it to the collection.
Syntax
452

) As XLSheet
C#
public XLSheet Add(
System.string name
)
Parameters
name
The name of the new XLSheet.
Return Value
Requirements
See Also
Reference
Overload List
Clear Method
Syntax
Public Sub Clear()
453
C#
public void Clear()
Requirements
See Also
Reference
Contains Method
Determines whether the collection contains a specific XLSheet object.
Overload List
Overload
Description
Contains(XLSheet) Determines whether the collection contains a specific XLSheet object.

Contains(String)
Determines whether the collection contains an XLSheet object with a given

name.
Requirements
See Also
Reference
454
Contains(XLSheet) Method
The object to look for in the collection.
Determines whether the collection contains a specific XLSheet object.
Syntax
) As System.Boolean
C#
XLSheet sheet
)
Parameters
sheet
The object to look for in the collection.
Return Value
True if the collection contains the object; False otherwise.
Requirements
See Also
Reference
Overload List
Contains(String) Method
The name of the sheet to look for (case-insensitive).
455
Determines whether the collection contains an XLSheet object with a given name.
Syntax
ByVal sheetName As System.String _
) As System.Boolean
C#
System.string sheetName
)
Parameters
sheetName
The name of the sheet to look for (case-insensitive).
Return Value
True if the collection contains an XLSheet with the given sheetName; False otherwise.
Requirements
See Also
Reference
Overload List
IndexOf Method
Gets the index of a given XLSheet in the collection.
Overload List
456
Overload
Description
IndexOf(XLSheet)
IndexOf(String)
Gets the position of the sheet with the specified name in the collection.
Requirements
See Also
Reference
IndexOf(XLSheet) Method
The object to look for.
Syntax
) As System.Integer
C#
XLSheet sheet
)
Parameters
sheet
The object to look for.
457
Return Value
The index of the object in the collection, or -1 if the object is not a member of the collection.
Requirements
See Also
Reference
Overload List
IndexOf(String) Method
Name of the object to look for (case-insensitive).
Gets the position of the sheet with the specified name in the collection.
Syntax
) As System.Integer
C#
System.string name
)
Parameters
name
Name of the object to look for (case-insensitive).
Return Value
The index of the sheet in the collection, or -1 if the sheet can't be found in the collection.
458
Requirements
See Also
Reference
Overload List
Insert Method
Creates a new XLSheet and inserts it at a specific position in the collection.
Overload List
Overload
Description
Insert(Int32)
Insert(Int32,XLSheet) Inserts an XLSheet object into the collection at the specified position.
Requirements
See Also
Reference
Index where the new XLSheet will be added.
459
Syntax
) As XLSheet
C#
public XLSheet Insert(
System.int index
)
Parameters
index
Index where the new XLSheet will be added.
Return Value
Requirements
See Also
Reference
Overload List
Insert(Int32,XLSheet) Method
XLSheet object to add to the collection.
Inserts an XLSheet object into the collection at the specified position.
460
Syntax
) As XLSheet
C#
public XLSheet Insert(
System.int index,
XLSheet sheet
)
Parameters
index
sheet
XLSheet object to add to the collection.
Return Value
A reference to the object that was added to the collection (in this case, always the sheet
parameter).
Requirements
See Also
Reference
Overload List
461
Remove Method
Removes an XLSheet from the collection.
Overload List
Overload
Description
Remove(XLSheet)
Remove(String)
Removes the XLSheet with the specified name from the collection.
Requirements
See Also
Reference
Remove(XLSheet) Method
The XLSheet object to remove from the collection.
Syntax
)
C#
public void Remove(
XLSheet sheet
)
462
Parameters
sheet
The XLSheet object to remove from the collection.
Requirements
See Also
Reference
Overload List
Remove(String) Method
Name of the sheet to remove from the collection (case-insensitive).
Removes the XLSheet with the specified name from the collection.
Syntax
)
C#
public void Remove(
System.string name
)
Parameters
name
Name of the sheet to remove from the collection (case-insensitive).
463
Requirements
See Also
Reference
Overload List
RemoveAt Method
Syntax
)
C#
System.int index
)
Parameters
index
Requirements
464
See Also
Reference
Properties
For a list of all members of this type, see XLSheetCollection members.
Public Properties
Name
Description
Book
Count
FirstIndex
Gets or sets the index of the sheet that is initially opened when a C1XLBook
file is loaded into Excel.
Item
Overloaded. Gets the XLSheet at a given position in the collection.
SelectedIndex
Gets or sets the index of the sheet that is selected when a C1XLBook file is
loaded into Excel.
Top
See Also
Reference
Book Property
Syntax
465

C#
Requirements
See Also
Reference
Count Property
Syntax
C#
Requirements
See Also
Reference
466
FirstIndex Property
Gets or sets the index of the sheet that is initially opened when a C1XLBook file is loaded into Excel.
Syntax
Public Property FirstIndex As System.Integer
C#
public System.int FirstIndex {get; set;}
Requirements
See Also
Reference
Item Property
Gets the XLSheet at a given position in the collection.
Overload List
Overload
Description
Item(Int32)
Item(String)
Gets the XLSheet with the given name (case-insensitive).
Requirements
467
See Also
Reference
Item(Int32) Property
Syntax
) As XLSheet
C#
public XLSheet Item(
System.int index
) {get;}
Parameters
index
Requirements
See Also
Reference
Overload List
468
Item(String) Property
Gets the XLSheet with the given name (case-insensitive).
Syntax
) As XLSheet
C#
public XLSheet Item(
System.string name
) {get;}
Parameters
name
Requirements
See Also
Reference
Overload List
SelectedIndex Property
Gets or sets the index of the sheet that is selected when a C1XLBook file is loaded into Excel.
Syntax
Public Property SelectedIndex As System.Integer
469
C#
public System.int SelectedIndex {get; set;}
Requirements
See Also
Reference
XLStyle
Object Model
Syntax
Public Class XLStyle
C#
public class XLStyle
Remarks
Each XLStyle object may define one or more of the following elements: font, format, background
color, background pattern, foreground color, alignment, text direction, and word wrapping.
elements defined in each one in order to determine how the cell should be displayed. The
precedence of the styles is: (1) cell, (2) row, (3) column, (4) default style.
470
Every XLStyle belongs to a C1XLBook, and may be assigned to one or more XLRow, XLColumn, and
XLCell objects through their Style property.
System.Object
C1.C1Excel.XLStyle
Requirements
See Also
Reference
XLStyle Members
Overview
Object Model
Syntax
Public Class XLStyle
C#
public class XLStyle
Remarks
Each XLStyle object may define one or more of the following elements: font, format, background
color, background pattern, foreground color, alignment, text direction, and word wrapping.
471
elements defined in each one in order to determine how the cell should be displayed. The
precedence of the styles is: (1) cell, (2) row, (3) column, (4) default style.
Every XLStyle belongs to a C1XLBook, and may be assigned to one or more XLRow, XLColumn, and
XLCell objects through their Style property.
System.Object
C1.C1Excel.XLStyle
Requirements
See Also
Reference
XLStyle Members
Members
Properties Methods
The following tables list the members exposed by XLStyle.
Public Constructors
Name
Description
XLStyle Constructor Creates a new instance of XLStyle and adds it to the specified C1XLBook.
Top
Public Properties
Name
Description
472
AlignHorz
Gets or sets the horizontal alignment for this XLStyle.
AlignVert
Gets or sets the vertical alignment for this XLStyle.
BackColor
Gets or sets the background color for this XLStyle.
BackPattern
Gets or sets the background pattern for this XLStyle.
BorderBottom
Gets or sets the line style used to draw the bottom border.
BorderColorBottom Gets or sets the color used to draw the bottom border.
BorderColorLeft
Gets or sets the color used to draw the left border.
BorderColorRight
Gets or sets the color used to draw the right border.
BorderColorTop
Gets or sets the color used to draw the top border.
BorderLeft
Gets or sets the line style used to draw the left border.
BorderRight
Gets or sets the line style used to draw the right border.
BorderTop
Gets or sets the line style used to draw the top border.
Diagonal
Gets or sets which diagonal lines to display (none, forward, backward).
DiagonalColor
Gets or sets the color used to draw the diagonal lines.
DiagonalStyle
Gets or sets the line style used to draw the diagonal lines.
Font
Gets or sets the font for this XLStyle.
ForeColor
Gets or sets the foreground color for this XLStyle.
Format
Gets or sets the format associated with this XLStyle.
473
Indent
Gets or sets the indent cell contents for this XLStyle.
Locked
Gets or sets whether the cell should be locked for editing when the
XLSheet is protected.
PatternColor
Gets or sets the color of the background pattern for this XLStyle.
Rotation
Gets or sets the rotation for this XLStyle, in degrees.
WordWrap
Gets or sets whether this XLStyle causes cell contents to wrap.
Top
Public Methods
Name
Description
Clone
Creates a new XLStyle object that is a copy of the current instance.
Equals
Determines whether two XLStyle objects are equivalent.
FormatDotNetToXL Overloaded. Converts a .NET-style format string into an Excel format

string.
FormatXLToDotNet Overloaded. Converts an Excel-style format string into a .NET-style
format string.
GetHashCode
Serves as a hash function suitable for use in hashing algorithms and

data structures like a hash table.
SetBorderColor
Sets the border color for this XLStyle.
SetBorderStyle
Sets the border style for this XLStyle.
Top
See Also
474
Reference
XLStyle Class
XLStyle Constructor
Parent C1XLBook.
Creates a new instance of XLStyle and adds it to the specified C1XLBook.
Syntax
ByVal book As C1XLBook _
)
C#
public XLStyle(
C1XLBook book
)
Parameters
book
Parent C1XLBook.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Methods
For a list of all members of this type, see XLStyle members.
475
Public Methods
Name
Description
Clone
Equals
FormatDotNetToXL Overloaded. Converts a .NET-style format string into an Excel format

string.
FormatXLToDotNet Overloaded. Converts an Excel-style format string into a .NET-style
format string.
GetHashCode
Serves as a hash function suitable for use in hashing algorithms and

data structures like a hash table.
SetBorderColor
SetBorderStyle
Top
See Also
Reference
XLStyle Class
Clone Method
Syntax
Public Function Clone() As XLStyle
476
C#
public XLStyle Clone()
Return Value
A new XLStyle object that is a copy of the current instance.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Equals Method
XLStyle object to compare to the current instance.
Syntax
Public Overrides Function Equals( _
ByVal obj As System.Object _
) As System.Boolean
C#
public override System.bool Equals(
System.object obj
)
Parameters
obj
XLStyle object to compare to the current instance.
477
Return Value
True if the styles are equivalent, False otherwise.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
FormatDotNetToXL Method
Converts a .NET-style format string into an Excel format string.
Overload List
Overload
Description
FormatDotNetToXL(String,Type)
Converts a .NET-style format string into an Excel

format string.
FormatDotNetToXL(String,Type,CultureInfo) Converts a .NET-style format string into an Excel

format string.
FormatDotNetToXL(String)

format string.
FormatDotNetToXL(String,CultureInfo)

format string.
Requirements
478
See Also
Reference
XLStyle Class
XLStyle Members
FormatDotNetToXL(String,Type) Method
.NET-style format to convert.
Data type to be formatted.
Syntax
Public Overloads Shared Function FormatDotNetToXL( _
ByVal fmt As System.String, _
ByVal dataType As System.Type _
) As System.String
C#
public static System.string FormatDotNetToXL(
System.string fmt,
System.Type dataType
)
Parameters
fmt
dataType
Return Value
An Excel-style format string.
Requirements
479
See Also
Reference
XLStyle Class
XLStyle Members
Overload List
FormatDotNetToXL(String,Type,CultureInfo) Method
The System.Globalization.CultureInfo object.
Syntax
ByVal dataType As System.Type, _
ByVal culture As System.Globalization.CultureInfo _
) As System.String
C#
System.string fmt,
System.Type dataType,
System.Globalization.CultureInfo culture
)
Parameters
fmt
480
dataType
culture
Return Value
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Overload List
FormatDotNetToXL(String) Method
Syntax
ByVal fmt As System.String _
) As System.String
C#
System.string fmt
)
Parameters
481
fmt
Return Value
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Overload List
FormatDotNetToXL(String,CultureInfo) Method
Syntax
) As System.String
C#
System.string fmt,
)
482
Parameters
fmt
culture
Return Value
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Overload List
FormatXLToDotNet Method
Converts an Excel-style format string into a .NET-style format string.
Overload List
Overload
Description
FormatXLToDotNet(String)
Converts an Excel-style format string into a .NET-style

format string.
FormatXLToDotNet(String,CultureInfo) Converts an Excel-style format string into a .NET-style

format string.
Requirements
483
See Also
Reference
XLStyle Class
XLStyle Members
FormatXLToDotNet(String) Method
Excel-style format to convert.
Syntax
Public Overloads Shared Function FormatXLToDotNet( _
ByVal fmt As System.String _
) As System.String
C#
public static System.string FormatXLToDotNet(
System.string fmt
)
Parameters
fmt
Return Value
A .NET-style format string.
Requirements
484
See Also
Reference
XLStyle Class
XLStyle Members
Overload List
FormatXLToDotNet(String,CultureInfo) Method
Syntax
Public Overloads Shared Function FormatXLToDotNet( _
) As System.String
C#
public static System.string FormatXLToDotNet(
System.string fmt,
)
Parameters
fmt
culture
Return Value
A .NET-style format string.
Requirements
485
See Also
Reference
XLStyle Class
XLStyle Members
Overload List
GetHashCode Method
Serves as a hash function suitable for use in hashing algorithms and data structures like a hash
table.
Syntax
Public Overrides Function GetHashCode() As System.Integer
C#
public override System.int GetHashCode()
Return Value
A hash code for the current XLStyle.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
SetBorderColor Method
Color used to draw the border.
486
Syntax
Public Sub SetBorderColor( _
ByVal color As System.Drawing.Color _
)
C#
public void SetBorderColor(
System.Drawing.Color color
)
Parameters
color
Color used to draw the border.
Remarks
This method applies the setting to all four borders.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
SetBorderStyle Method
Line style used to draw the border.
Syntax
487

Public Sub SetBorderStyle( _
ByVal style As XLLineStyleEnum _
)
C#
public void SetBorderStyle(
XLLineStyleEnum style
)
Parameters
style
Line style used to draw the border.
Remarks
This method applies the setting to all four borders.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Properties
For a list of all members of this type, see XLStyle members.
Public Properties
Name
Description
AlignHorz
488
AlignVert
BackColor
BackPattern
BorderBottom
BorderColorBottom Gets or sets the color used to draw the bottom border.
BorderColorLeft
BorderColorRight
BorderColorTop
BorderLeft
BorderRight
BorderTop
Diagonal
DiagonalColor
DiagonalStyle
Font
ForeColor
Format
Indent
489
Locked
Gets or sets whether the cell should be locked for editing when the
XLSheet is protected.
PatternColor
Rotation
WordWrap
Top
See Also
Reference
XLStyle Class
AlignHorz Property
Syntax
Public Property AlignHorz As XLAlignHorzEnum
C#
public XLAlignHorzEnum AlignHorz {get; set;}
Remarks
Set the AlignHorz property to XLAlignHorzEnum.Undefined to suppress this style element and use
the default horizontal alignment instead (XLAlignHorzEnum.General).
Requirements
490
See Also
Reference
XLStyle Class
XLStyle Members
AlignVert Property
Syntax
Public Property AlignVert As XLAlignVertEnum
C#
public XLAlignVertEnum AlignVert {get; set;}
Remarks
Set the AlignVert property to XLAlignVertEnum.Undefined to suppress this style element and use
the default horizontal alignment instead (XLAlignVertEnum.Bottom).
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
BackColor Property
Syntax
491

Public Property BackColor As System.Drawing.Color
C#
public System.Drawing.Color BackColor {get; set;}
Remarks
Set the BackColor property to Color.Transparent to suppress this style element and use the default
background color instead (white).
All colors on the C1XLBook are mapped to a palette. This means that if you assign colors to styles,
save the book, and then load it back, you probably won't get exactly the same colors used when the
book was created. You will get a fairly close approximation though.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
BackPattern Property
Syntax
Public Property BackPattern As XLPatternEnum
C#
public XLPatternEnum BackPattern {get; set;}
Requirements
492
See Also
Reference
XLStyle Class
XLStyle Members
BorderBottom Property
Syntax
Public Property BorderBottom As XLLineStyleEnum
C#
public XLLineStyleEnum BorderBottom {get; set;}
Remarks
Use the SetBorderStyle method to set all borders at once.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
BorderColorBottom Property
Gets or sets the color used to draw the bottom border.
Syntax
493

Public Property BorderColorBottom As System.Drawing.Color
C#
public System.Drawing.Color BorderColorBottom {get; set;}
Remarks
Use the SetBorderColor method to set all borders at once.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
BorderColorLeft Property
Syntax
Public Property BorderColorLeft As System.Drawing.Color
C#
public System.Drawing.Color BorderColorLeft {get; set;}
Remarks
Requirements
494
See Also
Reference
XLStyle Class
XLStyle Members
BorderColorRight Property
Syntax
Public Property BorderColorRight As System.Drawing.Color
C#
public System.Drawing.Color BorderColorRight {get; set;}
Remarks
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
BorderColorTop Property
Syntax
495

Public Property BorderColorTop As System.Drawing.Color
C#
public System.Drawing.Color BorderColorTop {get; set;}
Remarks
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
BorderLeft Property
Syntax
Public Property BorderLeft As XLLineStyleEnum
C#
public XLLineStyleEnum BorderLeft {get; set;}
Remarks
Requirements
496
See Also
Reference
XLStyle Class
XLStyle Members
BorderRight Property
Syntax
Public Property BorderRight As XLLineStyleEnum
C#
public XLLineStyleEnum BorderRight {get; set;}
Remarks
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
BorderTop Property
Syntax
497

Public Property BorderTop As XLLineStyleEnum
C#
public XLLineStyleEnum BorderTop {get; set;}
Remarks
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Diagonal Property
Syntax
Public Property Diagonal As XLDiagonalFlags
C#
public XLDiagonalFlags Diagonal {get; set;}
Requirements
498
See Also
Reference
XLStyle Class
XLStyle Members
DiagonalColor Property
Syntax
Public Property DiagonalColor As System.Drawing.Color
C#
public System.Drawing.Color DiagonalColor {get; set;}
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
DiagonalStyle Property
Syntax
Public Property DiagonalStyle As XLLineStyleEnum
C#
499
public XLLineStyleEnum DiagonalStyle {get; set;}
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Font Property
Syntax
Public Property Font As System.Drawing.Font
C#
public System.Drawing.Font Font {get; set;}
Remarks
Set the Font property to null in order to suppress this style element and use the default font
instead. The default font is determined by the book's DefaultFont property.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
500
ForeColor Property
Syntax
Public Property ForeColor As System.Drawing.Color
C#
public System.Drawing.Color ForeColor {get; set;}
Remarks
Set the ForeColor property to Color.Transparent to suppress this style element and use the default
foreground color instead (black).
All colors on the C1XLBook are mapped to a palette. This means that if you assign colors to styles,
save the book, and then load it back, you probably won't get exactly the same colors used when the
book was created. You will get a fairly close approximation though.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Format Property
Syntax
Public Property Format As System.String
501
C#
public System.string Format {get; set;}
Remarks
Excel uses formats similar, but not identical to .NET. Refer to the Excel documentation for details on
how to create format strings.
You can use the FormatXLToDotNet(String) and FormatDotNetToXL(String,CultureInfo) methods to
convert common Excel format strings to and from .NET format strings.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Indent Property
Syntax
Public Property Indent As System.Integer
C#
public System.int Indent {get; set;}
Remarks
This property should be set to values between 0 and 255 (between 0 and 15 for Excel 2003
compatible mode), indent calculate as value multiplied by the step (similar TAB value in the text) is
equal 2,5 points (180 twips).
502
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Locked Property
Gets or sets whether the cell should be locked for editing when the XLSheet is protected.
Syntax
C#
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
PatternColor Property
Syntax
503

Public Property PatternColor As System.Drawing.Color
C#
public System.Drawing.Color PatternColor {get; set;}
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
Rotation Property
Syntax
Public Property Rotation As System.Integer
C#
public System.int Rotation {get; set;}
Remarks
This property should be set to values between 0 and 180, or 255, as explained below:
Zero means no rotation.
1-90 means 1 to 90 degrees counter-clockwise (90 causes text to be displayed in the vertical
direction going up the cell).
91-180 means 1 to 90 degrees clockwise (180 causes text to be displayed in the vertical direction
going down the cell).
504
255 causes letters to be stacked top to bottom and not rotated.
Requirements
See Also
Reference
XLStyle Class
XLStyle Members
WordWrap Property
Syntax
Public Property WordWrap As System.Boolean
C#
public System.bool WordWrap {get; set;}
Remarks
Cells that do not wrap will spill onto adjacent cells and will be kept on a single line even if they
contain line-break characters.
Requirements
See Also
Reference
505
XLStyle Class
XLStyle Members
XLTextShape
Object Model
Syntax
Public MustInherit Class XLTextShape
Inherits XLShape
C#
public abstract class XLTextShape : XLShape
System.Object
C1.C1Excel.XLShape
Requirements
See Also
Reference
XLTextShape Members
Overview
506
Object Model
Syntax
Public MustInherit Class XLTextShape
Inherits XLShape
C#
public abstract class XLTextShape : XLShape
System.Object
C1.C1Excel.XLShape
Requirements
See Also
Reference
XLTextShape Members
Members
Properties Methods
The following tables list the members exposed by XLTextShape.
Public Properties
507
Name
Description
Bidirectional
BottomMargin
Gets or sets the bottom margin of this XLTextShape, in twips.
Column
C1.C1Excel.XLShape)
DashedLineStyle
HorizAlign
Gets or sets a horizontal alignment of the text in this XLTextShape.
Hyperlink
C1.C1Excel.XLShape)
Id
IsEmpty
Determines whether the shape is empty. (Inherited from C1.C1Excel.XLShape)
LeftMargin
Gets or sets the left margin area of this XLTextShape, in twips.
LineColor
C1.C1Excel.XLShape)
LineStyle
C1.C1Excel.XLShape)
LineWidth
Locked
Gets or sets a locked of this XLTextShape.
Orientation
Gets or sets a orientation of this XLTextShape.
508
Rectangle
C1.C1Excel.XLShape)
RightMargin
Gets or sets the right margin of this XLTextShape, in twips.
Rotation

C1.C1Excel.XLShape)
Row
C1.C1Excel.XLShape)
Sheet

C1.C1Excel.XLShape)
Text
TextId
Gets or sets a text identifier of this XLTextShape.
TextScale
Gets or sets a text scale of this XLTextShape.
TextToFit
Gets or sets a fit to shape of the text flag of this XLTextShape.
TopMargin
Gets or sets the top margin of this XLTextShape, in twips.
VertAlign
Gets or sets a vertical alignment of the text in this XLTextShape.
Workbook

C1.C1Excel.XLShape)
Wrapped
Gets or sets a wrapped text of this XLTextShape.
Top
Public Methods
Name
Description
509
Clone()

Top
See Also
Reference
XLTextShape Class
Properties
For a list of all members of this type, see XLTextShape members.
Public Properties
Name
Description
Bidirectional
BottomMargin
Column
C1.C1Excel.XLShape)
DashedLineStyle
HorizAlign
Hyperlink
C1.C1Excel.XLShape)
Id
IsEmpty
Determines whether the shape is empty. (Inherited from C1.C1Excel.XLShape)
510
LeftMargin
LineColor
C1.C1Excel.XLShape)
LineStyle
C1.C1Excel.XLShape)
LineWidth
Locked
Orientation
Rectangle
C1.C1Excel.XLShape)
RightMargin
Rotation

C1.C1Excel.XLShape)
Row
C1.C1Excel.XLShape)
Sheet

C1.C1Excel.XLShape)
Text
TextId
TextScale
511
TextToFit
TopMargin
VertAlign
Workbook

C1.C1Excel.XLShape)
Wrapped
Top
See Also
Reference
XLTextShape Class
Bidirectional Property
Syntax
Public Property Bidirectional As System.Integer
C#
public System.int Bidirectional {get; set;}
Requirements
See Also
Reference
512
XLTextShape Class
XLTextShape Members
BottomMargin Property
Syntax
Public Property BottomMargin As System.Integer
C#
public System.int BottomMargin {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
HorizAlign Property
Syntax
Public Property HorizAlign As XLHorizTextAlign
C#
public XLHorizTextAlign HorizAlign {get; set;}
Requirements
513
See Also
Reference
XLTextShape Class
XLTextShape Members
LeftMargin Property
Syntax
Public Property LeftMargin As System.Integer
C#
public System.int LeftMargin {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
Locked Property
Syntax
514

C#
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
Orientation Property
Syntax
Public Property Orientation As XLTextOrientation
C#
public XLTextOrientation Orientation {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
515
RightMargin Property
Syntax
Public Property RightMargin As System.Integer
C#
public System.int RightMargin {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
Text Property
Syntax
Public Property Text As System.String
C#
public System.string Text {get; set;}
Requirements
516
See Also
Reference
XLTextShape Class
XLTextShape Members
TextId Property
Syntax
Public Property TextId As System.Integer
C#
public System.int TextId {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
TextScale Property
Syntax
Public Property TextScale As System.Single
C#
517
public System.float TextScale {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
TextToFit Property
Syntax
Public Property TextToFit As System.Boolean
C#
public System.bool TextToFit {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
TopMargin Property
Syntax
518

Public Property TopMargin As System.Integer
C#
public System.int TopMargin {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
VertAlign Property
Syntax
Public Property VertAlign As XLVertTextAlign
C#
public XLVertTextAlign VertAlign {get; set;}
Requirements
See Also
Reference
519
XLTextShape Class
XLTextShape Members
Wrapped Property
Syntax
Public Property Wrapped As System.Boolean
C#
public System.bool Wrapped {get; set;}
Requirements
See Also
Reference
XLTextShape Class
XLTextShape Members
Enumerations
CalculationMode
Specifies calculation mode for all formulas in the workbook.
Syntax
Public Enum CalculationMode
Inherits System.Enum
C#
public enum CalculationMode : System.Enum
520
Members
Member
Description
Auto
Automatic calculation mode for all formulas in the workbook.
AutoNoTable
Automatic no table calculation mode for all formulas in the workbook.
Manual
Manual calculation mode for all formulas in the workbook (F9 in MS Excel).
System.Object
System.ValueType
System.Enum
C1.C1Excel.CalculationMode
Requirements
See Also
Reference
CompatibilityMode
Specifies limits to sheet size that correspond to specific versions of Microsoft Excel.
Syntax
Public Enum CompatibilityMode
C#
521
public enum CompatibilityMode : System.Enum
Members
Member
Description
Excel2003
Sheets may have up to 65,536 rows and 256 columns. Workbooks may have up
to 4050 unique cell styles.
Excel2007
Sheets may have up to 1,048,576 rows and 18,278 columns. Workbooks may
have up to 65,536 unique cell styles.
Workbooks that exceed the Excel2003 limits must be saved in OpenXml format
instead of XLS.
It may not be possible to open these workbooks with versions earlier than Excel
2007 (C1Excel will still open them correctly).
NoLimits
No size limits are enforced.

It may not be possible to open these workbooks with any version of Excel
(C1Excel will still open them correctly).
System.Object
System.ValueType
System.Enum
C1.C1Excel.CompatibilityMode
Requirements
See Also
Reference
522
ConsolidationFunction
Specifies consolidation function for sheet subtotals.
Syntax
Public Enum ConsolidationFunction
C#
public enum ConsolidationFunction : System.Enum
Members
Member
Description
Average
Represents Average function.
Count
Represents Count function.
CountNums
Represents Count Numbers function.
Max
Represents Max function.
Min
Represents Min function.
Product
Represents Product function.
StdDev
Represents StdDev function.
StdDevp
Represents StdDevp function.
Sum
Represents Sum function.
Var
Represents Var function.
523
Varp
Represents Varp function.
System.Object
System.ValueType
System.Enum
C1.C1Excel.ConsolidationFunction
Requirements
See Also
Reference
FileFormat
Specifies the file format to use when loading or saving workbooks.
Syntax
Public Enum FileFormat
C#
public enum FileFormat : System.Enum
Members
Member
Description
Biff8
Excel 97/2003 format (Binary Interchange File Format revision 8).
524
Csv
Simple Comma-separated values (CSV) format.
OpaqueBiff8
Excel 97/2003 format (Binary Interchange File Format revision 8) without

parsing opaque table.
OpenXml
Office 2007/2010 format. (Compressed Xml format).
OpenXmlTemplate Office 2007/2010 template format. (Compressed Xml format).
System.Object
System.ValueType
System.Enum
C1.C1Excel.FileFormat
Requirements
See Also
Reference
ImageScaling
Specifies how images are scaled within spreadsheet cells.
Syntax
Public Enum ImageScaling
C#
public enum ImageScaling : System.Enum
525
Members
Member
Description
Clip
Images are clipped to fit within the cell.
None
Images are rendered in their original size, regardless of cell size.
Scale
Images are scaled to fill the cell while preserving their original aspect ratio.
Stretch
Images are stretched to fill the cell.
System.Object
System.ValueType
System.Enum
C1.C1Excel.ImageScaling
Requirements
See Also
Reference
XLAlignHorzEnum
Specifies how to align cell content horizontally within a cell.
Syntax
Public Enum XLAlignHorzEnum
526
C#
public enum XLAlignHorzEnum : System.Enum
Members
Member
Description
Center
Align to cell center.
Fill
Fill cell, repeating content as necessary.
General
Align strings to the left, numbers to the right.
Justify
Justify content horizontally to span the whole cell width.
Left
Align to cell left.
Right
Align to cell right.
Selection
Align to selection center (may span multiple cells).
Undefined
Not specified (use default).
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLAlignHorzEnum
Requirements
See Also
Reference
527
XLAlignVertEnum
Specifies how to align cell content vertically within a cell.
Syntax
Public Enum XLAlignVertEnum
C#
public enum XLAlignVertEnum : System.Enum
Members
Member
Description
Bottom
Align to cell bottom.
Center
Align to cell center.
Justify
Justify content vertically to span the whole cell height.
Top
Align to cell top.
Undefined
Not specified (use default).
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLAlignVertEnum
Requirements
528
See Also
Reference
XLDiagonalFlags
Specifies the type of diagonal line to draw across the cells.
Syntax
<System.FlagsAttribute()>
Public Enum XLDiagonalFlags
C#
[System.FlagsAttribute()]
public enum XLDiagonalFlags : System.Enum
Members
Member
Description
Backward
Backward diagonal (/).
Forward
Forward diagonal (\).
None
No diagonal.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLDiagonalFlags
529
Requirements
See Also
Reference
XLHorizTextAlign
Specifies horizontal text alignment.
Syntax
Public Enum XLHorizTextAlign
C#
public enum XLHorizTextAlign : System.Enum
Members
Member
Description
Center
Text is centered.
Justify
Text is justified.
Left
Text is left aligned.
Right
Text is right aligned.
System.Object
System.ValueType
530
System.Enum
C1.C1Excel.XLHorizTextAlign
Requirements
See Also
Reference
XLLineStyleEnum
Specifies the line style used for the cell borders.
Syntax
Public Enum XLLineStyleEnum
C#
public enum XLLineStyleEnum : System.Enum
Members
Member
Description
Dashed
Dashed.
Dotted
Dotted.
Double
Double.
Hair
Hair (one pixel).
531
Medium
Medium.
MediumDashDotDotted
Medium dash-dot-dot.
MediumDashDotted
Medium dash-dot.
MediumDashed
Medium dashed.
None
No line.
SlantedMediumDashDotted Slanted dash-dot.

Thick
Thick.
Thin
Thin.
ThinDashDotDotted
Thin dash-dot-dot.
ThinDashDotted
Thin dash-dot.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLLineStyleEnum
Requirements
See Also
Reference
532
XLPatternEnum
Specifies the pattern used to fill the cell background.
Syntax
Public Enum XLPatternEnum
C#
public enum XLPatternEnum : System.Enum
Members
Member
Description
DiagonalCrosshatch
Diagonal crosshatch pattern.
DiagonalStripe
Diagonal stripe pattern (/).
Gray06
6% dotted pattern.
Gray12
12% dotted pattern.
Gray25
25% dotted pattern.
Gray50
50% dotted pattern.
Gray75
75% dotted pattern.
HorizontalStripe
Horizontal stripe pattern.
None
No pattern (transparent).
ReverseDiagonalStripe
Reverse diagonal stripe pattern (\).
533
Solid
Solid background.
ThickDiagonalCrosshatch
Thick diagonal crosshatch pattern.
ThinDiagonalCrosshatch
Thin diagonal crosshatch pattern.
ThinDiagonalStripe
Thin diagonal stripe pattern (/).
ThinHorizontalCrosshatch
Thin horizontal crosshatch pattern.
ThinHorizontalStripe
Thin horizontal stripe pattern.
ThinReverseDiagonalStripe Thin reverse diagonal stripe pattern (\).

ThinVerticalStripe
Thin vertical stripe pattern.
VerticalStripe
Vertical stripe pattern.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLPatternEnum
Requirements
See Also
Reference
XLPictureViewType
Specifies how images should be displayed (color, grayscale, or black and white).
534
Syntax
Public Enum XLPictureViewType
C#
public enum XLPictureViewType : System.Enum
Members
Member
Description
Auto
Display the image using the image's own color information.
BlackAndWhite
Display the image in black and white.
GrayScale
Display the image in grayscale.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLPictureViewType
Requirements
See Also
Reference
XLRangeType
The range type.
535
Syntax
Public Enum XLRangeType
C#
public enum XLRangeType : System.Enum
Members
Member
Description
Default
Default range.
Formula
Formula range.
Indirect
Indirect range.
Name
Named range.
Offset
Offset range.
Text
Text range.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLRangeType
Requirements
536
See Also
Reference
XLReferenceMode
The reference mode.
Syntax
Public Enum XLReferenceMode
C#
public enum XLReferenceMode : System.Enum
Members
Member
Description
A1
A1 style, default by spreadsheet.
R1C1
R1C1 style, default by formulas.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLReferenceMode
Requirements
See Also
537
Reference
XLReferenceType
The reference type.
Syntax
Public Enum XLReferenceType
C#
public enum XLReferenceType : System.Enum
Members
Member
Description
Absolute
Absolute coordinates.
Relative
Relative coordinates.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLReferenceType
Requirements
See Also
Reference
538
XLShapeDashedLineStyleEnum
Specifies the dash style of borders drawn around XLShape objects.
Syntax
Public Enum XLShapeDashedLineStyleEnum
C#
public enum XLShapeDashedLineStyleEnum : System.Enum
Members
Member
Description
Dash
Dash style, analogue PS_DASH pen of system.
DashDot
Dash-dot style, analogue PS_DASHDOT pen of system.
DashDotDot
Dash-dot-dot style, analogue PS_DASHDOTDOT pen of system.
Dot
Dot style, analogue PS_DOT pen of system.
LongDash
Long dash style.
LongDashDot
Long dash-dot style.
LongDashDotDot Long dash-dot-dot style.

ShortDash
Short dash style.
ShortDashDot
Short dash-dot style.
Solid
Solid (continuous) pen.
539
SquareDot
Square dot style.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLShapeDashedLineStyleEnum
Requirements
See Also
Reference
XLShapeLineStyleEnum
Specifies the style of borders drawn around XLShape objects.
Syntax
Public Enum XLShapeLineStyleEnum
C#
public enum XLShapeLineStyleEnum : System.Enum
Members
Member
Description
Double
Double lines of equal width.
540
Simple
Single line (of width LineWidth).
ThickThin
Double lines, one thick, one thin.
ThinThick
Double lines, reverse order.
Triple
Three lines, thin, thick, thin.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLShapeLineStyleEnum
Requirements
See Also
Reference
XLTextOrientation
Specifies text orientation.
Syntax
Public Enum XLTextOrientation
C#
public enum XLTextOrientation : System.Enum
Members
541
Member
Description
Default
Default (horizontal) orientation.
LeftRotation
Text is rotated 90 degrees counterclockwise.
RightRotation
Text is rotated 90 degrees clockwise.
TopToBottom
Vertical text (top to bottom).
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLTextOrientation
Requirements
See Also
Reference
XLVertTextAlign
Specifies vertical text alignment.
Syntax
Public Enum XLVertTextAlign
C#
542
public enum XLVertTextAlign : System.Enum
Members
Member
Description
Bottom
Text is bottom aligned.
Center
Text is centered vertically.
Justify
Text is justified vertically.
Top
Text is top aligned.
System.Object
System.ValueType
System.Enum
C1.C1Excel.XLVertTextAlign
Requirements
See Also
Reference
C1.Win.Localization Namespace
Overview
See Also
Reference
543
544

Manual Excel Componentone

Uploaded by

Copyright:

Available Formats

Manual Excel Componentone

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Manual Excel Componentone

Uploaded by

Copyright:

Available Formats

ComponentOne

Excel for .NET

Copyright 1987-2013 GrapeCity, Inc. All rights reserved.

This manual was produced using ComponentOne Doc-To-Help.

Excel for .NET Samples ...................................................................................................................... 47

ComponentOne Excel for .NET Overview

Help with ComponentOne Studio for WinForms

Migrating an Excel for .NET Project to Visual Studio 2005

To convert the project:

Open Visual Studio 2005 and select File, Open Project.

To update the .licx file:

The migration process is complete.

Excel for .NET Limitations

There is no support for the PivotTable declaration.

Save or load a workbook with one command

Read and write data in individual cells

Format the data in each cell.

Use Excel for .NET to export to XLS files

Create and position images within a cell

Save and load files to and from streams

Add images to the header and footer of a sheet

Excel for .NET QuickStart

Step 1 of 4: Setting up the Project

Step 1 of 4: Setting up the Project

Step 2 of 4: Adding Content to a C1XLBook

' Add content to the sheet.

// Add content to the sheet.

Step 3 of 4: Formatting the Content

style1.Font = New Font("Tahoma", 9, FontStyle.Bold)

sheet(i, 0).Style = style1

for (i = 0; i <= 9; i++)

Step 4 of 4: Saving and Opening the XLS File

Run the program and observe:

Formatted content is added to the workbook.

Using Excel for .NET

' step 1: create a new workbook

// step 1: create a new workbook

' step 1: create a new workbook

styleEven.Font = New Font("Tahoma", 9, FontStyle.Bold)

// step 1: create a new workbook

= new Font("Tahoma", 9, FontStyle.Italic);

= new Font("Tahoma", 9, FontStyle.Bold);

// step 4: save the file

Dim sheet As XLSheet = C1XLBook1.Sheets(0)

Dim row As XLRow = sheet.Rows(1000)

XLSheet sheet = c1XLBook1.Sheets[0];

Rows and Columns

Dim cell As XLCell = sheet(10, 10)

XLCell cell = sheet[10,10];

Excel for .NET Frequently Asked Questions

private void Form1_Load(object sender, EventArgs e)

// <-- result of the formula

Can Excel for .NET be used on an ASP.NET 2.0 page?

Excel for .NET Task-Based Help

Adding an Image to a Cell

Adding Content to a Workbook

Double-click the C1XLBook component in the Toolbox to add it to your form.

Dim sheet As XLSheet = C1XLBook1.Sheets(0)

XLSheet sheet = c1XLBook1.Sheets[0];

Save and open the book: