SPScenarioContext members
Provides a context object for interacting with the administrator scenario framework by providing methods to persist session data and enable transitions across various states in the scenario.
The SPScenarioContext type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
IsEndState | Gets a Boolean value that indicates whether this is the last step in the scenario. |
|
ScenarioDescription | The description of the scenario as specified in the scenario xml file |
|
ScenarioTitle | The title of the scenario as specified in the scenario xml file |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
ClearDataFromSessionState | Clears all session state data for the current scenario context. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
.gif "Static member") |
GetContext | Static method to get the SPScenarioContext object associated with the specified page for the specified culture. If a context object does not yet exist, one is initialized and stored in the session-state object. |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
PersistDataToSessionState | Persists the name/value pair to the session state for this scenario context. |
|
RetrieveDataFromSessionState | Retrieves data from the session state for this scenario context by using the key. |
|
SessionStateContainsData | Determines if the specified key is contained in the scenario context's session state. |
|
ToString | (Inherited from Object.) |
|
TransitionToCancelPage | Transitions to the cancel state in this scenario context. |
|
TransitionToNextPage | Transitions to the next state in this scenario context. |
Top