Click or drag to resize

PFItem Class

Represents an item in a content-type.
Inheritance Hierarchy

Namespace:  Packflow.Core
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
public abstract class PFItem : PFRelationalObject, 
	IPFLockable, IUserNotificationRelatedObject

The PFItem type exposes the following members.

Constructors
  NameDescription
Protected methodPFItem
Top
Properties
  NameDescription
Public propertyAbsolutePrintUrl
Gets the absolute url of the print form of this item.
Public propertyAbsoluteUrl
Gets the absolute url of the form of this item.
Public propertyApplicationContext
Gets the current application context of this item, if not yet assigned, will assign and return first found context on the parent application.
Public propertyApplicationContextId

Gets or sets the id of the current application context of this item.

Note : can only be assigned if this item has not been created yet or if the current application context does not exist anymore.
Public propertyApplicationContextName
Gets the name of the current application context of this item.
Public propertyBeforeSaveValues
Gets the previous values of modified fields before the latest Save.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyCanDelete
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.)
Public propertyCanRead
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.)
Public propertyCanUpdate
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.)
Public propertyCaption
Gets the display text representing this item.
Public propertyComments
Gets a relation allowing to access all comments.
Public propertyCommentsEnabled
Gets a value indicating whether comments are enabled.
Public propertyCreated
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.)
Public propertyCreatedAt
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.)
Public propertyCreatedBy
Gets the user who created this object in the database.
(Inherited from PFBaseObject.)
Public propertyData
Gets the metadata of this item.
Public propertyDateObjectCreation
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.)
Public propertyDeleted
True if this object is flagged as deleted.
(Inherited from PFBaseObject.)
Public propertyDeletedAt
Date of the suppression of this object.
(Inherited from PFBaseObject.)
Public propertyDeletedBy
The user who deleted this object.
(Inherited from PFBaseObject.)
Public propertyDisableNotificationsTemporarily
Gets or sets a value indicating whether all operations on this item should avoid to send notifications to users.

Important : this flag will only concern the current INSTANCE of this object.

