Class ContactPreviewPlugin
Inherited Members
Namespace: SuperOffice.CRM.Previews
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[PreviewPlugin("SuperOffice:ContactPreview", new string[] { "contact_id" })]
public class ContactPreviewPlugin : PreviewPluginBase
Constructors
ContactPreviewPlugin()
Declaration
public ContactPreviewPlugin()
Fields
ContactHint
Declaration
public const string ContactHint = "contact_id"
Field Value
| Type | Description |
|---|---|
| string |
Methods
FormatLargePreviewAsync(PreviewData, ContactRow, PhoneRow, AddressRow, AddressRow, URLRow, CancellationToken)
Declaration
public static Task<PreviewData> FormatLargePreviewAsync(PreviewData pd, ContactRow contactRow, PhoneRow phoneRow, AddressRow addressRow, AddressRow postalAddressRow, URLRow urlRow, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| PreviewData | pd | |
| ContactRow | contactRow | |
| PhoneRow | phoneRow | |
| AddressRow | addressRow | |
| AddressRow | postalAddressRow | |
| URLRow | urlRow | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<PreviewData> |
InnerGetPreviewAsync(PreviewData, CancellationToken)
Subclass contract: derived class must implement their Preview logicin this method.
Declaration
protected override Task<PreviewData> InnerGetPreviewAsync(PreviewData previewData, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| PreviewData | previewData | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<PreviewData> | Preview text, or an empty string |
Overrides
Remarks
The Preview 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.