Added properties and methods to a WebElement

unknown · unknown · commit 186eb827de55 · 2016-01-06T15:12:27.000Z
New: LocationInView, IsPresent, Value, ScrollIntoView and WaitRemoval
diff --git a/Selenium/ComInterfaces/_WebElement.cs b/Selenium/ComInterfaces/_WebElement.cs
@@ -36,9 +36,18 @@ public interface _WebElement {
         [DispId(943), Description("Returns the location of the element in the renderable canvas")]
         Point Location();
 
+        [DispId(944), Description("Gets the location of an element relative to the origin of the view port.")]
+        Point LocationInView();
+
         [DispId(947), Description("Returns the size of the element")]
         Size Size();
 
+        [DispId(957), Description("Whether the element is still attached to the DOM.")]
+        bool IsPresent { get; }
+
+        [DispId(965), Description("Returns the value attribute")]
+        object Value();
+
         #endregion
 
 
@@ -83,6 +92,9 @@ public interface _WebElement {
         [DispId(949), Description("Submits a form.")]
         void Submit();
 
+        [DispId(951), Description("Scrolls the current element into the visible area of the browser window.")]
+        WebElement ScrollIntoView(bool alignTop = false);
+
         #endregion
 
 
@@ -211,6 +223,9 @@ public interface _WebElement {
         [DispId(1060), Description("Wait for text")]
         WebElement WaitText(string pattern, int timeout = -1);
 
+        [DispId(1065), Description("Wait for the web element to be removed from the DOM.")]
+        void WaitRemoval(int timeout = -1);
+
         #endregion
 
 
diff --git a/Selenium/Common/WebElement.cs b/Selenium/Common/WebElement.cs
@@ -132,7 +132,7 @@ public Point Location() {
         /// <summary>
         /// Gets the location of an element relative to the origin of the view port.
         /// </summary>
-        public Point LocationInViewport() {
+        public Point LocationInView() {
             var dict = (Dictionary)Send(RequestMethod.GET, "/location_in_view");
             return new Point(dict);
         }
@@ -164,6 +164,20 @@ public bool IsDisplayed {
             }
         }
 
+        /// <summary>
+        /// Whether the element is present
+        /// </summary>
+        public bool IsPresent {
+            get {
+                try{
+                    Send(RequestMethod.GET, "/name");
+                    return true;
+                } catch (Errors.StaleElementReferenceError) {
+                    return false;
+                }
+            }
+        }
+
         /// <summary>
         /// Gets the attribute value.
         /// </summary>
@@ -184,6 +198,15 @@ public object CssValue(string property) {
             return value;
         }
 
+        /// <summary>
+        /// Returns the value attribute
+        /// </summary>
+        /// <returns></returns>
+        public object Value() {
+            var value = Send(RequestMethod.GET, "/attribute/value");
+            return value;
+        }
+
         /// <summary>
         /// Gets the screenshot of the current element
         /// </summary>
@@ -198,11 +221,13 @@ public Image TakeScreenshot(int delayms = 0) {
             }
 
             var dict = (Dictionary)_session.javascript.Execute(
-                "return arguments[0].getBoundingClientRect()", new[] { this }, false);
+                "return arguments[0].getBoundingClientRect();", new[] { this }, false);
 
-            var rect = new System.Drawing.Rectangle(
-                Convert.ToInt32(dict["left"]), Convert.ToInt32(dict["top"]),
-                Convert.ToInt32(dict["width"]), Convert.ToInt32(dict["height"]));
+            int left = Convert.ToInt32(dict["left"]);
+            int top = Convert.ToInt32(dict["top"]);
+            int width = Convert.ToInt32(dict["width"]);
+            int height = Convert.ToInt32(dict["height"]);
+            var rect = new System.Drawing.Rectangle(left, top, width, height);
 
             using (Image image = (Image)_session.Send(RequestMethod.GET, "/screenshot")) {
                 var bitmap = image.GetBitmap();
@@ -321,11 +346,13 @@ public void ReleaseKeys(string modifiers) {
             _session.keyboard.KeyUp(modifiers);
         }
 
+
         /// <summary>
         /// Simulates typing into the element.
         /// </summary>
         /// <param name="keysOrModifier">Sequence of keys or a modifier key(Control,Shift...) if the sequence is in keysToSendEx</param>
         /// <param name="keys">Optional - Sequence of keys if keysToSend contains modifier key(Control,Shift...)</param>
+        /// <returns></returns>
         /// <example>
         /// To Send mobile to an element :
         /// <code lang="vbs">
@@ -367,6 +394,17 @@ public void Click(string keys = null) {
                 _session.keyboard.SendKeys(keys);
         }
 
+        /// <summary>
+        /// Scrolls the current element into the visible area of the browser window.
+        /// </summary>
+        public WebElement ScrollIntoView(bool alignTop = false) {
+            string script = "arguments[0].scrollIntoView("
+                          + (alignTop ? "true);" : "false);");
+            object[] arguments = { this };
+            _session.javascript.Execute(script, arguments, false);
+            return this;
+        }
+
         #endregion
 
 
@@ -576,6 +614,14 @@ public WebElement WaitDisplayed(bool displayed = true, int timeout = -1) {
             return this;
         }
 
+        /// <summary>
+        /// Wait for the web element to be removed from the DOM.
+        /// </summary>
+        /// <param name="timeout"></param>
+        public void WaitRemoval(int timeout = -1) {
+            _session.SendUntil(timeout, () => this.IsPresent, (r) => r);
+        }
+
         #endregion
 
 
@@ -606,6 +652,12 @@ public TableElement AsTable() {
         /// <param name="script">The JavaScript code to execute.</param>
         /// <param name="arguments">The arguments to the script.</param>
         /// <returns>The value returned by the script.</returns>
+        /// <example>
+        /// <code lang="vbs">
+        ///   Set element = driver.FindElementById("id")
+        ///   Debug.Print element.ExecuteScript("return [this.tagName, this.scrollLeft, this.scrollTop];")
+        /// </code>
+        /// </example>
         public object ExecuteScript(string script, object arguments = null) {
             string newscript = "return (function(){" + script + "}).apply(arguments[0],arguments[1]);";
             object[] newargs = FormatArguments(this, arguments);
