IUILinkProvider.GetSingleObjectLink Method (UIElementInfo, ObjectDetailLinkParameters)

Gets link to the single object if supported by the current state of UI elements. Can return link to the object creation if object identifier in ObjectDetailLinkParameters is left empty. Leaving out the ObjectDetailLinkParameters to null will return simple link for the object creation.

Namespace: CMS.PortalEngine.Internal
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 10.0.0

Syntax

string GetSingleObjectLink(
	UIElementInfo detailElement,
	ObjectDetailLinkParameters parameters = null
)

Parameters

detailElement

Type: CMS.Modules.UIElementInfo
UI element displaying the object detail

parameters (Optional)

Type: CMS.PortalEngine.ObjectDetailLinkParameters
Additional parameters

Return Value

Type: String
Link to single object defined in detailElement and parameters.

Examples

Following example shows how to obtain link to access single site.

var siteEditElement = UIElementInfoProvider.GetUIElementInfo("CMS", "EditSiteProperties");

var retriever = <see cref="M:CMS.Core.Service`1.Entry" />;

string link = retriever.GetSingleObjectLink(siteEditElement, new ObjectDetailLinkParemeters {
    ObjectIdentifier = "siteName",
    AllowNavigationToListing = true
});