# SpreadsheetInfo

Returns the properties of a spreadsheet object.

## Method Signature

```
SpreadsheetInfo(spreadsheetObj=[any])
```

### Arguments

| Argument         | Type  | Required | Description             | Default |
| ---------------- | ----- | -------- | ----------------------- | ------- |
| `spreadsheetObj` | `ANY` | `true`   | The spreadsheet object. |         |

## Examples

Get complete spreadsheet information:

```js
// Get all information about a spreadsheet
var spreadsheet = SpreadsheetNew( sheetname = "Sales" );
SpreadsheetAddRow( spreadsheet, [ "Month", "Revenue" ] );
SpreadsheetAddRow( spreadsheet, [ "January", 5000 ] );

var info = SpreadsheetInfo( spreadsheet );
println( "Sheet names: " & info.sheets );
println( "Column count: " & info.columncount );
println( "Row count: " & info.rowcount );
```

Extract specific sheet information:

```js
// Get info about a specific sheet
var spreadsheet = SpreadsheetRead( "/path/to/file.xlsx" );
var info = SpreadsheetInfo( spreadsheet );

for ( var sheet in info.sheets ) {
    println( "Sheet: " & sheet );
}
```

Monitor spreadsheet structure:

```js
// Use info for validation before operations
var spreadsheet = SpreadsheetNew();
var info = SpreadsheetInfo( spreadsheet );

if ( info.rowcount == 0 ) {
    println( "Empty spreadsheet, adding headers..." );
    SpreadsheetAddRow( spreadsheet, [ "ID", "Name", "Email" ] );
}
```

## Related

* [SpreadsheetNew()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetnew) - Create a spreadsheet
* [SpreadsheetRead()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetread) - Read spreadsheet files
* [SpreadsheetGetColumnCount()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetgetcolumncount) - Get column count
* [SpreadsheetGetLastRowNumber()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetgetlastrownumber) - Get last row
* [Query Access Guide](https://github.com/ortus-boxlang/boxlang-docs/blob/v1.x/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/query-access.md) - Converting spreadsheets to queries