focusOffset property

Article
05/02/2017

Retrieves the end position of a selection that is relative to the IHTMLSelection::focusNode.

Syntax

HRESULT value = object.get_focusOffset(* p);

Property values

Type: long

The end position of the selection.

Standards information

HTML5 A vocabulary and associated APIs for HTML and XHTML, Section 7.6.1

Remarks

IHTMLSelection::focusOffset typically refers to a character position within the text portion of the IHTMLSelection::focusNode.

Examples

The following example uses IHTMLSelection::focusOffset to show the offset value for the end of a selection when you release the mouse button.

<!DOCTYPE html>
<html>
  <head>
<!-- this example displays the character offset from anchor node of your selection-->
    <title>Focus Offset Example</title>        
    <script type="text/javascript">         
      function getfocusOffset() {
        if (window.getSelection) {                      //only works if supported
           var selection = window.getSelection ();      //get the selection object     
           var focusOffsetProp = selection.focusOffset;   //get the offset
           alert ( "Offset: \n" + focusOffsetProp.toString());                                 
           }
      }                
    </script>
  </head>
<body>
<div onmouseup="getfocusOffset()">    <!-- call the function when the mouse button is released -->
      <p>
        Use the mouse to select some text within this field.
        When <strong>the left <em>button</em> is released</strong>, a dialog box appears with the anchor offset.
      </p>  
      <p>
        The nested tags <strong>here and <em>there</em> can</strong> demonstrate different offsets as well.
      </p>
    </div>
  </body>
</html>