SheetXL - v1.0.2
    Preparing search index...

    Variable TaskPaneKeyConst

    TaskPaneKey: {
        CellControl: "formatCellControl";
        Comments: "comments";
        ConditionalFormat: "conditionalFormatDetails";
        DataValidation: "dataValidationDetails";
        ExternalLinks: "externalLinks";
        FormatCells: "formatCells";
        FormatMovable: "formatMovable";
        Names: "managedNames";
        PivotTable: "pivotTableFields";
        Protection: "manageProtection";
        TableDetails: "tableDetails";
    } = ...

    The keys of the task panes this package's commands open. Activate one with taskPaneArea.activate(TaskPaneKey.Comments); register a pane under one to supply it or replace it.

    Type Declaration

    • ReadonlyCellControl: "formatCellControl"

      The cell control at the active cell. Supplied here.

    • ReadonlyComments: "comments"

      The sheet's threaded comments. Opened on a thread with a CommentsPaneArgs. A host supplies it.

    • ReadonlyConditionalFormat: "conditionalFormatDetails"

      The sheet's conditional formatting rules. Opened on a rule with ItemsPaneArgs. A host supplies it.

    • ReadonlyDataValidation: "dataValidationDetails"

      The sheet's data validation rules. Opened on a rule with ItemsPaneArgs. A host supplies it.

    • The workbooks this one links to. Opened with ExternalLinksPaneArgs. A host supplies it.

    • ReadonlyFormatCells: "formatCells"

      Format Cells: the selection's number format, font, alignment, fill and border. A host supplies it.

    • ReadonlyFormatMovable: "formatMovable"

      The format of the selected drawing (shape, picture, chart). Supplied here.

    • ReadonlyNames: "managedNames"

      The workbook's defined names, every scope. Opened on a name with ItemsPaneArgs. A host supplies it.

    • ReadonlyPivotTable: "pivotTableFields"

      The fields of the pivot table the active cell is in. Opened with PivotTablePaneArgs. Supplied here.

    • ReadonlyProtection: "manageProtection"

      Sheet and workbook protection, and the sheet's protected ranges. Opened with ProtectionPaneArgs. A host supplies it.

    • ReadonlyTableDetails: "tableDetails"

      The details of the table the active cell is in. A host supplies it.

    Some of these panes this package supplies itself, registered the first time their command runs. The rest a host supplies (Studio does): until one is registered under the key, the commands that open it are disabled.

    Not every pane is here. A plugin registers its own panes under keys of its own, so a pane key is any string; these are the ones this package knows by name.