| ResourceHandler Class |
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 HierarchyNamespace: CefSharp
Assembly: CefSharp (in CefSharp.dll) Version: 55.0.0.0 (55.0.0.0)
SyntaxThe ResourceHandler type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ResourceHandler |
Default Constructor
|
Properties| Name | Description | |
|---|---|---|
 | AutoDisposeStream |
When true the Stream will be Disposed when
this instance is Disposed. The default value for
this property is false.
|
| ErrorCode |
If the ErrorCode is set then the response will be ignored and
the errorCode returned.
|
| FilePath |
Path of the underlying file
|
| Headers |
Gets or sets the headers.
|
| MimeType |
Gets or sets the Mime Type.
|
| ResponseLength |
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 it's size used
|
| StatusCode |
Gets or sets the http status code.
|
| StatusText |
Gets or sets the status text.
|
| Stream |
Gets or sets the resource stream.
|
| Type |
Specify which type of resource handle represnets
|
Methods| Name | Description | |
|---|---|---|
| Cancel |
Called if the request is cancelled
|
| Dispose |
Dispose of resources here
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
 | FromFileName | Obsolete.
Gets the resource from the file.
|
| FromFilePath |
Gets the resource from the file path specified. Use the GetMimeType(String)
helper method to lookup the mimeType if required.
|
| FromStream |
Gets the resource from a stream.
|
| FromString(String, String) |
Gets the resource from the string.
|
| FromString(String, Encoding, Boolean, String) |
Gets a ResourceHandler that represents a string.
Without a Preamble, Cef will use BrowserSettings.DefaultEncoding to load the html.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetMimeType |
Gets the MIME type of the content.
|
| GetResponse |
Populate the response stream, response length. When this method is called
the response should be fully populated with data.
It is possible to redirect to another url at this point in time.
NOTE: It's no longer manditory to implement this method, you can simply populate the
properties of this instance and they will be set by the default implementation.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ProcessRequestAsync |
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
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | DefaultMimeType |
MimeType to be used if none provided
|
See Also