←Select platform

SelectUserImage Property

Summary

Gets or sets a user-defined image to use as the selection marker.

Syntax

C++

public RasterImage SelectUserImage { get; set; }

  
<BrowsableAttribute(False)> 
Public Property SelectUserImage As Leadtools.RasterImage

[BrowsableAttribute(false)] 
public: 
property Leadtools.RasterImage^ SelectUserImage { 
   Leadtools.RasterImage^ get(); 
   void set (    Leadtools.RasterImage^ ); 
}

Property Value

A user-defined Leadtools.RasterImage to use as the selection marker. Default value is null (Nothing in VB).

Remarks

The user defined image selection marker is used only when ViewStyle is set to RasterImageListViewStyle.Normal. It is ignored in all other styles.

When you set an image into the SelectUserImage, the specified image will be displayed around each selected item.

Normally, you would want to set a transparent color into this image using the RasterImage.Transparent and RasterImage.TransparentColor properties of the Leadtools.RasterImage class.

Example

using Leadtools.WinForms; 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Drawing; 
 
/// This example will use a user-defined image as the selection marker of an <see cref="RasterImageList"/> control. 
public void RasterImageList_SelectUserImage(RasterImageList imageList) 
{ // Use "Normal" view style 
   imageList.ViewStyle = RasterImageListViewStyle.Normal; 
 
   // Create the user-defined image to use as the selection marker (an ellipse) 
   RasterColor[] palette = new RasterColor[0]; 
   RasterImage selectImage = new RasterImage( 
      RasterMemoryFlags.Conventional, 
      imageList.ItemSize.Width, 
      imageList.ItemSize.Height, 
      24, 
      RasterByteOrder.Bgr, 
      RasterViewPerspective.TopLeft, 
      palette, 
      IntPtr.Zero, 
      0); 
 
   // Draw the ellipse 
   IntPtr hdc = RasterImagePainter.CreateLeadDC(selectImage); 
   Graphics g = Graphics.FromHdc(hdc); 
 
   Rectangle rc = new Rectangle(0, 0, selectImage.ImageWidth, selectImage.ImageHeight); 
   g.FillRectangle(Brushes.Black, rc); 
   for (int i = 0; i < 4; i++) 
   { 
      g.DrawEllipse(Pens.Red, rc.Left, rc.Top, rc.Width - 1, rc.Height - 1); 
      rc.Inflate(-1, -1); 
   } 
 
   g.Dispose(); 
   RasterImagePainter.DeleteLeadDC(hdc); 
 
   // Set the transparent color 
   selectImage.Transparent = true; 
   selectImage.TransparentColor = RasterColor.FromKnownColor(RasterKnownColor.Black); 
 
   // Set this image as the selection marker 
   imageList.SelectUserImage = selectImage; 
}

Imports Leadtools.WinForms 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Drawing 
 
''' This example will use a user-defined image as the selection marker for a <see cref="RasterImageList"/> control. 
Public Sub RasterImageList_SelectUserImage(ByVal imageList As RasterImageList) 
   imageList.ViewStyle = RasterImageListViewStyle.Normal 
 
   ' Create the user-defined image to use as the selection marker (an ellipse) 
   Dim palette As RasterColor() = New RasterColor() {} 
   Dim selectImage As RasterImage = New RasterImage(RasterMemoryFlags.Conventional, imageList.ItemSize.Width, imageList.ItemSize.Height, 24, 
                                                    RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, palette, IntPtr.Zero, 0) 
 
   ' Draw the ellipse 
   Dim hdc As IntPtr = RasterImagePainter.CreateLeadDC(selectImage) 
   Dim g As Graphics = Graphics.FromHdc(hdc) 
 
   Dim rc As Rectangle = New Rectangle(0, 0, selectImage.ImageWidth, selectImage.ImageHeight) 
   g.FillRectangle(Brushes.Black, rc) 
   For i As Integer = 0 To 3 
      g.DrawEllipse(Pens.Red, rc.Left, rc.Top, rc.Width - 1, rc.Height - 1) 
      rc.Inflate(-1, -1) 
   Next i 
 
   g.Dispose() 
   RasterImagePainter.DeleteLeadDC(hdc) 
 
   ' Set the transparent color 
   selectImage.Transparent = True 
   selectImage.TransparentColor = RasterColor.FromKnownColor(RasterKnownColor.Black) 
 
   ' Set this image as the selection marker 
   imageList.SelectUserImage = selectImage 
End Sub

Requirements

Target Platforms

Reference

RasterImageList Class

RasterImageList Members

Help Version 19.0.2017.10.27