Excel.WorksheetProtectionChangedEventArgs interface

  • Référence
Paquet:
excel

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

Remarques

[Ensemble d’API : ExcelApi 1.14 ]

Propriétés

allowEditRangesChanged

Indique si l’un des AllowEditRange objets a changé.
isProtected

Obtient l’état de protection actuel de la feuille de calcul.
protectionOptionsChanged

Spécifie si les changements WorksheetProtectionOptions ont été faits.
sheetPasswordChanged

Spécifie si le mot de passe de la feuille de calcul a changé.
source

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

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

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

Détails de la propriété

allowEditRangesChanged

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Indique si l’un des AllowEditRange objets a changé.

allowEditRangesChanged: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

isProtected

Obtient l’état 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) {
    await Excel.run(async (context) => {
        // This method is an event handler that returns the protection status of a worksheet and information about the changed worksheet.
        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

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si les changements WorksheetProtectionOptions ont été faits.

protectionOptionsChanged: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

sheetPasswordChanged

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si le mot de passe de la feuille de calcul a changé.

sheetPasswordChanged: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

source

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

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) {
    await Excel.run(async (context) => {
        // This method is an event handler that returns the protection status of a worksheet and information about the changed worksheet.
        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 Excel.EventType plus d’informations, voir.

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 l’état de protection est modifié.

worksheetId: string;

Valeur de propriété

string

Remarques

[Ensemble d’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) {
    await Excel.run(async (context) => {
        // This method is an event handler that returns the protection status of a worksheet and information about the changed worksheet.
        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 + ".");
    });
}