LiveView .NET Client API Documentation

Combined .NET Client API

The documentation for the LiveView and StreamBase .NET Client APIs are combined into a single documentation set. The .NET API documentation is installed only on Windows installations of StreamBase and LiveView.

Click the following link to open the combined .NET Client API documentation:

LiveView and StreamBase .NET Client API Documentation

If you are reading this page in your system browser, and your default browser is Firefox or Internet Explorer version 11, you can use this link with no further steps.

You can also follow this path in the Windows Start menu to open the combined .NET documentation:

    Start(All) ProgramsTIBCOStreamBase n.mStreamBase API DocumentationStreamBase n.m .NET API.

If your default browser is Chrome, Opera, or Internet Explorer 8, 9, or 10 see the next sections for further instructions.

.NET API Documentation in Internet Explorer

If your default browser is Internet Explorer 8, 9, or 10, the .NET documentation requires an extra step:

  1. Click the link above to open the .NET API in Internet Explorer. IE opens the documentation partially and shows a message like following at the bottom of the window:

  2. Click the Allow blocked content button.

    This only allows the use of JavaScript functions that provide the frame resize control, and does not endanger your PC in any way.

This step is not required for most users of Internet Explorer 11.

.NET API Documentation in Chrome or Opera

The combined .NET Client API documentation does not display correctly in recent versions of the Chrome or Opera browsers, both of which are based on the Webkit browsing engine. The Webkit project made the decision to stop supporting any web page that uses HTML frames and is also served from the local file system, instead of from a web server. This prohibition catches the .NET API documentation in its broad sweep.

To continue using a Webkit-based browser, use one of the following workarounds:

  • Start either chrome.exe or Opera's launcher.exe from a command prompt, adding the unsupported --disable-web-security option.

  • Copy the .NET documentation files to a local or department web server.

  • Use Firefox or Internet Explorer 11.

.NET API Documentation Within Studio Help

Studio Help on Windows uses Internet Explorer functionality to display pages, and does so independent of your system's default browser setting. However, Studio Help does not provide a way to see or respond to the Allow blocked content message shown above. Thus, if your system Internet Explorer version is 8, 9, or 10, the display of the .NET documentation within Studio Help may or may not be successful, depending on various system conditions.

To work around this limitation, use the web site version of the documentation by opening the Start menu path described above, or upgrade to the latest Internet Explorer release 11 or later.