PluginPreRenderEventArgs Class |
Event args for the PluginPreRender(Template, PluginPreRenderEventArgs) event.
Inheritance HierarchyNamespace: NetQuarry
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe PluginPreRenderEventArgs type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PluginPreRenderEventArgs |
Standard constructor.
|
Properties| Name | Description | |
|---|---|---|
 | Body |
Gets/sets the plugin HTML. When the event is fired this will be the Template body expanded
for template markers. An extension may modify this HTML in which case the field will use the modified HTML.
|
| BulkContext |
Gets/sets the context of the current bulk operation, if any.
If this event is part of a bulk operation, this is the context of that bulk operation.
If this event is not part of a bulk operation, this context will be null.
(Inherited from EAPEventArgs.) |
| ErrorDeveloperMessage |
An optional, developer-specific error message. This will be logged to the Devlog and xot_request_log, but
only displayed in user error messages when the user is identified as IsDeveloper.
(Inherited from EAPEventArgs.) |
 | ErrorMessage |
Sets the extention's error message for this event.
(Inherited from EAPEventArgs.) |
| ErrorOptions |
Options used to specify additional characteristics about an exception.
(Inherited from EAPEventArgs.) |
| Event |
Gets/Sets the event that is currently executing.
(Inherited from EAPEventArgs.) |
| Field |
Gets/sets the IField using the plugin.
|
| Result |
Gets/Sets the result to return from the event.
(Inherited from EAPEventArgs.) |
Methods| Name | Description | |
|---|---|---|
| Cancel |
Sets the extention's result code and error message for this event. The result code
is set to ExtResultsExtResults.Cancel.
(Inherited from EAPEventArgs.) |
| Equals | (Inherited from Object.) |
| Error(String) |
Sets the extention's result code and error message for this event.
The result code is set to Error.
Use Error(String, String, ExceptionOptions) to include an additional developer message and/or options.
(Inherited from EAPEventArgs.) |
| Error(String, String, ExceptionOptions) |
Sets the extention's result code and error message for this event with an optional developer-specific
error message and options.
The result code is set to Error.
(Inherited from EAPEventArgs.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
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.) |
See Also