Click or drag to resize
CfxFrame Class

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

Structure used to represent a frame in the browser window. When used in the browser process the functions of this structure may be called on any thread unless otherwise indicated in the comments. When used in the render process the functions of this structure may only be called on the main thread.
Inheritance Hierarchy
SystemObject
  ChromiumCfxObject
    ChromiumCfxBase
      ChromiumCfxLibraryBase
        ChromiumCfxFrame

Namespace: Chromium
Assembly: ChromiumFX (in ChromiumFX.dll)
Syntax
public class CfxFrame : CfxLibraryBase

The CfxFrame 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 propertyIsFocused
Returns true (1) if this is the focused frame.
Public propertyIsMain
Returns true (1) 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 NULL name value.
Public propertyNativePtr
Provides access to the underlying native cef struct. This is a refcounted library struct derived from cef_base_t. Add a ref in order to keep it alive when this managed object go out of scope.
(Inherited from CfxLibraryBase.)
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.
Public propertyV8Context
Get the V8 context associated with the frame. This function can only be called from the render process.
Top
Methods
  NameDescription
Public methodCopy
Execute copy in this frame.
Public methodCut
Execute cut in this frame.
Public methodDelete
Execute delete in this frame.
Public methodExecuteJavaScript
Execute a string of JavaScript code in this frame. The |scriptUrl| parameter is the URL where the script in question can be found, if any. The renderer may request this URL to show the developer the source of the error. The |startLine| parameter is the base line number to use for error reporting.
Public methodGetSource
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.
Public methodLoadRequest
Load the request represented by the |request| object.
Public methodLoadString
Load the contents of |stringVal| with the specified dummy |url|. |url| should have a standard scheme (for example, http scheme) or behaviors like link clicks and web security restrictions may not behave as expected.
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 function can only be called from the browser process.
Public methodVisitDom
Visit the DOM document. This function can only be called from the render process.
Top
Remarks
See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.
See Also