PFField Class |
Namespace: Packflow.Core
public abstract class PFField : PFBaseObject
The PFField type exposes the following members.
Name | Description | |
---|---|---|
BeforeSaveValues |
Gets the previous values of modified fields before the latest Save.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. | |
CanDelete |
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.) | |
CanRead |
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.) | |
CanUpdate |
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.) | |
ControlContainerMinHeight |
Gets the minimal height of the field's control container. Does not apply if negative.
| |
ControlHeightIsDynamic |
Gets a value indicating whether the control of this field could resize itself to fit its content.
| |
Created |
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.) | |
CreatedAt |
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.) | |
CreatedBy |
Gets the user who created this object in the database.
(Inherited from PFBaseObject.) | |
Data |
Gets the data collection of this object.
(Inherited from PFBaseObject.) | |
DateObjectCreation |
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.) | |
Deleted |
True if this object is flagged as deleted.
(Inherited from PFBaseObject.) | |
DeletedAt |
Date of the suppression of this object.
(Inherited from PFBaseObject.) | |
DeletedBy |
The user who deleted this object.
(Inherited from PFBaseObject.) | |
Description |
Gets or sets the description
| |
DisplayName |
Gets or sets the default display name.
Note: the getter will search the translation in the application model by default.
| |
EnableVersionMergeToResolveSaveConflicts |
Gets a value indicating whether versions can be merged to resolve save conflicts.
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.
(Inherited from PFBaseObject.) | |
Exists |
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.) | |
ForceLoadOnViews |
Gets or sets a value indicating whether the field value should be loaded
from the database in every view, even if not displayed to the user.
| |
Guid |
Gets the GUID identifying this object.
Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.) | |
HasComplexValue |
Gets a value indicating whether the current field is handling values with a specific Packflow type.
| |
HasPendingModifications |
Checks if there is pending changes.
Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.) | |
HasPendingPermissionsModifications |
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.) | |
Height |
Gets or sets the desired height for the control of this field.
| |
Id |
Gets the id identifying this object.
Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.) | |
Internal | Obsolete.
Obsolete. Use SystemField instead.
| |
KeepBeforeSaveValues |
Gets or sets a value indicating whether
the Save should keep a collection of the modified fields previous values.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. | |
Logger |
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.) | |
LogIdentification |
Gets a technical text representing this object.
(Overrides PFBaseObjectLogIdentification.) | |
ModelColumn |
Gets the column corresponding to this field in the model of the parent application.
| |
ModelColumnGuid |
Gets the Guid of the corresponding column in the application model.
| |
Name |
Gets or sets the internal name of this field.
| |
ParentContentType |
Gets the parent content-type of this field.
| |
PermissionContext |
Gets an object calculating permissions on demand.
| |
Permissions |
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.) | |
PermissionSetDeleteId |
Id of the permission set for Delete access.
(Inherited from PFBaseObject.) | |
PermissionSetDeleteXml |
XML of serialized permission set for Delete access.
(Inherited from PFBaseObject.) | |
PermissionSetReadId |
Id of the permission set for Read access.
(Inherited from PFBaseObject.) | |
PermissionSetReadXml |
XML of serialized permission set for Read access.
(Inherited from PFBaseObject.) | |
PermissionSetUpdateId |
Id of the permission set for Update access.
(Inherited from PFBaseObject.) | |
PermissionSetUpdateXml |
XML of serialized permission set for Update access.
(Inherited from PFBaseObject.) | |
ReadOnly |
Gets or sets a value indicating whether values from this field can be modified from the UI.
| |
Required |
Gets or sets a value indicating whether a value for this field is required for any PFItem.
| |
SerializedSettngs |
Gets or sets a serialized object (JSON) containing fields specific settings.
| |
Settings |
Gets the type-specific settings of this PFField.
| |
Site |
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.) | |
SystemField |
Gets a value indicating whether this field is a valid standard/system field.
A system field is automatically present in any content-type of the same type. | |
Type |
Gets a value indicating the type of a field. This allows to check the type of a field without the "is" keyword.
| |
TypeText |
Gets the type of the field, as it is stored in the database.
| |
UpdatedAt |
Gets the date of the last update of this object.
(Inherited from PFBaseObject.) | |
UpdatedBy |
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.) | |
VersionNumber |
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.) | |
Width |
Gets or sets the desired width for the control of this field.
|
Name | Description | |
---|---|---|
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. | |
DeserializeSettingsT |
Deserializes settings using a specific PFFieldSettings class.
| |
GetCurrentCulture |
Gets the culture used by this field
to represents values and controls. Based on current used effective language.
| |
GetCurrentCulture(PFSite) |
Gets the current culture based on current user effective language.
If site is null, returns GetDefaultCulture().
| |
GetDefaultCulture |
Gets the culture used when no PFSite is available. Currently returns CurrentUICulture.
| |
GetDefaultFieldControlName |
Gets the name of the main control of this field for a given item.
| |
GetFieldControlId |
Returns an unique HTML control Id based on current field name.
Note : characters ".", "_" and " " are automatically removed from controlName.
| |
GetFieldControlProperties |
Using the control id generated by GetFieldControlId and returns Id and Name properties for a HTML control.
| |
GetGenericDisplayHtml(Object) |
Converts a typed value to a display text using HTML.
| |
GetGenericDisplayHtml(Object, String) |
Converts a typed value to a display text using HTML.
| |
GetGenericDisplayText |
Converts a typed value to a display text without HTML.
| |
GetNewPermissionContext |
Creates a new permission context based on current object type.
(Overrides PFBaseObjectGetNewPermissionContext.) | |
GetValueObject |
Converts a raw object to a specific type handled by a specific type of PFField.
| |
GroupFieldsValues |
Groups posted values by field for each control in form.
| |
InitializeLogger |
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.) | |
InitializeSettings |
Deserializes settings using a specific PFFieldSettings class.
| |
ProcessPermissions |
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.) | |
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 |
Applies the data of this object in the database.
(Overrides PFBaseObjectSave.)When the field does not correspond to a system field, this Save will also ensure the SQL column in the database. | |
SaveObjectsInDataCollection |
Saves data loaded from temp specialized object
in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.) | |
ToString |
Generates a string representing this field for debugging, including the type and the name.
(Overrides ObjectToString.) | |
TryGetSectionName |
Tries to find the (translated) title
of the section hosting this field in the work form of the content-type.
Returns String.Empty if not found. | |
ValidateInterface |
Validates the related controls after a postback.
If success true validated value in Tag. If success false message to show in operation result message.
|
Name | Description | |
---|---|---|
ControlsPrefix |
Prefix of any control generated for a PFField.
| |
FieldName_Description |
Column name in database.
| |
FieldName_DisplayName |
Column name in database.
| |
FieldName_FieldType |
Column name in database.
| |
FieldName_ModelColumnGuid |
Column name in database.
| |
FieldName_Name |
Column name in database.
| |
FieldName_ReadOnly |
Column name in database.
| |
FieldName_Required |
Column name in database.
| |
FieldName_SystemField |
Column name in database.
|
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.) |