DOMClient Class

Version 103.0.120

This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an `id`. This `id` can be used to get additional information on the Node, resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM events only for the nodes that are known to the client. Backend keeps track of the nodes that were sent to the client and never sends the same node twice. It is client's responsibility to collect information about the nodes that were sent to the client.<p>Note that `iframe` owner elements will return corresponding document elements as their child nodes.</p>

Inheritance Hierarchy

SystemObject
CefSharp.DevToolsDevToolsDomainBase
CefSharp.DevTools.DOMDOMClient

Namespace: CefSharp.DevTools.DOM
Assembly: CefSharp (in CefSharp.dll) Version: 103.0.120.0 (103.0.120.0)

Syntax

C++

Copy

public class DOMClient : DevToolsDomainBase

public ref class DOMClient : public DevToolsDomainBase

The DOMClient type exposes the following members.

Constructors

	Name	Description
	DOMClient	DOM

Top

Methods

	Name	Description
	CollectClassNamesFromSubtreeAsync	Collects class names for the node with given id and all of it's child nodes.
	CopyToAsync	Creates a deep copy of the specified node and places it into the target container before the given anchor.
	DescribeNodeAsync	Describes node given its id, does not require domain to be enabled. Does not start tracking any objects, can be used for automation.
	DisableAsync	Disables DOM agent for the given page.
	DiscardSearchResultsAsync	Discards search results from the session with the given id. `getSearchResults` should no longer be called for that search.
	EnableAsync	Enables DOM agent for the given page.
	EnumToString(Enum)	(Inherited from DevToolsDomainBase.)
	EnumToString(ContentEncoding)	(Inherited from DevToolsDomainBase.)
	EnumToString(CSPViolationType)	(Inherited from DevToolsDomainBase.)
	EnumToString(DisabledImageType)	(Inherited from DevToolsDomainBase.)
	EnumToString(PermissionType)	(Inherited from DevToolsDomainBase.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FocusAsync	Focuses the given element.
	GetAttributesAsync	Returns attributes for the specified node.
	GetBoxModelAsync	Returns boxes for the given node.
	GetContainerForNodeAsync	Returns the container of the given node based on container query conditions. If containerName is given, it will find the nearest container with a matching name; otherwise it will find the nearest container regardless of its container name.
	GetContentQuadsAsync	Returns quads that describe node position on the page. This method might return multiple quads for inline nodes.
	GetDocumentAsync	Returns the root DOM node (and optionally the subtree) to the caller.
	GetFileInfoAsync	Returns file information for the given File wrapper.
	GetFrameOwnerAsync	Returns iframe node that owns iframe with the given domain.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetNodeForLocationAsync	Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is either returned or not.
	GetNodesForSubtreeByStyleAsync	Finds nodes with a given computed style in a subtree.
	GetNodeStackTracesAsync	Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
	GetOuterHTMLAsync	Returns node's HTML markup.
	GetQueryingDescendantsForContainerAsync	Returns the descendants of a container query container that have container queries against this container.
	GetRelayoutBoundaryAsync	Returns the id of the nearest ancestor that is a relayout boundary.
	GetSearchResultsAsync	Returns search results from given `fromIndex` to given `toIndex` from the search with the given identifier.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HideHighlightAsync	Hides any highlight.
	HighlightNodeAsync	Highlights DOM node.
	HighlightRectAsync	Highlights given rectangle.
	MarkUndoableStateAsync	Marks last undoable state.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveToAsync	Moves node into the new container, places it before the given anchor.
	PerformSearchAsync	Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or `cancelSearch` to end this search session.
	PushNodeByPathToFrontendAsync	Requests that the node is sent to the caller given its path. // FIXME, use XPath
	PushNodesByBackendIdsToFrontendAsync	Requests that a batch of nodes is sent to the caller given their backend node ids.
	QuerySelectorAllAsync	Executes `querySelectorAll` on a given node.
	QuerySelectorAsync	Executes `querySelector` on a given node.
	RedoAsync	Re-does the last undone action.
	RemoveAttributeAsync	Removes attribute with given name from an element with given id.
	RemoveNodeAsync	Removes node with given id.
	RequestChildNodesAsync	Requests that children of the node with given id are returned to the caller in form of `setChildNodes` events where not only immediate children are retrieved, but all children down to the specified depth.
	RequestNodeAsync	Requests that the node is sent to the caller given the JavaScript node object reference. All nodes that form the path from the node to the root are also sent to the client as a series of `setChildNodes` notifications.
	ResolveNodeAsync	Resolves the JavaScript node object for a given NodeId or BackendNodeId.
	ScrollIntoViewIfNeededAsync	Scrolls the specified rect of the given node into view if not already visible. Note: exactly one between nodeId, backendNodeId and objectId should be passed to identify the node.
	SetAttributesAsTextAsync	Sets attributes on element with given id. This method is useful when user edits some existing attribute value and types in several attribute name/value pairs.
	SetAttributeValueAsync	Sets attribute for an element with given id.
	SetFileInputFilesAsync	Sets files for the given file input element.
	SetInspectedNodeAsync	Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).
	SetNodeNameAsync	Sets node name for a node with given id.
	SetNodeStackTracesEnabledAsync	Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
	SetNodeValueAsync	Sets node value for a node with given id.
	SetOuterHTMLAsync	Sets node HTML markup, returns new node id.
	ToBase64String	(Inherited from DevToolsDomainBase.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UndoAsync	Undoes the last performed action.

Top

Events

	Name	Description
	AttributeModified	Fired when `Element`'s attribute is modified.
	AttributeRemoved	Fired when `Element`'s attribute is removed.
	CharacterDataModified	Mirrors `DOMCharacterDataModified` event.
	ChildNodeCountUpdated	Fired when `Container`'s child node count has changed.
	ChildNodeInserted	Mirrors `DOMNodeInserted` event.
	ChildNodeRemoved	Mirrors `DOMNodeRemoved` event.
	DistributedNodesUpdated	Called when distribution is changed.
	DocumentUpdated	Fired when `Document` has been totally updated. Node ids are no longer valid.
	InlineStyleInvalidated	Fired when `Element`'s inline style is modified via a CSS property modification.
	PseudoElementAdded	Called when a pseudo element is added to an element.
	PseudoElementRemoved	Called when a pseudo element is removed from an element.
	SetChildNodes	Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids.
	ShadowRootPopped	Called when shadow root is popped from the element.
	ShadowRootPushed	Called when shadow root is pushed into the element.

Top

Reference

CefSharp.DevTools.DOM Namespace