ApiFilter Class
Definition
- Namespace
- Sandcastle.Core.Project
- Assembly
- Sandcastle.Core.dll
This represents an API entry that is to be removed from the reflection information using MRefBuilder's namespace ripping feature.
public class ApiFilter : IComparable<ApiFilter>- Inheritance
-
ApiFilter
- Implements
Constructors
| ApiFilter(ApiEntryType, string, bool) |
Constructor. This takes the API type and the full name. |
Properties
| 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 |
Methods
| ApiEntryTypeFromLetter(char) |
This is used to convert an API type letter to an ApiEntryType enumerated value. |
| CompareTo(ApiFilter) |
Compares this instance to another instance and returns an indication of their relative values |