PFItem Methods |
The PFItem type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddItemRelation(Guid, PFItem) |
Adds an item relation from this item to another.
|
| AddItemRelation(Guid, PFItemReference) |
Adds an item relation from this item to another.
|
| AddItemRelation(String, PFItem) |
Adds an item relation from this item to another.
|
| AddItemRelation(String, PFItemReference) |
Adds an item relation from this item to another.
|
| AddItemRelation(ContentRelation, PFItem) |
Adds an item relation from this item to another.
|
| AddItemRelation(ContentRelation, PFItemReference) |
Adds an item relation from this item to another.
|
| AddItemRelation(String, Guid, PFItem) |
Adds an item relation from this item to another.
|
| AddItemRelation(String, Guid, PFItemReference) |
Adds an item relation from this item to another.
|
| AddItemRelation(String, String, PFItem) |
Adds an item relation from this item to another.
|
| AddItemRelation(String, String, PFItemReference) |
Adds an item relation from this item to another.
|
| AttachFile(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.
|
| AttachFile(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.
|
| AttachPdfFile(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.
|
| AttachPdfFile(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.
|
| BaseSave |
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).
|
 | BatchOperationTPFItem |
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.
|
| BatchSaveTPFItem |
Saves multiple items inside a single transaction.
Important note : batch save items without references pre-initialized will slow this operation. |
| CanFieldBeModifiedByUser(String) |
Checks if a field control mode is editable in the current context.
|
| CanFieldBeModifiedByUser(PFField) |
Checks if a field control mode is editable in the current context.
|
| ChangeApplicationContext |
Will change the context of this item, of its parts items and of its tasks.
You must have the permission to modify everything.
|
| CustomizeDefaultFileNameByTemplate |
Allows to customize default file names proposed to users for each template.
|
| Delete |
Flags this object as deleted.
(Inherited from PFBaseObject.)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. |
| DeletePermanently |
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.
|
| ExternalConnection_Get |
Gets the external connection having synchronized this item.
|
| ExternalConnection_GetExternalData |
Externals the connection_ get external data.
|
| ExternalConnection_Synchronize |
Synchronizes this item's data properties with its external content.
Note: this does NOT save the item. |
| ExternalConnection_SynchronizeAndSave |
Synchronizes this item's data properties with its external content,
then saves the item if the synchronization changed any value.
|
| ExternalConnection_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.
|
| GenerateHtmlMessage(Int32, String) |
Generates a html message (subject and body) from a modeling message.
|
| GenerateHtmlMessage(String, String) |
Generates a html message (subject and body) from a modeling message.
|
| GenerateHtmlMessage(ContentMessage, String) |
Generates a html message (subject and body) from a modeling message.
|
 | GenerateReference | 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. |
| GenerateTaskTitle | Used to initialize a task title in the current workflow state. Default : "{Reference} : {State}" |
| GenerateTextMessage(Int32, String) |
Generates a html message (subject and body) from a modeling message.
|
| GenerateTextMessage(String, String) |
Generates a html message (subject and body) from a modeling message.
|
| GenerateTextMessage(ContentMessage, String) |
Generates a html message (subject and body) from a modeling message.
|
| GetAbsolutePrintUrl |
Generates an absolute URL for an hypothetical item in print view.
|
| GetAbsoluteUrl |
Generates an absolute URL for an hypothetical item.
|
| GetConversationTitle |
Defines the title of this item conversation for the specified user.
Returns this item caption by default.
|
| GetFieldControlMode(String) |
Gets the control mode of a field in the current context.
|
| GetFieldControlMode(PFField) |
Gets the control mode of a field in the current context.
|
| GetFieldDisplayValue(String) |
Gets display text (not html) of a field in this item.
|
| GetFieldDisplayValue(PFField) |
Gets display text (not html) of a field in this item.
|
| GetFieldDisplayValue(PFDataCollection, PFField) |
Gets a field display text (not html) from a data collection.
|
| GetFieldGenericDisplayHtml(PFDataCollection, PFField) |
Gets a field display html from a data collection.
|
| GetFieldGenericDisplayHtml(PFDataCollection, PFField, String) |
Gets a field display value from a data collection.
|
| GetGuid |
Returns a Global Unique Identifier for the target.
|
| GetId |
Returns an id representing the target.
|
| GetItemLocks |
Gets current locks.
Note : will return an empty list if the object is not yet created. |
| GetLocks |
Gets current locks.
|
| GetMessagePlaceHolderHtml |
Gets the html of a message placeholder (in a ContentMessage) in the specified language.
|
| GetMessagePlaceHolderText |
Gets the text of a message placeholder (in a ContentMessage) in the specified language.
|
| GetNewPermissionContext |
Creates a new permission context based on current object type.
(Overrides PFBaseObjectGetNewPermissionContext.) |
| GetObjectRelationByName |
Gets a children entities relation by its name.
(Inherited from PFRelationalObject.) |
| GetParts |
Gets items whose current item is the owner item.
|
| GetPartsAndTasksRecursively |
Gets items whose current item is the owner item and recursively.
Will also return tasks of each returned item.
|
| GetPartsRecursively |
Gets items whose current item is the owner item and recursively.
|
| GetRelatedItems(Guid, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
|
| GetRelatedItems(String, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
|
| GetRelatedItems(String, Guid, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
|
| GetRelatedItems(String, String, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
|
| GetRelatedItems(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
|
| GetRelatedItemsByGroup(Guid, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
|
| GetRelatedItemsByGroup(String, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
|
| GetRelatedItemsByGroup(String, Guid, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
|
| GetRelatedItemsByGroup(String, String, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
|
| GetRelatedItemsByGroup(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
|
| GetRelativePrintUrl |
Generates an URL for an hypothetical item in print view.
|
| GetRelativeUrl(PFContentType, Int64) |
Generates an URL for an hypothetical item.
|
| GetRelativeUrl(String, String, Int64) |
Generates an URL for an hypothetical item.
|
| GetShownEventTagsInMessaging | |
| GetTasksDueDate |
Computes the due date using modeling settings on current state and taken transition.
|
| HasPendingModificationsOnSynchronizedColumns |
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.
|
| InheritFromOwnerItemApplicationContext |
Gets the corresponding application context from the owner item and set in this item.
|
| InitializeLogger |
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.) |
| IsFieldRequired | 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. |
| IsUserOwner |
Checks if a user has the owner privilege on this item.
|
| IsVisibleToEveryone |
Override this method if you want to force-open this item's visibility to everyone.
|
| OnAfterCreateNotification |
Raises the [E:BeforeSendingNotification] event.
|
| OnBeforeCreateNotification |
Raises the [E:BeforeSendingNotification] event.
|
| OnFileBinding |
Raises the [E:FileOpened] event.
|
| OnFileDownloaded |
Raises the [E:FileDownloaded] event.
|
| OnFileDownloading |
Raises the [E:FileDownloading] event.
|
| OnInitialized |
Raises the [E:Initialized] event.
|
| PreInitOwnerItem |
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. |
| ProcessPermissions |
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.) |
| ReleaseLock |
Releases the lock of a given user, if found.
|
| RemoveItemRelation(Guid, PFItem) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(Guid, PFItemReference) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(String, PFItem) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(String, PFItemReference) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(ContentRelation, PFItem) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(ContentRelation, PFItemReference) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(String, Guid, PFItem) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(String, Guid, PFItemReference) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(String, String, PFItem) |
Removes an item relation between this item and another.
|
| RemoveItemRelation(String, String, PFItemReference) |
Removes an item relation between this item and another.
|
| ResetOwnerItemCache |
Resets owner item cache, for example if the owner item could have changed.
|
| RunInTransactionArea |
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.) |
| Save |
Saves this item in the database.
(Overrides PFBaseObjectSave.)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). |
| SaveAsPartOf(String, PFItem, Boolean, Boolean) |
Saves this item and directly link it to an owner item through a relation.
|
| SaveAsPartOf(ContentRelation, PFItem, Boolean, Boolean) |
Saves this item and directly link it to an owner item through a relation.
|
| SaveObjectsInDataCollection |
Saves data loaded from temp specialized object
in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TriggerNotification(String, ListPFUser) |
Triggers a notification based on a name.
|
| TriggerNotification(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. |
| TryGetLock |
Tries to get a lock for a given user.
|
| TryToGetVersionEditedByUser |
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. |
| UpdateVersionEditedByUser |
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. |
| UserHasPrivilege |
Checks if a user has a given privilege on this item.
|
| ValidateRequiredFields |
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. |
| Workflow_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). |
| Workflow_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). |
| Workflow_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). |
| Workflow_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). |
| Workflow_EnsureTasks |
Cancels tasks of previous state instances and ensure tasks for current state instance.
|
| Workflow_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. |
| Workflow_GetRequiredFieldsForTransition |
Gets the required fields for a given transition.
|
| Workflow_ReassignTask |
Reassigns a specific task of this workflow to another user.
|
| Workflow_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.
|
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.) |
| GetReference | Overloaded.
Gets a object referencing the item.
(Defined by PFItemExtensions.) |
| GetReference(String) | Overloaded.
Gets a object referencing the item.
The Text of the reference will be the value of the specified field.
(Defined by PFItemExtensions.) |
| 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