Show / Hide Table of Contents

Interface IHasInfoLink

Implemented by plugins that want a small informational footer with a clickable inline hyperlink rendered below their config PropertyGrid in the WinForms admin UI. Use case: pointing admins at a related resource (e.g. translation portal, wiki page, support channel) without crowding the property descriptions.

The footer text uses a format string with a single {0} placeholder that gets substituted with the localized link text at runtime. The form code finds the link text within the formatted message and renders it as a hyperlink that navigates to InfoUrl when clicked. Both InfoTextFormat and InfoLinkText are localized; the URL stays in code and is not extracted for translation.

Namespace: Eco.Core.Plugins.Interfaces
Assembly: Eco.Core.dll
Syntax
public interface IHasInfoLink

Properties

InfoLinkText

Localized text rendered as a clickable hyperlink inside the footer message.

Declaration
LocString InfoLinkText { get; }
Property Value
Type Description
LocString

InfoTextFormat

Localized format string for the footer message, containing exactly one {0} placeholder where InfoLinkText gets substituted at runtime. Translators must preserve the {0}.

Declaration
LocString InfoTextFormat { get; }
Property Value
Type Description
LocString

InfoUrl

The URL opened in the default browser when the user clicks the hyperlink.

Declaration
string InfoUrl { get; }
Property Value
Type Description
System.String

Extension Methods

PropertyChanges.FirePropertyChanged(Object, String)
PropertyChanges.FirePropertyChanged(Object, String, Object, Object)
PropertyChanges.FirePropertyChanged(Object, MemberChangedBeforeAfterEventArgs)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