# GridWorkbookBinding

Fields, allowed values, and APIs that use GridWorkbookBinding.

Canonical: https://grid.syidax.com/docs/types/GridWorkbookBinding/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface GridWorkbookBinding {
  readonly workbookId: string;
  readonly workbookKey: number;
  readonly sheetName: string;
  readonly sheetId: number;
  readonly registrationId: number;
}
```

<a id="used-by"></a>

## APIs using this type

- [getWorkbookBinding](https://grid.syidax.com/docs/methods/getWorkbookBinding.md) — Reads current workbook and sheet connection information, or null when disconnected.
- [reconnectWorkbook](https://grid.syidax.com/docs/methods/reconnectWorkbook.md) — Rebuilds the connection from current workbook settings and returns the result.

<a id="parents"></a>

## Contracts containing this type

- [GridWorkbookBindingChangedDetail](https://grid.syidax.com/docs/types/GridWorkbookBindingChangedDetail.md)
- [GridWorkbookBindingErrorDetail](https://grid.syidax.com/docs/types/GridWorkbookBindingErrorDetail.md)
- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)