This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code
                                  public class Locator
Visual Basic (Declaration) Copy imageCopy Code
                                  Public Class Locator

The type exposes the following members.

Public Constructors

  Name Description
Public method Locator Overloaded.

Public Methods

  Name Description
Public method Clone
Creates a copy of this Locator.
(Overrides XUri..::Clone()()()().)
Public method CreateAIMReference
Creates an AIM reference from the current locator.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from XUri.)
Public method Static member GetFromXHtmlElement
Gets a list of locations referred to by an XHtml element.
Public method 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 XUri.)
Public method GetLocalPath
Gets the local path to a file on disk.
Public method GetType (Inherited from Object.)
Public method Static member IsUrlEndpoint Overloaded.
Public method SetChannel
Changes the channel of this locator to the given channel.
Public method SetItemNumber
Changes the item reference of this locator to the given item.
Public method SetReadOnly
Not in use.
(Inherited from XUri.)
Public method ToString Overloaded.
Public method Static member TryCreate Overloaded.

Protected Methods

  Name Description
Protected method Finalize (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnUrlParameters (Overrides XUri..::OnUrlParameters(UrlParameterMappings).)
Protected method Update (Inherited from XUri.)

Protected Fields

  Name Description
Protected field internalQuery (Inherited from XUri.)
Protected field UrlIsFriendly
Gets or sets a value indicating the url has a friendly CMS syntax.
(Inherited from XUri.)

Public Properties

  Name Description
Public property BaseUrl
Gets the base URL.
Public property Bookmark
Gets or sets the bookmark.
(Inherited from XUri.)
Public property FixQueryParamEscaping
Gets a value indicating whether the query parameters will be correctly url encoded.
(Inherited from XUri.)
Public property IsAssetItem
Gets or sets a value indicating whether this instance is an asset item.
Public property IsCms
Gets a value indicating whether this instance points to a CMS item.
Public property IsFriendlyUrl
Returns true if this is a friendly url.
Public property IsLocalFile
Gets a value indicating whether this instance is a local file.
Public property IsRelative
Gets or sets a value indicating whether this instance is relative.
Public property ItemReference
Gets the item.
Public property Query
Exposes the Url's query parameters as a collection.
(Inherited from XUri.)
Public property Relation
Gets or sets the relation the locator has to the context, such as when the location exists in a 'link' XHTML tag (rel attribute).
(Inherited from XUri.)
Public property Url
Gets the Url wrapped in the Locator object.
(Inherited from XUri.)
Public property UseFriendlyNames
Gets or sets if the locator should output the url using friendly names.
Public property UseUriEscaping
Gets or sets a value indicating whether to use URI escaping.
(Inherited from XUri.)
Public property UseXmlEncoding
Gets or sets a value indicating whether to use XML encoding for ampersands.
(Inherited from XUri.)

Protected Properties

  Name Description
Protected property UrlParametersShownInPath (Inherited from XUri.)

See Also

Advanced