$root.$iwindows.WINDOW.$objs.Headed List Box

Parent: $root.$iwindows.WINDOW.$objs
 
Children 

Class notation

Properties Methods Events 

A headed list box is a type of window field that displays data from a list variable in a table format. You can add button style headers to each column of the list on which the user can click to sort the data. You can also make the columns sizeable, and set other properties that control its appearance.

Properties

Object specific 
$boldheaderIf true, the heading has a bold font
$borderradiusRadius for rounded border corners.1 to 4 pixel values separated by -,in order topleft,topright,bottomright,bottomleft.If bottomleft is omitted it is topright.If bottomright is omitted it is topleft.If topright is omitted it is topleft
$buttonstyleThe drawing style of a button:kSystemButton,kUserButton,kNoBorderButton,kHeadingButton,kComboButton,kRoundButton,kLargeRoundButton, or kIDEButton.For headed and tree lists,it is the style of the header button: kSystemButton or kUserButton
kSystemButton kUserButton
$calculationThe calculation used to format the variable for display
$candragdisplayorderIf true,and $enableheader is also true,the user can drag and drop a column in the header,to change $displayorder
$canresizecolumnsIf true, the user can use the mouse to resize the columns of the object
$colcountReturns the number of columns in the list
$columnalignmodeControls how $setcolumnalign affects the control. One of kAlignModeAll,kAlignModeBody, kAlignModeHeading and kAlignModeFooter
kAlignModeAll kAlignModeBody kAlignModeFooter kAlignModeHeading kAlignModeNone
$columnnamesThe names of the columns
$columnscontextmenuA comma separated list of the column numbers to be enabled in the heading context menu. The menu allows the user to show and hide the columns specified by this property. If left empty,there is no menu
$columnsvisibleA comma separated list of numeric flags,indicating which columns are visible. A value of 1 means the column is visible, and a value of 0 means the column is invisible
$columnwidthsComma separated list of column widths,expressed in pixels
$contentlinecolorThe color of lines drawn in the content of the control.kColorDefault means draw dotted lines.All other values mean draw single pixel lines of the specified color
$contentsThe current contents of the object
$defaultwidthThe default width of a column
$disablecolumntooltipsIf true, automatic column tooltips are disabled for the headed list.Unless this property is set to kTrue,the headed list automatically generates a tooltip for a column if the text for the column is too long to fully display
$disableellipsisIf ($cobj.$disableellipsis|$clib.$prefs.$disableellipsis) window instance headed list boxes,and tree lists with more than one column,do not draw an ellipsis when the displayed value is truncated due to insufficient space
$disablehottrackingIf true,the control does not draw any highlighting to show that the mouse is over the main body of the control but not pressed
$displayorderComma separated list of column numbers,indicating the order in which columns are displayed by the headed list.Initially set to 1,2,...,$colcount.Reset to the initial value whenever you change the number of columns
$dropbetweenlinesIf true, the object highlights between lines during drag and drop
$enableheaderIf true, the headings can be clicked on
$fieldstylefocusedThe style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus
$firstselThe number of the first selected character or line in the current contents
$firstvisThe number of the first visible character or line in the contents
$footerA row containing the contents of the footer of the headed list box.#NULL if $footer has not been assigned
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$headerfillcolorThe fill color for the grid or headed list box header
$headerfontsizeThe font size for the text in the header;if this is zero,the header text font size is $fontsize
$headertextcolorThe text color for the header
$hidefooterIf true,the footer is hidden
$hideheaderIf true, the heading is hidden
$hilitelineIf true, the object highlights lines during drag and drop
$hiliteonecolColumn number for highlight. If greater than zero, the column with this number is the only highlighted column when a line is selected. To highlight whole lines when selected, set this property to zero
$lastselThe number of the final selected character or line in the current contents
$lastvisThe number of the final fully visible character or line in the contents
$linebackgroundcolIf non-zero,the column number in the dataname list that contains color values that override the default background color of each line (the value zero or kColorDefault in this column means use the normal background color for the line)
$linehtextraThe number of extra pixels added to the height of each line
$maxeditcharsThe maximum number of characters allowed when editing the text for an icon, or headed list box column; zero means editing is not allowed
$multipleselectIf true, the field allows the user to select more than one line
$resizecolumnThe column number of the column that is resized appropriately when the width of the control changes. Zero means no column is resized, and the last column extends if necessary
$rowbuttonsSlide out row buttons for the left of right sides of the list
$selectionbackcolorThe color of selected lines. kColorDefault means use the default color. When not kColorDefault only applies when the control has the focus
$selectiontextcolorThe text color of selected lines. kColorDefault means use the default color. When not kColorDefault applies irrespective of whether the control has the focus
$showcolumnlinesIf true, the control displays lines between columns
$showcolumnslinesifemptyIf true, the list is empty and $showcolumnlines is true, the column lines will be always be shown
$showheaderlinesIf true,the control displays lines between column headers
$showrowlinesIf true, row lines will be shown
$studioideIf true,the control draws in a platform independent IDE style
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
Standard$active $align $alpha $backcolor $backgroundtheme $backpattern $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $dataname $disablefocus $disablefontsizekeys $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $horzscroll $hscroll $hwnd $ident $keyevents $left $linestyle $local $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $textcolor $tooltip $top $userinfo $vertscroll $visible $vscroll $width

