<ControlPopupDialog> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyModelView » ControlPopupDialog

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32AddListItemAdds an item to the drop-down list control at the specified index.
int32ClearListItemsClears the list items for the specified drop-down list control.
int32CloseCloses the dialog.
int32GetBoolValueReturns the bool value at the specified index.
uint32GetColorValueReturns the color value at the specified index. Please note that this function returns a uint32, which can be consumed by a color object using the <Color> object's .SetData function. <Color> also has a similar method called .GetData that returns the color value as a packed uint32.
stringGetControlButtonLabelReturns a string containing the control button label.
int32GetControlButtonVisibleReturns true if the control button is visible. Otherwise returns false.
int32GetControlCountReturns the total number of controls in the dialog.
int32GetControlEnabledReturns true if the control is enabled. Otherwise returns false.
stringGetControlIDReturns a string containing the control ID ( Ex: "IDC_COLOR_PICKER" ) at the specified index.
int32GetControlIndexReturns the index of the first control with the specified control identification string.
int32GetCountReturns the total number of controls in the dialog.
int32GetEditReadOnlyReturns true if the control at the specified index is read-only.
floatGetFloat32ValueReturns the <float32> value from the control at the specified index.
floatGetFloat64ValueReturns the <float64> value from the control at the specified index.
int32GetInt32ValueReturns the <int32> value from the control at the specified index.
int64GetInt64ValueReturns the <int64> value at the specified index.
stringGetLabelReturns a string containing the value of the control's label.
int32GetLineSizeThis option is undocumented at present.
int32GetListValueReturns the value of the user-selected item in the drop-down list control item at the specified index. For example, if the drop-down list has four items, this function returns '0' if the user has chosen the first item and '3' if the user has chosen the last item.
stringGetMessageThis option is undocumented at present.
<List>GetObjectListThis option is undocumented at present.
int32GetOkButtonEnabledReturns true if the OK button is enabled.
int32GetPageSizeThis option is undocumented at present.
doubleGetRangeMaxFloat32Returns the range maximum value from the control at the specified index.
doubleGetRangeMaxFloat64Returns the range maximum value from the control at the specified index.
int32GetRangeMaxInt32Returns the range maximum value from the control at the specified index.
int64GetRangeMaxInt64Returns the current <int64> range maximum value of the specified control.
stringGetRangeMaxLabelReturns a string containing the text label of the maximum value.
uint32GetRangeMaxUint32Returns the range maximum value from the control at the specified index.
uint64GetRangeMaxUint64Returns the current <uint64> range maximum value of the specified control.
doubleGetRangeMinFloat32Returns the range minimum value from the control at the specified index.
doubleGetRangeMinFloat64Returns the range minimum value from the control at the specified index.
int32GetRangeMinInt32Returns the range minimum value from the control at the specified index.
int64GetRangeMinInt64Returns the current <int64> range maximum value of the specified control.
stringGetRangeMinLabelReturns a string containing the minimum value label text.
uint32GetRangeMinUint32Returns the range minimum value from the control at the specified index.
uint64GetRangeMinUint64Returns the current <uint64> range maximum value of the specified control.
int32GetSliderValueReturns the value of the <int32> control at the specified index.
stringGetStringValueReturns the string value of the control at the specified index.
stringGetTitleReturns a string containing the dialog's title text.
uint32GetUint32ValueReturns the value at the specified index.
uint64GetUint64ValueReturns the <uint64> value of the specified control.
stringGetValueLabelReturns a string containing the value label at the specified index.
int32InsertColorControlInserts a control at the specified index.
int32InsertFloat32ControlInserts a <float32> control at the specified index.
int32InsertInt32ControlInserts an <int32> control at the specified index.
int32InsertInt64ControlInserts a control at the specified index.
int32InsertListControlInserts a control at the specified index.
int32InsertSliderControlInserts a control at the specified index.
int32InsertStringControlInserts a control at the specified index.
int32InsertUint32ControlInserts a <uint32> control at the specified index.
int32InsertUint64ControlInserts a control at the specified index.
int32RemoveAllControlsRemoves all controls from the dialog.
int32RemoveControlRemoves the control at the specified index.
int32RemoveListItemRemoves a list item from the control at the specified index.
int32SetCallbackSets the callback functions used by this dialog. For example, a callback can be evaluated when a value in the dialog is changed.
int32SetColorValueSets the value of the color at the specified index.
int32SetControlButtonLabelSets the control button label text.
int32SetControlButtonVisibleSets the control button at the specified index visible or invisible.
int32SetControlEnabledEnables or disables the control at the specified index.
int32SetEditModelInfoConnects the dialog to the EditModelInfo system for editing action management during modeless operation.
int32SetEditReadOnlyEnables or disables the read-only state of the control at the specified index.
int32SetFloat32ValueSets the <float32> value at the specified control index.
int32SetFloat64ValueSets the <float32> value at the specified control index.
int32SetInt32ValueSets the <int32> value at the specified control index.
int32SetInt64ValueSets the <int64> value at the specified index.
int32SetLabelSets the control label at the specified index.
int32SetLineSizeThis option is undocumented at present.
int32SetListValueSets the index value of the list at the specified index.
int32SetMessageThis option is undocumented at present.
int32SetObjectListThis option is undocumented at present.
int32SetOkButtonEnabledThis option is undocumented at present.
int32SetPageSizeThis option is undocumented at present.
int32SetRangeFloat32Sets the range of the control at the specified index.
int32SetRangeFloat64Sets the range of the control at the specified index.
int32SetRangeInt32Sets the range of the control at the specified index.
int32SetRangeInt64Sets the range of values for the control at the specified index.
int32SetRangeMaxLabelSets the range maximum label.
int32SetRangeMinLabelSets the range minimum label.
int32SetRangeUint32Sets the range of the control at the specified index.
int32SetRangeUint64Sets the range of values for the control at the specified index.
int32SetSliderValueSets the value of the slider at the specified index. Slider values are always stored as <int32> values, and you must perform the appropriate conversion when using sliders for floating point values.
int32SetStringValueSets the string value at the specified index.
int32SetTitleSets the dialog title text.
int32SetUint32ValueSets the <int32> value at the specified control index.
int32SetUint64ValueSets the <int64> value at the specified index.
int32SetValueLabelSets the value label at the specified index.
int32ShowShows the dialog as a modeless control. This means you can set focus to the dialog and then return to the user interface.
int32ShowModalShows the dialog as a modal control. This means that you must click OK or hit ENTER to dismiss the dialog before you can access the user interface again.