PropertyGridEditorPart.ApplyChanges Method

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

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

public:
 override bool ApplyChanges();

public override bool ApplyChanges ();

override this.ApplyChanges : unit -> bool

Public Overrides Function ApplyChanges () As Boolean

Returns

Boolean

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

Exceptions

Exception

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

Remarks

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.

Important

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.

See also

• ApplyChanges()
• SyncChanges()
• ASP.NET Web Parts Controls