PFPlugin_Query Class |
Plugin providing methods interacting with Packflow query execution.
Inheritance HierarchyNamespace: Packflow.Plugins
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
SyntaxC#
public abstract class PFPlugin_Query : PFPlugin
The PFPlugin_Query type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFPlugin_Query |
Properties| Name | Description | |
|---|---|---|
 | InstanceGuid |
Gets or sets the instance GUID.
(Inherited from PFPlugin.) |
| InstanceName |
Gets or sets the plugin instance name. Only relevant for a multi instance (not singleton) plugin.
If this instance is a singleton plugin instance, this property will contain the plugin name.
(Inherited from PFPlugin.) |
| ParentBundle |
Gets the parent bundle. Only relevant if the plugin is currently in a bundle.
(Inherited from PFPlugin.) |
| Site |
Gets the site hosting this plugin instance.
(Inherited from PFPlugin.) |
Methods| Name | Description | |
|---|---|---|
 | CustomizeGroupedItemResults(ListPFContentType, PFQuery, ListPFGroupedObjects) |
Override this method to customize (aggregated items) results of the specified query.
|
| CustomizeGroupedItemResults(PFContentType, PFQuery, ListPFGroupedObjects, PFQuery_ItemRelationContext) |
Override this method to customize (aggregated items) results of the specified query.
|
| CustomizeItemResults(ListPFContentType, PFQuery, ListPFItem) |
Override this method to customize (items) results of the specified query.
|
| CustomizeItemResults(PFContentType, PFQuery, ListPFItem, PFQuery_ItemRelationContext) |
Override this method to customize (items) results of the specified query.
|
| Initialized |
Method called after a plugin instance has been initialized.
(Inherited from PFPlugin.) |
| OnCreating |
Raises the [E:Creating] event.
(Inherited from PFPlugin.) |
| OnDeleting |
Raises the [E:Deleting] event.
(Inherited from PFPlugin.) |
| OnUpdating |
Raises the [E:Updating] event.
(Inherited from PFPlugin.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | Creating |
Occurs when the the plugin is being created.
(Inherited from PFPlugin.) |
| Deleting |
Occurs when the the plugin is being deleted.
(Inherited from PFPlugin.) |
| Updating |
Occurs when the the plugin is being updated.
(Inherited from PFPlugin.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also