|
DotNetBrowser
1.11
|
Represents Chromium engine instance that you can use in BrowserView to display web pages, load web pages, listen to the browser events such as 'title change', 'frame start loading', 'frame finish loading', 'render gone' etc. Each Browser instance is running in a separate native process and communicates with the .NET process via Inter-Process-Communication bridge. When you don't need to use Browser instance you must dispose it using its IDisposable.Dispose method. If you dispose browser instance, you will not be able to use it anymore. To create a new Browser instance use BrowserFactory.Create() method. More...
Inherits IDisposable.
Public Member Functions | |
| DOMDocument | GetDocument () |
| Returns HTML document of the main frame of the currently loaded web page or null if the web page is not loaded or not available (e.g. PDF document is loaded). More... | |
| DOMDocument | GetDocument (long frameId) |
| Returns HTML document of the specified frame on the currently loaded web page or null if the web page is not loaded or not available (e.g. PDF document is loaded). More... | |
| DOMNodeAtPoint | NodeAtPoint (int x, int y) |
| Returns information about HTML Node at the location specified by the x and y parameters at the coordinate space of the loaded web page. Returns null if there's no Node at the passed location on the loaded web page. More... | |
| DOMNodeAtPoint | NodeAtPoint (Point point) |
| Returns information about HTML Node at the location specified by the point parameter at the coordinate space of the loaded web page. Returns null if there's no Node at the passed location on the loaded web page. More... | |
| void | LoadURL (string url) |
| Navigates to a resource identified by a URL. More... | |
| void | LoadURL (LoadURLParams parameters) |
| Navigates to a resource identified by a LoadURLParams.Url More... | |
| void | LoadHTML (string html) |
| Updates content of the browser instance with the html string. The currently loaded web page will be unloaded and new HTML content will be displayed. This operation is alternative for: loadHTML(new LoadHTMLParams("html...", "text/html", "UTF-8", null, false)); More... | |
| void | LoadHTML (long frameId, string html) |
| Loads the given html content into the specified frame of the currently loaded document. The web frame will be unloaded and new HTML content will be displayed. This operation is alternative for: LoadHTML(frameId, new LoadHTMLParams("html...", "UTF-8", null)); More... | |
| void | LoadHTML (LoadHTMLParams parameters) |
| Loads the given LoadHTMLParams.HTML content into the main frame of the currently loaded document. The currently loaded web page will be unloaded and new HTML content will be displayed. More... | |
| void | LoadHTML (long frameId, LoadHTMLParams parameters) |
| Loads the given LoadHTMLParams.HTML content into the specified frame of the currently loaded document. The web frame with frameId will be unloaded and new HTML content will be displayed in it. More... | |
| string | GetHTML () |
| Returns HTML of the currently loaded web page or empty string if the web page is still loading and its HTML is not available yet. The result string is built dynamically from the current state of the DOM. If some JavaScript code on this web page modified its DOM, this method always returns the latest representation of the DOM. More... | |
| string | GetHTML (long frameId) |
| Returns HTML of a specified web frame on the currently loaded web page. More... | |
| void | LoadData (LoadDataParams parameters) |
| Loads the given LoadDataParams.Data string with specified mime type and optional text encoding into the main frame on the currently loaded document. More... | |
| void | LoadData (long frameId, LoadDataParams parameters) |
| Loads the given LoadDataParams.Data string with specified mime type and optional text encoding into the specified frame on the currently loaded document. More... | |
| void | ExecuteJavaScript (string javaScript) |
| Executes javaScript in the context of the current page. This method is executed asynchronously, so when this method finish its execution there's no guaranty that passed script also has finished its execution. More... | |
| void | ExecuteJavaScript (long frameId, string javaScript) |
| Executes javaScript in the context of the web frame identified by frameId. This method is executed asynchronously, so when this method finish its execution there's no guaranty that passed script also has finished its execution. More... | |
| JSValue | ExecuteJavaScriptAndReturnValue (string javaScript) |
| Executes javaScript in the context of the current page and returns the result of JavaScript execution as JSValue object. This method blocks the current thread execution and waits until passed javaScript finishes its execution. This method never returns null. If JavaScript return value is null, then this method returns a valid JSValue object. To make sure that it's null you can use JSValue.IsNull() method. More... | |
| JSValue | ExecuteJavaScriptAndReturnValue (long frameId, string javaScript) |
| Executes javaScript in the context of the web frame identified by frameId and returns the result of JavaScript execution as JSValue object. This method blocks the current thread execution and waits until passed javaScript finishes its execution. This method never returns null. If JavaScript return value is null, then this method returns a valid JSValue object. To make sure that it's null you can use JSValue.IsNull() method. More... | |
| void | RegisterFunction (string functionName, BrowserFunction function) |
| Registers an instance of BrowserFunction instance and maps it with corresponding JavaScript function with the functionName, so that every time when JavaScript invokes the functionName, the corresponding function will be invoked. More... | |
| void | UnregisterFunction (string functionName) |
| Remove the registered BrowserFunction instance associated with the functionName from the list of registered JavaScript functions. When the function is unregistered, JavaScript cannot invoke it anymore and every attempt to access it will cause JavaScript error. If function is already unregistered, this method does nothing. More... | |
| void | Stop () |
| Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations. More... | |
| void | GoBack () |
| Navigates browser back or does nothing if it cannot navigate back. CanGoBack() More... | |
| bool | CanGoBack () |
| Indicates whether browser can navigate back. More... | |
| void | GoForward () |
| Navigates browser forward or does nothing if it cannot navigate forward. CanGoForward() More... | |
| bool | CanGoForward () |
| Indicates whether browser can navigate forward. More... | |
| void | Reload () |
| Reloads the currently loaded web page. More... | |
| void | Reload (bool checkForRepost) |
| Reloads the currently loaded web page. More... | |
| void | ReloadIgnoringCache () |
| Reloads the currently loaded web page ignoring caches. More... | |
| void | SaveWebPage (string filePath, string resourcesPath, SavePageType saveType) |
| Saves the current web page as a file or set of files. Page must be loaded completely. Use the FinishLoadingFrame to make sure that web page is loaded completely. More... | |
| bool | IsDisposed () |
| Returns true when the current browser instance is disposed. More... | |
| void | ZoomIn () |
| Updates zoom level for the currently loaded web page on one step up. More... | |
| void | ZoomOut () |
| Updates zoom level for the currently loaded web page on one step down. More... | |
| void | ZoomReset () |
| Resents zoom level for the currently loaded web page to default value. More... | |
| void | Print () |
| Prints currently loaded web page. It does nothing if the web page is still being loaded. If you invoke this method while previous printing hasn't been finished/canceled yet, it will cancel previous printing. You should wait until previous printing is finished before calling this method again. More... | |
| void | Print (long frameId) |
| Prints frame with the given frameId on the currently loaded web page. It does nothing if the web page is still being loaded. More... | |
| void | KeyDown (KeyParams parameters) |
| Forward key down event to the current browser instance. More... | |
| void | KeyUp (KeyParams parameters) |
| Forward key up event to the current browser instance. More... | |
| List< long > | GetFramesIds () |
| Returns a list of child frames IDs of the currently loaded document. Each frame on the loaded document has corresponding unique frame ID that can be used to work with this frame to get its document, execute JavaScript code on this frame, etc. More... | |
| List< long > | GetFramesIds (long frameId) |
| Returns a list of child frames IDs for specified parent frame. Each frame on the loaded document has corresponding unique frame ID that can be used to work with this frame to get its document, execute JavaScript code on this frame, etc. More... | |
| string | GetRemoteDebuggingURL () |
| SearchResult | FindText (SearchParams parameters) |
| Finds specified text, highlights all matches and selects the first match on the currently loaded web page. Browser performs search only through visible content on the loaded document. If some text is presented on the web page, but due to CSS rules it's not visible, Browser will not check this content during search. Also Browser will not find text on the document with size 0x0, so make sure that Browser component is visible and its size isn't empty. More... | |
| void | StopFindingText (StopFindAction action) |
| Stops finding text and resets found matches highlighting. More... | |
| string | GetSelectedText () |
| Returns selected text in the currently focused frame or empty string if there is no selection. More... | |
| string | GetSelectedText (long frameId) |
| Returns selected text for the frame, specified by frameId or empty string if there is no selection. More... | |
| string | GetSelectedHTML () |
| Returns selected HTML in the currently focused frame or empty string if there is no selection. More... | |
| string | GetSelectedHTML (long frameId) |
| Returns selected HTML for the frame, specified by frameId or empty string if there is no selection. More... | |
| void | SetSize (int width, int height) |
| Updates size of the current Browser's view. By default Browser's view is empty, so if you load some document it will not be loaded at all because there's no sense in loading and rendering web document when view is empty. More... | |
| void | SetBounds (int x, int y, int width, int height) |
| Updates bounds of the current Browser's view. By default Browser's view is empty, so if you load some document it will not be loaded at all because there's no sense in loading and rendering web document when view is empty. More... | |
| JSContext | GetJavaScriptContext () |
| Returns JavaScript context of the main frame on the currently loaded web page. Returns null if no main frame is available or JavaScript context doesn't exist for main frame (e.g. the web page doesn't contain any JavaScript code at all). More... | |
| JSContext | GetJavaScriptContext (long frameId) |
| Returns JavaScript context of a specified frameId on the currently loaded web page. Returns null if there's no frame with the frameId or JavaScript context isn't available for this frame. More... | |
| void | ReplaceMisspelledWord (string word) |
| Replaces misspelled word under cursor on the currently loaded web page with the given word. If there's no misspelled word under cursor, this method does nothing. More... | |
| bool | AddWordToSpellCheckerDictionary (string word) |
| Adds a new word to current user's spellchecker dictionary and returns boolean value that indicates whether word has been added to the dictionary successfully or not. More... | |
| bool | IsCommandEnabled (EditorCommand command) |
| Returns true if the command can be executed in the currently focused frame on the loaded web page. Most of the commands are always disabled for unfocused frames. There's no sense in checking whether command is enabled for unfocused frame. Use this method only to check whether a specified command can be used in the currently focused frame. More... | |
| bool | ExecuteCommand (EditorCommand command) |
| Executes the command in the currently focused frame on the loaded web page. You can find out when command requires value by calling EditorCommand.IsValueRequired() method. More... | |
| bool | ExecuteCommand (long frameId, EditorCommand command) |
| Executes the command in the frame, specified by frameId. You can find out when command requires value by calling EditorCommand.IsValueRequired() method. More... | |
| bool | ExecuteCommand (EditorCommand command, string value) |
| Executes the command with command value in the focused frame on the loaded web page. You can find out when command requires value by calling EditorCommand.IsValueRequired() method. More... | |
| bool | ExecuteCommand (long frameId, EditorCommand command, string value) |
| Executes the command with command value in the frame specified by frameId. To find out whether command requires a value you can use the EditorCommand.IsValueRequired() method. More... | |
| IWebStorage | GetLocalWebStorage () |
| Returns Local Web Storage associated with main frame. More... | |
| IWebStorage | GetLocalWebStorage (long frameId) |
| Returns Local Web Storage associated with specified frame or null. More... | |
| IWebStorage | GetSessionWebStorage () |
| Returns Session Web Storage associated with main frame. More... | |
| IWebStorage | GetSessionWebStorage (long frameId) |
| Returns Session Web Storage associated with specified frame or null. More... | |
| DOMEvent | CreateEvent (string eventType) |
| Return custom DOM event. More... | |
| DOMEvent | CreateEvent (string eventType, bool bubbles, bool cancelable) |
| Return custom DOM event. More... | |
Properties | |
| IImageProvider | ImageProvider [get] |
| Gets IImageProvider that allows to get rendered image. More... | |
| BrowserContext | Context [get] |
| Gets BrowserContext associated with this browser instance. More... | |
| PopupHandler | PopupHandler [get, set] |
| Popup windows handler. More... | |
| DialogHandler | DialogHandler [get, set] |
| Dialogs handler. More... | |
| LoadHandler | LoadHandler [get, set] |
| Load handler that will be invoked every time when Browser loads a web page. It can be used to cancel some URL loading. More... | |
| NativeCrashHandler | NativeCrashHandler [get, set] |
| Chromium native process crash handler. More... | |
| PluginManager | PluginManager [get] |
| Plugin manager that provides info about all available plugins and allows enabling/disabling them. More... | |
| CacheStorage | CacheStorage [get] |
| Provides access to the cache storage associated with this Browser instance. The cache storage saves all cache files in the Browser's user data directory. If you need to configure each Browser to use unique cache storage which is not accessible for other Browser instances, you need to provide unique user data directory for each Browser instance. More... | |
| IAppCacheStorage | AppCacheStorage [get] |
| Provides access to the application cache storage associated with this Browser instance. The cache storage saves all application cache files in the Browser's user data directory. If you need to configure each Browser to use unique application cache storage which is not accessible for other Browser instances, you need to provide unique user data directory for each Browser instance. More... | |
| CookieStorage | CookieStorage [get] |
| Provides access to the cookie storage. By default all Browser instances can access persistent cookies of each other. Since each Browser instance is running in a separate native process the session cookies are not shared between such Browser instances. The cookie storage saves all the cookies in the Browser's user data directory. If you need to configure each Browser to use unique cookie storage which is not accessible for other Browser instances, you need to provide unique user data directory for each Browser instance. The data directory path can be provided via BrowserContext.BrowserContext(BrowserContextParams) object that must be passed to the BrowserFactory.Create(BrowserContext) factory method. More... | |
| ContextMenuHandler | ContextMenuHandler [get, set] |
| Gets or sets the handler for the context menu requests that will be invoked every time the user clicks the right mouse button. More... | |
| DownloadHandler | DownloadHandler [get, set] |
| Gets or sets the file download handler that will be invoked every time the Browser downloads a file. By default this method returns null, so all file downloads are suppressed. More... | |
| IPermissionHandler | PermissionHandler [get, set] |
| Gets or sets permission handler that will be invoked every time the engine asks about permission for different functionality such as geolocation, desktop. notifications, etc. By default, this method returns null which indicates that all permission requests will be denied. More... | |
| string | URL [get] |
| URL of the currently loaded web page. More... | |
| string | Title [get] |
| A string that represents a title of the currently loaded web page. More... | |
| BrowserPreferences | Preferences [get, set] |
| Browser's preferences. More... | |
| PasswordManagerClient | PasswordManagerClient [get, set] |
| bool | Loading [get] |
| Returns true when browser is loading resource. More... | |
| double | ZoomLevel [get, set] |
| Gets or sets zoom level for the currently loaded web page. Zoom level is configured for each domain separately. For example, if you load the www.a.com web page and set zoom level to 2.5, then load the www.b.org web page, the zoom level for www.b.org web page will be reset to default value. When you load the www.a.com web page again, its zoom level will be restored to 2.5 automatically. More... | |
| BrowserType | BrowserType [get] |
| Return current rendering type for browser More... | |
| PrintHandler | PrintHandler [get, set] |
| Gets or sets the file download handlerthat will be invoked every time when printing requests for print settings. By default this method returns null. When it is More... | |
| FullScreenHandler | FullScreenHandler [get, set] |
| Gets or sets a new full screen handler to receive notifications when HTML element on the web page goes into a full screen mode. More... | |
| MediaStreamDeviceManager | MediaStreamDeviceManager [get] |
| Gets the media device manager of the current Browser instance. Provides access to media device manager of the current Browser instance. More... | |
| bool | AudioMuted [get, set] |
| Gets or sets mutes all audio output for this Browser instance. True when audio output must be muted, false otherwise. More... | |
| bool | AudioPlaying [get] |
| Gets true when the audio is currently playing on the loaded web page. More... | |
| IBackForwardNavigator | BackForwardNavigator [get] |
| Returns back-forward navigation controller instance. More... | |
| bool | ZoomEnabled [get, set] |
| Gets or sets zoom changes enabled. By default, zoom functionality is enabled. You can change zoom level for the currently loaded web page. More... | |
| bool | IsSandboxEnabled [get] |
| Returns true if sandbox enabled for render process. Should be used only for testing purposes. More... | |
| RenderProcessInfo | RenderProcessInfo [get] |
| Gets information about Chromium render process associated with the current Browser instance. When Chromium loads a new web page, it creates a new render process where DOM and JavaScript are running. This render process can be terminated by Chromium engine when a new web page with different domain is loaded. So, this method can return different render process information. More... | |
| string | CustomStylesheet [get, set] |
| Gets or sets stylesheet which will be applied to any loaded document. The CustomStylesheet CSS properties don't override the intersected properties on the loaded webpage. More... | |
Events | |
| FinishLoadingFrameHandler | FinishLoadingFrameEvent |
| An event that indicates that frame loading process has been finished. More... | |
| StartLoadingFrameHandler | StartLoadingFrameEvent |
| An event that indicates that frame loading process has been started. More... | |
| FailLoadingFrameHandler | FailLoadingFrameEvent |
| An event that indicates that frame loading process has been failed. More... | |
| ProvisionalLoadingFrameHandler | ProvisionalLoadingFrameEvent |
| An event that indicates that provisional load for a specified frame was successfully committed. More... | |
| DocumentLoadedInFrameHandler | DocumentLoadedInFrameEvent |
| An event that indicates that frame with a document is loaded. More... | |
| DocumentLoadedInMainFrameHandler | DocumentLoadedInMainFrameEvent |
| An event that indicates that main frame with a document is loaded. More... | |
| RenderCreatedHandler | RenderCreatedEvent |
| An event that indicates that the render process is created. More... | |
| RenderCreatedHandler | RenderGoneEvent |
| An event that indicates that the render process is gone. More... | |
| RenderCreatedHandler | RenderResponsiveEvent |
| An event that indicates that the render process is no longer hung. More... | |
| RenderCreatedHandler | RenderUnresponsiveEvent |
| An event that indicates that the render process is hung. More... | |
| StatusEventHandler | StatusChangedEvent |
| An event that indicates that the status has been changed. More... | |
| TitleChangedHandler | TitleChangedEvent |
| An event that indicates that the title of a document in main frame has been changed. More... | |
| ConsoleMessageHandler | ConsoleMessageEvent |
| An event that indicates that the message was added to the console. More... | |
| DragDropHandler | DragEnterEvent |
| An event that indicates that the object is dragged into the browser's bounds. More... | |
| DragDropHandler | DragExitEvent |
| An event that indicates that the object is dragged out of the browser's bounds. More... | |
| DragDropHandler | DropEvent |
| An event that indicates when a drag-and-drop operation is completed. More... | |
| HandledGestureEventHandler | HandleGestureEvent |
| An event that indicates that user has made a gesture interaction GestureType with device SourceDevice. Provides an ability to discard performed interaction. More... | |
| GestureEventHandler | GestureEvent |
| An event that indicates that user has made a gesture interaction GestureType with device SourceDevice. More... | |
| DisposeEventHandler | DisposeEvent |
| An event that indicates that browser instance disposed. More... | |
| ScriptContextCreatedHandler | ScriptContextCreated |
| An event that indicates that JavaScript context has been created. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance. More... | |
| ScriptContextDestroyedHandler | ScriptContextDestroyed |
| An event that indicates that JavaScript context has been destroyed. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance. More... | |
Represents Chromium engine instance that you can use in BrowserView to display web pages, load web pages, listen to the browser events such as 'title change', 'frame start loading', 'frame finish loading', 'render gone' etc. Each Browser instance is running in a separate native process and communicates with the .NET process via Inter-Process-Communication bridge. When you don't need to use Browser instance you must dispose it using its IDisposable.Dispose method. If you dispose browser instance, you will not be able to use it anymore. To create a new Browser instance use BrowserFactory.Create() method.
| bool DotNetBrowser.Browser.AddWordToSpellCheckerDictionary | ( | string | word | ) |
Adds a new word to current user's spellchecker dictionary and returns boolean value that indicates whether word has been added to the dictionary successfully or not.
| word | a string that represents word to add. Cannot be null or empty string. |
| ArgumentException | when word is null or empty string. |
| bool DotNetBrowser.Browser.CanGoBack | ( | ) |
Indicates whether browser can navigate back.
| bool DotNetBrowser.Browser.CanGoForward | ( | ) |
Indicates whether browser can navigate forward.
| DOMEvent DotNetBrowser.Browser.CreateEvent | ( | string | eventType | ) |
| DOMEvent DotNetBrowser.Browser.CreateEvent | ( | string | eventType, |
| bool | bubbles, | ||
| bool | cancelable | ||
| ) |
| bool DotNetBrowser.Browser.ExecuteCommand | ( | EditorCommand | command | ) |
Executes the command in the currently focused frame on the loaded web page. You can find out when command requires value by calling EditorCommand.IsValueRequired() method.
| command | the command to execute. |
| bool DotNetBrowser.Browser.ExecuteCommand | ( | long | frameId, |
| EditorCommand | command | ||
| ) |
Executes the command in the frame, specified by frameId. You can find out when command requires value by calling EditorCommand.IsValueRequired() method.
| frameId | id of the frame, in which the command will be executed. |
| command | command the command to execute. |
| ArgumentException | when frameId is invalid GetFramesIds(). |
| bool DotNetBrowser.Browser.ExecuteCommand | ( | EditorCommand | command, |
| string | value | ||
| ) |
Executes the command with command value in the focused frame on the loaded web page. You can find out when command requires value by calling EditorCommand.IsValueRequired() method.
| command | the command to execute. |
| value | a string that represents command value. |
| bool DotNetBrowser.Browser.ExecuteCommand | ( | long | frameId, |
| EditorCommand | command, | ||
| string | value | ||
| ) |
Executes the command with command value in the frame specified by frameId. To find out whether command requires a value you can use the EditorCommand.IsValueRequired() method.
| frameId | id of the frame, in which the command will be executed. |
| command | the command to execute. |
| value | a string that represents command value. |
| ArgumentException | when frameId is invalid GetFramesIds(). |
| void DotNetBrowser.Browser.ExecuteJavaScript | ( | string | javaScript | ) |
Executes javaScript in the context of the current page. This method is executed asynchronously, so when this method finish its execution there's no guaranty that passed script also has finished its execution.
If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| javaScript | a string that represents JavaScript code to be executed. |
| ArgumentException | when javaScript is null. |
| void DotNetBrowser.Browser.ExecuteJavaScript | ( | long | frameId, |
| string | javaScript | ||
| ) |
Executes javaScript in the context of the web frame identified by frameId. This method is executed asynchronously, so when this method finish its execution there's no guaranty that passed script also has finished its execution.
If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| javaScript | a string that represents JavaScript code to be executed. |
| ArgumentException | when javaScript is null. |
| JSValue DotNetBrowser.Browser.ExecuteJavaScriptAndReturnValue | ( | string | javaScript | ) |
Executes javaScript in the context of the current page and returns the result of JavaScript execution as JSValue object. This method blocks the current thread execution and waits until passed javaScript finishes its execution. This method never returns null. If JavaScript return value is null, then this method returns a valid JSValue object. To make sure that it's null you can use JSValue.IsNull() method.
If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| javaScript | a string that represents JavaScript code to be executed. |
| ArgumentException | when javaScript is null. |
| JSValue DotNetBrowser.Browser.ExecuteJavaScriptAndReturnValue | ( | long | frameId, |
| string | javaScript | ||
| ) |
Executes javaScript in the context of the web frame identified by frameId and returns the result of JavaScript execution as JSValue object. This method blocks the current thread execution and waits until passed javaScript finishes its execution. This method never returns null. If JavaScript return value is null, then this method returns a valid JSValue object. To make sure that it's null you can use JSValue.IsNull() method.
If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| javaScript | a string that represents JavaScript code to be executed. |
| ArgumentException | when javaScript is null. |
| SearchResult DotNetBrowser.Browser.FindText | ( | SearchParams | parameters | ) |
Finds specified text, highlights all matches and selects the first match on the currently loaded web page. Browser performs search only through visible content on the loaded document. If some text is presented on the web page, but due to CSS rules it's not visible, Browser will not check this content during search. Also Browser will not find text on the document with size 0x0, so make sure that Browser component is visible and its size isn't empty.
| parameters | search parameters, such as text to search, case-sensitive, search direction. |
| ArgumentException | when parameters null |
| DOMDocument DotNetBrowser.Browser.GetDocument | ( | ) |
Returns HTML document of the main frame of the currently loaded web page or null if the web page is not loaded or not available (e.g. PDF document is loaded).
| DOMDocument DotNetBrowser.Browser.GetDocument | ( | long | frameId | ) |
Returns HTML document of the specified frame on the currently loaded web page or null if the web page is not loaded or not available (e.g. PDF document is loaded).
| frameId | unique identifier of a web frame on the currently loaded web page. |
| ArgumentException | when frameId is invalid. |
| List<long> DotNetBrowser.Browser.GetFramesIds | ( | ) |
Returns a list of child frames IDs of the currently loaded document. Each frame on the loaded document has corresponding unique frame ID that can be used to work with this frame to get its document, execute JavaScript code on this frame, etc.
You must call this method only when the entire document of a specified URL you navigate to is loaded completely. If you call this method when the document is still loading, you may receive only already loaded frames IDs. Each document has at least one frame (main frame).
| List<long> DotNetBrowser.Browser.GetFramesIds | ( | long | frameId | ) |
Returns a list of child frames IDs for specified parent frame. Each frame on the loaded document has corresponding unique frame ID that can be used to work with this frame to get its document, execute JavaScript code on this frame, etc.
You must call this method only when the entire document of a specified URL you navigate to is loaded completely. If you call this method when the document is still loading, you may receive only already loaded frames IDs. Each document has at least one frame (main frame).
| frameId | the parent frame id |
| string DotNetBrowser.Browser.GetHTML | ( | ) |
Returns HTML of the currently loaded web page or empty string if the web page is still loading and its HTML is not available yet. The result string is built dynamically from the current state of the DOM. If some JavaScript code on this web page modified its DOM, this method always returns the latest representation of the DOM.
| string DotNetBrowser.Browser.GetHTML | ( | long | frameId | ) |
Returns HTML of a specified web frame on the currently loaded web page.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| JSContext DotNetBrowser.Browser.GetJavaScriptContext | ( | ) |
Returns JavaScript context of the main frame on the currently loaded web page. Returns null if no main frame is available or JavaScript context doesn't exist for main frame (e.g. the web page doesn't contain any JavaScript code at all).
JavaScript context is created automatically when JavaScript code is executed on the web page. If frame doesn't have JavaScript code, then method returns null. To force JavaScript context creation on the web page without JavaScript, you can call the ExecuteJavaScriptAndReturnValue(String) method.
| JSContext DotNetBrowser.Browser.GetJavaScriptContext | ( | long | frameId | ) |
Returns JavaScript context of a specified frameId on the currently loaded web page. Returns null if there's no frame with the frameId or JavaScript context isn't available for this frame.
JavaScript context is created automatically when JavaScript code is executed on the web page. If frame doesn't have JavaScript code, then method returns null. To force JavaScript context creation on the web page without JavaScript, you can call the ExecuteJavaScriptAndReturnValue(String) method.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| IWebStorage DotNetBrowser.Browser.GetLocalWebStorage | ( | ) |
Returns Local Web Storage associated with main frame.
| IWebStorage DotNetBrowser.Browser.GetLocalWebStorage | ( | long | frameId | ) |
Returns Local Web Storage associated with specified frame or null.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| ArgumentException | when frameId is invalid. GetFramesIds(long) |
| string DotNetBrowser.Browser.GetRemoteDebuggingURL | ( | ) |
Returns a string that represents URL of the Chrome Developers Tools web page, that allows you to debug the loaded web page in the current Browser instance. When you load this URL in another Browser instance or Google Chrome application you will see standard Chrome Developer Tools page where you can inspect web page HTML, debug JavaScript etc. To use this remote debugging feature you must specify the –remote-debugging-port=[port] Chromium switch by calling BrowserPreferences.SetChromiumSwitches(string[]) method before creating any Browser instance.
do not load this URL in other web browser applications such as Mozilla FireFox, IE, etc. This may cause native crash in Chrome Developers Tools server. It's recommended that you access the URL from Google Chrome 31+ or another JxBrowser Browser instance.
| string DotNetBrowser.Browser.GetSelectedHTML | ( | ) |
Returns selected HTML in the currently focused frame or empty string if there is no selection.
| string DotNetBrowser.Browser.GetSelectedHTML | ( | long | frameId | ) |
Returns selected HTML for the frame, specified by frameId or empty string if there is no selection.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| string DotNetBrowser.Browser.GetSelectedText | ( | ) |
Returns selected text in the currently focused frame or empty string if there is no selection.
| string DotNetBrowser.Browser.GetSelectedText | ( | long | frameId | ) |
Returns selected text for the frame, specified by frameId or empty string if there is no selection.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| IWebStorage DotNetBrowser.Browser.GetSessionWebStorage | ( | ) |
Returns Session Web Storage associated with main frame.
| IWebStorage DotNetBrowser.Browser.GetSessionWebStorage | ( | long | frameId | ) |
Returns Session Web Storage associated with specified frame or null.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| ArgumentException | when frameId is invalid. GetFramesIds(long) |
| void DotNetBrowser.Browser.GoBack | ( | ) |
Navigates browser back or does nothing if it cannot navigate back. CanGoBack()
| void DotNetBrowser.Browser.GoForward | ( | ) |
Navigates browser forward or does nothing if it cannot navigate forward. CanGoForward()
| bool DotNetBrowser.Browser.IsCommandEnabled | ( | EditorCommand | command | ) |
Returns true if the command can be executed in the currently focused frame on the loaded web page. Most of the commands are always disabled for unfocused frames. There's no sense in checking whether command is enabled for unfocused frame. Use this method only to check whether a specified command can be used in the currently focused frame.
| command | the command to check. |
| bool DotNetBrowser.Browser.IsDisposed | ( | ) |
Returns true when the current browser instance is disposed.
| void DotNetBrowser.Browser.KeyDown | ( | KeyParams | parameters | ) |
Forward key down event to the current browser instance.
| parameters | contains parameters such as key value, unicode character and modifiers. |
| void DotNetBrowser.Browser.KeyUp | ( | KeyParams | parameters | ) |
Forward key up event to the current browser instance.
| parameters | contains parameters such as key value, unicode character and modifiers. |
| void DotNetBrowser.Browser.LoadData | ( | LoadDataParams | parameters | ) |
Loads the given LoadDataParams.Data string with specified mime type and optional text encoding into the main frame on the currently loaded document.
This method is asynchronous. If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| parameters | contains parameters such as data string, mime type, text encoding and base URL. The parameter cannot be null. |
| ArgumentException | when parameters is null |
| void DotNetBrowser.Browser.LoadData | ( | long | frameId, |
| LoadDataParams | parameters | ||
| ) |
Loads the given LoadDataParams.Data string with specified mime type and optional text encoding into the specified frame on the currently loaded document.
This method is asynchronous. If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| parameters | contains parameters such as data string, mime type, text encoding and base URL. The parameter cannot be null. |
| ArgumentException | when parameters is null |
| void DotNetBrowser.Browser.LoadHTML | ( | string | html | ) |
Updates content of the browser instance with the html string. The currently loaded web page will be unloaded and new HTML content will be displayed. This operation is alternative for: loadHTML(new LoadHTMLParams("html...", "text/html", "UTF-8", null, false));
This method is asynchronous. If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| html | contains parameters such as HTML, Encoding, BaseURL etc. The parameter cannot be null |
| ArgumentException | when html is null |
| void DotNetBrowser.Browser.LoadHTML | ( | long | frameId, |
| string | html | ||
| ) |
Loads the given html content into the specified frame of the currently loaded document. The web frame will be unloaded and new HTML content will be displayed. This operation is alternative for: LoadHTML(frameId, new LoadHTMLParams("html...", "UTF-8", null));
This method is asynchronous. If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| html | contains parameters such as HTML, Encoding, BaseURL etc. The parameter cannot be null. |
| ArgumentException | when html is null |
| void DotNetBrowser.Browser.LoadHTML | ( | LoadHTMLParams | parameters | ) |
Loads the given LoadHTMLParams.HTML content into the main frame of the currently loaded document. The currently loaded web page will be unloaded and new HTML content will be displayed.
This method is asynchronous. If Browser instance doesn't have a document, this method does nothing.
| parameters | contains parameters such as HTML, Encoding, BaseURL etc. The parameter cannot be null. |
| ArgumentException | when parameters is null |
| void DotNetBrowser.Browser.LoadHTML | ( | long | frameId, |
| LoadHTMLParams | parameters | ||
| ) |
Loads the given LoadHTMLParams.HTML content into the specified frame of the currently loaded document. The web frame with frameId will be unloaded and new HTML content will be displayed in it.
This method is asynchronous. If Browser instance doesn't have a text/html document (e.g. the PDF document is loaded), this method does nothing.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| parameters | contains parameters such as HTML, Encoding, BaseURL etc. The parameter cannot be null. |
| ArgumentException | when parameters is null |
| void DotNetBrowser.Browser.LoadURL | ( | string | url | ) |
Navigates to a resource identified by a URL.
This method is invoked asynchronously. To make sure that the web page is loaded completely, use the FinishLoadingFrame event.
remarks>
| url | the URL of the resource to display. The parameter cannot be null |
| void DotNetBrowser.Browser.LoadURL | ( | LoadURLParams | parameters | ) |
Navigates to a resource identified by a LoadURLParams.Url
This method is invoked asynchronously. To make sure that the web page is loaded completely, use the FinishLoadingFrame event.
| parameters | contains parameters such as URL and POST data. The parameter cannot be null |
| DOMNodeAtPoint DotNetBrowser.Browser.NodeAtPoint | ( | int | x, |
| int | y | ||
| ) |
Returns information about HTML Node at the location specified by the x and y parameters at the coordinate space of the loaded web page. Returns null if there's no Node at the passed location on the loaded web page.
| x | the x-coordinate of the location. |
| y | the y-coordinate of the location. |
| DOMNodeAtPoint DotNetBrowser.Browser.NodeAtPoint | ( | Point | point | ) |
Returns information about HTML Node at the location specified by the point parameter at the coordinate space of the loaded web page. Returns null if there's no Node at the passed location on the loaded web page.
| point | the point defining the top-left corner of the location, given in the coordinate space of the loaded web page. |
| ArgumentException | when point parameter is null. |
| void DotNetBrowser.Browser.Print | ( | ) |
Prints currently loaded web page. It does nothing if the web page is still being loaded. If you invoke this method while previous printing hasn't been finished/canceled yet, it will cancel previous printing. You should wait until previous printing is finished before calling this method again.
| void DotNetBrowser.Browser.Print | ( | long | frameId | ) |
Prints frame with the given frameId on the currently loaded web page. It does nothing if the web page is still being loaded.
If you invoke this method while previous printing hasn't been finished/canceled yet, it will cancel previous printing. You should wait until previous printing is finished before calling this method again.
| frameId | unique identifier of a web frame on the currently loaded web page. |
| ArgumentException | when frameId is invalid. |
| void DotNetBrowser.Browser.RegisterFunction | ( | string | functionName, |
| BrowserFunction | function | ||
| ) |
Registers an instance of BrowserFunction instance and maps it with corresponding JavaScript function with the functionName, so that every time when JavaScript invokes the functionName, the corresponding function will be invoked.
The list of registered functions is checked every time when browser loads a web page or frame. If you load web page and only then register JavaScript function, the web page will not see it until you reload it.
If you register the "MyFunction" JavaScript function via this method and this function already exists on the loaded web page, then the body of the JavaScript function on the loaded web page will be invoked. The registerFunction method doesn't allow overriding existing JavaScript functions.
| functionName | the name of JavaScript function that will be mapped to the BrowserFunction instance. |
| function | an instance of BrowserFunction that will be invoked every time when JavaScript invokes the functionName. |
| void DotNetBrowser.Browser.Reload | ( | ) |
Reloads the currently loaded web page.
| void DotNetBrowser.Browser.Reload | ( | bool | checkForRepost | ) |
Reloads the currently loaded web page.
If checkForRepost is true and the current web page has POST data the user it prompted to see if they really want to reload the page.
| checkForRepost | if true and the current web page has POST data the user is prompted to see if they really want to reload the page, otherwise - POST data will be sent without prompting the user. |
| void DotNetBrowser.Browser.ReloadIgnoringCache | ( | ) |
Reloads the currently loaded web page ignoring caches.
| void DotNetBrowser.Browser.ReplaceMisspelledWord | ( | string | word | ) |
Replaces misspelled word under cursor on the currently loaded web page with the given word. If there's no misspelled word under cursor, this method does nothing.
| word | a string that represents word for replacement. |
| ArgumentException | when word is null or empty string. |
| void DotNetBrowser.Browser.SaveWebPage | ( | string | filePath, |
| string | resourcesPath, | ||
| SavePageType | saveType | ||
| ) |
Saves the current web page as a file or set of files. Page must be loaded completely. Use the FinishLoadingFrame to make sure that web page is loaded completely.
| filePath | the full path of a file in which the web page will be saved. If absolute path to the file does not exist, it will be created. |
| resourcesPath | the full path of the directory in which resources (e.g. images, css) of the web page will be saved. If the directory does not exist, it will be created. |
| saveType | determines how the web page will be saved: as HTML file with required resources (e.g. images, css etc.), a single HTML or MHTML file. |
| ArgumentException | when filePath is null or empty, dirPath is null or empty, saveType is null. |
| void DotNetBrowser.Browser.SetBounds | ( | int | x, |
| int | y, | ||
| int | width, | ||
| int | height | ||
| ) |
Updates bounds of the current Browser's view. By default Browser's view is empty, so if you load some document it will not be loaded at all because there's no sense in loading and rendering web document when view is empty.
Use this method in headless mode when Browser isn't displayed, but you need to perform some UI related actions that depend on the loaded document size. For example, when you need to get Node at specific point in headless mode.
| x | The x-coordinate of the upper-left corner of the Browser's view. |
| y | The y-coordinate of the upper-left corner of the Browser's view. |
| width | width of the Browser's view in pixels. Cannot be negative. |
| height | height of the Browser's view in pixels. Cannot be negative. |
| ArgumentException | when width or height is negative |
| void DotNetBrowser.Browser.SetSize | ( | int | width, |
| int | height | ||
| ) |
Updates size of the current Browser's view. By default Browser's view is empty, so if you load some document it will not be loaded at all because there's no sense in loading and rendering web document when view is empty.
Use this method in headless mode when Browser isn't displayed, but you need to perform some UI related actions that depend on the loaded document size. For example, when you need to get Node at specific point in headless mode.
| width | width of the Browser's view in pixels. Cannot be negative. |
| height | height of the Browser's view in pixels. Cannot be negative. |
| ArgumentException | when width or height is negative |
| void DotNetBrowser.Browser.Stop | ( | ) |
Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations.
| void DotNetBrowser.Browser.StopFindingText | ( | StopFindAction | action | ) |
Stops finding text and resets found matches highlighting.
| action | determines action, which will be applied to the selected match. |
| void DotNetBrowser.Browser.UnregisterFunction | ( | string | functionName | ) |
Remove the registered BrowserFunction instance associated with the functionName from the list of registered JavaScript functions. When the function is unregistered, JavaScript cannot invoke it anymore and every attempt to access it will cause JavaScript error. If function is already unregistered, this method does nothing.
| functionName | the name of the registered JavaScript function. |
| void DotNetBrowser.Browser.ZoomIn | ( | ) |
Updates zoom level for the currently loaded web page on one step up.
| void DotNetBrowser.Browser.ZoomOut | ( | ) |
Updates zoom level for the currently loaded web page on one step down.
| void DotNetBrowser.Browser.ZoomReset | ( | ) |
Resents zoom level for the currently loaded web page to default value.
|
get |
Provides access to the application cache storage associated with this Browser instance. The cache storage saves all application cache files in the Browser's user data directory. If you need to configure each Browser to use unique application cache storage which is not accessible for other Browser instances, you need to provide unique user data directory for each Browser instance.
You cannot use the application cache storage when the current Browser instance is already disposed.
the application cache storage associated with the current Browser instance.
|
getset |
Gets or sets mutes all audio output for this Browser instance. True when audio output must be muted, false otherwise.
|
get |
Gets true when the audio is currently playing on the loaded web page.
|
get |
Returns back-forward navigation controller instance.
|
get |
Return current rendering type for browser
|
get |
Provides access to the cache storage associated with this Browser instance. The cache storage saves all cache files in the Browser's user data directory. If you need to configure each Browser to use unique cache storage which is not accessible for other Browser instances, you need to provide unique user data directory for each Browser instance.
You cannot use the cache storage when the current Browser instance is already disposed.
the cache storage associated with the current Browser instance.
|
get |
Gets BrowserContext associated with this browser instance.
|
getset |
Gets or sets the handler for the context menu requests that will be invoked every time the user clicks the right mouse button.
|
get |
Provides access to the cookie storage. By default all Browser instances can access persistent cookies of each other. Since each Browser instance is running in a separate native process the session cookies are not shared between such Browser instances. The cookie storage saves all the cookies in the Browser's user data directory. If you need to configure each Browser to use unique cookie storage which is not accessible for other Browser instances, you need to provide unique user data directory for each Browser instance. The data directory path can be provided via BrowserContext.BrowserContext(BrowserContextParams) object that must be passed to the BrowserFactory.Create(BrowserContext) factory method.
You cannot use the cookie storage when its Browser instance is disposed.
the cookie storage.
|
getset |
Gets or sets stylesheet which will be applied to any loaded document. The CustomStylesheet CSS properties don't override the intersected properties on the loaded webpage.
|
getset |
Dialogs handler.
|
getset |
Gets or sets the file download handler that will be invoked every time the Browser downloads a file. By default this method returns null, so all file downloads are suppressed.
the registered file download handler or null if no file download handler is currently registered.
|
getset |
Gets or sets a new full screen handler to receive notifications when HTML element on the web page goes into a full screen mode.
|
get |
Gets IImageProvider that allows to get rendered image.
|
get |
Returns true if sandbox enabled for render process. Should be used only for testing purposes.
|
getset |
Load handler that will be invoked every time when Browser loads a web page. It can be used to cancel some URL loading.
|
get |
Returns true when browser is loading resource.
|
get |
|
getset |
Chromium native process crash handler.
|
getset |
Gets or sets permission handler that will be invoked every time the engine asks about permission for different functionality such as geolocation, desktop. notifications, etc. By default, this method returns null which indicates that all permission requests will be denied.
|
get |
Plugin manager that provides info about all available plugins and allows enabling/disabling them.
|
getset |
Popup windows handler.
|
getset |
Browser's preferences.
|
getset |
Gets or sets the file download handlerthat will be invoked every time when printing requests for print settings. By default this method returns null. When it is
null it means silent mode where print dialog isn't displayed and web page is printed using default system print settings. On different platforms default system print settings can be different.
|
get |
Gets information about Chromium render process associated with the current Browser instance. When Chromium loads a new web page, it creates a new render process where DOM and JavaScript are running. This render process can be terminated by Chromium engine when a new web page with different domain is loaded. So, this method can return different render process information.
The information about render process is collected at the moment of the method invocation. You must call this method again if you need to get the up to date information.
|
get |
A string that represents a title of the currently loaded web page.
|
get |
URL of the currently loaded web page.
|
getset |
Gets or sets zoom changes enabled. By default, zoom functionality is enabled. You can change zoom level for the currently loaded web page.
To disable zoom functionality pass false. In this case the browser instance will revert to the default zoom level, and all attempted zoom changes will be ignored.
|
getset |
Gets or sets zoom level for the currently loaded web page. Zoom level is configured for each domain separately. For example, if you load the www.a.com web page and set zoom level to 2.5, then load the www.b.org web page, the zoom level for www.b.org web page will be reset to default value. When you load the www.a.com web page again, its zoom level will be restored to 2.5 automatically.
This method is executed asynchronously.
| ConsoleMessageHandler DotNetBrowser.Browser.ConsoleMessageEvent |
An event that indicates that the message was added to the console.
| DisposeEventHandler DotNetBrowser.Browser.DisposeEvent |
An event that indicates that browser instance disposed.
| DocumentLoadedInFrameHandler DotNetBrowser.Browser.DocumentLoadedInFrameEvent |
An event that indicates that frame with a document is loaded.
| DocumentLoadedInMainFrameHandler DotNetBrowser.Browser.DocumentLoadedInMainFrameEvent |
An event that indicates that main frame with a document is loaded.
| DragDropHandler DotNetBrowser.Browser.DragEnterEvent |
An event that indicates that the object is dragged into the browser's bounds.
| DragDropHandler DotNetBrowser.Browser.DragExitEvent |
An event that indicates that the object is dragged out of the browser's bounds.
| DragDropHandler DotNetBrowser.Browser.DropEvent |
An event that indicates when a drag-and-drop operation is completed.
| FailLoadingFrameHandler DotNetBrowser.Browser.FailLoadingFrameEvent |
An event that indicates that frame loading process has been failed.
| FinishLoadingFrameHandler DotNetBrowser.Browser.FinishLoadingFrameEvent |
An event that indicates that frame loading process has been finished.
| GestureEventHandler DotNetBrowser.Browser.GestureEvent |
An event that indicates that user has made a gesture interaction GestureType with device SourceDevice.
| HandledGestureEventHandler DotNetBrowser.Browser.HandleGestureEvent |
An event that indicates that user has made a gesture interaction GestureType with device SourceDevice. Provides an ability to discard performed interaction.
| ProvisionalLoadingFrameHandler DotNetBrowser.Browser.ProvisionalLoadingFrameEvent |
An event that indicates that provisional load for a specified frame was successfully committed.
| RenderCreatedHandler DotNetBrowser.Browser.RenderCreatedEvent |
An event that indicates that the render process is created.
| RenderCreatedHandler DotNetBrowser.Browser.RenderGoneEvent |
An event that indicates that the render process is gone.
| RenderCreatedHandler DotNetBrowser.Browser.RenderResponsiveEvent |
An event that indicates that the render process is no longer hung.
| RenderCreatedHandler DotNetBrowser.Browser.RenderUnresponsiveEvent |
An event that indicates that the render process is hung.
| ScriptContextCreatedHandler DotNetBrowser.Browser.ScriptContextCreated |
An event that indicates that JavaScript context has been created. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance.
| ScriptContextDestroyedHandler DotNetBrowser.Browser.ScriptContextDestroyed |
An event that indicates that JavaScript context has been destroyed. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance.
| StartLoadingFrameHandler DotNetBrowser.Browser.StartLoadingFrameEvent |
An event that indicates that frame loading process has been started.
| StatusEventHandler DotNetBrowser.Browser.StatusChangedEvent |
An event that indicates that the status has been changed.
| TitleChangedHandler DotNetBrowser.Browser.TitleChangedEvent |
An event that indicates that the title of a document in main frame has been changed.
1.8.11
