How to: Cache data in a password-protected document

Applies to: Visual Studio Visual Studio for Mac

If you add data to the data cache in a document or workbook that is protected with a password, changes to the cached data are not saved automatically. You can save changes to the cached data by overriding two methods in your project.

Applies to: The information in this topic applies to document-level projects for Excel and Word. For more information, see Features available by Office application and project type.

Caching in Word documents

To cache data in a Word document that is protected with a password

1. In the ThisDocument class, mark a public field or property to be cached. For more information, see Cache data.

2. Override the UnprotectDocument method in the ThisDocument class and remove protection from the document.

   When the document is saved, the Visual Studio Tools for Office runtime calls this method to give you an opportunity to unprotect the document. This enables changes to the cached data to be saved.

3. Override the ProtectDocument method in the ThisDocument class and reapply protection to the document.

   After the document is saved, the Visual Studio Tools for Office runtime calls this method to give you an opportunity to reapply protection to the document.

Example

The following code example demonstrates how to cache data in a Word document that is protected with a password. Before the code removes the protection in the UnprotectDocument method, it saves the current ProtectionType value, so that the same type of protection can be reapplied in the ProtectDocument method.

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

private Word.WdProtectionType protectionTypeValue;

protected override void UnprotectDocument()
{
    if (this.ProtectionType != Word.WdProtectionType.wdNoProtection)
    {
        protectionTypeValue = this.ProtectionType;
        this.Unprotect(ref securelyStoredPassword);
    }
}

protected override void ProtectDocument()
{
    this.Protect(protectionTypeValue, ref missing,
        ref securelyStoredPassword, ref missing, ref missing);
}

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

Private protectionTypeValue As Word.WdProtectionType

Protected Overrides Sub UnprotectDocument()
    If Me.ProtectionType <> Word.WdProtectionType.wdNoProtection Then
        protectionTypeValue = Me.ProtectionType
        Me.Unprotect(securelyStoredPassword)
    End If
End Sub

Protected Overrides Sub ProtectDocument()
    Me.Protect(protectionTypeValue, password:=securelyStoredPassword)
End Sub

Compile the code

Add this code to the ThisDocument class in your project. This code assumes that the password is stored in a field named securelyStoredPassword.

Cache in Excel workbooks

In Excel projects, this procedure is necessary only when you protect the entire workbook with a password by using the Protect method. This procedure is not necessary if you protect only a specific worksheet with a password by using the Protect method.

To cache data in an Excel workbook that is protected with a password

1. In the ThisWorkbook class or one of the Sheetn classes, mark a public field or property to be cached. For more information, see Cache data.

2. Override the UnprotectDocument method in the ThisWorkbook class and remove protection from the workbook.

   When the workbook is saved, the Visual Studio Tools for Office runtime calls this method to give you an opportunity to unprotect the workbook. This enables changes to the cached data to be saved.

3. Override the ProtectDocument method in the ThisWorkbook class and reapply protection to the document.

   After the workbook is saved, the Visual Studio Tools for Office runtime calls this method to give you an opportunity to reapply protection to the workbook.

Example

The following code example demonstrates how to cache data in an Excel workbook that is protected with a password. Before the code removes the protection in the UnprotectDocument method, it saves the current ProtectStructure and ProtectWindows values, so that the same type of protection can be reapplied in the ProtectDocument method.

<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);
}

Compile the code

Add this code to the ThisWorkbook class in your project. This code assumes that the password is stored in a field named securelyStoredPassword.

See also

• Cache data
• How to: Cache data for use offline or on a server
• How to: Programmatically cache a data source in an Office document