PRIM_LIST.Label (PRIM_LIST.Label)

Material Design Label to be shown in column

Ancestors - List Column (PRIM_LIST.Column) Object (PRIM_OBJT)

Details

A Label is a simple control used to display a Caption and Icon as a column of List (PRIM_LIST).

Properties

NameDescription
CaptionText to be displayed within the label
CaptionAlignmentPosition of the caption within the control
CaptionMarginBottomBottom margin in pixels
CaptionMarginLeftLeft margin in pixels
CaptionMarginRightRight margin in pixels
CaptionMarginTopTop margin in pixels
CellAlignmentPosition of the content of a list cell. Inherited from List Column (PRIM_LIST.Column)
CellHeightHeight of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginBottomBottom margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginLeftLeft margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginRightRight margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginTopTop margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellSizingSizing behavior of a list cell allowing for the content to only use a portion of the cell Inherited from List Column (PRIM_LIST.Column)
CellThemeDrawStyleDrawstyle to be used in list cell
CellWidthWidth of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionCaption displayed in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionAlignAlignment of the text in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionTextCaption displayed in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionTypeType of caption to appear in the column header
ColumnCaptionWordWrapWrap text on to the next line if there is insufficient space Inherited from List Column (PRIM_LIST.Column)
ColumnImageImage to be show in the column heading Inherited from List Column (PRIM_LIST.Column)
ColumnImageHeightSet the height and width of the column image in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMaxWidthMaximum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMinWidthMinimum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMouseOverStyleStyle to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnMouseOverStylesCollection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnPinnedPin the column to the left or right hand sides of the list Inherited from List Column (PRIM_LIST.Column)
ColumnPopupPopup Panel to display as a menu Inherited from List Column (PRIM_LIST.Column)
ColumnPopupImageImage to display in the column header in place of the default image Inherited from List Column (PRIM_LIST.Column)
ColumnPressedStyleStyle to be applied to the column header on click Inherited from List Column (PRIM_LIST.Column)
ColumnPressedStylesCollection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnResizeSpecifies whether the column can be manually resized Inherited from List Column (PRIM_LIST.Column)
ColumnStyleStyle to be applied to the column Inherited from List Column (PRIM_LIST.Column)
ColumnStylesCollection of styles to be applied to the column Inherited from List Column (PRIM_LIST.Column)
ColumnThemeDrawStyleName of the Theme DrawStyle to be applied to the column heading Inherited from List Column (PRIM_LIST.Column)
ColumnUnitsSpecifies whether the column is a specific width or uses a proportion of the available space (See ColumnWidth) Inherited from List Column (PRIM_LIST.Column)
ColumnVisibleShow or hide the column Inherited from List Column (PRIM_LIST.Column)
ColumnWidthWidth of the column. See the ColumnUnits property Inherited from List Column (PRIM_LIST.Column)
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
CurrentItemThe last item in the list touched either in the UI or via a list related command
DisplayPositionPosition of the column relative to the other columns Inherited from List Column (PRIM_LIST.Column)
EllipsesSpecifies if ellipses are displayed when text is truncated
EnabledEnable or disable the column contents Inherited from List Column (PRIM_LIST.Column)
FocusItemReference to the focus label in the focus entry of the list
IconIcon to be used in label
IconAlignmentPosition of the caption within the control
IconColorColor to be applied to the icon
IconFileNameFileName is the name of image file
IconHeightHeight of the icon in pixels
IconImageImage to be shown on the control
IconImageSizingSpecifies the sizing behavior of the IconImage
IconMarginBottomBottom margin in pixels
IconMarginLeftLeft margin in pixels
IconMarginRightRight margin in pixels
IconMarginTopTop margin in pixels
IconOpacityPercentage opacity of the icon
IconPaddingPadding of an Icon in pixels
IconThemeDrawStyleName of the Theme DrawStyle to be applied to the icon
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
PaddingBottomBottom padding in pixels
PaddingLeftLeft padding in pixels
PaddingRightRight padding in pixels
PaddingTopTop padding in pixels
ParentReference to the list containing the column Inherited from List Column (PRIM_LIST.Column)
SortAsColumnSpecifies an alternate column to use to sort the data Inherited from List Column (PRIM_LIST.Column)
SortDirectionSort the column ascending or descending Inherited from List Column (PRIM_LIST.Column)
SortOnClickSort the column when the column header is clicked
SortPositionPosition of the column in the sort sequence Inherited from List Column (PRIM_LIST.Column)
SourceField label is sourced from
StyleStyles to be applied to the item Inherited from List Column (PRIM_LIST.Column)
StylesCollection of styles to be applied to the item Inherited from List Column (PRIM_LIST.Column)
ThemeDrawStyleThemeDrawStyle to be applied to the column Inherited from List Column (PRIM_LIST.Column)
VisibleShow or hide the content of a cell Inherited from List Column (PRIM_LIST.Column)
WordWrapWrap text on to the next line if there is insufficient space

Events

NameDescription
ClickFires when label column is clicked on
ColumnClickFired when the column header is clicked Inherited from PRIM_LIST.Label (PRIM_LIST.Label)
Origin, Handled
ColumnDoubleClickFired when the column header is DoubleClicked Inherited from PRIM_LIST.Label (PRIM_LIST.Label)
Origin, Handled
ColumnMouseEnterFired when the mouse enters the bounds of the column Inherited from PRIM_LIST.Label (PRIM_LIST.Label)
ColumnMouseLeaveFired when the mouse leaves the bounds of the column Inherited from PRIM_LIST.Label (PRIM_LIST.Label)
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from PRIM_LIST.Label (PRIM_LIST.Label)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from PRIM_LIST.Label (PRIM_LIST.Label)
DoubleClickFires when label column is double clicked on

Methods

NameDescription
SizeToContentsSet the column width to the widest content Inherited from List Column (PRIM_LIST.Column)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020