WorkbookBase.ProtectDocument (Método)

Artículo
08/10/2011

Lo llama Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office para que pueda aplicar de nuevo la protección con contraseña al libro una vez guardados los datos almacenados en la memoria caché.

Espacio de nombres: Microsoft.Office.Tools.Excel
Ensamblado: Microsoft.Office.Tools.Excel.v4.0.Utilities (en Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Sintaxis

'Declaración
Protected Overridable Sub ProtectDocument

protected virtual void ProtectDocument()

Comentarios

Invalide este método en un proyecto en el nivel del documento para Excel si el libro se protege utilizando una contraseña y contiene datos almacenados en memoria caché que se podrían cambiar en tiempo de ejecución. En la implementación de este método, utilice el método Protect para proteger el libro.

De forma predeterminada, los cambios efectuados en los datos almacenados en la memoria caché de un libro protegido mediante contraseña no se conservan cuando se guarda el libro. Para guardar los cambios efectuados en los datos almacenados en la memoria caché, debe invalidar los métodos siguientes en el proyecto:

UnprotectDocument. Una vez que el libro se ha guardado, Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office llama a este método. Agregue código a este método que desproteja el libro temporalmente. Esto permite guardar los cambios efectuados en los datos almacenados en la memoria caché.
ProtectDocument. Una vez que el libro se ha guardado, Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office llama a este método. Agregue código a este método que vuelva a aplicar la protección al libro.

Para obtener más información, vea Cómo: Almacenar datos en caché en un documento protegido por contraseña.

Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office llama al método ProtectDocument aun cuando los datos almacenados en memoria caché no pudieron guardarse debido a algún error no relacionado con la protección con contraseña. Por ejemplo, si implementa la interfaz ICachedType para personalizar cómo se guardan en la memoria caché los datos del documento, se llama al método ProtectDocument incluso si la implementación ICachedType produce una excepción que evita que se guarden los datos almacenados en la memoria caché.

Ejemplos

En el ejemplo de código siguiente se muestra cómo invalidar el método ProtectDocument para volver a aplicar la protección que se quitó invalidando el método UnprotectDocument. Para utilizar este código, ejecútelo desde la clase ThisWorkbook en un proyecto en el nivel del documento para Excel. El código da por supuesto que la contraseña está almacenada en un campo denominado securelyStoredPassword.

<CachedAttribute()> _
Public CachedString As String = "This string is cached in the workbook."

Private protectStructureValue As Boolean
Private protectWindowsValue As Boolean

Protected Overrides Sub UnprotectDocument()
    protectStructureValue = Me.ProtectStructure
    protectWindowsValue = Me.ProtectWindows

    Me.Unprotect(securelyStoredPassword)
End Sub

Protected Overrides Sub ProtectDocument()
    Me.Protect(securelyStoredPassword, protectStructureValue, _
        protectWindowsValue)
End Sub

[CachedAttribute]
public string CachedString = "This string is cached in the workbook.";

private bool protectStructureValue;
private bool protectWindowsValue;

protected override void UnprotectDocument()
{
    protectStructureValue = this.ProtectStructure;
    protectWindowsValue = this.ProtectWindows;

    this.Unprotect(securelyStoredPassword);
}

protected override void ProtectDocument()
{
    this.Protect(securelyStoredPassword, protectStructureValue,
        protectWindowsValue);
}

Seguridad de .NET Framework

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.