This is documentation of an archived release.
For documentation on the current version, please check Knowledge Base.
For documentation on the current version, please check Knowledge Base.
Getting Started
Getting started with the Orbit Web Client SDK for .Net:
- Install the Adobe Flash Player. Make sure you install the ActiveX player for Internet Explorer.
- Copy the Orbit Web Client SDK to your system. This includes the 'Orbit.dll' and 'webclient_api.swf' files.
- Create a new “Windows Form Application” and save it.
- Copy the 'webclient_api.swf' file to the 'bin\Debug' and 'bin\Release' directories of the new application.
- Add the “Orbit.dll” to the references of the new application.
- Add the “Orbit Web Client” user control to the toolbox. Use “Choose Items…” to browse to the 'Orbit.dll' file. The “Orbit Web Client” component should be added to the toolbox.
- Drag the 'Orbit Web Client' user control from the toolbox to the application form. Change the name from 'orbitWebClient1' to 'orbitWebClient'.
- Add a 'start' button to the form. Change the name to 'startButton' and the text to 'start'.
- Add a 'test' button to the form. Change the name to 'testButton' and the text to 'test'.
- Add a textbox to the form. Change the name to 'textBox'.
- Edit the 'Form1.cs' class (not the 'Form1.Designer.cs' class). Implement the 'OrbitWebClientContainer' interface.
- Define the 'click' method for the 'start' button (double-click the button). Call the 'InitializeOrbit' method of the Orbit Web Client component. This will start the loading of the 'webclient_api.swf' flash component in the background. When ready the Orbit Web Client will call the 'ProcessOrbitReady' callback method.
- The 'SetDebug(true)' method can be called to show debug messages to the debug console.
- Inside the 'ProcessOrbitReady' callback method you can add event listeners and load a publication. Call the 'SetServer', 'SetCredentials' and 'LoadPublication' methods. This finishes the loading of the Orbit application and the user can start interacting with the Orbit Web Client component.
- Define the 'click' method for the 'test' button. You can call some Orbit methods and display the results in the textbox. Refer to the sample application.
The ActiveX flash object sometimes fails to load when using the debugger.
Try the following: go to the property pages of the project, select the 'Debug' tab, and uncheck the 'Enable the Visual Studio hosting process' checkbox.
Try the following: go to the property pages of the project, select the 'Debug' tab, and uncheck the 'Enable the Visual Studio hosting process' checkbox.
Last modified:: 2019/03/25 11:36