PFFieldUserValueHelper Class |
Wraps a PFFieldUserValue which represents the value of a PFFieldUser.
A PFFieldUserValue 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 HierarchySystemObject
Packflow.CorePFFieldValueHelper
Packflow.CorePFFieldValueHelperPFFieldUser, PFFieldUserValue
Packflow.CorePFFieldUserValueHelper
Packflow.CorePFFieldValueHelper
Packflow.CorePFFieldValueHelperPFFieldUser, PFFieldUserValue
Packflow.CorePFFieldUserValueHelper
Namespace: Packflow.Core
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
SyntaxC#
public sealed class PFFieldUserValueHelper : PFFieldValueHelper<PFFieldUser, PFFieldUserValue>, IEquatable<PFFieldUserValueHelper>
The PFFieldUserValueHelper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFFieldUserValueHelper |
Initializes a new instance of the PFFieldUserValueHelper class.
|
Properties| Name | Description | |
|---|---|---|
 | Field |
Gets the field.
(Inherited from PFFieldValueHelperFieldType, ValueType.) |
| IsEmpty |
Gets a value indicating whether the user value is null or empty.
|
| IsNotEmpty |
Gets a value indicating whether the user value is not null and contains references.
|
| References |
Gets the references of the selected principals.
|
| Value |
Gets or sets the stored value.
(Overrides PFFieldValueHelperFieldType, ValueTypeValue.) |
Methods| Name | Description | |
|---|---|---|
| AddGroup |
Adds a group.
|
| AddPrincipal(String) |
Adds a principal reference.
|
| AddPrincipal(PFFieldUserValue_Reference) |
Adds a principal reference.
|
| AddUser |
Adds a user.
|
| Clear |
Removes all selected users and groups.
|
| ClearGroups |
Removes all selected groups.
|
| ClearUsers |
Removes all selected users.
|
| Contains(PFGroup) |
Determines whether the value contains the specified group.
|
| Contains(PFUser) |
Determines whether the value contains the specified user.
|
| ContainsGroup |
Determines whether the value contains the specified group.
|
| ContainsUser |
Determines whether the value contains the specified user.
|
| Equals |
Indicates whether the current object is equal to another object of the same type.
|
| GetGroups |
Gets the selected groups from the database.
|
| GetGroupsIds |
Gets the id of selected groups.
|
| GetUsers |
Gets the selected users from the database.
|
| GetUsersIds |
Gets the id of selected users.
|
| GetValue |
Gets the value. (Generic method)
(Inherited from PFFieldValueHelperFieldType, ValueType.) |
| RemoveGroup(Int64) |
Removes a group.
|
| RemoveGroup(PFGroup) |
Removes a group.
|
| RemoveUser(Int64) |
Removes a user.
|
| RemoveUser(PFUser) |
Removes a user.
|
| Set(PFFieldUserValueHelper) |
Replaces the currently selected values by the given ones.
|
| Set(PFGroup) |
Replaces the currently selected values (users and groups) by the given group.
|
| Set(PFUser) |
Replaces the currently selected values (users and groups) by the given user.
|
| Set(IEnumerablePFGroup, IEnumerablePFUser) |
Replaces the currently selected values by the given ones.
|
| Set(IEnumerablePFUser, IEnumerablePFGroup) |
Replaces the currently selected values by the given ones.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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.) |
| 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