Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

Configuring Filtering (xamTreeGrid)

Topic Overview

Purpose

This topic explains how to configure the filtering feature of the control.

Required background

The following topics are prerequisites to understanding this topic:

Topic Purpose

This topic explains the features supported by the control from developer perspective.

This topic provides an overview of the visual elements of the control.

This topic provides an overview of the filtering feature and summarize the main objects and properties related to the filtering feature

Filtering Summary

Filtering summary

The filtering feature of the xamTreeGrid control filters records against a specified filtering criteria and performs a filter action (for example hiding, disabling or reducing the opacity of records that don’t match the filter criteria). You have the option to specify the filter action performed by the control by choosing a value from the RecordFilterAction enumeration.

Note
Note

When the filter action is set to Hide, if some nested level records match the filter criteria but their ancestor records don’t match the filter criteria then the ancestor records will be displayed with a reduced opacity.

If you set the filter action to Hide (which is also the default value) you can still set the control to show filtered out nested (i.e. descendant) records with a reduced opacity when their parent records are matching the filter criteria by choosing the respective value from the TreeViewFilterResultsDisplayMode enumeration.

Filtering configuration summary

The following table explains briefly the configurable aspects of the xamTreeGrid control’s filtering and maps them to the properties that configure them.

Configurable aspect Details Properties

Action to perform on filtered items

Specify the filter action performed over the records which does not match the filter criteria.

Visibility of filtered out child records

Configure the visibility of child records which does not match the filter criteria of a parent record which match the filtering criteria.

Code example

The following code example shows how to enable record filtering and configure the control to show filtered out nested records of parent which match the filter criteria.

In XAML:

<igDP:XamTreeGrid>
  <igDP:XamTreeGrid.FieldSettings>
    <igDP:FieldSettings AllowRecordFiltering="True" />
  </igDP:XamTreeGrid.FieldSettings>
  <igDP:XamTreeGrid.FieldLayoutSetting>
    <igDP:FieldLayoutSetting FilterAction="Hide" />
  </igDP:XamTreeGrid.FieldLayoutSetting>
  <igDP:XamTreeGrid.ViewSettings>
    <igDP:TreeViewSettings FilterResultDisplayMode="ShowWithAncestorAndDescendants" />
  </igDP:XamTreeGrid.ViewSettings>
</igDP:XamTreeGrid>

Related Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic explains how to configure the control’s tree field.

This topic explains how to configure the expansion indicators' behavior.

This topic explains how to set the indentation used to render the child records.

This topic explains how to configure the selection behavior for child level records.

This topic explains the specifics of the summaries support of the control.