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
)
public void EnsureEnabled (
	boolean ensureModifiable
)
public function EnsureEnabled (
	ensureModifiable : boolean
)
Not applicable.

Parameters

ensureModifiable

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

Exception typeCondition

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.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: