PageUrlPathsDocumentQueryExtensions.WithPageUrlPaths<TQuery, TObject> Method

Ensures that corresponding PageUrlPathInfo data is joined to the result.

Namespace: CMS.DocumentEngine.Routing
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

public static TQuery WithPageUrlPaths<TQuery, TObject>(
	this IDocumentQuery<TQuery, TObject> query,
	bool withPageUrlPaths = true
)
where TQuery : Object, IDocumentQuery<TQuery, TObject>
where TObject : new(), TreeNode

Parameters

query

Type: CMS.DocumentEngine.IDocumentQuery<TQuery, TObject>
Document query which is being extended.

withPageUrlPaths (Optional)

Type: System.Boolean
If set to false the result is without URL paths.

Type Parameters

TQuery

Actual type of query being extended.

TObject

Actual type of TreeNode instance.

Return Value

Type: TQuery

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IDocumentQuery<TQuery, TObject>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

The method joins PageUrlPathInfo data, if the routing mode is set to BasedOnContentTree. In case of Custom routing mode, no data are joined to the result.

Has to be called before Source(Action<QuerySource>) method if used together in one query.