Object Types Reference > Siebel Object Types >

List Column


Siebel Object Types > Applet > List > List Column

Associates one list column to a list applet. Lists and list columns are usually created and edited in the Applet Designer.

You can add user properties to list columns.

Properties

Property
Description/Usage
Valid Values/Examples
Available (O)
A TRUE or FALSE value.
If Available = FALSE, the list column does not show up in the list or the Columns Displayed dialogue window. See also Show In List (O).
The list column can be shown in a list applet.
Available - Language Override (O)
A TRUE or FALSE value.
Provides the ability to change the list column can be associated with a list applet when a particular language/locale is active.
Same as for available property.
Bitmap Column Heading (O)*
A TRUE or FALSE value that is used only for Boolean list columns that specify a value for the Check Bitmap Identifier.
TRUE = The bitmap specified in the Check Bitmap Identifier will be displayed as the list column heading.
FALSE = The normal name/display name will be used as the list column heading.
Check Bitmap Identifier (O)*
The bitmap to display in the TRUE state if the list column is of the type CheckBox.
 
Content Fixup Name (O)
Determines if the links and images within the HTML page should be "fixed-up" to be proxied through the Siebel server (Inside Application) or left alone to be requested by the client's browser directly (Outside Application).
 
Detail Applet (O)
An applet that displays related information for the field specified by the list column from the same business component.
 
Display Format (O)
The format mask to apply to the data.
Example: $#,###,###,###.
Display Name (O)
Either the value to use as the list column heading or the key to the international message table.
Example: Expected Value.
Field (O)
The field for which the list column is displaying data.
Example: Amount Expected Value.
Field Retrieval Type (O)
Specifies that the field data is either rich content HTML data (Field Data), a standard reference to a web page (URL), or a specially constructed URL integrating data taken from the Siebel database and supporting the external content service (Symbolic URL).
 
HTML Attribute (O)
Can be used to add HTML tag attributes to the HTML tag that the HTML client framework creates to render a list column.
Only works in Standard Interactivity.
Used with the Siebel Web Engine.
 
HTML Display Mode (O)
Used with controls that are field values. Controls how the field value is displayed.
Used with the Siebel Web Engine.
Valid values are:
  • DontEncodeData = Field value shown as in the database.
  • EncodeData = This is the default. Any markup language reserved characters in the field data are encoded so as to render them correctly.
  • FormatData = In addition to encoding markup language reserved characters, the field value will be formatted using the markup language as it is formatted in the database— for example, when HTML is the markup language. newlines in the data are replaced with <br> tags, and contiguous white spaces are replaced with &nbsp.
HTML Height (O)
Height of list column in pixels in the HTML thin client.
 
HTML Height - Language Override (O)
Provides the ability to change the height of list column in pixels in the HTML thin client when a particular language/locale is active.
 
HTML Icon Map (O)
Can be set to an icon map object. Used to map field values to icons as defined in the icon map.
Used with the SWE Engine.
Example: CHECK.
HTML List Edit (O)
A TRUE or FALSE value.
Used with the Siebel Web Engine.
TRUE = This control is shown as a data input control (if the control allows updates) when rendering the applet in the Edit List mode. This is the DEFAULT.
FALSE = Will be shown as read-only.
HTML Max Chars Displayed (O)
The maximum number of characters to be displayed in a list column.
Only applies when the parent applet is in base mode or the list column is read only. Property does not limit the number of characters that can be entered into a text control in edit mode.
 
HTML Max Chars Displayed - Language Override (O)
Provides the ability to change the maximum number of characters displayed in a list column when a particular language/locale is active.
 
HTML Only (O)
A TRUE or FALSE value.
Used with the Siebel Web Engine.
TRUE = The control is used only in the HTML thin client.
FALSE = The control is also used in the dedicated client.
HTML Row Sensitive (O)
Causes the Web engine to position the applet on the current record before invoking the method defined in the Method Invoked property.
Used with the Siebel Web Engine.
Examples of methods that require this to be set to TRUE are EditRecord, DeleteRecord, and Drilldown.
HTML Sequence (O)
The (order) position of this list column relative to other list columns in the applet in the HTML thin client. Indicates tab sequence.
 
