FilterObjManager MethodsA Sandcastle Documented Class Library
The FilterObjManager type exposes the following members.
Methods

  NameDescription
Public methodAppend(String)
Appends a filter to the list, directly after the active filter. Excess filters are pruned.
Public methodAppend(FilterObj)
Appends a filter to the list, directly after the active filter. Excess filters are pruned.
Public methodAppendPassive(String)
Appends a filter to the filter object manager in passive mode.
Public methodAppendPassive(FilterObj)
Appends a filter to the filter object manager in passive mode.
Public methodCloseActiveFilter
Closes the current active filters.
Public methodCloseAllFilters
Close all open filters.
Public methodCloseFilterAtIdx
Close the filter at the given index.
Public methodGetActiveFilterObj
Returns the active filter object, the first filter.
Public methodGetFilterAtIndex
Returns a filter from the given index.
Public methodGetFilterCount
Returns the current count of loaded filters.
Public methodGetFilterWithId
Returns the filter object of the filter with the given id.
Public methodGetFilterWithName
Returns the filter object of the filter with the given id.
Public methodGetIndexOfFilterWithId
Returns the index of the filter with the given id.
Public methodGetMaxFilters
Returns the current maximum of filters.
Public methodGetMaxReports
Returns the maximum number of reports.
Public methodGetMaxStatistics
Returns the maximum number of statistics.
Public methodHasFilterAtIndex
Has a filter at the given index.
Public methodMakeFilterActive(Int32)
Activates the filter at the given index.
Public methodMakeFilterActive(String)
Makes a filter with the given filterId the active filter.
Public methodReloadFilterWithId
Reloads a filter with the given id.
Public methodReloadFilterWithName
Reloads a filter with the given id.
Back to Top
See Also