Class

FrameworkElement

Create a new FrameworkElement.

Declaration

public FrameworkElement()

Defines how to get the ActualHeight property of this element.

Declaration

public static AutomationProperty ActualHeightProperty

Field Value

Defines how to get the ActualWidth property of this element.

Declaration

public static AutomationProperty ActualWidthProperty

Field Value

Defines how to get the Clip property of this element.

Declaration

public static AutomationProperty ClipProperty

Field Value

Defines how to get the DataContext property of this element.

Declaration

public static AutomationProperty DataContextProperty

Field Value

Defines how to get the DesiredSize property of this element.

Declaration

public static AutomationProperty DesiredSizeProperty

Field Value

Defines how to get the Height property of this element.

Declaration

public static AutomationProperty HeightProperty

Field Value

Defines how to get the HorizontalAlignment property of this element.

Declaration

public static AutomationProperty HorizontalAlignmentProperty

Field Value

Defines how to get the IsHitTestVisible property of this element.

Declaration

public static AutomationProperty IsHitTestVisibleProperty

Field Value

Defines how to get the Margin property of this element.

Declaration

public static AutomationProperty MarginProperty

Field Value

Defines how to get the MaxHeight property of this element.

Declaration

public static AutomationProperty MaxHeightProperty

Field Value

Defines how to get the MaxWidth property of this element.

Declaration

public static AutomationProperty MaxWidthProperty

Field Value

Defines how to get the MinHeight property of this element.

Declaration

public static AutomationProperty MinHeightProperty

Field Value

Defines how to get the MinWidth property of this element.

Declaration

public static AutomationProperty MinWidthProperty

Field Value

Defines how to get the Name property of this element.

Declaration

public static AutomationProperty NameProperty

Field Value

Defines how to get the OpacityMask property of this element.

Declaration

public static AutomationProperty OpacityMaskProperty

Field Value

Defines how to get the Opacity property of this element.

Declaration

public static AutomationProperty OpacityProperty

Field Value

Defines how to get the RenderSize property of this element.

Declaration

public static AutomationProperty RenderSizeProperty

Field Value

Defines how to get the RenderTransformOrigin property of this element.

Declaration

public static AutomationProperty RenderTransformOriginProperty

Field Value

Defines how to get the RenderTransform property of this element.

Declaration

public static AutomationProperty RenderTransformProperty

Field Value

Defines how to get the Tag property of this element.

Declaration

public static AutomationProperty TagProperty

Field Value

Defines how to get the VerticalAlignment property of this element.

Declaration

public static AutomationProperty VerticalAlignmentProperty

Field Value

Defines how to get the Visibility property of this element.

Declaration

public static AutomationProperty VisibilityProperty

Field Value

Defines how to get the Width property of this element.

Declaration

public static AutomationProperty WidthProperty

Field Value

Get the sibling tag index of this FrameworkElement.

Declaration

public int AbsoluteSiblingTagIndex { get; }

Property Value

Implements IFrameworkElement.AbsoluteSiblingTagIndex

Get the absolute index of this Xaml tag in the Visual Tree.

Declaration

public int AbsoluteTagIndex { get; }

Property Value

Gets the value of the ActualHeight of this element.

Declaration

public double ActualHeight { get; }

Property Value

Implements IFrameworkElement.ActualHeight

Gets the value of the ActualWidth of this element.

Declaration

public double ActualWidth { get; }

Property Value

Implements IFrameworkElement.ActualWidth

Get the Application object that owns this element.

Declaration

[Browsable(false)]
public IApplication Application { get; }

Property Value

Gets the AutomationId set on this element if any.

Declaration

public string AutomationId { get; }

Property Value

Gets the visual children of this element.

Declaration

public IList<FrameworkElement> Children { get; }

Property Value

Gets / Sets the value of the Clip of this element.

Declaration

public Geometry Clip { get; set; }

Property Value

Declaration

public virtual Visibility ComputedVisibility { get; }

Property Value

Implements IFrameworkElement.ComputedVisibility

Get the depth of this element in the Visual Tree.

Declaration

public int Depth { get; }

Property Value

Implements ITargetElement.Depth

Gets the value of the DesiredSize of this element.

Declaration

public Size DesiredSize { get; }

Property Value

Enables or disables the validation of mouse click locations before performing mouse actions

Declaration

public bool EnableValidateMouseLocation { get; set; }

Property Value

Get the Find object used to search the visual children of this element.

Declaration

[Browsable(false)]
public VisualFind Find { get; }

Property Value

Implements IFrameworkElement.Find

Gets / Sets the value of the Height of this element.

Declaration

public double Height { get; set; }

Property Value

Gets / Sets the value of the HorizontalAlignment of this element.

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Returns the AutomationHost for this object.

Declaration

public IAutomationHost Host { get; }

