SheetXL - v0.3.20
    Preparing search index...

    Interface ISheetProtection

    Interface representing the protection settings for a sheet. Extends the base IProtection interface with additional sheet-specific protection options.

    interface ISheetProtection {
        addListeners(listeners: IListeners, options?: IListener.Options): Remove;
        checkPassword(password?: string): Promise<boolean>;
        getProperties(): Properties;
        hasPassword(): boolean;
        isAutoFilterAllowed(): boolean;
        isDeleteColumnsAllowed(): boolean;
        isDeleteRowsAllowed(): boolean;
        isFormatCellsAllowed(): boolean;
        isFormatColumnsAllowed(): boolean;
        isFormatRowsAllowed(): boolean;
        isInsertColumnsAllowed(): boolean;
        isInsertHyperlinksAllowed(): boolean;
        isInsertRowsAllowed(): boolean;
        isLocked(): boolean;
        isObjectsAllowed(): boolean;
        isPaused(): boolean;
        isPivotTablesAllowed(): boolean;
        isScenariosAllowed(): boolean;
        isSelectLockedCellsAllowed(): boolean;
        isSelectUnlockedCellsAllowed(): boolean;
        isSortAllowed(): boolean;
        lock(
            properties?: Partial<P>,
            password?: string,
            algorithm?: string,
            spinCount?: number,
        ): Promise<IProtection<ISheetProtection, Properties, JSON>>;
        pause(
            password?: string,
        ): Promise<IProtection<ISheetProtection, Properties, JSON>>;
        resume(): IProtection<ISheetProtection, Properties, JSON>;
        toJSON(): JSON;
        unlock(
            password?: string,
        ): Promise<IProtection<ISheetProtection, Properties, JSON>>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    addListeners checkPassword getProperties hasPassword isAutoFilterAllowed isDeleteColumnsAllowed isDeleteRowsAllowed isFormatCellsAllowed isFormatColumnsAllowed isFormatRowsAllowed isInsertColumnsAllowed isInsertHyperlinksAllowed isInsertRowsAllowed isLocked isObjectsAllowed isPaused isPivotTablesAllowed isScenariosAllowed isSelectLockedCellsAllowed isSelectUnlockedCellsAllowed isSortAllowed 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.

    • Retrieves the protection properties for the sheet.

      Returns Properties

      The ISheetProtection.Properties object representing the current protection settings.

    • Returns true if the protection has a password.

      Returns boolean

    • Checks if the AutoFilter functionality is protected on the sheet.

      Returns boolean

      true if AutoFilter is locked, false otherwise.

    • Checks if deleting columns is protected on the sheet.

      Returns boolean

      true if deleting columns is locked, false otherwise.

    • Checks if deleting rows is protected on the sheet.

      Returns boolean

      true if deleting rows is locked, false otherwise.

    • Checks if formatting cells is protected on the sheet.

      Returns boolean

      true if formatting cells is locked, false otherwise.

    • Checks if formatting columns is protected on the sheet.

      Returns boolean

      true if formatting columns is locked, false otherwise.

    • Checks if formatting rows is protected on the sheet.

      Returns boolean

      true if formatting rows is locked, false otherwise.

    • Checks if inserting columns is protected on the sheet.

      Returns boolean

      true if inserting columns is locked, false otherwise.

    • Checks if inserting hyperlinks is protected on the sheet.

      Returns boolean

      true if inserting hyperlinks is locked, false otherwise.

    • Checks if inserting rows is protected on the sheet.

      Returns boolean

      true if inserting rows is locked, false otherwise.

    • 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 objects (e.g., charts, shapes) are protected on the sheet.

      Returns boolean

      true if objects are locked, false otherwise.

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

      Returns boolean

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

    • Checks if pivot tables are protected on the sheet.

      Returns boolean

      true if pivot tables are locked, false otherwise.

    • Checks if scenarios are protected on the sheet.

      Returns boolean

      true if scenarios are locked, false otherwise.

    • Checks if selecting locked cells is protected on the sheet.

      Returns boolean

      true if selecting locked cells is locked, false otherwise.

    • Checks if selecting unlocked cells is protected on the sheet.

      Returns boolean

      true if selecting unlocked cells is locked, false otherwise.

    • Checks if sorting is protected on the sheet.

      Returns boolean

      true if sorting is 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<ISheetProtection, 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<ISheetProtection, 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<ISheetProtection, 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