WorkbookBase.ChangeFileAccess(XlFileAccess, Object, Object) Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Changes the access permissions for the workbook. This might require an updated version to be loaded from the disk.

public void ChangeFileAccess (Microsoft.Office.Interop.Excel.XlFileAccess mode, object writePassword, object notify);

member this.ChangeFileAccess : Microsoft.Office.Interop.Excel.XlFileAccess * obj * obj -> unit

Public Sub ChangeFileAccess (mode As XlFileAccess, Optional writePassword As Object, Optional notify As Object)

Parameters

mode: XlFileAccess

One of the XlFileAccess values. Specifies the new access mode.

writePassword: Object

Specifies the write-reserved password if the file is write reserved and Mode is xlReadWrite. Ignored if there is no password for the file or if Mode is xlReadOnly.

notify: Object

true to notify the user if the file cannot be immediately accessed.

Examples

The following code example displays a message if the ReadOnlyRecommended property is true and the ReadOnly property is false, and then prompts the user to set the file access to read-only by calling the ChangeFileAccess method.

This example is for a document-level customization.

private void MakeWorkbookReadOnly()
{
    if (this.ReadOnlyRecommended && !this.ReadOnly)
    {
        // Change the access level of the document to read-only if the user 
        // clicks yes.
        if (MessageBox.Show("Set this document to read-only?",
            "Sample", MessageBoxButtons.YesNo) == DialogResult.Yes)
        {
            this.ChangeFileAccess(Excel.XlFileAccess.xlReadOnly,
                 false);
        }
    }
}

Private Sub MakeWorkbookReadOnly()
    If Me.ReadOnlyRecommended AndAlso Not Me.ReadOnly Then
        ' Change the access level of the document to read-only  
        ' if the user clicks yes.
        If MessageBox.Show("Set this document to read-only?", _
            "Sample", MessageBoxButtons.YesNo) = DialogResult.Yes Then
            Me.ChangeFileAccess(Excel.XlFileAccess.xlReadOnly, Notify:=False)
        End If
    End If
End Sub

Remarks

If you have a file open in read-only mode, you do not have exclusive access to the file. If you change a file from read-only to read/write, Microsoft Office Excel must load a new copy of the file to ensure that no changes were made while you had the file open as read-only.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to

Share via