Public propertyEnableVersionMergeToResolveSaveConflicts
If an object is saved with an older version than the last persisted (in database), the system will try to merge the versions values (if no conflicts between values) and will then save the merged item to database. Note : this setting is NOT persisted and will affect this object instance only.
(Overrides PFBaseObjectEnableVersionMergeToResolveSaveConflicts.)
Public propertyEvents
Gets a relation allowing to access all significant events that occurred during the life of this item.
Public propertyExists
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.)
Public propertyExternalConnectionId
Gets or sets the id of the PFExternalConnection having created and synchronized this item. If not synchronized, this value is 0 or less.
Public propertyFiles
Gets a relation allowing to access all files attached to this item using a PFFileHolderField.
Public propertyGuid
Gets the GUID identifying this object. Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.)
Public propertyHasPendingModifications
Checks if there is pending changes. Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.)
Public propertyHasPendingPermissionsModifications
Checks if there is pending modifications in permissions. Will compute permissions (RUD) and check if there is differences with current persisted permissions.
(Inherited from PFBaseObject.)
Public propertyId
Gets the id identifying this object. Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.)
Public propertyInboundTransition
Gets the last persisted display name of the last taken transition.
Public propertyInboundTransitionId
Gets the id of the last transition taken in the workflow, corresponding to the modeling Transition id.
Public propertyIsSynchronizedWithAnExternalSource
Gets a value indicating whether this instance is synchronized with an external source.
Public propertyKeepBeforeSaveValues
Gets or sets a value indicating whether the Save should keep a collection of the modified fields previous values.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Overrides PFBaseObjectKeepBeforeSaveValues.)
Public propertyLogger
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.)
Public propertyLogIdentification
Gets a technical text representing this object.
(Inherited from PFBaseObject.)
Public propertyModelItem
If this item is linked to or synchronized with a modeled item, this will contain the ContentItem (from the model).
Public propertyModelItemGuid
If this item is linked to or synchronized with a modeled item, this will contain the Guid of that ContentItem.
Public propertyOwnerItem
Gets the owner item of this item. Based on the item relation with the correct ownership.
Public propertyParentApplication
Gets the parent application of this item.
Public propertyParentContentType
Gets the parent content-type of this item.
Public propertyPermissionContext
Gets an object calculating permissions on demand.
Public propertyPermissions
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetDeleteId
Id of the permission set for Delete access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetDeleteXml
XML of serialized permission set for Delete access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetReadId
Id of the permission set for Read access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetReadXml
XML of serialized permission set for Read access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetUpdateId
Id of the permission set for Update access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetUpdateXml
XML of serialized permission set for Update access.
(Inherited from PFBaseObject.)
Public propertyPrintUrl
Gets the relative url of the print form of this item.
Public propertyReference
Gets or sets the formatted text used to represent this item.
Public propertyShortCaption
Gets the short display text representing this item.
Public propertySite
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.)
Public propertyStatic memberSkipChoiceMonoMultiValueCheck
Gets or sets a value indicating whether items' Save must check if choice entries do not contain more than one value if the relation is restricted to mono value.
Public propertyStatic memberSkipRequiredFieldsValidation
Gets or sets a value indicating whether items of the local/current thread should not check required fields upon Save (this includes Save called in workflow enactment).
Public propertyState
Gets the last persisted display name of the current state. Uses Workflow_ModelState to access the modeling object.
Public propertyState_Translated
Gets the display name of the current state, translation based on current user effective language.
Public propertyStateId
Gets the current state in the workflow, corresponding to the modeling State id.
Public propertyStateInstanceId
Gets the instance of state in the workflow. This will change every time this item's state changes, even if the state is the same.
Public propertyStatus
Gets or sets the status of the last taken transition in the workflow.
Public propertySubscriptions
Gets a relation allowing to access all subscriptions.
Public propertyUpdatedAt
Gets the date of the last update of this object.
(Inherited from PFBaseObject.)
Public propertyUpdatedBy
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.)
Public propertyUrl
Gets the relative url of the form of this item.
Public propertyUserUpdatedAt
Gets the date of the last update (ignoring system updates) of this object.
Public propertyUserUpdatedBy
Gets the user who last updated this object in the database (ignoring system updates).
Public propertyVersionNumber
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.)
Public propertyWorkflow_CurrentUserTask
Gets the current user task in the current state instance, if found.
Public propertyWorkflow_InstanceTasks
Gets the task of the current state instance.
Public propertyWorkflow_ModelState
Gets the current workflow state.
Public propertyWorkflow_ModelStep
Gets the current workflow step.
Public propertyWorkflow_Tasks
Gets all tasks attached to the workflow of this item.
Top
Methods
  NameDescription
Public methodAddItemRelation(Guid, PFItem)
Adds an item relation from this item to another.
Public methodAddItemRelation(Guid, PFItemReference)
Adds an item relation from this item to another.
Public methodAddItemRelation(String, PFItem)
Adds an item relation from this item to another.
Public methodAddItemRelation(String, PFItemReference)
Adds an item relation from this item to another.
Public methodAddItemRelation(ContentRelation, PFItem)
Adds an item relation from this item to another.
Public methodAddItemRelation(ContentRelation, PFItemReference)
Adds an item relation from this item to another.
Public methodAddItemRelation(String, Guid, PFItem)
Adds an item relation from this item to another.
Public methodAddItemRelation(String, Guid, PFItemReference)
Adds an item relation from this item to another.
Public methodAddItemRelation(String, String, PFItem)
Adds an item relation from this item to another.
Public methodAddItemRelation(String, String, PFItemReference)
Adds an item relation from this item to another.
Public methodAttachFile(String, Byte, PFFieldFileHolder)
This will create and persist a file in database and then link it into the fileHolder field value. You will need to save this item to persist the value in database. Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
Public methodAttachFile(String, Byte, String)
This will create and persist a file in database and then link it into the fileHolder field value. You will need to save this item to persist the value in database. Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
Public methodAttachPdfFile(PFFile, PFFieldFileHolder)
This will create and persist a file in database and then link it into the fileHolder field value. You will need to save this item to persist the value in database. Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
Public methodAttachPdfFile(PFFile, String)
This will create and persist a file in database and then link it into the fileHolder field value. You will need to save this item to persist the value in database. Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
Public methodBaseSave
IMPORTANT : will not call overridden Save method! Saves item to database. Note: use transaction. If transaction already exists, will not commit it, but may rollback it if needed (then an exception is thrown).
Public methodStatic memberBatchOperationTPFItem
Executes an operation for each of passed items. Operations will be executed in the context of a transaction (one for each connection). Transactions are committed after all operations. If an exception is thrown, everything is rollbacked.
Public methodStatic memberBatchSaveTPFItem
Saves multiple items inside a single transaction.

