Home→DataView_Folder→piDogDataView_Folder→piDogDataView→DataView
DataView
Class DataView
Description
DataView is a grid-style DesktopControl designed to function as a drop-in replacement for Xojo's built-in ListBox DesktopControl.

DataView is a subclass of piDogScrollingCanvas

To replace a Listbox, add the dataview and piDogScrollingCanvas folders to your project.
SelectionChanged the super of a listbox to DataView or drag a DataView from the DesktopControl Library.
Constants
AlignBottom
Deprecated. Use DataView.Alignments instead
Text Aligned at bottom of cell/heading
AlignCenter
Deprecated. Use DataView.Alignments instead
Horizontally Center align cell text
AlignDecimal
Deprecated. Use DataView.Alignments instead
Decimal align cells
AlignDefault
Deprecated. Use DataView.Alignments instead
Default align or column align
AlignLeft
Deprecated. Use DataView.Alignments instead
Left align cell text
AlignMiddle
AlignRight
Deprecated. Use DataView.Alignments instead
Right align cell text
AlignTop
Deprecated. Use DataView.Alignments instead
Align text to the top of cells/headings
BorderDefault
Deprecated. Use DataView.BorderStyles instead
The default line for the view
BorderDoubleThinSolid
Deprecated. Use DataView.BorderStyles instead
Double thin line
BorderNone
Deprecated. Use DataView.BorderStyles instead
No border
BorderRaised
Deprecated. Use DataView.BorderStyles instead
A raised edge border style
BorderThickSolid
Deprecated. Use DataView.BorderStyles instead
A thick solid line
BorderThinDotted
Deprecated. Use DataView.BorderStyles instead
A thin dashed style
BorderThinSolid
CellFormatAlignmentKey
Used to specify a text alignment for cell formatting
CellFormatBackgroundColorKey
Used to specify a background color for cell formatting
CellFormatBoldKey
Used to specify a bold font color for cell formatting
CellFormatFontKey
Used to specify a font for cell formatting
CellFormatFontSizeKey
Used to specify a text size for cell formatting
CellFormatItalicKey
Used to specify an italic font for cell formatting
CellFormatTextColorKey
Used to specify a text color for cell formatting
CellFormatTextWrapModeKey
Used to specify a text color for cell formatting
CellFormatVerticalAlignmentKey
Used to specify a text alignment for cell formatting
CheckBoxChecked
Deprecated. Use DataView.CheckboxStates instead
The state is checked
CheckBoxIndeterminate
Deprecated. Use DataView.CheckboxStates instead
An indeterminate state
CheckBoxUnchecked
Deprecated. Use DataView.CheckboxStates instead
An unchecked state
HeaderTypeNonSortable
HeaderTypeSortable
kHide
Text to display to hide contents of a group
kShow
Text to display for show group widget
SelectionMultiple
Deprecated. Use DataView.RowSelectionTypes instead
Allow multiple selection
SelectionSingle
Deprecated. Use DataView.RowSelectionTypes instead
Allow only single selection
SortAscending
Deprecated. Use DataView.SortTypes instead
The ascending sort direction
SortDescending
Deprecated. Use DataView.SortTypes instead
The descending sort direction
SortNone
Deprecated. Use DataView.SortTypes instead
Unsorted
TextWrapModeCharacter
Deprecated. Use Dataview.TextWrapModes instead
Wrap text by character mode
TextWrapModeDefault
Deprecated. Use Dataview.TextWrapModes instead
Default wrap mode constant
TextWrapModeTruncate
Deprecated. Use Dataview.TextWrapModes instead
Truncate text constant
TextWrapModeWrap
Deprecated. Use Dataview.TextWrapModes instead
Wrap text mode
TypeCheckBox
Deprecated. Use DataView.CellTypes instead
Cell will contain a checkbox. Use CellChecked to set/get the value
TypeDate
Deprecated. Use DataView.CellTypes instead
A DateChooser will be displayed to show a date. The user can click the date to access a calendar cho
TypeDateChooser
Deprecated. Use DataView.CellTypes instead
A DateChooser will be displayed to show a date. The user can click the date to access a calendar cho
TypeDefault
Deprecated. Use DataView.CellTypes instead
The default type of cell
TypeEditable
Deprecated. Use DataView.CellTypes instead
Cell can be edited by double click or click-and-hover
TypeEditableTextField
Deprecated. Use DataView.CellTypes instead
Same as TypeEditable
TypeIndex
Deprecated. Use DataView.CellTypes instead
Cells in a column with this type will be draw in the style of a header allowing for a spreadsheet st
TypeNormal
Deprecated. Use DataView.CellTypes instead
The plain text cell type
TypePassword
Deprecated. Use DataView.CellTypes instead
Editable cell type with text hidden by bullets ie ••••••
TypePopup
Deprecated. Use DataView.CellTypes instead
A popupMenu will be displayed to select an availble option
TypeProgress
Deprecated. Use DataView.CellTypes instead
A progressbar will be displayed to show a percent 0.0-1.0
Enums
Alignments
These values are used to determine the alignment of cells and headings in the following
BorderStyles
These Values are used to determine the gridline style in:
CellTypes
These Values are used to define standard Cell Types in:
CheckboxStates
These Values are used to determine the checkbox state of cells and headings:
ColumnResizingModes
ColumnUserResizingModes
DateFormatStyles
EditorActions
FolderAnimationStyles
Used to determine the animation style when expanding or collapsing a folder row.
RowSelectionTypes
Used to set the RowSelectionType.
SortDirections
Used to determine the direction of sorting.
SortTypes
Whether a column can be sorted by the user.
TextWrapModes
Used to set the TextWrapMode
Events
AdjustScrollerBounds
Use this event to adjust the bounds where the scrollers will display. Initial value is the default b
CellAction
Fired when a cell value or checked state changes
CellConstructContextualMenu
A right click has occurred. Populate base to display a contextual menu.
CellContextualMenuAction
A contextual menu item was selected.
CellDidEdit
Called when a cell has been edited by the user.
CellDoubleClick
The user double clicked a cell. Return true to handle it yourself.
CellDropObject
Will be fired when the user drops an object on the list unless true was returned from dragover event
CellFocusLost
Fired when a cell loses the focus
CellFocusReceived
Fired when an editable cell gets focus.
CellKeyDown
Fired when the user is editing a cell.
CellMouseDrag
The Mouse was dragged after cellClick returned true. X and Y are relative to the top-left of the cel
CellMouseEnter
Fired when the mouse moves into the given cell.
CellMouseExit
Fired when the mouse exits the given cell
CellMouseMove
The mouse moved within the cell at row-column. X and Y are relative to the top-left of the cell.
CellPopupMenuAction
Called when the user has selected an item in a PopupMenu Cell.
CellPressed
Fired when the user clicks a cell. Return true to handle the click
CellTextChanged
Fired when a cell has bee edited
CellWillEdit
Change
Selection or data has been changed
CheckAllChecked
Closing
The control is closing
ColumnDrag
Handle this event to prevent dragging of a column by returning true
ColumnDragTo
Handle this event to prevent dragging a column to newindex by returning true
ColumnReorder
Handle this event to be notified when a column has been moved by the user
ColumnResize
The user is resizing the column DraggingColumn
ColumnSorted
The user has requested the list to be sorted by the column indicated. Return true to handle the sort
ConstructContextualMenu
Standard ContextualMenu functionality. See CellConstructContextualMenu for cell based function.
ContextualMenuItemSelected
Standard ContextualMenu Handler. See CellConstructContextualMenu for cell based function.
DepopulateCell
Called when a CellContainer needs to be reset to it's default state.
DoublePressed
The user has double-clicked the control.
DragAccepted
'Item' was dragged from this view and dropped on 'target''.
DragCells
Called when the user drags cells with cellSelectionMode=true
DragOut
Called when The user drags rows out of the control. Requires EnabelDrag to be set to True.
DragOver
Return true from this event to receive a dropObject event when the user drops an object.
DragReorderRows
The user has dragged a row or group of rows to a new location.
DragReorderRowsOut
Called when the user drops dragged rows outside of the list during a drag reorder. Set ShouldRemoveR
DragRows
Called when the user drags rows with cellSelectionMode=false
DrawCellRect
Fired to allow an opportunity to draw a rect to show the cell currently affected by keyboard navigat
DropCells
Cells (XML available in obj raw data "cell") have been dropped on the list at insertionIn
DropObject
Fallback event fired when CellDropObject returns false and dragItem doesn't contain 'cels&
DropRows
Called when rows dragged out of a DataView have been dropped at insertionIndex.
EditCellPaste
The Paste Menu was selected while a cell is being edited. Use this event to handle the paste by retu
EditCopyHandler
The Copy menu was selected
EditCutHandler
The Cut menu was selected
EditPasteHandler
The paste menu was selected
FocusLost
The control has lost the focus
FocusReceived
The control has gotten focus
FormatCellText
Use this event to sidestep the internal text formatting.
getDataSource
Return a TableData object here to provide a data source during initialization and before the control
HeaderConstructContextualMenu
A right click has occurred. Populate base to display a contextual menu.
HeaderContextualMenuAction
A contextual menu item was selected.
HeaderPressed
The user clicked a column header. return true to cancel (prevent sorting).
KeyDown
A key was pressed. Return true to handle the event.
KeyUp
A key was released. return true to handle the event
MouseDown
MouseDrag
MouseEnter
MouseExit
The mouse has left the control
MouseMove
MouseUp
MouseWheel
The user has scrolled the control. return true to handle the event.
Opening
The control is opening
PageDown
The user has scrolled down by clicking below the scrollbar handle. Adjust targetRect to change desti
PageLeft
The user has scrolled left by clicking below the scrollbar handle. Adjust targetRect to change desti
PageRight
The user has scrolled right by clicking below the scrollbar handle. Adjust targetRect to change dest
PageUp
The user has scrolled up by clicking below the scrollbar handle. Adjust targetRect to change destina
PaintCellBackground
Allows you to do the background painting. Return true if you've handled drawing.
PaintCellText
Allows you to do the text drawing youself. Return true if you've handled the event.
PaintDatePickerIcon
PaintDisclosureWidget
Handle this event to paint the disclosure widget. Change the x,y,width,height to a
PaintGridline
This event is fired after the list is drawn and before the header is drawn. return true if the drawi
PaintHeaderBackGround
Use this event to draw the header background. Return true if you've handled the event.
PaintHeaderContent
Use this event to draw the Header text. Return true if you've handled the event
PaintOverlayLayer
Provides an oportunity to paint on the DataView after the standard painting has completed.
PaintScrollingLayer
area needs to be redrawn. g is the main graphics. m is the graphcs for masking under carbon/win32. Z
PaintSortIndicator
This event allows you to override or modify the build-in Sort Indicator drawing when not using syste
PopulateCell
Called when a CellContainer needs to be updated to display the current data for a cell
PrepareDatePicker
Called before a datePicker is displayed. Use this event to set the minDate as maxDate for the select
PrintCell
Allows for custom Handling of Cell Printing including to PDF. Return true if you've handled it.
PrintCellBG
Allows for custom Handling of Cell Printing including to PDF. Return true if you've handled it.
PrintCellBorders
Allows for custom Handling of Cell Border Printing including to PDF. Return true if you've hand
RenderDraggedRows
Handle this event and return a picture if custom drag rendering is needed.
Resized
The Canvas was resized. Called after painting.
Resizing
The Canvas is resizing. Called before painting
RowCollapsed
Called when an expanded row is collapsed by the user.
RowComparison
Return true to use a custom sort order. Set Result to -1 the specify less-than, +1 for greater
RowExpanded
Called when a row is expanded by the user. Rows added will be added as children of the expanding row
RowWillRender
Provides opportunity to populate a row immediately before it is rendered. Useful for on-demand lists
ScrollingLayerSizeChanged
Use this event to make adjusments based on the size of the scrolling layer.
SelectionChanged
Fired when the selected row/cell changes due to user interaction
ThemeChanged
Fired when the rendering theme has changed. Set any overrides here.
WillNavigateToCell
Event fires when the user is navigating between cells using the keyboard.
ZoomChanged
The zoom factor of the control has changed.
Methods
ActivateCell
Will Activated the cell's CellContainer and return a reference to it
AddChildRow
Adds a new row to the list as a child of ParentRow using an array of strings
Adds a new row to the list as a child of ParentRow
Adds a new row to the list as a child of ParentRow using an array of variants
AddColumn
Adds a new column at Index using the passed newColumn to setup the column
Add a new column to the right side of the list
Add a new column to the right side of the list
AddColumnAt
Add a column to the view and datasource after specified column
AddExpandableRow
Adds a new folder to the list
AddExpandableRowAt
Adds a folder to the list at index
AddFolder
Deprecated. Use AddExpandableRow instead
Adds a new folder to the list
AddGroup
Adds a new group to the list
AddListSelectionNotificationReceiver
AddRow
Adds a new row to the list using an array of strings
Adds a new row to the list using an array of variants
Adds a new row to the list
AddRowAt
inserts a row into the list at index using an array of strings
inserts a row into the list at index
inserts a row into the list at index using an array of variants
AddRows
Adds a list of rows with optional rowtags. Much faster to use during ExpandRow on a long list
Adds a list of rows with optional rowtags. Much faster to use during ExpandRow on a long list
AddRowsAt
Allows inserting of an array of rows using Titles() and optionally RowTags, Tags() at index.
CalculateCellTextHeightAt
Returns the vertical space required to display wrapped text
CalculateCellTextWidthAt
Returns the horizontal space required to display text without truncating
CalculateColumnWidthsForWidth
returns the widths for the specified columns() sized to fit forWidth or all columns if columns() is
CalculatePrintHeight
returns the vertical space needed to print the entire view
CalculateRectForCellAt
Returns a Xojo.Rect representing the bounds of the cell at row,column
CalculateViewRectForCellAt
calculates the area of the view that the given cell will occupy.
Cell
Get the text of the cell
Set the value of the cell (variant)
CellAlignment
Deprecated. Use CellAlignmentAt instead
Gets the BackgroundColor of the cell at row/column
Set the allignment for the cell
CellAlignmentAt
Gets the BackgroundColor of the cell at row/column
Set the allignment for the cell
CellBackgroundColor
Deprecated. Use CellBackgroundColorAt instead
Gets the BackgroundColor of the cell at row/column
Sets the BackgroundColor of the cell at row/column
CellBackgroundColorAt
Gets the BackgroundColor of the cell at row/column
Sets the BackgroundColor of the cell at row/column
CellBold
Gets the Bold style for the cell if available
Sets the Bold style for the cell if available
CellBoldAt
Gets the Bold style for the cell if available
Sets the Bold style for the cell if available
CellBorderBottom
Deprecated. Use CellBorderBottomAt instead
Gets the Bottom Border Style for the given cell
Sets the Bottom Border Style for the given cell
CellBorderBottomAt
Gets the Bottom Border Style for the given cell
Sets the Bottom Border Style for the given cell
CellBorderColorBottom
Deprecated. Use CellBorderColorBottomAt instead
Gets the Bottom Border Color for the given cell
Sets the Bottom Border Color for the given cell
CellBorderColorBottomAt
Gets the Bottom Border Color for the given cell
Sets the Bottom Border Color for the given cell
CellBorderColorLeft
Deprecated. Use CellBorderColorLeftAt instead
Gets the Left Border Color for the given cell
Sets the Left Border Color for the given cell
CellBorderColorLeftAt
Gets the Left Border Color for the given cell
Sets the Left Border Color for the given cell
CellBorderColorRight
Deprecated. Use CellBorderColorRightAt instead
Gets the Right Border Color for the given cell
Sets the Right Border Color for the given cell
CellBorderColorRightAt
Gets the Right Border Color for the given cell
Sets the Right Border Color for the given cell
CellBorderColorTop
Deprecated. Use CellBorderColorTopAt instead
Gets the Top Border Color for the given cell
Sets the Top Border Color for the given cell
CellBorderColorTopAt
Gets the Top Border Color for the given cell
Sets the Top Border Color for the given cell
CellBorderLeft
Deprecated. Use CellBorderLeftAt instead
Gets the Left Border Style for the given cell
Sets the Left Border Style for the given cell
CellBorderLeftAt
Gets the Left Border Style for the given cell
Sets the Left Border Style for the given cell
CellBorderRight
Deprecated. Use CellBorderRightAt instead
Gets the Right Border Style for the given cell
Sets the Right Border Style for the given cell
CellBorderRightAt
Gets the Right Border Style for the given cell
Sets the Right Border Style for the given cell
CellBorderTop
Deprecated. Use CellBorderTopAt instead
Gets the Top Border Style for the given cell
Sets the Top Border Style for the given cell
CellBorderTopAt
Gets the Top Border Style for the given cell
Sets the Top Border Style for the given cell
CellCheck
Deprecated. Use CellCheckBoxValueAt instead
Get the checked value of the cell
Set whether the cell is Checked
CellCheckBoxEnabledAt
Gets whether the cellcheck is enabled
Sets whether the cellcheck is enabled
CellCheckBoxStateAt
Get the checked value of the cell
Set whether the cell is Checked
CellCheckBoxValueAt
Get the checked value of the cell
Set whether the cell is Checked
CellCheckEnabled
Deprecated. Use CellCheckBoxEnabledAt instead
Gets whether the cellcheck is enabled
Sets whether the cellcheck is enabled
CellColumnSpanAt
Get the number of columns the cell at row/column occupies
Set the number of columns the cell at row/column occupies
CellContainer
Deprecated. Use CellContainerAt instead
Get the Container for the cell
Set the Container for the Cell
CellContainerAt
Get the Container for the cell
Set the Container for the Cell
CellCueText
Deprecated. Use CellCueTextAt instead
Get the cue text for the Cell to be displayed when no value has been entered for an editable or popu
Set the cue text for the Cell to be displayed when no value has been entered for an editable or popu
CellCueTextAt
Get the cue text for the Cell to be displayed when no value has been entered for an editable or popu
Set the cue text for the Cell to be displayed when no value has been entered for an editable or popu
CellFont
Deprecated. Use CellFontNameAt instead
gets the font name for the cell
sets the font by name for the cell
CellFontNameAt
gets the font name for the cell
sets the font by name for the cell
CellFontSize
Deprecated. Use CellFontSizeAt instead
gets the size of text in the cell at row/column
sets the size of text in the cell at row/column
CellFontSizeAt
gets the size of text in the cell at row/column
sets the size of text in the cell at row/column
CellFormatString
Deprecated. Use CellFormatStringAt instead
Get the formatString to be used when rendering a double value in this cell
Set the formatString to be used when rendering a Double value in this cell
CellFormatStringAt
Get the formatString to be used when rendering a double value in this cell
Set the formatString to be used when rendering a Double value in this cell
CellHeight
Deprecated. Use CellHeightAt instead
Gets the height for the given cell
Sets the height for the given cell
CellHeightAt
Gets the height for the given cell
Sets the height for the given cell
CellHelpTag
Deprecated. Use CellHelpTagAt instead
Get the HelpTag for the cell
Set the HelpTag for the Cell
CellHelpTagAt
Get the HelpTag for the cell
Set the HelpTag for the Cell
CellItalic
Deprecated. Use CellItalicAt instead
Gets the Bold style for the cell if available
sets the italic style for the cell if available
CellItalicAt
Gets the Bold style for the cell if available
sets the italic style for the cell if available
CellOptionList
Deprecated. Use CellOptionListAt instead
Get the OptionList for the DesktopPopupMenu cell
Set the OptionList for the DesktopPopupMenu Cell
CellOptionListAt
Get the OptionList for the DesktopPopupMenu cell
Set the OptionList for the DesktopPopupMenu Cell
CellPicture
Deprecated. Use CellPictureAt instead
Get the picture for the cell
Set the picture for the Cell
CellPictureAt
Get the picture for the cell
Set the picture for the Cell
CellRowSpanAt
Get the number of rows the cell at row/column occupies
Set the number of rows the cell at row/column occupies
CellSelectable
Whether the cell is selectable
Sets whether the cell is selectable
CellSelected
Whether the cell is selected
Sets whether the cell is selected
CellState
Deprecated. Use CellCheckBoxStateAt instead
Get the checked value of the cell
Set whether the cell is Checked
CellTag
Deprecated. Use CellTagAt instead
Get the tag for the cell
Set the Tag for the Cell
CellTagAt
Get the tag for the cell
Set the Tag for the Cell
CellTextAt
Get the text of the cell as it would be rendered in the UI
Set the text value of the cell
CellTextColor
Deprecated. Use CellTextColorAt instead
gets the color of text in the cell at row/column
sets the color of text in the cell at row/column
CellTextColorAt
gets the color of text in the cell at row/column
sets the color of text in the cell at row/column
CellTextHeight
Deprecated. Use CalculateCellTextHeightAt instead
Returns the vertical space required to display wrapped text
CellTextWidth
Deprecated. Use CalculateCellTextWidthAt instead
Returns the horizontal space required to display text without truncating
CellTextWrapMode
Deprecated. Use CellTextWrapModeAt instead
TextWrapMode for the celll
Set the TextWrapMode for the Cell
CellTextWrapModeAt
TextWrapMode for the celll
Set the TextWrapMode for the Cell
CellType
Deprecated. Use CellTypeAt instead
Get the type of the cell
Set the type of the cell
CellTypeAt
Get the type of the cell
Set the type of the cell
CellValue
Deprecated. Use CellValueAt instead
Get the value of the cell (variant)
CellValueAt
Get the value of the cell (variant)
set the value of the cell (variant)
CellVerticalAlignment
Deprecated. Use CellVerticalAlignmentAt instead
Gets the Vertical Alignment of the cell at row/column
Set the vertical allignment for the cell
CellVerticalAlignmentAt
Gets the Vertical Alignment of the cell at row/column
Set the vertical allignment for the cell
ClearBorders
Reset all CellBorders
ClearSelections
Deselect all rows/cells
CollapseRow
Deprecated. Use CollapseRowAt instead
Collapse the row
CollapseRowAt
Collapse the row
Column
Deprecated. Use ColumnAttributesAt instead
Gets a piDogDataView.ListColumn object containing width values for the column at index
Assigns a piDogDataView.ListColumn object containing width values for the column at index and refres
ColumnAlignment
Deprecated. Use ColumnAlignmentAt instead
Get the current allignment of the column
Set the allignment for the column
ColumnAlignmentAt
Get the current allignment of the column
Set the allignment for the column
ColumnAlignmentOffset
Deprecated. Use ColumnAlignmentOffsetAt instead
Get the current allignment Offset of the column
Set the allignment Offset for the column
ColumnAlignmentOffsetAt
Get the current allignment Offset of the column
Set the allignment Offset for the column
ColumnAttributesAt
Gets a piDogDataView.ListColumn object containing width values for the column at index
Assigns a piDogDataView.ListColumn object containing width values for the column at index and refres
ColumnByFieldName
Attempts to get a column's index from it's title
ColumnByTitle
Attempts to get a column's index from it's title
ColumnCheckAll
Deprecated. Use ColumnHasCheckAllCheckBoxAt instead
Get whether the column has a check all box in the header
Set whether the column will have a check all box in the header
ColumnCheckAllChecked
Deprecated. Use ColumnCheckAllValueAt instead
Whether the user has checked the checkAll box
ColumnCheckAllState
Deprecated. Use ColumnCheckAllStateAt instead
State of the checkAll box
Sets the state of the check all box and checks the checkboxes in that column in all rows
ColumnCheckAllStateAt
State of the checkAll box
Sets the state of the check all box and checks the checkboxes in that column in all rows
ColumnCheckAllValueAt
Whether the user has checked the checkAll box
ColumnData
Deprecated. Use ColumnDataAt instead
ColumnDataAt
ColumnDateFormatAt
Get the current date format of the column
Get the current date format of the column
ColumnFormatString
Deprecated. Use ColumnFormatStringAt instead
Get the current format string of the column
Set the format string for the column
ColumnFormatStringAt
Get the current format string of the column
Set the format string for the column
ColumnFromXY
Get the column at x,y relative to the View if isMouseCoordinates=true.
ColumnHasCheckAllCheckBoxAt
Get whether the column has a check all box in the header
Set whether the column will have a check all box in the header
ColumnHiddenAt
Get whether the column is currently hidden
Set whether the column is hidden
ColumnIsResizableAt
Get whether the column has a check all box in the header
Set whether the column will have a check all box in the header
ColumnOptionList
Deprecated. Use ColumnOptionListAt instead
gets the OptionList associated with a column
sets the optionList for a column of type CellTypes.Popup.
ColumnOptionListAt
gets the OptionList associated with a column
sets the optionList for a column of type CellTypes.Popup.
ColumnResizable
Deprecated. Use ColumnIsResizableAt instead
Get whether the column has a check all box in the header
Set whether the column will have a check all box in the header
ColumnSortDirection
Deprecated. Use ColumnSortDirectionAt instead
The current sorting direction of the column.
Sets the current sorting direction of the column.
ColumnSortDirectionAt
The current sorting direction of the column.
Sets the current sorting direction of the column.
ColumnSortTypeAt
Gets the Header SortType for the column
assigns the Header SortType to the column
ColumnSpan
Deprecated. Use CellColumnSpanAt instead
Get the number of columns the cell at row/column occupies
Set the number of columns the cell at row/column occupies
ColumnTag
Deprecated. Use ColumnTagAt instead
gets the tag associated with a column
sets the tag for a column.
ColumnTagAt
gets the tag associated with a column
sets the tag for a column.
ColumnType
Deprecated. Use ColumnTypeAt instead
Get the type of the column
Set the type of the column
ColumnTypeAt
Get the type of the column
Set the type of the column
ColumnWidthsForWidth
Deprecated. Use CalculateColumnWidthsForWidth instead
returns the widths for the specified columns() sized to fit forWidth or all columns if columns() is
Copy
Copies currently selected cells/rows as tab delimited text
CopySystemColors
Cut
Copies and removes selected rows or copies and clears selected cells as tab-delimited text
DeleteAllRows
Deprecated. Use RemoveAllRows instead
Remove all rows from the list
EditCell
Deprecated. Use EditCellAt instead
Puts the cell into editing mode
EditCellAt
Puts the cell into editing mode
enableVibrancy
Under MacOSX 10.10+ calling this Method will enable vibrancy for the DesktopCanvas
EnableVibrantHeader
Under MacOSX 10.10 calling this Method will enable vibrancy for the list header
Expanded
Deprecated. Use RowExpandedAt instead
Whether the row is expanded
Sets whether the row is expanded
FocusCell
Deprecated. Use SetFocusedCell instead
Sets the cell as the cell with focus
fromXML
Deprecated. Use LoadFromXML instead
Load the list from previously created XmlDocument
GroupHasShowHideTextAt
Whether the group folder has a show/hide widget.
Sets whether the group folder has a show/hide text.
GroupSuppressShowHideText
Deprecated. Use GroupHasShowHideTextAt instead
Whether the group folder has a show/hide widget.
Sets whether the group folder has a show/hide text.
HasCellHeights
Whether the list contains any cells with a custom height.
HeaderAt
Get the heading at index
set the heading at index
Heading
Deprecated. Use HeaderAt instead
Get the heading at index
set the heading at index
HeadingType
Deprecated. Use ColumnSortTypeAt instead
Gets the Header Type for the column at Index
assigns the Header Type to the column at Index
InsertColumn
Deprecated. Use AddColumnAt instead
Add a column to the view and datasource after specified column
InsertFolder
Deprecated. Use AddExpandableRowAt instead
Adds a folder to the list at index
InsertRow
Deprecated. Use AddRowAt instead
inserts a row into the list at index using an array of strings
inserts a row into the list at index
inserts a row into the list at index using an array of variants
InsertRows
Deprecated. Use AddRowsAt instead
Allows inserting of an array of rows using Titles() and optionally RowTags, Tags() at index.
InvalidateAllCells
Cause all cells to be rerendered
InvalidateCell
Deprecated. Use InvalidateCellAt instead
Cause a cell to be rerendered
InvalidateCellAt
Cause a cell to be rerendered
InvalidateRow
Deprecated. Use InvalidateRowAt instead
Cause all cells in the row to be rerendered
InvalidateRowAt
Cause all cells in the row to be rerendered
List
Returns cell at row,0
Sets the cell at row,0
ListCount
Deprecated. Use RowCount instead
The number of items in the list
Sets the list to have 'value' number of rows.
LoadFromDB
LoadFromXML
Load the list from previously created XmlDocument
LockColumns
Lock (Count) left columns so other columns can slide under when scrolling right.
LockRows
Lock (Count) rows to the top of the list so other rows can slide under when scrolling down.
Mojave
NavigateToNextCell
Moves the selection to the next cell in the same manner as a Tab keypress would.
Paste
Pastes tab-delimited text from clipboard into selected cells/rows
PressHeader
SImulates a click in the header of Column
printHeight
Deprecated. Use CalculatePrintHeight instead
returns the vertical space needed to print the entire view
PrintPage
Call to print a page to g (graphics) beginning with startRow.
RectFromCell
Deprecated. Use CalculateRectForCellAt instead
Returns a Xojo.Rect representing the bounds of the cell at row,column
Redraw
Causes all cells and header to be redrawn and the view invalidated
RemoveAllRows
RemoveColumn
Deprecated. Use RemoveColumnAt instead
Remove the column from the view and datasource
RemoveColumnAt
Remove the column from the view and datasource
RemoveListSelectionNotificationReceiver
RemoveRow
Deprecated. Use RemoveRowAt instead
Remove the row from the list
RemoveRowAt
Remove the row from the list
RenderCell
Deprecated. Use RenderCellAsPictureAt instead
Renders a cell as a picture.
RenderCellAsPictureAt
Renders a cell as a picture.
RowBackgroundColor
Deprecated. Use RowBackgroundColorAt instead
Gets the backgroundcolor of the row at index
Sets the BackgroundColor of the row at index
RowBackgroundColorAt
Gets the backgroundcolor of the row at index
Sets the BackgroundColor of the row at index
RowBold
Deprecated. Use RowBoldAt instead
Gets the bold value of the row at index
Sets the Bold value of the row at index
RowBoldAt
Gets the bold value of the row at index
Sets the Bold value of the row at index
RowByIdentifier
The row associated with the Identifier
RowDepth
Deprecated. Use RowDepthAt instead
Gets the depth of the row as index
Sets the depth of the row at index
RowDepthAt
Gets the depth of the row as index
Sets the depth of the row at index
RowExpandableAt
Sets the row as a iHierarchical folder.
Sets whether the row is a iHierarchical folder
RowExpandedAt
Whether the row is expanded
Sets whether the row is expanded
RowFont
Deprecated. Use RowFontNameAt instead
Gets the Font of the row at index
Sets the Font of the row at index
RowFontNameAt
Gets the Font of the row at index
Sets the Font of the row at index
RowFontSize
Deprecated. Use RowFontSizeAt instead
Gets the FontSize of the row at index
Sets the FontSize of the row at index
RowFontSizeAt
Gets the FontSize of the row at index
Sets the FontSize of the row at index
RowFromXY
The row located at x,y in the view coordinates if isMouseCoordinate=true.
RowHeight
Deprecated. Use RowHeightAt instead
Sets the height of the row at index
Gets the height of the row at index
RowHeightAt
Gets the height of the row at index
Sets the height of the row at index
RowHiddenAt
Gets the hidden state of the row as index
Sets the hidden state of the row at index, preserving other properties
RowIdentifier
Deprecated. Use RowIdentifierAt instead
The Identifier associated with the row
Associate an Identifier with a row
RowIdentifierAt
The Identifier associated with the row
Associate an Identifier with a row
RowIsFolder
Deprecated. Use RowExpandableAt instead
Sets the row as a iHierarchical folder.
Sets whether the row is a iHierarchical folder
RowIsGroup
Deprecated. Use RowIsGroupAt instead
Whether the row as a group folder.
Sets whether the row as a group folder.
RowIsGroupAt
Whether the row as a group folder.
Sets whether the row as a group folder.
RowIsVisible
Deprecated. Use RowIsVisibleAt instead
checks whether a row is currently displayed
RowIsVisibleAt
checks whether a row is currently displayed
RowItalic
Deprecated. Use RowItalicAt instead
Gets the italic value of the row at index
Sets the Italic value of the row at index
RowItalicAt
Gets the italic value of the row at index
Sets the Italic value of the row at index
RowParentAt
Get the parent row of the row passed
RowPicture
Deprecated. Use RowPictureAt instead
The Picture assigned to the row
Assign a picture to the row
RowPictureAt
The Picture assigned to the row
Assign a picture to the row
RowSelectable
Whether the row is selectable
Sets whether the row is selectable
RowSelected
Whether the row is selected
Sets whether the row is selected
RowSpan
Deprecated. Use CellRowSpanAt instead
Get the number of rows the cell at row/column occupies
Set the number of rows the cell at row/column occupies
RowTag
Deprecated. Use RowTagAt instead
The tag associated with the row
Associate a tag with a row
RowTagAt
The tag associated with the row
Associate a tag with a row
RowTextColor
Deprecated. Use RowTextColorAt instead
Gets the TextColor of the row at index
Sets the TextColor of the row at index
RowTextColorAt
Gets the TextColor of the row at index
Sets the TextColor of the row at index
SaveAsPDF
On MacOS allows you to write the DataView to a PDF file at Destination using CoreGraphics
ScrollCellIntoView
Brings a cell into the visible area in the control
ScrollRowIntoView
Brings a row into the visible area in the control
SelCount
Deprecated. Use SelectedRowCount instead
get the number of rows selected
Selectable
Deprecated. Use RowSelectable instead
Whether the row is selectable
Sets whether the row is selectable
Whether the cell is selectable
Sets whether the cell is selectable
SelectAll
Selects all rows/cells
Selected
Deprecated. Use RowSelected instead
Whether the row is selected and visible
Sets whether the row is selected
Whether the cell is selected and visible
Sets whether the cell is selected
SelectedCells
returns an Array of the Selected Cells as Pairs Row:Column
SelectedRowCount
get the number of rows selected
SelectedRows
returns an Array of the Selected Rows
SelectedRowValue
SelectionAsText
SetFocusedCell
Sets the cell as the cell with focus
ShowDatePicker
Show a datepicker for the specified cell
ShowPopupMenu
Allows you to Activated a DesktopPopupMenu via code based on keypress or other events
Sort
sort the list by the current SortColumn and SortDesending value
toXML
Create an XmlDocument representing the list
UnhideAllRows
Sets the hidden state of all rows to false
ViewRectFromCell
Deprecated. Use CalculateViewRectForCellAt instead
calculates the area of the view that the given cell will occupy.
Properties
AccessColumnsByInsertionOrder
When set to true, column access will be mapped to the original insertion order.
ActiveCell
Deprecated. Use ActiveTextControl instead
Gets the currently active cell editor.
ActiveTextControl
Gets the currently active cell editor.
AllowColumnReorder
Whether the user should be allowed to reorder columns
AllowExpandableRows
Setting this value to true will cause the list to perform as a iHierarchical list. This value is aut
AllowResizableColumns
Set to true to alow the user to resize columns by dragging
AllowRowDragging
Set to true to alow the user to drag rows from the list
AllowRowReordering
Set to true to allow users to reorder the list by dragging
AllowsOverflow
If false, column widths are reduced proportionally beyond minimums to keep the list width with
AllowsUnderflow
If false, column widths are expanded proportionally when the view is larger than the total of
AnimationDuration
Duration of animations for DragReorderRows
AutoExpandCellEditor
Whether DesktopTextArea autoExpands to accomodate text when editing cells
AutomaticCheckBoxes
Whether the DataView will automatically set the checked state of parent rows when checkboxes are che
AutomaticHeaderHeight
Whether HeaderHeight automatically expands to accomodate text when resizing
Bold
Makes the text in the list Bold if available
CacheColumnsDuringResize
If set to true, columns will be cached during live resize to optimize rendering.
CellPadding
Determines the amount of space to be inserted at cell edges
CellSelectionMode
Set to true to allow individual cells to be selected
ChildrenPersist
If set to true, child rows will be hidden when a folder is collapsed and unhidden when the fol
ColorIzedHeader
Set to true to use system Color.HighlightColor for selected Column when UsesSystemColors=true
ColumnCount
The number of columns in the control
ColumnDefaults
The Default column setting for this DataView. Used to set properties in calls to AddColumn.
ColumnResizingMode
Determines the mode For collapsing column widths To their minimumWidth when resizing the DesktopCont
ColumnsResizable
Deprecated. Use AllowResizableColumns instead
Set to true to alow the user to resize columns by dragging
ColumnUserResizingMode
Determines the mode For resizing column widths when the user drags a column divider
ColumnWidths
A string to set the column sizing. Same format as Xojo Listbox ColumnWidths
ControlCellsUseSystemFont
Whether DesktopCheckbox, popup and cells use system font and size. Otherwise, cell&comm
CopyDelimiter
CopyLineBreak
DataSource
DefaultColumnWidth
The Width to be used for new columns when no widths are set
DefaultMaxColumnWidth
The MaxWidth expression to be used for new columns
DefaultMinColumnWidth
The MinWidth to be used for new columns
DefaultRowHeight
The RowHeight to be used for rows without an explicit height
DragDelay
Determines how long the user must hold the mouse before a drag begins.
DrawsCellRect
Whether the view will draw a rectangle around the currently active cell and raise the DrawCellRect e
DrawsFlatHeaderSeparators
If set to true, separator lines will be drawn between header segments
EditDelay
Determines how long the user must hover the mouse after a click before an edit begins.
EnableDrag
Deprecated. Use AllowRowDragging instead
Set to true to alow the user to drag rows from the list
EnableDragReorder
Deprecated. Use AllowRowReordering instead
Set to true to allow users to reorder the list by dragging
FlatHeader
If set to true, header will render without gradiated background
FloatGroupRows
Whether Group Row Headings Float at the top of the view when subrows are still Visible.
FocusedCell
The cell with keyboard focus
FolderAnimationDuration
Duration of animations for Folder Opening/Closing
FolderAnimationStyle
Either standard Or Drop-In style
FontName
The font to use to render text in the list
FontSize
The size to render text in the list
FontUnit
GridlinePaintEnabled
Set to false to disable GridlinePaint event and save some CPU
GridLinesHorizontal
GridLinesHorizontalColor
Defines the default color used for drawing horizontal gridlines
GridLinesHorizontalStyle
GridLinesVertical
GridLinesVerticalColor
Defines the color used for drawing Vertical Gridlines
GridLinesVerticalStyle
GroupHideText
Set a value to override the built-in Hide Group text
GroupShowText
Set a value to override the built-in Show Group text
HasHeader
The list has column headers
HasHeading
The list has column headers
HeaderHeight
The height of the header
HeaderOffset
Moves the header down the specified number of pixels.
HeadingBGAlpha
The alpha value used in drawing header backgrounds.
HeadingBGColor
The base background color for the header.
HeadingDisabledTextColor
the text color of the header when disabled.
HeadingFont
The font to use to draw text in the header
HeadingFontSize
the size to draw the header text
HeadingSelectedBGColor
The base background color for drawing header sort column
HeadingSelectedTextColor
the text color of the header sort column
HeadingTextBold
If set to true, all headers will be rendered with Bold text.
HeadingTextColor
The text color to draw header text
HeadingTextPadding
Padding in pixels to use when rendering header cells
Hierarchical
Setting this value to true will cause the list to perform as a iHierarchical list. This value is aut
InitialValue
A set of tab delimited values to be used to initialize the list
Italic
Makes text in the list italic if available for selected Font
LastAddedRowIndex
The index of the last row added to the list
LastColumnIndex
Index of the last column in the list
LastIndex
The index of the last row added to the list
LastRowIndex
///Index of the last row in the list
LazyRendering
When true, sets a time limit on frame rendering to prevent scroll stutter.
ListBackgroundColorA
first alternating Background color
ListBackgroundColorB
second alternating Background color
ListDisabledHighlightColor
The color for selected cells when DesktopControl is inactive
ListDisabledTextColor
The color for cell text when DesktopControl is disabled.
ListHighlightColor
The background color to be used for selected rows/cells
ListHighlightedTextColor
Text color of selected cells
ListIndex
Deprecated. Use SelectedRowIndex instead
The currently selected row, or the the first selected row if multiple rows are selected
LockedColumnCount
Set to a value > 0 to lock a number of columns to the left edge of the view.
LockedColumnSeparatorColor
The Color to use when drawing the right edge of
LockedRowCount
Set to a value > 0 to lock a number of Rows to the top edge of the view under the header.
NSVisualEffectMaterialHeader
/// The Material used for a visualEffectView under the header.
PageScrollToColumnBounds
If True(Default), horizontal page scroll will attempt to scroll to a column boundary.
PaintEmptyRows
Set to false to prevent painting of rows beyond the list content
PDF_Info
RequiresSelection
Set to true to prevent the user from deselcting all rows by clicking an empty row
RowCount
The number of rows in the list
RowSelectionType
piDogDataView.selectionMultiple or piDogDataView.SelectionSingle
ScrollPosition
Get or set the first visible row
ScrollToFocusOnSort
If true, the view will scroll the focused cell into view when the list is sorted.
SelectedRowIndex
SelectionType
Deprecated. Use RowSelectionType instead
piDogDataView.selectionMultiple or piDogDataView.SelectionSingle
SnapToRowTops
Setting to True causes scrolling to snap the top row to the bottom of the heading
SortColumn
Deprecated. Use SortingColumn instead
The Currently selected column for sorting the list
SortDesending
Whether the list is sorted with lower value items toward the bottom
SortedColumn
Deprecated. Use SortingColumn instead
The Column currently used to sort the list
SortingColumn
The Column currently used to sort the list
StaticHeader
Setting to true will prevent the header from bouncing with the list when the user scrolls past the b
TabToEditableCellsOnly
Whether the TAB key moves to the next editable cell (includes DesktopCheckbox, DateChooser and
TextColor
The color to render text in the list
TextFont
Deprecated. Use FontName instead
The font to use to render text in the list
TextWrapMode
Use a value from TextWrapModes To determine how the Text Is wrapped. Can be overridden With CellText
Underline
UsesAlternatingBackgroundColors
Whether the list will display rows with alternating background colors
UsesSystemColors
Overrides the colors set through other properties
UsesSystemHeaders
Renders column headers using built-in system widgets if True
UsesSystemSortIndicators
Renders column sort indicators using built-in system widgets if True
UsesThemeHighlightColor
If true, selected rows will be colored with the theme selection
UseTempDataSourceForColumnResize
Causes a copy of the datasource with the visible rows to be used during column resize operations to
VerticalAlignment
ZoomScalesColumnWidths
If true, column widths are calculated based on the width of the view/zoom.
Shared Methods
Register