# SpreadsheetRead

Reads a sheet from a spreadsheet file and stores it in a BoxLang spreadsheet object.

## Method Signature

```
SpreadsheetRead(src=[any], sheet=[any], format=[any], headerrow=[any], password=[any])
```

### Arguments

| Argument    | Type      | Required | Description                                                                                 | Default |
| ----------- | --------- | -------- | ------------------------------------------------------------------------------------------- | ------- |
| `src`       | `STRING`  | `true`   | The path to the spreadsheet file.                                                           |         |
| `sheet`     | `ANY`     | `false`  | The name or index of the sheet to read. If not specified, reads the first sheet.            |         |
| `format`    | `STRING`  | `false`  | The format of the spreadsheet (not used in this implementation as format is auto-detected). |         |
| `headerrow` | `NUMERIC` | `false`  | The row number to start reading from (1-based). Default is 1.                               |         |
| `password`  | `STRING`  | `false`  | The password for encrypted spreadsheets.                                                    |         |

## Examples

Read a spreadsheet file:

```js
// Read an Excel file from disk
var spreadsheet = SpreadsheetRead( src = "/path/to/file.xlsx" );
println( "Read spreadsheet with " & SpreadsheetGetColumnCount( spreadsheet ) & " columns" );
```

Read a specific sheet from a spreadsheet:

```js
// Read a specific sheet by name
var spreadsheet = SpreadsheetRead(
    src = "/path/to/file.xlsx",
    sheet = "Sales"
);
println( "Read sheet: Sales" );
```

Read a spreadsheet starting from a specific row:

```js
// Skip header rows and start reading from row 5
var spreadsheet = SpreadsheetRead(
    src = "/path/to/file.xlsx",
    sheet = 1,
    headerrow = 5
);
```

Read an encrypted spreadsheet:

```js
// Read password-protected spreadsheet
var spreadsheet = SpreadsheetRead(
    src = "/path/to/encrypted.xlsx",
    password = "myPassword"
);
```

## Related

* [SpreadsheetNew()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetnew) - Create a new spreadsheet
* [SpreadsheetReadBinary()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetreadbinary) - Read binary format files
* [SpreadsheetWrite()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetwrite) - Save spreadsheets
* [SpreadsheetInfo()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetinfo) - Get spreadsheet information
* [File Handling Guide](https://github.com/ortus-boxlang/boxlang-docs/blob/v1.x/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/file-handling.md) - Working with spreadsheet files