Class NavigatorButtonTooltipPlugin

Tooltip plugin for buttons in the navigator and the button bar. It fetches tooltips from the preferences, and also accepts a default tooltip to be used if there is no preference tooltip.

Inheritance
object
TooltipPluginBase
NavigatorButtonTooltipPlugin
Inherited Members
Namespace: SuperOffice.CRM.Tooltips
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[TooltipPlugin("SuperOffice:NavigatorButtons", new string[] { "button_id" })]
public class NavigatorButtonTooltipPlugin : TooltipPluginBase

Constructors

NavigatorButtonTooltipPlugin()

Tooltip plugin for buttons in the navigator and the button bar. It fetches tooltips from the preferences, and also accepts a default tooltip to be used if there is no preference tooltip.

Declaration
public NavigatorButtonTooltipPlugin()

Fields

ButtonId

Tooltip plugin for buttons in the navigator and the button bar. It fetches tooltips from the preferences, and also accepts a default tooltip to be used if there is no preference tooltip.

Declaration
public const string ButtonId = "button_id"
Field Value
Type Description
string

Methods

InnerGetTooltipAsync(CancellationToken)

Subclass contract: derived class must implement their tooltip logicin this method.

Declaration
protected override Task<string> InnerGetTooltipAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<string>

Tooltip text, or an empty string
Overrides
Remarks

The tooltip hints are accessible through the Hints property, but clients should usually find the provided access methods sufficient. TryGetIntHint(string, out int), TryGetStringHint(string, out string) and TryGetBoolHint(string, out bool) look for and parse the given type of key, and return a bool value that specifies whether the given key was found.

Extension Methods