ClientObjectQueryableExtension.IncludeWithDefaultProperties<TSource> Method

Article
08/05/2014

Specifies which properties, in addition to the default properties, to retrieve from the server.

Namespace: Microsoft.SharePoint.Client
Assemblies: Microsoft.SharePoint.Client.Silverlight.Runtime (in Microsoft.SharePoint.Client.Silverlight.Runtime.dll); Microsoft.SharePoint.Client.Runtime (in Microsoft.SharePoint.Client.Runtime.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function IncludeWithDefaultProperties(Of TSource As ClientObject) ( _
    clientObjects As IQueryable(Of TSource), _
    ParamArray retrievals As Expression(Of Func(Of TSource, Object))() _
) As IQueryable(Of TSource)
'Usage
Dim clientObjects As IQueryable(Of TSource)
Dim retrievals As Expression(Of Func(Of TSource, Object))()
Dim returnValue As IQueryable(Of TSource)

returnValue = clientObjects.IncludeWithDefaultProperties(retrievals)

public static IQueryable<TSource> IncludeWithDefaultProperties<TSource>(
    this IQueryable<TSource> clientObjects,
    params Expression<Func<TSource, Object>>[] retrievals
)
where TSource : ClientObject

Type Parameters

TSource
The type of the elements of clientObjects.

Parameters

clientObjects
Type: System.Linq.IQueryable<TSource>

A client object that implements IQueryable<T>, which contains the queried properties.

retrievals
Type: []

The list of the properties to retrieve from the server.

Return Value

Type: System.Linq.IQueryable<TSource>
A client object used to retrieve the default properties and the specified properties for the query.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable<TSource>. When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936(v=office.14) or https://msdn.microsoft.com/en-us/library/bb383977(v=office.14).

Remarks

This method extends the properties retrieved for the client object that implements IQueryable<T>, so that it can specify which properties, in addition to the default properties, to retrieve from the server.