Siebel Object Interfaces Reference > Siebel VB Quick Reference >

Application Methods for Siebel VB


Table 47 lists a summary of the Application methods' syntax.

Table 47. Application Methods Syntax Summary
Method
Description
Syntax

ActiveBusObject Method

Returns the business object for the business component of the active applet.

Dim oApplication as Application
Dim oBusObject as BusObject
Set oBusObject = oApplication.ActiveBusObject

ActiveViewName Method

Function that returns the name of the active view.

Dim oApplication as Application
Dim sView as String
sView = oApplication.ActiveViewName

CurrencyCode Method

Returns the three-letter operating currency code.

Dim oApplication as Application
Dim sCur as String
sCur = oApplication.CurrencyCode

GetBusObject Method

Instantiates and returns a new instance of the argument-specified business object.

Dim oApplication as Application
Dim oBusObject as BusObject
set oBusObject = oApplication.GetBusObject busobject as String

GetProfileAttr Method

Returns the value of an attribute in a user profile.

Dim oApplication as Application
Dim sAttr as String
SAttr = oApplication.GetProfileAttr(name as String)

GetService Method

Instantiates and returns a new instance of the argument-specified service.

Dim oApplication as Application
Dim oService as Service
set oService = oApplication.GetService(serviceName as String)

GetSharedGlobal Method

Gets the shared user-defined global variables.

Dim oApplication as Application
Dim sName as String
sName = Application.GetSharedGlobal(varName as String)

GotoView Method

Activates the named view and its business object.

Dim oApplication as Application
oApplication.GotoView viewName as String, [BusinessObjectName as BusObject]

InvokeMethod Method

Calls the named specialized method.

Dim oApplication as Application
Dim sReturn as String
sReturn = oApplication.InvokeMethod(methodName as String, methodArgs as String or StringArray)

LoginId Method

Function that returns the login ID of the user who started the Siebel application.

Dim oApplication as Application
Dim sID as String
iID = oApplication.LoginId

LoginName Method

Function that returns the login name of the user who started the Siebel application.

Dim oApplication as Application
Dim sUser as String
sUser = oApplication.LoginName

NewPropertySet Method

Constructs and returns a new property set object.

Dim oApplication as Application
Dim oPropSet as ProperySet
oPropSet = oApplication.NewPropertySet()

PositionId Method

Function that returns the position ID that describes the user's current position.

Dim oApplication as Application
Dim sRow as String
sRow = oApplication.PositionId

PositionName Method

Function that returns the position name of the user's current position.

Dim oApplication as Application
Dim sPosition as String
sPosition = oApplication.PositionName

RaiseError Method

Raises a scripting error message to the browser. The error code is a canonical number.

Dim oApplication as Application
oApplication.RaiseError keyValue as String, parma1 as String, ...

RaiseErrorText Method

Raises a scripting error message to the browser. The error text is the specified literal string.

Dim oApplication as Application
oApplication.RaiseErrorText message as String

SetPositionId Method

Sets the active position to the position ID specified in the argument.

Dim oApplication as Application
oApplication.SetPositionId posId as string

SetPositionName Method

Sets the active position to the position name specified in the argument. Returns a Boolean value indicating whether or not method succeeded.

Dim oApplication as Application
oApplication.SetPositionName posName as string

SetProfileAttr Method

Used in personalization to assign values to attributes in a user profile.

Dim oApplication as Application
oApplication.SetProfileAttr name as String, value as String

SetSharedGlobal Method

Sets a shared user-defined global variable.

Dim oApplication as Application
oApplication.SetSharedGlobal varName as String, value as String

Trace Method

Appends a message to the trace file.

Dim oApplication as Application
oApplication.Trace message as String

TraceOff Method

Turns off the tracing started by TraceOn.

Dim oApplication as Application
oApplication.TraceOff

TraceOn Method

Turns tracing on.

Dim oApplication as Application
oApplication.TraceOn filename as String, type as String, selection as String

Table 48 lists a summary of the Application Events.

Table 48. Application Events Summary
Event
Description
Syntax

Application_Close Event

Called before the application exits.

Application_Close

Application_Navigate Event

Called after the client has navigated to a view.

Application_Navigate

Application_InvokeMethod Event

Called after a specialized method is invoked.

Application_InvokeMethod(methodName as String)

Application_PreInvokeMethod Event

Called before a specialized method is invoked.

Application_PreInvokeMethod(methodName as String)

Application_PreNavigate Event

Called before the client has navigated from one view to the next.

Application_PreNavigate (DestViewName As String, DestBusObjName As String)

Application_Start Event

Called when the client starts.

Application_Start(commandLine as String)

Siebel Object Interfaces Reference