Table 58. Business Component Methods Syntax Summary
Method
|
Description
|
Syntax
|
|
Allows queries to retrieve data for the specified field.
|
Dim oBusComp as BusComp oBusComp.ActivateField fieldName as String
|
|
Allows queries to retrieve data for the fields specified in the property set.
|
Dim oBusComp as BusComp oBusComp.ActivateMultipleFields oPropSet as PropertySet
|
|
Creates a new many-to-many relationship for the parent object through an association business component.
|
Dim oBusComp as BusComp oBusComp.Associate whereIndicator as Integer
|
|
Function that returns the business object that contains the business component.
|
Dim oBusComp as BusComp Dim oBusObject as BusObject Set oBusObject = oBusComp.BusObject
|
|
Clears the current query and sort specifications on the business component.
|
Dim oBusComp as BusComp oBusComp.ClearToQuery
|
|
Deactivates every currently activated field.
|
Dim oBusComp as BusComp oBusComp.DeactivateFields
|
|
Removes the current record from the business component.
|
Dim oBusComp as BusComp oBusComp.DeleteRecord
|
|
Retrieves a set of BusComp records.
|
Dim oBusComp as BusComp oBusComp.ExecuteQuery cursorMode as Integer
|
|
Retrieves a set of BusComp records.
|
Dim oBusComp as BusComp oBusComp.ExecuteQuery2 cursorMode as Integer, ignoreMaxCursorSize as Integer
|
|
Moves to the first record in the business component.
|
Dim oBusComp as BusComp Dim iIsRecord as Integer iIsRecord = oBusComp.FirstRecord
|
|
Moves the focus to the first record of the multiple selection in the business component.
|
Dim oBusComp as BusComp Dim iIsMultipleSection as Integer iIsMultipleSelection = oBusComp.FirstSelected
|
|
Function that returns the association business component.
|
Dim oBusComp as BusComp Dim AssocBusComp as BusComp Set AssocBusComp = oBusComp.GetAssocBusComp
|
|
Function that returns a value for the argument-specified field.
|
Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetFieldValue(FieldName as String)
|
|
Function that returns a formatted value for the argument-specified field.
|
Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetFormattedFieldValue(FieldName as String)
|
|
Returns a value for the fields specified in the property set.
|
Dim oBusComp as BusComp oBusComp.GetMultipleFieldValues oFields as PropertySet, oValues as PropertySet
|
|
Function that returns the MVG business component associated with the argument-specified field.
|
Dim oBusComp as BusComp Dim MvgBusComp as BusComp set MvgBusComp = oBusComp.GetMVGBusComp(FieldName as String)
|
|
Function that returns the argument-named search specification.
|
Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetNamedSearch(SearchName as String)
|
|
Function that returns the pick business component associated with the argument-specified field.
|
Dim oBusComp as BusComp Dim pickBusComp as BusComp Set pickBusComp = oBusComp.GetPicklistBusComp(FieldName as String)
|
|
Function that returns the current search expression.
|
Dim oBusComp as BusComp Dim sExpr as String sExpr = oBusComp.GetSearchExpr
|
|
Function that returns the current search specification for the argument-specified field.
|
Dim oBusComp as BusComp Dim sSpec as String sSpec = oBusComp.GetSearchSpec(FieldName as String)
|
|
Function that returns the value for an argument-specified property name.
|
Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetUserProperty(propertyName as String)
|
|
Function that returns the visibility mode for the business component.
|
Dim oBusComp as BusComp Dim iMode as Integer iMode = oBusComp.GetViewMode
|
|
Calls the specialized method named in the argument.
|
Dim oBusComp as BusComp Dim Return Return = oBusComp.InvokeMethod(methodName as String, methodArgs as String or StringArray)
|
|
Moves to the last record in the business component.
|
Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.LastRecord
|
|
Function that returns the name of the business component.
|
Dim oBusComp as BusComp Dim sName as String sName = oBusComp.Name
|
|
Adds a new record to the business component.
|
Dim oBusComp as BusComp oBusComp.NewRecord(whereIndicator as Integer)
|
|
Moves to the next record in the business component.
|
Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.NextRecord
|
|
Moves to the next record of the current multiple selection.
|
Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.NextSelected
|
|
Function that returns the parent business component.
|
Dim oBusComp as BusComp Dim parentBusComp as BusComp Set parentBusComp = oBusComp.ParentBusComp
|
|
Places the currently selected record in a picklist business component into the appropriate fields of the parent business component.
|
Dim oBusComp as BusComp oBusComp.Pick
|
|
Moves to the previous record in the business component.
|
Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.PreviousRecord
|
|
Refines a query after a query has been executed.
|
Dim oBusComp as BusComp oBusComp.RefineQuery
|
|
Assigns a new value to the named field for the current row of the business component.
|
Dim oBusComp as BusComp oBusComp.SetFieldValue FieldName as String, FieldValue as String
|
|
Accepts the field value in the current local format and assigns the new value to the named field for the current row of the business component.
|
Dim oBusComp as BusComp oBusComp.SetFormattedFieldValue FieldName as String, FieldValue as String
|
|
Assigns a new value to the fields specified in the property set for the current row of the business component.
|
Dim oBusComp as BusComp oBusComp.SetMultipleFieldValues oPropSet as PropertySet
|
|
Sets a named search specification on the business component.
|
Dim oBusComp as BusComp oBusComp.SetNamedSearch searchName as String, searchSpec as String
|
|
Sets the search specification for the business component.
|
Dim oBusComp as BusComp oBusComp.SetSearchExpr searchSpec as String
|
|
Sets the search specification for the specified field.
|
Dim oBusComp as BusComp oBusComp.SetSearchSpec fieldName as String, searchSpec as String )
|
|
Sets the sort specification for a query.
|
Dim oBusComp as BusComp oBusComp.SetSortSpec sortSpec as String
|
|
Sets the value of the specified User Property.
|
Dim oBusComp as BusComp oBusComp.SetUserProperty propertyName as String, newValue as String
|
|
Sets the visibility type for the business component.
|
Dim oBusComp as BusComp oBusComp.SetViewMode viewMode as Integer
|
|
Deletes an active record created by NewRecord.
|
Dim oBusComp as BusComp oBusComp.UndoRecord
|
|
Commits to the database any changes made to the current record.
|
Dim oBusComp as BusComp oBusComp.WriteRecord
|