Class TextLinkButton

Clickable UI link that can be used in tooltips. For a demo see OwnershipTooltip(WorkOrder, User) or ItemPersistentData.

Inheritance

System.Object

UnserializedEntry

TextLinkButton

Implements

IController

IViewController

IHasUniversalID

System.ComponentModel.INotifyPropertyChanged

ILinkable

Inherited Members

UnserializedEntry.Id

UnserializedEntry.idToEntry

UnserializedEntry.All<T>()

UnserializedEntry.GetById(Int32)

UnserializedEntry.ControllerID

UnserializedEntry.PropertyChanged

Namespace: Eco.Gameplay.Systems.TextLinks

Assembly: Eco.Gameplay.dll

Syntax

public class TextLinkButton : UnserializedEntry, IController, IViewController, IHasUniversalID, INotifyPropertyChanged, ILinkable

Constructors

TextLinkButton()

Declaration

public TextLinkButton()

TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User>, LocString)

Declaration

public TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User> onClick, LocString link)

Parameters

Type	Name	Description
System.Action<TooltipOrigin, TooltipClickContext, User>	onClick
LocString	link

TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User>, LocString, LocString)

Declaration

public TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User> onClick, LocString header, LocString hint)

Parameters

Type	Name	Description
System.Action<TooltipOrigin, TooltipClickContext, User>	onClick
LocString	header
LocString	hint

TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User>, LocString, LocString, LocString)

Declaration

public TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User> onClick, LocString header, LocString hint, LocString content)

Parameters

Type	Name	Description
System.Action<TooltipOrigin, TooltipClickContext, User>	onClick
LocString	header
LocString	hint
LocString	content

TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User>, LocString, LocString, LocString, LocString)

Declaration

public TextLinkButton(Action<TooltipOrigin, TooltipClickContext, User> onClick, LocString header, LocString hint, LocString content, LocString link)

Parameters

Type	Name	Description
System.Action<TooltipOrigin, TooltipClickContext, User>	onClick
LocString	header
LocString	hint
LocString	content
LocString	link

Properties

CustomUILink

Declaration

public LocString CustomUILink { get; }

Property Value

Type	Description
LocString

HoveredContent

Declaration

public LocString HoveredContent { get; set; }

Property Value

Type	Description
LocString

HoveredHeader

Declaration

public LocString HoveredHeader { get; set; }

Property Value

Type	Description
LocString

HoveredHint

This string will be at the bottom of the tooltip when the button is hovered.

Declaration

public LocString HoveredHint { get; set; }

Property Value

Type	Description
LocString

OnClick

Declaration

public ThreadSafeAction<TooltipOrigin, TooltipClickContext, User> OnClick { get; }

Property Value

Type	Description
ThreadSafeAction<TooltipOrigin, TooltipClickContext, User>

TooltipChildren

Declaration

[NewTooltipChildren]
public IEnumerable<IController> TooltipChildren { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IController>

Methods

Describe(LocString)

Declaration

public LocString Describe(LocString additionalString)

Parameters

Type	Name	Description
LocString	additionalString

Returns

Type	Description
LocString

DescribeLoc(String)

Declaration

public LocString DescribeLoc(string additionalString)

Parameters

Type	Name	Description
System.String	additionalString

Returns

Type	Description
LocString

OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

Declaration

public override void OnLinkClicked(TooltipOrigin origin, TooltipClickContext clickContext, User user)

Parameters

Type	Name	Description
TooltipOrigin	origin
TooltipClickContext	clickContext
User	user

Overrides

UnserializedEntry.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

SetCustomUILink(LocString)

Declaration

public void SetCustomUILink(LocString content)

Parameters

Type	Name	Description
LocString	content

UILinkContent()

Declaration

public override LocString UILinkContent()

Returns

Type	Description
LocString

Overrides

UnserializedEntry.UILinkContent()

Implements

IController

IViewController

IHasUniversalID

System.ComponentModel.INotifyPropertyChanged

ILinkable

Extension Methods

TagUtils.TagNames(Object, Boolean)

TagUtils.TagDisplayNames(Object, Boolean)

ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)

TypeTooltipExtensions.UILinkGeneric(Object)

ILinkableTooltipLibrary.TextLinkButtonLinkClicked(TextLinkButton)

TextLinkButtonTooltipLibrary.HoveredContent(TextLinkButton)