Endeca Presentation API
UrlGen Class
NamespacesEndeca.NavigationUrlGen
A generic toolkit for manipulating and generating URL query strings.
Declaration Syntax
C#Visual BasicVisual C++
public class UrlGen
Public Class UrlGen
public ref class UrlGen
Members
All MembersConstructorsMethods



IconMemberDescription
UrlGenUrlGenNew()() Obsolete.
Obsolete. Use the constructor that takes an encoding instead. This version defaults to using the "windows-1252" encoding.

UrlGenUrlGenNew(String) Obsolete.
Obsolete. Use the constructor that takes an encoding instead. This version defaults to using the "windows-1252" encoding.

UrlGenUrlGenNew(String, String)
Constructor where the start URL will be the one specified in this constructor.

AddParam(String, String)
Manipulates the resultant URL by adding this key value pair.

AddParams(ICollection)
Bulk add of param pairs.

AppendParam(String, String)
Manipulates the resultant url by adding this key value pair.

AppendParams(ICollection)
Bulk append of param pairs.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()
Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType()()
Gets the Type of the current instance.
(Inherited from Object.)
MemberwiseClone()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
RemoveParam(String)
Removes any key value parameter from the to be outputted URL with the parameter name key.

RemoveParams(ICollection)
Removes any key value parameter with the keys specified in the collection.

ToString()()
The output method on this class.
(Overrides Object.ToString()().)
Remarks
The intended use of UrlGen was for the management of state and query parameters when dealing with UrlENEQuery objects.

UrlGen takes either a query string in a constructor as the base query to work with or none which indicates that it begins with an empty base. The ToString()() method called immediately after the constructor will return the original input URL or none if none was specified.

The remove params and add parameters are evaluated in order. That is removes placed after an add may delete the parameter you just added.

This toolkit attempts to preserve whatever input URL parameters are input to the system as long as they follow the structure of an & delimited, x-www-form-urlencoded parameter value pairs. In the case of multiple parameters with the same name, the multiple pairs will be preserved on output, however, a remove, or add with the same name will remove or overwrite the all of the keys with that name. An append on the other hand will preserve the previous prameter. Append adds parameters without knowledge of the previous.

Inheritance Hierarchy
Object
UrlGen

Assembly: Endeca.Navigation (Module: Endeca.Navigation) Version: 0.0.0.0