RenderTreeFrame Struct

Definition

Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside of the Blazor framework. These types will change in future release.

public value class RenderTreeFrame
public struct RenderTreeFrame
type RenderTreeFrame = struct
Public Structure RenderTreeFrame
Inheritance
RenderTreeFrame

Fields

AttributeEventHandlerId

If the FrameType property equals Attribute gets the ID of the corresponding event handler, if any.

AttributeEventUpdatesAttributeName

If the FrameType property equals Attribute, and the attribute represents an event handler, gets the name of another attribute whose value can be updated to represent the UI state prior to executing the event handler. This is primarily used in two-way bindings.

AttributeName

If the FrameType property equals Attribute, gets the attribute name. Otherwise, the value is undefined.

AttributeValue

If the FrameType property equals Attribute, gets the attribute value. Otherwise, the value is undefined.

ComponentId

If the FrameType property equals Component, gets the child component instance identifier.

ComponentKey

If the FrameType property equals Component, gets the component's diffing key, or null if none was specified.

ComponentReferenceCaptureAction

If the FrameType property equals ComponentReferenceCapture, gets the action that writes the reference to its target. Otherwise, the value is undefined.

ComponentReferenceCaptureParentFrameIndex

If the FrameType property equals ComponentReferenceCapture, gets the index of the parent frame representing the component being captured. Otherwise, the value is undefined. WARNING: This index can only be used in the context of the frame's original render tree. If the frame is copied elsewhere, such as to the ReferenceFrames buffer of a RenderTreeDiff, then the index will not relate to entries in that other buffer. Currently there's no scenario where this matters, but if there was, we could change all of the subtree initialization logic in RenderTreeDiffBuilder to walk the frames hierarchically, then it would know the parent index at the point where it wants to initialize the ComponentReferenceCapture frame.

ComponentSubtreeLength

If the FrameType property equals Component gets the number of frames in the subtree for which this frame is the root. The value is zero if the frame has not yet been closed.

ComponentType

If the FrameType property equals Component, gets the type of the child component.

ElementKey

If the FrameType property equals Element, gets the element's diffing key, or null if none was specified.

ElementName

If the FrameType property equals Element, gets a name representing the type of the element. Otherwise, the value is undefined.

ElementReferenceCaptureAction

If the FrameType property equals ElementReferenceCapture, gets the action that writes the reference to its target. Otherwise, the value is undefined.

ElementReferenceCaptureId

If the FrameType property equals ElementReferenceCapture, gets the ID of the reference capture. Otherwise, the value is undefined.

ElementSubtreeLength

If the FrameType property equals Element gets the number of frames in the subtree for which this frame is the root. The value is zero if the frame has not yet been closed.

FrameType

Describes the type of this frame.

MarkupContent

If the FrameType property equals Markup, gets the content of the markup frame. Otherwise, the value is undefined.

RegionSubtreeLength

If the FrameType property equals Region gets the number of frames in the subtree for which this frame is the root. The value is zero if the frame has not yet been closed.

Sequence

Gets the sequence number of the frame. Sequence numbers indicate the relative source positions of the instructions that inserted the frames. Sequence numbers are only comparable within the same sequence (typically, the same source method).

TextContent

If the FrameType property equals Text, gets the content of the text frame. Otherwise, the value is undefined.

Properties

AttributeEventHandlerId

If the FrameType property equals Attribute gets the ID of the corresponding event handler, if any.

AttributeEventUpdatesAttributeName

If the FrameType property equals Attribute, and the attribute represents an event handler, gets the name of another attribute whose value can be updated to represent the UI state prior to executing the event handler. This is primarily used in two-way bindings.

AttributeName

If the FrameType property equals Attribute, gets the attribute name. Otherwise, the value is undefined.

AttributeValue

If the FrameType property equals Attribute, gets the attribute value. Otherwise, the value is undefined.

Component

If the FrameType property equals Component, gets the child component instance. Otherwise, the value is undefined.

ComponentId

If the FrameType property equals Component, gets the child component instance identifier.

ComponentKey

If the FrameType property equals Component, gets the component's diffing key, or null if none was specified.

ComponentReferenceCaptureAction

If the FrameType property equals ComponentReferenceCapture, gets the action that writes the reference to its target. Otherwise, the value is undefined.

ComponentReferenceCaptureParentFrameIndex

If the FrameType property equals ComponentReferenceCapture, gets the index of the parent frame representing the component being captured. Otherwise, the value is undefined. WARNING: This index can only be used in the context of the frame's original render tree. If the frame is copied elsewhere, such as to the ReferenceFrames buffer of a RenderTreeDiff, then the index will not relate to entries in that other buffer. Currently there's no scenario where this matters, but if there was, we could change all of the subtree initialization logic in RenderTreeDiffBuilder to walk the frames hierarchically, then it would know the parent index at the point where it wants to initialize the ComponentReferenceCapture frame.

ComponentSubtreeLength

If the FrameType property equals Component gets the number of frames in the subtree for which this frame is the root. The value is zero if the frame has not yet been closed.

ComponentType

If the FrameType property equals Component, gets the type of the child component.

ElementKey

If the FrameType property equals Element, gets the element's diffing key, or null if none was specified.

ElementName

If the FrameType property equals Element, gets a name representing the type of the element. Otherwise, the value is undefined.

ElementReferenceCaptureAction

If the FrameType property equals ElementReferenceCapture, gets the action that writes the reference to its target. Otherwise, the value is undefined.

ElementReferenceCaptureId

If the FrameType property equals ElementReferenceCapture, gets the ID of the reference capture. Otherwise, the value is undefined.

ElementSubtreeLength

If the FrameType property equals Element gets the number of frames in the subtree for which this frame is the root. The value is zero if the frame has not yet been closed.

FrameType

Describes the type of this frame.

MarkupContent

If the FrameType property equals Markup, gets the content of the markup frame. Otherwise, the value is undefined.

RegionSubtreeLength

If the FrameType property equals Region gets the number of frames in the subtree for which this frame is the root. The value is zero if the frame has not yet been closed.

Sequence

Gets the sequence number of the frame. Sequence numbers indicate the relative source positions of the instructions that inserted the frames. Sequence numbers are only comparable within the same sequence (typically, the same source method).

TextContent

If the FrameType property equals Text, gets the content of the text frame. Otherwise, the value is undefined.

Methods

ToString()

Applies to