LEADTOOLS WPF and Silverlight (Leadtools.Windows.Controls assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
EnsureVisible Method
See Also 
Leadtools.Windows.Controls Namespace > ImageList Class : EnsureVisible Method



index
The zero-based index of the item to scroll into view.
index
The zero-based index of the item to scroll into view.
Ensures that the specified item is visible within the control, scrolling the contents of the control if necessary. Supported in Silverlight, Windows Phone 7

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
)
C++/CLI 
public:
void EnsureVisible( 
   int index
)

Parameters

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

Example

Visual BasicCopy Code
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
C#Copy Code
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";
}
SilverlightCSharpCopy Code
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);
}
SilverlightVBCopy Code
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

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.

Requirements

Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also