CodeCarvings.Piczard
Plugin Class
Members  See Also  Send Feedback
CodeCarvings.Piczard.Plugins Namespace : Plugin Class

Represents the base class for Piczard plugins; all plugins must be objects that implement this class.

Syntax

Visual Basic (Declaration)  
<SerializableAttribute()>
Public MustInherit Class Plugin 
C#  
[SerializableAttribute()]
public abstract class Plugin 

Remarks

Only Piczard can initialize a new instance of a Plugin class.

 

Every Plugin method that can be invoked by Piczard expects 2 types of results:

Moreover a Plugin method can handle - or not handle - a particular method invocation.

Example: if a Piczard Plugin implements the IDynamicLocalizationPlugin interface, then it contains the following method:

  • PluginOperationResult<string> GetString(string key, string culture, string tag)

Supposing that such Plugin handles only the "fr" language, then there are 2 kind of results:

  1. PluginOperationResult<T> with the Handled property set to true and the Value property valorized - if the culture parameter passed to the method by Piczard is equal to "fr".
  2. PluginOperationResult<T> with the Handled property set to false - if the culture parameter passed to the method by Piczard is not equal to "fr".

For more informatio about Piczard Plugins please see:

Inheritance Hierarchy

System.Object
   CodeCarvings.Piczard.Plugins.Plugin

Requirements

Namespace: CodeCarvings.Piczard.Plugins

Platforms: Windows 8, Windows 7, Windows Vista, Windows XP Professional, Windows 2000 - Windows Server family: 2012, 2008.R2, 2008, 2003, 2000

Assembly: CodeCarvings.Piczard (in CodeCarvings.Piczard.dll)

See Also

©2013 Sergio Turolla. All Rights Reserved.