EncryptionProvider.ShowSettings(Int32, Object, Boolean, Boolean) Method

Reference

Definition

Namespace:: Microsoft.Office.Core

Assembly:: office.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.

Used to display a dialog of the encryption settings for the current document.

public:
 void ShowSettings(int SessionHandle, System::Object ^ ParentWindow, bool ReadOnly, [Runtime::InteropServices::Out] bool % Remove);

public void ShowSettings (int SessionHandle, object ParentWindow, bool ReadOnly, out bool Remove);

abstract member ShowSettings : int * obj * bool * bool -> unit

Public Sub ShowSettings (SessionHandle As Integer, ParentWindow As Object, ReadOnly As Boolean, ByRef Remove As Boolean)

Parameters

SessionHandle: Int32

The ID of the current session.

ParentWindow: Object

Specifies the window that is called to display the encryption settings.

ReadOnly: Boolean

Specifies whether you want the user to be able to change the encryption settings.

Remove: Boolean

If True, the encryption for a document will be removed during the next save operation.

Remarks

This method can only be called on an already encrypted document. You can use this method in your COM add-in to display whatever user experience you like based on the user's missions. For example, in a pure encryption scenario, you can display a dialog box to change the document’s password. In a rights management scenario, you can decide whether to show a dialog box for changing permissions or show the user’s permissions.

Applies to