Intersoft ClientUI Documentation
FilterDescriptors Property
See Also  Send Feedback
Intersoft.Client.Data.ComponentModel Namespace > QueryDescriptor Class : FilterDescriptors Property






Syntax

Visual Basic (Declaration) 
Public Property FilterDescriptors As CompositeFilterDescriptorCollection
Visual Basic (Usage)Copy Code
Dim instance As QueryDescriptor
Dim value As CompositeFilterDescriptorCollection
 
instance.FilterDescriptors = value
 
value = instance.FilterDescriptors
C# 
public CompositeFilterDescriptorCollection FilterDescriptors {get; set;}
Delphi 
public read-write property FilterDescriptors: CompositeFilterDescriptorCollection; 
JScript 
public function get,set FilterDescriptors : CompositeFilterDescriptorCollection
Managed Extensions for C++ 
public: __property CompositeFilterDescriptorCollection* get_FilterDescriptors();
public: __property void set_FilterDescriptors( 
   CompositeFilterDescriptorCollection* value
);
C++/CLI 
public:
property CompositeFilterDescriptorCollection^ FilterDescriptors {
   CompositeFilterDescriptorCollection^ get();
   void set (    CompositeFilterDescriptorCollection^ value);
}

Example

The following example shows how to instantiate a QueryDescriptor programmatically and demonstrate the use of FilterDescriptors, SortDescriptors and PageDescriptors in the QueryDescriptor object.

CS Copy Code
QueryDescriptor queryDescriptor = new QueryDescriptor();

// filtering
// get records that have
// (UnitPrice >= 0 AND UnitPrice < 50) OR (UnitPrice == 0)
CompositeFilterDescriptorCollection groupFilter1 = new CompositeFilterDescriptorCollection();

groupFilter1.LogicalOperator = FilterCompositionLogicalOperator.And;
groupFilter1.Add(
    new FilterDescriptor()
    {
        PropertyName = "UnitPrice",
        Operator = FilterOperator.IsGreaterThanOrEqualTo, Value = 0
    }
);
groupFilter1.Add(
    new FilterDescriptor()
    {
        PropertyName = "UnitPrice",
        Operator = FilterOperator.IsLessThan, Value = 50
    }
);

CompositeFilterDescriptorCollection groupFilter2 = new CompositeFilterDescriptorCollection();

groupFilter2.LogicalOperator = FilterCompositionLogicalOperator.And;
groupFilter2.Add(
    new FilterDescriptor()
    {
        PropertyName = "UnitsInStock",
        Operator = FilterOperator.IsEqualTo, Value = 0
    }
);

queryDescriptor.FilterDescriptors.LogicalOperator = FilterCompositionLogicalOperator.Or;

queryDescriptor.FilterDescriptors.Add(groupFilter1);
queryDescriptor.FilterDescriptors.Add(groupFilter2);

// paging
// get the record 6 - 10
queryDescriptor.PageDescriptor.PageSize = 5;
queryDescriptor.PageDescriptor.PageIndex = 1;

// sorting
// sort by category ascending then by product id descending
queryDescriptor.SortDescriptors.Add(
    new SortDescriptor()
    {
        PropertyName = "CategoryID",
        Direction = System.ComponentModel.ListSortDirection.Ascending
    }
);
queryDescriptor.SortDescriptors.Add(
    new SortDescriptor()
    {
        PropertyName = "ProductID",
        Direction = System.ComponentModel.ListSortDirection.Descending
    }
);    

Remarks

FilterDescriptors is a property that contains a collection of FilterDescriptor that hold filtering information.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2012 All Rights Reserved.