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

Syntax

'Declaration
Public Overridable Sub FeatureUpgrading ( _
    properties As SPFeatureReceiverProperties, _
    upgradeActionName As String, _
    parameters As IDictionary(Of String, String) _
)
'Usage
Dim instance As SPFeatureReceiver
Dim properties As SPFeatureReceiverProperties
Dim upgradeActionName As String
Dim parameters As IDictionary(Of String, String)

instance.FeatureUpgrading(properties, _
    upgradeActionName, parameters)

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:

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

See Also

Reference

SPFeatureReceiver Class

SPFeatureReceiver Members

Microsoft.SharePoint Namespace