Configuring Siebel Open UI > Siebel Open UI Application Programming Interface > Methods of the Siebel Open UI Application Programming Interface >

Applet Class

This topic describes the methods that Siebel Open UI uses with the Applet class. It includes the following information:

• AddClientControl Method
• GetControls Method
• GetName Method for Applets
• GetRecordSet Method
• GetSelection Method

Siebel Open UI defines this class in the applet.js file.

AddClientControl Method

The AddClientControl method adds a control in the client. It returns nothing. It uses the following syntax:

Applet.prototype.AddClientControl = function (ctrlInfo) {
....

}

It includes no arguments.

For an example that uses the GetControls method, see Customizing Methods in the Presentation Model to Store Field Values.

GetControls Method

The GetControls method returns the set of controls that the current applet uses. It returns this set as an object. It uses the following syntax:

GetControls()

It includes no arguments.

For an example that uses the AddClientControl method, see Creating and Managing Client-Side Controls.

GetName Method for Applets

The GetName method that Siebel Open UI uses for applets returns the name of the current applet. It returns this name in a string. It uses the following syntax:

GetName()

It includes no arguments.

For information about the GetName method that Siebel Open UI uses for other classes, see GetName Method for Applet Controls see GetName Method for Application Models.

GetRecordSet Method

The GetRecordSet method returns the current set of records that Siebel Open UI displays in the current applet. It returns these records in an array. It uses the following syntax:

GetRecordSet()

It includes no arguments.

GetSelection Method

The GetSelection method returns the index of the active row of the current record set. It returns this index as a number. It uses the following syntax:

GetSelection()

It includes no arguments.