SelectUserImage Property (RasterImageList)

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

[BrowsableAttribute(false)]
public RasterImage SelectUserImage {get; set;}

'Declaration
 
<BrowsableAttribute(False)>
Public Property SelectUserImage As RasterImage

'Usage
 
Dim instance As RasterImageList
Dim value As RasterImage
 
instance.SelectUserImage = value
 
value = instance.SelectUserImage

[BrowsableAttribute(false)]
public RasterImage SelectUserImage {get; set;}

BrowsableAttribute()
 get_SelectUserImage();
 set_SelectUserImage(value);

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

Property Value

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

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.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

''' 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

/// 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;
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterImageList Class
RasterImageList Members