PFQueryFilter Class |
Inheritance HierarchyPackflow.CorePFQueryFilter
Packflow.CorePFQueryFilter_Boolean
Packflow.CorePFQueryFilter_DateTime
Packflow.CorePFQueryFilter_File
Packflow.CorePFQueryFilter_User
Namespace: Packflow.Core
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax[XmlIncludeAttribute(typeof(PFQueryFilter_Boolean))] [XmlIncludeAttribute(typeof(PFQueryFilter_DateTime))] [XmlIncludeAttribute(typeof(PFQueryFilter_User))] [XmlIncludeAttribute(typeof(DateTimeOffset))] [XmlIncludeAttribute(typeof(PFQueryFilter_File))] [KnownTypeAttribute(typeof(PFQueryFilter_Boolean))] [KnownTypeAttribute(typeof(PFQueryFilter_DateTime))] [KnownTypeAttribute(typeof(PFQueryFilter_User))] [KnownTypeAttribute(typeof(DateTimeOffset))] [KnownTypeAttribute(typeof(PFQueryFilter_File))] [DataContractAttribute] public class PFQueryFilter
The PFQueryFilter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFQueryFilter |
Initializes a new instance of the PFQueryFilter class.
|
| PFQueryFilter(String) | [Special constructor, to be used only knowingly] Creates a filter with an unknown value! Will not work in direct query. For stored procedure system. |
| PFQueryFilter(String, PFQueryFilterOperator) | [Special constructor, to be used only knowingly] Creates a filter with an unknown value! Will not work in direct query. For stored procedure system. |
| PFQueryFilter(String, Object) |
Initializes a new instance of the PFQueryFilter class.
|
| PFQueryFilter(Guid, String, Object) |
Initializes a new instance of the PFQueryFilter class.
|
| PFQueryFilter(String, PFQueryFilterOperator, Object) |
Initializes a new instance of the PFQueryFilter class.
|
| PFQueryFilter(Guid, String, PFQueryFilterOperator, Object) |
Initializes a new instance of the PFQueryFilter class.
|
Properties| Name | Description | |
|---|---|---|
 | Coalesce | Gets or sets a value indicating whether the column value, if null, should be converted for this test. Ex: "SampleColumn!='Test'" becomes "COALESCE(SampleColumn, '')!='Test'" if this is enabled and the chosen coalesce value is an empty string. |
| CoalesceValue | Gets or sets a value to use as an alternative for the column value if it is null. Used only if the property Coalesce is True. Ex: "SampleColumn!='Test'" becomes "COALESCE(SampleColumn, '')!='Test'" if Coalesce is True and the chosen coalesce value is an empty string. |
| FieldName |
Gets or sets the name of the target field/column.
|
| FieldValue |
Gets or sets the value used for comparisons.
|
| FilterOnGroupedValues | Gets or sets a value indicating whether the filter should apply to splitted values after group instead of filtering objects directly. This will only apply -To choice and user multi-values fields. -If the filtered field is also grouped. -If the filtered value is not null. Note : this parameter is NOT serialized because its use is very rare. |
| HasRestriction |
Gets a value indicating whether there are restrictions,
limiting the use of this filter to certain objects. |
| IgnoreAccents |
Gets or sets a value indicating whether this filter should ignore accents or not.
Note : this only applies when the database is currently NOT ignoring accents by default. Attention, this can greatly degrade performances! |
| Operator |
Gets or sets the filter's operator.
|
| RestrictedToParents |
Gets or sets a list of parents' GUIDs.
If not empty, the filter will be applied to a subset of objects, depending on their parent. |
| UnknownValue |
Gets or sets a value indicating whether the filter value is already known.
This is typically used (= set to true) when a query is created to be stored and not executed immediately, e.g. for stored procedures. |
Methods| Name | Description | |
|---|---|---|
 | Create |
Creates a new instance of the PFQueryFilter class.
|
| DisableCoalesce |
Disables coalesce mode for this filter. See Coalesce property for more information.
|
| EnableCoalesce |
Enables coalesce mode for this filter with a given value. See Coalesce property for more information.
|
| ToString |
Creates a display value of this filters.
(Overrides ObjectToString.) |
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