This topic has not yet been rated - Rate this topic

SPFeatureReceiver.FeatureUpgrading Method

SharePoint 2010

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

Syntax

Copy

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.

Remarks

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:

XML

Copy

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

Reference

SPFeatureReceiver Class

SPFeatureReceiver Members

Microsoft.SharePoint Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