Show / Hide Table of Contents

Class FilterList

A FilterList is a list of Filters. The Project owns a FilterList which is used by the to decide which IGeoObjects may be selected or must be rejected. You may add a handler to the PreFilterEvent event to do your own filtering or use the default filtering machanism (or both). The FilterList of the project is displayed in the ControlCenter and may be interactively manipulated.

Inheritance
System.Object
IShowPropertyImpl
FilterList
Implements
IShowProperty
IPropertyEntry
System.Runtime.Serialization.ISerializable
ICommandHandler
INameChange
System.Runtime.Serialization.IDeserializationCallback
Inherited Members
IShowPropertyImpl.propertyTreeView
IShowPropertyImpl.labelText
IShowPropertyImpl.resourceId
IShowPropertyImpl.flagsToSuppress
IShowPropertyImpl.SuppressFlags(ShowPropertyLabelFlags)
IShowPropertyImpl.Frame
IShowPropertyImpl.IShowProperty.Added(IPropertyTreeView)
IShowPropertyImpl.Added(IPropertyTreeView)
IShowPropertyImpl.Selected()
IShowPropertyImpl.UnSelected()
IShowPropertyImpl.ChildSelected(IShowProperty)
IShowPropertyImpl.Opened(Boolean)
IShowPropertyImpl.Removed(IPropertyTreeView)
IShowPropertyImpl.ShowOpen(Boolean)
IShowPropertyImpl.Select()
IShowPropertyImpl.LabelText
IShowPropertyImpl.InfoText
IShowPropertyImpl.HelpLink
IShowPropertyImpl.OwnerDrawHeight
IShowPropertyImpl.IShowProperty.SetTabIndex(Int32)
IShowPropertyImpl.StateChangedEvent
IShowPropertyImpl.LabelChanged(String)
IShowPropertyImpl.SetFocus()
IShowPropertyImpl.Hidden
IShowPropertyImpl.ReadOnly
IShowPropertyImpl.Refresh()
IShowPropertyImpl.OnEnterPressed()
IShowPropertyImpl.OnVisibilityChanged(Boolean)
IShowPropertyImpl.IsSelected
IShowPropertyImpl.Concat(IShowProperty[], IShowProperty[])
IShowPropertyImpl.Update(IShowProperty)
IShowPropertyImpl.SelectedBckgColor
IShowPropertyImpl.SelectedTextColor
IShowPropertyImpl.UnselectedBckgColor
IShowPropertyImpl.UnselectedTextColor
IShowPropertyImpl.IPropertyEntry.IsOpen
IShowPropertyImpl.HasDropDownButton
IShowPropertyImpl.ValueIsEditable
IShowPropertyImpl.Flags
IShowPropertyImpl.Label
IShowPropertyImpl.Value
IShowPropertyImpl.ResourceId
IShowPropertyImpl.Parent
IShowPropertyImpl.SubItems
IShowPropertyImpl.ButtonClicked(PropertyEntryButton)
IShowPropertyImpl.OpenOrCloseSubEntries()
IShowPropertyImpl.propertyPage
IShowPropertyImpl.GetDropDownList()
IShowPropertyImpl.StartEdit(Boolean)
IShowPropertyImpl.EndEdit(Boolean, Boolean, String)
IShowPropertyImpl.EditTextChanged(String)
IShowPropertyImpl.IPropertyEntry.Index
IShowPropertyImpl.IPropertyEntry.IndentLevel
IShowPropertyImpl.Selected(IPropertyEntry)
IShowPropertyImpl.UnSelected(IPropertyEntry)
IShowPropertyImpl.ListBoxSelected(Int32)
IShowPropertyImpl.DeferUpdate
IShowPropertyImpl.PropertyEntryChangedStateEvent
IShowPropertyImpl.PropertyEntryChangedState(StateChangedArgs)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: CADability.Attribute
Assembly: CADability.dll
Syntax
[Serializable]
public class FilterList : IShowPropertyImpl, IShowProperty, IPropertyEntry, ISerializable, ICommandHandler, INameChange, IDeserializationCallback

Constructors

| Improve this Doc View Source

FilterList()

Constructs a empty FilterList

Declaration
public FilterList()
| Improve this Doc View Source

FilterList(SerializationInfo, StreamingContext)

Constructor required by deserialization

