IWorkbookSession Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines dependency-free methods and properties to interact with a workbook model that has been loaded in a SharePoint farm.
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("c4a79a5d-c3fb-4d20-b40d-1fc8ef626832")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IWorkbookSession : IDisposable
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("c4a79a5d-c3fb-4d20-b40d-1fc8ef626832")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IWorkbookSession = interface
interface IDisposable
Public Interface IWorkbookSession
Implements IDisposable
- Attributes
- Implements
Properties
| ConnectionStyle |
Gets a value indicating how client libraries are expected to communicate with the Analysis Services database hosting the loaded workbook model. |
| Database |
Gets the name of the Analysis Services database containing the loaded workbook model. |
| Server |
Gets the name of the Analysis Services instance containing the loaded workbook model. |
| SessionId |
Gets the Excel Services session identifier for the current workbook model connection. |
| UserName |
Gets the user name as per the SharePoint context |
| WorkbookFormatVersion |
Gets the file format version of the loaded workbook. |
| WorkbookPath |
Gets the absolute path of the workbook within the SharePoint farm. |
Methods
| BeginActivity() |
Signal that a query or other action is in progress and that Excel Services should not time out the session. |
| CreateManagedStream() |
Get a managed Stream that can be used to communicate with the AS instance hosting the current session's model. |
| CreateNativeStream() |
Gets a native IStream that can be used to communicate with the AS instance hosting the current session's model. |
| EndActivity() |
Signal that activity has ceased (for the moment) and that Excel Services is free to time out the session. |
| EndSession() |
Signal that the caller is permanently releasing interest in the session and will not resume activity. |
| EnsureValidSession() |
Ensures that the session is valid. |
| GetWorkbookConnections() |
Get the names of the embedded connections. |
| Log(TraceLevel, String) |
Adds a trace entry to the log. |
| Log1(TraceLevel, String, String) |
Adds a trace entry to the log. |
| Log2(TraceLevel, String, String, String) |
Adds a trace entry to the log. |
| Log3(TraceLevel, String, String, String, String) |
Adds a trace entry to the log. |
| Log4(TraceLevel, String, String, String, String, String) |
Adds a trace entry to the log. |
| Refresh(String, String) |
Execute a shallow refresh of the workbook model's data sources using credentials that have been cached in a given Secure Store target application. |
| RefreshEmbeddedModel() |
Do a shallow refresh of the embedded model. This is only needed when working against O14 models |
| ReportQueryExecution(Int32, String) |
Reports a query execution. |
| Save() |
After refresh, save the workbook back into SharePoint. |
| TraceError(String, Object[]) |
Write an error to the ULS log. |
| TraceVerbose(String, Object[]) |
Write a verbose message to the ULS log. |
| TraceWarning(String, Object[]) |
Write a warning to the ULS log. |