Skip to main content

Class DtrBarEntry

Class representing an entry in the server info bar.

Assembly: Dalamud.dll​
View Source​
Declaration
public sealed class DtrBarEntry : IDisposable, IDtrBarEntry, IReadOnlyDtrBarEntry

Implements:
System.IDisposable, Dalamud.Game.Gui.Dtr.IDtrBarEntry, Dalamud.Game.Gui.Dtr.IReadOnlyDtrBarEntry

Properties​

Title​

Gets the title of this entry.

View Source​
Declaration
public string Title { get; init; }

Text​

Gets or sets the text of this entry.

View Source​
Declaration
public SeString? Text { get; set; }

Tooltip​

Gets or sets a tooltip to be shown when the user mouses over the dtr entry.

View Source​
Declaration
public SeString? Tooltip { get; set; }

OnClick​

Gets or sets a action to be invoked when the user clicks on the dtr entry.

View Source​
Declaration
public Action? OnClick { get; set; }

HasClickAction​

Gets a value indicating whether this entry has a click action.

View Source​
Declaration
public bool HasClickAction { get; }

Shown​

Gets or sets a value indicating whether this entry is visible.

View Source​
Declaration
public bool Shown { get; set; }

UserHidden​

Gets a value indicating whether or not the user has hidden this entry from view through the Dalamud settings.

View Source​
Declaration
public bool UserHidden { get; }

Methods​

TriggerClickAction()​

Triggers the click action of this entry.

View Source​
Declaration
public bool TriggerClickAction()
Returns​

System.Boolean: True, if a click action was registered and executed.### Remove() Remove this entry from the bar. You will need to re-acquire it from DtrBar to reuse it.

View Source​
Declaration
public void Remove()

Dispose()​

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

View Source​
Declaration
public void Dispose()

Implements​