PFPlugin_Item Class |
Plugin providing methods hooked to item' main events.
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_Item : PFPlugin
The PFPlugin_Item type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFPlugin_Item |
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 | |
|---|---|---|
 | CustomizeDeletePermissions |
Customizes the delete permissions.
|
| CustomizeReadPermissions |
Customizes the read permissions.
|
| CustomizeUpdatePermissions |
Customizes the update permissions.
|
| Initialized |
Method called after a plugin instance has been initialized.
(Inherited from PFPlugin.) |
| ItemCommentAdded |
Method called after a PFItemComment has been added on an item.
|
| ItemCreated |
Method called when a new item has been created.
|
| ItemCreating |
Method called when a new item is being created.
|
| ItemDeleted |
Method called when a item has been deleted.
|
| ItemDeleting |
Method called when a item is being deleted.
|
| ItemEventAdded |
Method called after a PFItemEvent has been added on an item.
|
| ItemFileBinding |
Method called when the file of an item is about to be bound via WordForm or Quickparts.
|
| ItemFileConfirmed |
Method called when a file has been confirmed on an item.
A file is confirmed when, after its upload, the parent item is saved with a reference to the file
in the FileHolder value.
|
| ItemFileCreated |
Method called after a file has been created on an item.
|
| ItemFileCreating |
Method called when a file is being created on an item.
|
| ItemFileDeleted |
Method called after the file of an item has been deleted.
|
| ItemFileDeleting |
Method called when the file of an item is being deleted.
|
| ItemFileDownloaded |
Method called when the file of an item has been downloaded.
|
| ItemFileDownloading |
Method called when the file of an item has been downloaded.
Called async, do not use non-thread safe objects.
There is no warranty the download is finished or succeeded.
|
| ItemFileOpened |
Method called when the file of an item has been opened for modification (Office or KeePass application).
|
| ItemFileUpdated |
Method called after the file of an item has been updated.
|
| ItemFileUpdating |
Method called when the file of an item is being updated.
|
| ItemNotificationCreated |
Method called after a user notification whose related object is the given item was created.
|
| ItemNotificationCreating |
Method called before a user notification whose related object is the given item is created.
|
| ItemNotificationSending |
Method called before a modeled notification is sent.
|
| ItemSaved |
Method called when a item has been saved.
|
| ItemSaving |
Method called when a item is being saved.
|
| ItemStateChanged |
Method called after the call to Save() during an item's enactment
(when the SQL transaction made to move the workflow is committed).
|
| ItemStateChanging |
Method called when the state has been changed in an item instance, but the save has not been called yet.
|
| ItemUpdated |
Method called when a item has been updated.
|
| ItemUpdating |
Method called when a item is being updated.
|
| 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.) |
| OverrideDefaultReference |
Overrides the default reference generated for the specified item.
|
| 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