Provides methods to construct URLs that represent the state of the EndecaCommands and Parameters that have been registered with a UrlManager.

Namespace:  Endeca.Web.Url
Assembly:  Endeca.Web (in Endeca.Web.dll) Version: 2.1.3.0 (2.1.3.622)

Syntax

C#
public class UrlBuilder
Visual Basic (Declaration)
Public Class UrlBuilder
Visual C++
public ref class UrlBuilder

Remarks

When building URLs, the state that is included in the URL is in general the state of the commands and parameters that are associated with a UrlManager. However it is typically the case that the exact state that should be in the URL represents a modification to the 'base' state represented by the UrlManager.

UrlBuilder therefore provides methods to construct URLs by allowing an application to obtain a copy of the commands (or parameters) registered with the manager, and then modify these copies to reflect the desired state that should be represented in the URL. The BuildUrl(Action<(Of <(CommandActionInfo>)>)) method provides this basic functionality.

In addition to this method, UrlBuilder has a selection of higher-level helper functions, such as SelectDimensionValue(String, Object), representing modifications that are commonly used when building Endeca applications.

Inheritance Hierarchy

System..::.Object
  Endeca.Web.Url..::.UrlBuilder

See Also