DirectoryVirtualListView Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

The DirectoryVirtualListView class specifies how to conduct a virtual list view search. A virtual list view search enables users to view search results as address-book style virtual list views. It is specifically designed for very large result sets. Search data is retrieved in contiguous subsets of a sorted directory search.

Namespace:   System.DirectoryServices
Assembly:  System.DirectoryServices (in System.DirectoryServices.dll)

System.Object
  System.DirectoryServices.DirectoryVirtualListView

type DirectoryVirtualListView = class end

NameDescription
System_CAPS_pubmethodDirectoryVirtualListView()

Initializes a new instance of the DirectoryVirtualListView class.

System_CAPS_pubmethodDirectoryVirtualListView(Int32)

Initializes a new instance of the DirectoryVirtualListView class with the after count set.

System_CAPS_pubmethodDirectoryVirtualListView(Int32, Int32, Int32)

Initializes a new instance of the DirectoryVirtualListView class with the before count, after count, and offset set.

System_CAPS_pubmethodDirectoryVirtualListView(Int32, Int32, Int32, DirectoryVirtualListViewContext)

Initializes a new instance of the DirectoryVirtualListView class with the before count, after count, offset and context set.

System_CAPS_pubmethodDirectoryVirtualListView(Int32, Int32, String)

Initializes a new instance of the DirectoryVirtualListView class with the before count, after count, and target set.

System_CAPS_pubmethodDirectoryVirtualListView(Int32, Int32, String, DirectoryVirtualListViewContext)

Initializes a new instance of the DirectoryVirtualListView class with the before count, after count, target and context set.

NameDescription
System_CAPS_pubpropertyAfterCount

Gets or sets a value to indicate the number of entries after the target entry that the client is requesting from the server.

System_CAPS_pubpropertyApproximateTotal

Gets or sets a value to indicate the estimated total count of items in the list.

System_CAPS_pubpropertyBeforeCount

Gets or sets a value to indicate the number of entries before the target entry that the client is requesting from the server.

System_CAPS_pubpropertyDirectoryVirtualListViewContext

Gets or sets a value to indicate the virtual list view search response.

System_CAPS_pubpropertyOffset

Gets or sets a value to indicate the target entry's offset within the list.

System_CAPS_pubpropertyTarget

The Target property gets or sets a value to indicate the target entry that was requested by the client.

System_CAPS_pubpropertyTargetPercentage

The TargetPercentage property gets or sets a value to indicate the estimated target entry's requested offset within the list, as a percentage of the total number of items in the list.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The following C# example shows how to retrieve the first 30 entries in a result set.

using System.DirectoryServices;
...
DirectorySearcher src = new DirectorySearcher("…"); 
src.VirtualListView = new DirectoryVirtualListView(0,30);
foreach(SearchResult res in src.FindAll() )
{
    Console.WriteLine(…");
}

The following C# example shows how to retrieve the first 50 entries in a result set that start with the letters "Ha".

using System.DirectoryServices;
...
DirectorySearcher src = new DirectorySearcher("…"); 
src.VirtualListView = new DirectoryVirtualListView(0,50, "Ha");
foreach(SearchResult res in src.FindAll() )
{
    Console.WriteLine(…");
}

The following C# example shows how to retrieve the first 100 entries at the 60% approximate target.

using System.DirectoryServices;
...
// First VLV calls. 
DirectorySearcher src = new DirectorySearcher("…"); 
src.VirtualListView = new DirectoryVirtualListView(100);
foreach(SearchResult res in src.FindAll() )
{
    Console.WriteLine(…");
}

// Second Call, the VLV context is still attached to the DirectorySearcher.
src.VirtualListView.TargetPercentage = 60;
src.VirtualListView.BeforeCount = 50;
src.VirtualListView.AfterCount = 50;

foreach(SearchResult res in src.FindAll() )
{
    Console.WriteLine(…");
}


.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: