Click or drag to resize
Chromium.Remote.Event Namespace

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

 
Classes
  ClassDescription
Public classCfrDomVisitorVisitEventArgs
Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.
Public classCfrFlushEventArgs
Flush the stream.
Public classCfrGetByIndexEventArgs
Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.
Public classCfrGetByNameEventArgs
Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.
Public classCfrGetDataResourceEventArgs
Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.
Public classCfrGetDataResourceForScaleEventArgs
Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.
Public classCfrGetLoadHandlerEventArgs
Return the handler for browser load status events.
Public classCfrGetLocalizedStringEventArgs
Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.
Public classCfrGetRenderProcessHandlerEventArgs
Return the handler for functionality specific to the render process. This function is called on the render process main thread.
Public classCfrGetResourceBundleHandlerEventArgs
Return the handler for resource bundle events. If CfrSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.
Public classCfrMayBlockEventArgs
Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.
Public classCfrOnBeforeCommandLineProcessingEventArgs
Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfrCommandLine object passed to this function. The CfrSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfrSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.
Public classCfrOnBeforeNavigationEventArgs
Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.
Public classCfrOnBrowserCreatedEventArgs
Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.
Public classCfrOnBrowserDestroyedEventArgs
Called before a browser is destroyed.
Public classCfrOnContextCreatedEventArgs
Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfrV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfrV8Context.GetTaskRunner() function.
Public classCfrOnContextReleasedEventArgs
Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.
Public classCfrOnFocusedNodeChangedEventArgs
Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.
Public classCfrOnLoadEndEventArgs
Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will always be called for all frames irrespective of whether the request completes successfully. For notification of overall browser load status use OnLoadingStateChange instead.
Public classCfrOnLoadErrorEventArgs
Called when the resource load for a navigation fails or is canceled. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.
Public classCfrOnLoadingStateChangeEventArgs
Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.
Public classCfrOnLoadStartEventArgs
Called when the browser begins loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will always be called for all frames irrespective of whether the request completes successfully. For notification of overall browser load status use OnLoadingStateChange instead.
Public classCfrOnProcessMessageReceivedEventArgs
Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.
Public classCfrOnRegisterCustomSchemesEventArgs
Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.
Public classCfrOnRenderThreadCreatedEventArgs
Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfrBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.
Public classCfrOnUncaughtExceptionEventArgs
Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfrSettings.UncaughtExceptionStackSize > 0.
Public classCfrReadEventArgs
Read raw binary data.
Public classCfrReadHandlerEofEventArgs
Return non-zero if at end of file.
Public classCfrSeekEventArgs
Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.
Public classCfrSetByIndexEventArgs
Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.
Public classCfrSetByNameEventArgs
Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.
Public classCfrStringVisitorVisitEventArgs
Method that will be executed.
Public classCfrTellEventArgs
Return the current offset position.
Public classCfrV8AccessorGetEventArgs
Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.
Public classCfrV8AccessorSetEventArgs
Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.
Public classCfrV8HandlerExecuteEventArgs
Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.
Public classCfrWriteEventArgs
Write raw binary data.
Delegates
  DelegateDescription
Public delegateCfrDomVisitorVisitEventHandler
Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.
Public delegateCfrFlushEventHandler
Flush the stream.
Public delegateCfrGetByIndexEventHandler
Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.
Public delegateCfrGetByNameEventHandler
Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.
Public delegateCfrGetDataResourceEventHandler
Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.
Public delegateCfrGetDataResourceForScaleEventHandler
Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.
Public delegateCfrGetLoadHandlerEventHandler
Return the handler for browser load status events.
Public delegateCfrGetLocalizedStringEventHandler
Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.
Public delegateCfrGetRenderProcessHandlerEventHandler
Return the handler for functionality specific to the render process. This function is called on the render process main thread.
Public delegateCfrGetResourceBundleHandlerEventHandler
Return the handler for resource bundle events. If CfrSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.
Public delegateCfrMayBlockEventHandler
Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.
Public delegateCfrOnBeforeCommandLineProcessingEventHandler
Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfrCommandLine object passed to this function. The CfrSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfrSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.
Public delegateCfrOnBeforeNavigationEventHandler
Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.
Public delegateCfrOnBrowserCreatedEventHandler
Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.
Public delegateCfrOnBrowserDestroyedEventHandler
Called before a browser is destroyed.
Public delegateCfrOnContextCreatedEventHandler
Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfrV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfrV8Context.GetTaskRunner() function.
Public delegateCfrOnContextReleasedEventHandler
Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.
Public delegateCfrOnFocusedNodeChangedEventHandler
Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.
Public delegateCfrOnLoadEndEventHandler
Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will always be called for all frames irrespective of whether the request completes successfully. For notification of overall browser load status use OnLoadingStateChange instead.
Public delegateCfrOnLoadErrorEventHandler
Called when the resource load for a navigation fails or is canceled. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.
Public delegateCfrOnLoadingStateChangeEventHandler
Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.
Public delegateCfrOnLoadStartEventHandler
Called when the browser begins loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will always be called for all frames irrespective of whether the request completes successfully. For notification of overall browser load status use OnLoadingStateChange instead.
Public delegateCfrOnProcessMessageReceivedEventHandler
Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.
Public delegateCfrOnRegisterCustomSchemesEventHandler
Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.
Public delegateCfrOnRenderThreadCreatedEventHandler
Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfrBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.
Public delegateCfrOnUncaughtExceptionEventHandler
Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfrSettings.UncaughtExceptionStackSize > 0.
Public delegateCfrReadEventHandler
Read raw binary data.
Public delegateCfrReadHandlerEofEventHandler
Return non-zero if at end of file.
Public delegateCfrSeekEventHandler
Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.
Public delegateCfrSetByIndexEventHandler
Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.
Public delegateCfrSetByNameEventHandler
Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.
Public delegateCfrStringVisitorVisitEventHandler
Method that will be executed.
Public delegateCfrTellEventHandler
Return the current offset position.
Public delegateCfrV8AccessorGetEventHandler
Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.
Public delegateCfrV8AccessorSetEventHandler
Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.
Public delegateCfrV8HandlerExecuteEventHandler
Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.
Public delegateCfrWriteEventHandler
Write raw binary data.