List Reusable Part Column (PRIM_LIST.Part)
Column displaying a reusable part in the cell
Ancestors - List Column (PRIM_LIST.Column)Object (PRIM_OBJT)
Details
Prim_List.Part is a column in a List used to present an instance of a reusable part rather than the typical field based cell. Each column type has a corresponding CurrentItem class that provides access to the individual entries in the column accessible via the CurrentItem property. The part used in the column must implement the Prim_list.iListCellDesign interface. This cell can represent several field values. A part column is created whenever a reusable part is dropped on the list. The Design property defines the class of part being used. The *ListFields parameter used in the resuable part will define the data fields for the column.
Example
In this example, a simple part displays an address as a single cell rather than using 4 separate columns.
Begin_Com Role(*EXTENDS #PRIM_PANL *implements #prim_list.IListCellDesign *ListFields #ListFields) Displayposition(1) Height(68) Left(0) Tabposition(1) Top(0) Width(217) Layoutmanager(#TableLayout)
Group_By Name(#ListFields) Fields(#Address1 #Address2 #address3 #postcode)
Define_Com Class(#PRIM_TBLO) Name(#TableLayout)
Define_Com Class(#PRIM_TBLO.Row) Name(#Row1) Displayposition(1) Parent(#TableLayout)
Define_Com Class(#PRIM_TBLO.Column) Name(#Column1) Displayposition(1) Parent(#TableLayout)
Define_Com Class(#PRIM_LABL) Name(#gAddress) Caption('') Displayposition(1) Ellipses(End) Left(0) Parent(#COM_OWNER) Tabposition(1) Tabstop(False) Top(0) Height(68) Width(217) Verticalalignment(Center) Marginleft(2) Marginright(2)
Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutItem) Alignment(TopLeft) Column(#Column1) Flow(Down) Manage(#gAddress) Parent(#TableLayout) Row(#Row1) Rowspan(3)
Mthroutine Name(OnAdd) Options(*redefine)
#gAddress := ("&1, &2, &3, &4").Substitute( #Address1 #Address2 #Address3 #PostCode.AsString )
Endroutine
End_Com
Properties
| Name | Description |
|---|---|
| CellAlignment | Position of the content of a list cell. Inherited from List Column (PRIM_LIST.Column) |
| CellHeight | Height of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column) |
| CellMarginBottom | Bottom margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column) |
| CellMarginLeft | Left margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column) |
| CellMarginRight | Right margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column) |
| CellMarginTop | Top margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column) |
| CellSizing | Sizing behavior of a list cell allowing for the content to only use a portion of the cell Inherited from List Column (PRIM_LIST.Column) |
| CellThemeDrawStyle | Drawstyle for list cell |
| CellWidth | Width of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column) |
| ColumnCaption | Caption displayed in the column header Inherited from List Column (PRIM_LIST.Column) |
| ColumnCaptionAlign | Alignment of the text in the column header Inherited from List Column (PRIM_LIST.Column) |
| ColumnCaptionText | Caption displayed in the column header Inherited from List Column (PRIM_LIST.Column) |
| ColumnCaptionWordWrap | Wrap text on to the next line if there is insufficient space Inherited from List Column (PRIM_LIST.Column) |
| ColumnImage | Image to be show in the column heading Inherited from List Column (PRIM_LIST.Column) |
| ColumnImageHeight | Set the height and width of the column image in pixels Inherited from List Column (PRIM_LIST.Column) |
| ColumnMaxWidth | Maximum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column) |
| ColumnMinWidth | Minimum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column) |
| ColumnMouseOverStyle | Style to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column) |
| ColumnMouseOverStyles | Collection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column) |
| ColumnPinned | Pin the column to the left or right hand sides of the list Inherited from List Column (PRIM_LIST.Column) |
| ColumnPopup | Popup Panel to display as a menu Inherited from List Column (PRIM_LIST.Column) |
| ColumnPopupImage | Image to display in the column header in place of the default image Inherited from List Column (PRIM_LIST.Column) |
| ColumnPressedStyle | Style to be applied to the column header on click Inherited from List Column (PRIM_LIST.Column) |
| ColumnPressedStyles | Collection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column) |
| ColumnResize | Specifies whether the column can be manually resized Inherited from List Column (PRIM_LIST.Column) |
| ColumnStyle | Style to be applied to the column Inherited from List Column (PRIM_LIST.Column) |
| ColumnStyles | Collection of styles to be applied to the column Inherited from List Column (PRIM_LIST.Column) |
| ColumnThemeDrawStyle | Name of the Theme DrawStyle to be applied to the column heading Inherited from List Column (PRIM_LIST.Column) |
| ColumnUnits | Specifies whether the column is a specific width or uses a proportion of the available space (See ColumnWidth) Inherited from List Column (PRIM_LIST.Column) |
| ColumnVisible | Show or hide the column Inherited from List Column (PRIM_LIST.Column) |
| ColumnWidth | Width of the column. See the ColumnUnits property Inherited from List Column (PRIM_LIST.Column) |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentMembers | ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
| ComponentPatternName | ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
| ComponentTag | Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
| ComponentType | ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
| ComponentTypeName | ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
| CurrentItem | The last item in the list touched either in the UI or via a list related command |
| Design | Reusable part to be used as a design for the cell |
| DisplayPosition | Position of the column relative to the other columns Inherited from List Column (PRIM_LIST.Column) |
| Enabled | Enable or disable the column contents Inherited from List Column (PRIM_LIST.Column) |
| FocusItem | Reference to the focus item in the column |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | Reference to the list containing the column Inherited from List Column (PRIM_LIST.Column) |
| SortAsColumn | Specifies an alternate column to use to sort the data Inherited from List Column (PRIM_LIST.Column) |
| SortDirection | Sort the column ascending or descending Inherited from List Column (PRIM_LIST.Column) |
| SortOnClick | Sort the column when the column header is clicked |
| SortPosition | Position of the column in the sort sequence Inherited from List Column (PRIM_LIST.Column) |
| Style | Styles to be applied to the item Inherited from List Column (PRIM_LIST.Column) |
| Styles | Collection of styles to be applied to the item Inherited from List Column (PRIM_LIST.Column) |
| ThemeDrawStyle | ThemeDrawStyle to be applied to the column Inherited from List Column (PRIM_LIST.Column) |
| Visible | Show or hide the content of a cell Inherited from List Column (PRIM_LIST.Column) |
Events
| Name | Description |
|---|---|
| ColumnClick | Fired when the column header is clicked Inherited from List Column (PRIM_LIST.Column) Origin, Handled |
| ColumnDoubleClick | Fired when the column header is DoubleClicked Inherited from List Column (PRIM_LIST.Column) Origin, Handled |
| ColumnMouseEnter | Fired when the mouse enters the bounds of the column Inherited from List Column (PRIM_LIST.Column) |
| ColumnMouseLeave | Fired when the mouse leaves the bounds of the column Inherited from List Column (PRIM_LIST.Column) |
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from List Column (PRIM_LIST.Column) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List Column (PRIM_LIST.Column) |
Methods
| Name | Description |
|---|---|
| SizeToContents | Set the column width to the widest content Inherited from List Column (PRIM_LIST.Column) |
See also
LANSA Version 15, April 2020