SPPersistedUpgradableObject Members
Include Protected Members
Include Inherited Members
Represents a persisted object that implements the IUpgradable interface.
The SPPersistedUpgradableObject type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SPPersistedUpgradableObject() | Infrastructure. |
.gif "Protected method") |
SPPersistedUpgradableObject(String, SPPersistedObject) | Initializes a new instance of the SPPersistedUpgradableObject class based on the specified name and parent object. |
|
SPPersistedUpgradableObject(String, SPPersistedObject, Guid) | Initializes a new instance of the SPPersistedUpgradableObject class based on the specified name, parent object, and ID. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CanUpgrade | Gets a value that indicates whether the object can be upgraded. |
|
DisplayName | Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.) |
|
Farm | Gets the server farm where the object lives. (Inherited from SPPersistedObject.) |
|
Id | Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.) |
|
Name | Gets or sets the name that identifies a particular instance of the object. (Inherited from SPPersistedObject.) |
|
NeedsUpgrade | Gets or sets a Boolean value that specifies whether the object needs to be upgraded. |
|
NeedsUpgradeIncludeChildren | Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. |
|
Parent | Gets the ID of the parent class that declares the object. (Inherited from SPPersistedObject.) |
|
Properties | Gets a property bag that is used to store properties for the persisted object. (Inherited from SPPersistedObject.) |
|
Status | Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.) |
|
TypeName | Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.) |
|
UpgradeContext | Gets additional upgrade context. |
|
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) |
|
Version | Gets the time that the object was last updated. (Inherited from SPPersistedObject.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Clone | Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.) |
|
Delete | Removes the object from the collection and the server farm. (Inherited from SPPersistedObject.) |
|
Equals | Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.) |
|
Finalize | (Inherited from Object.) |
|
GetChild<T>() | Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.) |
|
GetChild<T>(String) | Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.) |
|
GetHashCode | Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.) |
|
GetObjectData | Retrieves the data required to serialize the object. (Inherited from SPAutoSerializingObject.) |
|
GetType | (Inherited from Object.) |
|
Invalidate | Invalidates computed property values of the IUpgradable interface. |
|
MemberwiseClone | (Inherited from Object.) |
|
OnDeserialization | Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.) |
|
Provision | Makes the necessary changes to the local server to use the object. (Inherited from SPPersistedObject.) |
|
ToString | Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.) |
|
Uncache | Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.) |
|
Unprovision | Makes the necessary changes to the local server to clean up after deleting the object. (Inherited from SPPersistedObject.) |
|
Update() | Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.) |
|
Update(Boolean) | Causes the object to save its state and propagate changes to all the computers in the server farm based on a Boolean value that specifies whether to raise an exception if the object already exists. (Inherited from SPPersistedObject.) |
|
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) |
|
Upgrade() | Upgrades the object. |
|
Upgrade(Boolean) | Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. |
|
Validate | Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.) |
Top