Click or drag to resize
SearchContext Class
Search context.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerSearchContext
    CMS.BaseAbstractDataContainerSearchContext
      CMS.BaseAbstractHierarchicalObjectSearchContext
        CMS.BaseContextContainerSearchContext
          CMS.BaseAbstractContextSearchContext
            CMS.SearchSearchContext

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 11.0.0
Syntax
C#
public class SearchContext : AbstractContext<SearchContext>

The SearchContext type exposes the following members.

Constructors
  NameDescription
Public methodSearchContext
Top
Properties
  NameDescription
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyStatic memberCurrentParameters
Current search parameters
Public propertyStatic memberCurrentSearchDocuments
Current search documents
Public propertyStatic memberCurrentSearchResults
Current search results
Public propertyStatic memberHighlightRegex
Gets the regular expression specified for highlighting.
Public propertyStatic memberHighlights
Specifies the list of highlighted words
Public propertyIsDefault
Returns true if the context is the default request context
(Inherited from ContextContainerTParent.)
Public propertyItem
Gets the value of particular property
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyKey
Unique container key
(Inherited from ContextContainerTParent.)
Public propertyStatic memberLastError
Gets the last search error.
Public propertyStatic memberMoreCultures
Gets the value that indicates whether current search is performed for all cultures or combine current culture with default.
Public propertyProperties
Properties available through the context.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyPropertyList
Used property list
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredProperties
Registered properties
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRegisteredPropertiesObject
Registered properties object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalProperties
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.)
Top
Methods
  NameDescription
Public methodClearCurrent
Clears the current context value
(Inherited from ContextContainerTParent.)
Public methodCloneForNewThread
Clones the object for new thread
(Overrides AbstractContextTContextCloneForNewThread.)
Public methodCombineWith
Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection).
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodEnsureCurrent (Inherited from ContextContainerTParent.)
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodStatic memberGetSearchValue
Returns column value for current search result item.
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodHasSetter
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object, FuncTObject, Object, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumns
Registers the Columns of this object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterProperties
Registers the properties of this object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodRegisterProperty(String, FuncTObject, Object)
Registers the given property to the object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodRegisterProperty(String, Object, FuncTObject, Object, Object)
Registers the given parameterized property to the object.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodSetAsCurrent
Sets the current instance as the current thread item
(Inherited from ContextContainerTParent.)
Public methodSetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodTryGetProperty(String, Object)
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Top
See Also