Share via


Web Browser Control Foundation Class

This subclass of the Microsoft Internet Explorer browser control provides hooks for Visual FoxPro code and can be added to a Visual FoxPro form.

Category

Internet

Default Catalog

Visual FoxPro Catalog\Foundation Classes\Internet

Class

_Webbrowser4

Class Library

_webview.vcx

Parent Class

olecontrol

Sample

...\Samples\Solution\Ffc\Webvwr.scx

Remarks

To use, drop the class on a project or form or, from the Component Gallery Item shortcut menu, select Add to Project or Add to Form. When you add the class to a form, Visual FoxPro places an Internet Explorer logo on your form. You need to specify an appropriate URL in the Navigate method. When you drop the class on a project, you can choose between adding the class or creating a subclass.

See Guidelines for Using Visual FoxPro Foundation Classesfor more information on using foundation classes.

Properties, Events, Methods

Description

aHistory[1,2] property

URL address history array.

Default: .F.

aParam[1,0] property

URL parameters array.

Default: .F.

aScripts[1,0] property

Visual FoxPro scripts array.

Default: .F.

cAlias property

Returns the table alias of the currently selected. Set automatically when using the OpenTable method.

Default: ""

cBeforeURL property

Specifies the current URL before a document is fully retrieved.

Default: ""

cBlankHTMLFile property

Specifies a blank .htm file.

Default: Blank.htm

cDBF property

Returns the file name of currently selected table. Set automatically when using the OpenTable method.

Default: ""

cDBFPath property

Returns the path of the currently selected table. Set automatically when using the OpenTable method.

Default: ""

cFilename property

Returns the file name of the current document.

Default: ""

cFilepath property

Returns the path of the current document.

Default: ""

cLasturl property

Specifies the last URL.

Default: ""

cNewURL property

Specifies the URL before the document is fully retrieved.

Default: ""

cParam property

Specifies the URL parameter string.

Default: ""

cParamdelimiter property

Specifies the URL parameter delimiter character.

Default: &

cParseFileExt property

File extension list of the file to parse in pre-processing mode.

Default: htm;html;asp

cProgramPath property

Specifies the Web browser control class path.

Default: ""

cSourceFile property

Specifies the file name of current document.

Default: ""

cSourceFilename property

Specifies the file name of current source document.

Default: ""

cSourceFilepath property

Specifies the path of current source document.

Default: ""

cSourceHTML property

Specifies the HTML text of the current source document.

Defaul t: ""

cSourceURL property

Specifies the URL of the current source document.

Default: ""

cTempFilename property

Specifies the file name of the temporary file document.

Default: ""

cTempFilePrefix property

Prefix used for the file name of the temporary file document.

Default: _temp

cURL property

Current URL.

Default: ""

cUserID property

User ID, user-defined, not used internally.

Default: ""

cUserName property

User name, user defined, not used internally.

Default: ""

cVersion property

Specifies the version of the Web browser control subclass.

Default: "Web Browser 04.01.0006"

cVFPScript property

Specifies the Visual FoxPro script program file name.

Default: ""

cVFPScriptTable property

Specifies the Visual FoxPro script table file name.

Default: ""

cVFPSprotocol property

Specifies the default Visual FoxPro script protocol string.

Default: vps:

lBlankHTMLStartup property

Specifies whether the browser starts with a blank startup Web page.

Default: .F.

lBusy property

Web browser busy mode.

D efault: .F.

lDebug property

Specifies whether the Web browser runs in Debug mode.

Default: .F.

lDesign property

Specifies whether the Web browser runs in design mode.

Default: .F.

lDHTML property

Specifies whether the Web browser supports dynamic HTML.

Default: .T.

lHistoryEnabled property

Specifies whether URL history tracking is enabled.

Default: .F.

lParseSource property

Specifies whether Parse document source mode is enabled.

Default: .F.

lRefresh property

Specifies whether the control is refreshed when the Refresh method runs.

Default: .F.

lRefreshDeactivate property

Specifies whether auto-execution of the RefreshDeactivate method for the LostFocus event is enabled.

Default: .F.

lRefreshMode property

Specifies whether Refresh document mode is enabled.

Default: .F.

lRelease property

Specifies whether the object's Release method has been executed and the object is in the process of being released from memory.

Default: .F.

lRunCodeMode property

Specifies whether Run code mode is enabled.

Default: .F.

lVFPsScript property

Specifies whether Visual FoxPro script mode is enabled.

Default: .F.

lViewSourceMode property

Specifies whether View source mode is enabled.

Default: .F.

nDataSessionID property

Specifies the data session number of the table alias of the currently selected table that was set automatically when using the OpenTable method.

Default: 0

nHistoryCount property

Specifies the length of the URL history array.

Default: 0

nParamCount property

Specifies the length of the URL parameter array.

Default: .F.

nRecno property

Specifies the current record number of the currently selected table that was set automatically when using the OpenTable method.

