FilterObjManager MembersA Sandcastle Documented Class Library

The FilterObjManager type exposes the following members.
Constructors

  NameDescription
Public methodFilterObjManager(String)
Default constructor.
Public methodFilterObjManager(Int32, Int32, Int32, String)
General construction, expects max filters, max stats, max reports and a user id.
Public methodFilterObjManager(String, String, String, String)
General constructor, takes the maximum filters as a string arguments.
Back to Top
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
Fields

  NameDescription
Private fieldStatic memberDEFAULT_FILTER_MAX
Represents the default maximum number of filters available at one time.
Private fieldStatic memberDEFAULT_REPORT_MAX
Represents the default maximum number of reports available for one filter.
Private fieldStatic memberDEFAULT_STATISTIC_MAX
Represents the default maximum number of statistics available for one filter.
Private fieldfilters
List of FilterObj kept track of by this manager.
Private fieldmaxFilters
Local updated max filters, gets set to either the default or from the Web.Config.
Private fieldmaxReports
Local updated max reports, gets set to either the default or from the Web.Config.
Private fieldmaxStatistics
Local updated max stats, gets set to either the default or from the Web.Config.
Private fielduserId
Owner's user id.
Back to Top
See Also