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 Code |
---|---|
public class Locator |
Visual Basic (Declaration) | Copy Code |
---|---|
Public Class Locator |
The type exposes the following members.
Public Constructors
Name | Description | |
---|---|---|
Locator | Overloaded. |
Public Methods
Name | Description | |
---|---|---|
Clone |
Creates a copy of this Locator.
(Overrides XUri..::Clone()()()().) |
|
CreateAIMReference |
Creates an AIM reference from the current locator.
|
|
Equals | (Inherited from XUri.) | |
GetFromXHtmlElement |
Gets a list of locations referred to by an XHtml element.
|
|
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.) |
|
GetLocalPath |
Gets the local path to a file on disk.
|
|
GetType | (Inherited from Object.) | |
IsUrlEndpoint | Overloaded. | |
SetChannel |
Changes the channel of this locator to the given channel.
|
|
SetItemNumber |
Changes the item reference of this locator to the given item.
|
|
SetReadOnly |
Not in use.
(Inherited from XUri.) |
|
ToString | Overloaded. | |
TryCreate | Overloaded. |
Protected Methods
Name | Description | |
---|---|---|
Finalize | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
OnUrlParameters | (Overrides XUri..::OnUrlParameters(UrlParameterMappings).) | |
Update | (Inherited from XUri.) |
Protected Fields
Name | Description | |
---|---|---|
internalQuery | (Inherited from XUri.) | |
UrlIsFriendly |
Gets or sets a value indicating the url has a friendly CMS syntax.
(Inherited from XUri.) |
Public Properties
Name | Description | |
---|---|---|
BaseUrl |
Gets the base URL.
|
|
Bookmark |
Gets or sets the bookmark.
(Inherited from XUri.) |
|
FixQueryParamEscaping |
Gets a value indicating whether the query parameters will be correctly url encoded.
(Inherited from XUri.) |
|
IsAssetItem |
Gets or sets a value indicating whether this instance is an asset item.
|
|
IsCms |
Gets a value indicating whether this instance points to a CMS item.
|
|
IsFriendlyUrl |
Returns true if this is a friendly url.
|
|
IsLocalFile |
Gets a value indicating whether this instance is a local file.
|
|
IsRelative |
Gets or sets a value indicating whether this instance is relative.
|
|
ItemReference |
Gets the item.
|
|
Query |
Exposes the Url's query parameters as a collection.
(Inherited from XUri.) |
|
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.) |
|
Url |
Gets the Url wrapped in the Locator object.
(Inherited from XUri.) |
|
UseFriendlyNames |
Gets or sets if the locator should output the url using friendly names.
|
|
UseUriEscaping |
Gets or sets a value indicating whether to use URI escaping.
(Inherited from XUri.) |
|
UseXmlEncoding |
Gets or sets a value indicating whether to use XML encoding for ampersands.
(Inherited from XUri.) |
Protected Properties
Name | Description | |
---|---|---|
UrlParametersShownInPath | (Inherited from XUri.) |
See Also
Smartsite.Core Namespace