←Select platform

EnsureVisible Method

Summary

Ensures that the specified item is visible within the control, scrolling the contents of the control if necessary.

Syntax

C#
VB
C++
public void EnsureVisible( 
   int index 
) 
  
Public Sub EnsureVisible( _ 
   ByVal index As Integer _ 
)  
public: 
void EnsureVisible(  
   int index 
)  

Parameters

index
The zero-based index of the item to scroll into view.

Remarks

You can use this method to ensure that a specific item is visible within the ImageList control. When performing validation on the items in a ImageList, you can call the EnsureVisible method to ensure that an item that failed validation is displayed in the ImageList control to allow the user to perform changes on the item. If the item that you want to ensure is visible is located above the viewable region of the ImageList control, calling the EnsureVisible method will scroll the contents of the control until it is the first item in the viewable area of the control. If the item is below the viewable region of the ImageList control, calling the EnsureVisible method will scroll the contents of the ImageList control until the item is the last item in the viewable area of the control.

Example

C#
VB
Silverlight C#
Silverlight VB
using Leadtools.Help; 
using Leadtools.Windows.Controls; 
using Leadtools; 
using Leadtools.Codecs; 
 
public void ImageList_EnsureVisible(ImageList imageList) 
{ 
   imageList.Orientation = Orientation.Horizontal; 
 
   // Append the new item to the image list control 
   string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg"); 
   ImageListItem item = new ImageListItem(); 
   item.Source = new BitmapImage(new Uri(imageFileName)); 
   item.Text = "New Item"; 
 
   imageList.Items.Add(item); 
   int nIndex = imageList.Items.IndexOf(item); 
 
   // Make sure this new item is visible to the user 
   imageList.EnsureVisible(nIndex); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 
Imports Leadtools.Windows.Controls 
Imports Leadtools.Codecs 
Imports Leadtools 
 
Public Sub ImageList_EnsureVisible(ByVal imageList As ImageList) 
   imageList.Orientation = Orientation.Horizontal 
 
   ' Append the new item to the image list control 
   Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg") 
   Dim item As ImageListItem = New ImageListItem() 
   item.Source = New BitmapImage(New Uri(imageFileName)) 
   item.Text = "New Item" 
 
   imageList.Items.Add(item) 
   Dim nIndex As Integer = imageList.Items.IndexOf(item) 
 
   ' Make sure this new item is visible to the user 
   imageList.EnsureVisible(nIndex) 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 
using Leadtools.Help; 
using Leadtools.Windows.Controls; 
 
public void ImageList_EnsureVisible(ImageList imageList) 
{ 
   imageList.Orientation = Orientation.Horizontal; 
 
   // Append the new item to the image list control 
   string imageFileName = LeadtoolsExamples.Common.ImagesPath.Path + "cannon.jpg"; 
   ImageListItem item = new ImageListItem(); 
   item.Source = new BitmapImage(new Uri(imageFileName)); 
   item.Text = "New Item"; 
 
   imageList.Items.Add(item); 
   int nIndex = imageList.Items.IndexOf(item); 
 
   // Make sure this new item is visible to the user 
   imageList.EnsureVisible(nIndex); 
} 
Imports Leadtools.Windows.Controls 
 
Public Sub ImageList_EnsureVisible(ByVal imageList As ImageList) 
   imageList.Orientation = Orientation.Horizontal 
 
   ' Append the new item to the image list control 
   Dim imageFileName As String = LeadtoolsExamples.Common.ImagesPath.Path & "cannon.jpg" 
   Dim item As ImageListItem = New ImageListItem() 
   item.Source = New BitmapImage(New Uri(imageFileName)) 
   item.Text = "New Item" 
 
   imageList.Items.Add(item) 
   Dim nIndex As Integer = imageList.Items.IndexOf(item) 
 
   ' Make sure this new item is visible to the user 
   imageList.EnsureVisible(nIndex) 
End Sub 

Requirements

Target Platforms

See Also

Reference

ImageList Class

ImageList Members

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Windows.Controls Assembly