Click or drag to resize

CefCustomScheme Class

Version 103.0.120
Used in conjunction with CefSettings.RegisterScheme to register a scheme. You can register your own custom scheme e.g. custom:// if you are using a build in scheme (http/https) then you should directly register your ISchemeHandlerFactory using Cef.GetGlobalRequestContext().RegisterSchemeHandlerFactory - make sure the Global RequestContext has been initialized before doing so, you can use OnContextInitialized for notification of RequestContext initialization (Pass an IBrowserProcessHandler instance to Cef.Initialize)
Inheritance Hierarchy
SystemObject
  CefSharpCefCustomScheme

Namespace:  CefSharp
Assembly:  CefSharp (in CefSharp.dll) Version: 103.0.120.0 (103.0.120.0)
Syntax
public sealed class CefCustomScheme

The CefCustomScheme type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyDomainName
Optional Domain Name. An empty value for a standard scheme will cause the factory to match all domain names. The |domain_name| value will be ignored for non-standard schemes.
Public propertyIsCorsEnabled
If true the scheme can be sent CORS requests. This value should be true in most cases where IsStandard is true.
Public propertyIsCSPBypassing
If true the scheme can bypass Content-Security-Policy(CSP) checks. This value should be false in most cases where IsStandard is true.
Public propertyIsDisplayIsolated
If true the scheme will be treated as display-isolated. This means that pages cannot display these URLs unless they are from the same scheme. For example, pages in another origin cannot create iframes or hyperlinks to URLs with this scheme.
Public propertyIsFetchEnabled
If true the scheme can perform Fetch API requests.
Public propertyIsLocal
If true the scheme will be treated as local (i.e. with the same security rules as those applied to "file" URLs). Normal pages cannot link to or access local URLs. Also, by default, local URLs can only perform XMLHttpRequest calls to the same URL (origin + path) that originated the request. To allow XMLHttpRequest calls from a local URL to other URLs with the same origin set the CefSettings.file_access_from_file_urls_allowed value to true. To allow XMLHttpRequest calls from a local URL to all origins set the CefSettings.universal_access_from_file_urls_allowed value to true.
Public propertyIsSecure
If true the scheme will be treated with the same security rules as those applied to "https" URLs. For example, loading this scheme from other secure schemes will not trigger mixed content warnings.
Public propertyIsStandard
If true the scheme will be treated as a standard scheme. Standard schemes are subject to URL canonicalization and parsing rules as defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available at http://www.ietf.org/rfc/rfc1738.txt In particular, the syntax for standard scheme URLs must be of the form:
              [scheme]://[username]:[password]@[host]:[port]/[url-path]
             
Standard scheme URLs must have a host component that is a fully qualified domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of RFC 1123. These URLs will be canonicalized to "scheme://host/path" in the simplest case and "scheme://username:password@host:port/path" in the most explicit case. For example, "scheme:host/path" and "scheme:///host/path" will both be canonicalized to "scheme://host/path". The origin of a standard scheme URL is the combination of scheme, host and port (i.e., "scheme://host:port" in the most explicit case). For non-standard scheme URLs only the "scheme:" component is parsed and canonicalized. The remainder of the URL will be passed to the handler as-is. For example, "scheme:///some%20text" will remain the same. Non-standard scheme URLs cannot be used as a target for form submission.
Public propertyOptions
Gets the underlying scheme options that represents
Public propertySchemeHandlerFactory
Factory Class that creates IResourceHandler instances for handling scheme requests. Leave this null if you wish to manually register the scheme handler with the relevant RequestContext.
Public propertySchemeName
Schema Name e.g. custom
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberParseCommandLineArguments
Method used internally
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also