List Badge control (PRIM_MD.ListBadge)

Badge that is repeated for each entry in the list

Ancestors - Badge (PRIM_MD.Badge) Label (PRIM_MD.Label) Control (PRIM_MD.Control) Control (PRIM_CTRL) Object (PRIM_OBJT)

Details

Prim_MD.ListBadge is a Badge in a List.
 
Each Badge type has a corresponding CurrentItem class that provides access to the individual entries accessible via the CurrentItem property.
 
A list Badge control is created whenever a badge is dragged and dropped onto another control contained in a list from the controls view.

Example

In this example the badge is the orphan of a flat button that is in the list.
 
When the the button is clicked the badge of the current item will display the number of time the button was clicked as its caption.
 
 
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(241) Width(633) Theme(#SYS_THEME) Layoutmanager(#LayoutPage)
 
    Define_Com Class(#PRIM_TBLO) Name(#LayoutPage)
    Define_Com Class(#PRIM_TBLO.Row) Name(#LayoutPageRow) Displayposition(1) Parent(#LayoutPage)
    Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutPageColumn) Displayposition(1) Parent(#LayoutPage)
    Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutPageItem) Column(#LayoutPageColumn) Manage(#List) Parent(#LayoutPage) Row(#LayoutPageRow) sizing(FitBoth)
 
    Define_Com Class(#PRIM_TBLO) Name(#LayoutList)
    Define_Com Class(#PRIM_TBLO.Row) Name(#LayoutListRow) Parent(#LayoutList) Displayposition(1)
    Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutListColumn) Parent(#LayoutList) Displayposition(1)
    Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutListItem) Column(#LayoutListColumn) Manage(#ListButton) Parent(#LayoutList) Row(#LayoutListRow) Row(#LayoutListRow) Marginbottom(10) Marginleft(10) Marginright(10) Margintop(10) sizing(FitBoth)
 
    Define_Com Class(#prim_md.List) Name(#List) Parent(#COM_OWNER) Displayposition(1) Tabposition(1) Left(0) Top(0) Height(241) Width(633) Layoutmanager(#LayoutList)
    Define_Com Class(#Prim_md.ListFlatButton) Name(#ListButton) Parent(#List) Displayposition(1) Tabposition(1) Height(30) Width(613)
    Define_Com Class(#PRIM_MD.ListBadge) Name(#ListBadge) Displayposition(1) Dragstyle(None) Tabposition(1) Height(16) Width(16) Parent(#ListButton) Left(607) Top(-10) Visible(False)
 
 
        Evtroutine Handling(#Com_owner.CreateInstance)
 
            Begin_Loop To(10)
 
                Add_Entry To_List(#List)
 
                #ListButton.CurrentItem.Caption := 'Click Me'
 
            End_Loop
 
        Endroutine
 
 
        Evtroutine Handling(#ListButton.Click)
 
            #ListBadge.CurrentItem.Visible := True
 
            #ListBadge.CurrentItem.Caption := (#ListBadge.CurrentItem.Caption.AsNumber + 1).AsString
 
        Endroutine
 
End_Com

Properties

NameDescription
BadgeAlignmentPosition of the badge relative to the Control Inherited from Badge (PRIM_MD.Badge)
BadgeMarginBottomBottom margin in pixels Inherited from Badge (PRIM_MD.Badge)
BadgeMarginLeftLeft margin in pixels Inherited from Badge (PRIM_MD.Badge)
BadgeMarginRightRight margin in pixels Inherited from Badge (PRIM_MD.Badge)
BadgeMarginTopTop margin in pixels Inherited from Badge (PRIM_MD.Badge)
BadgeSizingSpecifies the sizing behaviour of the Badge Inherited from Badge (PRIM_MD.Badge)
BusyUpdatesBusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParentBusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocusCanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
CaptionText to be displayed within the label Inherited from Label (PRIM_MD.Label)
CaptionAlignmentPosition of the caption within the control Inherited from Label (PRIM_MD.Label)
CaptionMarginBottomBottom margin in pixels Inherited from Label (PRIM_MD.Label)
CaptionMarginLeftLeft margin in pixels Inherited from Label (PRIM_MD.Label)
CaptionMarginRightRight margin in pixels Inherited from Label (PRIM_MD.Label)
CaptionMarginTopTop margin in pixels Inherited from Label (PRIM_MD.Label)
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
CursorCursor sets the cursor image Inherited from Control (PRIM_CTRL)
DisplayPositionDisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyleDragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
EllipsesShow ellipses for truncated text Inherited from Label (PRIM_MD.Label)
EnabledEnable activates/deactivates the component Inherited from Control (PRIM_CTRL)
FixedPositionFix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
FocusFocus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusedStyleReference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStylesCollection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusItemReference to the badge in the focus entry of the list
HandleReturns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HeightThe height of the control in pixels Inherited from Control (PRIM_CTRL)
HintCaption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShowEnabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParentDelegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitleHintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
IconImage displayed within the control Inherited from Label (PRIM_MD.Label)
IconAlignmentPosition of the icon within the control Inherited from Label (PRIM_MD.Label)
IconColorColor to be applied to the icon Inherited from Label (PRIM_MD.Label)
IconHeightHeight of the icon in pixels Inherited from Label (PRIM_MD.Label)
IconImageMaterial design image to show on the control Inherited from Label (PRIM_MD.Label)
IconImageSizingSpecifies the sizing behaviour of the IconImage Inherited from Label (PRIM_MD.Label)
IconMarginBottomBottom margin in pixels Inherited from Label (PRIM_MD.Label)
IconMarginLeftLeft margin in pixels Inherited from Label (PRIM_MD.Label)
IconMarginRightRight margin in pixels Inherited from Label (PRIM_MD.Label)
IconMarginTopTop margin in pixels Inherited from Label (PRIM_MD.Label)
IconOpacityPercentage opacity of the icon Inherited from Label (PRIM_MD.Label)
IconThemeDrawStyleName of the Theme DrawStyle to be applied to the icon Inherited from Label (PRIM_MD.Label)
IsAnimatingIsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealizedTrue if the control is currently realized Inherited from Control (PRIM_CTRL)
LeftPosition of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
ModifiedModified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
MouseOverMouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverStyleMouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStylesMouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
NameName identifies the component Inherited from Object (PRIM_OBJT)
OpacityOpacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
PaddingBottomBottom padding in pixels Inherited from Label (PRIM_MD.Label)
PaddingLeftLeft padding in pixels Inherited from Label (PRIM_MD.Label)
PaddingRightRight padding in pixels Inherited from Label (PRIM_MD.Label)
PaddingTopTop padding in pixels Inherited from Label (PRIM_MD.Label)
ParentReference to the Object containing the badge Inherited from Badge (PRIM_MD.Badge)
PopupPopup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenuReference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
RotationRotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeftRotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTopRotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
ScaleHeightScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeftScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTopScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidthScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeftScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTopScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeftLeft position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTopTop position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SkewLeftSkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeftSkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTopSkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTopSkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
StyleStyle defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
StylesCollection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPositionTabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStopSet to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
ThemeBackgroundBackground theme to be used Inherited from Control (PRIM_MD.Control)
ThemeDrawStyleName of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
TopPosition of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMoveDetermines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotateDetermines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScaleDetermines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSizeDetermines whether a control can be resized Inherited from Control (PRIM_CTRL)
VisibleShow or hide the control Inherited from Control (PRIM_CTRL)
VisualStyleVisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParentAdopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
WidthWidth of the component in pixels Inherited from Control (PRIM_CTRL)
WordWrapWrap text on to the next line if there is insufficient space Inherited from Label (PRIM_MD.Label)

Events

NameDescription
AnimationEndedFired when an animation is ended Inherited from Label (PRIM_MD.Label)
Cancelled
ClickFired when the mouse is clicked on the control Inherited from Label (PRIM_MD.Label)
Origin, Handled
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Label (PRIM_MD.Label)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Label (PRIM_MD.Label)
DragDropFired on mouse up to signify the end of a drag process Inherited from Label (PRIM_MD.Label)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOverFired during the drag and drop process when the cursor moves over the control Inherited from Label (PRIM_MD.Label)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
EndDragFired when the drag and drop process has completed Inherited from Label (PRIM_MD.Label)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
InitializeFired after a component has been realized for the first time Inherited from Label (PRIM_MD.Label)
MouseEnterThe mouse has entered the bounds of the control Inherited from Label (PRIM_MD.Label)
MouseHoverThe mouse has hovered over the control Inherited from Label (PRIM_MD.Label)
Origin, Handled
MouseLeaveThe mouse has left the bounds of the control Inherited from Label (PRIM_MD.Label)
StartDragFired when the user starts a drag and drop process Inherited from Label (PRIM_MD.Label)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChangeFired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Label (PRIM_MD.Label)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEndFired when the user stops touching the screen Inherited from Label (PRIM_MD.Label)
TouchStartFired when the user first makes physical contact with the screen Inherited from Label (PRIM_MD.Label)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

NameDescription
FadeInAnimate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOutAnimate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
MoveFromMove a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveToAnimate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
RealizeCreates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
ScaleAnimate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SetFocusSets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowMessagesLANSA Internal Use Inherited from Control (PRIM_CTRL)
UnrealizeDestroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplayUpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2