Visual Brush (PRIM_VS.VisualBrush)

Base class for all brushes

Ancestors - Brush (PRIM_VS.Brush)Object (PRIM_OBJT)


A Visual Brush is used to apply a "live" image of a Control to a control rather than colors or an image.
A typical use for this would be as the image when dragging and dropping.


This example has a visual brush showing an enlarged image of the button.
Function Options(*DIRECT)
Begin_Com Role(*EXTENDS #PRIM_FORM) Clientheight(400) Clientwidth(703) Height(439) Width(719) Left(218) Top(203)
   Define_Com Class(#PRIM_VS.Style) Name(#Style) Backgroundbrush(#Brush)
   Define_Com Class(#PRIM_VS.VisualBrush) Name(#Brush) Control(#Button) Sizing(BestFit)
   Define_Com Class(#PRIM_PHBN) Name(#Button) Caption('Click me') Displayposition(1) Left(8) Parent(#COM_OWNER) Tabposition(1) Top(8) Height(41) Width(105) Wordwrap(True)
   Define_Com Class(#PRIM_PANL) Name(#Panel1) Displayposition(2) Left(176) Parent(#COM_OWNER) Tabposition(2) Tabstop(False) Top(8) Height(369) Width(513) Style(#Style)
   Evtroutine Handling(#Button.Click)
      #Button.Caption := "Clicked"


Name Description
Alignment Position of the image
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)
Control Reference to the control used to generate the image
Height Height of the image
Left Horizontal position of the image
Name Name identifies the component Inherited from Object (PRIM_OBJT)
Opacity Opacity of the image
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)
Sizing Behavior of the image when it does not fit the space available
Tile Use tiling to repeat the image
Top Vertical position of the image
Units Allows the brush to be rendered using a specific size or as a percentage
Width Width of the image


Name Description
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Visual Brush (PRIM_VS.VisualBrush)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Visual Brush (PRIM_VS.VisualBrush)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020