Show / Hide Table of Contents

Class PreviewPluginAttribute

Attribute used to mark a class as a Preview provider Plugin. Such classes need to implement the interface. The priority of the standard providers is set at int.MaxValue/2 to provide room both above and below. The name has no impact on functionality, but should be hept unique and traceable (such as partnerName:pluginName or some such syntax). The provider can optionally register for one or more Preview hints it wishes to handle.

Inheritance
Object
PluginAttribute
PrioritizedPluginAttribute
PreviewPluginAttribute
Namespace: SuperOffice.CRM.Previews
Assembly: SoDataBase.dll
Syntax
public class PreviewPluginAttribute : PrioritizedPluginAttribute

Constructors

PreviewPluginAttribute(String, Int32, String[])

Mark a class as a Preview provider Plugin with the given name and priority. Standard providers have priority int.MaxValue/2.

Declaration
public PreviewPluginAttribute(string name, int priority, params string[] registerHints)
Parameters
Type Name Description
String name

Provider name

Int32 priority

Priority, lower values come before higher values

String[] registerHints

Set of hints to register for. If this is empty, the provider will be called for ALL Preview requests and must filter by itself. If nonempty, the provider will be called only for requests that contain at least one of its registered hints.

PreviewPluginAttribute(String, String[])

Mark a class as a Preview provider Plugin with the given name and the standard priority of int.MaxValue/2.

Declaration
public PreviewPluginAttribute(string name, params string[] registerHints)
Parameters
Type Name Description
String name

Provider name

String[] registerHints

Set of hints to register for. If this is empty, the provider will be called for ALL Preview requests and must filter by itself. If nonempty, the provider will be called only for requests that contain at least one of its registered hints.

Properties

RegisteredHints

Attribute used to mark a class as a Preview provider Plugin. Such classes need to implement the interface. The priority of the standard providers is set at int.MaxValue/2 to provide room both above and below. The name has no impact on functionality, but should be hept unique and traceable (such as partnerName:pluginName or some such syntax). The provider can optionally register for one or more Preview hints it wishes to handle.

Declaration
public string[] RegisteredHints { get; }
Property Value
Type Description
String[]

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top