Dynamicweb 8 Documentation
Filter Class Members
Properties  Methods 


The following tables list the members exposed by Filter.

Public Constructors
 NameDescription
Public ConstructorFilter ConstructorInitializes a new instance of an object.  
Top
Public Properties
 NameDescription
Public PropertyContextGets or sets the execution context.  
Public PropertyDefinitionGets the reference to a definition used to create an instance of this filter.  
Public PropertyIsAppliedGets value indicating whether filter is applied according to current request.  
Public PropertyIsVisibleGets value indicating whether filter can be displayed under the current pageview.  
Public PropertyItemsGets the custom storage that is dependent on a current HTTP context.  
Public PropertyNameGets or sets the name of the filter.  
Public PropertyTagNameGets or sets the tagname for the specific filter renderer.  
Public PropertyTemplateGets or sets the virtual path to the template file.  
Top
Protected Properties
 NameDescription
Protected PropertyOptionsGets the reference to utility object that represents an options list filter.  
Top
Public Methods
 NameDescription
Public MethodBulkEstimateResultsOverloaded. Returns an estimated number of search results for each set of matching items.  
Public MethodCompareToComparse one filter to another one.  
Public MethodComposeQueryRetrieves a part of the search query based on the filter properties.  
Public MethodEstimateResultsReturns an estimated number of search results for the current query.  
Public MethodFormatNumberReturns the formatted version of the specified number according to current culture.  
Public MethodGetCssClassOverloaded. Returns a CSS class for this filter.  
Public MethodGetGlobalQueryConstraintRetrieves a query constraint that is globally defined according to current module settings.  
Public MethodGetIdSuitableStringGets the id suitable string. (Inherited from Dynamicweb.Extensibility.ConfigurableAddIn)
Public MethodGetParametersToXMLOverloaded. Gets the parameters to XML. (Inherited from Dynamicweb.Extensibility.ConfigurableAddIn)
Public MethodLoadParametersFromXMLLoads the parameters from XML. (Inherited from Dynamicweb.Extensibility.ConfigurableAddIn)
Public MethodRenderRenders a filter on a frontend.  
Public MethodRenderAdditionalContent (Inherited from Dynamicweb.Extensibility.ConfigurableAddIn)
Public MethodRenderStandardTagsRenders standard filter tags like name or tag name.  
Public MethodRequestOverloaded. Gets the request parameter value (default parameter).  
Public MethodSetupInitializes the filter.  
Public MethodUpdateFromPostUpdates from post back. (Inherited from Dynamicweb.Extensibility.ConfigurableAddIn)
Top
Protected Methods
 NameDescription
Protected MethodMatchesRequestDetermines whether filter's current value (fully or artially) matches the given value.  
Top
See Also

Reference

Filter Class
Dynamicweb.Extensibility.Searching.eCommerce Namespace

Send Feedback