Programmer's Guide TList 8 ActiveX Control Bennet-Tec Information Systems, Inc. This manual was produced using ComponentOne Doc-To-Help. Contents Bennet-Tec Information Systems, Inc.............................................................................1 Software License Agreement: Use and Distribution.................................................1 List of Custom Controls..........................................................................................iii Contact Information................................................................................................iv Introduction....................................................................................................................5 Control features........................................................................................................5 New Features (Version 8.0)......................................................................................8 License Registration.................................................................................................8 License Registration Questions and Answers................................................................10 On-Line Help.........................................................................................................12 Distribution Notes..................................................................................................12 Technical Support..................................................................................................14 Features and programming techniques.......................................................................... 15 TList features and programming techniques............................................................15 Backward Compatibility................................................................................................16 Color Support...............................................................................................................17 Design-Time Support...................................................................................................18 Display Features..........................................................................................................18 Expanding and Collapsing the Outline...........................................................................20 Hiding TList Items........................................................................................................20 Grid Support................................................................................................................21 Internet Interfaces........................................................................................................22 Keyboard Interface.......................................................................................................22 Navigating the List -Choosing an Indexing Scheme......................................................24 Objects and Object Collections.....................................................................................27 Picture, Selection and Double-Byte Characters Support................................................29 Visual Elements and Hot Spots.....................................................................................31 How to Add or Delete Items..........................................................................................32 How to Boost Performance...........................................................................................33 How to Specify Default Properties.................................................................................34 How to Specify and Work with Associated Hidden Data.................................................35 How to Work with Virtual Items.....................................................................................36 How to Use TList Grids for Column/Table Data.............................................................37 How to Work with Databases........................................................................................43 How to Use Tree Buffers to Manipulate the Tree...........................................................46 How to Support DragDrop............................................................................................47 How to Sort or Search a Tree.......................................................................................51 How to Sort a Grid........................................................................................................51 How to Access the Clipboard........................................................................................52 How to Save and Load Lists -File I/O...........................................................................53 How to Use Cell / Item Editing......................................................................................54 How to Use Bookmarks................................................................................................65 How to Assign Categories -TList Mark Support.............................................................66 How to Control the Display of Plus/Minus Pictures.........................................................66 How to Upgrade an Old TList 3/Pro OCX Project to Use New TList OCX.......................67 How to Upgrade an Old VBX Based Project to Use TList OCX in Place of the VBX...................................................................................................................67 How To Detect the Version Number Of TList.................................................................69 How to Trap Right Mouse Clicks...................................................................................69 Programmer's Guide TList 8 ActiveX Control Contents • iii How to Navigate a Web Site with TList..........................................................................69 How to Print With TList.................................................................................................70 How to Use TList’s RTF Support...................................................................................72 How to Use the VisualRoot Property.............................................................................72 How to Use LevelDefs for Sorting.................................................................................73 How to Use TListNodes and TListNode Objects............................................................74 How to Use IntelliMouse Functionality...........................................................................74 How To Resize Rows And Columns..............................................................................75 How to Use ToolTips....................................................................................................75 How to Copy from one TList to Another.........................................................................76 How to Smoothly Scroll Tall Items.................................................................................76 How to Support Excel Style Navigation While Editing....................................................76 TList Diagrams (Objects, Functionality And Relationships)....................................77 TListTreeView features and programming techniques............................................83 MSTreeView and TListTreeView compatibility...............................................................83 TListTreeView and TList...............................................................................................84 Using the TDesigner application.............................................................................88 TDesigner Layout.........................................................................................................89 Design-Time Mode buttons...........................................................................................90 Using TDesigner Windows...........................................................................................92 Specifying TDesigner Defaults......................................................................................93 Using Clipboard...........................................................................................................93 Using Drag/Drop..........................................................................................................94 Printing........................................................................................................................95 Hints for Web Site Designers........................................................................................96 Setting up ToolTips......................................................................................................99 Selecting Colors...........................................................................................................99 Setting up Pictures.....................................................................................................102 Modifying Tree Line Settings......................................................................................105 Specifying Drag Drop Settings....................................................................................106 Controlling Selection..................................................................................................106 Controlling Expanding/Collapsing...............................................................................107 Controlling Text Display..............................................................................................108 Controlling Fonts........................................................................................................110 Controlling Marks.......................................................................................................111 Associating Additional Data with an Item.....................................................................112 Specifying Sorting Method..........................................................................................113 Controlling Miscellaneous Settings.............................................................................114 Controlling Item Cell Default Settings..........................................................................115 Setting up Background...............................................................................................116 Specifying Scrollbar Appearance................................................................................117 Setting up Item And Grid Cell Borders.........................................................................118 Setting up Item And Grid Cell Alignment.....................................................................118 Specifying Virtual Items..............................................................................................118 Setting up Item Visibility.............................................................................................118 Setting up Item And Grid Cell Tag...............................................................................119 Setting up LevelDefs..................................................................................................119 Specifying a Tree Grid................................................................................................119 Specifying Item Grids.................................................................................................119 Properties You Cannot Set with TDesigner.................................................................119 Objects reference.........................................................................................................121 Introduction.........................................................................................................121 TList Object.........................................................................................................123 TListCellDef Object.............................................................................................137 TListCheckBox Object.........................................................................................139 TListColDef Object..............................................................................................140 TListColDefs Object Collection...........................................................................141 TListComboBox Object.......................................................................................141 TListComboItem Object.......................................................................................142 iv • Contents Programmer's Guide TList 8 ActiveX Control TListComboItems Object.....................................................................................144 TListDataObject Object........................................................................................145 TListDataObjectFiles Object................................................................................146 TListDateTime Object..........................................................................................147 TListEditInfo Object............................................................................................148 TListEditingChangeInfo Object............................................................................148 TListGrid Object..................................................................................................149 TListGridCell Object............................................................................................152 TListLevelDef Object...........................................................................................153 TListLevelDefs Object Collection........................................................................154 TListNode Object.................................................................................................154 TListNodes Object Collection..............................................................................156 TListReport Object...............................................................................................156 TListPage Object..................................................................................................158 TListPages Object Collection...............................................................................159 TListSpinObject..................................................................................................159 TListTextBox Object............................................................................................160 TListValue Object................................................................................................161 TListValues Object Collection.............................................................................162 TListSelectedGridCells Object.............................................................................162 TListSelectedGridColumns Object.......................................................................163 TListSelectedGridRows Object............................................................................163 TListRowDefs Object...........................................................................................164 TListRowDef Object............................................................................................164 TVWSelectedNodes Object Collection (TListTreeView)......................................165 TListPoint Object.................................................................................................166 TListRectangle Object..........................................................................................166 TListShowTooltipArgs Object..............................................................................167 TListTooltip Object..............................................................................................167 TListTooltipStyle Object......................................................................................168 TListTooltipWindow Object.................................................................................169 Properties, events, methods, functions reference..........................................................171 AbortWindowStyle and AbortWindow Properties.................................................171 AboutProperty.....................................................................................................171 Activatable Property (TListCellDef Object)..........................................................172 Activate Method (TListGrid object)......................................................................173 ActivationMode Property (TListGrid object)........................................................174 ActiveGrid Property.............................................................................................176 ActiveCell Property (TListGrid object).................................................................176 ActiveRow Property (TListGrid object)................................................................177 Add and SafeAdd Methods (TListComboItems Object)........................................177 Add Method (TListSelectedGridCells, TListSelectedGridColumns and TListSelectedGridRows Objects)...................................................................178 AddProperty........................................................................................................179 Add Method (TListNode/TlistNodes objects).......................................................180 Add Method (TVWSelectedNodes Object)...........................................................181 AddAfter Method.................................................................................................181 AddItem Method..................................................................................................182 AddItem2 and AddItem2Ex Methods...................................................................184 AddRow Method..................................................................................................185 AfterEditing Event...............................................................................................186 Programmer's Guide TList 8 ActiveX Control Contents • v AlignProperty......................................................................................................188 AllowResizing Property.......................................................................................188 Appearance Property............................................................................................189 Appearance Properties (TListCheckbox Object)...................................................189 AutoDragComplete Event....................................................................................190 AutoDragRequest Event.......................................................................................191 AutoDragMode Property......................................................................................192 AutoExpand Property...........................................................................................192 AutoFillColTitles and AutoFillRowTitles Properties............................................193 AutoNewPage Property........................................................................................194 AutoScrDuringDragDrop Property.......................................................................194 AutoSizeRow Method, AutoSizeColumn Method.................................................195 AutoSizeOptions Property....................................................................................196 BackColor and DefItemCellBackColor Property...................................................197 BackColor and SelBackColor Properties (TListNode Object)...............................198 BackColorBkg Property.......................................................................................198 BackPicture and BackPictureAlignment Properties...............................................198 BackwardCompatible Property.............................................................................199 BeforeDrag Method..............................................................................................199 BeforeItemDeactivate, BeforeGridRowDeactivate and BeforeGridCellDeactivateEvents.........................................................................200 BeginPage Event..................................................................................................203 BorderColor and DefItemCellBorderColor Properties...........................................203 BorderStyleand DefItemCellBorderStyle Properties.............................................204 BorderStyle Property (TListGrid Object)..............................................................205 BottomIndex Property..........................................................................................206 Caption Property..................................................................................................206 CellDef Property..................................................................................................207 CellEdit Property..................................................................................................207 Cells Property......................................................................................................208 CellValue Property (TListComboItem Object)......................................................208 CheckBox Property (TListEditInfo Object)...........................................................209 CheckboxValue Property......................................................................................210 CheckedPicture, UncheckedPicture and GrayedPicture Properties (TListCheckbox Object).......................................................................................210 CheckedValue, UncheckedValue and GrayedValue Properties (TListCheckbox Object).......................................................................................211 Children Property (TListNode Object)..................................................................212 ChildrenCount Property (TListNode Object)........................................................213 Col and Row Properties (TListGridCell object)....................................................213 Col and Row Properties (TListGrid object)...........................................................213 ColDefs Property..................................................................................................214 ColDelimiter Property..........................................................................................214 Cols and Rows Properties.....................................................................................215 ColTitleCellDef Property.....................................................................................215 ColTitlesHeight Property......................................................................................215 ComboBox Property (TListEditInfo Object).........................................................216 ConvertTabsToCols Property...............................................................................216 Count Property.....................................................................................................216 Count Property (TListSelectedGridCells, TListSelectedGridColumns and TListSelectedGridRows Objects)...................................................................217 vi • Contents Programmer's Guide TList 8 ActiveX Control Count Property (TVWSelectedNodes Object).......................................................217 Clear Method.......................................................................................................217 Clear Method (TListNodes Object).......................................................................218 Clear Method (TListSelectedGridCells, TListSelectedGridColumns and TListSelectedGridRows Objects)...................................................................218 Clear Method (TListComboItems Object).............................................................219 Clear Method (TVWSelectedNodes Object).........................................................219 ClearItemProperty...............................................................................................219 Click Event..........................................................................................................220 Clipboard Property...............................................................................................220 CoerceIndexProperty...........................................................................................221 CollapseEvent.....................................................................................................221 CopyBuffer Method.............................................................................................222 CopyItemProperty...............................................................................................222 CopyItemSubProperty.........................................................................................222 CopyOne Property................................................................................................223 CopySelectedProperty.........................................................................................223 CurrentIndexMethodProperty..............................................................................224 CurrentItemProperty............................................................................................225 CurrentParentProperty.........................................................................................225 CurrentItemBMProperty......................................................................................226 DateTime Property (TListEditInfo Object)...........................................................226 DefItemCellAlignment and Alignment Properties.................................................227 DefItemCellPictureAlignment and PictureAlignment Properties...........................228 DefItemCellTextAlignment and TextAlignment Properties...................................229 DblClickEvent.....................................................................................................229 DefItemCellDef Property.....................................................................................230 DefMultiLine Property.........................................................................................230 DisableNoScrollProperty.....................................................................................230 DisplayValue Property (TListComboItem Object)................................................231 DisplayPic Property (TListComboItem Object)....................................................232 Drag Method........................................................................................................233 DragColumnsEnabled property.............................................................................233 DragDrop, DragOver Events................................................................................233 DragDropEx, DragOverExEvents........................................................................234 DragHighlight Property........................................................................................234 DragIconProperty................................................................................................235 DragIconStyleProperty........................................................................................235 DragMode Property..............................................................................................236 DrawFocusRectProperty......................................................................................236 DropDownItemHeight Property (TListComboBox)..............................................237 DropDownMaxHeight Property (TListComboBox)..............................................237 DropDownWidth Property (TListComboBox)......................................................238 DropTarget Property............................................................................................238 EditAreaMinHeight, EditAreaMaxHeight, EditAreaMinWidth, EditAreaMaxWidth Properties (TListComboBox)................................................239 Editable Property(TListEditInfo)..........................................................................239 EditableStartOptions Property(TListEditInfo).......................................................240 EditInfo Property..................................................................................................241 EditingKeyDown Event........................................................................................242 EditingKeyPress Event.........................................................................................242 Programmer's Guide TList 8 ActiveX Control Contents • vii EditingKeyUp Event............................................................................................242 EditingMode Property..........................................................................................242 EditInfoObject Property (TListEditingChangeInfo object)....................................243 EnabledProperty..................................................................................................244 EndPage Event.....................................................................................................244 EnumIndex Property (TListNode Object).............................................................245 Environment Property..........................................................................................245 ExpandEvent.......................................................................................................246 ExpandProperty...................................................................................................246 ExpandChildren Property.....................................................................................247 ExpandEx Property..............................................................................................247 ExpandNewItem Property....................................................................................248 ExpandToLevelProperty......................................................................................248 ExplorerCompatible Property...............................................................................249 FastAddItem and FastAddItemEx Methods...........................................................249 File Property........................................................................................................249 Files Property.......................................................................................................250 FindItem and FindValue Methods.........................................................................250 FireTListEvents Property (TListTreeView)..........................................................251 FirstItem and LastItem Properties.........................................................................252 FirstSibling and LastSibling Properties (TListNode Object)..................................252 FixedSizeProperty...............................................................................................252 FocusRectStyle property.......................................................................................253 FontProperty.......................................................................................................253 FontBold, FontItalic, FontStrikethru, FontUnderline Properties............................254 FontName Property..............................................................................................255 FontSize Property.................................................................................................255 Font3D property (TListCellDef object).................................................................255 FontShadowColor and FontShadowSelectedColor properties (TListCellDef object)...........................................................................................256 ForeColor Property...............................................................................................257 Format Property...................................................................................................257 Format Property (TListDateTime Object).............................................................262 FormatString Property (TListDateTime Object)....................................................264 FreeBuffer Method...............................................................................................266 FreeBuffer/TListFreeBuffer improvement............................................................266 FullItemString and FullRowString Properties.......................................................266 FullPathProperty.................................................................................................267 GetArrayProperty, SetArrayProperty, GetArrayPropertyID Properties.............................................................................................................267 GetData Method...................................................................................................268 GetFormat Method...............................................................................................269 GetItemByCellValue Method (TListComboItems)................................................269 GetItemByXY Method.........................................................................................270 GetItemRect Method............................................................................................271 GotFocusEvent....................................................................................................271 GradientColorFrom, GradientColorTo, and GradientStyle Properties....................272 Grid Property.......................................................................................................273 GridCellActivateEvent / GridCellDeactivateEvent..............................................273 GridCellClickEvent.............................................................................................274 GridCellDblClickEvent.......................................................................................275 viii • Contents Programmer's Guide TList 8 ActiveX Control GridCellDef Property...........................................................................................275 GridCellRequestEditing Event..............................................................................276 GridCellAfterEditing Event..................................................................................277 GridCellEditingChange Event..............................................................................278 GridCellEditingKeyDown, GridCellEditingKeyUp and GridCellEditingKeyPress Events..........................................................................279 GridLinesColor Property......................................................................................280 GridLinesStyle Property.......................................................................................280 GridLines3DStyle Property..................................................................................281 GridLines3DLightColor and GridLines3DShadowColorProperties......................281 GridRowActivateEvent / GridRowDeactivateEvent............................................282 GridRowTitleClickEvent, GridColumnTitleClick Event, GridCornerTitleClickEvent.................................................................................282 HasCell Property..................................................................................................283 HasGrid Property.................................................................................................284 HasSubItemsProperty..........................................................................................284 HeightProperty....................................................................................................285 HelpContextIDProperty.......................................................................................285 HScroll and VScroll Events..................................................................................285 HWndProperty....................................................................................................286 ImageProperty.....................................................................................................287 ImageStretchProperty..........................................................................................288 Indent Property.....................................................................................................288 Indentation Property.............................................................................................289 Index Property (TListNode Object)......................................................................290 IndexProperty......................................................................................................290 IndexByBM Method............................................................................................291 InsertProperty......................................................................................................291 InsertItemProperty...............................................................................................292 InvBorderStyleProperty.......................................................................................292 InvImageProperty or SelectedImage Property......................................................293 InvStyleProperty.................................................................................................294 IsClipboardAvailable Property.............................................................................294 IsItemVisibleProperty.........................................................................................295 IsPrinting Method................................................................................................295 IsValidBM Method..............................................................................................295 IsValidBuffer Method..........................................................................................295 Item Method (TListSelectedGridCells, TListSelectedGridColumns and TListSelectedGridRows Objects)...................................................................296 Item Property (TVWSelectedNodes Object).........................................................297 ItemActivateEvent / ItemDeactivateEvent..........................................................297 ItemAlwaysHiddenProperty................................................................................298 ItemBackColor and ItemForeColor Properties......................................................298 ItemBM Property.................................................................................................299 ItemCellProperty.................................................................................................299 ItemCheckboxValue Property...............................................................................300 ItemClickEvent...................................................................................................301 ItemDblClickEvent..............................................................................................301 ItemEditText Property..........................................................................................301 ItemEditingChange Event.....................................................................................302 ItemFont…Properties..........................................................................................303 Programmer's Guide TList 8 ActiveX Control Contents • ix ItemGridProperty................................................................................................304 ItemIndex Property...............................................................................................305 ItemIndexToRow Method....................................................................................305 ItemHasGridProperty..........................................................................................305 ItemHeight Property.............................................................................................306 ItemImageDefWidthandItemImageDefHeightProperty......................................306 ItemMark Property...............................................................................................307 ItemMultiLineProperty........................................................................................307 ItemParent Property..............................................................................................308 ItemParentBM Property........................................................................................308 ItemPMPicType Property.....................................................................................308 ItemPrevSibling, ItemNextSibling, and ItemLastSubItemIndex Properties.............................................................................................................309 Item Property.......................................................................................................309 ItemQueryDataEvent...........................................................................................310 Items Property (TListComboBox Object).............................................................311 ItemSorted, ItemSortingMethod, ItemSortingStyle, and ItemSortingKey Properties...................................................................................311 ItemTag Property.................................................................................................315 ItemToolTip and ToolTip Properties....................................................................316 Item...ValueProperties.........................................................................................317 ItemValues and ItemHasValue Properties (Values property of TListNode Object)...............................................................................................317 ItemVirtualParent, ItemVirtualCount, VirtualParent and VirtualCount Properties........................................................................................318 ItemUrl Property..................................................................................................319 HitTest Method....................................................................................................319 KeyboardActivation Property (TList object).........................................................320 KeyDownand KeyUpEvents...............................................................................322 KeyPressEvent....................................................................................................322 KeyboardNavigateWhileEditing Property(TListEditInfo).....................................322 LeftProperty........................................................................................................323 LeftMargin, TopMargin, RightMargin, and BottomMargin Properties..................324 LevelDefs Property..............................................................................................324 ListProperty........................................................................................................324 ListCountProperty...............................................................................................325 ListCountEx Property...........................................................................................325 ListIndexProperty................................................................................................326 LoadAndAdd Property.........................................................................................326 LoadAndInsert Property.......................................................................................327 LoadBuffer Method..............................................................................................327 LoadData Method................................................................................................328 LoadData Method (TListTreeView).....................................................................328 LoadPicture Method.............................................................................................329 LostFocusEvent...................................................................................................329 MarginLeft, MarginTop, MarginRight, MarginBottom Properties.........................330 MarkClick and MarkDblClick Events...................................................................330 MarkedItemsAlwaysHidden Property...................................................................330 MarkPicture Property...........................................................................................331 MarkTag Property................................................................................................331 MarkWidth and MarkHeight Properties................................................................332 x • Contents Programmer's Guide TList 8 ActiveX Control
Description: