Click or drag to resize

PFField Class

Represents a content-type's field.
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 PFField : PFBaseObject

The PFField type exposes the following members.

Constructors
  NameDescription
Protected methodPFField
Top
Properties
  NameDescription
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 propertyControlContainerMinHeight
Gets the minimal height of the field's control container. Does not apply if negative.
Public propertyControlHeightIsDynamic
Gets a value indicating whether the control of this field could resize itself to fit its content.
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 data collection of this object.
(Inherited from PFBaseObject.)
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 propertyDescription
Gets or sets the description
Public propertyDisplayName
Gets or sets the default display name. Note: the getter will search the translation in the application model by default.
Public propertyEnableVersionMergeToResolveSaveConflicts
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.)
Public propertyExists
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.)
Public propertyForceLoadOnViews
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.
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 propertyHasComplexValue
Gets a value indicating whether the current field is handling values with a specific Packflow type.
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 propertyHeight
Gets or sets the desired height for the control of this field.
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 propertyInternal Obsolete.
Obsolete. Use SystemField instead.
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.

(Inherited from PFBaseObject.)
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.
(Overrides PFBaseObjectLogIdentification.)
Public propertyModelColumn
Gets the column corresponding to this field in the model of the parent application.
Public propertyModelColumnGuid
Gets the Guid of the corresponding column in the application model.
Public propertyName
Gets or sets the internal name of this field.
Public propertyParentContentType
Gets the parent content-type of this field.
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 propertyReadOnly
Gets or sets a value indicating whether values from this field can be modified from the UI.
Public propertyRequired
Gets or sets a value indicating whether a value for this field is required for any PFItem.
Protected propertySerializedSettngs
Gets or sets a serialized object (JSON) containing fields specific settings.
Protected propertySettings
Gets the type-specific settings of this PFField.
Public propertySite
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.)
Public propertySystemField
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.

Public propertyType
Gets a value indicating the type of a field. This allows to check the type of a field without the "is" keyword.
Public propertyTypeText
Gets the type of the field, as it is stored in the database.
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 propertyVersionNumber
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.)
Public propertyWidth
Gets or sets the desired width for the control of this field.
Top
Methods
  NameDescription
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.)
Protected methodStatic memberDeserializeSettingsT
Deserializes settings using a specific PFFieldSettings class.
Public methodGetCurrentCulture
Gets the culture used by this field to represents values and controls. Based on current used effective language.
Public methodStatic memberGetCurrentCulture(PFSite)
Gets the current culture based on current user effective language. If site is null, returns GetDefaultCulture().
Public methodStatic memberGetDefaultCulture
Gets the culture used when no PFSite is available. Currently returns CurrentUICulture.
Public methodGetDefaultFieldControlName
Gets the name of the main control of this field for a given item.
Public methodGetFieldControlId
Returns an unique HTML control Id based on current field name. Note : characters ".", "_" and " " are automatically removed from controlName.
Public methodStatic memberGetFieldControlProperties
Using the control id generated by GetFieldControlId and returns Id and Name properties for a HTML control.
Public methodGetGenericDisplayHtml(Object)
Converts a typed value to a display text using HTML.
Public methodGetGenericDisplayHtml(Object, String)
Converts a typed value to a display text using HTML.
Public methodGetGenericDisplayText
Converts a typed value to a display text without HTML.
Protected methodGetNewPermissionContext
Creates a new permission context based on current object type.
(Overrides PFBaseObjectGetNewPermissionContext.)
Public methodGetValueObject
Converts a raw object to a specific type handled by a specific type of PFField.
Public methodStatic memberGroupFieldsValues
Groups posted values by field for each control in form.
Protected methodInitializeLogger
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.)
Protected methodInitializeSettings
Deserializes settings using a specific PFFieldSettings class.
Protected methodProcessPermissions
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.)
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
Applies the data of this object in the database.

When the field does not correspond to a system field, this Save will also ensure the SQL column in the database.

(Overrides PFBaseObjectSave.)
Protected methodSaveObjectsInDataCollection
Saves data loaded from temp specialized object in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.)
Public methodToString
Generates a string representing this field for debugging, including the type and the name.
(Overrides ObjectToString.)
Public methodTryGetSectionName
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.

Public methodValidateInterface
Validates the related controls after a postback. If success true validated value in Tag. If success false message to show in operation result message.
Top
Fields
  NameDescription
Public fieldStatic memberControlsPrefix
Prefix of any control generated for a PFField.
Public fieldStatic memberFieldName_Description
Column name in database.
Public fieldStatic memberFieldName_DisplayName
Column name in database.
Public fieldStatic memberFieldName_FieldType
Column name in database.
Public fieldStatic memberFieldName_ModelColumnGuid
Column name in database.
Public fieldStatic memberFieldName_Name
Column name in database.
Public fieldStatic memberFieldName_ReadOnly
Column name in database.
Public fieldStatic memberFieldName_Required
Column name in database.
Public fieldStatic memberFieldName_SystemField
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 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
Inheritance Hierarchy