Partager via

Excel.WorksheetProtectionChangedEventArgs interface

  • Référence
Paquet:
excel

Fournit des informations sur la feuille de calcul qui a déclenché l’événement de status de protection modifié, qui se déclenche lorsque le status de protection est mis à jour dans une feuille de calcul.

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Propriétés

isProtected

Obtient le status de protection actuel de la feuille de calcul.
source

Source de l'événement. Il peut être local ou distant (via la co-création).
type

Obtient le type de l’événement. Pour plus d’informations, consultez Excel.EventType .
worksheetId

Obtient l’ID de la feuille de calcul dans laquelle le status de protection est modifié.

Détails de la propriété

isProtected

Obtient le status de protection actuel de la feuille de calcul.

isProtected: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Exemples

// 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 de l'événement. Il peut être local ou distant (via la co-création).

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

Valeur de propriété

Excel.EventSource | "Local" | "Remote"

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Exemples

// 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

Obtient le type de l’événement. Pour plus d’informations, consultez Excel.EventType .

type: "WorksheetProtectionChanged";

Valeur de propriété

"WorksheetProtectionChanged"

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

worksheetId

Obtient l’ID de la feuille de calcul dans laquelle le status de protection est modifié.

worksheetId: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Exemples

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