LayoutEditorPart.ApplyChanges Method

Definition

Saves the values from a LayoutEditorPart 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

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

Exceptions

An error occurred when setting the value of the ChromeState property on the associated WebPart control.

Remarks

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

Important

You cannot call the ApplyChanges method from your own code. However, if you need more programmatic control over the process of editing various WebPart control properties than the LayoutEditorPart control provides, you can create a custom EditorPart control and provide your own implementation of this method. For an example, see the EditorPart.ApplyChanges method.

The ApplyChanges method attempts to set the following properties on the associated WebPart control:

The ApplyChanges method is called when the user clicks a button representing an OK or an apply verb in the editing user interface (UI).

Applies to

See also