You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 31, 2021. It is now read-only.
<overview>The <b>revBrowserSet</b> command sets the value of the property <i>propertyName</i> to the value <i>propertyValue</i> for the browser specified by the <i>instanceId</i>.</overview>
69
+
<overview>The <b>revBrowserSet</b> command sets the value of the property
70
+
<i>propertyName</i> to the value <i>propertyValue</i> for the browser
71
+
specified by the <i>instanceId</i>.</overview>
63
72
64
73
<parameters>
65
74
<parameter>
@@ -68,75 +77,102 @@
68
77
</parameter>
69
78
<parameter>
70
79
<name>propertyName</name>
71
-
<description>The name of the property to set. See below for a full list.</description>
80
+
<description>The name of the property to set. See below for a full
81
+
list.</description>
72
82
<optionstitle="">
73
83
<option>
74
84
<item>url</item>
75
-
<description>The url being displayed by the browser. The default is empty.</description>
85
+
<description>The url being displayed by the browser. The default is
86
+
empty. The URL can be a web page, beginning "http://", or a local file,
87
+
beginning "file://"</description>
76
88
</option>
77
89
<option>
78
90
<item>rect</item>
79
-
<description>The rect of the browser object. The default is 0,0,0,0 so it is necessary to set the rect of a newly created browser before it will appear to be visible.</description>
91
+
<description>The rect of the browser object. The default is 0,0,0,0
92
+
so it is necessary to set the rect of a newly created browser before it will
93
+
appear to be visible.</description>
80
94
</option>
81
95
<option>
82
96
<item>selected</item>
83
-
<description>The selected text of the browser. The default is empty. Repeatedly setting the selected allows you to iterate through the matches in the browser document. See the note below for more information.</description>
97
+
<description>The selected text of the browser. The default is empty.
98
+
Repeatedly setting the selected allows you to iterate through the matches in
99
+
the browser document. See the note below for more information.</description>
84
100
</option>
85
101
<option>
86
102
<item>messages</item>
87
-
<description>Whether the browser sends "advanced" callback messages. See the note below for more information. The default is false.</description>
103
+
<description>Whether the browser sends "advanced" callback messages.
104
+
See the note below for more information. The default is false.</description>
88
105
</option>
89
106
<option>
90
107
<item>offline</item>
91
-
<description>true if the browser should run in offline mode, ie it does not retrieve information from the internet. The default is false.</description>
108
+
<description>true if the browser should run in offline mode, ie it
109
+
does not retrieve information from the internet. The default is
110
+
false.</description>
92
111
</option>
93
112
<option>
94
113
<item>contextmenu</item>
95
-
<description>true if the browser should show a right-click context menu. The default is false.</description>
114
+
<description>true if the browser should show a right-click context
115
+
menu. The default is false.</description>
96
116
</option>
97
117
<option>
98
118
<item>visible</item>
99
-
<description>true if the browser is visible. The default is true.</description>
119
+
<description>true if the browser is visible. The default is
120
+
true.</description>
100
121
</option>
101
122
<option>
102
123
<item>newwindow</item>
103
-
<description>true if the browser should allow pages to open new windows. The default is false.</description>
124
+
<description>true if the browser should allow pages to open new
125
+
windows. The default is false.</description>
104
126
</option>
105
127
<option>
106
128
<item>htmltext</item>
107
-
<description>Sets the html source of the document being displayed. The default is empty.</description>
129
+
<description>Sets the html source of the document being displayed.
130
+
The default is empty.</description>
108
131
</option>
109
132
<option>
110
133
<item>scrollbars</item>
111
-
<description>true if the browser should display scrollbars. The default is true.</description>
134
+
<description>true if the browser should display scrollbars. The
135
+
default is true.</description>
112
136
</option>
113
137
<option>
114
138
<item>showborder</item>
115
-
<description>true if the browser should be drawn with a border. The default is false.</description>
139
+
<description>true if the browser should be drawn with a border. The
140
+
default is false.</description>
116
141
</option>
117
142
<option>
118
143
<item>browser</item>
119
-
<description>Which browser should be used. Currently this can be "IE" on Windows and "Safari" on OS X.</description>
144
+
<description>Which browser should be used. Currently this can be
145
+
"IE" on Windows and "Safari" on OS X.</description>
120
146
</option>
121
147
<option>
122
148
<item>hscroll</item>
123
-
<description>The number of pixels to the right that the browser is scrolled. The default is zero.</description>
149
+
<description>The number of pixels to the right that the browser is
150
+
scrolled. The default is zero.</description>
124
151
</option>
125
152
<option>
126
153
<item>vscroll</item>
127
-
<description>The number of pixels down that the browser is scrolled. The default is zero. </description>
154
+
<description>The number of pixels down that the browser is scrolled.
155
+
The default is zero. </description>
128
156
</option>
129
157
<option>
130
158
<item>instance</item>
131
-
<description>Set the active browser instance. This property is deprecated and is only available when using the XBrowser_Set synonym. There is no longer a concept of "active browser instance" as the instance id is required by all revBrowser functions.</description>
159
+
<description>Set the active browser instance. This property is
160
+
deprecated and is only available when using the XBrowser_Set synonym. There
161
+
is no longer a concept of "active browser instance" as the instance id is
162
+
required by all revBrowser functions.</description>
132
163
</option>
133
164
<option>
134
165
<item>useragent</item>
135
-
<description>MAC ONLY. If propertyValue is non-empty the browser instance uses that string instead of the default for the User-Agent header transmitted to the web server. If propertyValue is empty the browser instance uses the default user agent string (which is determined by the browser the URL that is being requested).</description>
166
+
<description>MAC ONLY. If propertyValue is non-empty the browser
167
+
instance uses that string instead of the default for the User-Agent header
168
+
transmitted to the web server. If propertyValue is empty the browser
169
+
instance uses the default user agent string (which is determined by the
170
+
browser the URL that is being requested).</description>
136
171
</option>
137
-
<option>
172
+
<option>
138
173
<item>windowID</item>
139
-
<description>Attaches an instance of a browser to a stack</description>
174
+
<description>Attaches an instance of a browser to a
175
+
stack</description>
140
176
</option>
141
177
</options>
142
178
</parameter>
@@ -145,7 +181,53 @@
145
181
<description>The value to set the property to.</description>
146
182
</parameter> </parameters>
147
183
148
-
<value>The <b>revBrowserSet</b> command puts empty into the result if successful. </value>
149
-
<comments><note>The "advanced" callback messages are: <message tag="browserClick">browserClick</message>, <message tag="browserOut">browserOut</message> and <message tag="browserOver">browserOver</message>. These messages are only sent when the "messages" property is set to true. The other callback messages are always sent.<p></p><note>Setting the selected property selects the first instance of that text. Setting the property repeatedly to the same value will cycle through each occurrence of the value. Setting the selected to empty or to a string not present in the current document will reset the selected text, ie subsequently setting the selected to any string will select the first occurrence again. This behavior is similar to that of the <command tag="find">find command</command>.</note><p></p><change>There is a long standing issue with revBrowser that causes browser instances to be lost whenever the stack it is attached to has its window re-created. Previously, cases where this would occur had to be avoided when a browser was present on a stack.</note><p><p>To resolve this problem a new property was added in version 4.5.1 to browser instances – windowId. The windowId property allows the stack to which a browser instance is attached to be changed after it has been created.</change><p></p><p>If the windowId is set to 0, the browser instance is temporary hidden. If the windowId is set to a valid stack windowId, the browser instance will move to that stack.</p><p></p><p>For example, to toggle the resizable property of a stack hosting a browser use the following code:</p><p></p><p>	revBrowserSet pBrowserId, "windowId", 0</p><p>	set the resizable of stack pBrowserStack to pNewResizeableValue</p><p>	revBrowserSet pBrowserId, "windowId", the windowId of stack pBrowserStack</p><p></p><p><b>Cross Platform Caution</b>: Due to a limitation in the current browser implementation, the behavior of the scrollbars property is slightly different on Windows and OS X. In particular, under OS X, when navigating to a page for the first time after disabling scrollbars, revBrowser won't allow you to turn scrollbars back on. The way to work around this and create a browser that allows scrollbars to be toggled on both platforms is like this:</p><p></p><p>local sBrowserId</p><p></p><p>on browserOpen</p><p> put revBrowserOpen(the windowId of me, http://www.runrev.com) into sBrowserId</p><p> if the platform is MacOS then</p><p> send browserDisableScrollbars to me in 1 second</p><p> else</p><p> revBrowserSet sBrowserId, scrollbars, false</p><p> end if</p><p>end browserOpen</p><p></p><p>on browserDisableScrollbars</p><p> revBrowserSet sBrowserId, scrollbars, false</p><p>end browserDisableScrollbars</p><p></p><p>on browserToggleScrollbars</p><p> revBrowserSet sBrowserId, scrollbars, (not(revBrowserGet(sBrowserId, scrollbars)))</p><p>end browserToggleScrollbars</p><p></p><p></p><note>For general information on using the browser library, see the notes in the <function tag="revBrowserOpen">revBrowserOpen function</function> reference.</note></comments>
184
+
<value>The <b>revBrowserSet</b> command puts empty into the result if
185
+
successful. </value>
186
+
<comments><note> The "advanced" callback messages are: <message
0 commit comments