 | Worksheet |
Class representing a reader for worksheets of XLSX files
Inheritance HierarchySystemObject
NanoXLSX.LowLevelWorksheetReader
NanoXLSX.LowLevelWorksheetReader
Namespace: NanoXLSX.LowLevel
Assembly: NanoXLSX (in NanoXLSX.dll) Version: 2.6.7+3223c8b99fcd3402b4ae016daa480abac16f8a9f
SyntaxC#
public class WorksheetReader
The WorksheetReader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WorksheetReader | Constructor with parameters |
Properties| Name | Description | |
|---|---|---|
 | AutoFilterRange | Gets the auto filter range. If null, no auto filters were defined |
| Columns | Gets a list of defined Columns |
| CurrentZoomScale | Gets the zoom factor of the current view type |
| Data | Gets the data of the worksheet as Dictionary of cell address-cell object tuples |
| DefaultColumnWidth | Gets the default column width if defined, otherwise null |
| DefaultRowHeight | Gets the default row height if defined, otherwise null |
| MergedCells | Gets a list of merged cells |
| PaneSplitValue | Gets the definition of pane split-related information |
| Rows | Gets a dictionary of internal Row definitions |
| SelectedCells | Gets the selected cells (panes are currently not considered) |
| ShowGridLines | Gets whether grid lines are shown |
| ShowRowColHeaders | Gets whether column and row headers are shown |
| ShowRuler | Gets whether rulers are shown in view type: pageLayout |
| StyleAssignment | Gets the assignment of resolved styles to cell addresses |
| ViewType | Gets the sheet view type of the current worksheet |
| WorksheetProtection | Gets the applicable worksheet protection values |
| WorksheetProtectionHash | Gets the (legacy) password hash of a worksheet if protection values are applied with a password |
| ZoomFactors | Gets all preserved zoom factors of the worksheet |
Methods| Name | Description | |
|---|---|---|
 | CollectSelectedCells | Resolves the selected cells of a range or a single cell |
| ConvertDateFromDouble | Tries to convert a date (DateTime) from a double |
| ConvertDoubleToInt | Converts a double to an integer without checks |
| ConvertTimeFromDouble | Tries to convert a time (TimeSpan) from a double |
| ConvertToBool | Tries to convert a value to a bool |
| ConvertToDate | Tries to convert a value to a Date (DateTime) |
| ConvertToDecimal | Tries to convert a value to a decimal |
| ConvertToDouble | Tries to convert a value to a double |
| ConvertToInt | Tries to convert a value to an integer |
| ConvertToString | Converts an arbitrary value to string |
| ConvertToTime | Tries to convert a value to a Time (TimeSpan) |
| CreateCell | Creates a generic cell with optional style information |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetAutoFilters | Gets the auto filters of the current worksheet |
| GetColumns | Gets the columns of the current worksheet |
| GetDateTimeValue | Parses the date (DateTime) or time (TimeSpan) value of a raw cell. If the value is numeric, but out of range of a OAdate, a numeric value will be returned instead. If invalid, the string representation will be returned. |
| GetEnforcedColumnValue | Converts the cell values of defined rows, based on import options (e.g. everything to string or all values to double) |
| GetGloballyEnforcedFlagValues | Modifies certain values globally by import options (e.g. empty as string or dates as numbers) |
| GetGloballyEnforcedValue | Converts the cell values globally, based on import options (e.g. everything to string or all numbers to double) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetMergedCells | Gets the merged cells of the current worksheet |
| GetNumericValue(String) | Parses the numeric value of a raw cell. The order of possible number types are: ulong, long, uint, int, float or double. If nothing applies, null is returned |
| GetNumericValue(Object, CellCellType) | Tries to parse a numeric value with an appropriate type |
| GetSheetFormats | Gets the sheet format information of the current worksheet |
| GetSheetProtection | Gets the sheet protection values of the current worksheets |
| GetSheetView | Gets the selected cells of the current worksheet |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValidatedWidth | Gets the column width according to EnforceValidColumnDimensions |
| ManageSheetProtection | Manages particular sheet protection values if defined |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ProcessStyles | Determine which of the resolved styles are either to define a time or a date. Stores also the styles into a dictionary |
| Read | Reads the XML file form the passed stream and processes the worksheet data |
| ReadCell | Reads one cell in a worksheet |
| ResolveCellData | Resolves the data of a read cell either automatically or conditionally (import options), transforms it into a cell object and adds it to the data |
| ResolveSharedString | Tries to resolve a shared string from its ID |
| ResolveType | Resolves the final cell type after a possible conversion by import options |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryConvertDoubleToInt | Tries to convert a double to an integer |
| TryParseBool | Parses the boolean value of a raw cell |
| TryParseDate | Tris to parse a DateTime instance from a string |
| TryParseTime | Tris to parse a TimeSpan instance from a string |
See Also