Class TextFilter

Filter for text fields.

Inheritance
System.Object
Filter
TextFilter
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 TextFilter : Filter, ICustomFieldFilter, IFilter, ICloneable

Constructors

TextFilter(Boolean)

Intended to allow creation of a filter for empty text.

Declaration
public TextFilter(bool empty_)
Parameters
Type Name Description
System.Boolean empty_

True if the filter should limit to empty text.

TextFilter(String, Boolean)

Intended to allow creation of a filter to search for or exactly match a string of text.

Declaration
public TextFilter(string searchText_, bool exactMatch_)
Parameters
Type Name Description
System.String searchText_

Text to filter on.
System.Boolean exactMatch_

True if the filter should look for an exact match of the given text.

Properties

Empty

True if the filter should match only empty values. False if the filter should make use of the search text.

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

ExactMatch

The search text should be matched exactly. (Ignored when filtering on an empty value.)

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

FilterType

Identifies the filter type.

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

SearchText

The text to search for. (Ignored when filtering on an empty value.)

Declaration
public string SearchText { get; set; }
Property Value
Type Description
System.String

Methods

BuildDescription(String)

Builds a description of the filter.

Declaration
public string BuildDescription(string fieldName_)
Parameters
Type Name Description
System.String fieldName_

Name of the field to use in the description of the filter.
Returns
Type Description
System.String

A description of the filter

Clone()

Creates a copy of the filter.

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

A copy of the filter.
Overrides

Implements

System.ICloneable