Click or drag to resize

ResourceHandler Class

Version 102.0.100
Default implementation of IResourceHandler. This latest implementation provides some simplification, at a minimum you only need to override ProcessRequestAsync. See the project source on GitHub for working examples. used to implement a custom request handler interface. The methods of this class will always be called on the IO thread. Static helper methods are included like FromStream and FromString that make dealing with fixed resources easy.
Inheritance Hierarchy

Namespace:  CefSharp
Assembly:  CefSharp (in CefSharp.dll) Version: (
public class ResourceHandler : IResourceHandler, 

The ResourceHandler type exposes the following members.

Public methodResourceHandler
Initializes a new instance of the ResourceHandler class.
Public propertyAutoDisposeStream
When true the Stream will be Disposed when this instance is Disposed. The default value for this property is false.
Public propertyCharset
Gets or sets the Charset
Public propertyErrorCode
If the ErrorCode is set then the response will be ignored and the errorCode returned.
Public propertyHeaders
Gets or sets the headers.
Public propertyMimeType
Gets or sets the Mime Type.
Public propertyResponseLength
Gets or sets ResponseLength, when you know the size of your Stream (Response) set this property. This is optional. If you use a MemoryStream and don't provide a value here then it will be cast and its size used
Public propertyStatusCode
Gets or sets the http status code.
Public propertyStatusText
Gets or sets the status text.
Public propertyStream
Gets or sets the resource stream.
Public methodDispose
Dispose of resources here
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberForErrorMessage
Generates a ResourceHandler that has it's StatusCode set
Public methodStatic memberFromByteArray
Creates a IResourceHandler that represents a Byte[], uses CefStreamResourceHandler for reading the data
Public methodStatic memberFromFilePath
Gets the resource from the file path specified. Use the Cef.GetMimeType() helper method to lookup the mimeType if required. Uses CefStreamResourceHandler for reading the data
Public methodStatic memberFromStream
Gets the resource from a stream.
Public methodStatic memberFromString(String, String) Obsolete.
Gets the resource from the string.
Public methodStatic memberFromString(String, Encoding, Boolean, String)
Gets a ResourceHandler that represents a string. Without a Preamble, Cef will use BrowserSettings.DefaultEncoding to load the html.
Public methodStatic memberGetByteArray
Gets a byteArray from the given string using the provided encoding
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodStatic memberGetMemoryStream
Gets a MemoryStream from the given string using the provided encoding
Public methodStatic memberGetMimeType
Gets the MIME type of the content.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodProcessRequestAsync
Begin processing the request. If you have the data in memory you can execute the callback immediately and return true. For Async processing you would typically spawn a Task to perform processing, then return true. When the processing is complete execute callback.Continue(); In your processing Task, simply set the StatusCode, StatusText, MimeType, ResponseLength and Stream
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public fieldStatic memberDefaultMimeType
MimeType to be used if none provided
See Also