<doc>
  <legacy_id>3056</legacy_id>
  <name>browserBeforeNavigateFrame</name>
  <type>message</type>
  <syntax>
    <example>browserBeforeNavigateFrame <i>instanceId, url</i></example>
    <example>XBrowser_BeforeNavigateFrame <i>url, instanceId</i></example>
  </syntax>
  <library>Browser Library</library>
  <objects>
    <card/>
  </objects>
  <synonyms>
    <synonym>XBrowser_BeforeNavigateFrame</synonym>
  </synonyms>
  <classification>
  </classification>
  <references>
    <message tag="browserDownloadRequest">browserDownloadRequest Message</message>
    <message tag="browserBeforeNavigate">browserBeforeNavigate Message</message>
    <message tag="browserNavigateCompleteFrame">browserNavigateCompleteFrame Message</message>
  </references>
  <history>
    <introduced version="2.8.1">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
  </platforms>
  <classes>
    <desktop/>
  </classes>
  <security>
    <network/>
  </security>
  <summary>Sent when a browser is about to navigate to a new url in a frame</summary>
  <examples>
    <example>on browserBeforeNavigateFrame pInstanceId, pUrl</p><p>  if not browserFrameNavAllowed() then</p><p>    global browserCancel</p><p>    put true into browserCancel</p><p>  end if</p><p>end browserBeforeNavigateFrame</example>
  </examples>
  <description>
    <p>The <b>browserBeforeNavigateFrame</b> message is sent to the current card of a stack containg a browser object when the browser object is about to navigate to a new url in a frame. i.e. a change in the url in the target browser has been requested but not yet actioned.</p><p/><p>If the target is the main frame of the browser then the <message tag="browserBeforeNavigate">browserBeforeNavigate message</message> is sent instead.</p><p/><p>To prevent the navigation occuring, set the global variable <href tag="dictionary/keyword/3071.xml">browserCancel</href> to true</p><p/><p><b>Parameters:</b></p><p>The <i>url</i> is the new url that is about to be navigated to in the frame</p><p>The <i>instanceId</i> is the integer identifier of the browser object</p><p/><p><b>Note:</b> For general information on using the browser library, see the notes in the <function tag="revBrowserOpen">revBrowserOpen function</function> reference.</p><p/>
  </description>
</doc>