# Interface ICefFrame

Description
Hierarchy
Methods
Properties

## Unit

uCEFInterfaces

## Declaration

`type ICefFrame = interface(ICefBaseRefCounted)`

## Description

Interface used to represent a frame in the browser window. When used in the browser process the functions of this interface may be called on any thread unless otherwise indicated in the comments. When used in the render process the functions of this interface may only be called on the main thread.

UNKNOWN

<see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_frame_capi.h">CEF source file: /include/capi/cef_frame_capi.h (cef_frame_t))

## Hierarchy

- IInterface
- ICefBaseRefCounted
- ICefFrame

## Overview

### Methods

Public | `function IsValid: Boolean;`
Public | `procedure Undo;`
Public | `procedure Redo;`
Public | `procedure Cut;`
Public | `procedure Copy;`
Public | `procedure Paste;`
Public | `procedure PasteAndMatchStyle;`
Public | `procedure Del;`
Public | `procedure SelectAll;`
Public | `procedure ViewSource;`
Public | `procedure GetSource(const visitor: ICefStringVisitor);`
Public | `procedure GetSourceProc(const proc: TCefStringVisitorProc);`
Public | `procedure GetText(const visitor: ICefStringVisitor);`
Public | `procedure GetTextProc(const proc: TCefStringVisitorProc);`
Public | `procedure LoadRequest(const request: ICefRequest);`
Public | `procedure LoadUrl(const url: ustring);`
Public | `procedure ExecuteJavaScript(const code, scriptUrl: ustring; startLine: Integer);`
Public | `function IsMain: Boolean;`
Public | `function IsFocused: Boolean;`
Public | `function GetName: ustring;`
Public | `function GetIdentifier: ustring;`
Public | `function GetParent: ICefFrame;`
Public | `function GetUrl: ustring;`
Public | `function GetBrowser: ICefBrowser;`
Public | `function GetV8Context: ICefv8Context;`
Public | `procedure VisitDom(const visitor: ICefDomVisitor);`
Public | `procedure VisitDomProc(const proc: TCefDomVisitorProc);`
Public | `function CreateUrlRequest(const request: ICefRequest; const client: ICefUrlrequestClient): ICefUrlRequest;`
Public | `procedure SendProcessMessage(targetProcess: TCefProcessId; const message_: ICefProcessMessage);`

### Properties

Public | `property Name : ustring read GetName;`
Public | `property Url : ustring read GetUrl;`
Public | `property Browser : ICefBrowser read GetBrowser;`
Public | `property Parent : ICefFrame read GetParent;`
Public | `property Identifier : ustring read GetIdentifier;`

## Description

### Methods

Public | `function IsValid: Boolean;`
True if this object is currently attached to a valid frame. ###### Attributes GUID['{8FD3D3A6-EA3A-4A72-8501-0276BD5C3D1D}']

Public | `procedure Undo;`
Execute undo in this frame.

Public | `procedure Redo;`
Execute redo in this frame.

Public | `procedure Cut;`
Execute cut in this frame.

Public | `procedure Copy;`
Execute copy in this frame.

Public | `procedure Paste;`
Execute paste in this frame.

Public | `procedure PasteAndMatchStyle;`
Execute paste and match style in this frame.

Public | `procedure Del;`
Execute delete in this frame.

Public | `procedure SelectAll;`
Execute select all in this frame.

Public | `procedure ViewSource;`
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 | `procedure GetSource(const visitor: ICefStringVisitor);`
Retrieve this frame's HTML source as a string sent to the specified visitor.

Public | `procedure GetSourceProc(const proc: TCefStringVisitorProc);`
Retrieve this frame's HTML source as a string sent to the specified visitor.

Public | `procedure GetText(const visitor: ICefStringVisitor);`
Retrieve this frame's display text as a string sent to the specified visitor.

Public | `procedure GetTextProc(const proc: TCefStringVisitorProc);`
Retrieve this frame's display text as a string sent to the specified visitor.

Public | `procedure LoadRequest(const request: ICefRequest);`
Load the request represented by the |request| object. WARNING: This function 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 | `procedure LoadUrl(const url: ustring);`
Load the specified |url|.

Public | `procedure ExecuteJavaScript(const code, scriptUrl: ustring; startLine: Integer);`
Execute a string of JavaScript code in this frame. The |script_url| 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 |start_line| parameter is the base line number to use for error reporting.

Public | `function IsMain: Boolean;`
Returns true (1) if this is the main (top-level) frame.

Public | `function IsFocused: Boolean;`
Returns true (1) if this is the focused frame.

Public | `function GetName: ustring;`
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 | `function GetIdentifier: ustring;`
Returns the globally unique identifier for this frame or empty if the underlying frame does not yet exist.

Public | `function GetParent: ICefFrame;`
Returns the parent of this frame or NULL if this is the main (top-level) frame.

Public | `function GetUrl: ustring;`
Returns the URL currently loaded in this frame.

Public | `function GetBrowser: ICefBrowser;`
Returns the browser that this frame belongs to.

Public | `function GetV8Context: ICefv8Context;`
Get the V8 context associated with the frame. This function can only be called from the render process.

Public | `procedure VisitDom(const visitor: ICefDomVisitor);`
Visit the DOM document. This function can only be called from the render process.

Public | `procedure VisitDomProc(const proc: TCefDomVisitorProc);`
Visit the DOM document. This function can only be called from the render process.

Public | `function CreateUrlRequest(const request: ICefRequest; const client: ICefUrlrequestClient): ICefUrlRequest;`
Create a new URL request that will be treated as originating from this frame and the associated browser. Use TCustomCefUrlrequestClient.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 function). A request created with this function may only originate from the browser process, and will behave as follows: - It may be intercepted by the client via CefResourceRequestHandler or CefSchemeHandlerFactory. - POST data may only contain a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES. The |request| object will be marked as read-only after calling this function.

Public | `procedure SendProcessMessage(targetProcess: TCefProcessId; const message_: ICefProcessMessage);`
Send a message to the specified |target_process|. Ownership of the message contents will be transferred and the |message| reference will be invalidated. Message delivery is not guaranteed in all cases (for example, if the browser is closing, navigating, or if the target process crashes). Send an ACK message back from the target process if confirmation is required.

### Properties

Public | `property Name : ustring read GetName;`
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 | `property Url : ustring read GetUrl;`
Returns the URL currently loaded in this frame.

Public | `property Browser : ICefBrowser read GetBrowser;`
Returns the browser that this frame belongs to.

Public | `property Parent : ICefFrame read GetParent;`
Returns the parent of this frame or NULL if this is the main (top-level) frame.

Public | `property Identifier : ustring read GetIdentifier;`
Returns the globally unique identifier for this frame or empty if the underlying frame does not yet exist.

Generated by PasDoc 1.0.4.