MAIDR JavaScript API
    Preparing search index...

    Interface ExcelWorksheetCollection

    The workbook's worksheets (Excel.WorksheetCollection).

    interface ExcelWorksheetCollection {
        load: (propertyNames?: string | string[]) => unknown;
        items: readonly ExcelWorksheet[];
        getItemOrNullObject: (
            key: string,
        ) => ExcelWorksheet & { isNullObject?: boolean };
        onChanged: ExcelEventHandlers<unknown>;
        onCalculated: ExcelEventHandlers<unknown>;
        onAdded: ExcelEventHandlers<ExcelWorksheetAddedEvent>;
        onDeleted: ExcelEventHandlers<unknown>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    load items getItemOrNullObject onChanged onCalculated onAdded onDeleted

    Properties

    load: (propertyNames?: string | string[]) => unknown
    items: readonly ExcelWorksheet[]

    The loaded worksheets, in tab order.

    getItemOrNullObject: (
        key: string,
    ) => ExcelWorksheet & { isNullObject?: boolean }

    A worksheet by name or id; a null object when there is none (ExcelApi 1.4).

    onChanged: ExcelEventHandlers<unknown>

    A cell changed on any worksheet (ExcelApi 1.9).

    onCalculated: ExcelEventHandlers<unknown>

    Any worksheet was recalculated (ExcelApi 1.8).

    onAdded: ExcelEventHandlers<ExcelWorksheetAddedEvent>

    A worksheet was added (ExcelApi 1.7).

    onDeleted: ExcelEventHandlers<unknown>

    A worksheet was deleted (ExcelApi 1.7).

    Settings

    Member Visibility

    On This Page

    Properties