Siebel Control - Properties, Methods, and Events

Descriptions of properties, methods, and events for the following Siebel controls are shown in the tables below.

 

Siebel List Control

Properties

Description

Siebel.DisplayRows (get)

Shows the number of rows displayed.

Siebel.Columns (get)

Shows the number of columns in the table.

Siebel.Rows (get)

Shows the number of rows in the table.

Siebel.ActiveRow (get)

Shows the current active row.

 

 

Methods

Description

Siebel.GetCellValue

Gets the current cell value from the specified cell.

Siebel.GetCellEditValue

Gets the current cell added value (the Link Value).

Siebel.GetHeading

Gets the specified column heading. Specify the column by the integer index value.

Siebel.GetHeadings

Gets an array of all column headings.

Siebel.GetColumnFromHeading

Gets the column number for the specified column header value.

Siebel.LineUp

Moves the current active row up by one.

Siebel.LineDown

Moves the current active row down by one.

Siebel.PageUp

Moves the displayed rows up one page.

Siebel.PageDown

Moves the displayed rows down one page.

Siebel.SetCellValue (3 args)

Sets the value of a control in a cell.

Siebel.SetCellValue (5 args)

Sets the actual value of a cell.

Siebel.CellPerformClick

Clicks on a cell based on alignment (left, right and center).  

Siebel.CellLinkPerformClick

Clicks on a cell containing a link. Delineated the cell by the row and column. Specify the row and column by their index integer value.

Siebel.CellShowPopup

Opens the pop-up window associated with a cell delineated by the row and column. Specify the row and column by their index integer value.

Siebel.SetActiveCell

Sets the current active cell.

 

 

Events

Description

Siebel.ActiveRowChanging

Occurs after the click but before the active row changes.

Siebel.ActiveRowChanged

Occurs after the active row changes.

Siebel.AfterFirstLine

Occurs under these conditions:

  • After scrolling to the very first line in a Siebel list.

  • Clicking the scroll bar when the current row is the absolute first row in the list.

  • Dragging the scroll bar away from the first row then restoring it back to its original position without releasing mouse.

Siebel.AfterLastLine

Occurs under these conditions:

  • After scrolling to the very last line in a Siebel list.

  • Clicking the scroll bar when the current row is the absolute last row in the list.

  • Dragging the scroll bar away from the last row then restoring it back to its original position without releasing mouse.

Siebel.AfterLineDown

Occurs after the line has moved down.

Siebel.AfterLineUp

Occurs after the line has moved up.

Siebel.AfterPageDown

Occurs after the page has moved down.

Siebel.AfterPageUp

Occurs after the page has moved up.

Siebel.BeforeFirstLine

Occurs immediately before scrolling to the very first line in a Siebel list. This would occur by moving the vertical scroll bar all the way to the top most position.

Siebel.BeforeLastLine

Occurs immediately before scrolling to the very last line in a Siebel list. This would occur by moving the vertical scroll bar all the way to the bottom most position.

Siebel.BeforeLineDown

Occurs after the click but before the line is moved down.

Siebel.BeforeLineUp

Occurs after the click but before the line is moved up.

Siebel.BeforePageDown

Occurs after the click but before the page has moved down.

Siebel.BeforePageUp

Occurs after the click but before the page has moved up.

Siebel.CellClick

Occurs after the cell is clicked.

Siebel.CellLinkClick

Occurs after the cell link is clicked.

Siebel.CellControlGotFocus

Occurs after the control gains focus.

Siebel.CellControlLostFocus

Occurs when the focus is removed from a control.

Siebel.CellControlPopupDisplayed

Occurs when a popup window is displayed.

Siebel.ClickingCell

Occurs after the click but before the cell is clicked.

Siebel.ClickingCellLink

Occurs after the click but before the cell link is clicked.

Siebel.ColumnSorted

Occurs after the column is sorted.

Siebel.SelectedIndexChanged

Occurs if the content of a combo box has changed.

Siebel.SortingColumn

Occurs after the click but before the column is sorted.

 

Siebel Navigation Control

Methods

Description

Siebel.Navigate

Navigates controls. Clicks on pages associated with the designated control.

 

Events

Description

Siebel.Navigated

Occurs once Siebel has been navigated.

Siebel.Navigating

Occurs as Siebel is navigating.

 

Siebel General Control

Properties

Description

Siebel.Format (get)

Shows the format that the control uses (usually a text box.)

Siebel.IsNull (get)

Lets you know if the value of the control is null.

Siebel.Text (get, set)

Shows or sets the text for a control.

Siebel.MaxLength (get)

Shows the maximum length of a control’s value. Until a control has been focused, the MaxLength property does not return a valid value. Once focus has been set to the control the first time, the property returns the correct value every time thereafter.

Siebel.ReadOnly (get)

Shows if a value is editable.

 

Methods

Description

Siebel.Focus

Sets the focus on a control.

Siebel.RemoveFocus

Removes the focus from a control.

 

Events

Description

Siebel.Focusing

Occurs after a click and before a control is focused.

Siebel.GotFocus

Occurs after a control is focused.

Siebel.LosingFocus

Occurs after a click and before the focus of a control is lost.

Siebel.LostFocus

Occurs after a control has lost focus.

Siebel.DisplayingPopup

Occurs after a click but before a pop-up window has displayed.

Siebel.PopupDisplayed

Occurs after a pop-up window has displayed.

 

Note: The controls below extend from the general control and contain all the methods, properties, and events that are available to the general control.

Currency Control

Methods

Description

Siebel.SetValue (1 arg)

Sets the value of the control, as determined by the existing format.

Siebel.SetValue (2 args)

Sets the value of the control and specifies the format.

Siebel.GetValue

Gets the value of the control.

Siebel.ShowPopup

Shows the selected pop-up window.

Siebel.HidePopup

Hides the selected pop-up window.

 

Date Time Picker

Methods

Description

Siebel.SetDate (1 arg)

Sets the value of the date, as determined by the existing format. The date format used corresponds to the System.DateTime.ToString method. Each DateTime control will vary, depending on how it is set up in Siebel. 

See this website for examples:

http://msdn.microsoft.com/en-us/library/az4se3k1.aspx

Siebel.SetDate (2 args)

Sets the value of the date and the format. The date format used corresponds to the System.DateTime.ToString method. Each DateTime control will vary, depending on how it is set up in Siebel.

See this website for examples:

http://msdn.microsoft.com/en-us/library/az4se3k1.aspx

Siebel.GetDate

Gets the value of the Date/Time picker.

Siebel.ShowPopup

Shows the selected pop-up window.

Siebel.HidePopup

Hides the selected pop-up window.

 

Multi Value Control

Methods

Description

Siebel.ShowPopup

Shows the selected pop-up window.

 

Numeric Control

Methods

Description

Siebel.SetValue (1 arg)

Sets the value of the numeric control using the existing format.

Siebel.SetValue (2 args)

Sets the value of the numeric control and the format.

Siebel.GetValue

Gets the value of the selected numeric control.

Siebel.ShowPopup

Shows the selected pop-up window.

Siebel.HidePopup

Hides the selected pop-up window.

 

Pick List Control

Methods

Description

Siebel.ShowPopup

Shows the selected pop-up window.

 

 

Checkbox Control

Properties

Description

Siebel.Checked

Gets and sets the Checked property.

 

Related information

Interrogating Nav Items

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 21 September 2022

© 2016 - 2022 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label