SPSolution Members
Include Protected Members
Include Inherited Members
Represents a solution on a farm.
The SPSolution type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SPSolution | Reserved for internal use only. |
Top
Properties
Name | Description | |
---|---|---|
Added | Gets a value specifying whether a language-neutral solution package has been added to this solution. | |
CanSelectForBackup | Gets or sets whether this item can be selected by itself for backup operations. | |
CanSelectForRestore | Gets or sets whether this item can be selected by itself for restore operations. | |
ContainsCasPolicy | Gets a Boolean value that indicates whether the solution contains Code Access Security (CAS) policies. | |
ContainsGlobalAssembly | Returns a value indicating whether the solution contains an assembly that is installed in the global assembly cache. | |
ContainsWebApplicationResource | Gets a value indicating whether the solution contains any web application-specific resources to deploy. | |
Deployed | Returns a value indicating whether the solution is deployed to one or more web applications in the farm. | |
DeployedServers | Gets the collection of servers to which the solution is deployed. | |
DeployedWebApplications | Gets the collection of web applications to which this solution is deployed. | |
DeploymentState | Gets a value indicating whether the solution has been deployed, and if so, whether it has assemblies installed in the global assembly cache, in the application's bin directory, or both. | |
DisplayName | Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.) | |
Farm | The farm on which this solution is installed. | |
Id | Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.) | |
IsWebPartPackage | Gets a value indicating whether the solution represents a Web Part package. Do not use. The concept of a "Web Part package" is obsolete. | |
JobExists | Specifies whether a timer job exists for this SPSolution. | |
JobStatus | Gets the job status that is associated with the language-neutral solution. | |
LanguagePacks | Returns the list of language packages associated with this solution. | |
LastOperationDetails | Returns details of the last operation while deploying the solution. | |
LastOperationEndTime | Returns the date and time that the last operation ended. | |
LastOperationResult | Returns the result of the last operation. | |
Name | Returns the name of the solution. | |
Parent | Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.) | |
Properties | Gets metadata for the persisted object. (Inherited from SPPersistedObject.) | |
SolutionFile | Returns the file associated with the solution. | |
SolutionId | Returns the solution id specified in the manifest file. | |
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.) | |
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) | |
Version | Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.) | |
WasCreated | Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (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 | Deletes the object. (Inherited from SPPersistedObject.) | |
Deploy(DateTime, Boolean, Boolean) | Creates a timer job to deploy the language-neutral solution at a specified time. | |
Deploy(DateTime, Boolean, Collection<SPWebApplication>, Boolean) | Creates a timer job to deploy the language-neutral solution to the specified web applications at a specified time. | |
DeployLocal(Boolean, Boolean) | Deploys the solution to all applications on the local server for trouble-shooting purposes. | |
DeployLocal(Boolean, Collection<SPWebApplication>, Boolean) | Deploys the language neutral solution to the specified web applications on the local server for trouble-shooting purposes. | |
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.) | |
GetLanguagePack | Returns the language pack in the solution for the specified locale identifier. | |
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) | |
GetType | (Inherited from Object.) | |
HasAdditionalUpdateAccess | Override this method to allow more users to update the object. (Inherited from SPPersistedObject.) | |
MemberwiseClone | (Inherited from Object.) | |
OnDeserialization | Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.) | |
Provision | Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.) | |
Retract(DateTime) | Creates a timer job to retract the specified solution at a particular time. | |
Retract(DateTime, Collection<SPWebApplication>) | Creates a timer job to retract the specified solution from the specified web applications at a particular time. | |
RetractLocal() | Retracts the solution from all web applications on the local server for trouble-shooting purposes. | |
RetractLocal(Collection<SPWebApplication>) | Retracts the solution from the specified web applications on the local server for trouble-shooting purposes. | |
Synchronize | Synchronizes the solution on this machine with other machines in the farm. | |
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 changes to the local server that are needed 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, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.) | |
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) | |
Upgrade(String) | Upgrades the solution from a previous version to the current version using the specified solution file. | |
Upgrade(String, DateTime) | Upgrades the solution from a previous version to the current version using the specified solution file, and scheduled to run at a specified time. | |
Validate | Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IBackupRestore.AddBackupObjects | Adds the solution to the backup and restore operation. | |
IBackupRestore.CanRenameOnRestore | Gets whether this item can be renamed at restore time. | |
IBackupRestore.DiskSizeRequired | Gets the disk size required for a backup operation. | |
IBackupRestore.Name | Gets or sets the name of the solution. | |
IBackupRestore.OnAbort | An event that is called in the backup and restore infrastructure when the user cancels the operation. | |
IBackupRestore.OnBackup | An event that is called when the system is being backed up. | |
IBackupRestore.OnBackupComplete | The event that is called when the system is finished with the backup and restore procedure. | |
IBackupRestore.OnPostRestore | The event that is called when the system is finished restoring. | |
IBackupRestore.OnPrepareBackup | The event that is called when the system is preparing a backup operation. | |
IBackupRestore.OnPreRestore | The event that is called when the system is preparing a restore operation. | |
IBackupRestore.OnRestore | The event that is called when the system is being restored. | |
IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration | Gets whether the item can be selectable during configuration-only backup or restore. |
Top