Interface ILinkService

Helpers to create links to

  • Pages
  • APIs
  • Images

As well as create base-tag links (important for SPAs)

You will never create this yourself, as get this automatically in Razor or WebAPIs on an object called Link.

Inherited Members
Namespace: ToSic.Sxc.Services
Assembly: ToSic.Sxc.dll
Syntax
[PublicApi_Stable_ForUseInYourCode]
public interface ILinkService : ICanDebug, ILinkHelper, INeedsDynamicCodeRoot
Remarks

History

  • Created ca. v2 as ToSic.Sxc.Web.ILinkHelper
  • Moved to this new Services.ILinkService in v13.05. The previous name will continue to work, but newer features will be missing on that interface.

Methods

| Improve this Doc View Source

Base()

A base url for the current page, for use in html-base tags

Declaration
string Base()
Returns
Type Description
System.String
| Improve this Doc View Source

Image(String, Object, Object, String, IDynamicField, Object, Object, Object, String, String, String, Object, String, Object)

Generate an Image-Resizing link base on presets or custom parameters.
It will also ensure that the final url is safe, so it will encode umlauts, spaces etc.

Note that you can basically just use presets, or set every parameter manually.

  • All params are optional.
  • Some combinations are not valid - like setting a factor and a width doesn't make sense and will throw an error
  • Most parameters if set to 0 will cause a reset so that this aspect is not in the URL
Declaration
string Image(string url = null, object settings = null, object factor = null, string noParamOrder = "Params must be named (https://r.2sxc.org/named-params)", IDynamicField field = null, object width = null, object height = null, object quality = null, string resizeMode = null, string scaleMode = null, string format = null, object aspectRatio = null, string type = null, object parameters = null)
Parameters
Type Name Description
System.String url

The image url. Use an empty string if you want to just get the params for re-use.
System.Object settings
  • A standardized Image-Settings object like Settings.Images.Content - see http://r.2sxc.org/settings
  • Or a dynamic object containing settings properties (this can also be a merged custom + standard settings)
  • Or a specially prepared IResizeSettings object containing all settings. If this is provided, only factor will still be respected, all other settings like width on this command will be ignored.
System.Object factor

A multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5.
System.String noParamOrder

see Convention: Named Parameters
IDynamicField field

WIP v13.04 - not final yet
System.Object width

Optional width parameter. Usually takes the default from the settings.
System.Object height

Optional height parameter. Usually takes the default from the settings.
System.Object quality

Optional quality parameter. Usually takes the default from the settings.
System.String resizeMode

Optional resize-mode, like crop or max. Usually takes the default from the settings.
System.String scaleMode

Optional scale-mode to allow up-scaling images like up or both. Usually takes the default from the settings.
System.String format

Optional file format like jpg or png
System.Object aspectRatio

Aspect Ratio width/height, only relevant if a width is supplied. Can't be used together with height. Usually takes default from the settings or is ignored.

System.String type

Optional type changes how the link is generated. Possible values are:

  • null / not specified / empty = return link as is generated
  • "full" return link with protocol and domain. If that was missing before, it will add current protocol/domain if possible, but not on relative ./ or ../ links
  • "//" return link with //domain. If that was missing before, will add current domain if possible, but not on relative ./ or ../ links
System.Object parameters
  • the parameters either as id=47&name=daniel (Dnn also supports /id/47/name/daniel)
  • in 2sxc 12.05+ it can also be an IParameters
Returns
Type Description
System.String
Remarks

Usually a factor is applied to create a link which is possibly 50% of the content-width or similar. In these cases the height is not applied but the aspectRatio is used, which usually comes from settings if any were provided.

History

  • New in 2sxc 12.03
  • type added ca. v12.08
  • Option to use IResizeSettings added in v13.03
  • factor originally didn't influence width/height if provided here, updated it v13.03 to influence that as well
  • field being added in 13.04, not ready yet
| Improve this Doc View Source

To(String, Nullable<Int32>, String, Object, String, String)

returns a link to the current page with parameters resolved in a way that DNN wants it

Declaration
string To(string noParamOrder = "Params must be named (https://r.2sxc.org/named-params)", int? pageId = default(int? ), string api = null, object parameters = null, string type = null, string language = null)
Parameters
Type Name Description
System.String noParamOrder

see Convention: Named Parameters
System.Nullable<System.Int32> pageId

optional page ID (TabId) - if not supplied, will use current page
System.String api

optional api url "api/name/method?id=something"
System.Object parameters
  • the parameters either as id=47&amp;name=daniel (Dnn also supports /id/47/name/daniel)
  • in 2sxc 12.05+ it can also be an IParameters
System.String type

Optional type changes how the link is generated. Possible values are:

  • null / not specified / empty = return link as is generated
  • &quot;full&quot; return link with protocol and domain. If that was missing before, it will add current protocol/domain if possible, but not on relative ./ or ../ links
  • &quot;//&quot; return link with //domain. If that was missing before, will add current domain if possible, but not on relative ./ or ../ links
System.String language
  • If not set, null or empty &quot;&quot; will use the specified pageId (pageIds can be language specific); api would always be the current language
  • If set to &quot;current&quot; will adjust pageId to use the language of the current language. API will be as before, as it was already current
  • future (not implemented yet) &quot;primary&quot; would link to primary language
  • future (not implemented yet) &quot;en&quot; or &quot;en-us&quot; would link to that specific language (page and API)
Returns
Type Description
System.String
Remarks

History

  • v12 added the api parameter for liking APIs of the current app
  • In v12.05 the type of parameters was changed from string to object, to allow IParameters as well
  • In v13.02 introduced language with "current"