Class ContactTooltipPlugin

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

Constructors

ContactTooltipPlugin()

Declaration
public ContactTooltipPlugin()

Fields

ContactHint

Declaration
public const string ContactHint = "contact_id"
Field Value
Type Description
string

ContactWithNoSelectionHint

Declaration
public const string ContactWithNoSelectionHint = "contactWithNoSelection_id"
Field Value
Type Description
string

Methods

FormatLargeTooltip(ContactRow, PhoneRow, AddressRow)

Declaration
public static string FormatLargeTooltip(ContactRow contactRow, PhoneRow phoneRow, AddressRow addressRow)
Parameters
Type Name Description
ContactRow contactRow
PhoneRow phoneRow
AddressRow addressRow
Returns
Type Description
string

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

Format a short tooltip for a contact.

Declaration
public static string FormatTooltip(string name, string department, bool xStop, string city, int countryId, string phone, int categoryId, int associateId)
Parameters
Type Name Description
string name

Name of the contact, as returned from the database.
string department

Department of the contact.
bool xStop

State of xStop.
string city

City from the contacts postal address record
int countryId

Country id of the contact.
string phone

The first phone number from the contact.
int categoryId

Id of the contacts category.
int associateId

AssociateId of the contact's owner.
Returns
Type Description
string

Tooltip for the contact.
Remarks

The returned value might contain a the value [SR_CC_STOPX].
This needs to be replaced with an appropriate resource value for X-Stop. The SuperOffice.DCF.dll module has features for carrying out this.

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