Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

ddHiCreateCellComboField

ddHiCreateCellComboField(
?name s_fieldName 
[ ?prompt t_fieldPrompt ] 
[ ?value t_currentValue ]
[ ?defValue t_defaultValue ] 
[ ?callback g_callback ]
[ ?editable g_editable ]
[ ?enabled g_enabled ]
[ ?invisible g_invisible ]
[ ?nextField g_nextField ]
[ ?toolTip t_toolTip ] 
[ ?validationType g_validationType ] 
[ ?highlightType g_highlightType ] 
) 
=> r_comboField

Description

Creates a customized Cell combo field, which is an extension of a regular combo field, for selecting cells.

Arguments

?name s_fieldName

The handle to this field within a form. To reference it, use formHandle-><fieldName>

?prompt t_fieldPrompt

  

A string specifying the prompt for the field. To reference it, use formHandle-><fieldName>->prompt

?value t_currentValue

  

The initial and current values of this field. To reference it, use formHandle-><fieldName>->value

?defValue t_defaultValue

  

The default value of the field. This value is equal to the initial entry in t_currentValue, if t_defaultValue is not specified. To reference the default value, use formHandle-><fieldName>->defValue

?callback g_callback

  

A string, symbol, or function object type callback that is executed if the value of the field changes. If a new value is typed in, the callback is called when the field has “lost focus”. This happens for example, when you move the pointer outside the form, or tab to another field, or when you select any button in the form.

  • If a new value is selected from the drop-down list, then the callback is called immediately, not when the field loses focus.
  • If the callback is of string type, you can specify one or more SKILL functions or even multiple SKILL statements that get executed when the value of the field changes.

?editable g_editable

  

If set to nil, the field is read-only; setting g_editable to t makes the field editable.

?enabled g_enabled

  

Specifies whether the field is enabled. The default value is t.

?invisible g_invisible

  

Specifies whether the field is invisible. The default value is nil.

?nextField g_nextField

  

Symbol or string indicating the next field to bring into focus when the Tab key is pressed. If you specify nil or do not specify this argument, the Tab traversal order is determined by the tabOrderIsAddOrder argument of hiCreateAppForm or hiCreateScrollRegion. If the tabOrderIsAddOrder argument is not set or if its value is nil, the default traversal order is based on the form layout —left-to-right and top-to-bottom— beginning with the field at the top-left corner of the form.

?toolTip t_toolTip

  

The tool tip that is displayed when the pointer hovers over the field.

?validationType g_validationType

  

Specifies the criteria that determines if the input is valid or not. Acceptable values (symbol) are:

  • allowAny: No restriction on input type.
  • allowExisting (default): Allow existing unfiltered data returned by (DDPI) generator.
  • allowNew: Allow data other than the return value of (DDPI) generator.

?highlightType g_highlightType

  

Specifies when and how a widget is to be highlighted. Acceptable values (symbol) are:

  • background
  • highlight
  • error
  • highlightInvalidText (default)

The first three values have the same definitions as given for the g_highlighType argument of hiHighlightField.

Setting the property to highlightInvalidText turns on automatic highlighting, which highlights the widget when an invalid input is entered. The validity of the input is determined based on the setting of the validationType property.

Value Returned

r_comboField

The cell combo field.

Examples

A Cell combo field is created.

trCreateBlockCellName = ddHiCreateCellComboField(
    ?name 'cellName
    ?prompt "Cells"
    ?defValue ""
    ?value ""
    ?callback "trCreateBlockCellNameCB( trCreateBlockForm 'cellName )"
)

Related Topic

Form and Field Functions

ddHiLinkFields


Return to top
 ⠀
X