Click or drag to resize

PFFieldChoice Class

Represents a content-type's field hosting a Choice value. This value is referencing other PFItem(s) using PFItemReference(s).
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 sealed class PFFieldChoice : PFField

The PFFieldChoice type exposes the following members.

Constructors
  NameDescription
Public methodPFFieldChoice
Top
Properties
  NameDescription
Public propertyAllowMultipleValues
Gets a value indicating whether a value can reference more than one item.
Public propertyAutoCompleteCloseAfterSelection
Gets a value indicating whether the auto-complete closes after a selection.
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.
(Inherited from PFField.)
Public propertyControlHeightIsDynamic
Gets a value indicating whether the control of this field could resize itself to fit its content.
(Overrides PFFieldControlHeightIsDynamic.)
Public propertyControlValueMaxCharacters
Gets the maximum number of characters shown in a control value.
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 propertyCreationMode
Gets the creation mode.
Public propertyData
Gets the data collection of this object.
(Inherited from PFBaseObject.)
Public propertyDataScope
Gets the scope of the data available for selection.
Public propertyDateObjectCreation
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.)
Public propertyDefaultValueModelItemGuid
Gets the default value guid, referencing a ContentItem.
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
(Inherited from PFField.)
Public propertyDisplayMode
Gets the display mode.
Public propertyDisplayName
Gets or sets the default display name. Note: the getter will search the translation in the application model by default.
(Inherited from PFField.)
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.
(Inherited from PFField.)
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.
(Overrides PFFieldHasComplexValue.)
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.
(Inherited from PFField.)
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.
(Inherited from PFField.)
Public propertyIsExternal
Gets a value indicating whether this field targets content in another application.
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.
(Inherited from PFField.)
Public propertyModelColumn
Gets the column corresponding to this field in the model of the parent application.
(Inherited from PFField.)
Public propertyModelColumnGuid
Gets the Guid of the corresponding column in the application model.
(Inherited from PFField.)
Public propertyName
Gets or sets the internal name of this field.
(Inherited from PFField.)
Public propertyOpenLinksInFrame
Gets a value indicating whether links (in views) should be opened in a frame instead of the classic navigation.
Public propertyParentContentType
Gets the parent content-type of this field.
(Inherited from PFField.)
Public propertyPermissionContext
Gets an object calculating permissions on demand.
(Inherited from PFField.)
Public propertyPermissions
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.)
Public propertyReadOnly
Gets or sets a value indicating whether values from this field can be modified from the UI.
(Inherited from PFField.)
Public propertyReference
Gets the reference to the target content.
Public propertyRelationDirection
Gets the relation direction. This indicates how the values are updated from relations. If set to Both, the relations created from the other side will also be added in the choice values at next save.
Public propertyRequired
Gets or sets a value indicating whether a value for this field is required for any PFItem.
(Inherited from PFField.)
Public propertySecondaryColumnName_Ids
Gets the name of the secondary column in the database, containing only ids of the selected values.
Public propertySecondaryColumnName_Texts
Gets the name of the secondary column in the database, containing only texts of the selected values.
Public propertySelectValuesInDialog
Gets a value indicating whether the values are selected in a dialog that can be opened from the control.

Selected values are directly shown in the control and can be removed.

Does not apply on the DropDownList display mode.

Public propertyShowCreationButton
Gets a value indicating whether a creation option should be available when the control is editable.
Public propertyShowLinksInDisplayMode
Gets a value indicating whether links must be shown in views. If set to False, the values will still be clickable, but they will appear as simple text.
Public propertyShowNoneChoice
Gets a value indicating whether the 'None' value can be displayed in the control.

This setting only applies on radio buttons controls (DisplayMode=Choices + no multiple values)

Public propertyShowSelectedValuesFirst
Gets a value indicating whether the selected values should be shown at the beginning of the list of values (in a Choice display mode).
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.

(Inherited from PFField.)
Public propertyTL_Checkboxes
Gets a value indicating which nodes of the tree can be checked.
Public propertyTL_ShowTreeViewInDisplayMode
Gets a value indicating whether a tree should be displayed instead of the classic list of values.
Public propertyTL_TreeViewState
Gets a value indicating which node of the tree are expanded by default.
Public propertyType
Gets a value indicating the type of a field. This allows to check the type of a field without the "is" keyword.
(Inherited from PFField.)
Public propertyTypeText
Gets the type of the field, as it is stored in the database.
(Inherited from PFField.)
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 propertyUseNewLinesInDisplayMode
Gets a value indicating whether values are separated by new lines in views. If set to False, values will separated by commas.
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.
(Inherited from PFField.)
Top
Methods
  NameDescription
Public methodCreateValue(PFItem)
Creates a new instance of the PFFieldChoiceValue class.
Public methodCreateValue(IEnumerablePFItem)
Creates a new instance of the PFFieldChoiceValue class.
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 methodGetCurrentCulture
Gets the culture used by this field to represents values and controls. Based on current used effective language.
(Inherited from PFField.)
Public methodGetDefaultFieldControlName
Gets the name of the main control of this field for a given item.
(Overrides PFFieldGetDefaultFieldControlName(Int64).)
Public methodGetFieldControlId
Returns an unique HTML control Id based on current field name. Note : characters ".", "_" and " " are automatically removed from controlName.
(Inherited from PFField.)
Public methodGetGenericDisplayHtml(Object)
Converts a typed value to a display text using HTML.
(Inherited from PFField.)
Public methodGetGenericDisplayHtml(Object, String)
Converts a typed value to a display text using HTML.
(Overrides PFFieldGetGenericDisplayHtml(Object, String).)
Public methodGetGenericDisplayHtml(Object, String, PFFieldChoiceValue_DisplaySeparatorType, Boolean, Boolean)
Converts a typed value to a display text using HTML.
Public methodGetGenericDisplayText
Converts a typed value to a display text without HTML.
(Overrides PFFieldGetGenericDisplayText(Object).)
Public methodGetTargetApplication
Gets the target application.
Public methodGetTargetContentType
Gets the target content-type.
Public methodGetTargetView
Gets the target view.
Public methodGetValueObject
Converts a raw object to a specific type handled by a specific type of PFField.
(Overrides PFFieldGetValueObject(Object).)
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.

(Inherited from PFField.)
Public methodToString
Generates a string representing this field for debugging, including the type and the name.
(Inherited from PFField.)
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.

(Inherited from PFField.)
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.
(Overrides PFFieldValidateInterface(DictionaryString, Object).)
Public methodValidateInterface_AutoComplete
Validates the values of an autocomplete control.
Public methodValidateInterface_Choices
Validates the values of a choice control (including checkboxes or radio buttons).
Public methodValidateInterface_DropDown
Validates the values of a dropdown control.
Top
Fields
  NameDescription
Public fieldStatic memberControlBaseName_ChoiceInput
Base name for checkboxes and radio buttons displayed for a choice field.
Public fieldStatic memberControlName_AutoCompleteInput
Name of the control hosting values in the autocomplete display mode.
Public fieldStatic memberControlName_Choice_HiddenInput
Name of the control: hidden input posted to get the control value when there is no checked radio button or checkbox (=not posted).
Public fieldStatic memberControlName_DropDownInput
Name of the control: dropdown list (select).
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