HTML Sequence - Language Override (O)
Provides the ability to change the (order) position of this list column relative to other list columns in the applet in the HTML thin client when a particular language/locale is active.
 
HTML Type (O)
Defines how the list column is to be rendered. If not set, will use the Type property.
Used with the Siebel Web Engine.
Example: CheckBox.
HTML Width (O)
The width of the list column in pixels in the HTML thin client.
 
HTML Width - Language Override (O)
Provides the ability to change the width of the list column in pixels in the HTML thin client when a particular language/locale is active.
 
Inactive (O)
A TRUE or FALSE value.
TRUE = Removes the list column from compilation, as described in Properties with Consistent Meanings. Additionally, the list column is no longer visible in the applet or available to the user in the Columns Displayed dialog box. However, the user can still execute a previously saved QBE that uses the deactivated column, provided that the QBE was created while the list column was still active and visible.
MVG Applet (O)
The applet to use for the pop-up MVG if the field for the list column is a multi-value field and the Runtime property is set to TRUE for the list column.
 
Name (R)
The name of the list column.
 
Pick Applet (O)
The applet to use for the pop-up picklist if the field for the list column has a picklist specified and the Runtime property is set to TRUE.
This property (and corresponding applet) is ignored for list columns based on fields with static picklists, with one exception: it will be used for picklists that have the Long List property set to TRUE.
 
Popup Edit (O)*
A TRUE or FALSE value that, if TRUE, specifies that an ordinary text field requires a pop-up edit box.
 
Prompt Text (O)
Not used.
Not applicable.
Read Only (O)
A TRUE or FALSE value.
If the underlying field has a property setting of Read Only = TRUE, the list column is also read-only even if the list column's Read Only property is FALSE.
TRUE = Prevents data from being edited.
Runtime (O)
A TRUE or FALSE value.
TRUE = Makes a run-time check to see if a picklist, calculator, calendar, or MVG pop-up button will be provided.
FALSE = It is assumed that there is no picklist or MVG or that the field is Date or Time in DateTime.
Sequence (R)*
The position of this list column in the list.
Integer value.
Sequence - Language Override (O)*
Provides the ability to change the position of this list column in the list when a particular language/locale is active.
Integer value.
Show In List (O)
A TRUE or FALSE value.
If Show In List is FALSE and Available is TRUE, the list column will not be visible in the applet unless the user selects it from the Columns Displayed dialogue window.
TRUE = The list column is shown in a list.
Show In List - Language Override (O)
Provides the ability to change the list column is shown in a list when a particular language/locale is active.
 
Show Popup (O)
A TRUE or FALSE value.
TRUE = Specifies that a new browser window is opened before invoking the method.
FALSE = Specifies that the method is invoked in the same browser window.
Text Alignment (O)
The text alignment of the list column.
Valid values are Left, Center, and Right.
Text Alignment - Language Override (O)
Provides the ability to change the text alignment of the list column when a particular language/locale is active.
 
Total Currency Code Expression (O)
The currency of the total value. Can be used to display the list column total in a converted currency.
For example, an opportunity with a currency code of dollars might have two products, one with a price in YEN and the other in USD. The list total could show the total product prices in the currency of the opportunity if the list column's Total Currency Code Expression were set to the following:
Parent: 'Opportunity.Currency Code'.
Total Required (O)
A TRUE or FALSE value.
This property also requires the Total Required property to be set on the list object definition.
TRUE = The list column is totaled.
FALSE = The list column is not totaled.
Type (O)*
The list column type.
Valid values are CheckBox or TextBox.
Width (O)*
The list column width.
 
Width - Language Override (O)*
Provides the ability to change the list column width when a particular language/locale is active.
 

See Also

Applet
List
Hidden Object Types and Properties

For information about user properties, read Siebel Tools Reference.


 Object Types Reference 
 Published: 18 April 2003