Class ListOfValuesFilter

List of values filter for values tracked as integers.

Inheritance
System.Object
ListOfValuesFilter
Implements
System.ICloneable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Moraware.JobTrackerAPI5
Assembly: JobTrackerAPI5.dll
Syntax
public class ListOfValuesFilter : ICustomFieldFilter, IFilter, ICloneable

Constructors

ListOfValuesFilter()

Creates a filter with no values assigned.

Declaration
public ListOfValuesFilter()

ListOfValuesFilter(Boolean, ListOfValuesFilterValues)

Creates a new list of values filter, specifying the items in the list (excluding the 'none' option) and whether or not the filter should invert the listed items.

Declaration
public ListOfValuesFilter(bool invert_, ListOfValuesFilterValues values_)
Parameters
Type Name Description
System.Boolean invert_

When using this filter, filter for the inversion of the specified list. (i.e. Filter for values NOT in the given list.)
ListOfValuesFilterValues values_

The values to filter on.

ListOfValuesFilter(Boolean, IEnumerable<Int32>, Boolean)

Creates a new list of values filter, specifying the items in the list and whether or not the filter should invert the listed items and if those items should include the 'none' option.

Declaration
public ListOfValuesFilter(bool invert_, IEnumerable<int> values_, bool includeNoneInValues_)
Parameters
Type Name Description
System.Boolean invert_

When using this filter, filter for the inversion of the specified list. (i.e. Filter for values NOT in the given list.)
System.Collections.Generic.IEnumerable<System.Int32> values_

The values to filter on.
System.Boolean includeNoneInValues_

True if the list of values to filter on should include 'None'.

Properties

FilterType

Identifies the filter type.

Declaration
public CustomFieldFilterType_Enum FilterType { get; }
Property Value
Type Description
CustomFieldFilterType_Enum

Invert

True if the associated list should be inverted when filtering (i.e. Filter for values NOT in the given list.)

Declaration
public bool Invert { get; set; }
Property Value
Type Description
System.Boolean

Values

The set of values to filter on.

Declaration
public ListOfValuesFilterValues Values { get; }
Property Value
Type Description
ListOfValuesFilterValues

Methods

BuildDescription(String, Dictionary<Int32, String>)

Builds a description of the filter.

Declaration
public string BuildDescription(string fieldName_, Dictionary<int, string> lovValues_)
Parameters
Type Name Description
System.String fieldName_

Name to use for the field in the filter description.
System.Collections.Generic.Dictionary<System.Int32, System.String> lovValues_

Map of available field values.
Returns
Type Description
System.String

A description of the filter

Clone()

Creates a copy of this ListOfValuesFilter.

Declaration
public object Clone()
Returns
Type Description
System.Object

A copy of this object.

Implements

System.ICloneable