1. Object Types Reference
  2. List Column

List Column

A list column associates one list column to a list applet. You can add user properties to a list column. For more information about controls, see the topic about field data types in Configuring Siebel Business Applications. For information about user properties, see Siebel Developer's Reference.

This object type occurs in the following location in the object hierarchy:

The following table describes properties that Siebel CRM uses with a list column.

Property Description

Available (O)

If FALSE, then Siebel CRM does not display the list column in the list or in the Columns Displayed dialogue box. For more information, see the description of the Show In List property for this list column.

Available - Language Override (O)

Specifies to use this column with a list applet if a language or locale is active.

Bitmap Column Heading (O)(H)

You can use one of the following values:

  • TRUE. Display the bitmap specified in the Check Bitmap Identifier property as the list column heading.

  • FALSE. Display the normal name and display name in the list column heading.

You can use this property only in a Boolean list column that specifies a value for the Check Bitmap Identifier property.

Check Bitmap Identifier (O)(H)

Specifies the bitmap that Siebel CRM displays in the TRUE state if this list column is a CheckBox list column.

Content Fixup Name (O)

Specifies to use the Siebel Server or the client browser to do fixup. This fixup allows Siebel CRM to display links and images in the HTML page. For more information, see Siebel Portal Framework Guide.

Detail Applet (O)

Specifies the applet that Siebel CRM uses to display related data for the field that the list column from the same business component specifies.

Display Format (O)

Specifies the format mask that Siebel CRM applies to the data. For example:

$#,###,###,###

Display Name (O)

Specifies the value that Siebel CRM uses as the list column heading or the key to the international message table. For example:

Expected Value

Field (O)

Specifies the field that provides the data that the list column displays. For example:

Amount Expected Value

Field Retrieval Type (O)

Specifies that the field data is one of the following:

  • Rich content HTML data (Field Data)

  • A predefined reference to a Web page (URL)

  • A specially created URL that integrates data from the Siebel database and the external content service (Symbolic URL)

HTML Attribute (O)

Specifies to add HTML tag attributes to the HTML tags that the client creates to display the list column.

HTML Display Mode (O)

Specifies the display mode that Siebel CRM uses with a control that displays a field value. You can use one of the following values:

  • EncodeData. Encode any reserved characters in the markup language that exist in the field data so that it displays correctly.

  • FormatData. Encode any reserved characters in the markup language that exist in the field data so that it displays correctly. Format the field value using the markup language using the same format that the Siebel database uses. For example, if HTML is the markup language, then do the following:

    • Replace a newline with a br tag.

    • Replace contiguous white space with &nbsp.

HTML Height (O)

Specifies the height of this list column in pixels in the Siebel Web Client.

HTML Height - Language Override (O)

Specifies the height of this list column in pixels in the Siebel Web Client if a language or locale is active.

HTML Icon Map (O)

Specifies to map field values to icons that the icon map defines. For example:

CHECK

HTML List Edit (O)

You can use one of the following values:

TRUE. If the applet displays in the Edit List mode, then display this control as a data input control.

FALSE. Display this control as a read-only control.

HTML Max Chars Displayed (O)

Specifies the maximum number of characters that Siebel CRM displays in a list column. This property applies only if the parent applet is in Base mode, or if the list column is read only. It does not limit the number of characters that the user can enter in a text control in edit mode.

HTML Max Chars Displayed - Language Override (O)

Specifies the maximum number of characters that Siebel CRM displays in a list column if a language or locale is active.

HTML Only (O)

If TRUE, then Siebel CRM uses the control only in the Siebel Web Client.

HTML Row Sensitive (O)

Specifies to position the applet on the current record before calling the method that the Method Invoked property specifies. The following methods are examples that require you to set the HTML Row Sensitive property TRUE:

  • EditRecord

  • DeleteRecord

  • Drilldown

HTML Sequence (O)

Specifies the position of this list column relative to other list columns that Siebel CRM displays in the applet in the Siebel Web Client.

