SheetXL - v0.3.20
    Preparing search index...

    Interface IWorkbookProtection

    Interface representing protection settings for a workbook. This interface allows for getting and setting passwords, managing structure and window locks, and handling revision protection.

    interface IWorkbookProtection {
        addListeners(listeners: IListeners, options?: IListener.Options): Remove;
        checkPassword(password?: string): Promise<boolean>;
        hasPassword(): boolean;
        isLocked(): boolean;
        isPaused(): boolean;
        isRevisionAllowed(): boolean;
        isStructureAllowed(): boolean;
        isWindowsAllowed(): boolean;
        lock(
            properties?: Partial<P>,
            password?: string,
            algorithm?: string,
            spinCount?: number,
        ): Promise<IProtection<IWorkbookProtection, Properties, JSON>>;
        pause(
            password?: string,
        ): Promise<IProtection<IWorkbookProtection, Properties, JSON>>;
        resume(): IProtection<IWorkbookProtection, Properties, JSON>;
        toJSON(): JSON;
        unlock(
            password?: string,
        ): Promise<IProtection<IWorkbookProtection, Properties, JSON>>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    addListeners checkPassword hasPassword isLocked isPaused isRevisionAllowed isStructureAllowed isWindowsAllowed lock pause resume toJSON unlock

    Methods

    • Verifies if the provided password matches the current protection password.

      Parameters

      • Optionalpassword: string

        The password to check against the current protection.

      Returns Promise<boolean>

      true if the password is correct, false otherwise.

      Use this method to validate the password before unlocking or modifying the protection settings.

    • Returns true if the protection has a password.

      Returns boolean

    • Checks if the object is currently locked.

      Returns boolean

      true if the object is locked, false otherwise.

      This method returns true If the lock is active.

    • Checks if the object has a locked but is paused.

      Returns boolean

      true if the object is locked but paused, false otherwise.

    • Checks if workbook revisions are locked. Locking revisions prevents changes to the workbook without the revision password.

      Returns boolean

      true if revisions are locked, false otherwise.

    • Checks if the workbook structure is locked. Locking the structure prevents changes like adding or deleting sheets.

      Returns boolean

      true if the structure is locked, false otherwise.

    • Checks if workbook windows are locked. Locking the windows prevents changes to window position and size.

      Returns boolean

      true if windows are locked, false otherwise.

    • Locks the object (workbook or sheet or range) with the specified options and password.

      Parameters

      • Optionalproperties: Partial<P>

        The properties to allow to remain unlocked.

      • Optionalpassword: string

        The password required to unlock the object.

      • Optionalalgorithm: string

        The algorithm for encrypting the password.

      • OptionalspinCount: number

        The spin count for encrypting the password.

      Returns Promise<IProtection<IWorkbookProtection, Properties, JSON>>

      The IProtection instance for method chaining.

      By default all properties are locked but you can specify which properties to remain unlocked.

    • Temporarily disables protection with the provided password.

      Parameters

      • Optionalpassword: string

        The password required to pause protection.

      Returns Promise<IProtection<IWorkbookProtection, Properties, JSON>>

      The IProtection instance for method chaining.

      This method allows temporarily pausing protection without permanently unlocking the object. Use resume to restore protection.

    • Unlocks the object (workbook or sheet) using the provided password.

      Parameters

      • Optionalpassword: string

        The password required to unlock the object.

      Returns Promise<IProtection<IWorkbookProtection, Properties, JSON>>

      The IProtection instance for method chaining.

      If the correct password is provided, protection is removed from the object.

    Settings

    Member Visibility

    On This Page

    Methods