FeaturedContentCollection.GetEnumerator Method (FeaturedContentSortField, SortDirection, Int32, Int32)
Retrieves an enumerator for a subset of the the featured content in the collection, sorting on the specified field in the specified direction.
Namespace: Microsoft.SharePoint.Search.Extended.Administration.Keywords
Assembly: Microsoft.SharePoint.Search.Extended.Administration (in Microsoft.SharePoint.Search.Extended.Administration.dll)
Syntax
'Declaration
Function GetEnumerator ( _
sortField As FeaturedContentSortField, _
sortDirection As SortDirection, _
offset As Integer, _
count As Integer _
) As IEnumerator(Of FeaturedContent)
'Usage
Dim instance As FeaturedContentCollection
Dim sortField As FeaturedContentSortField
Dim sortDirection As SortDirection
Dim offset As Integer
Dim count As Integer
Dim returnValue As IEnumerator(Of FeaturedContent)
returnValue = instance.GetEnumerator(sortField, _
sortDirection, offset, count)
IEnumerator<FeaturedContent> GetEnumerator(
FeaturedContentSortField sortField,
SortDirection sortDirection,
int offset,
int count
)
Parameters
sortField
Type: Microsoft.SharePoint.Search.Extended.Administration.Keywords.FeaturedContentSortFieldThe field on which the result is to be sorted.
sortDirection
Type: Microsoft.SharePoint.Search.Extended.Administration.Common.SortDirectionThe sort direction.
offset
Type: System.Int32The offset in the result set from which values are returned.
count
Type: System.Int32The number of elements to return.
Return Value
Type: System.Collections.Generic.IEnumerator<FeaturedContent>
An [IEnumerator] over the FeaturedContent.
Remarks
The count and offset values are applied to the result after sorting on the specified field in the specified direction. This can be used for paging in a GUI
See Also
Reference
FeaturedContentCollection Interface
FeaturedContentCollection Members
Microsoft.SharePoint.Search.Extended.Administration.Keywords Namespace