 | ApiFilter Class |
This represents an API entry that is to be removed from the reflection information using MRefBuilder's
namespace ripping feature.
Inheritance HierarchyNamespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe ApiFilter type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | ApiEntryTypeFromLetter |
This is used to convert an API type letter to an ApiEntryType enumerated value.
|
| Clone |
Clone the API filter
|
| CompareTo |
Compares this instance to another instance and returns an indication of their relative values
|
| Equals | (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 a hash function for a particular type. (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.) |
Properties| Name | Description | |
|---|---|---|
 | 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.
|
See Also