Default: 0

nScriptCount property

Specifies the length of the Visual FoxPro script array.

Default: 0

nUserLevel property

Specifies the user level, user defined, not used internally.

Default: 0

oAction property

Specifies the user action object, user defined, not used internally.

Default: .NULL.

oHost property

Specifies the host form – equivalent to THISFORM.

Default: .NULL.

oSource property

Specifies the source object, user defined, not used internally.

Default: .NULL.

oUser property

Specifies the user object, user defined, not used internally.

Default: .NULL.

uResult property

Specifies the variant result value.

Default: .T.

uReturn property

Specifies the variant return value.

Default: .T.

uValue property

Specifies the variant value, user defined, not used internally.

Default: .T.

AddProp method

Adds a new property.

Syntax: AddProp(tcName, tcProperty, tuValue)

Arguments: tcName specifies tcProperty specifies the name of the property.tuValue specifies the value to assign to the property.

BeforeNavigate method

Provides a BeforeNavigate event.

Syntax: BeforeNavigate(URL, flags, targetframename, postdata, headers, cancel)

Arguments: URL specifies the Web page to use.flags specifies whether to add the resource to the history list, to read or write from the cache, display the resource in a new window or a combination of these.targetframename specifies the name of the target frame.postdata specifies data to send to the HTTP Post transaction.headers specifies the HTTP headers to send.cancel specifies whether navigation was cancelled.

BeforeRetrieval method

Identifies the event to run before retrieval.

Syntax: BeforeRetrieval(URL, flags, targetframename, postdata, headers, cancel)

Arguments: URL specifies the Web page to use.flags specifies whether to add the resource to the history list, to read or write from the cache, display the resource in a new window or a combination of these.targetframename specifies the name of the target frame.postdata specifies data to send to the HTTP Post transaction.headers specifies the HTTP headers to send.cancel specifies whether navigation was cancelled.

BrowseTable method

Browse the currently selected based on cAlias.

Syntax: BrowseTable(tcAlias, tcClauses)

CloseTable method

Close the currently selected based on cAlias.

Syntax: CloseTable(tcAlias)

EditScript method

Edit a specific Visual FoxPro script.

Syntax: EditScript(tcScriptName)

Arguments: tcScriptName specifies the name of the Visual FoxPro script.

EditString method

Opens a string in an edit window.

Syntax: EditString(tcString, tcTitle, tlNoEdit)

Arguments: tcString specifies the string to edit.tcTitle specifies the name of the edit window.tlNoEdit specifies whether string is editable.

EraseTempFile method

Specifies whether to erase the current temporary file.

Syntax: EraseTempFile( )

Ret urn: none

Arguments: none

FileToString method

Returns the string contents of a file.

Syntax: FileString(tcFileName)

Arguments: tcFileName specifies the name of the file from which to extract the string.

FrameBeforeNavigate method

Provides a FrameBeforeNavigate event.

Syntax: FrameBeforeNavigate(URL, flags, targetframename, postdata, headers, cancel)

Arguments: URL specifies the Web page to use.flags specifies whether to add the resource to the history list, to read or write from the cache, display the resource in a new window or a combination of these.targetframename specifies the name of the target frame.postdata specifies data to send to the HTTP Post transaction.headers specifies the HTTP headers to send.cancel specifies whether navigation was cancelled.

GetHTML method

Returns the HTML of the current document.

Syntax: GetHTML(tcName, tcAlias)

Arguments: tcName specifies the name of the document to return.tcAlias specifies the alias of cVFPScriptTable.

GetSourceFile method

Returns the file name of the current source document.

Syntax: GetSourceFile( )

Arguments: none

GetSourceHTML method

Returns the HTML of the current source document.

Syntax: GetSourceHTML( )

Arguments: none

GoBack method

Executes a hyperlink jump backward within the history list.

Syntax: GoBack( )

Return: none

Arguments: none

GoForward method

Executes a hyperlink jump forward within the history list.

Syntax: GoForward( )

Return: none

Arguments: none

Msgbox method

Message box handler method.

Syntax: Msgbox(tcMessage, tnType,tcTitle)

Arguments: tcMessage specifies the message to display.tnType specifies the messagebox type.tcTitle specifies the title of the messagebox.

NavigateComplete method

Provides a NavigateComplete event.

Syntax: NavigateComplete(URL)

Arguments: URL specifies the Web page to navigate.

NewWindow method

Provides a NewWindow event.

Syntax: NewWindow(URL, flags, targetframename, postdata, headers, processed)

Arguments: URL specifies the Web page to use.flags specifies whether to add the resource to the history list, to read or write from the cache, display the resource in a new window or a combination of these.targetframename specifies the name of the target frame.postdata specifies data to send to the HTTP Post transaction.headers specifies the HTTP headers to send.cancel specifies whether navigation was cancelled.

OpenTable method

Opens the specified table and activates it as the current table by setting the cAlias property.

