Click or drag to resize

IFrame Interface

Version 112.3.0
This interface represents a CefFrame object (i.e. a HTML frame)

Namespace:  CefSharp
Assembly:  CefSharp (in CefSharp.dll) Version: 112.3.0.0 (112.3.0.0)
Syntax
public interface IFrame : IDisposable

The IFrame type exposes the following members.

Properties
  NameDescription
Public propertyBrowser
Returns the browser that this frame belongs to.
Public propertyIdentifier
Returns the globally unique identifier for this frame or < 0 if the underlying frame does not yet exist.
Public propertyIsDisposed
Gets a value indicating whether the frame has been disposed of.
Public propertyIsFocused
Returns true if this is the focused frame.
Public propertyIsMain
Returns true if this is the main (top-level) frame.
Public propertyIsValid
True if this object is currently attached to a valid frame.
Public propertyName
Returns the name for this frame. If the frame has an assigned name (for example, set via the iframe "name" attribute) then that value will be returned. Otherwise a unique name will be constructed based on the frame parent hierarchy. The main (top-level) frame will always have an empty name value.
Public propertyParent
Returns the parent of this frame or NULL if this is the main (top-level) frame.
Public propertyUrl
Returns the URL currently loaded in this frame.
Top
Methods
  NameDescription
Public methodCopy
Execute copy in this frame.
Public methodCreateRequest
Create a custom request for use with LoadRequest(IRequest)
Public methodCreateUrlRequest
Create a new URL request that will be treated as originating from this frame and the associated browser. This request may be intercepted by the client via IResourceRequestHandler or ISchemeHandlerFactory. Use IUrlRequest.Create instead if you do not want the request to have this association, in which case it may be handled differently (see documentation on that method). Requests may originate from both the browser process and the render process. For requests originating from the browser process: - POST data may only contain a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES. For requests originating from the render process: - POST data may only contain a single element of type PDE_TYPE_BYTES. - If the response contains Content-Disposition or Mime-Type header values that would not normally be rendered then the response may receive special handling inside the browser for example, via the file download code path instead of the URL request code path). The request object will be marked as read-only after calling this method.
Public methodCut
Execute cut in this frame.
Public methodDelete
Execute delete in this frame.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodEvaluateScriptAsync
Execute some Javascript code in the context of this WebBrowser, and return the result of the evaluation in an Async fashion
Public methodExecuteJavaScriptAsync
Execute a string of JavaScript code in this frame.
Public methodGetSource
Retrieve this frame's HTML source as a string sent to the specified visitor. Use the GetSourceAsync method for a Task based async wrapper
Public methodGetSourceAsync
Retrieve this frame's HTML source as a string sent to the specified visitor.
Public methodGetText
Retrieve this frame's display text as a string sent to the specified visitor. Use the GetTextAsync method for a Task based async wrapper
Public methodGetTextAsync
Retrieve this frame's display text as a string sent to the specified visitor.
Public methodLoadRequest
Load the custom request. WARNING: This method will fail with "bad IPC message" reason INVALID_INITIATOR_ORIGIN (213) unless you first navigate to the request origin using some other mechanism (LoadURL, link click, etc).
Public methodLoadUrl
Load the specified url.
Public methodPaste
Execute paste in this frame.
Public methodRedo
Execute redo in this frame.
Public methodSelectAll
Execute select all in this frame.
Public methodUndo
Execute undo in this frame.
Public methodViewSource
Save this frame's HTML source to a temporary file and open it in the default text viewing application. This method can only be called from the browser process.
Top
Extension Methods
  NameDescription
Public Extension MethodDownloadUrl
Downloads the specified url and calls completeHandler when the download is complete. Makes a GET Request.
(Defined by WebBrowserExtensionsEx.)
Public Extension MethodDownloadUrlAsync
Downloads the specified url as a byte. Makes a GET Request.
(Defined by WebBrowserExtensionsEx.)
Public Extension MethodEvaluateScriptAsPromiseAsync
Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript. The result of the script execution in javascript is Promise.resolve so even no promise values will be treated as a promise. Your javascript should return a value. The javascript will be wrapped in an Immediately Invoked Function Expression. When the promise either trigger then/catch this returned Task will be completed.
(Defined by WebBrowserExtensions.)
Public Extension MethodEvaluateScriptAsyncT
Evaluate javascript code in the context of the frame. The script will be executed asynchronously and the method returns a Task that can be awaited to obtain the result.
(Defined by WebBrowserExtensionsEx.)
Public Extension MethodLoadHtml
Loads html as Data Uri See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for details If base64Encode is false then html will be Uri encoded.
(Defined by WebBrowserExtensions.)
Top
See Also