Excel.WorksheetProtectionChangedEventArgs interface

Пакет:
excel

Содержит сведения о листе, на котором возникло событие изменения состояния защиты, которое возникает при обновлении состояния защиты на листе.

Комментарии

Набор API: ExcelApi 1.14

Используется

Свойства

allowEditRangesChanged

Указывает, AllowEditRange изменился ли какой-либо из объектов.
isProtected

Получает текущее состояние защиты листа.
protectionOptionsChanged

Указывает, изменились ли они WorksheetProtectionOptions .
sheetPasswordChanged

Указывает, изменился ли пароль листа.
source

Источник события. Она может быть локальной или удаленной (путем совместного редактирования).
type

Получает тип события. См. Excel.EventType дополнительные сведения.
worksheetId

Получает идентификатор листа, для которого изменяется состояние защиты.

Сведения о свойстве

allowEditRangesChanged

Указывает, AllowEditRange изменился ли какой-либо из объектов.

allowEditRangesChanged: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApiOnline 1.1

isProtected

Получает текущее состояние защиты листа.

isProtected: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.14

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}

protectionOptionsChanged

Указывает, изменились ли они WorksheetProtectionOptions .

protectionOptionsChanged: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApiOnline 1.1

sheetPasswordChanged

Указывает, изменился ли пароль листа.

sheetPasswordChanged: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApiOnline 1.1

source

Источник события. Она может быть локальной или удаленной (путем совместного редактирования).

source: Excel.EventSource | "Local" | "Remote";

Значение свойства

Excel.EventSource | "Local" | "Remote"

Комментарии

Набор API: ExcelApi 1.14

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}

type

Получает тип события. См. Excel.EventType дополнительные сведения.

type: "WorksheetProtectionChanged";

Значение свойства

"WorksheetProtectionChanged"

Комментарии

Набор API: ExcelApi 1.14

worksheetId

Получает идентификатор листа, для которого изменяется состояние защиты.

worksheetId: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.14

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}