GetEmbeddableElement(UIElement,EmbeddableEditorOwnerBase,Object,Boolean,Boolean,Boolean,Boolean,EmbeddableUIElementBase) Method

Called from inside the UIElement.PositionChildElements method of the parent element to create and position the embedded element or elements.

Syntax

Visual Basic

'Declaration
 
Public Overloads MustOverride Function GetEmbeddableElement( _
   ByVal parentElement As UIElement, _
   ByVal owner As EmbeddableEditorOwnerBase, _
   ByVal ownerContext As Object, _
   ByVal includeEditElements As Boolean, _
   ByVal reserveSpaceForEditElements As Boolean, _
   ByVal drawOuterBorders As Boolean, _
   ByVal isToolTip As Boolean, _
   ByVal previousElement As EmbeddableUIElementBase _
) As EmbeddableUIElementBase

C#

public abstract EmbeddableUIElementBase GetEmbeddableElement( 
   UIElement parentElement,
   EmbeddableEditorOwnerBase owner,
   object ownerContext,
   bool includeEditElements,
   bool reserveSpaceForEditElements,
   bool drawOuterBorders,
   bool isToolTip,
   EmbeddableUIElementBase previousElement
)

Parameters

parentElement

The element that will contain the embedded element.

owner

An object that derives from the EmbeddableEditorOwnerBase class.

ownerContext

Context information that is used to get the value to render via a call to the EmbeddableEditorOwnerBase.GetValue method.

includeEditElements

If true will add associated elements (e.g. editing elements like spin buttons).

reserveSpaceForEditElements

If true will reserve space for associated elements (e.g. editing elements like spin buttons).

drawOuterBorders

If true the element is expected to draw the outer borders

isToolTip

If true the element should draw as a tooltip, i.e., use SystemColors.Info as a BackColor, and not draw gradients.

previousElement

The element returned the prior time the parent element's UIElement.PositionChildElements method was called.

Return Value

An instance of a class derived from EmbeddableUIElementBase.

Remarks

The owner and ownerContext values are saved by the added element to get value and state information later.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2