SPSiteSequence members
Abstract class that represents the upgrade sequence for a site collection.
The SPSiteSequence type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
SPSiteSequence | Initializes a new instance of the SPSiteSequence class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
Actions | Gets the actions for the action sequence. (Inherited from SPActionSequence.) |
.gif "Public property") |
Applicable | Obsolete. Reserved for internal use. This property is deprecated. (Inherited from SPSequence.) |
|
ApplicableRootWebTemplate | If this site sequence is only applicable to a special root web template, return the number. otherwise, return 0. |
|
CanUpgrade | Gets a Boolean value that indicates whether the site collection can be upgraded. (Overrides SPSequence.CanUpgrade.) |
|
ContentDatabase | Property for typed upgradable object. |
|
ContentDatabaseConnectionString | Gets the connection string for the content database of the site collection. |
|
ContinueOnFailure | Fail-forward by default for an SPSite. (Overrides SPSequence.ContinueOnFailure.) |
|
HierarchyManager | Gets the SPHierarchyManager object used by the SPSequence object. (Inherited from SPSequence.) |
|
Id | Gets the ID of the sequence. (Inherited from SPSequence.) |
|
IsApplicable | Gets a Boolean that indicates whether the current upgrade sequence should be executed during the upgrade operation based the state of the site collection object. (Overrides SPSequence.IsApplicable.) |
|
IsBackwardsCompatible | Determines whether or not this object is within the backwards compatible range. (Inherited from SPSequence.) |
|
Log | Gets an SPLog object that represents the log of the upgrade session. The upgrade session object can be retrieved by the Session property. (Inherited from SPDelegate.) |
|
Manager | Gets the Microsoft SharePoint Foundation Upgrade Manager. (Inherited from SPDelegate.) |
|
NeedsUpgrade | Gets or sets a Boolean value that specifies whether the sequence object needs an upgrade. (Inherited from SPSequence.) |
|
Object | Gets the delegating object. (Inherited from SPDelegate.) |
|
PlaceHolderSequence | This sequence does not have any upgrade logic (yet) (Inherited from SPSequence.) |
|
SchemaVersion | Gets or sets the schema version of the site collection sequence. |
|
Session | Gets the upgrade session of the delegate. (Inherited from SPDelegate.) |
|
Site | Gets the site collection that is being upgraded by the sequence. |
|
Stopped | Gets or sets a Boolean value that specifies whether the upgrade is stopped. (Inherited from StopEventReceiver.) |
|
TargetCompatibilityLevel | Determines target compatibility level for this site collection based on the site compatibility level and upgrade flags. |
|
TargetSchemaVersion | Gets the target schema version for the site collection upgrade sequence. |
|
Type | Gets the type of the delegate. (Inherited from SPDelegate.) |
|
UpgradableObject | Gets the object of UpgradableObject type which is being upgraded by this sequence. (Inherited from SPSequence.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AddNextLevelObjects | Adds any objects that should be upgraded after the current upgradable object has finished being upgraded. The current upgradable object can be retrieved by the UpgradableObject method. (Inherited from SPSequence.) |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
FinalizeUpgrade | Performs an explicitly called operation to finalize upgrade. (Inherited from SPSequence.) |
|
GetAllVersions | Get the associated version for all SPSiteSequences of this SPSite. |
|
GetHashCode | (Inherited from Object.) |
|
GetProperty | Returns one of the per-sequence properties from the upgrade config files (Inherited from SPSequence.) |
|
GetType | (Inherited from Object.) |
|
GetVersion | Returns the associated site collection version based on the specified ID and default version. |
|
Initialize | Initializes the upgrade sequence for the specified object. (Inherited from SPSequence.) |
|
IsRootWebTemplate | A protected method that determines if the root Web is using a Web template as specified by the templateId parameter. |
|
MemberwiseClone | (Inherited from Object.) |
|
PostUpgrade | Executed by the SharePoint upgrade infrastructure after the IUpgrader.Upgrade method is implemented. (Inherited from SPActionSequence.) |
|
PreUpgrade | Executed by the SharePoint upgrade infrastructure before the IUpgrader.Upgrade method is implemented. (Inherited from SPActionSequence.) |
|
SetPostUpgradeDependencies | By default this object has no post-upgrade dependencies. (Inherited from SPSequence.) |
|
SetPreUpgradeDependencies | By default this object has no pre-upgrade dependencies. (Inherited from SPSequence.) |
|
SetVersion | Sets the version of the site collection sequence within the Versions table of the Microsoft SharePoint Foundation database. |
|
ToString | (Inherited from Object.) |
|
Upgrade | Executes the upgrade logic. (Inherited from SPActionSequence.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
UpdatingProgress | Occurs while the upgrade is in progress. (Inherited from SPActionSequence.) |
Top