Methods

Object specific 
$autosizecolumn$autosizecolumn(iColumnNumber) resizes iColumn to the maximum width of the text in iColumn given every row
$columnheaderstyle$columnheaderstyle(iColumnNumber[,summedStyleConstants]) sets or gets the additional styles to apply to the column header of the specified column
$edittext$edittext(iColumnnumber[,bSetCurrentField=kFalse]) invokes in place text editing for the specified column on the current line of the headed list box when it is the current field or if bSetCurrentField is kTrue, if the line is selected
$getcolumnalign$getcolumnalign(iColumnNumber) gets the column alignment for the specified column
$getedittext$getedittext(iLine,iColumn[,bStripTextEscapes=kTrue]) gets the text to edit from the specified line and column, in a headed list box
$sendevent$sendevent(iEvent[,eventParameters...]) Sends event iEvent (an ev... constant value) to the object with eventParameters passed as name,value pairs, for example $sendevent(evClick,'pLineNumber',2).Returns kFalse if the event is discarded
$setcolumnalign$setcolumnalign(iColumnNumber,[kLeftJst|kRightJst|kCenterJst]) sets the column alignment for the specified column
$setrowbuttons$setrowbuttons(bLeftIcon[,cIcnID,iBackTintColor,bDisabled,cTooltip]) Modify left or right row buttons.Call with 1 parameter to remove all left or right buttons.Call with 2 or more parameters to add a button with SVG icon id cIcnID
$setsortcolumn$setsortcolumn(iColumnnumber,bDescending) sets the sort column for the headed list,and whether the direction is ascending or descending.This controls the drawing of the sort arrow.To clear the sort column,pass zero in iColumnnumber
$showpanel$showpanel(iAction[,iMode=kSidePanelModeAuto]) executes kSidePanelAction... on a side panel object. iMode only applies to kSidePanelActionShow,and must be kSidePanelModeCover/Push/Auto. For JS client,$showpanel must be executed on the client
Standard$redraw

Events

Object specific 
evIconDeleteFinishedSent to an icon array when all selected lines have been deleted
Parameters
pEventCodeThe event code
evIconDeleteStartingSent to an icon array when the selected lines are about to be deleted
Parameters
pEventCodeThe event code
evIconEditFinishedSent to an icon array when new edit text has been stored in the array
Parameters
pEventCodeThe event code
pLineNumberThe line number in the list
evIconEditFinishingSent to an icon array before new edit text is stored in the array
Parameters
pEventCodeThe event code
pLineNumberThe line number in the list
pNewTextThe new text entered by the user
evIconEditStartingSent to an icon array when the text is about to be edited
Parameters
pEventCodeThe event code
pLineNumberThe line number in the list
evWillHideSent to a field before it is hidden. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
evWillShowSent to a field before it becomes visible. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
StandardevAfter evBefore evCanDrop evClick evClipChangedData evDisabled evDoubleClick evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evHScrolled evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evVScrolled evWillDrop

Children

Top 

$methods