HTML Sequence - Language Override (O)

Specifies the position of this list column relative to other list columns that Siebel CRM displays in the applet in the Siebel Web Client if a language or locale is active.

HTML Type (O)

Specifies how to display the list column. If this property is empty, then Siebel CRM uses the value that the Type property specifies.

HTML Width (O)

Specifies the width of the list column in pixels in the Siebel Web Client. The maximum value is 2048.

HTML Width - Language Override (O)

Specifies the width of the list column in pixels in the Siebel Web Client if a language or locale is active.

MVG Applet (O)

Specifies the applet that Siebel CRM uses to display the pop-up multivalue group if the properties of this list column are set as follows:

  • The Field property references a multivalue field.

  • The Runtime property is TRUE.

Name (R)

Specifies the name of this list column.

Pick Applet (O)

Specifies the applet that Siebel CRM uses to display the pop-up picklist if the properties of this list column are set as follows:

  • The Field property references a multivalue field.

  • The Runtime property is TRUE.

If this list column references a field that contains a static picklist, then Siebel CRM ignores this property. The only exception to this configuration occurs if the Long List property of this picklist is TRUE.

Popup Edit (O)(H)

If TRUE, then a text field uses a pop-up edit box.

Prompt Text (O)

For more information, see Configuring the Prompt Text Property of a Control or List Column.

Read Only (O)

If TRUE, then the user cannot edit data. If the Read Only property of the field that the Field property of this list column references is TRUE, then this list column is read-only even if the Read Only property of this list column is FALSE.

Runtime (O)

You can use one of the following values:

  • TRUE. Display a pop-up button at run time for a picklist, calculator, calendar, or multivalue group.

  • FALSE. Do not display a pop-up button at run time. Siebel CRM assumes there is no picklist or multivalue group or that the field is a date or time field.

Sequence (R)(H)

Specifies the position of this list column in the list. This property can contain only an integer. For more information, see Configuring the Sequence Property of a List Column to Import Records.

Sequence - Language Override (O)(H)

Specifies the position of this list column in the list if a language or locale is active. This property can contain only an integer.

Show In List (O)

If TRUE, then Siebel CRM displays this list column in a list.

If the Show In List property is FALSE, and if the Available property of this list column is TRUE, then Siebel CRM does not display list column in the applet unless the user chooses it from the Columns Displayed window.

Show In List - Language Override (O)

Specifies the list column that Siebel CRM displays in a list if a language or locale is active.

Show Popup (O)

You can use one of the following values:

  • TRUE. Open a new browser window before calling the method.

  • FALSE. Call the method in the same browser window.

Text Alignment (O)

Specifies the text alignment of this list column.

Text Alignment - Language Override (O)

Specifies the text alignment of the list column if a language locale is active. You can use one of the following values:

  • Center

  • Left

  • Right

Text-Alignment Label (O)

Specifies to align the text of the list column label on a list applet.

Text Alignment-Label - Language Override (O)

Specifies the Text-Alignment Label property for a list column if a language or locale is active. Siebel CRM applies this configuration automatically for a locale that reads right-to-left, such as Japanese. You can use one of the following values:

  • Center

  • Left

  • Right

Total Currency Code Expression (O)

Specifies the currency that Siebel CRM uses to display the total value. You can use this property to display the list column total in a converted currency. For example, assume an opportunity that uses dollars as the currency code includes two products. One product is priced with YEN and the other product is priced in USD. To display the list total in these currencies, you set the Total Currency Code Expression to the following value:

Parent: 'Opportunity.Currency Code'

Total Required (O)

You can use one of the following values:

  • TRUE. Create a total value of all the values that this list column displays. You must also set the Total Required property of the list object definition to TRUE.

  • FALSE. Do not create a total value.

Type (O)(H)

Specifies the list column type.

Width (O)(H)

Specifies the list column width.

Width - Language Override (O)(H)

Specifies the list column width if a language or locale is active.