Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
desktop:grid [2019/10/23 00:53]
127.0.0.1 external edit
desktop:grid [2020/03/20 05:47] (current)
agcyphers [Events]
Line 15: Line 15:
  
 ==== Events ==== ==== Events ====
-^ Definition      ^ Description       ^ +^ Definition      ^ Parameters   ^ Description       ^ 
-| CellClicktheRow as GraffitiWebGridRowtheColumn as GraffitiGridColumn | Fired when the user clicks a cell. | +| CellClick theRow as GraffitiWebGridRow \\ theColumn as GraffitiGridColumn | Fired when the user clicks a cell. | 
-| CellDoubleClicktheRow as GraffitiWebGridRowtheColumn as GraffitiGridColumn | Fired when the user double-clicks a cell. | +| CellDoubleClick theRow as GraffitiWebGridRow \\ theColumn as GraffitiGridColumn | Fired when the user double-clicks a cell. | 
-| CellEditedtheRow as GraffitiWebGridRowtheColumn as GraffitiGridColumnnewValue as String | Fires when the user submits an edit to a cell. | +| CellEdited theRow as GraffitiWebGridRow \\  theColumn as GraffitiGridColumn \\ newValue as String | Fires when the user submits an edit to a cell. | 
-| ColumnContextClickColumn as GraffitiGridColumnX as IntegerY as Integer | Raised when the user right- or CTRL-clicks on a column header. | +| ColumnContextClick Column as GraffitiGridColumn \\ X as Integer \\ Y as Integer | Raised when the user right- or CTRL-clicks on a column header. | 
-| ColumnReordertheColumn as GraffitiGridColumnoldIndex as IntegernewIndex as Integer | Fires when the user drags a column to a new position+| ColumnReorder theColumn as GraffitiGridColumn \\ oldIndex as Integer \\ newIndex as Integer | Fires when the user drags a column to a new position \\ 
-| ColumnResizetheColumn as GraffitiGridColumnnewWidth as Integer | Fires when the user resizes a column+| ColumnResize theColumn as GraffitiGridColumn \\ newWidth as Integer | Fires when the user resizes a column \\ 
-| DrawCellBackgroundtheRow as GraffitiWebGridRowtheColumn as GraffitiGridColumng as Graphics as Boolean | This event is raised before a cell's background is drawnand provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | +| DrawCellBackground theRow as GraffitiWebGridRow \\ theColumn as GraffitiGridColumn \\ g as Graphics as Boolean | This event is raised before a cell's background is drawn \\ and provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | 
-| DrawCellTexttheRow as GraffitiWebGridRowtheColumn as GraffitiGridColumng as Graphics as Boolean | This event is raised before a cell's text is drawnand provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | +| DrawCellText theRow as GraffitiWebGridRow \\ theColumn as GraffitiGridColumn \\ g as Graphics as Boolean | This event is raised before a cell's text is drawn \\ and provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | 
-| DrawHeaderBackgroundtheColumn as GraffitiGridColumng as Graphics | This event is raised before a header's background is drawnand provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | +| DrawHeaderBackground theColumn as GraffitiGridColumn \\ g as Graphics | This event is raised before a header's background is drawn \\ and provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | 
-| DrawHeaderTexttheColumn as GraffitiGridColumng as Graphics as Boolean | This event is raised before a header's text is drawnand provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | +| DrawHeaderText theColumn as GraffitiGridColumn \\ g as Graphics as Boolean | This event is raised before a header's text is drawn \\ and provides the opportunity to override the class's behavior.  Return True if you draw to the graphics property here. | 
-| FormatCellValueg as GraphicstheRow as GraffitiWebGridRowtheColumn as GraffitiGridColumntheValue as VariantbyRef formattedValue as String as Boolean | This event allows you to change the look and content of the text that will be drawn to the cell. | +| FormatCellValue g as Graphics \\ theRow as GraffitiWebGridRow \\ theColumn as GraffitiGridColumn \\ theValue as Variant \\ byRef formattedValue as String as Boolean | This event allows you to change the look and content of the text that will be drawn to the cell. | 
-| HeaderClicktheColumn as GraffitiGridColumn as Boolean | Raised when the user clicks a header.  Return True to cancel built-in functionality. | +| HeaderClick theColumn as GraffitiGridColumn as Boolean | Raised when the user clicks a header.  Return True to cancel built-in functionality. | 
-| MouseMoveX as IntegerY as IntegerRow as GraffitiWebGridRowColumn as GraffitiGridColumn | This event is raised when the mouse is moved. | +| MouseMove X as Integer \\ Y as Integer \\ Row as GraffitiWebGridRow \\ Column as GraffitiGridColumn | This event is raised when the mouse is moved. | 
-| RowClicktheRow as GraffitiWebGridRow | Raised when the user clicks a row. | +| RowClick theRow as GraffitiWebGridRow | Raised when the user clicks a row. | 
-| RowContextClickRow as GraffitiWebGridRowX as IntegerY as Integer | Raised when the user right- or CTRL-clicks on a row. | +| RowContextClick Row as GraffitiWebGridRow \\ X as Integer \\ Y as Integer | Raised when the user right- or CTRL-clicks on a row. | 
-| RowDropStartIndex as IntegerEndIndex as Integer | Raised when the user moves a row in the display by dragging. | +| RowDrop StartIndex as Integer \\ EndIndex as Integer | Raised when the user moves a row in the display by dragging. | 
-| Scroll() | Raised when the user scrolls the display. | +| Scroll |  | Raised when the user scrolls the display. | 
-| SortedColumn as GraffitiGridColumn | Raised when the user sorts a column. |+| Sorted Column as GraffitiGridColumn | Raised when the user sorts a column. |
  
 ==== Methods ==== ==== Methods ====
Line 95: Line 95:
 | GradientFills | Boolean | False | When true, the grid will use subtle gradients instead of solid colors to draw components. | | GradientFills | Boolean | False | When true, the grid will use subtle gradients instead of solid colors to draw components. |
 | HeaderBorder | Boolean | False | When true, draw a border around all column headers. | | HeaderBorder | Boolean | False | When true, draw a border around all column headers. |
-HeaderBorderColor | Color | &c000000 | Border color for header. | +HeaderColor | Color | &c000000 | Background color of the header items when not hovered. | 
-| HeaderDividerColor | Color | &c000000 | Color of border between column headers. |+| HeaderDividerColor | Color | &c000000 | Color of border between column headers, as well as between the header and the viewport. |
 | HeaderDividerLineSize | Integer | 2 | The width of the divider between column headers. | | HeaderDividerLineSize | Integer | 2 | The width of the divider between column headers. |
 | HeaderHeight | Integer | 30 | The height of the header row. | | HeaderHeight | Integer | 30 | The height of the header row. |
Line 139: Line 139:
 ==== Notes ==== ==== Notes ====
 === Embedded Containers and Transparency === === Embedded Containers and Transparency ===
-Embedded ContainerControls must have their Transparent property set to False. On Windows, setting this to True causes a litany issues, but GraffitiGrid simulates transparency on containers by setting the Backdrop of the ContainerControl to the content of the space it occupies on the Grid. This allows ContainerControls that are embedded to display the Hover or Selection color, or allows you to perform other customizations in the Draw* events.+Embedded ContainerControls must have their Transparent property set to False. On Windows, setting this to True causes a litany of issues, but GraffitiGrid simulates transparency on containers by setting the Backdrop of the ContainerControl to the content of the space it occupies on the Grid. This allows ContainerControls that are embedded to display the Hover or Selection color, or allows you to perform other customizations in the Draw* events.