This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code
                                  public abstract class CmsRequest
Visual Basic (Declaration) Copy imageCopy Code
                                  Public MustInherit Class CmsRequest

The type exposes the following members.

Protected Constructors

  Name Description
Protected method CmsRequest
Initializes a new instance of the CmsRequest class.

Public Methods

  Name Description
Public method BinaryRead
Performs a binary read of a specified number of bytes from the current input stream.
Public method Equals (Inherited from Object.)
Public method GetBinaryBody
Returns the body of the request as a byte array
Public method GetBody
Returns the body of the request as a string
Public method GetData
Gets an element in the data collection added to the current request.
In a Web environment, this will be the posted form data.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method IsPostback
Gets a value indicating whether the request is a postback from the same page.
Public method IsPosted
Determines whether this request is posted.
Public method LoadPersistedPost
Loads the persisted post data into the form if available.
Public method PersistPost
Persists the post data for later retrieval.
Public method ResetMapping
Remaps the request to a new location.
Public method SetBinaryBody
Sets the binary body.
Public method SetRequestBody
Sets the request body.
Public method ToString
Returns a String that represents the current Object.
(Overrides Object..::ToString()()()().)
Public method Transfer
Transfers rendering to the specified item or local application.

Protected Methods

  Name Description
Protected method Finalize (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method SetRestoreState

Protected Fields

  Name Description
Protected field contentEncoding
Encoding of the request content
Protected field getPersistedPost
Flag to set in order to retrieve persisted post data.
Protected field requestContentType
Body MIME Type

Public Properties

  Name Description
Public property AnonymousID
Gets or sets the anonymous identifier for the user.
Public property Channel
Returns a reference to the Channel
Public property Client
Gets or sets the user agent / client.
Public property Commands
Gets or sets the request commands.
Public property ContentType
Gets the MIME type of the request body.
Public property Data
Data added to the request
Public property Encoding
Returns the encoding used by the request
Public property Engine
Returns the RenderEngine the request is associated with.
Public property Files
Gets the files associated with the request
Public property Instance
Returns a reference to the root object in the current context
Public property IsAimRequest
Gets a value indicating whether this instance is an AIM request.
Public property IsInternal
Gets or sets the internal rendering mode.
Public property IsJson
Gets a value indicating whether this request is a json request.
Public property IsVirtualCmsFile
Gets a value indicating whether this request is done by the Smartsite Virtual Path Provider.
Public property JsonObject
Returns the Json object represented by the request body if the request MIME type is application/json
Public property Locale
Gets the channel Locale instance for the current render channel.
Public property Location
Gets the Locator address of the request.
Public property MetaData
Meta data added to the request
Public property Method
Method name of the request. In HTTP requests, usually GET or POST.
Public property RawUrl
Gets the raw URL of the request.
Public property RestoreState
Gets a value indicating whether form data was restored from persisted state.
Public property State
Gets a key/value collection that can be used to organize and share data during a Cms request.
Public property TotalBytes
Gets the number of bytes in the current input stream.
Public property UserProfile
Gets or sets security information for the current HTTP request.

Explicit Interface Implementations

  Name Description
Explicit interface implemetation Private method IRenderDeviceContext..::..SetChannel
Sets the channel.
Explicit interface implemetation Private method IRenderDeviceContext..::..SetItem
Sets the item.

See Also

Advanced