home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1998 November / pcwk_11_98a.iso / Wtestowe / Vistdtk / Install / Data.Z / VcWeb32.OCX / HTMLPAGE / 246 < prev    next >
Text File  |  1997-11-06  |  12KB  |  169 lines
  1. <HTML><HEAD><TITLE>WebViewer Control Interface</TITLE></HEAD>
  2. <BODY BACKGROUND="Webster://Internal/331" TEXT="#000000" LINK="#0000FF">
  3. <P ALIGN = CENTER><IMG SRC="Webster://Internal/330"></a></p> </CENTER>
  4. <H3>The VCI WebViewer Control Interface</h3><p>
  5. WebViewer <A HREF="#properties">properties</a>, <A HREF="#methods">methods</a>, <A HREF="#events">events</a> and <A HREF="#buttons">buttons</a> are described.
  6. <HR><A NAME="buttons"></a><H4><U>Buttons</U></H4>
  7. The buttons are presented on the title bar, which is usually placed 
  8. at the top of the display area.  Every button has a corresponding <A HREF="#buttonMethods">method</a>.
  9. Use the <tt><b>ButtonMask</b></tt> property to show or hide individual buttons.<p>
  10. <UL>
  11. <LI><A HREF="http://www.visualcomp.com"><IMG SRC="Webster://Internal/213" ALIGN=TOP></A>
  12. Loads the page for the URL specified by the <tt><b>HomePage</b></tt> property.  The initial setting of the HomePage property is <strong>http://www.visualcomp.com</strong>.
  13. <LI><A HREF="Webster://Command/back"><IMG SRC="Webster://Internal/248" ALIGN=MIDDLE></A>
  14. and <A HREF="Webster://Command/forth"><IMG SRC="Webster://Internal/249" ALIGN=MIDDLE></A> page back and forth through history.
  15. <LI><IMG SRC="Webster://Internal/230" ALIGN=MIDDLE> Captures the currently displayed WWW page to disk, including embedded images.
  16. <LI><A HREF="Webster://Command/help"><IMG SRC="Webster://Internal/250" ALIGN=MIDDLE></A> Shows a status screen, which presents capture-to-disk options and shows the HTML document source.
  17. Shows this screen when clicked from internal pages (session history, directory).
  18. <LI><IMG SRC="Webster://Internal/251" ALIGN=MIDDLE> Reloads the current page, 
  19. <IMG SRC="Webster://Internal/252" ALIGN=MIDDLE> indicates an active load - click to cancel.
  20. <LI><IMG SRC="Webster://Internal/226" ALIGN=MIDDLE> Displays a directory of files on the local disk, allows selection.
  21. <LI><IMG SRC="Webster://Internal/351" ALIGN=MIDDLE> Displays a direct URL entry dialog, with a drop-down URL history list.
  22. <LI><A HREF="Webster://Command/history"><IMG SRC="Webster://Internal/253" ALIGN=MIDDLE></A> Displays session history.
  23. </UL>
  24. <HR><A NAME="properties"></a><H4><U>Properties</U></H4>
  25.  
  26. <DL>
  27. <dt><tt><b>short BorderStyle</b></tt><dd>Stock property.<p>
  28. <dt><tt><b>short HWnd</b></tt><dd>Stock property.<p>
  29. <dt><tt><b>BOOL Enabled</b></tt><dd>Stock property.<p>
  30.  
  31. <dt><tt><b>short BevelStyleInner</b></tt><dd>Inner bevel style:<p>
  32.  0 - None<br> 1 - Indent<br> 2 - Outdent<p><p>
  33. <dt><tt><b>short BevelStyleOuter</b></tt><dd>Outer bevel style (see BevelStyleInner).<p>
  34. <dt><tt><b>long BevelWidth</b></tt><dd>Bevel width<p>
  35. <dt><tt><b>OLE_COLOR BevelColorTop</b></tt><dd>Color of the flat surface between the bevels.<p>
  36. <dt><tt><b>OLE_COLOR BevelColorDark</b></tt><dd>Bevel shade color.<p>
  37. <dt><tt><b>OLE_COLOR BevelColorLight</b></tt><dd>Bevel highlight color.<p>
  38.  
  39. <dt><tt><b>LPDISPATCH Font</b></tt><dd>Stock property - used in title and URL windows.<p>
  40. <dt><tt><b>LPDISPATCH FontAddress</b></tt><dd>Address font.<p>
  41. <dt><tt><b>LPDISPATCH FontBlockQuote</b></tt><dd>Block quote font.<p>
  42. <dt><tt><b>LPDISPATCH FontDir</b></tt><dd>Directory font.<p>
  43. <dt><tt><b>LPDISPATCH FontExample</b></tt><dd>Example font.<p>
  44. <dt><tt><b>LPDISPATCH FontHeading1</b></tt><dd>Heading 1 font.<p>
  45. <dt><tt><b>LPDISPATCH FontHeading2</b></tt><dd>Heading 2 font.<p>
  46. <dt><tt><b>LPDISPATCH FontHeading3</b></tt><dd>Heading 3 font.<p>
  47. <dt><tt><b>LPDISPATCH FontHeading4</b></tt><dd>Heading 4 font.<p>
  48. <dt><tt><b>LPDISPATCH FontHeading5</b></tt><dd>Heading 5 font.<p>
  49. <dt><tt><b>LPDISPATCH FontHeading6</b></tt><dd>Heading 6 font.<p>
  50. <dt><tt><b>LPDISPATCH FontListing</b></tt><dd>Listing font.<p>
  51. <dt><tt><b>LPDISPATCH FontMenu</b></tt><dd>Menu font.<p>
  52. <dt><tt><b>LPDISPATCH FontNormal</b></tt><dd>Normal font.<p>
  53. <dt><tt><b>LPDISPATCH FontPreformatted</b></tt><dd>Preformatted font.<p>
  54.  
  55. <dt><tt><b>short ShowUrlBar</b></tt><dd>Determines the visibility and 
  56. position of the URL bar:<p> 0 - None<br> 1 - Top<br> 2 - Bottom<p><p>
  57.  
  58. <dt><tt><b>short ShowTitleBar</b></tt><dd>Determines the visibility and position of the Title 
  59. bar (see ShowUrlBar).<p>
  60.  
  61. <dt><tt><b>CString PageURL</b></tt><dd>Reflects the currently active (visible) page, which may
  62. be an HTML document, pure text or pure image.  Setting this property initiates loading and display of the page
  63. specified by the URL.<p>
  64. <dt><tt><b>CString PageTitle</b></tt><dd>Reflects the page title (read-only)<p>
  65. <dt><tt><b>OLE_COLOR AnchorColor</b></tt><dd>Color of hyperlink text.<p>
  66. <dt><tt><b>CString HomePage</b></tt><dd>URL to be loaded when the HomePage button is clicked.<p>
  67. <dt><tt><b>CString DownloadDir</b></tt><dd>The default directory for downloads and saved files.<p>
  68. <dt><tt><b>long PagesToCache</b></tt><dd>The number of pages to cache.<p>
  69. <dt><tt><b>OLE_COLOR BackColor</b></tt><dd>Stock property - the default page background color.<p>
  70. <dt><tt><b>BOOL IgnoreBaseInFile</b></tt><dd>Causes any BASE tag URL to be ignored when constructing full URLs from partial
  71. references. In addition, image references are treated as partial references (based on the underlying page URL) even
  72. when fully qualified.  This is useful when loading a page which has been captured to local disk, since images which are
  73. available on local disk are retrieved from there rather than from the original (remote) source,
  74. and so are hyperlinked pages.<p>
  75. <dt><tt><b>short LoadStatus</b></tt><dd>A status code for the currently active page:<p>
  76.  0 - Page load done.<br>
  77.  1 - Connecting to host.<br>
  78.  2 - Connected, waiting.<br>
  79.  3 - Page text loading.<br>
  80.  4 - Images loading.<br>
  81.  5 - Load failed.<br>
  82.  5 - Idle (no page).<p>
  83. <dt><tt><b>OLE_COLOR ForeColor</b></tt><dd>Stock property - default for text.<p>
  84. <dt><tt><b>long MaxSockets</b></tt><dd>Maximum number of active sockets per control instance.<p>
  85. <dt><tt><b>long ImageCacheKB</b></tt><dd>Maximum image cache size in KB.<p>
  86. <dt><tt><b>long MaxPageLoads</b></tt><dd>Maximum number of concurrent page loads allowed.<p>
  87. <dt><tt><b>long MarginHorizontal</b></tt><dd>The horizontal margin in pixels.<p>
  88. <dt><tt><b>long MarginVertical</b></tt><dd>The top margin in pixels.<p>
  89. <dt><tt><b>BOOL LoadImages</b></tt><dd>Determines whether embedded images are loaded.<p>
  90. <dt><tt><b>BOOL ShowReferer</b></tt><dd>HTTP Referer header switch.<p>
  91. <dt><tt><b>CString AuthenticName</b></tt><dd>Name for Basic authenication.<p>
  92. <dt><tt><b>CString AuthenticPassword</b></tt><dd>Password for Basic authentication.<p>
  93. <dt><tt><b>CString FromName</b></tt><dd>HTTP From header field.<p>
  94. <dt><tt><b>CString BrowserName</b></tt><dd>HTTP User-Agent header field.<p>
  95. <dt><tt><b>long ButtonMask</b></tt><dd>Enables/disables title bar buttons:<p>
  96. 0x0001 - Home button mask<br>
  97. 0x0002 - Open button mask<br>
  98. 0x0004 - History button mask<br>
  99. 0x0008 - Check button mask<br>
  100. 0x0010 - Save button mask<br>
  101. 0x0020 - Back button mask<br>
  102. 0x0040 - Forth button mask<br>
  103. 0x0080 - StopGo button mask<br>
  104. 0x0100 - Movie button mask<br>
  105. 0x0200 - URL button mask<br>
  106. 0x0400 - Title display mask<br>
  107. <p>
  108. <dt><tt><b>CString ProxyServerHTTP</b></tt><dd>Proxy server name.<p>
  109. <dt><tt><b>long ProxyPortHTTP</b></tt><dd>Proxy server port.<p>
  110. </DL>
  111. <HR><A NAME="methods"></a><H4><U>Methods</U></H4>
  112. <dl>
  113. <dt><tt><b>void AboutBox()</b></tt><dd>Stock method.<p>
  114. <dt><tt><b>short DismissPage(LPCTSTR URL)</b></tt><dd>Remove the page from cache.<p>
  115. <dt><tt><b>long GetContentSize(LPCTSTR URL)</b></tt><dd>Byte count for the specified page, according to the header.<p>
  116. <dt><tt><b>long GetContentSizeRead(LPCTSTR URL)</b></tt><dd>Actual byte count available in the specified page.<p>
  117. <dt><tt><b>CString GetContentType(LPCTSTR URL)</b></tt><dd>The content type string for the page, from the header.<p>
  118. <dt><tt><b>CString GetContent(LPCTSTR URL, long StartOffset, long Length)</b></tt><dd>Retrieve a range of raw bytes from the page.<p>
  119. <dt><tt><b>short GetHiddenFlag(LPCTSTR URL)</b></tt><dd>Return the hidden state of the page.<p>
  120. <dt><tt><b>short SetHiddenFlag(LPCTSTR URL, BOOL Hidden)</b></tt><dd>Cause the specified page to be concealed or revealed.<p>
  121. <dt><tt><b>long GetLinkCount(LPCTSTR URL)</b></tt><dd>Return the number of hyperlinks in the page.<p>
  122. <dt><tt><b>CString GetLinkURL(LPCTSTR URL, long Index)</b></tt><dd>Get the specified URL from the page.<p>
  123. <dt><tt><b>CString GetRedirectedURL(LPCTSTR URL)</b></tt><dd>Final URL corresponding to the specified URL, after any redirection.<p>
  124. <dt><tt><b>short GetStatus(LPCTSTR URL)</b></tt><dd>Get a status code for the specified page (see LoadStatus).<p>
  125. <dt><tt><b>long GetTextSize(LPCTSTR URL)</b></tt><dd>Get the byte count of pure text, no tags.<p>
  126. <dt><tt><b>CString GetText(LPCTSTR URL, long StartOffset, long Length)</b></tt><dd>Extract pure text from the page, no tags.<p>
  127. <dt><tt><b>CString GetTitle(LPCTSTR URL)</b></tt><dd>Get the page title.<p>
  128. <dt><tt><b>short LoadPage(LPCTSTR URL, short Hidden)</b></tt><dd>Initiate a page load.<p>
  129. <dt><tt><b>void ShowDir()</b></tt><dd>Display the built-in directory page.<p>
  130. <dt><tt><b>void Refresh()</b></tt><dd>Stock method.<p>
  131. <dt><A NAME="buttonMethods"><em>These are the button-equivalent methods:</em></a><p>
  132. <dt><tt><b>void GoHome()</b></tt><dd>Display the page specified by the <tt><b>HomePage</b></tt> property.<p>
  133. <dt><tt><b>void ShowOpenFileDialog()</b></tt><dd>Display the Open File dialog box.<p>
  134. <dt><tt><b>void ShowURLDialog()</b></tt><dd>Display the URL entry dialog box.<p>
  135. <dt><tt><b>void ShowHistory()</b></tt><dd>Display the history page.<p>
  136. <dt><tt><b>void ShowStatus()</b></tt><dd>Display the status page.<p>
  137. <dt><tt><b>short SaveToDisk(LPCTSTR FileName)</b></tt><dd>Save the current page to disk, synthesizing a file name if necessary.  The
  138. file is written to the directory specified by the <tt><b>SaveDir</b></tt> property.<p>
  139. <dt><tt><b>void PageBack()</b></tt><dd>Display the previous page in the history list.<p>
  140. <dt><tt><b>void PageForth()</b></tt><dd>Display the next page in the history list.<p>
  141. <dt><tt><b>short Cancel()</b></tt><dd>Cancel the loading of the current (visible) page, if it is loading.  Harmless otherwise.<p>
  142. <dt><tt><b>short Reload()</b></tt><dd>Reload the current page.<p>
  143. </dl><p>
  144. <HR><A NAME="events"></a><H4><U>Events</U></H4>
  145. <dl>
  146. <dt><tt><b>void DoClickURL(BSTR* SelectedURL, BOOL* Cancel)</b></tt><dd>This event is fired when the user clicks on a hyperlink.
  147. An interested container may inspect the clicked URL in <tt><b>stringURL</b></tt> and take one of the following courses:<p>
  148. <ul>
  149. <li> Do nothing, and the page specified by the URL will be loaded.
  150. <li> Set the <tt><b>boolCancel</b></tt> argument to TRUE (non-zero), causing the user click to be ignored.
  151. <li> Replace the contents of <tt><b>stringURL</b></tt> with another URL, which will be loaded instead.
  152. </ul>
  153. <p>
  154. <dt><tt><b>void DoLoadImage(BSTR* ImageURL, BOOL* Cancel)</b></tt><dd>Presents image URL to the
  155. container -- set Cancel to TRUE to cancel the load.<p>
  156. <dt><tt><b>void HyperlinkTransition(BSTR* URL, boolean IsOverLink)</b></tt><dd>Fired when the
  157. mouse enters or exits a hyperlink zone.  When IsOverlink is TRUE, the hyperlink is specified by URL.<p>
  158. <dt><tt><b>void KeyDown(short* KeyCode, short Shift)</b></tt><dd>Stock event.<p>
  159. <dt><tt><b>void LoadComplete(BSTR* URL, short Status)</b></tt><dd>When a page load is finished,
  160. this event conveys the load status.<p>
  161. <dt><tt><b>void MouseDown(short Button, short Shift, long xPixel, long yPixel)</b></tt><dd>Stock event.<p>
  162. <dt><tt><b>void MouseMove(short Button, short Shift, long xPixel, long yPixel)</b></tt><dd>Stock event.<p>
  163. <dt><tt><b>void MouseUp(short Button, short Shift, long xPixel, long yPixel)</b></tt><dd>Stock event.
  164. </dl>
  165. <HR>
  166. The VCI WebViewer Control was created by 
  167. <a href="http://www.vpm.com/trafalmador/homepage.htm">Home Page Software.</a>
  168. </HTML>
  169.