WebHandlerBase Class Content Studio 5.7 SDK
Content Studio Web Content Management System

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

This abstract (MustInherit in Visual Basic) class acts as the base class of a Content Studio web API:s.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteWebHandlerBase
    ContentStudio.Site.HttpHandlersDelegateHttpRequest
    ContentStudio.Site.HttpHandlersGetHTMLData
    ContentStudio.Site.HttpHandlersGetXMLData

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

public abstract class WebHandlerBase : IHttpHandler, 
	IUserSessionObject

The WebHandlerBase type exposes the following members.

Constructors

  NameDescription
Protected methodWebHandlerBase
Initializes a new instance of the WebHandlerBase class
Top
Properties

  NameDescription
Protected propertyApplication
Gets the current HTTP application state.
Public propertyCS_ConnectionId
Gets a value that uniquely identifies the current web site.
Public propertyCS_InsertedCategoryId
Gets a value containing the categoryid of the current document
Public propertyCS_InsertedDocumentId
Gets the document id for the current document, in a presentation template this is the presentated document.
Public propertyCS_IsInAdmin
Gets a value that indicates whether the current user is logged on to Content Studio admin site or not.
Public propertyCS_IsInPreView
Gets a value that tells if the current page is in preview mode
Public propertyCS_IsInWebView
Gets a value that indicates whether the current user is logged on to content studio admin and the content is displayd in web view.
Public propertyCS_PreviewDate
Gets a value that is used in the web-view to preview documents on another date. This value will be DateTime.MinValue if preview is not used.
Public propertyCS_QueryStringPrefix
Gets a value that defines the page identifier part of a query string. This value is also true for the id part of the ptid querystring member.
Public propertyCS_RootDocumentId
Gets a value that contains the root document id retrieved from a querystring.
Public propertyCS_RootPresentationTemplateId
Gets the root presentation template id retrieved from a querystring.
Public propertyCS_RootRefId
Gets the root referer document id retrieved from a querystring.
Public propertyCS_UserSessionId
Gets value that identifies the caller's session.
Public propertyCS_XHTML
Gets a value that tells if the current page is written in XHTML
Public propertyCS_XHTML_TRAIL
Gets a value that is a slash ("/") if the page uses X, otherwise it is an empty string.
Public propertyCS_XHTMLStrict
Gets a value that tells if the current page is written in XHTML 1.0 Strict Or XHTML 1.1.
Public propertyIsReusable
Used for webhandlers
Protected propertyRequest
Gets the current HTTP request.
Protected propertyResponse
Gets the current HTTP response.
Protected propertyServer
Gets the current HTTP server utility.
Protected propertySession
Gets the current HTTP Session.
Protected propertyUser
Gets the current HTTP response.
Top
Methods

  NameDescription
Public methodBuildQueryString(String)
Returns a query string from a Request.QueryString with an '&' (ampersand) at the end.
Public methodBuildQueryString(NameValueCollection, String)
Returns a query string from a collection with an '&' (ampersand) at the end.
Public methodBuildQueryString(NameValueCollection, String, String)
Returns a query string from a collection with an '&' (ampersand) at the end.
Public methodCS_FixJavaString
Returns a string where the escape character sequences is adjusted to be used with Javascript.
Public methodStatic memberCS_ReplaceRelativeUrls
Returns a string where all occurrences of relative URL's in a string containing HTML is replaced with absolute URL's.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetCookie(String)
Gets an http cookie
Public methodGetCookie(String, String)
Gets an http cookie
Public methodGetCredentialCache
Returns the a System.Net.CredentialCache object used when making HTTPrequests.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodGetWebRequest(String, String)
Returns a WebReques containing the response to the request to a Uniform Resource Identifier (URI). All cookies and credentials are stored in session variables.
Public methodGetWebRequest(String, String, String, String, Boolean, String)
Returns a WebRequest containing the response to the request to a Uniform Resource Identifier (URI).
Public methodGetWebResponse(String, String)
Returns a WebResponse containing the response to the request to a Uniform Resource Identifier (URI). All cookies and credentials are stored in session variables.
Public methodGetWebResponse(String, String, String, String, Boolean, String)
Returns a WebResponse containing the response to the request to a Uniform Resource Identifier (URI).
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodNotifyInitedPage
Indicate that the page is initialized
Protected methodPage_Load
Setting up some standard for all web-api:s
Public methodProcessRequest
Setting up some standard features for all web-api. This runs onload. The method handles connection id cookies.
Public methodSetCookie(String, String)
Sets an http cookie
Public methodSetCookie(String, String, DateTime)
Sets an http cookie
Public methodSetCookie(String, String, String)
Sets an http cookie
Public methodSetCookie(String, String, String, DateTime)
Sets an http cookie
Public methodToString (Inherited from Object.)
Top
See Also

Reference