Property Value

Implements ITargetElement.Host

Gets / Sets the value of the IsHitTestVisible of this element.

Declaration

public bool IsHitTestVisible { get; set; }

Property Value

Gets whether or not this element is contained in a test region.

Declaration

public bool IsTestRegion { get; }

Property Value

Implements ITargetElement.IsTestRegion

Declaration

public virtual bool IsVisible { get; }

Property Value

Gets a mappings collection that stores customizable control specific mapping knowledge that can be later customized.

Declaration

public virtual MappingsCollection Mappings { get; }

Property Value

Gets / Sets the value of the Margin of this element.

Declaration

public Thickness Margin { get; set; }

Property Value

Gets / Sets the value of the MaxHeight of this element.

Declaration

public double MaxHeight { get; set; }

Property Value

Gets / Sets the value of the MaxWidth of this element.

Declaration

public double MaxWidth { get; set; }

Property Value

Gets / Sets the value of the MinHeight of this element.

Declaration

public double MinHeight { get; set; }

Property Value

Gets /Sets the value of the MinWidth of this element.

Declaration

public double MinWidth { get; set; }

Property Value

Gets the value of the Name of this element.

Declaration

public string Name { get; }

Property Value

Implements IFrameworkElement.Name

Gets / Sets the value of the Opacity of this element.

Declaration

public double Opacity { get; set; }

Property Value

Gets / Sets the value of the OpacityMask of this element.

Declaration

public Brush OpacityMask { get; set; }

Property Value

Get the parsed element under this object.

Declaration

public ParsedElement ParsedElement { get; }

Property Value

Implements ITargetElement.ParsedElement

Gets the value of the RenderSize of this element.

Declaration

public Size RenderSize { get; }

Property Value

Gets / Sets the value of the RenderTransform of this element.

Declaration

public Transform RenderTransform { get; set; }

Property Value

Gets / Sets the value of the RenderTransformOrigin of this element.

Declaration

public Point RenderTransformOrigin { get; set; }

Property Value

Gets the tag name index of the xaml tag name in the visual tree.

Declaration

public int TagNameIndex { get; }

Property Value

Get the technology type of this element.

Declaration

public virtual TechnologyType TechnologyType { get; }

Property Value

Implements ITargetElement.TechnologyType

Gets the element text, the first text block text by default.

Declaration

public virtual string Text { get; }

Property Value

Implements IFrameworkElement.Text

Gets the text from all the inner TextBlock elements.

Declaration

public string TextBlockContent { get; }

Property Value

Implements IFrameworkElement.TextBlockContent

Gets the literal text content of this framework element if any.

Declaration

public string TextLiteralContent { get; }

Property Value

Implements IFrameworkElement.TextLiteralContent

The text of the tooltip specified for this element

Declaration

public virtual string ToolTipText { get; }

Property Value

Implements IFrameworkElement.ToolTipText

Unique identifier for this control in its application. For internal use.

Declaration

public string Uid { get; }

Property Value

Implements IFrameworkElement.Uid

Gets the UI interaction object that allows you to interact with this framework element directly using real mouse and keyboard interactions

Declaration

[Browsable(false)]
public virtual UserInteraction User { get; }

Property Value

Implements IFrameworkElement.User

Gets / Sets the value of the VerticalAlignment of this element.

Declaration

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

Gets / Sets the value of the Visibility of this element.

Declaration

public Visibility Visibility { get; set; }

Property Value

Gets a VisualWait object to be used on waiting for Visual elemnets in the VisualTree.

Declaration

[Browsable(false)]
public VisualWait Wait { get; }

Property Value

Implements IFrameworkElement.Wait

Gets / Sets the value of the Width of this element.

Declaration

public double Width { get; set; }

Property Value

Get the xaml tag name of this FrameworkElement. This is used for hierarchy matching and traversal.

Declaration

public virtual string XamlTag { get; }

Property Value

Gets the lowest control type that the framework recognizes

Declaration

public string XamlTagBase { get; }

Property Value

Add a child node to this framework element.

Declaration

public void AddChildNode(ITargetElement child)

Parameters

Implements ITargetElement.AddChildNode(ITargetElement)

Return any sibling of this control of the specified type. This method searches the previous siblings first, then the next sibilings.

Declaration

public FrameworkElement AnySibling(string controlType)

Parameters

Returns

Return any sibling of this control of the specified type.

Declaration

public T AnySibling<T>() where T : FrameworkElement

Returns

Return this framework element as a strongly-typed control.

Declaration

public T As<T>() where T : FrameworkElement

Returns

Assign the automation reference to this element.

Declaration

public override void AssignReference(AutomationReference reference)

Parameters

Overrides AutomationObject<FrameworkElement>.AssignReference(AutomationReference)

Implements IFrameworkElement.AssignReference(AutomationReference)