Important note : batch save items without references pre-initialized will slow this operation.

Public methodCanFieldBeModifiedByUser(String)
Checks if a field control mode is editable in the current context.
Public methodCanFieldBeModifiedByUser(PFField)
Checks if a field control mode is editable in the current context.
Public methodChangeApplicationContext
Will change the context of this item, of its parts items and of its tasks. You must have the permission to modify everything.
Public methodCustomizeDefaultFileNameByTemplate
Allows to customize default file names proposed to users for each template.
Public methodDelete
Flags this object as deleted.

If it fails, throws an error.

If the object could not be deleted because it does not yet exist in database, returns false.

If successful, returns true.

(Inherited from PFBaseObject.)
Public methodStatic memberDeletePermanently
Deletes permanently an item from the database. Unless you want to clear temporary or confidential data, we highly recommend to use the classic Delete method on the PFItem.
Public methodExternalConnection_Get
Gets the external connection having synchronized this item.
Public methodExternalConnection_GetExternalData
Externals the connection_ get external data.
Public methodExternalConnection_Synchronize
Synchronizes this item's data properties with its external content.

Note: this does NOT save the item.

Public methodExternalConnection_SynchronizeAndSave
Synchronizes this item's data properties with its external content, then saves the item if the synchronization changed any value.
Public methodExternalConnection_SynchronizeValidation
Checks if the item can be synchronized with its external source by the current user. Called for the method ExternalConnection_Synchronize in the batch action feature.
Public methodGenerateHtmlMessage(Int32, String)
Generates a html message (subject and body) from a modeling message.
Public methodGenerateHtmlMessage(String, String)
Generates a html message (subject and body) from a modeling message.
Public methodGenerateHtmlMessage(ContentMessage, String)
Generates a html message (subject and body) from a modeling message.
Protected methodGenerateReference

Returns a reference for the current item.

Is called by the Save method when the item is not yet created and the reference is empty.

Protected methodGenerateTaskTitle

Used to initialize a task title in the current workflow state.

Default : "{Reference} : {State}"

Public methodGenerateTextMessage(Int32, String)
Generates a html message (subject and body) from a modeling message.
Public methodGenerateTextMessage(String, String)
Generates a html message (subject and body) from a modeling message.
Public methodGenerateTextMessage(ContentMessage, String)
Generates a html message (subject and body) from a modeling message.
Public methodStatic memberGetAbsolutePrintUrl
Generates an absolute URL for an hypothetical item in print view.
Public methodStatic memberGetAbsoluteUrl
Generates an absolute URL for an hypothetical item.
Public methodGetConversationTitle
Defines the title of this item conversation for the specified user. Returns this item caption by default.
Public methodGetFieldControlMode(String)
Gets the control mode of a field in the current context.
Public methodGetFieldControlMode(PFField)
Gets the control mode of a field in the current context.
Public methodGetFieldDisplayValue(String)
Gets display text (not html) of a field in this item.
Public methodGetFieldDisplayValue(PFField)
Gets display text (not html) of a field in this item.
Public methodStatic memberGetFieldDisplayValue(PFDataCollection, PFField)
Gets a field display text (not html) from a data collection.
Public methodStatic memberGetFieldGenericDisplayHtml(PFDataCollection, PFField)
Gets a field display html from a data collection.
Public methodStatic memberGetFieldGenericDisplayHtml(PFDataCollection, PFField, String)
Gets a field display value from a data collection.
Public methodGetGuid
Returns a Global Unique Identifier for the target.
Public methodGetId
Returns an id representing the target.
Public methodGetItemLocks
Gets current locks.

