SearchForm Class

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Write as search form to the supplied stream or to the default response stream. The code is included in a FORM element and contains a text box and a submit button. This class should be used to submit data to a page that contains a component such as Search result for categories that can perform the search and display the result. The SearchForm class is the engine of the Search Form AS component.

Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingSearchBase
          ContentStudio.Site.ActiveScripting.SearchSearchForm

Namespace: ContentStudio.Site.ActiveScripting.Search
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public sealed class SearchForm : SearchBase

Public NotInheritable Class SearchForm
	Inherits SearchBase

The SearchForm type exposes the following members.

Properties

	Name	Description
	BackwardsComponentCompatibilityMode	Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false. (Inherited from ActiveScriptingBase.)
	ComponentName	Gets the name of the component (Overrides ActiveScriptingBaseComponentName.)
	Conformance	Gets a value which specifies which type of code a component can generate. (Overrides ActiveScriptingBaseConformance.)
	ElementType	Gets a value which specifies the type of outer element the component generates. (Overrides ActiveScriptingBaseElementType.)
	Encoding	Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark. (Inherited from ActiveScriptingBase.)

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Invoke(String, Int32, Int32, String, String, String, String, String, Boolean)	Invokes the component and writes its content into the default response stream.
	Invoke(Stream, String, Int32, Int32, String, String, String, String, String, Boolean)	Invokes the component and writes its content into the specified stream.
	ToString	(Inherited from Object.)

Top

Remarks

To use this class, create an instance of this object and call the Invoke method with an appropriate set of parameters. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash. This class generates inline code, thus you must wrap it into a block element to make the page validate according to the HTML/XHTML regulations. The generated code can be made fully HTML/XHTML strict compatible. This class is sealed and cannot be inherited from.

Reference

ContentStudio.Site.ActiveScripting.Search Namespace