Capture the image of this element.

Declaration

public Bitmap Capture()

Returns

Implements ITargetElement.Capture()

Captures the image of current element with scaling and OS information.

Declaration

public ElementImage CaptureImage()

Returns

Implements ITargetElement.CaptureImage()

Returns this framework element as a strongly-typed control without enforcing tag name to match the type. This functions gives you free casting abilities between types.

Declaration

public T CastAs<T>() where T : IFrameworkElement

Returns

Implements IFrameworkElement.CastAs<T>()

Performs best-effort operations to ensure that this element is user-visible and avialable for simulated user actions.

Declaration

public void EnsureClickable()

Determines whether this FrameworkElement is equal to another, by comparing their AutomationReferences

Declaration

public override bool Equals(object obj)

Parameters

Returns

Overrides object.Equals(object)

Used internally to translate object across application boundaries

Declaration

public override void FromRealObject(object o)

Parameters

Overrides AutomationObject<FrameworkElement>.FromRealObject(object)

Get value of attached property.

Declaration

public T GetAttachedProperty<T>(string propertyOwner, string propertyName)

Parameters

Returns

Declaration

public AutomationProperty GetAutomationProperty(string name)

Parameters

Returns

Implements IFrameworkElement.GetAutomationProperty(string)

Given a child FrameworkElement of this element, return this child's tag index relative to this element. If the child has the same tag name as this element, it will not be counted.

Declaration

public int GetChildTagIndex(FrameworkElement child)

Parameters

Returns

Get the children of this framework element.

Declaration

public ITargetElement[] GetChildren()

Returns

Implements ITargetElement.GetChildren()

Get the loaded Xaml control type by given interface control type. Useful for sharing common Xaml (SL/Wpf) controls.

Declaration

public static Type GetControlTypeFromInterface(Type interfaceType)

Parameters

Returns

Calculates and returns the hashcode for this element.

Declaration

public override int GetHashCode()

Returns

Overrides object.GetHashCode()

Not implemented for Silverlight elements. Returns null.

Declaration

public ITargetElement GetHostParent()

Returns

Implements ITargetElement.GetHostParent()

Gets whether this framework element has an automationid set on it or name. If it does, it will return which one was found and its value. If both are found, AutomationId will be returned first.

Declaration

public bool GetIdentifier(out string name, out string value)

Parameters

Returns

Gets the bounding rectangle of this element within the Silverlight app with integral coordinates

Declaration

public Rectangle GetIntRectangle()

Returns

Return all the known control types.

Declaration

public static List<string> GetKnownControlTypes(TechnologyType techType)

Parameters

Returns

Get the next sibling of this FrameworkElement.

Declaration

public FrameworkElement GetNextSibling()

Returns

Get the Parent of this element.

Declaration

public ITargetElement GetParent()

Returns

Implements ITargetElement.GetParent()

Get the previous sibling.

Declaration

public FrameworkElement GetPrevSibling()

Returns

Reads and returns the specified property from this element.

Declaration

public Dictionary<string, string> GetProperties()

Returns

Gets the property value by given name. Will be useful for common translators supporting different technologies (SL/Wpf).

Declaration

public T GetProperty<T>(string name)

Parameters

Returns

Implements IFrameworkElement.GetProperty<T>(string)

Declaration

public object GetPropertyTypeSafe(string name)

Parameters

Returns

Implements IFrameworkElement.GetPropertyTypeSafe(string)

Gets the real object type. This property returns string.empty on FrameworkElement and all subclasses that inherit from it.

Declaration

public override string GetRealType()

Returns

Overrides AutomationObject<FrameworkElement>.GetRealType()

Get the bounding rectangle of this element within this Silverlight App.

Declaration

public RectangleF GetRectangle()

Returns

Get the bounding rectangle of this element relative to another element

Declaration

public RectangleF GetRectangle(FrameworkElement relativeTo)

Parameters

Returns

Return the actual coordinates of this element in absolute screen coordinates taking into account the location of the overall plug-in on the page.

Declaration

public Rectangle GetScreenRectangle()

Returns

Remarks

Return a string representation of this element

Declaration

public string GetStringPresentation()

Returns

Implements ITargetElement.GetStringPresentation()

Calculates and returns the hash code for this element.

Declaration

public int GetUniqueHashCode()

Returns

Implements ITargetElement.GetUniqueHashCode()

Highlight this element.

Declaration

public void Highlight()

Highlight this element

Declaration

public void Highlight(bool clear)

Parameters

Declaration

public static void InitKnownSilverlightControlTypes()

Declaration

public static void InitKnownWpfControlTypes()

Initialize all the known types

Declaration

public static void InitKnownXamlControlTypes(Type baseType)

Parameters

Initialize the Mappings collection. This method is called when the Mappings collection is accessed for the first time. It is then cached

