SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface PasswordFieldProps

    interface PasswordFieldProps {
        description?: string;
        disabled?: boolean;
        hasPassword: boolean;
        label?: string;
        note?: string;
        requireCurrent?: boolean;
        onClear(): void | Promise<void>;
        onSet(password: string, current?: string): void | Promise<void>;
    }
    Index
    description? disabled? hasPassword label? note? requireCurrent?
    onClear onSet
    description?: string

    One line inside the dialog saying what this password will protect.

    disabled?: boolean
    hasPassword: boolean

    Whether a password is in force (or staged to be).

    label?: string

    Heading above the row. Omit for a row that sits under someone else's heading.

    note?: string

    Shown in place of the "a password is set" line — e.g. "will be set when you protect".

    requireCurrent?: boolean

    Ask for the password already in force alongside the new one.

    True where the model verifies before it will write a new hash — a protected sheet, a protected workbook. False where the password is only staged and nothing has been committed yet.

    • Returns void | Promise<void>

    • Parameters

      • password: string
      • Optionalcurrent: string

      Returns void | Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods