PropertyGridEditorPart.ApplyChanges Method

Note: This method is new in the .NET Framework version 2.0.

Saves the values from a PropertyGridEditorPart control to the corresponding properties in the associated WebPart control.

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

public:
virtual bool ApplyChanges () override
public boolean ApplyChanges ()
public override function ApplyChanges () : boolean

Return Value

true if the action of saving values from the PropertyGridEditorPart to the WebPart is successful; otherwise (if an error occurs), false.

Exception typeCondition

Exception

An error occurred when trying to set the value for a property on the associated WebPart.

The ApplyChanges method is a critical method on a PropertyGridEditorPart control. The method saves the values a user has set on a PropertyGridEditorPart control to the corresponding properties in the associated WebPart control. The associated control is referenced in the PropertyGridEditorPart control's inherited WebPartToEdit property.

NoteImportant:

You cannot override the ApplyChanges method because the PropertyGridEditorPart type is sealed to prevent inheriting from it. However, if you need more programmatic control over the process of editing various WebPart control properties than the PropertyGridEditorPart control provides, you can create a custom EditorPart control and provide your own implementation of this method. For a code example, see the ApplyChanges method.

The ApplyChanges method attempts to set the values on public custom properties in the associated WebPart control, provided that those properties each have a [WebBrowsable(true)] attribute.

The ApplyChanges method is called when the user clicks a button representing an OK or an apply verb in the editing user interface (UI). You can also call it directly from your own code if there is a need to save the edited values apart from user actions.

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: