Excel.WorksheetProtectionChangedEventArgs interface

Пакет:

excel

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

Комментарии

[ Набор API: ExcelApi 1.14 ]

Свойства

isProtected	Возвращает текущее состояние защиты листа.
source	Источник события. Он может быть локальным или удаленным (с помощью совместного редактирования).
type	Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.
worksheetId	Возвращает идентификатор листа, на котором изменяется состояние защиты.

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

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 + ".");
    });
}

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 + ".");
    });
}