GraffitiSuite Docs
Docs
Graffitigridcolumn
Loading document parsing libraries...
# GraffitiGridColumn Class ## Compatibility ### Framework API Version | 1.0 | 2.0 | | :---: | :---: | | False | True | ### iOS | 32-Bit | 64-Bit | | :---: | :---: | | False | True | ## Enumerations | Name | Value | Description | | --- | :---: | --- | | Alignments | Left <br> Center <br> Right | Supported cell alignment values. | | SortDirections | Unsorted <br> Ascending <br> Descending | Supported sort directions. | | SortResults | LessThan <br> EqualTo <br> GreaterThan | Sort comparison result values. | ## Delegates | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | SortFunction | value1 as Variant <br> value2 as Variant | SortResults | Delegate function definition for sorting methods. | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | Constructor | name as String <br> text as String <br> width as String = "*" | (None) | Creates a new instance. | | Destroy | (None) | (None) | Removes all outside references and readies the column for deconstruction. | | Invalidate | (None) | (None) | Invalidates the column's cached Pictures to be redrawn upon the next parent GraffitiGrid's refresh. | | Sort | direction as GraffitiGridColumn.SortDirections | (None) | Sorts the column. | ## Shared Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | SortBoolean | value1 as Variant <br> value2 as Variant | GraffitiGridColumn.SortResults | A basic Boolean sorting algorithm for use in SortDelegate properties. | | SortColor | value1 as Variant <br> value2 as Variant | GraffitiGridColumn.SortResults | A basic Color sorting algorithm for use in SortDelegate properties. | | SortNumeric | value1 as Variant <br> value2 as Variant | GraffitiGridColumn.SortResults | A basic numeric sorting algorithm for use in SortDelegate properties. | | SortString | value1 as Variant <br> value2 as Variant | GraffitiGridColumn.SortResults | A basic String sorting algorithm for use in SortDelegate properties. | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | ActualWidth | Double | Nil | Actual width of the column within its parent GraffitiGrid's viewport. | | Alignment | Alignments | Nil | The justification of the column's contents. | | Attributes | image | Picture | | | Attributes | mCellEditor | GraffitiGridCellEditor | | | Attributes | mCellRenderer | GraffitiGridCellRenderer | | | Attributes | mFontName | String | | | Attributes | mFontSize | Integer | | | Attributes | mFontStyle | GraffitiUIControl.FontStyles | | | Attributes | mFrozen | Boolean | | | Attributes | mMinimumWidth | Integer | | | Attributes | mObserver | GraffitiUpdateInterface | | | Attributes | mSortDirection | GraffitiGridColumn.SortDirections | | | Attributes | mText | String | | | Attributes | mTextColor | ColorGroup | | | Attributes | mVisible | Boolean | | | Attributes | needsRedraw | Boolean | | | Attributes | mBackgroundColor | ColorGroup | | | Attributes | mAlignment | Alignments | | | Attributes | mActualWidth | Double | | | BackgroundColor | ColorGroup | Nil | ColorGroup used to draw the background of the column's header and cells. | | CanSort | Boolean | Nil | Allows the column to be sorted by the user. | | CellEditor | GraffitiGridCellEditor | Nil | GraffitiGridCellEditor controller used for edit operations of cells within this column. | | CellRenderer | GraffitiGridCellRenderer | Nil | GraffitiGridCellRenderer class instance used for drawing column cell contents. | | FontName | String | Nil | Font name used for drawing header and cells. | | FontSize | Integer | Nil | Text font size used for drawing. | | FontStyle | GraffitiUIControl.FontStyles | Nil | Style of font used to draw text content. | | Frozen | Boolean | Nil | Controls whether the column is always drawn in a left-hand pane and scrolled independently of non-frozen columns. | | MinimumWidth | Integer | Nil | Minimum allowed width for column. | | Name | String | Nil | Column name used for data association. | | SortDelegate | SortFunction | Nil | Function to use for sorting operations. | | SortDirection | GraffitiGridColumn.SortDirections | Nil | Current direction of the column's sort. | | Tag | Variant | Nil | Developer storage. | | Text | String | Nil | Text to display in the column's header. | | TextColor | ColorGroup | Nil | ColorGroup applied to column's default text drawing. | | Visible | Boolean | Nil | Controls whether the column is visible within its parent GraffitiGrid's viewport. | | Width | String | Nil | Width of the column. Valid values: 100 = Actual width in points. 10% = Percentage width of parent GraffitiGrid's entire viewport. * = Split value among all columns without an otherwise set width. |