SPFeatureReceiver.FeatureUpgrading Method

Handles the event that is raised when a Feature is upgraded.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

public virtual void FeatureUpgrading(
	SPFeatureReceiverProperties properties,
	string upgradeActionName,
	IDictionary<string, string> parameters
)

Parameters

properties
Type: Microsoft.SharePoint.SPFeatureReceiverProperties

The properties of the event.

upgradeActionName
Type: System.String

The name of the custom upgrade action to execute.

parameters
Type: System.Collections.Generic.IDictionary<String, String>

Parameter names and values for the custom action.

The value of the upgradeActionName can be null if the override of this method implements only one upgrade action.

This method is called during a Feature upgrade when the XML of the Feature contains one or more CustomUpgradeAction tags, as shown in the following example:

<UpgradeActions>
  <CustomUpgradeAction Name="text">
    ...
  </CustomUpgradeAction>
</UpgradeActions>
Show: