Click or drag to resize

BaseCursorFilter Class

CursorFilter is a an abstract base class for the various Commence filters you can create. Use CursorFilters.Add to get a derived filter object that exposes properties only applicable to that filtertype. This shields you from having to use the horrible DDE syntax the ViewFilter request takes. You can still set filters the old-fashioned way via CommenceCursor.SetFilter.
Inheritance Hierarchy

Namespace:  Vovin.CmcLibNet.Database
Assembly:  Vovin.CmcLibNet (in Vovin.CmcLibNet.dll) Version: 1.0.7729.42686
Syntax
public abstract class BaseCursorFilter : ICursorFilter

The BaseCursorFilter type exposes the following members.

Properties
  NameDescription
Public propertyClauseNumber
Returns ClauseNumber for use in derived classes. Should be a value between 1 and 8.
Public propertyExcept
Except flag. Set to true to create a Except (NOT) filter.
Public propertyFiltertypeIdentifier
String representing the filtertype identifier for use in a Commence DDE request.
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]].

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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToString(FuncICursorFilter, String)
Overload allowing custom formatting.
Top
See Also