Export (0) Print
Expand All

WebPartPersonalization.EnsureEnabled Method

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

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public void EnsureEnabled(
	bool ensureModifiable
)

Parameters

ensureModifiable
Type: System.Boolean

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

ExceptionCondition
InvalidOperationException

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

- or -

IsEnabled returned false.

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Show:
© 2015 Microsoft