# GridWorkbookBindingErrorDetail

Fields, allowed values, and APIs that use GridWorkbookBindingErrorDetail.

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

<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 GridWorkbookBindingErrorDetail {
  readonly code: WorkbookRegistryErrorCode | 'unexpected';
  readonly message: string;
  readonly reason: GridWorkbookBindingReason;
  readonly workbookId?: string;
  readonly sheetName?: string;
  readonly retainedBinding: GridWorkbookBinding | null;
}
```

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

## APIs using this type

- [workbookBindingError](https://grid.syidax.com/docs/events/workbookBindingError.md) — Emitted when a workbook connection cannot be configured. Inspect identifiers and connection errors.

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

## Contracts containing this type

- [SyGridEventMap](https://grid.syidax.com/docs/types/SyGridEventMap.md)

<a id="related"></a>

## Related types

- [WorkbookRegistryErrorCode](https://grid.syidax.com/docs/types/WorkbookRegistryErrorCode.md)
- [GridWorkbookBindingReason](https://grid.syidax.com/docs/types/GridWorkbookBindingReason.md)
- [GridWorkbookBinding](https://grid.syidax.com/docs/types/GridWorkbookBinding.md)