Declaration

public virtual void InitializeMappings(MappingsCollection mappings)

Parameters

Checks if element passed in is a child of this framework element.

Declaration

public bool IsChild(FrameworkElement element)

Parameters

Returns

Determines whether the element can be clicked/selected

Declaration

public virtual bool IsHitTest()

Returns

Determines whether [is hit test] [the specified relative parent].

Declaration

public virtual bool IsHitTest(FrameworkElement relativeParent, bool allowPartialVisibiltiy)

Parameters

Returns

Determines whether [is hit test] [the specified allow partial visibiltiy].

Declaration

public virtual bool IsHitTest(bool allowPartialVisibiltiy)

Parameters

Returns

Simulate user key press specific to this element.

Declaration

public void KeyPress(Keys key, int holdFor, int delayBetweenRepetitions, int repeatCount)

Parameters

Match this FrameworkElement against a specific find expression.

Declaration

public bool Match(IFindExpression findExpr)

Parameters

Returns

Implements ITargetElement.Match(IFindExpression)

Return the next sibling of this control of type.

Declaration

public FrameworkElement NextSibling(string controlType)

Parameters

Returns

The next sibling control of desired type.

Declaration

public T NextSibling<T>() where T : FrameworkElement

Returns

Get the parent framework element

Declaration

public FrameworkElement Parent()

Returns

Get the parent control that matched the control type.

Declaration

public FrameworkElement Parent(string controlType)

Parameters

Returns

Get the parent control that matched the control type.

Declaration

public FrameworkElement Parent(string controlType, bool matchBaseType)

Parameters

Returns

Get the parent control of this control that is of type T.

Declaration

public T Parent<T>() where T : IFrameworkElement

Returns

Implements IFrameworkElement.Parent<T>()

Remarks

The previous sibling control of desired type.

Declaration

public FrameworkElement PreviousSibling(string controlType)

Parameters

Returns

The previous sibling control of specified type.

Declaration

public T PreviousSibling<T>() where T : FrameworkElement

Returns

Refresh this FrameworkElement within the VisualTree.

Declaration

public void Refresh()

Implements ITargetElement.Refresh()

Associate a control type with a Xaml tag.

Declaration

public static void RegisterElement(Type controlType, string xamlTagName)

Parameters

Scrolls the web page so that this element is visible in the browser window

Declaration

public void ScrollToVisible()

Implements IFrameworkElement.ScrollToVisible()

Scrolls the web page so that this element is visible in the browser window

Declaration

public void ScrollToVisible(ScrollToVisibleType scrollType)

Parameters

Set value of attached property.

Declaration

public void SetAttachedProperty<T>(string propertyOwner, string propertyName, T value)

Parameters

Ignore for the base FrameworkElement. May be overriden in a derived class to provide additional functionality.

Declaration

public void SetClosingTag(ITargetElement closingElement)

Parameters

Implements ITargetElement.SetClosingTag(ITargetElement)

Set the depth of this framework element.

Declaration

public void SetDepth(int depth)

Parameters

Implements ITargetElement.SetDepth(int)

Declaration

public void SetFindInfo(VisualFindInfo findInfo)

Parameters

Implements IFrameworkElement.SetFindInfo(VisualFindInfo)

Sets keyboard focus to this element

Declaration

public void SetFocus()

Implements IFrameworkElement.SetFocus()

Set the parent object of this framework element.

Declaration

public void SetParent(ITargetElement parent)

Parameters

Implements ITargetElement.SetParent(ITargetElement)

Sets the property value. Will be useful for common translators supporting different technologies (SL/Wpf).

Declaration

public void SetProperty(string name, object value)

Parameters

Implements IFrameworkElement.SetProperty(string, object)

Declaration

public void SetProxy(bool isProxy)

Parameters

Implements IFrameworkElement.SetProxy(bool)

Declaration

public void SetUid(string uid)

Parameters

Implements IFrameworkElement.SetUid(string)

Set the Xaml tag name.

Declaration

public void SetXamlTag(string tag)

Parameters

Implements IFrameworkElement.SetXamlTag(string)

Used internally to translate object across application boundaries

Declaration

public override object ToRealObject()

Returns

Overrides AutomationObject<FrameworkElement>.ToRealObject()

Gets the string representation of this FrameworkElement object.

Declaration

public override string ToString()

Returns

Overrides object.ToString()

Gets an Xml formatted string that represents this element and all its children This Xml represents the VisualTree.

Declaration

public string ToXml()

Returns

Validate that the current location of the mouse is inside the browser window.

Declaration

public void ValidateMouseLocationIfNeeded(Point point)

Parameters

Exceptions

Validate a control type with the control tag name.

Declaration

protected bool ValidateType(Type type, string tagName)

Parameters

Returns