Xceed.Workbooks.NET
Offers the base properties for a range.
Interface exposing the properties and methods of a read-only Alignment object.
Interface exposing the properties and methods of a read-only Border object.
Interface exposing the properties and methods of a read-only Fill object.
Interface exposing the properties and methods of a read-only Font object.
Interface exposing the properties and methods of a read-only Protection object.
Interface exposing the properties and methods of a read-only Style object.
Represents the available properties of a read-only ThemeColor object.
Contains, in their read-only version, the actions that can be carried out on a Workbook
when it is protected.
Contains, in their read-only version, the actions that can be carried out on a Worksheet
when it is protected.
Clears specific elements in the range.
Sets the options that determine which elements are cleared from the range. The default setting isAll.
Searches into the content of the range and replaces all occurences of a specific value with a new value.
The total number of instances of the searchValue that were replaced within the content of the range.
The value that will be searched for.
The value that will replace all found instances of the searchValue.
Searches into the content of the range and replaces all instances of the SearchValues with their corresponding NewValues.
Returns how many instances of the searchValues were replaced within the content of the range.
The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Gets the number of items in the range.
Gets the items in the range.
Gets or sets the last item in the range.
Gets or sets the first item in the range.
Returns a copy of the Alignment object.
Gets the horizontal alignment.
Gets if the text content of a Cell is wrapped or not.
Gets the vertical alignment.
Returns a copy of the Border object.
Gets the Border's Color.
Gets the Border's Style.
Gets the Border's ThemeColor.
Returns a copy of the Fill object.
Gets the Fill object's BackgroundColor.
Gets the Fill object's BackgroundThemeColor.
Gets the Fill object's PatternColor.
Gets the Fill object's PatternStyle.
Gets the Fill object's PatternThemeColor.
Returns a copy of the Font object.
Gets if the Font object is bold or not.
Gets the Color of the Font object.
Gets if the Font object is in italic.
Gets the name of the Font object.
Gets the size of the Font object.
Gets if the Font object is strikethrough.
Gets if the Font object is displayed as subscript.
Gets if the Font object is displayed as superscript.
Gets the Font object's ThemeColor.
Gets if the Font object is underlined.
Gets the type of underline used on the Font object.
Clones a Protection object.
The cloned Protection object.
Gets if the content of the Cell or the formula are displayed in the formula bar or not.
Gets if the Cell is locked or not.
Returns a copy of the Style object.
Gets the Alignment object of the Style object.
Gets the collection of active Borders from a Style.
Gets the BuiltinStyleType.
Gets the format of the Style object.
Gets the Fill object of the Style object.
Gets the Font object of the Style object.
Gets the predefined format Id of the Style object. This Id will be a number between 0 and 49.
Gets the Protection object associated with the Style.
Gets the ThemeColor's type.
Gets if the following actions are allowed when a Workbook is protected: adding, removing,
inserting, moving, copying, deleting and renaming Worksheets.
Gets if resizing the Workbook's window is allowed when the Workbook is protected.
Gets if deleting Columns is allowed when the Worksheet is protected.
Gets if deleting Rows is allowed when the Worksheet is protected.
Gets if editing objects like Pictures, Notes or Comments is allowed when
the Worksheet is protected.
Gets if modifying the formatting of Cells is allowed when the Worksheet is protected.
Gets if modifying the formatting of Columns is allowed when the Worksheet is protected.
Gets if modifying the formatting of Rows is allowed when the Worksheet is protected.
Gets if inserting Columns is allowed when the Worksheet is protected.
Gets if inserting Hyperlinks is allowed when the Worksheet is protected.
Gets if inserting Rows is allowed when the Worksheet is protected.
Gets if selecting locked Cells is allowed when the Worksheet is protected.
Gets if selecting unlocked Cells is allowed when the Worksheet is protected.
Gets if using AutoFilter is allowed when the Worksheet is protected.
Determines how a Picture is anchored in a Worksheet.
This anchor uses the AnchorPosition (with different values for StartingElement and EndingElement) and Edit properties to determine the position of the Picture in the Worksheet. The
TopLeftOffsets and BottomRightOffsets properties can also be used to nudge the image using either
its top left or bottom right corners as a reference point.
This anchor uses the AnchorPosition (with the same StartingElement and EndingElement), Height and Width
properties to determine the position of the Picture in the Worksheet. The TopLeftOffsets property can also be used to nudge the image using its top left corner
as a reference point.
This anchor uses the AbsolutePosition, Height and Width
properties to determine the position of the Picture in the Worksheet.
Determines the Annotation's type.
The Annotation is a Note.
The Annotation is a Comment.
Defines the Border's type.
Border will be on top
Border will be at the bottom
Border will be at the left
Border will be at the right
Borders will be at the top and at the bottom of the Cells in a range
Borders will be at the left and at the right of the Cells in a range
Borders will be from the top left to the bottom right
Borders will be from the bottom left to the top right
Determines which kind of page break will be inserted.
Inserts a row break.
Inserts a column break.
Represents the different types of built-in CellStyles offered by MS Excel.
(Sorry, no preview is available for this one!)
(Sorry, no preview is available for this one!)
Contains the options that determine what will be cleared when one of the Clear methods is used on a Row, Column, Worksheet or Range.
This options will clear the content as well as the Formulas.
This option will clear only the Styles.
This option will clear the Hyperlinks but the rest of the content will remain in place.
This option will clear only the Annotations.
This option will clear everything, meaning all the content, the Formulas, the Styles, the Hyperlinks and the
Annotations.
Determines if the Cell or CellRange is cut or copied.
The Cell or CellRange will
be copied; in other words, it will stay in place once pasted.
The Cell or CellRange will
be cut; in other words, it will be removed once pasted.
Determines the type of comparison that the DataValidation process will use.
To be valid, the data entered by the user must be between the MinValue &
MaxValue.
To be valid, the data entered by the user must not be between the MinValue
& the MaxValue.
To be valid, the data entered by the user must be equal to the Value.
To be valid, the data entered by the user must not be the same as the Value.
To be valid, the data entered by the user must be greater than the Value.
To be valid, the data entered by the user must be less than the Value.
To be valid, the data entered by the user must be greater than or equal to the Value.
To be valid, the data entered by the user must be less than or equal to the Value.
Determines the type of data entered in a Cell.
The data is an int, a double, a byte, a float or any of the other number types.
The data is of the boolean type.
The data is of the DateTime type.
The value is of the TimeSpan type.
The data is a string, an enum, a char or a guid.
The data is an error.
The data is a formula.
Represents the different types of built-in error alerts offered by MS Excel.
A Stop alert message prevents users from entering invalid data in a Cell.
It offers two options: Retry or Cancel.
Warns users that the data they entered is invalid, without preventing them from entering it. The users can click Yes to accept the invalid entry,
No to edit the invalid entry or Cancel to remove the invalid entry.
Informs users that the data they entered is invalid, without preventing them from entering it. The users can click Ok to accept the invalid value or
Cancel to reject it.
Determines how Cells are shifted after a CellRange is deleted.
The Cells that are located after the deleted CellRange are shifted to the left.
The Cells that are located after the deleted CellRange are shifted up.
Represents the possible values for a pattern style when a Fill object is used to fill a
Cell, Row, Column or range.
No pattern is applied
A solid fill pattern
A 75% gray fill pattern.
A 50% gray fill pattern.
A 25% gray fill pattern.
A 12.5% gray fill pattern.
A 6.25% gray fill pattern.
A fill pattern that uses horizontal stripes
A fill pattern that uses vertical stripes
A fill pattern that uses left diagonal stripes
A fill pattern that uses right diagonal stripes
A fill pattern that uses cross diagonal stripes
A fill pattern that uses cross diagonal thick stripes
A fill pattern that uses thin horizontal stripes
A fill pattern that uses thin vertical stripes
A fill pattern that uses left diagonal thin stripes
A fill pattern that uses right diagonal thin stripes
A fill pattern that uses thin horizontal and vertical stripes
A fill pattern using cross diagonal thin stripes
Specifies the types of horizontal alignments possible for a cell.
The default alignment. Texts will be aligned to the left, Numbers/Dates/Times will be aligned to right and Boolean will be aligned to the center of the cell.
The content will be aligned to the left of the cell.
The content will be aligned to the center of the cell.
The content will be aligned to the right of the cell.
The content will be duplicated to fill the cell?s width.
The content will be centered within the selection (which is a cell, for now).
The text will be aligned with the left and right sides of a cell simultaneously, except for the last line, which will be aligned to the left side only.
The text will be centered but will also be aligned with the left and right side of the cell when possible.
Defines the hyperlink's type.
The hyperlink refers to an email address.
The hyperlink refers to a cell in the current worksheet or from another worksheet of the workbook.
The hyperlink refers to an external document.
The hyperlink refers to a website.
Determines how Cells are shifted after inserting a CellRange.
The Cells that are located after the inserted CellRange are shifted to the right.
The Cells that are located after the inserted CellRange are shifted down.
Defines the style of a Border.
No lines
Line composed of small dots
Line composed of dots
Line composed of dash-dot-dots
Line composed of dash-dots
Line composed of dashes
Full thin line
Medium line composed of dash-dot-dots
Line composed of diagonal dash-dots
Medium line composed of dash-dots
Medium line composed of dashes
Full medium line
Full thick line
Full double line
Allows to set the Margins using pre-set values.
Sets the Top & BottomMargins at 0.75"
& the Left & RightMargins at 0.25".
Sets the Top & BottomMargins at 0.75"
& the Left & RightMargins at 0.7".
Sets the Top, Bottom, Left &
RightMargins at 1".
Represents the number of MarginPresets that are available; currently, a total of 3 MarginPresets are available.
Defines how a page is laid out.
The page will be laid out vertically, similar to a standard portrait painting.
The page will be laid out horizontally, similar to a standard landscape portrait.
Defines the dimensions of a page.
The dimensions will be 8 1/2" x 11".
The dimensions will be 8 1/2" x 11".
The dimensions will be 11" x 17".
The dimensions will be 17" x 11".
The dimensions will be 8 1/2" x 14".
The dimensions will be 5 1/2" x 8 1/2".
The dimensions will be 7 1/2" x 10 1/2".
The dimensions will be 297 x 420 mm.
The dimensions will be 210 x 297 mm.
The dimensions will be 210 x 297 mm.
The dimensions will be 148 x 210 mm.
The dimensions will be 250 x 354 mm.
The dimensions will be 148 x 210 mm.
The dimensions will be 8 1/2" x 13".
The dimensions will be 215 x 275 mm.
The dimensions will be 10" x 14".
The dimensions will be 11" x 17".
The dimensions will be 8 1/2" x 11".
The dimensions will be 3 7/8" x 8 7/8".
The dimensions will be 4 1/8" x 9 1/2".
The dimensions will be 4 1/2" x 10 3/8".
The dimensions will be 4 1/2" x 11".
The dimensions will be 5" x 11 1/2".
The dimensions will be the equivalent of a C size sheet.
The dimensions will be the equivalent of a D size sheet.
The dimensions will be the equivalent of an E size sheet.
The dimensions will be 110 mm x 220 mm.
The dimensions wil be 162 x 229 mm.
The dimensions will be 324 x 458 mm.
The dimensions will be 229 x 324 mm.
The dimensions will be 114 mm x 162 mm.
The dimensions will be 114 mm x 229 mm.
The dimensions will be 250 x 353 mm.
The dimensions will be 176 x 250 mm.
The dimensions will be 176 x 125 mm.
The dimensions will be 110 mm x 230 mm.
The dimensions will be 3 7/8" x 7 1/2".
The dimensions will be 3 5/8" x 6 1/2".
The dimensions will be 14 7/8" x 11".
The dimensions will be 8 1/2" x 13".
The dimensions will be 8 1/2" x 13".
Determines what kind of data will be pasted into the new location.
Specifies that no mathematical operation will be applied to the pasted data.
Pastes the formula results found in the original Cell or CellRange, without any formatting or comments.
Pastes only the formulas found in the original Cell or CellRange, without any formatting or comments.
Pastes only the formatting of the original Cell or CellRange.
Pastes only the data validation rules found in the original Cell or CellRange.
Pastes & reorients the content of the original Cell or CellRange; this means that the data in Rows will be pasted into Columns &
vice versa.
Pastes all of the Cell or CellRange's content, as well as how it is formatted.
Represents the available picture format.
Specifies the built-in style used on a Table. The available styles are the same as the ones
found in MS Excel.
No Style is applied to the Table.
Creates a custom Style.
The name of this Style is specified via the StyleName property in the Table class.
Determines how the text will flow.
Automatically determines the flow of the text.
Text will flow from left to right.
Text will flow from right to left.
The available types for the ThemeColor class.
The ThemeColor that corresponds to the Text/Background - Dark 1 Color in MS
Excel.
The ThemeColor that corresponds to the Text/Background - Light 1 Color in MS
Excel.
The ThemeColor that corresponds to the Text/Background - Dark 2 Color in MS
Excel.
The ThemeColor that corresponds to the Text/Background - Light 2 Color in MS
Excel.
The ThemeColor that corresponds to the Accent 1 Color in MS Excel.
The ThemeColor that corresponds to the Accent 2 Color in MS Excel.
The ThemeColor that corresponds to the Accent 3 Color in MS Excel.
The ThemeColor that corresponds to the Accent 4 Color in MS Excel.
The ThemeColor that corresponds to the Accent 5 Color in MS Excel.
The ThemeColor that corresponds to the Accent 6 Color in MS Excel.
The ThemeColor that corresponds to the Hyperlink Color in MS Excel.
The ThemeColor that corresponds to the FollowedHyperlink Color in MS Excel.
This enum can be used to set the TableColumn.TotalRowFunction property. It will be used to apply a built-in formula in a TableColumn?s total row.
0
101
102
103
104
105
107
109
110
Affects the behavior of a TwoCellAnchorPicture when adding and deleting Rows
and Columns.
When inserting or deleting Rows or Columns, the Picture can move but
its size will stay the same.
When inserting or deleting Rows or Columns, the Picture can move and
change size.
When inserting or deleting Rows or Columns, the Picture will not move
or change size.
Defines which type of underline is used.
1 single line
2 lines
1 single line extending through the parent cell.
2 lines extending through the parent cell.
Determines what type of units are used for measurements.
Inches
Centimeters
Millimeters
Points
English measure units
Defines which type of DataValidation is accepted.
Accepts any value.
Accepts only whole numbers.
Accepts only decimal numbers.
Allows to pick data from a drop-down list.
Accepts only a date.
Accepts only a time-related value.
Restricts the length of the text.
Uses a custom formula.
Specifies the types of vertical alignments possible for a cell.
The content will be aligned to the bottom of the cell.
The content will be aligned to the center of the cell.
The content will be aligned to the top of the cell.
The text will be aligned with the top and bottom sides of the cell.
The text will be centered as well as aligned with the top and bottom sides of the cell.
Determines which View mode is used by a SheetView.
The SheetView uses the Normal View mode, which is the standard mode for viewing
Excel documents.
The SheetView uses the Page Break Preview mode, which displays where the page
breaks will appear if the document is printed.
The SheetView uses the Page Layout mode, which displays how the document will
look once it is printed.
Determines how the Worksheet is displayed.
The Worksheet is visible.
This is the default value.
The Worksheet is not visible but it can be displayed by using the user interface (UI).
The Worksheet is not visible and cannot be displayed in the user interface (UI).
This state is only available programmatically.
An alignment represents the horizontal and vertical alignment used to align the content of a Cell. Alignment is available through these properties: Cell.Style, Row.Style or Column.Style.
Base class that contains the basic components for Notes & Comments.
Represents a collection of all the Notes and ThreadCommentCollections in the Worksheet.
An AutoFilter represents the object controlling the filtering process in a Table. It offers
properties to display the filtering buttons and customize the filtering process on TableColumns.
Defines the content of a specific border.
Defines the collection of Borders for a Style.
A cell represents a rectangle in a Worksheet. Each cell is the intersection of a Row and a Column. It can be accessed
by using an address (a combination of a letter and a number, like A1, B2, C3?, where the letter is the Column Id and the number is the Row
Id) or by coordinates (by specifying the Row Id first & then the Column Id, for example, 0,0; 2,3; 5;5...). Note that indexes for rows & columns always start
at 0.
Represents a collection of Cell.
Offers some static functions for converting data.
Represents a rectangular range of Cells. The top-left and bottom-right Cells delimit the range.
Contains many methods that will help convert Colors between Color, int, string and ThemeColor.
Represents a column in a Worksheet.
This collection represents the collection of Cell for a specific column.
Represents a collection of Column in a worksheet.
Defines a ColumnRange, which is a range of consecutives Columns. It derives from LinearRange.
This class represents a single Comment in a ThreadCommentCollection.
Specifies the properties of the import options for a CSV document or stream when importing data in a Worksheet through the Worksheet.ImportData method.
Specifies the properties of the import options for DataTables when importing data in a Worksheet through the Worksheet.ImportData method.
Represents the data validation process used to validate the content of a Cell.
The collection of DataValidations found in the Worksheet.
Gets or sets an error message.
Represents the message that the user will see when entering data in a Cell.
This class is used to enable or disable the selection and printing of the elements within the worksheet when it is protected.
This class represents a builder used to build ranges in a Worksheet.
Contains the properties related to filling a Cell, Row, Column or range with a Color and
a pattern.
The Font object representing the possible properties that a font can have.
Represents a text that is formatted in a specific way.
Represents a list of FormattedText objects.
Encapsulates the object that represents an hyperlink.
Represents a collection of Hyperlinks in a Worksheet.
Specifies the import options' properties when importing data in a Worksheet through the
Worksheet.ImportData method.
Represents the class used to register all classes defined in the Xceed.Workbooks.NET assembly.
Abstract class defining a LinearRange, which is a range of consecutives WorksheetElements.
Contains the common elements for the Column and Row classes.
Represents the Worksheet's margins.
Represents a collection of all the Cells that need to be merged.
Represents a Note, which is made of multiple blocks of FormattedText that are added one after the other.
Contains the Protection properties of a Note.
Defines the options related to the Worksheet's page & printing layouts.
Represents the person who interacted with an object that requires identification.
This class represents a picture element in the PictureCollection of the Worksheet.
This class will contain all the pictures in the worksheet. It will also allow the user to add new pictures and manipulate them.
Allows the user to remove the authorization to modify certain properties of the picture in MS Excel. All values are false by default.
Manages the values of properties that are unit dependent, like AbsoluteAnchor,
TopLeftOffsets and BottomRightOffsets.
Represents the possible properties of a Protection.
Contains the base data for a Protection.
Contains the base data for a range.
Represents a row in a Worksheet.
This collection represents the collection of Cell for a specific row.
Represents a collection of Row in a worksheet.
Defines a range of consecutives Rows.
A single sheet view from a Worksheet. Currently, only one SheetView per Worksheet is supported.
Represents the style that is used to display either a Cell, Cells from a Column or
Cells from a Row.
A generic base class for styled objects like Style, Fill, Font and Alignment.
Contains the base data for a range.
Abstract class that contains a Style property for worksheet elements.
A Table represents a range of cells in a Worksheet. To be considered a Table, these
cells should be independent from the other cells in the Worksheet and grouped to form a
rectangular arrangement of rows and columns. Built-in styles can be used to unify these grouped cells visually.
The Table?s header row can display filtering options for each column. A total row can also be added. Each cell of this row will display a formula
calculation based on the data in that column (SUM, AVERAGE, COUNT?).
Represents a collection of Table in a Worksheet.
Represents a column from a Table in a Worksheet.
Represents a collection of TableColumn in a Table.
Contains the properties and methods of a Theme object.
Represents a Theme's Color.
Contains a collection of the various threads of Comments that can be found in the Worksheet.
Specifies the properties of the import options for user objects when importing data in a Worksheet through the Worksheet.ImportData method.
Represents the root document containing the Worksheet(s).
This is the base class for all single elements in a Workbook.
Represents the Protection used on a Workbook.
Gets the ThemeColor associated with the Workbook's Theme.
The collection of ThemeColors associated to the current Theme used by the Workbook.
Each WorkbookView opens a new window when the document is opened. This allows the user to focus on an important element of the document by displaying it in a
different window.
Represents a single worksheet from a Workbook.
Represents a collection of Worksheet in a Workbook.
This is the base class for all single elements in a Worksheet.
Contains the actions that can be carried out on a Worksheet when it is protected.
Corresponds to a group of continuous Worksheets in a WorksheetCollection.
Determines whether the specified System.Object is equal to the current System.Object.
Returns true if the specified System.Object is equal to the current System.Object; returns false otherwise.
The object that will be compared with the current object.
Serves as the default hash function.Serves as a hash function for a particular type.
A hash code for the current object.
Gets or sets the alignment used to align the content of a cell horizontally.
Gets or sets the indentation for the content of the Cell.
Gets or sets if the text is shrunk to fit within the Cell or not.
Gets or sets if the text content of a Cell is wrapped or not.
Gets or sets the rotation angle. The rotation can be up to 90 degrees upward ( 90 ) or downward ( -90 ). The default value is 0.
Keeps the text flowing in the specified direction.
Gets or sets the alignment used to align the content of a cell vertically.
Returns the AnnotationType.
Object that represents the person who wrote the Note or the Comment.
Represents the Cell in which the Note or the Comment is inserted.
Indicates if the Annotation is visible or not when the Workbook is opened. The default value is false.
Adds a Comment in the current Worksheet.
Adds a Note in the current Worksheet.
Removes an Annotation (Note or Comment) from the AnnotationCollection.
Adds a Comment in the current Worksheet, using the Address of a Cell to determine
the insertion point.
The text that will be displayed in the Comment.
The Address of the Cell
in which the Comment will be inserted.
Adds a Comment in the current Worksheet, using a Row Id and a
Column Id to determine the insertion point.
The text that will be displayed in the Comment.
The Id of the Row in which the Comment will be inserted.
The Id of the Column in which the Comment will be inserted.
Adds a Note in the current Worksheet, using a Row Id and a
Column Id to determine the insertion point.
The block of FormattedText that will be displayed in the Note.
The Id of the Row in which the Note will be inserted.
The Id of the Column in which the Note will be inserted.
Adds the Name of the Person who created the Note.
Adds a Note in the current Worksheet, using the Address of a Cell to determine
the insertion point.
The block of FormattedText that will be displayed in the Note.
The Address of the Cell
in which the Note will be inserted.
Adds the Name of the Person who created the Note.
Adds a Note in the current Worksheet, using a Row Id and a
Column Id to determine the insertion point.
The FormattedTextList that will be displayed in the Note.
The Id of the Row in which the Note will be inserted.
The Id of the Column in which the Note will be inserted.
Adds the Name of the Person who created the Note.
Adds a Note in the current Worksheet, using the Address of a Cell to determine
the insertion point.
The FormattedTextList that will be displayed in the Note.
The Address of the Cell
in which the Note will be inserted.
Adds the Name of the Person who created the Note.
Removes a chosen Annotation (Note or Comment) from the AnnotationCollection.
The Annotation that will be removed.
Removes an Annotation (Note or Comment) from the AnnotationCollection by using a Row Id and a Column Id to locate it.
The Id of the Row in which the Annotation that will be removed was initially inserted.
The Id of the Column in which the Annotation that will be removed was initially inserted.
Removes an Annotation (Note or Comment) from the AnnotationCollection by using the Address of a Cell to locate it.
The Address of the Cell
in which the Annotation that will be removed was initially inserted.
Gets the ThreadCommentCollection associated with the current Worksheet.
Returns the number of Annotations in the Worksheet.
Gets a specific Annotation.
Gets an Annotation by using a Row Id & a Column Id.
The Id of the Row to which the Annotation is attached.
The Id of the Column to which the Annotation is attached.
Gets an Annotation by using a CellAddress.
The Address of the Cell
to which the Annotation is attached.
Gets the range of cells, in a Table, where the filtering will be applied.
Gets or sets if the filtering buttons will be displayed in the header cells of a Table. The
default value is true.
Determines whether the specified System.Object is equal to the current System.Object.
Returns true if the specified System.Object is equal to the current System.Object; returns false otherwise.
The object that will be compared with the current object.
Serves as the default hash function.Serves as a hash function for a particular type.
A hash code for the current object.
Gets or sets the Color of the Border. The default value is null.
Gets or sets the style of the Border. The default value is None.
Gets or sets the ThemeColor of the Border. The default value is null.
Determines whether the specified System.Object is equal to the current System.Object.
Returns true if the specified System.Object is equal to the current System.Object; returns false otherwise.
The object that will be compared with the current object.
Serves as the default hash function.Serves as a hash function for a particular type.
A hash code for the current object.
Sets the DiagonalUp and DiagonalDown borders using the same lineStyle and color.
The style that will be used for the two Borders.
The color that will be used for the two Borders. The default value is null,
resulting in a black color.
Sets the Horizontal and VerticalBorders using
the same lineStyle and color. This is useful in CellRanges, ColumnRanges and RowRanges
to automatically set the Left, Right, Top and
BottomBorders
inside the range based on the position of the Cell, Column or Row position in the range
and the BorderType that is used.
The style used for the Horizontal & VerticalBorders.
The color used for the Horizontal & VerticalBorders. The
default value is null, resulting in a black color.
Sets the Left, Right, Top and
BottomBorders
using the same lineStyle and color.
The style that will be used for the four Borders.
The color that will be used for the four Borders. The default value is null,
resulting in a black color.
Sets the DiagonalUp and DiagonalDownBorders using the same lineStyle and themeColor.
The style that will be used for the two Borders.
The theme color that will be used for the two Borders. The default value is null,
which sets the color to black.
Sets the Horizontal and VerticalBorders using
the same lineStyle and themeColor. This is useful for CellRanges, ColumnRanges or RowRanges as
it allows to automatically set the Left, Right, Top and
BottomBorders
inside the range based on the position of the Cell, Column or Row in the range and the
type of border that is used.
The style that will be used for the Horizontal & VerticalBorders.
The theme color that will be used for the Horizontal & VerticalBorders. The
default value is null, which sets the borders to black.
Sets the Left, Right, Top and
BottomBorders
using the same lineStyle and themeColor.
The style that will be used for the four Borders.
The theme color that will be used for the four Borders. The default value is null,
which sets the borders to black.
Gets or sets a specific Border in the BorderCollection.
Defines the border's type.
Starts the calculation process in order to get a value from the Cell's formula.
Copies or cuts a Cell & pastes it into another Cell.
Where the data will be pasted; this can be either an Address (ie. "D14") or a RowID followed by a ColumnID (ie. 4, 5).
The PasteOptions; in other words, this determines what will be pasted into the new
Cell.
The CopyOptions; in other words, this determines if the Cell will be copied or cut.
Formats a specific section of the text with a selected Font.
The Font that will be used to format the text.
The 0 based index that determines the starting point of the formatting.
The length of the formatted section of text.
If this value is 0, all of the text that follows the startingIndex will be formatted.
Gets the result of the DataValidation process.
Gets the address of this Cell, which is composed of a letter (for the Column) and a number (for the Row).
The first Column starts at ?A? and first Row starts at ?1?; this means that the top left Cell is located at the ?A1? address.
Gets the Id of the column associated to this cell, the first column starting at Id 0. The maximum numbers of column allowed for a worksheet is 16384.
Gets the DataType in the Cell. The default type is Number.
Gets or sets the Cell's DataValidation.
Gets or sets the formula used for this cell. A formula always starts with the equal sign (?=?) and uses comma (?,?) as parameter separators. Example:
?=SUM(A1, A2, A4)?. A formula can include constant (?=A1 + 5*4%?), references (?=A1*A3?), ranges of references (?=SUM(A1:A3, B1:B3)?) or functions
(?=SUM(A1:A3) + AVERAGE(B1:B3)?). Note that each functions have their own characteristics and that you should refer to their specific pages for more
information.
The formula will be calculated once the workbook is opened with MS Excel and the Value property will be updated once the workbook is saved with MS Excel.
The formula can also be calculated by using Worksheet.CalculateFormulas() since this call will automatically set the Value property. The default value is null.
Gets the Id of the row associated to this cell, the first row starting at Id 0. The maximum number of rows allowed for a worksheet is 1048576.
Gets or sets the value for this Cell. Currently, the valid value types can be numerics ( int,
double, float, byte, decimal, short, long, sbyte, ushort, uint, ulong), string, DateTime, TimeSpan or bool. The default value is null.
Gets the number of cells from the CellCollection.
Gets the Cell element that is located at the specified Row Id and Column Id.
The Id of the Row where the Cell
is located.
The Id of the Column where the Cell is located.
Returns a collection of Cells in a CellRange format.
The Row Id that corresponds to the topmost part of the range.
The Column Id that corresponds to the leftmost part of the range.
The Row Id that corresponds to the bottommost part of the range.
The Column Id that corresponds to the rightmost part of the range.
Gets the Cell element that is located at the specified address.
Returns a collection of Cells in the CellRange format.
The Address of the Cell
that is located at the top left of the range.
The Address of the Cell
that is located at the bottom right of the range.
Converts letters into a numerical value.
The number corresponding to the chosen letters.
The letter or letters that will be converted.
This must correspond to one or more letters used by MS Excel to identify a Column.
Converts a number into one or more letters.
The letter or letters that correspond to the chosen number.
The number that will be converted.
This number must be equal to or greater than 0.
Clears specific elements in the range.Clears specific elements in the CellRange.
Sets the options that determine which elements are cleared from the range. The default setting isAll.All.
Copies a CellRange & pastes it to another location.
Cuts a CellRange & pastes it to another location.
Serves as the default hash function.
A hash code for the current object.
Gets a list of Cells that have failed the DataValidation process.
Adds the CellRange in the MergedCellCollection.
Centers the text horizontally and vertically. The default value is true.
Splits the merge per Row; for example, "A1 : B2" will be merged as "A1: B1" and "A2 : B2". The
default value is false.
Searches into the content of the range and replaces all occurences of a specific value with a new value.Searches into the content of the CellRange and replaces all occurences of a specific value
with a new value.
The total number of instances of the searchValue that were replaced within the content of the range.The total number of instances of the searchValue that were replaced within the content of the CellRange.
The value that will be searched for.The value that will be searched for.
The value that will replace all found instances of the searchValue.The value that will replace all found instances of the searchValue.
Searches into the content of the StyledRange and replaces all instances of the
SearchValues with their corresponding NewValues.SearchValuesNewValues
Returns how many instances of the searchValues were replaced within the content of the StyledRange.searchValues
The values that will be searched for.The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said
data with the corresponding newValues.
Returns a string that represents the current object.Returns the starting element and the ending element addresses in the following format ( "SE : EE " ).
A string that represents the current object.
Removes all the element in the CellRange from the MergedCellCollection.
Copies the CellRange from its current location and pastes it to a new
location, using the Address of a Cell to determine where the data will be pasted.
The Address of the Cell
used as the target location for pasting the copied CellRange.
The PasteOptions; in other words, what type of data will be pasted into the new
location.
The Worksheet in which the data will be pasted; by default, this is set to null,
which means that the data will be pasted into the current Worksheet.
The CopyOptions; by default, this is set to Copy.
Copies the CellRange from its current location and pastes it to a new
location, using a RowID & a ColumnID to determine where the data will be pasted.
The RowID used to determine where the CellRange will be pasted.
The ColumnID used to determine where the CellRange will be pasted.
The PasteOptions; in other words, what type of data will be pasted into the new
location.
The Worksheet in which the data will be pasted; by default, this is set to null,
which means that the data will be pasted in the current Worksheet.
The CopyOptions; by default, this is set to Copy.
Removes the CellRange from its current location and pastes it to a new
location, using the Address of a Cell to determine where the data will be pasted.
The Address of the Cell
used as the target location for pasting the CellRange.
The PasteOptions; in other words, what type of data will be pasted into the new
location.
The Worksheet in which the data will be pasted; by default, this is set to null,
which means that the data will be pasted into the current Worksheet.
Removes the CellRange from its current location and pastes it to a new
location, using a RowID & a ColumnID to determine where the data will be pasted.
The RowID that will be used to determine the location where the CellRange will be pasted.
The ColumnID used to determine the location where the CellRange will be pasted.
The PasteOptions; in other words, what type of data will be pasted into the new
location.
The Worksheet in which the data will be pasted; by default, this is set to null,
which means that the data will be pasted into the current Worksheet.
Gets the number of items in the range.Returns the number of cells within the cell range.
Sets the Cell Range's DataValidation.
Returns the Color associated with a specific index in the Indexed Color palette.
The index associated with a specific Color. This should be a number between 0 and 63.
Converts to an int, which represents an ARGB Color.
Converts to a Color.
Converts to an HTML string that represents a Color.
Returns the index associated with a specific Color in the Indexed Color palette.
The name of the Color, for example Red or Ice Blue.
Converts a ThemeColor into an int.
The int that represents the converted ThemeColor.
The Workbook that contains the ThemeColor to convert.
The ThemeColor to convert.
Converts a Color into an int.
The int that represents the converted Color.
The Color to convert.
Converts 3 int values into an int.
The int that represents the converted Color.
The int that represents the red part of the Color.
The int that represents the green part of the Color.
The int that represents the blue part of the Color.
Converts 4 int values into an int.
The int that represents the converted Color.
The int that represents the alpha part of the Color.
The int that represents the red part of the Color.
The int that represents the green part of the Color.
The int that represents the blue part of the Color.
Converts an HTML string Color into an int.
The int that represents the converted Color.
The string that represents the hex Color. For example: "#FFF000".
Converts a Workbook's ThemeColor into a Color.
The converted Color.
The Workbook that contains the ThemeColor to convert.
The ThemeColor to convert.
Converts an int Color into a Color.
The converted Color.
The int that represents the ARGB Color.
Converts 3 int values into a Color.
The converted Color.
The int that represents the red part of the Color.
The int that represents the green part of the Color.
The int that represents the blue part of the Color.
Converts 4 int values into a Color.
The converted Color.
The int that represents the alpha part of the Color.
The int that represents the red part of the Color.
The int that represents the green part of the Color.
The int that represents the blue part of the Color.
Converts an HTML string Color into a Color.
The converted Color.
The string that represents the hex Color. For example: "#FFF000".
Converts a ThemeColor into an HTML string.
The HTML string that represents the converted ThemeColor.
The Workbook that contains the ThemeColor to convert.
The ThemeColor to convert.
Converts an int Color into an HTML string.
The HTML string that represents the converted Color.
The int that represents the ARGB Color to convert.
Converts a Color into an HTML string.
The HTML string that represents the converted Color.
The Color to convert.
Converts 3 int values into an HTML string.
The HTML string that represents the converted Color.
The int that represents the red part of the Color.
The int that represents the green part of the Color.
The int that represents the blue part of the Color.
Converts 4 int values into an HTML string.
The HTML string that represents the converted Color.
The int that represents the alpha part of the Color.
The int that represents the red part of the Color.
The int that represents the green part of the Color.
The int that represents the blue part of the Color.
Base method declaration for auto-fitting the Height of a Row or the Width of a Column.Adjusts the column width based on the cell with the widest content.
The minimum desired width when autoFitting a column. The default value is 0.
The maximum desired width when autofitting a column. The default value is 255.
The Id for the row from where to start calculating the cells content width in the specified column. The default value is 0 (the first row Id in a column).
The Id for the row from where to stop calculating the cells content width in the specified column. The default value is 1048575 (the last row Id in a column).
Gets or sets if the width of the column will be adjusted to the largest cell value content from the column. The default setting is false.
Gets the collection of Cell from the current column. Only the modified cells will be returned.
Gets the index of the Column and returns it as a letter.
Gets or sets the width of the column.
Gets the number of cells from the ColumnCellCollection.
Gets the Cell element at the specified row Id.
The Id for the row where the Cell is located.
Adjusts the columns? width based on the cell with the widest content within the ColumnRange.
The minimum desired width when autoFitting a column. The default value is 0.
The maximum desired width when autofitting a column. The default value is 255.
The Id for the row from where to start calculating the cells content width in the specified column. The default value is 0 (the first row Id in a column).
The Id for the row from where to end calculating the cells content width in the column. The default value is 1048575 (the last row Id in a column).
Gets the number of Column from the ColumnCollection.
Gets the Column element at the specified column Id. The first column starts at 0 and the last
column is located at 16383.
Gets a ColumnRange that starts at the column with the Id startColumnId and ends at the
column with the Id endColumnId. For example ?var columnRange = worksheet.Columns[1, 3];? will get a range from column 1 to 3.
Gets the Column element at the specified column address. The first column is located at ?A?.
Gets a ColumnRange that starts at the column with the Id startColumnId and ends at the
column with the Id endColumnId. For example, ?var columnRange = worksheet.Columns["B", "D"];? will get a range from column "B" to "D".
Base method for auto-fitting the Height of a RowRange or the Width
of a ColumnRange.Adjusts the columns? width based on the cell with the widest content in the ColumnRange.
The minimum desired width when autoFitting a column. The default value is 0.
The maximum desired width when autofitting a column. The default value is 255.
The Id for the row from where to start calculating the cells content width in the specified column. The default value is 0 (the first row Id in a column).
The Id for the row from where to end calculating the cells content width in the specified column. The default value is 1048575 (the last row Id in a column).
Gets or sets the Width of all Columns in the range. Getting this property will return the common Width of all the Columns in
the range; if at least one Column has a different Width than the others, 0 will be returned.
Inserts a new Comment at the end of the ThreadCommentCollection.
Corresponds to the text that will be displayed in the new Comment.
Returns the AnnotationType.
Returns the time at which the Comment was first written in the Workbook.
Gets or sets the text that is displayed in the Comment.
Gets or sets the separator used to split the CSV data. The default value is ",".
Gets or sets the DataTable?s ColumnNames. These will be displayed in the Worksheet after
importing the data. When set to null, which is the default setting, all the ColumnNames will be displayed.
Gets or sets if the DataTable?s ColumnNames will be shown or not.
The default value is false.
Creates a new DataValidation.
The ValidationType.
The DataComparisonType.
Serves as the default hash function.
A hash code for the current object.
Sets an error message.
The error message's title.
The error message's text.
The DataValidationErrorStyle.
When set to true, the error message will be displayed when the user enters invalid data.
Sets the message that will be displayed when the user selects or hovers over the target Cell(s).
The message's title.
The message's text.
When set to true, the target Cell(s) will display the message.
Sets where the DataValidation process should validate data.
The Address of the Cell
or CellRange where data should be validated.
Sets a range of values accepted by the DataValidation.
The MinValue, or minimum value, accepted by the DataValidation process.
The MaxValue, or maximum value, accepted by the DataValidation process.
Sets the Value that will be accepted by the DataValidation.
The Value that will serve as a reference for the DataValidation process.
Determines whether the specified object is equal to the current object.
if the specified object is equal to the current object; otherwise, .
The object to compare with the current object.
Gets the DataComparisonType.
Gets or sets if the DataValidation ignores blank Cells.
Gets or sets if the Cell contains a drop-down menu offering choices that can be used for
DataValidation.
Gets or sets a maximum value for the DataValidation.
Gets or sets a minimum value for the DataValidation.
Gets the ExcelRangeBuilder.
Gets the ValidationType.
Gets or sets a value for the DataValidation.
Adds a DataValidation to the Worksheet's DataValidationCollection.
The DataValidation that will be added to the DataValidationCollection.
Empties the DataValidationCollection by removing all DataValidations in the Worksheet.
Gets all Cells that failed the DataValidation process in the current Worksheet.
The list of Cells that have failed the validation. Returns null if all Cells are valid.
Removes a specific DataValidation from the DataValidationCollection.
The DataValidation that will be removed.
Removes all DataValidations found in a particular range.
The range that will be targeted by the removal process.
Gets a DataValidation by using an index to locate it.
The DataValidation's index.
Serves as the default hash function.
A hash code for the current object.
Determines whether the specified object is equal to the current object.
if the specified object is equal to the current object; otherwise, .
The object to compare with the current object.
Gets or sets the DataValidationErrorStyle.
Serves as the default hash function.
A hash code for the current object.
Determines whether the specified object is equal to the current object.
if the specified object is equal to the current object; otherwise, .
The object to compare with the current object.
Gets or sets if the input message is displayed when the user selects or hovers over the target Cell(s).
Gets or sets the input message's text.
Gets or sets the input message's title.
Allows the user to enable the selection of drawing elements (Picture, Chart, Shape) when the
Worksheet is protected. The default value is true.
The user can enable or disable the printing of the elements with the worksheet when the sheet is protected. By default, the element will not be printed with
the worksheet.
Looks at the Worksheet & extracts a list of Addresses where DataValidation is used.
Gets where DataValidation is used to validate data entry.
Adds a location where data will be validated by the DataValidation process.
The Address or CellRange where DataValidation should be applied.
Creates an empty Fill object.
Determines whether the specified System.Object is equal to the current System.Object.
Returns true if the specified System.Object is equal to the current System.Object; returns false otherwise.
The object that will be compared with the current object.
Serves as the default hash function.Serves as a hash function for a particular type.
A hash code for the current object.
Gets/sets the Color used for filling the background of a Cell, Row, Column or range. The default
value is null.
Gets/sets the ThemeColor used for filling the background of a Cell, Row, Column or range. The default value is null.
Gets/sets the Color of the pattern used for filling a Cell, Row, Column or range. This will be
based on the PatternStyle property. The default setting is null.
Gets/sets the Style of the pattern used for filling a Cell, Row, Column or range. These will be filled based on the PatternColor property. The default setting is FillPattern.None.
Gets/sets the ThemeColor of the pattern used for filling a Cell, Row, Column or range. The Cell, Row, Column or range are filled based
on the PatternStyle property. The default setting is null.
Determines whether the specified System.Object is equal to the current System.Object.
Returns true if the specified System.Object is equal to the current System.Object; returns false otherwise.
The object that will be compared with the current object.
Serves as the default hash function.Serves as a hash function for a particular type.
A hash code for the current object.
Gets or sets if the Font has bold content. The default is false.
Gets or sets the Color for the Font. The default is null.
Gets or sets if the Font has Italic content. The default is false.
Gets or sets the name of the Font. The font must be installed for the system to recognize it
(ex: "Arial", "Times New Roman", "Broadway"...). The default font is "Calibri".
Gets or sets the size of the Font. The values are in points and must be between 1 and 409; they
are rounded to the nearest 0.5. The default value is 11.
Gets or sets if the Font is single strikethrough.The default is false.
Gets or sets if the Font is subscript. When set to true, the font will be smaller and
lower in the cell. The default setting is false.
Gets or sets if the Font is superscript. When set to true, the font will be smaller
and higher in the cell. The default setting is false.
Gets or sets the ThemeColor for the Font. The default setting is null.
Gets or sets if the Font has underline content. The default is false.
Gets or sets the type for the underline content. The Underline property must be set
to true in order to use this property. The default is Single.
Serves as the default hash function.
A hash code for the current object.
Gets or sets the style of the FormattedText. The style is made of elements like the
Name of the Font, its
Size and its Color.
Gets or sets the text content of the FormattedText.
Formats a specific section of the text with a selected Font.
The Font that will be used to format the text.
The 0 based index that determines the starting point of the formatting.
The length of the formatted section of text.
If this value is 0, all of the text that follows the startingIndex will be formatted.
Serves as the default hash function.
A hash code for the current object.
Creates a Hyperlink that can be used with the ReplaceContent method.
The address that corresponds to the Hyperlink's destination.
This can be the Address of a Cell, an external document, a website or an email address.
This property stores the range of cells where the hyperlink is applied.
This property stores the destination address of the hyperlink.
This property stores the text that should be displayed if the existing text is to be replaced. The default value will be the destinationAddress if no value is provided when the item is created.
This property stores the text that will be displayed when the user mouses over the hyperlink?s cells range.
This property returns the hyperlink's type (Internal, External, Email).
Adds a new Hyperlink in the designated Worksheet.
Removes a Hyperlink from the HyperlinkCollection.
Removes a Hyperlink from the HyperlinkCollection by using an index to locate it.
The index that corresponds to the Hyperlink that will be removed from the HyperlinkCollection.
Adds a new Hyperlink based on a string representing the Address of a Cell.
The address that corresponds to the Hyperlink's destination. This can be the Address of a Cell, an external
document, a website or an email address.
The Address of the Cell
where the Hyperlink will be located.
Specifies on how many vertical Cells the Hyperlink will be active. The default is 1.
Specifies on how many horizontal Cells the Hyperlink will be active. The default is 1.
The Cell?s text, if it is different from the existing one. The default value is null.
The tooltip text that will be displayed on mouse over.
Adds a new Hyperlink based on a Row and a Column Id.
The address that corresponds to the Hyperlink's destination. This can be the Address of a Cell, an external
document, a website or an email address.
The Id of the Row where the Hyperlink's location starts.
The Id of the Column where the Hyperlink's location starts.
Specifies on how many vertical Cells the Hyperlink is active. The default value is 1.
Specifies on how many horizontal Cells the Hyperlink is active. The default value is 1.
The Cell?s text, if it is different from the existing one. The default value is null.
The tooltip text that will be displayed on mouse over.
Adds a new Hyperlink based on 2 string CellAddresses.
The address that corresponds to the Hyperlink's destination. This can be the Address of a Cell, an external
document, a website or an email address.
The Address of the Cell
that corresponds to the top left corner of the Hyperlink's active range.
The Address of the Cell
that corresponds to the bottom right of the Hyperlink's active range.
The Cell?s text, if it is different from the existing one. The default value is null.
The tooltip text that will be displayed on mouse over.
Removes the chosen Hyperlink from the HyperlinkCollection.
The Hyperlink that will be removed.
Removes a Hyperlink from the HyperlinkCollection by using an Address to identify its location.
The Address that corresponds to the top left Cell of the area where the Hyperlink is located.
Removes a Hyperlink from the HyperlinkCollection by using Ids to identify its location.
The RowId that corresponds to the topmost Row of the area where the Hyperlink
is located.
The ColumnId that corresponds to the leftmost Column of the area where the Hyperlink is located.
Returns the number of hyperlinks in this collection.
Returns the designated hyperlink.
Gets or sets the Id of the Column where the first data item will be imported. Column Ids start at 0, which is the default value.
Gets or sets the Id of the Row where the first data item will be imported. Row Ids start at 0, which is the default value.
Gets or sets the address of the Cell where the first data item will be imported. The default
value is A1.
Gets or sets if a linear data (like a List<string>, Array<int>, MyProduct[], ...) will be imported and whether it will be displayed vertically or
horizontally in the Worksheet. The default value is true, which means that the
data will be displayed vertically.
Gets or sets the license key used to license this product.
Base method for auto-fitting the Height of a RowRange or the Width
of a ColumnRange.
The minimum value of a Height or Width.
The maximum value of a Height or Width.
The Id of the Row or Column
where the autofit starts from.
The Id of the Row or Column
where the autofit ends.
Clears specific elements in the range.Clears specific elements in the LinearRange.
Sets the options that determine which elements are cleared from the range. The default setting isAll.All
Serves as the default hash function.
A hash code for the current object.
Searches into the content of the range and replaces all occurences of a specific value with a new value.Searches into the content of the range and replaces all occurences of a specific value with a new value.
The total number of instances of the searchValue that were replaced within the content of the range.The total number of instances of the searchValue that were replaced within the content of the range.
The value that will be searched for.The value that will be searched for.
The value that will replace all found instances of the searchValue.The value that will replace all found instances of the searchValue.
Searches into the content of the StyledRange and replaces all instances of the
SearchValues with their corresponding NewValues.SearchValuesNewValues
Returns how many instances of the searchValues were replaced within the content of the StyledRange.searchValues
The values that will be searched for.The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Returns a string that represents the current object.
A string that represents the current object.
Gets the number of items in the range.Gets the number of items in the target range.
Gets or sets if the Rows or Columns in the RowRange or
ColumnRange are hidden are not. The default value is false.
Base method declaration for auto-fitting the Height of a Row or the Width of a Column.
The minimum value of a Height or Width.
The maximum value of a Height or Width.
The Id of the Row or Column
from where the autofit starts.
The Id of the Row or Column
where the autofit ends.
Clears specific elements in the LinearWorksheetElement.
Sets the options that determine which elements are cleared from the LinearWorksheetElement. The default setting is All.
Searches into the content of the LinearWorksheetElement and replaces all
occurences of a specific value with a new value.
The total number of instances of the searchValue that were replaced within the content of the LinearWorksheetElement.
The value that will be searched for.
The value that will replace all found instances of the searchValue.
Searches into the content of the LinearWorksheetElement and replaces all
instances of the SearchValues with their corresponding NewValues.
Returns how many instances of the searchValues were replaced within the content of the LinearWorksheetElement.
The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Gets the Id of a specific Column or Row in a Worksheet.
Gets or sets if the Row or Column is hidden or not. The default value is false.
Serves as the default hash function.
A hash code for the current object.
Sets all of the Worksheet's Margins at the same time.
The LeftMargin's
value.
The RightMargin's
value.
The TopMargin's
value.
The BottomMargin's
value.
The Header's value.
The Footer's value.
Sets which MarginPreset will be used.
The MarginPreset that will be used to set the Worksheet's Margins.
Determines whether the specified object is equal to the current object.
if the specified object is equal to the current object; otherwise, .
The object to compare with the current object.
Gets or sets the margin at the bottom of the Worksheet.
Gets or sets the height of the Footer area.
Gets or sets the height of the Header area.
Gets or sets the margin at the left of the Worksheet.
Gets or sets the margin at the right of the Worksheet.
Gets or sets the margin at the top of the Worksheet.
Adds a CellRange element in the MergedCellCollection.
Removes a CellRange from the MergedCellCollection.
The CellRange that will be removed.
Removes an element from the MergedCellCollection by using an index.
The index that corresponds to the element that will be removed from the collection.
Adds a CellRange element in the MergedCellCollection by providing Rows and Columns Ids.
Base 0 index that represents the topmost Row of the CellRange to add to the collection.
Base 0 index that represents the leftmost Column of the CellRange to add to the collection.
Base 0 index that represents the last Row of the CellRange to add to the collection.
Base 0 index that represents the rightmost Column of the CellRange to add to the collection.
Centers the text horizontally and vertically. The default value is true.
Splits the merge per Row. For example, "A1 : B2" will be merged as "A1: B1" and "A2 : B2". The
default value is false.
Adds a CellRange element in the MergedCellCollection by providing the addresses of the Cells that start and end the range.
Base 0 index that represents the top left element of the CellRange to add to the
collection.
Base 0 index that represents the bottom right element of the CellRange to add to the
collection.
Centers the text horizontally and vertically. The default value is true.
Splits the merge per Row. For example, "A1 : B2" will be merged as "A1: B1" and "A2 : B2". The
default value is false.
Returns the number of CellRange in the current collection.
Returns the CellRange object that represents all the Cells that will be merged at the index.
Represents the position of the object in the list.
Adds a new FormattedText object at the end of the Note's current FormattedTextList.
Returns the index that corresponds to the newly inserted FormattedText object.
Represents the FormattedText that will be added to the current Note.
Adds multiple FormattedText objects at the end of the Note's current FormattedTextList.
Returns the index that corresponds to the first FormattedText object that was just
inserted in the FormattedTextList.
Represents the FormattedText objects that will be added to the current Note.
Returns the AnnotationType.
Represents the Color used for the Note's background. The default value is null, which
uses the Note's default Color as the background Color.
Gets or sets the Note's height. The default value is 100.
Gets or sets if the Note uses AutoFit.
Returns a specific block of FormattedText contained in the Note.
The index corresponding to the location of the targeted block of FormattedText.
Represents the cumulative length of all the blocks of FormattedText in the current
Note.
Gets or sets the Unit used to define Width & Height. The
default value is Point.
Gets or sets the Note's Protection. The default setting automatically creates a protected Note if the associated Worksheet
is protected.
Represents the Note's HorizontalAlignement and VerticalAlignment. The default values are respectively Left and Top.
Gets or sets the Note's width. The default value is 100.
Gets or sets if the Note is locked. The default setting is true.
Gets or sets if the Note and the text that it contains are locked. The default value is
true.
Serves as the default hash function.
A hash code for the current object.
Inserts a page break at the left of a specific Column.
The index that corresponds to the target Column; the page break will be added to the left of
this Column.
Inserts a page break on top of a specific Row.
The index that corresponds to the target Row; the page break will be added on top of that
Row.
Inserts page breaks at a specific location in the Worksheet.
The index that corresponds to the target Row; a page break will be added on top of that Row.
The index that corresponds to the target Column; a page break will be added to the left of
this Column.
Inserts page breaks using a specific Cell as the target location for the insertion.
The Address of the Cell
that is used as a reference point for the insertion; two page breaks will be added, one on top of the Cell & one at the left of it.
Removes the page break at the left of a specific Column.
The index that corresponds to the target Column; the page break at the left of this Column will be removed.
Removes the page break that is located on top of a specific Row.
The index that corresponds to the target Row; the page break on top of that Row will be removed.
Removes the page breaks at a specific location in the Worksheet.
The index that corresponds to the target Row; the page break on top of that Row will be removed.
The index that corresponds to the target Column; the page break at the left of this Column will be removed.
Removes page breaks using a specific Cell as the target location for the removal.
The Address of the Cell
that is used as a reference point for the removal; both the page breaks on top & at the left of this Cell will be removed.
Resets all page breaks to their default state.
Determines whether the specified object is equal to the current object.
if the specified object is equal to the current object; otherwise, .
The object to compare with the current object.
Gets or sets if the Worksheet(s) will be printed in black & white or not.
Gets a list of indexes that correspond to all of the column breaks in the Worksheet.
Gets or sets whether the Worksheet(s) will be printed in draft quality or not.
Gets or sets how the content's height will be scaled when the Worksheet is printed.
Gets or sets how the content's width will be scaled when the Worksheet is printed.
Gets or sets if gridlines should be printed or not.
Gets or sets whether headings will be printed or not.
Gets or sets if the content will be centered horizontally when the Worksheet(s) is
printed.
Gets the Worksheet's Margins.
Gets or sets the page's orientation.
Gets or sets the page's size.
Gets a list of indexes that correspond to all of the row breaks in the Worksheet.
Gets or sets the percentage by which the Worksheet's content will be scaled before it is
printed.
Gets or sets if the content will be centered vertically when the Worksheet(s) is printed.
The name of the Person who wrote the object.
Gets/sets the absolute position of the Picture in the Worksheet.
Gets/sets the Anchor's position in the Worksheet. This position is determined by a StartingElement and an EndingElement, which sets a CellRange. For it to work, the CellRange must be located within the same Worksheet as the Picture.
Gets the Anchor's type. An Anchor can be either an AbsoluteAnchor, a OneCellAnchor or a TwoCellAnchor.
Offsets the bottom right corner of a TwoCellAnchorPicture.
This property contains the description of the picture.
Class property that contains the information of the ClientData, which is how the data should behave when the worksheet is protected.
Gets the file format of the uploaded media.
Gets/sets the height of an AbsoluteAnchor or OneCellAnchorPicture.
Gets/sets the unit used for measuring the Width and Height of the Picture.
Gets or sets the name of the Picture in the Worksheet.
Class property that contains the information of the PictureLocks, which are the
manipulations allowed on the picture.
Offsets the top right corner of a TwoCellAnchorPicture.
Gets or sets the behavior of the TwoCellAnchorPicture when moving or deleting Rows
or Columns. The defaut setting isMoveAndResize.
Gets/sets the width of an AbsoluteAnchor or OneCellAnchorPicture.
Adds a new picture by specifying the path and the file or by giving an ImageStream of the picture.
Removes a Picture from the PictureCollection.
Removes a Picture from the PictureCollection by using an index to locate it in the collection.
The index that corresponds to the Picture that will be removed.
Adds a picture in the worksheet using a filename.
The path for the image file that will be added.
The scale of the image.
The values start at 0 and represent a percentage. The default value is 100, which stands for 100%.
Adds a picture in the worksheet using a stream.
The stream for the image file that will be added.
The scale of the image.
The values start at 0 and represent a percentage. The default value is 100, which stands for 100%.
Adds a picture in the worksheet using a filename and a specific position corresponding to the top left corner of the picture.
The path for the image file that will be added.
The Id of the row where the top left corner of the picture will be located once it is inserted in the worksheet.
The Id of the column where the top left corner of the picture will be located once it is inserted in the worksheet.
The scale of the image.
The values start at 0 and represent a percentage. The default value is 100, which stands for 100%.
Adds a picture in the worksheet using a filename and a specific position corresponding to the top left corner of the picture.
The path for the image file that will be added.
The address of the cell where the top left corner of the picture will be located once it is inserted in the worksheet.
The scale of the image.
The values start at 0 and represent a percentage. The default value is 100, which stands for 100%.
Adds a picture in the worksheet using a stream and a specific position corresponding to the top left corner of the picture.
The stream for the image file that will be added.
The Id of the row where the top left corner of the picture will be located once it is inserted in the worksheet.
The Id of the column where the top left corner of the picture will be located once it is inserted in the worksheet.
The scale of the image.
The values start at 0 and represent a percentage. The default value is 100, which stands for 100%.
Adds a picture in the worksheet using a stream and a specific position corresponding to the top left corner of the picture.
The stream for the image file that will be added.
The address of the cell where the top left corner of the picture will be located once it is inserted in the worksheet.
The scale of the image.
The values start at 0 and represent a percentage. The default value is 100, which stands for 100%.
Adds a picture in the worksheet using a filename and two specific positions, corresponding respectively to the picture's top left and bottom right corner.
The path for the image file to be added.
The Id of the row where the top left corner of the picture will be located once it is inserted in the worksheet.
The Id of the column where the top left corner of the picture will be located once it is inserted in the worksheet.
The Id of the row to which the bottom right corner of the picture will extend once it is inserted in the worksheet.
The Id of the column to which the bottom right corner of the picture will extend once it is inserted in the worksheet.
Adds a picture in the worksheet using a filename and two specific positions, corresponding respectively to the picture's top left and bottom right corner.
The stream for the image file that will be added.
The Id of the row where the top left corner of the picture will be located once it is inserted in the worksheet.
The Id of the column where the top left corner of the picture will be located once it is inserted in the worksheet.
The Id of the row to which the bottom right corner of the picture will extend once it is inserted in the worksheet.
The Id of the column to which the bottom right corner of the picture will extend once it is inserted in the worksheet.
Adds a picture in the worksheet using a filename and two specific positions, corresponding respectively to the picture's top left and bottom right corner.
The path for the image file to be added.
The address of the cell where the top left corner of the picture will be located once it is inserted in the worksheet.
The address of the cell to which the bottom right corner of the picture will extend once it is inserted in the worksheet.
Adds a picture in the worksheet using a filename and two specific positions, corresponding respectively to the picture's top left and bottom right corner.
The stream for the image file that will be added.
The address of the cell where the top left corner of the picture will be located once it is inserted in the worksheet.
The address of the cell to which the bottom right corner of the picture will extend once it is inserted in the worksheet.
Removes a Picture from the PictureCollection by using its name.
The name of the Picture that will be removed.
Removes the chosen Picture from the PictureCollection.
The Picture that will be removed.
Returns the amount of Picture in the current worksheet.
Returns the Picture located at the specific index.
Removes the authorization to use the adjust handles when the value is set to true.
Removes the authorization to change Arrowheads when the value is set to true.
Removes the authorization to change the ratio when the value is set to true.
Removes the authorization to change the connection shape when the value is set to true.
Removes the authorization to crop the picture when the value is set to true.
Removes the authorization to edit the connection shape points when the value is set to true.
Removes the authorization to group shapes when the value is set to true.
Removes the authorization to move the picture when the value is set to true.
Removes the authorization to rotate the picture when the value is set to true.
Removes the authorization to select the picture when the value is set to true.
Represents the value of the horizontal (X) axis.
Represents the value of the vertical (Y) axis.
Represents the type of unit used for the given values. The default value is Inch.
Determines if negative values are accepted. The default value is false, so no negative numbers are allowed by default.
Represents the type of unit associated with the numbers input in the X and Y properties. The default value is Inch.
Represents the value of the horizontal axis. The default value is 0.
Represents the value of the vertical axis. The default value is 0.
Serves as the default hash function.
A hash code for the current object.
Gets or sets if the content of a Cell or the formula are displayed in the formula bar or not.
The default value is false.
Gets or sets if the Cell is locked or not. The default value is true.
Clears specific elements in the range.
Sets the options that determine which elements are cleared from the range. The default setting is All.
Searches into the content of the range and replaces all occurences of a specific value with a new value.
The total number of instances of the searchValue that were replaced within the content of the range.
The value that will be searched for.
The value that will replace all found instances of the searchValue.
Searches into the content of the RangeBase and replaces all instances of the
SearchValues with their corresponding NewValues.
Returns how many instances of the searchValues were replaced within the content of the RangeBase.
The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Gets the number of items in the range.
Gets the items in the range.
Gets or sets the last item in the range.
Gets or sets the first item in the range.
Base method declaration for auto-fitting the Height of a Row or the Width of a Column.CellRow
Base method declaration for auto-fitting the Height of a Row or the Width of a Column.Identifies the start and end of the AutoFit's range by using Ids.
The minimum desired Height when AutoFitting a Row. The default value is 0 point.
The maximum desired Height when AutoFitting a Row. The default value is 409 points.
The Id of the Column used as the starting point of the Autofit's range. The default is 0,
which is the first Column in a Row.
The Id of the Column used as the ending point of the Autofit's range. The default value is
16383, which is the last possible Column in a Row.
Identifies the start and end of the AutoFit's range by using string Ids.
The minimum desired Height when AutoFitting a Row. The default value is 0 point.
The maximum desired Height when AutoFitting a Row. The default value is 409 points.
The string Id of the Column used as the starting point of the Autofit's range. The default is
A, which is the first Column in a Row.
The string Id of the Column used as the ending point of the Autofit's range. The default
value is XFD, which is the last possible Column in a Row.
Gets the collection of Cell from the current Row. Only the modified Cells will be
returned.
Gets or sets the height of a specific Row.
Gets the number of cells from the RowCellCollection.
Gets the Cell element at the specified column Id. The first column starts at 0 and the last
column is located at 16383.
Gets the Cell element at the specified column address. The first column is located at ?A?.
Gets the number of Row from the RowCollection.
Gets the Row element at the specified row Id. The first row starts at 0 and the last row is
located at 1048575.
Gets a Row using an Id.
The Id of the Row that you want to get.
Gets a RowRange that starts at the Row associated with the startRowId and ends at the row associated with the endRowId. For example, ?var
rowRange = worksheet.Rows[1, 3];? will get a range from row 1 to 3.
The Id for the Row starting the range.
The Id for the Row ending the range.
Base method for auto-fitting the Height of a RowRange or the Width
of a ColumnRange.CellRowRange
Base method for auto-fitting the Height of a RowRange or the Width
of a ColumnRange.Identifies the start and end of the AutoFit's range by using Ids.
The minimum desired Height when AutoFitting a Row from a RowRange. The default
value is 0 point.
The maximum desired Height when AutoFitting a Row from a RowRange. The default
value is 409 points.
The Id of the Column used as the starting point of the Autofit's range. The default is 0,
which is the first Column in a Row.
The Id of the Column used as the ending point of the Autofit's range. The default value is
16383, which is the last possible Column in a Row.
Identifies the start and end of the AutoFit's range by using string Ids.
The minimum desired Height when AutoFitting a Row from a RowRange. The default
value is 0 point.
The maximum desired Height when AutoFitting a Row from a RowRange. The default
value is 409 points.
The string Id of the Column used as the starting point of the Autofit's range. The default is
A, which is the first Column in a Row.
The string Id of the Column used as the ending point of the Autofit's range. The default
value is XFD, which is the last possible Column in a Row.
Gets or sets the Height of all Rows in the range. Getting this property will return the common Height of all the Rows in the
range; if at least one Row has a different Height than the others, 0 will be returned.
Gets or sets the active Cell in the Worksheet, which is the one with focus. The address of the cell (?A2?, for example) is used to set
this property. Default is null.
Gets or sets the number of frozen Columns in the Worksheet. Frozen Columns are
always shown at the left of the SheetView when a user scrolls to the right.
Gets or sets the number of frozen Rows in the Worksheet. Frozen Rows are always
shown at the top of the SheetView when a user scrolls down.
Gets or sets the number of Columns after which a vertical split will appear in the Worksheet. Creating a split will divide the SheetView in two; afterwards, both sides of the split can be scrolled independently.
Gets or sets the number of Rows after which a horizontal split will appear in the Worksheet. Creating a split will divide the SheetView in two; afterwards, both sides of the split can be scrolled independently.
Gets or sets the Cell to be displayed as the top left position in the Worksheet view. The address of the cell (?A2?, for example) is used to set this property. The
default value is null.
Gets or sets the WorksheetViewType associated with the Worksheet. The default setting is Normal.
Gets or sets the Zoom level used when the Worksheet is displayed in Normal mode.
The values are percentages and must be between 10 and 400.
Gets or sets the Zoom level used when the Worksheet is displayed in PageBreakPreview mode.
The values are percentages and must be between 10 and 400.
Gets or sets the Zoom level used when the Worksheet is displayed in PageLayout mode.
The values are percentages and must be between 10 and 400.
Determines whether the specified System.Object is equal to the current System.Object.
Returns true if the specified System.Object is equal to the current System.Object; returns false otherwise.
The object that will be compared with the current object.
Serves as the default hash function.Serves as a hash function for a particular type.
A hash code for the current object.
Resets the Style of the Cell,
Row or Column back to its
default setting.
Gets or sets the horizontal and vertical alignments used to align the content of a cell. The default values are General for horizontal and Bottom for vertical.
Gets the collection of active Borders in a Style. Returns an empty collection by default.
Gets or sets the BuiltinStyleType. The default setting isNormal.
Gets or sets the format used to display the content of a Cell, the cells in a Column or the cells in a Row. The
default is null. Setting this property will overwrite the PredefinedNumberFormatId property. The formatting characters that can be used
are explained here : .
Gets or sets the Fill object used to fill the background of a Cell, Column, Row or range.
Gets or sets the Font to use for the current Style.
Gets or sets the predefined number format with an Id. Built-in common formatting options exist, like in MS Excel. A specific Id can be set to format the
content of a Cell, the Cells in a Column or the
Cells in a Row with
predefined formats. The default value is 0. Setting this property will overwrite the CustomFormat property.
Gets or sets the Protection object associated with this Style. The default value is null.
Clears specific elements in the range.
Sets the options that determine which elements are cleared from the range. The default setting isAll.
Searches into the content of the range and replaces all occurences of a specific value with a new value.
The total number of instances of the searchValue that were replaced within the content of the range.
The value that will be searched for.
The value that will replace all found instances of the searchValue.
Searches into the content of the StyledRange and replaces all instances of the
SearchValues with their corresponding NewValues.
Returns how many instances of the searchValues were replaced within the content of the StyledRange.
The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Gets the number of items in the range.
Gets the items in the range.
Gets or sets the last item in the range.
Gets or sets the first item in the range.
Gets the Style object for a worksheet element. The default value is a default style object.
Resizes the table with a new CellRange. The top of the table must remain in the same row,
the resulting table must contain at least one row of data and the resized table must overlap the original table.
The table?s first row Id.
The table?s first column Id.
The table?s last row Id.
The table?s last column Id.
Resizes the table with a new CellRange. The top of the table must remain in the same row,
the resulting table must contain at least one row of data and the resized table must overlap the original table.
The table?s top-left cell.
The table?s bottom-right cell.
Gets the Table?s AutoFilter. The AutoFilter contains the filtering options that will be used
for every column of that table.
Gets the range of cells that are part of the table. A CellRange contains the top-left and the bottom-right cells of a rectangular selection of cells.
Gets the collection of columns that are part of the Table. When a column has no header
content, ?Column1? will be used as the column header?s default content; the numbers will be incremented for the next columns without header content, thus
filing the second column without header content with ?Column2? and so forth.
Gets or sets the name of the Table. The default name is ?Table1?; the numbers will be
incremented for every table without a name, thus naming the second Table without a name
?Table2? & so forth. Custom names must start with a letter or an underscore (_), contain only letters or numbers and contain between one and 255
characters. Also note that two tables in the Workbook can not have the same name.
Gets or sets if banded columns are displayed. When set to true, the even columns are formatted differently from the odd columns, which can make the table
easier to read. The default setting is false.
Gets or sets if banded rows are displayed. When set to true, the even rows are formatted differently from the odd rows, which can make the table easier to
read. The default setting is false.
Gets or sets if the table?s first column is displayed using special formatting. The default setting is false.
Gets or sets if the table?s header row is displayed or not. When it is displayed, the table?s first row uses unique formatting to set it apart from the other
rows. The default setting is true.
Gets or sets if the table?s last column is displayed using special formatting. The default setting is false.
Gets or sets if the table?s total row is displayed or not. The total row is the row at the end of the table; it displays totals for each column. When set to
true, the table?s CellRange will grow by one row. The default setting is
false.
Gets or sets the Style that is used to format the Table. Many built-in styles can be used but the default style is TableStyleLight9.
Gets or sets the name of a CustomStyle that is applied to the Table.
The default value is the string value used by the Style property.
Returns true if the TableCollection contains a Table with the name ?tableName?; returns false otherwise.
true if the Table is found; false otherwise.
The name of the Table to look for.
Removes a Table from the TableCollection.
Removes a Table from the TableCollection by using an index to identify the Table that needs to be removed.
The index that corresponds to the Table that will be removed.
Adds a new Table to the TableCollection using a range of cells defined by cell addresses.
The Table added to the TableCollection.
The top-left cell of the range of cells that defines the table.
The bottom-right cell of the range of cells that defines the table.
The built-in style used to format the new table. The default style is TableStyleLight9.
Determines if the header row is displayed. The default setting is true.
Adds a new Table to the TableCollection using its name and a range of cells defined by cell addresses.
The Table added to the TableCollection.
The name of the table.
The top-left cell of the range of cells that defines the table.
The bottom-right cell of the range of cells that defines the table.
The built-in style used to format the new table. The default style is TableStyleLight9.
Determines if the header row should be displayed. The default setting is true.
Adds a new Table to the TableCollection using a range of cells defined by indexes. The indexes start at (0, 0).
The Table added to the TableCollection.
The Id for the first row of the range of cells that defines the table.
The Id for the first column of the range of cells that defines the table.
The Id for the last row of the range of cells that defines the table.
The Id for the last column of the range of cells that defines the table.
The built-in style used to format the new table. The default style is TableStyleLight9.
Determines if the header row should be displayed. The default setting is true.
Adds a new Table to the TableCollection using its name and a range of cells defined by indexes. The indexes start at
(0, 0).
The Table added to the TableCollection.
The name of the table.
The Id for the first row of the range of cells that defines the table.
The Id for the first column of the range of cells that defines the table.
The Id for the last row of the range of cells that defines the table.
The Id for the last column of the range of cells that defines the table.
The built-in style used to format the new table. The default style is TableStyleLight9.
Determines if the header row should be displayed. The default setting is true.
Removes a Table from the TableCollection by using its name.
The name of the Table that will be removed.
Removes the chosen Table from the TableCollection.
The Table that will be removed.
Gets the number of Table from the TableCollection.
Gets the Table element at the specified Id. The first table starts at 0.
Gets the Table element that has the specified table name.
Gets the last cell of the TableColumn.
Gets or sets the name of the table's column.
Gets the first cell of the TableColumn.
Gets or sets the custom formula used for a TableColumn?s total row. The
TableColumn.TotalRowFunction property must be set to CustomFormula for this property to work. Note that this property can affect the Formula property of the cells in the total row.
Gets or sets the built-in formula used for a TableColumn?s total row. The formula will
be applied for each cell of the TableColumn. If the value is None, the
TableColumn.TotalRowLabel can be displayed; if the value is CustomFormula, the TableColumn.TotalRowFormula can be used. This property can affect the
Formula and Value
properties of the cells in the total row. The default value is None.
Gets or sets the label used for a TableColumn?s total row. The
TableColumn.TotalRowFunction property must be set to None for this property to work. Note that this property can affect the Value property of the cells in the total row.
Gets the number of TableColumn from the TableColumnCollection.
Gets the TableColumn element at the specified Id. The first TableColumn starts at 0.
Gets the TableColumn element with the specified column name.
Gets the Theme's ThemeColors.
Gets/sets the Theme's name.
Instanciates a ThemeColor by specifying its Type and possible Tint.
The ThemeColor's type.
The ThemeColor's tint. Values range from -1 (dark) to +1 (light). The default value is 0.
Returns true if the current ThemeColor is equal to the obj received.
Returns true if the obj received is equal to the current ThemeColor; returns
false otherwise.
The ThemeColor that will be compared to the current ThemeColor.
Serves as the default hash function.Serves as the default hash function.
A hash code for the current object.
Gets/sets the ThemeColor's tint. Values are from -1 (dark) to +1 (light). The default
value is 0.
Gets or sets the ThemeColor's type.
Gets the number of Comment threads in the current Worksheet.
Gets a thread of Comments.
Gets a thread of Comments by using a Row Id and a Column Id.
The Id of the Row where the thread of Comments was inserted.
The Id of the Column where the thread of Comments was inserted.
Gets a thread of Comments by using an Address.
The Address of the Cell
where the thread of Comments was inserted.
Gets or sets if the user object?s PropertyNames will be shown
or not. The default value is false.
Gets or sets the user object?s PropertyNames, which will be displayed in the Worksheet
after importing the data. When set to null, which is the default value, all the PropertyNames are displayed.
Starts the calculation process for all the Cells containing a formula and update their Value properties once the process is done.
Clears specific elements in the Workbook.
Sets the options that determine which elements are cleared from the Workbook. The default
setting isAll.
Creates a new Workbook.
Loads an existing Workbook.
Protects a Workbook by enabling or disabling specific actions.
This can be done with or without a password.
The WorkbookProtection object that lets you select which actions can be carried
out on a protected Workbook.
The password that will be used to protect this Workbook.
Note that the same password must be used to Unprotect the Workbook. However, you can protect a Workbook without using a password. The default setting is, in fact, null, which sets no
password for the Protection.
Searches into the content of the Workbook and replaces all occurences of a specific value
with a new value.
The total number of instances of the searchValue that were replaced within the content of the Workbook.
The value that will be searched for.
The value that will replace all found instances of the searchValue.
Searches into the content of the Workbook and replaces all instances of the
SearchValues with their corresponding NewValues.
Returns how many instances of the searchValues were replaced within the content of the Workbook.
The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Saves the Workbook.
Saves the Workbook as a stream or as a new document.
Removes the protection that was added on the Workbook.
The password that will be used to unprotect the protected Workbook. This password must
be the same as the one set when the Protect method was used.
Note, however, that this parameter does not require a value if the Workbook was
protected without using a password. The default value for the parameter is, in fact, null, which allows to unprotect a Workbook without the use of a password when no password was set when the Protect method was used.
Creates a new Workbook in a document. The name of this Workbook will be the chosen ?filename?.
The created Workbook.
The file name used to create the Workbook.
Loads an existing Workbook using a string.
The loaded Workbook.
The file name of the Workbook that will be loaded.
Loads an existing Workbook from a stream.
The loaded Workbook.
The stream where the Workbook can be found.
Saves the Workbook as a stream.
The stream where the Workbook will be saved.
Saves the Workbook in a document named ?filename?.
The file name used to save the Workbook.
Gets if the Workbook is currently protected. The default value is false.
Gets the name of the Workbook.
Gets the WorkbookProtection as a read-only object.
Gets the Workbook's Theme.
Gets the list of all the WorkbookViews.
Gets the collection of Worksheet that is part of this Workbook. A Workbook always
have at least one Worksheet.
Protects a Workbook by removing the right to execute the following actions : adding,
removing, inserting, moving, copying, deleting and renaming Worksheets. The default value
is false.
Protects a Workbook by locking the size of its window. The default value is false.
Gets/sets the WorkbookThemeColor's Color.
Gets the WorkbookThemeColor associated with the specified ThemeColorType.
Gets the WorkbookThemeColor associated th the specified ThemeColorType.
Gets or sets the first page shown when the document is opened. The default value is -1. The index starts at 0.
Gets or sets the first worksheet displayed at the bottom of the workbook. Pages before that number will be replaced by "..." . The default value is 0. The
index starts at 1.
Starts the calculation process in all the Cells containing a formula and update their Value properties once the process is done.
Clears specific elements in the Worksheet.
Sets the options that determine which elements are cleared from the Worksheet. The default
setting isAll.
Removes all DataValidations in the Worksheet.
Deletes Columns at a specific index in the Worksheet.
Deletes a CellRange and allows to specify in which direction the Cells located after the deleted range will be shifted.
Deletes Rows at a specific index in the Worksheet.
The Id of the Row that is currently located where the deletion will start. The Ids start at 0.
The number of Rows that will be deleted. The default value is 1.
Imports data of type Array, 2D-Array, ArrayList, ICollection, IDictionary, DataTable,
DataView or CSV path/stream in a Worksheet.
The number of items imported in the Worksheet.
The data to import.
The data can be of any of the supported types:
- Array (like string[], int[], MyProduct[], object[]...)
- 2D-Array (like double[,], string[,], MyProduct[,], object[,])
- ArrayList
- ICollection (like List <string>, List<MyProduct>, ObservableCollection<MyProduct>, Array<int>, ...)
- IDictionary (like Dictionary<int, string>, Dictionary<int, MyProduct>, ...)
- DataTable (with DataColumns and DataRows)
- DataView
- CSV path/stream (a path to a CSV document or a stream based on a CSV document).
The options when importing the data.
These can be any of the following:
- ImportOptions
- UserObjectImportOptions
- DataTableImportOptions
- CSVImportOptions.
Inserts new Columns at a
specific index in the Worksheet.
Inserts an empty CellRange and allows to specify in which direction the Cells located after the inserted range will be shifted.
Inserts new Rows at a specific index in the Worksheet.
The Id of the Row that is currently located where the new Rows will be inserted. The Ids start at 0.
The number of Rows that will be inserted. The default value is 1.
Protects a Worksheet by enabling or disabling specific actions.
This can be done with or without a password.
The WorksheetProtection object that lets you select which actions can be
carried out on a protected Worksheet.
When set to null, the default WorksheetProtection object will be
used, which will allow only two actions to be carried out : selecting locked and unlocked Cells.
The password that will be used to protect the Worksheet.
Note that the same password must be used to Unprotect the Worksheet. However, you can protect a Worksheet without using a password. The default setting is, in fact, null, which sets no
password for the Protection.
Removes a specific DataValidation from the Worksheet.
The DataValidation that will be removed.
Searches into the content of the Worksheet and replaces all occurences of a specific value
with a new value.
The total number of instances of the searchValue that were replaced within the content of the Worksheet.
The value that will be searched for.
The value that will replace all found instances of the searchValue.
Searches into the content of the Worksheet and replaces all instances of the
SearchValues with their corresponding NewValues.
Returns how many instances of the searchValues were replaced within the content of the Worksheet.
The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Unprotects a Worksheet.
The password that will be used to unprotect the protected Worksheet. This password must
be the same as the one set when the Protect method was used.
Note, however, that this parameter does not require a value if the Worksheet was
protected without using a password. The default value for the parameter is, in fact, null, which allows to unprotect a Worksheet without the use of a password when no password was set when the Protect method was used.
Determines where the deletion starts by using an Id.
The Id of the Column that is currently located where the deletion will start. Ids start at 0.
The number of Columns that will be deleted. The default value is 1.
Determines where the deletion starts by using a string Id.
The string Id of the Column that is currently located where the deletion will start. Ids
start at A.
The number of Columns that will be deleted. The default value is 1.
Deletes a CellRange using Row & Column Ids to identify the
range and allows to specify in which direction the Cells located after the deleted range will
be shifted.
The Id of the Row that corresponds to the topmost Row of the CellRange that will be
deleted.
The Id of the Column that corresponds to the leftmost Column of the CellRange that
will be deleted.
The Id of the Row that corresponds to the bottommost Row of the CellRange that will be
deleted.
The Id of the Column that corresponds to the rightmost Column of the CellRange that
will be deleted.
Specifies the DeleteRangeShiftType.
Deletes a CellRange using CellAddresses to identify the
range and allows to specify in which direction the Cells located after the deleted range will
be shifted.
The Address of the Cell
that is located at the start of the CellRange that will be deleted.
The Address of the Cell
that is located at the end of the CellRange that will be deleted.
Specifies the DeleteRangeShiftType.
Determines where the new Columns will be inserted by using an Id .
The Id of the Column that is currently located where the new Columns will be inserted. Ids start at 0.
The number of Columns that will be inserted. The default value is 1.
Determines where the new Columns will be inserted by using a string Id.
The string Id of the Column that is currently located where the new Columns will be inserted. Ids start at A.
The number of Columns that will be inserted. The default value is 1.
Inserts an empty CellRange using Row & Column Ids to identify where
the range will be inserted and allows to specify in which direction the Cells located after the
inserted range will be shifted.
The Id of the Row that is currently located where the topmost Row of the inserted CellRange will
be located.
The Id of the Column that is currently located where the leftmost Column of the inserted CellRange
will be located.
The Id of the Row that is currently located where the bottommost Row of the inserted CellRange will
be located.
The Id of the Column that is currently located where the rightmost Column of the inserted CellRange
will be located.
Specifies the InsertRangeShiftType.
Inserts an empty CellRange using CellAddresses to identify where
the range will be inserted and allows to specify in which direction the Cells located after the
inserted range will be shifted.
The Address of the Cell
that is currently located where the top left corner of the inserted range will be located.
The Address of the Cell
that is currently located where the bottom right corner of the inserted range will be located.
Specifies the InsertRangeShiftType.
Gets the Worksheet's AnnotationCollection.
Gets the Worksheet's CellCollection.
Gets the Worksheet's ColumnCollection.
Gets the DataValidations in the DataValidationCollection.
Gets the Worksheet's HyperlinkCollection.
Gets the current Worksheet's Id. A Workbook may contain more than one Worksheet. The first Id starts at 0.
Gets if the Worksheet is currently protected. The default value is false.
Gets the Worksheet's MergedCellCollection.
Gets or sets the Worksheet's name.
Gets the Worksheet's PageLayout.
Gets the Worksheet's PictureCollection.
Gets the WorksheetProtection as a read-only object.
Gets the Worksheet's RowCollection.
Gets the Worksheet's SheetView.
Gets or sets the Color for the Worksheet's tab. The default value is null.
Gets the Worksheet's TableCollection.
Gets or sets the ThemeColor that the Worksheet will use on its tabs. The default value is null.
Gets or sets how a Worksheet is displayed. The default setting isVisible.
This method allows to add a Worksheet to the WorksheetCollection.
Returns true if the WorksheetCollection contains a Worksheet with the name ?worksheetName?; returns false otherwise.
true if the Worksheet is found; false otherwise.
This method is used to create a copy of a specific worksheet. The worksheet to be copied can be specified by its index, name or by using the Worksheet object itself.
Adds a new Worksheet at the designated location.
Moves a Worksheet or a WorksheetRange to a selected location in the WorksheetCollection.
Removes the Worksheet from the WorksheetCollection and offsets the index of the other Worksheets toward the deleted element.
Removes a Worksheet from the WorksheetCollection by using an index to locate it in the collection.
The index that corresponds to the Worksheet that will be removed.
Adds a Worksheet to the WorksheetCollection and sets how it is displayed.
Determines how the added Worksheet is displayed. The default
setting is Visible.
Adds a Worksheet to the WorksheetCollection using a string and then sets how it is displayed.
Identifies the Worksheet that will be added to the WorksheetCollection by using a string that corresponds to its name.
Sets how the added Worksheet is displayed. The default setting isVisible.
Uses an index as the target location.
The index that corresponds to the location where the new Worksheet will be placed.
The Name of the Worksheet that will be added.
Uses the Name of a Worksheet as the target location.
The Name of the Worksheet that is currently located where the new Worksheet will be placed.
The Name of the Worksheet that will be added.
Uses a specific Worksheet as the target location.
The Worksheet that is currently located where the new Worksheet will be placed.
The Name of the Worksheet that will be added.
Moves a Worksheet into a WorksheetCollection using Ids to identify the Worksheet to move & its insertion point.
The index corresponding to the Worksheet that will be moved.
The Id of the Worksheet that is currently located where the selected Worksheet will be moved.
Moves a Worksheet into a WorksheetCollection using an Id to identify the Worksheet to move & the name of a Worksheet to determine the insertion point.
The index corresponding to the Worksheet that will be moved.
The name of the Worksheet that is currently located where the selected Worksheet will be moved.
Moves a Worksheet into a WorksheetCollection using an Id to identify the Worksheet to move & a specific Worksheet as the insertion point.
The index corresponding to the Worksheet that will be moved.
The Worksheet that is currently located where the selected Worksheet will be moved.
Moves a Worksheet into a WorksheetCollection using a string to identify the Worksheet to move & an Id to determine its insertion point.
The name of the Worksheet that will be moved.
The Id of the Worksheet that is currently located where the selected Worksheet will be moved.
Moves a Worksheet into a WorksheetCollection using strings to identify the Worksheet to move & its insertion point.
The name of the Worksheet that will be moved.
The name of the Worksheet that is currently located where the selected WorksheetRange will be moved.
Moves a Worksheet into a WorksheetCollection using a string to identify the Worksheet to move & a specific Worksheet as the insertion point.
The name of the Worksheet that will be moved.
The Worksheet that is currently located where the selected Worksheet will be moved.
Moves a specific Worksheet into a WorksheetCollection and uses an Id to determine its insertion point.
The Worksheet that will be moved.
The Id of the Worksheet that is currently located where the selected Worksheet will be moved.
Moves a specific Worksheet into a WorksheetCollection and uses a string to determine its insertion point.
The Worksheet that will be moved.
The name of the Worksheet that is currently located where the selected WorksheetRange will be moved.
Moves a specific Worksheet into a WorksheetCollection and targets another Worksheet as the insertion point.
The Worksheet that will be moved.
The Worksheet that is currently located where the selected Worksheet will be moved.
Moves a WorksheetRange into a WorksheetCollection using an Id to determine the insertion point.
The WorksheetRange that will be moved.
The Id of the Worksheet that is currently located where the selected WorksheetRange will be moved.
Moves a WorksheetRange into a WorksheetCollection using the name of a Worksheet to determine the insertion point.
The WorksheetRange that will be moved.
The name of the Worksheet that is currently located where the selected WorksheetRange will be moved.
Moves a WorksheetRange into a WorksheetCollection using a specific Worksheet to determine the insertion point.
The WorksheetRange that will be moved.
The Worksheet that is currently located where the selected WorksheetRange will be moved.
Removes a Worksheet from the WorksheetCollection using a string to identify the Worksheet that needs to be removed.
The name of the Worksheet that will be removed.
Removes a Worksheet from the WorksheetCollection by identifying the specific Worksheet that needs to be removed.
The Worksheet that will be removed.
Removes a WorksheetRange from the WorksheetCollection.
The WorksheetRange that will be removed.
Gets the number of Worksheet in the WorksheetCollection. The default is one Worksheet per Workbook.
Gets the Worksheet element that is located at the specified Id.
The first worksheet starts at 0.
Gets the Worksheet element that has the specified worksheet name.
Gets a WorksheetRange from the WorksheetCollection, using Ids to identify the starting and ending points of the range.
The Id of the Worksheet that is used as the starting point of the range.
The Id of the Worksheet that ends the range.
Gets a WorksheetRange from the WorksheetCollection, using names to identify the starting and ending points of the
range.
The name of the Worksheet that is used as the starting point of the range.
The name of the Worksheet that ends the range.
Gets or sets if deleting Columns is allowed when a Worksheet is protected. The default value is false.
Gets or sets if deleting Rows is allowed when a Worksheet is protected. The default value is false.
Gets or sets if editing objects like Pictures, Notes or Comments is allowed when a
Worksheet is protected. The default value is false.
Gets or sets if modifying the formatting of Cells is allowed when a Worksheet is protected. The default value is false.
Gets or sets if modifying the formatting of Columns is allowed when a Worksheet is protected. The default value is false.
Gets or sets if modifying the formatting of Rows is allowed when a Worksheet is protected. The default value is false.
Gets or sets if inserting Columns is allowed when a Worksheet is protected. The default value is false.
Gets or sets if inserting Hyperlinks is allowed when a Worksheet is protected. The default value is false.
Gets or sets if inserting Rows is allowed when a Worksheet is protected. The default value is false.
Gets or sets if selecting locked Cells is allowed when a Worksheet is protected. The default value is true.
Gets or sets if selecting unlocked Cells is allowed when a Worksheet is protected. The default value is true.
Gets or sets if using AutoFilter is allowed when a Worksheet is protected. The default value is false.
Triggers CalculateFormulas for all of the Worksheets in the WorksheetRange.
Clears specific elements in the range.Clears specific elements in the WorksheetRange.
Sets the options that determine which elements are cleared from the range. The default setting is All.All
Searches into the content of the range and replaces all occurences of a specific value with a new value.Searches into the content of the range and replaces all occurences of a specific value with a new value.
The total number of instances of the searchValue that were replaced within the content of the range.The total number of instances of the searchValue that were replaced within the content of the range.
The value that will be searched for.The value that will be searched for.
The value that will replace all found instances of the searchValue.The value that will replace all found instances of the searchValue.
Searches into the content of the RangeBase and replaces all instances of the
SearchValues with their corresponding NewValues.SearchValuesNewValues
Returns how many instances of the searchValues were replaced within the content of the RangeBase.searchValues
The values that will be searched for.The values that will be searched for.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
The values that will replace all found instances of the searchValues.
Note that the replacement will respect the position of the data in the searchValues & will follow the established order when replacing said data
with the corresponding newValues.
Returns a string that represents the current object.
A string that represents the current object.
Gets the number of items in the range.WorksheetRange
Gets or sets the TabColor of all the Worksheets in the WorksheetRange.
Gets or sets the TabThemeColor of all the Worksheets in the WorksheetRange.
Gets or sets the Visibility of all the Worksheets in the WorksheetRange.