Image Brush (PRIM_VS.ImageBrush)
Brush used to apply an image as style
Ancestors - Brush (PRIM_VS.Brush)Object (PRIM_OBJT)
Details
An Image Brush is used to apply an image to a control rather than colors. A typical use for this would be as watermark or background image for an application.
Example
This example shows a simple ImageBrush. The IDE will manage the creation of styles and brushes. This code is provided for reference purposes.
Define_Com Class(#PRIM_VS.Style) Name(#Style1) Backgroundbrush(#Backgroundbrush1) Define_Com Class(#PRIM_VS.ImageBrush) Name(#Backgroundbrush1) Image(#xImageImage256) Opacity(30) Alignment(BottomRight)
Properties
| 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) |
| Height | Height of the image |
| Image | Repository enrolled image to show in the control |
| 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 |
Events
| Name | Description |
|---|---|
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Image Brush (PRIM_VS.ImageBrush) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Image Brush (PRIM_VS.ImageBrush) |
See also
LANSA Version 15, April 2020