Declaration
protected FilterList(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info

SerializationInfo

System.Runtime.Serialization.StreamingContext context

StreamingContext

Properties

| Improve this Doc View Source

ContextMenu

Declaration
public override MenuWithHandler[] ContextMenu { get; }
Property Value
Type Description
MenuWithHandler[]
Overrides
IShowPropertyImpl.ContextMenu
| Improve this Doc View Source

Count

Returns the number of Filters in this list.

Declaration
public int Count { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

EntryType

Overrides EntryType, returns GroupTitle.

Declaration
public override ShowPropertyEntryType EntryType { get; }
Property Value
Type Description
ShowPropertyEntryType
Overrides
IShowPropertyImpl.EntryType
| Improve this Doc View Source

Item[Int32]

Indexer to access individual Filters by index

Declaration
public Filter this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

index of the required Filter

Property Value
Type Description
Filter

The Filter

| Improve this Doc View Source

LabelType

Overrides LabelType

Declaration
public override ShowPropertyLabelFlags LabelType { get; }
Property Value
Type Description
ShowPropertyLabelFlags
Overrides
IShowPropertyImpl.LabelType
| Improve this Doc View Source

SubEntries

Overrides SubEntries, returns the subentries in this property view.

Declaration
public override IShowProperty[] SubEntries { get; }
Property Value
Type Description
IShowProperty[]
Overrides
IShowPropertyImpl.SubEntries
| Improve this Doc View Source

SubEntriesCount

Overrides SubEntriesCount, returns the number of subentries in this property view.

Declaration
public override int SubEntriesCount { get; }
Property Value
Type Description
System.Int32
Overrides
IShowPropertyImpl.SubEntriesCount

Methods

| Improve this Doc View Source

Accept(IGeoObject)

Use all active filters in this list to check whether an object is accepted or not. If there is a PreFilterEvent the this event will be called.

Declaration
public bool Accept(IGeoObject go)
Parameters
Type Name Description
IGeoObject go

Object to check

Returns
Type Description
System.Boolean

true: accepted, false: rejected

| Improve this Doc View Source

Add(Filter)

Add the provided Filter to the list

Declaration
public void Add(Filter f)
Parameters
Type Name Description
Filter f

Filter to add

| Improve this Doc View Source

Added(IPropertyPage)

Declaration
public override void Added(IPropertyPage pp)
Parameters
Type Name Description
IPropertyPage pp
Overrides
IShowPropertyImpl.Added(IPropertyPage)
| Improve this Doc View Source

AddNewFilter()

Declaration
public Filter AddNewFilter()
Returns
Type Description
Filter
| Improve this Doc View Source

FindFilter(String)

Declaration
public Filter FindFilter(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
Filter
| Improve this Doc View Source

GetObjectData(SerializationInfo, StreamingContext)

Implements System.Runtime.Serialization.ISerializable.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)

Declaration
public void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info

The System.Runtime.Serialization.SerializationInfo to populate with data.

System.Runtime.Serialization.StreamingContext context

The destination (System.Runtime.Serialization.StreamingContext) for this serialization.

| Improve this Doc View Source

MayChangeName(Object, String)

Declaration
public bool MayChangeName(object namedObject, string newName)
Parameters
Type Name Description
System.Object namedObject
System.String newName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NameChanged(Object, String)

Declaration
public void NameChanged(object namedObject, string oldName)
Parameters
Type Name Description
System.Object namedObject
System.String oldName
| Improve this Doc View Source

Remove(Filter)

Remove the provided Filter from the list

Declaration
public void Remove(Filter f)
Parameters
Type Name Description
Filter f

Filter to remove

| Improve this Doc View Source

Removed(IPropertyPage)

Declaration
public override void Removed(IPropertyPage pp)
Parameters
Type Name Description
IPropertyPage pp
Overrides
IShowPropertyImpl.Removed(IPropertyPage)

Events

| Improve this Doc View Source

PreFilterEvent

Event to add custom filter.

Declaration
public event FilterList.PreFilterDelegate PreFilterEvent
Event Type
Type Description
FilterList.PreFilterDelegate

Explicit Interface Implementations

| Improve this Doc View Source

ICommandHandler.OnCommand(String)

Declaration
bool ICommandHandler.OnCommand(string MenuId)
Parameters
Type Name Description
System.String MenuId
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ICommandHandler.OnSelected(MenuWithHandler, Boolean)

Declaration
void ICommandHandler.OnSelected(MenuWithHandler selectedMenuItem, bool selected)
Parameters
Type Name Description
MenuWithHandler selectedMenuItem
System.Boolean selected
| Improve this Doc View Source

ICommandHandler.OnUpdateCommand(String, CommandState)

Declaration
bool ICommandHandler.OnUpdateCommand(string MenuId, CommandState CommandState)
Parameters
Type Name Description
System.String MenuId
CommandState CommandState
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IDeserializationCallback.OnDeserialization(Object)

Declaration
void IDeserializationCallback.OnDeserialization(object sender)
Parameters
Type Name Description
System.Object sender

Implements

IShowProperty
IPropertyEntry
System.Runtime.Serialization.ISerializable
ICommandHandler
INameChange
System.Runtime.Serialization.IDeserializationCallback
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX