Leadtools.Windows.Controls Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.03.25
EnsureVisible Method
See Also  Example
Leadtools.Windows.Controls Namespace > ImageList Class : EnsureVisible Method




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

This member is available in the WPF Express Edition. See the LEADTOOLS products page for full details on more WPF features available with LEADTOOLS toolkits.

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

Syntax

Visual Basic (Declaration) 
Public Sub EnsureVisible( _
   ByVal index As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As ImageList
Dim index As Integer
 
instance.EnsureVisible(index)
C# 
public void EnsureVisible( 
   int index
)
Managed Extensions for C++ 
public: void EnsureVisible( 
   int index
) 
C++/CLI 
public:
void EnsureVisible( 
   int index
) 

Parameters

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

Example

This example will add a new item to the end of a ImageList control and make sure the item is visible to the user.

Visual BasicCopy Code
Public Sub ImageList_EnsureVisible(ByVal imageList As ImageList)
   imageList.ScrollStyle = ImageListScrollStyle.Horizontal
   ' Append the new item to the image list control
   Dim imageFileName As String = "C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1.jpg"
   Dim item As ImageListItem = New ImageListItem(New BitmapImage(New Uri(imageFileName)), "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
C#Copy Code
public void ImageList_EnsureVisible(ImageList imageList) 

   imageList.ScrollStyle = ImageListScrollStyle.Horizontal; 
   // Append the new item to the image list control 
   string imageFileName = @"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\slave.jpg"; 
   ImageListItem item = new ImageListItem(new BitmapImage(new Uri(imageFileName)), "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); 
}

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 an 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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Vista, and Windows Server 2003 family

See Also