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

NameDescription
AlignmentPosition of the image
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)
HeightHeight of the image
ImageRepository enrolled image to show in the control
LeftHorizontal position of the image
NameName identifies the component Inherited from Object (PRIM_OBJT)
OpacityOpacity of the image
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentThe 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)
SizingBehavior of the image when it does not fit the space available
TileUse tiling to repeat the image
TopVertical position of the image
UnitsAllows the brush to be rendered using a specific size or as a percentage
WidthWidth of the image

Events

NameDescription
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Image Brush (PRIM_VS.ImageBrush)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Image Brush (PRIM_VS.ImageBrush)

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2