Note : will return an empty list if the object is not yet created.

Public methodGetLocks
Gets current locks.
Public methodGetMessagePlaceHolderHtml
Gets the html of a message placeholder (in a ContentMessage) in the specified language.
Public methodGetMessagePlaceHolderText
Gets the text of a message placeholder (in a ContentMessage) in the specified language.
Protected methodGetNewPermissionContext
Creates a new permission context based on current object type.
(Overrides PFBaseObjectGetNewPermissionContext.)
Public methodGetObjectRelationByName
Gets a children entities relation by its name.
(Inherited from PFRelationalObject.)
Public methodGetParts
Gets items whose current item is the owner item.
Public methodGetPartsAndTasksRecursively
Gets items whose current item is the owner item and recursively. Will also return tasks of each returned item.
Public methodGetPartsRecursively
Gets items whose current item is the owner item and recursively.
Public methodGetRelatedItems(Guid, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
Public methodGetRelatedItems(String, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
Public methodGetRelatedItems(String, Guid, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
Public methodGetRelatedItems(String, String, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
Public methodGetRelatedItems(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
Public methodGetRelatedItemsByGroup(Guid, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
Public methodGetRelatedItemsByGroup(String, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
Public methodGetRelatedItemsByGroup(String, Guid, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
Public methodGetRelatedItemsByGroup(String, String, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
Public methodGetRelatedItemsByGroup(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
Public methodStatic memberGetRelativePrintUrl
Generates an URL for an hypothetical item in print view.
Public methodStatic memberGetRelativeUrl(PFContentType, Int64)
Generates an URL for an hypothetical item.
Public methodStatic memberGetRelativeUrl(String, String, Int64)
Generates an URL for an hypothetical item.
Public methodGetShownEventTagsInMessaging
Returns the values of Tag that should be included when displaying the messaging UI for this PFItem instance.
Protected methodGetTasksDueDate
Computes the due date using modeling settings on current state and taken transition.
Protected methodHasPendingModificationsOnSynchronizedColumns
Determines whether at least one synchronized (with the model) data has been modified. This will always return false for an item not being synchronized with the model.
Public methodInheritFromOwnerItemApplicationContext
Gets the corresponding application context from the owner item and set in this item.
Protected methodInitializeLogger
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.)
Public methodIsFieldRequired

Checks if a field is required before any Save of this item.

By default, returns True if the field is marked as required or if the transition requires this field, if the transition is specified.

Note : will return false for all FileHolder fields before creation.

Public methodIsUserOwner
Checks if a user has the owner privilege on this item.
Protected methodIsVisibleToEveryone
Override this method if you want to force-open this item's visibility to everyone.
Public methodOnAfterCreateNotification
Raises the [E:BeforeSendingNotification] event.
Public methodOnBeforeCreateNotification
Raises the [E:BeforeSendingNotification] event.
Public methodOnFileBinding
Raises the [E:FileOpened] event.
Public methodOnFileDownloaded
Raises the [E:FileDownloaded] event.
Public methodOnFileDownloading
Raises the [E:FileDownloading] event.
Protected methodOnInitialized
Raises the [E:Initialized] event.
Public methodPreInitOwnerItem
Initializes owner item before creation.

This allows the item to have access to the OwnerItem property before its creation and obviously before the relation exists.

Important: an exception is thrown if the owner item is invalid or already initialized or if the item is already created in the database.

Protected methodProcessPermissions
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.)
Public methodReleaseLock
Releases the lock of a given user, if found.
Public methodRemoveItemRelation(Guid, PFItem)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(Guid, PFItemReference)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(String, PFItem)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(String, PFItemReference)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(ContentRelation, PFItem)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(ContentRelation, PFItemReference)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(String, Guid, PFItem)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(String, Guid, PFItemReference)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(String, String, PFItem)
Removes an item relation between this item and another.
Public methodRemoveItemRelation(String, String, PFItemReference)
Removes an item relation between this item and another.
Public methodResetOwnerItemCache
Resets owner item cache, for example if the owner item could have changed.
Public methodRunInTransactionArea
Runs a code with a transaction on object connection. If there is no current transaction and if the code succeed, transaction is committed. If an exception is thrown, transaction is rollback.
(Inherited from PFBaseObject.)
Public methodSave
Saves this item in the database.

But also:

-Validates required fields.

-Generates a default reference.

-Ensures the synchronization between choice fields and relations.

-Ensures files validity.

-Trigger multiple events.

Note: use transaction. If transaction already exists,

will not commit it, but may rollback it if needed (then an exception is thrown).

(Overrides PFBaseObjectSave.)
Public methodSaveAsPartOf(String, PFItem, Boolean, Boolean)
Saves this item and directly link it to an owner item through a relation.
Public methodSaveAsPartOf(ContentRelation, PFItem, Boolean, Boolean)
Saves this item and directly link it to an owner item through a relation.
Protected methodSaveObjectsInDataCollection
Saves data loaded from temp specialized object in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTriggerNotification(String, ListPFUser)
Triggers a notification based on a name.
Public methodTriggerNotification(PFNotificationTriggerType, ListPFUser)
Triggers a notification type for this item.

IMPORTANT : This method does not support TaskAssigned as a trigger type, use TaskAssignedOnly or TaskReassignedOnly instead.

Public methodTryGetLock
Tries to get a lock for a given user.
Public methodTryToGetVersionEditedByUser
The edited version is a backup of the item's data when the user started to edit this item. This allows to set his changes to the same item version

This method tries to get this item's version, if it exists.

Public methodUpdateVersionEditedByUser
The edited version is a backup of the item's data when the user started to edit this item. This allows to set his changes to the same item version

This method updates that version to the current metadata, it upgrades it.

Public methodUserHasPrivilege
Checks if a user has a given privilege on this item.
Public methodValidateRequiredFields
Checks if all required fields are currently filled.

Will throw a PFMissingItemValuesException if not.

Will throw a ValidationException is one or more required fields entry are missing in the data collection.

Note : this method is called at the beginning of the Save method.

Public methodWorkflow_Enact

Moves the workflow (if possible).

Ensures tasks (if enacted).

Saves item to database (in any case).

Note: uses transaction. If transaction already exists,

will not commit it, but may rollback it if needed (then an exception is thrown).
Public methodWorkflow_Enact(Int32)

Moves the workflow (if possible).

Ensures tasks (if enacted).

Saves item to database (in any case).

Note: uses transaction. If transaction already exists,

will not commit it, but may rollback it if needed (then an exception is thrown).
Public methodWorkflow_Enact(State)

Moves the workflow (if possible).

Ensures tasks (if enacted).

Saves item to database (in any case).

Note: uses transaction. If transaction already exists,

will not commit it, but may rollback it if needed (then an exception is thrown).
Public methodWorkflow_Enact(Transition)

Moves the workflow (if possible).

Ensures tasks (if enacted).

Saves item to database (in any case).

Note: uses transaction. If transaction already exists,

will not commit it, but may rollback it if needed (then an exception is thrown).
Public methodWorkflow_EnsureTasks
Cancels tasks of previous state instances and ensure tasks for current state instance.
Public methodWorkflow_GetCurrentTaskForUser
Gets the task of a given user in the current state instance, if found.

If multiple instance tasks are available for the user, active task (if any) is returned first.

Public methodWorkflow_GetRequiredFieldsForTransition
Gets the required fields for a given transition.
Public methodWorkflow_ReassignTask
Reassigns a specific task of this workflow to another user.
Protected methodWorkflow_ResolveTransitionConflict
If multiple transitions are possible; the conflict must be resolved. By default, takes top most transition based on Transition Priority and then on participation count.
Top
Events
  NameDescription
Public eventAfterCreate
Occurs after an item has been created in database.
Public eventAfterCreateFile
Occurs after a file has been created on this item.
Public eventAfterCreateNotification
Occurs after a user notification whose related object is this item was created.
Public eventAfterDelete
Occurs after an item has been deleted.
Public eventAfterDeleteFile
Occurs after a file of this item has been deleted.
Public eventAfterSave
Occurs when an item has been updated or created in database.
Public eventAfterUpdate
Occurs after an item has been updated in database.
Public eventAfterUpdateFile
Occurs after a file of this item has been updated.
Public eventBeforeCreate
Occurs when an item is being persisted for the first time in database.
Public eventBeforeCreateFile
Occurs when a file is being created on this item.
Public eventBeforeCreateNotification
Occurs before a user notification whose related object is this item is created.
Public eventBeforeDelete
Occurs when an item is being deleted.
Public eventBeforeDeleteFile
Occurs when a file of this item is being deleted.
Public eventBeforeSave
Occurs when an item is being updated or created in database.
Public eventBeforeSendingNotification
Occurs before a modeled notification is sent.
Public eventBeforeUpdate
Occurs when an item is being updated in database.
Public eventBeforeUpdateFile
Occurs when a file of this item is being updated.
Public eventCommentAdded
Occurs after a PFItemComment has been added on the item.
Public eventEventAdded
Occurs after a PFItemEvent has been added on the item.
Public eventFileBinding
Occurs when a file of this item is about to be bound via WordForm or Quickparts.
Public eventFileConfirmed
Occurs when a file has been confirmed on this item. A file is confirmed when, after its upload, the parent item is saved with a reference to the file in the FileHolder value.
Public eventFileDownloaded
Occurs when a file of this item has been downloaded. Engine triggers this event on an async task. Do not use non-thread safe objects. (Packflow types inheriting PFBaseObject are thread-safe in this case) Codes triggering this event does not depend on HttpContext or other web context object. When triggered, there is no warranty the download is finished or succeeded.
Public eventFileDownloading
Occurs when a file of this item has been downloaded.
Public eventFileOpened
Occurs when a file of this item has been opened for modification (Office or KeePass application).
Public eventStateChanged
Occurs after the call to Save() during enactment when the SQL transaction made to move the workflow is committed.
Public eventStateChanging
Occurs when the state has been changed in this item instance, but the save has not been called yet.
Top
Fields
  NameDescription
Public fieldStatic memberFieldName_ApplicationContextId
Column name in database.
Public fieldStatic memberFieldName_ApplicationContextName
Column name in database.
Public fieldStatic memberFieldName_ContentTypeId
Column name in database.
Public fieldStatic memberFieldName_ExternalConnectionId
Column name in database.
Public fieldStatic memberFieldName_InboundTransition
Column name in database.
Public fieldStatic memberFieldName_InboundTransitionId
Column name in database.
Public fieldStatic memberFieldName_ModelItemGuid
Column name in database.
Public fieldStatic memberFieldName_Reference
Column name in database.
Public fieldStatic memberFieldName_State
Column name in database.
Public fieldStatic memberFieldName_StateId
Column name in database.
Public fieldStatic memberFieldName_StateInstanceId
Column name in database.
Public fieldStatic memberFieldName_Status
Column name in database.
Public fieldStatic memberFieldName_UserUpdatedAt
Column name in database.
Public fieldStatic memberFieldName_UserUpdatedBy
Column name in database.
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetReferenceOverloaded.
Gets a object referencing the item.
(Defined by PFItemExtensions.)
Public Extension MethodGetReference(String)Overloaded.
Gets a object referencing the item. The Text of the reference will be the value of the specified field.
(Defined by PFItemExtensions.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also