IUILinkProviderGetSingleObjectLink Method (String, String, 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.InternalAssembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 10.0.0
Syntaxstring GetSingleObjectLink(
string moduleName,
string elementDetailName,
ObjectDetailLinkParameters parameters = null
)
Parameters
- moduleName
- Type: SystemString
Module name - elementDetailName
- Type: SystemString
Object detail element name - parameters (Optional)
- Type: CMS.PortalEngineObjectDetailLinkParameters
Additional parameters
Return Value
Type:
StringLink to single object defined in
moduleName,
elementDetailName and
parameters.
Examples
Following example shows how to obtain link to access single site.
var retriever = <see cref="M:CMS.Core.Service`1.Entry" />;
string link = retriever.GetSingleObjectLink("CMS", "EditSiteProperties" new ObjectDetailLinkParemeters {
ObjectIdentifier = "siteName",
AllowNavigationToListing = true
});
See Also