WorkbookBase.WriteReserved Property

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Gets a value that indicates whether the workbook is write-reserved.

public:
 property bool WriteReserved { bool get(); };

public bool WriteReserved { get; }

member this.WriteReserved : bool

Public ReadOnly Property WriteReserved As Boolean

Property Value

Boolean

true if the workbook is write-reserved; otherwise, false.

Examples

The following code example uses the WriteReserved property to determine whether the current workbook is write-reserved. If the workbook is not write-reserved, then the method sets the WritePassword property to a password obtained through user input. Otherwise, the example uses the WriteReservedBy property to display the name of the user who saved the workbook as write-reserved. This example assumes the existence of a method named GetPasswordFromUserInput that obtains a strong password from user input.

This example is for a document-level customization.

private void SetWritePassword()
{
    if (!this.WriteReserved)
    {
        this.WritePassword = GetPasswordFromUserInput();
    }
    else
    {
        MessageBox.Show("This workbook was saved as Write Reserved." +
            " Please contact " + this.WriteReservedBy + " to add data.");
    }
}

Private Sub SetWritePassword()
    If Not Me.WriteReserved Then
        Me.WritePassword = GetPasswordFromUserInput()
    Else
        MsgBox("This workbook has been saved as Write Reserved." & _
            " Please contact " & Me.WriteReservedBy & " to add data.")
    End If
End Sub

Remarks

Use the SaveAs method to set this property.