Click or drag to resize

TemplateExtensionBase Class

The recommended base class for all Template extensions.
Inheritance Hierarchy

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class TemplateExtensionBase : ExtensionBase

The TemplateExtensionBase type exposes the following members.

Constructors
  NameDescription
Public methodTemplateExtensionBase
Initializes a new instance of the TemplateExtensionBase class
Top
Properties
  NameDescription
Protected propertyIsPlatform
Gets whether or not the extension is a platform extension vs. a custom extension.
(Inherited from ExtensionBase.)
Public propertyOwner
Gets/Sets the owner of this object
(Inherited from ExtensionBase.)
Public propertyProperties
Returns this instance's properties.
(Inherited from ExtensionBase.)
Public propertyCode exampleTextItems
Returns a collection of TextItems loaded from metadata related to this component.
(Inherited from ExtensionBase.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetOwnerName
Gets a descriptive name for the provided object (which is presumably the extension owner object).
(Inherited from ExtensionBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleEvent
Method overridden in dervied classes that handles type specfic events.
(Overrides ExtensionBaseHandleEvent(ExtensionEvents, Object, EAPEventArgs).)
Public methodInfo
Return requested information about the extension.
(Inherited from ExtensionBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOnEvent
IExtension.OnEvent handler. Note that generally speaking, you will want to override the individual methods specific to the event and not implement the interface directly.
(Inherited from ExtensionBase.)
Protected methodOnSetOwner
When the Owner is attached to this extension, verifies that the object a Template object. Attaching any other object indicates that this extension was likely attached to the wrong type of object and results in a devlog to that effect.
(Overrides ExtensionBaseOnSetOwner.)
Public methodOnUnload
Notifies the extension that it should perform any cleanup necessary just prior to being unloaded.
(Inherited from ExtensionBase.)
Public methodPluginPreRender
Fired when a Plugin template is about to be rendered. The plugin is obtained using GetExpandedBody(IAppContext, NameValueCollection, ContentResolution) (against the IField) and the resulting plugin HTML is provided in Body. The extension may modify the HTML in which case the modified HTML will be used.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also