HierarchyTreeFilterProvider.HierarchyTreeFilter Class

Base class that implements some of the boilerplate parts of an ISolutionTreeFilter. This includes behavior to ensure newly-added hierarchy items are always visible through the filtered view, even if those items do not match the filter. Derived types must still implement the logic for constructing the set of included items.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.PlatformUI.DisposableObject
    Microsoft.VisualStudio.Shell.HierarchyTreeFilterProvider.HierarchyTreeFilter

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
Protected MustInherit Class HierarchyTreeFilter _
    Inherits DisposableObject _
    Implements ISolutionTreeFilter, IDisposable, ISupportInitializeNotification, ISupportInitialize,  _
    INotifyPropertyChanged

protected abstract class HierarchyTreeFilter : DisposableObject, 
    ISolutionTreeFilter, IDisposable, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged

protected ref class HierarchyTreeFilter abstract : public DisposableObject, 
    ISolutionTreeFilter, IDisposable, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged

[<AbstractClass>]
type HierarchyTreeFilter =  
    class 
        inherit DisposableObject 
        interface ISolutionTreeFilter 
        interface IDisposable 
        interface ISupportInitializeNotification 
        interface ISupportInitialize 
        interface INotifyPropertyChanged 
    end

protected abstract class HierarchyTreeFilter extends DisposableObject implements ISolutionTreeFilter, IDisposable, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged

The HierarchyTreeFilterProvider.HierarchyTreeFilter type exposes the following members.

Constructors

	Name	Description
	HierarchyTreeFilterProvider.HierarchyTreeFilter	Initializes a new instance of the HierarchyTreeFilterProvider.HierarchyTreeFilter class.

Top

Properties

	Name	Description
	CancellationToken	Gets a CancellationToken that will be cancelled when this filter is disposed.
	IncludedItems	Gets the set of items that are included by the filter.
	IsDisposed	Returns whether the object has been disposed once, which protects against double disposal. (Inherited from DisposableObject.)
	IsInitialized	Gets a value indicating whether the component is initialized.

Top

Methods

	Name	Description
	Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DisposableObject.)
	Dispose(Boolean)	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Standard virtual overload for IDisposable pattern. (Inherited from DisposableObject.)
	DisposeManagedResources	Allows derived classes to provide custom dispose handling for managed resources. (Overrides DisposableObject.DisposeManagedResources().)
	DisposeNativeResources	Allows derived classes to provide custom dispose handling for native resources. (Inherited from DisposableObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from DisposableObject.)
	GetFilterDescendantsBehavior	Indicates whether to include descendants if none are explicitly specified.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIncludedItemsAsync
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ThrowIfDisposed	Throws an ObjectDisposedException if this object has been disposed. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Disposing	Raised when the event is being disposed, that is, while it is still accessible. (Inherited from DisposableObject.)
	Initialized	Occurs when initialization of the component is completed.
	PropertyChanged	Occurs when a property value changes.

Top

Explicit Interface Implementations

	Name	Description
	ISupportInitialize.BeginInit	Signals the object that initialization is starting.
	ISupportInitialize.EndInit	Signals the object that initialization is complete.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Shell Namespace