Click or drag to resize

CursorFilterTypeF Class

Represents a filter of type 'Field' (F).
Inheritance Hierarchy

Namespace:  Vovin.CmcLibNet.Database
Assembly:  Vovin.CmcLibNet (in Vovin.CmcLibNet.dll) Version: 1.0.7729.42686
Syntax
Copy
public sealed class CursorFilterTypeF : BaseCursorFilter, 
	ICursorFilterTypeF, ICursorFilter

The CursorFilterTypeF type exposes the following members.

Constructors
  NameDescription
Public methodCursorFilterTypeF
constructor.
Top
Properties
  NameDescription
Public propertyClauseNumber
Returns ClauseNumber for use in derived classes. Should be a value between 1 and 8.
(Inherited from BaseCursorFilter.)
Public propertyExcept
Except flag. Set to true to create a Except (NOT) filter.
(Inherited from BaseCursorFilter.)
Public propertyFieldName
Field to evaluate.
Public propertyFieldValue
Fieldvalue to evaluate. Ignored when Between qualifier is used.
Public propertyFilterBetweenEndValue
End value (inclusive) for filters with Between qualifier. Used only with Between qualifier. When this property is set, you must also set FilterStartEndValue.
Public propertyFilterBetweenStartValue
Start value (inclusive) for filters with Between qualifier. Used only with Between qualifier. When this property is set, you must also set FilterBetweenEndValue.
Public propertyFiltertypeIdentifier
String representing the filtertype identifier for use in a Commence DDE request.
(Overrides BaseCursorFilterFiltertypeIdentifier.)
Public propertyMatchCase
Case-sensitive parameter. Set to true for case-sensitive filter. Defaults to false.
Public propertyOrFilter
Defines AND/OR filter logic. Set to true to make filter an OR filter. Defaults to 'AND'.

The relationship applies to the next filter you set (just like in the Commence UI) so do not set to true unless you define an additional filter, otherwise your will get all items.

Keep in mind the special grouping Commence uses for filters: [[1 and/or2] and/or [3 and/or 4]] and/or [[5 and/or 6] and/or [7 and/or 8]].

(Inherited from BaseCursorFilter.)
Public propertyQualifier
Convenience property for the qualifier for in .NET applications. This property takes precedence over QualifierString.
Public propertyQualifierString
String value specifying how to evaluate the filtervalue. Not all qualifiers can be used on all field-types. See Commence ViewFilter documentation in DDE helpfile.

If you use COM, either use this member with the strings listed below, or supply the FilterQualifier enum value to Qualifier. .NET users are strongly encouraged to use Qualifier.

List of valid qualifier strings and the fields they can be applied to.

Qualifier stringApplies to fieldtype(s)
Equal ToName, Calculation, E-mail, URL, Number, Selection, Sequence, Telephone, Text fields.
Not Equal ToName, Calculation, E-mail, URL, Number, Selection, Sequence, Telephone, Text fields.
Less ThanCalculation, Number, Sequence number fields.
Greater ThanCalculation, Number, Sequence number fields.
BetweenName, Calculation, Date, E-mail, URL, Number, Sequence number, Time fields.
TrueCheckbox fields.
FalseCheckbox fields.
CheckedCheckbox fields.
Not CheckedCheckbox fields.
YesCheckbox fields.
NoCheckbox fields.
BeforeDate, Time fields.
OnDate fields.
AtTime fields.
AfterDate, Time fields.
ContainsName, E-mail, URL, Telephone, Text fields.
Doesn't ContainName, E-mail, URL, Telephone, Text fields.
SharedN/A when used with fields.
LocalN/A when used with fields.
1Checkbox fields.
0Checkbox fields.
Public propertyShared
Filter for Local/Shared items.
Public propertySharedOptionSet
Keep track of whether the 'shared/local' option was set
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViewFilterString
Convenience method mainly for COM Interop; returns ViewFilter string as you would use it in DDE syntax.
(Inherited from BaseCursorFilter.)
Public methodToString
Creates the filter string.
(Overrides ObjectToString.)
Public methodToString(FuncICursorFilter, String)
Overload allowing custom formatting.
(Inherited from BaseCursorFilter.)
Top
See Also