Class PersonTooltipPlugin

Tooltip provider plugin for Person data. It retrieves various information about the person, including an image if there is one in the BLOB table.

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

Constructors

PersonTooltipPlugin()

Tooltip provider plugin for Person data. It retrieves various information about the person, including an image if there is one in the BLOB table.

Declaration
public PersonTooltipPlugin()

Fields

PersonKey

Tooltip provider plugin for Person data. It retrieves various information about the person, including an image if there is one in the BLOB table.

Declaration
public const string PersonKey = "person_id"
Field Value
Type Description
string

PersonWithNoSelectionHint

Tooltip provider plugin for Person data. It retrieves various information about the person, including an image if there is one in the BLOB table.

Declaration
public const string PersonWithNoSelectionHint = "personWithNoSelection_id"
Field Value
Type Description
string

Methods

FormatTooltip(string, string, string, string, string, int, int, bool, string, string, string, string, string)

Format a somewhat smaller tooltip, without an image, based on strings instead of TableRow objects

Declaration
public static string FormatTooltip(string mrMrs, string title, string firstName, string middleName, string lastName, int countryId, int personId, bool isRetired, string contactName, string contactDepartment, string city, string phone, string email)
Parameters
Type Name Description
string mrMrs
string title
string firstName
string middleName
string lastName
int countryId
int personId
bool isRetired
string contactName
string contactDepartment
string city
string phone
string email
Returns
Type Description
string

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