SheetXL - v1.0.2
    Preparing search index...

    Interface ITaskPaneAreaElement

    interface ITaskPaneAreaElement {
        activate: <A = any>(
            key: string,
            options?: ActivateFrameOptions<A>,
        ) => void;
        addListener: (listener: ITaskPaneAreaListener) => RemoveListener;
        canActivate: (key: string) => boolean;
        close: (key: string) => Promise<void>;
        getActive: () => string | null;
        getOpen: () => readonly string[];
    }

    Hierarchy (View Summary)

    Index
    activate addListener canActivate close getActive getOpen
    activate: <A = any>(key: string, options?: ActivateFrameOptions<A>) => void

    This will show and focus a task pane by key.

    Type Declaration

    addListener: (listener: ITaskPaneAreaListener) => RemoveListener

    Add a listener for task pane state changes.

    canActivate: (key: string) => boolean

    Whether activate can show the task pane key: there is an area to show it in, and a pane registered under that key. A command that opens a pane is disabled when this is false.

    Type Declaration

      • (key: string): boolean

      • Parameters

        • key: string

          The task pane key.

        Returns boolean

    close: (key: string) => Promise<void>

    Will close the task pane with the given key.

    Type Declaration

      • (key: string): Promise<void>

      • Parameters

        • key: string

          The task pane key.

        Returns Promise<void>

    getActive: () => string | null

    Return the key for the currently active task pane.

    getOpen: () => readonly string[]

    Returns the list of currently open task panes.

    Settings
    Member Visibility

    On This Page
    Properties