ApiFilter Class

This represents an API entry that is to be removed from the reflection information using MRefBuilder's namespace ripping feature.

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0

public class ApiFilter : IComparable<ApiFilter>

Public Class ApiFilter
	Implements IComparable(Of ApiFilter)

public ref class ApiFilter : IComparable<ApiFilter^>

type ApiFilter = 
    class
        interface IComparable<ApiFilter>
    end

Constructor. This takes the API type and the full name.

Children	This returns the child API filter collection for this entry
EntryType	This is used to get or set the API entry type
FilterName	This is used to get the API filter name
FullName	This is used to get the fully qualified name of the API entry
IsExposed	This is used to get or set whether or not the entry is exposed
IsProjectExclude	This is used to get or set whether or not the entry is excluded via the project (i.e. via the SHFB Namespaces option or an <exclude /> tag.

ApiEntryTypeFromLetter	This is used to convert an API type letter to an ApiEntryType enumerated value.
CompareTo	Compares this instance to another instance and returns an indication of their relative values
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 Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
ToString	Returns a string that represents the current object. (Inherited from Object)