Syntax: OpenTable(tcFileName, tcAlias,tlExclusive, tcFilter)

Arguments: tcFileName specifies the name of the table to open.tcAlias the alias of the table.tlExclusive specifies whether to open the table EXCLUSIVE.tcFilter specifies a filter expression to use.

OpenVFPScript method

Opens the Visual FoxPro script table.

Syntax: OpenVFPScript( )

ParseSource method

Parses the source code of the HTML document.

Syntax: ParseSource(URL, flags, targetframename, postdata, headers, cancel)

Arguments: URL specifies the Web page to use.flags specifies whether to add the resource to the history list, to read or write from the cache, display the resource in a new window or a combination of these.targetframename specifies the name of the target frame.postdata specifies data to send to the HTTP Post transaction.headers specifies the HTTP headers to send.cancel specifies whether navigation was cancelled.

RefreshDeactivate method

Use when losing focus of the Web browser control.

Syntax: RefreshDeactivate( )

Arguments: none

RefreshMode method

Set refresh mode.

Syntax: Refresh( )

Arguments: none

RefreshSource method

Refresh the source.

Syntax: RefreshSource( )

Return: none

Arguments: none

ReleaseHost method

Release the host form.

Syntax: ReleaseHost( )

Arguments: none

RunAction method

Run action that is a specific method of the object referenced by the oAction property.

Syntax: RunAction(tcMethod)

Arguments: tcMethod specifies the method to run.

RunCode method

Run a specific block of Visual FoxPro code without compilation.

Syntax: RunCode(tcCode)

Arguments: tcCode specifies the Visual FoxPro code to run.

RunScript method

Run a specific Visual FoxPro script.

Syntax: RunScript(tcScript, tcAlias)

Arguments: tcScript specifies the script to run.tcAlias specifies the alias of the file containing tcScript.

SetBusyState method

Set busy state method.

Syntax: SetBusyState(tlBusy)

Arguments: tlBusy specifies whether a download is in process.

SetParam method

Set URL parameters method.

Syntax: SetParam(tcParam)

Arguments: tcParam

SkipRecord method

Skip record of currently selected table, based on cAlias.

Syntax: SkipRecord(tnRecords)

Arguments: tnRecords specifies the number of records to skip.

StringToFile method

Saves string contents to file.

Syntax: StringToFile(tcText, tcFileName)

Arguments: tcText specifies the text to save.tcFileName specifies the target file.

TrimExt method

Returns a file name without extension.

Syntax: TrimExt(tcFileName, tlPlatformType)

Return: cFilename

Arguments: tcFileName specifies the filename to process.tlPlatformType specifies whether a file is from a DOS or Unix computer.

TrimFile method

Returns the path of the specified file name.

Syntax: TrimFile(tcFileName, lPlatType)

Arguments: tcFileName specifies the name of the target file.lPlatType specifies whether a file is from a DOS or Unix computer.

TrimPath method

Returns the file name without a path.

Syntax: TrimPath(tcFileName, tlTrimExt, tlPlatformType)

Arguments: tcFileName specifies name of the file.tlTrimExt specifies whether to remove the extension.tlPlatformType specifies whether a file is from a DOS or Unix computer.

ValidateURL method

Validates the URL.

Syntax: ValidateURL(tcURL)

Arguments: tcUrl specifies the Web page to validate.

ValidURL method

Returns the validated URL.

Syntax: ValidURL(tcURL)

Arguments: tcUrl specifies the Web page to return.

VFPS method

Executes a Visual FoxPro script based on the specified URL.

Syntax: VFPS(tcCommand)

Arguments: tcCommand specifies the Visual FoxPro expression to run.

VFPScript method

Executes a specific Visual FoxPro script.

Syntax: VFPScript(tcName, tcAlias, tnCode)

Arguments: tcName specifies the name of the file cVFPScript.tcAlias specifies the alias of cVFPScriptTable.tnCode specifies the Visual FoxPro code to run.

ViewSource method

View the source of the current document.

Syntax: ViewSource(tlNoWait, tlNoEdit)

Arguments: tlNoWait specifies whether the program pauses while the window displays.tlNoEdit specifies whether the viewed source is editable.

WaitWindow method

Wait window wrapper method.

Syntax: WaitWindow(tcText, tlWait)

Arguments: tcText specifies the text that displays in the Wait Window.tlWait specifies whether the program pauses while the window displays.

WildcardMatch method

Returns true (.T.) if the wild card string is matched to a specific string.

Syntax: WildcardMatch(tcMatchExpList, tcExpressionSearched, tlMatchAsIs)

Return: lMatch

Arguments: tcMatchExpList specifies the search expression.tcExpressionSearched specifies the target expression.tlMatchAsIs specifies whether to enforce an exact string match.

See Also

Concepts

Guidelines for Using Visual FoxPro Foundation Classes

Reference

Visual FoxPro Foundation Classes A-Z

Other Resources

Foundation Class Samples