OISClientLauncher Control

  • Article

Applies to: SharePoint Foundation 2010

An ActiveX control that enables users of Microsoft SharePoint Foundation 2010 to work with the Microsoft Office Picture Manager.

Remarks

This control is defined in the OISCTRL.dll file, a dynamic-link library (DLL) that is installed in the %ProgramFiles%\Microsoft Office\Office14\ directory on the client computer during Microsoft Office Setup.

To instantiate the control, use the following function in ECMAScript (JavaScript, JScript):

var obj = new ActiveXObject('OISCTRL.OISClientLauncher');

In Microsoft Visual Basic Scripting Edition (VBScript), use the following to instantiate the control:

Set obj = CreateObject('OISCTRL.OISClientLauncher')

In both cases, the argument is the programmatic identifier (ProgId) of the control, OISCTRL.OISClientLauncher. For more information about ProgIds, see <ProgID> Key.

In SharePoint Foundation 2010, when a page that contains a view of a picture library opens, code in the IMGLIB.js file determines whether Microsoft Office is installed and, if it is, instantiates the control.

The following Microsoft Visual Basic Scripting Edition code shows the typical use of the control.

Set OISClientLauncher = CreateObject("OISCTRL.OISClientLauncher")
fClientInstalled = IsObject(OISClientLauncher)

if (fClientInstalled = True) Then OISClientLauncher.LaunchOIS(cmdLine)
Set OISClientLauncher = Nothing

In this example, cmdLine is a string. The control verifies that cmdLine is well-formed and safe before it passes it on to OIS.

OIS Command Line Parameters

There are four modes for calling OIS.exe from the command line. The modes take the following parameters:

  • upload folder_url (string)

    Enables a set of images to be uploaded to a folder in the picture library. The folder_url parameter is the path to the folder in the picture library that you want to upload the images to.

  • editSP lib_url (string) id1 (int) id2 (int) …id(n) (int)

    Enables a set of selected pictures from the picture library to be edited. The lib_url parameter specifies the path to the picture library that you are editing, and each id parameter is an integer that corresponds to an image in the picture library that you want to edit.

  • download lib_url (string) id1;id2;…;id(n) (string) jpg (string) 1024x768 (string)

    Enables the selected pictures to be downloaded in a specified size and format. lib_url is the path to the picture library that you are downloading from. id1;id2… are the pictures that you are downloading. jpg is a string that determines the format that you want to convert the images to when you are downloading. 1024 x 768 is a string that is either a number between 1 and 100, which is interpreted to be the percentage of the size of the image, or it is some x-by-y value that determines the size of the image that you want to download.

  • sendto lib_url (string) id1;id2;…;id(n) (string)

    Sends a set of pictures from a picture library to some other application. lib_url is the path to the picture library that the pictures are being sent from. id1;id2… are the pictures that you are sending.