Export (0) Print
Expand All

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.

  Name Description
Public property IsEndState Gets a Boolean value that indicates whether this is the last step in the scenario.
Public property ScenarioDescription The description of the scenario as specified in the scenario xml file
Public property ScenarioTitle The title of the scenario as specified in the scenario xml file

  Name Description
Public method ClearDataFromSessionState Clears all session state data for the current scenario context.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method 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.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method PersistDataToSessionState Persists the name/value pair to the session state for this scenario context.
Public method RetrieveDataFromSessionState Retrieves data from the session state for this scenario context by using the key.
Public method SessionStateContainsData Determines if the specified key is contained in the scenario context's session state.
Public method ToString (Inherited from Object.)
Public method TransitionToCancelPage Transitions to the cancel state in this scenario context.
Public method TransitionToNextPage Transitions to the next state in this scenario context.
© 2014 Microsoft