Click or drag to resize

PFFieldChoiceValueHelper Class

Wraps a PFFieldChoiceValue which represents the value of a PFFieldChoice. A PFFieldChoiceValue is not directly related to a PFItem or a PFField, requiring more code when using it. Working with this helper allows avoiding all null checks and field settings references when browsing and modifying the values.
Inheritance Hierarchy
SystemObject
  Packflow.CorePFFieldValueHelper
    Packflow.CorePFFieldValueHelperPFFieldChoice, PFFieldChoiceValue
      Packflow.CorePFFieldChoiceValueHelperPFItem
        Packflow.CorePFFieldChoiceValueHelper

Namespace:  Packflow.Core
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
public class PFFieldChoiceValueHelper : PFFieldChoiceValueHelper<PFItem>

The PFFieldChoiceValueHelper type exposes the following members.

Constructors
  NameDescription
Public methodPFFieldChoiceValueHelper
Initializes a new instance of the PFFieldChoiceValueHelper class.
Top
Properties
  NameDescription
Protected propertyData
Gets or sets the data collection.
(Inherited from PFFieldValueHelperFieldType, ValueType.)
Public propertyField
Gets the field.
(Inherited from PFFieldValueHelperFieldType, ValueType.)
Public propertyIsEmpty
Gets a value indicating whether the choice value is null or empty.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public propertyIsNotEmpty
Gets a value indicating whether the choice value is not null and contains references.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public propertyReferences
Gets the references of the selected items.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public propertyValue
Gets or sets the stored value.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Top
Methods
  NameDescription
Public methodAddItem(TargetItemType)
Adds an item.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodAddItem(PFItemReference)
Adds an item.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodAddItems(IEnumerableTargetItemType)
Adds items.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodAddItems(TargetItemType)
Adds items.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodClear
Removes all selected items.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodEquals
Indicates whether the current object is equal to another object of the same type.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodGetItemsT
Gets selected items.
Public methodGetSelectedGuid
Gets the item GUID of the choice value. Returns Guid.Empty if the value is null or empty.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodGetSelectedGuids
Gets the item GUIDs of the choice value. Returns an empty list if the value is null or empty.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodGetSelectedId
Gets the item id of the choice value. Returns -1 if the value is null or empty.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodGetSelectedIds
Gets the item ids of the choice value. Returns an empty list if the value is null or empty.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodGetValue
Gets the value. (Generic method)
(Inherited from PFFieldValueHelperFieldType, ValueType.)
Public methodRemoveItem(Guid)
Removes an item. Note: does not throw an exception if the item is not found among the values.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodRemoveItem(TargetItemType)
Removes an item. Note: does not throw an exception if the item is not found among the values.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodRemoveItem(PFItemReference)
Removes an item. Note: does not throw an exception if the item is not found among the values.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodSet(IEnumerableTargetItemType)
Replaces the currently selected items by the given ones.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodSet(TargetItemType)
Replaces the currently selected items by the given ones.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodSet(PFFieldChoiceValueHelperTargetItemType)
Replaces the currently selected items by the given ones.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodSet(PFItemReference)
Replaces the currently selected items by the given one.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
Public methodToString
Returns a string that represents the current object.
(Inherited from PFFieldChoiceValueHelperTargetItemType.)
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