Edit

Share via


WebPartPersonalization.EnsureEnabled(Boolean) Method

Definition

Ensures that the WebPartPersonalization instance has completed initialization or that the current user has rights to modify personalization state.

public:
 void EnsureEnabled(bool ensureModifiable);
public void EnsureEnabled (bool ensureModifiable);
member this.EnsureEnabled : bool -> unit
Public Sub EnsureEnabled (ensureModifiable As Boolean)

Parameters

ensureModifiable
Boolean

A Boolean value indicating which type of check should be made.

Exceptions

The current user does not have rights to modify personalization information, or other checks failed.

-or-

IsEnabled returned false.

Remarks

This method is a helper method used in several WebPartPersonalization methods to ensure one of two things:

  • The WebPartPersonalization instance has completed initialization (for example, the Load method was called and successfully completed). This check is made if the ensureModifiable parameter equals false.

    -or-

  • The current user has rights to modify personalization state. This check is made if ensureModifiable equals true.

The WebPartManager control also calls this method in a number of cases:

  • To switch the display mode to something other than normal. The current user must have rights to modify personalization state.

  • To add, delete, or move Web Parts controls. The current user must have rights to modify personalization state.

  • To connect, disconnect, and edit Web Parts controls. The current user must have rights to modify personalization state.

  • To export the Web Parts controls on a page. The WebPartPersonalization instance must have completed initialization.

  • To import Web Parts controls. The current user must have rights to modify personalization state.

Applies to

See also