documentation.help · BasicList ListFields Web Lists NavigationNode WebFile NavigationNodes...

FrontPageWebObjectModelApplicationSystem ThemesTheme

WebsWebListsNavigationNodeWebFileMetaTags

NavigationNodesPropertiesWebFilesWebFileMetaTags

WebFolderListListFields

WebFolders

WebWindowsWebWindowPageWindowsPageWindowWebFile

WebListsNavigationNodeNavigationNodesPropertiesWebFilesWebFolderWebFolders

Legend

ObjectandcollectionObjectonly

OthernotablemembersoftheFrontPageobjectmodel.

BasicListListFieldsWebListsNavigationNodeWebFile

NavigationNodesPropertiesThemesTheme

WebFilesWebFile

WebFoldersWebWindowsWebWindow

WebFolderListPropertiesWebFilesWebFile

WebFolders

DocumentLibraryListFieldsWebListsNavigationNodeWebFile

NavigationNodesPropertiesThemesTheme

WebFilesWebFile

WebFoldersWebWindowsWebWindow

WebFolderListPropertiesWebFilesWebFile

WebFolders

PageWindowExWebListsNavigationNodeNavigationNodesPropertiesThemes

WebFilesWebFolder

WebFoldersWebWindows

WebFileMetaTagsNavigationNode

Properties

NewWebObjectModelObjectsVisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetworkWebsiteforthelatestinformationaboutprogrammingwithMicrosoftOfficeFrontPage2003,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistsobjectsaddedtotheOfficeFrontPage2003objectmodel.

Object Description

Discussion ContainsinformationaboutaDiscussionlistinaMicrosoftFrontPageWebsite.

ListFieldAttachmentsContainsinformationabouttheattachmentsfieldwhenattachmentsareenabledforalistinaFrontPageWebsite.

ListFieldRatingScale ContainsinformationabouttheratingscalelistfieldforasurveylistinaFrontPageWebsite.

WebPackage RepresentsaWebpackagethathasbeencreatedinMicrosoftVisualBasicforApplications.

NewWebObjectModelProperties(AlphabeticalList)VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetworkWebsiteforthelatestinformationaboutprogrammingwithMicrosoftOfficeFrontPage2003,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistspropertiesaddedtotheOfficeFrontPage2003objectmodel(sortedalphabetically).

NewProperty Object(s)

AllowAttachments BasicList,DocumentLibrary,List,Survey,Discussion

AllowFillInChoices ListFieldChoice

AllowModerate BasicList,DocumentLibrary,List,Survey,Discussion

AllowRichHTML ListFieldMultiLineAuthor WebPackageCompany WebPackageComputationFormula ListFieldComputedDynamicTemplate WebFileEndNumber ListFieldRatingScale

IsHidden BasicList,DocumentLibrary,List,Survey,Discussion

IsModified BasicList,DocumentLibrary,List,Survey,Discussion

OptimizeHTMLFlags ApplicationOptimizeHTMLPublishFlagsWeb,WebExReturnType ListFieldComputedStartNumber ListFieldRatingScaleSubject WebPackage

NewWebObjectModelProperties(byObject)VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetworkWebsiteforthelatestinformationaboutprogrammingwithMicrosoftOfficeFrontPage2003,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistspropertiesaddedtotheOfficeFrontPage2003objectmodel(sortedbyobjectname).

Object NewPropertiesOptimizeHTMLFlags

BasicList AllowAttachments,AllowModerate,IsHidden,IsModified

Discussion AllowAttachments,AllowModerate,IsHidden,IsModified

DocumentLibrary AllowAttachments,AllowModerate,IsHidden,IsModified

List AllowAttachments,AllowModerateListFieldChoice AllowFillInChoicesListFieldComputed ComputationFormula,ReturnTypeListFieldMultiLine AllowRichHTMLListFieldRatingScale EndNumber,StartNumberList IsHidden,IsModified

Survey AllowAttachments,AllowModerate,IsHidden,IsModified

WebEx OptimizeHTMLPublishFlagsWebFile DynamicTemplateWeb OptimizeHTMLPublishFlagsWebPackage Author,Company,Subject

NewWebObjectModelMethods(AlphabeticalList)VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetworkWebsiteforthelatestinformationaboutprogrammingwithMicrosoftOfficeFrontPage2003,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistsmethodsaddedtotheOfficeFrontPage2003objectmodel(sortedalphabetically).

NewMethod ObjectApplyDynamicTemplate WebFile

ConvertToField

ListField,ListFieldChoice,ListFieldComputed,ListFieldCounter,ListFieldCurrency,ListFieldDateTime,ListFieldFile,ListFieldInteger,ListFieldLookup,ListFieldMultiLine,ListFieldNumber,ListFieldSingleLine,ListFieldTrueFalse,ListFieldURL,ListFieldAttachments,ListFieldRatingScale

CreateDynamicTemplateState ApplicationCreatePackage Web,WebExCreateSearchInfo ApplicationDecodeURL ApplicationEncodeURL ApplicationImportWebPackage Web,WebExRemove WebPackageShowBordersShadingDialog ApplicationShowFontDialog ApplicationShowHTMLDialog ApplicationShowHyperlinkParameters Application

ShowImportWebPackageDialog ApplicationShowPickURLDialog ApplicationShowPositionDialog ApplicationSplitArgs ApplicationUpdateDynamicTemplate Web,WebEx,WebFile

NewWebObjectModelMethods(byObject)VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetworkWebsiteforthelatestinformationaboutprogrammingwithMicrosoftOfficeFrontPage2003,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistsmethodsaddedtotheOfficeFrontPage2003objectmodel(sortedbyobjectname).

NewMethod ObjectDecodeURL

Application

CreateDynamicTemplateState,CreateSearchInfo,EncodeURL,ShowBordersShadingDialog,ShowFontDialog,ShowHTMLDialog,ShowHyperlinkParameters,ShowImportWebPackageDialog,ShowPickURLDialog,ShowPositionDialog,SplitArgs

ListFieldAttachments ConvertToFieldListFieldChoice ConvertToFieldListFieldComputed ConvertToFieldListField ConvertToFieldListFieldCounter ConvertToFieldListFieldCurrency ConvertToFieldListFieldDateTime ConvertToFieldListFieldFile ConvertToFieldListFieldInteger ConvertToFieldListFieldLookup ConvertToFieldListFieldMultiLine ConvertToFieldListFieldNumber ConvertToFieldListFieldRatingScale ConvertToField

ListFieldSingleLine ConvertToFieldListFieldTrueFalse ConvertToFieldListFieldURL ConvertToFieldWeb CreatePackage

WebEx CreatePackage,ImportWebPackage,UpdateDynamicTemplate

WebFile ApplyDynamicTemplate,UpdateDynamicTemplateWeb ImportWebPackageWebPackage RemoveWeb UpdateDynamicTemplate

CreatingWebSitesSomeofthecontentinthistopicmaynotbeapplicabletosomelanguages.

MicrosoftFrontPagemakesFrontPage-basedWebsitecreationaseasyascreatinganewfolderonyourharddrive.ThekeytosuccessfulWebsitemanagementinFrontPageisplanningthestructureanddesignofyourWebsites.WithmostWebservers,youhaveoneWebsite,butwithFrontPage,youcancreateasmanyWebsitesasyouwant,includingnestedWebsites,calledsubsites.AFrontPage-basedWebsitecomprisesthreelayers—Websitestructure,folderstructure,andnavigationstructure.Clickoneofthelinksbelowtoselectaspecifictopic.

UnderstandingFrontPageWebstructure

UnderstandingFrontPagefolderstructure

Understandingnavigationstructure

CreatingWebsitesprogramatically

CreatingaWebsitewiththeAddmethod

CreatingaWebsitewiththeMakeWebmethod

UnderstandingFrontPageWebstructure

AnyfolderonyourWebservercanbeaWebsitewithitsownfolderhierarchythatcanincludesubsitesbelowtheoriginalWebsite.WhenyouinstallFrontPage,theprogramautomaticallyprovidesadefaultnameforyourmainWebsite.Onadisk-basedsystem,thedefaultnameisC:\DocumentsandSettings\username\MyDocuments\MyWebSitesforMicrosoftWindowsXP.Youmaywanttonametheindividualsubsitesforthevariouscompanynamesthemselves,suchasAdventureWorks,AmericanSocietyofScience,MightyflightToys,orCohoWinery.

FrontPageprovidesavarietyofWebsitetemplates—corporate,discussion,customersupport,andsoon.ThesetemplatesprovidethefoundationofthestructureforeachWebsite.Forexample,AdventureWorksmaywantyoutoestablishafull-blowncorporatepresencefortheirWebsite;andsoon.TheWebsitehierarchyforadisk-basedWebsiteisshowninthefollowingdiagram.

ThefollowingfigureshowstheWebsitestructureinFoldersview.Thesubsitesdisplayasmallglobewithinthefoldericon.

UnderstandingFrontPagefolderstructure

ThefolderstructureinFrontPagebehavesinthesamemannerasthefolderstructureinWindowsExplorer.However,toaccessthesefilesfromWindowsExplorer,youhavetoexportthemtoanotherlocation—eitheryourharddriveorserver.Duringtheexportprocess,thefilesareconvertedtoHTMLpages.Inthatsense,openingFrontPageissimilartoopeningawindowtoyourWebsites.Thefolderhierarchyforadisk-basedWebsiteisshowninthefollowingdiagram.

ThefollowingdiagramshowsthefolderstructureinFoldersview.

NoteThisdiagramdisplaysthesameinformationasthepreviousonebecausebothfoldersandWebsitesaredisplayedinthesameview,butyoucanseefromtheWebsiteandfolderdiagramsthattheyeachhavetheirownstructure.AWebsiteorsubsiteisafolder.However,afolderthatisalsoaWebsitecontainsmetadataaboutthatWebsite.Forexample,ifyouapplyathemetooneofyourWebsites,allfolderswithinthatWebsitewillhavethesametheme.However,youcanapplydifferentthemestotheWebsitesonyourWebserver.WhenyouchangeaWebsitetoafolder,youremovespecialsettingsthatmakethatfolderaWebsite,andsettingssuchasthethemechangetomatchthe"global"themeforthedisk-basedorserver-basedWebsitethatprovidesthecontainerforyour

FrontPage-basedsubsites.

Understandingnavigationstructure

YoucancreatefileswithinyourWebsite,butthenavigationstructurethatlinksthesefilestoyourWebsiteisn'tautomaticallycreatedwhenthefilesarecreated.However,eachsubsitecanhaveitsownhomepage.AhomepageisusuallythestartingpageforanyWebsiteinthenavigationstructure;butinFrontPageyoucancreatealternatepagesthatexistatthesamenavigationlevelasthehomepage.Youmaywanttoaddlinkstoahomepagethatnavigatetothehomepagesofothersubsitesthatyou'remaintaining.

Thenavigationstructurecontainsnodesthatlinkeachofthepagesinyoursubsitesandprovidepointerstothelocationsofeachpageinthenavigationstructure.Thenavigationstructureforadisk-basedWebsiteisshowninthefollowingdiagram.

ThefollowingdiagramshowsthenavigationstructureinNavigationview.

CreatingWebsitesprogrammatically

Here'saverysimpledesignforaWebsite.TheCohoWinerycompanywantstoaddasubsitecalledWinesAroundtheWorldthatwillstartwithpagesfortworegions,SpainandFrance.ThefolderstructurewillcontaintheCohoWineryWebsiteandthefolderforthesubsite,WinesAroundtheWorld,plusthehiddenfolder_private,andanImagesfolder.ThenavigationstructurewillcontaintheWinesAroundtheWorldhomepage(index.htm)andthetwochildpages(Spain.htmandFrance.htm—theleftandrightnodesinthenavigationstructure).

TherearetwowaystocreateFrontPage-basedWebsitesinMicrosoftVisualBasicforApplications.YoucanusetheAddmethodwiththeWebscollection,oryoucanusetheMakeWebmethodwithaWebFolderobjecttochangeanexistingfolderintoaWebsite.

CreatingaWebsitewiththeAddmethod

Onceyou'vedesignedhowyourWebsiteisgoingtolookandfunction,youcanusetheSetstatementasshownintheprocedurebelowtocreateanewWebsite.

NoteToruntheexamplesinthistopic,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\CohoWinery",oryoumaysubstituteaWebsiteandfilesofyourchoice.

PrivateSubAdd()

DimmyNewWebAsWebEx

SetmyNewWeb=_

Webs.Add("C:\MyWebSites\CohoWinery\WinesAroundtheWorld")

EndSub

WhenyoucreateaWebsitewiththismethod,youonlycreatetheWebsiteanditsfolder;youdon'tcreateacompleteWebsitewithallofthefolders,pages,andnavigationinplace.Thenextstepisaddingahomepage.Thefollowingexampleaddsahomepage.

PrivateSubAdd()

DimmyNewWebAsWebEx

DimmyFilesAsWebFilesDimmyUrlAsString

SetmyNewWeb=_

SetmyFiles=myNewWeb.RootFolder.FilesmyFileUrl=_

"C:\MyWebSites\CohoWinery\WinesAroundtheWorld\index.htm"

myFiles.Add(myFileUrl)

EndSub

Becauseindex.htmordefault.htmarefilenamesassociatedwithnamescommonlyusedashomepages,FrontPagecreatestheappropriatenavigationstructureforahomepagewheneveryouuseoneofthesenames.However,ifyouaddfurtherpagesusingtheAddmethodwiththeWebFileobject,youwilladdpages,butFrontPagewillnotautomaticallycreatethenavigationstructureforyou—youwillhavetoaddthenavigationstructuremanuallyasisillustratedinthefollowingexample.

NoteThefollowingexamplecreatesanewsubsiteintheCohoWineryWebsite

andcreatestwopagesinthenewsubsite:index.htmandSpain.htm.

PrivateSubAddCompleteWeb()

DimmyNewWebAsWebEx

DimmyFilesAsWebFiles

DimmyUrlAsString

DimmyFileOneAsString

SetmyNewWeb=_

SetmyFiles=myNewWeb.RootFolder.Files

myFileUrl=_

myFileOne="C:\MyWebSites\CohoWinery\WinesAroundtheWorld\"

myFileOne=myFileOne&"Spain.htm"

myFiles.AddmyFileOne

CallmyNewWeb.HomeNavigationNode.Children.Add(myFileOne,"Spain",_

fpStructLeftmostChild)

myNewWeb.ApplyNavigationStructure

EndSub

Noticethelaststatement—theApplyNavigationStructuremethodappliesthechangesthatyou'vemadetothenavigationstructure.

ThereareseveralconstantsyoucanuseintheAddmethodfortheChildrenproperty:fpStructBaseOnSibling,fpStructLeftmostChild,andfpStructRightmostChild.Verysimply,theseconstantsinformFrontPagewhichpositionyouwanttoapplytothefileinthenavigationstructure—left,right,orbasethepositionononeofthesiblings.Here,myFileOnebecomestheleftmostchildofthehomepage.Thenextstepistoaddthenextpage,sothatyoucanviewthenavigationstructureinNavigationview.ThefollowingaddsanotherpageandnavigationnodetothepreviousWebsite.

PrivateSubAdd()

DimmyNewWebAsWebEx

DimmyFileUrlAsString

DimmyFileOneAsString

DimmyFileTwoAsString

SetmyNewWeb=_

SetmyFiles=myNewWeb.RootFolder.Files

myFileUrl=_

myFileOne="C:\MyWebSites\CohoWinery\WinesAroundtheWorld\"

myFileOne=myFileOne&"Spain.htm"

myFileTwo="C:\MyWebSites\CohoWinery\WinesAroundtheWorld\"

myFileTwo=myFileTwo&"France.htm"

myFiles.AddmyFileOne

myFiles.AddmyFileTwo

fpStructLeftmostChild)

fpStructRightmostChild)

myNewWeb.ApplyNavigationStructure

EndSub

YoucancontinuetoaddpagesandnavigationnodestoyourWebsiteinthiswayuntilyourWebsiteiscomplete.Or,youcancreateaForloopwhereyouiteratethroughtheWebsiteaddingthenumberofpagesandnavigationnodesyouneedtocompletetheWebsite.ThefollowingexampleaddsfivepagesandnavigationnodestoanewsubsiteintheCohoWineryWebsite.

NoteCreating,moving,ordeletingfilesandfolderswhileattemptingtomodifythenavigationstructuremaycausesomechangestobelost.First,makethechangestothefolderstructureoftheWebsite,thenmakethenavigationstructurechanges,andthenapplythenavigationstructuretotheWebsite.

PrivateSubAddDesignerCrystalWeb()

DimmyWebAsWebEx

DimmyParentWebAsWebEx

DimmyFoldersAsWebFolders

DimmyFolderAsWebFolder

DimmyNewFiles(4)AsWebFiles

DimmyChildNodeAsNavigationNode

DimmyNewFilenameAsString

DimmyFileURLAsString

DimmyCountAsInteger

DimmyBaseURLAsString

DimmyWebURLAsString

DimmyInputMsgAsString

DimmyExistAsBoolean

SetmyParentWeb=_

Webs.Open("C:/MyDocuments/MyWebSites/CohoWinery/")

myParentWeb.Activate

myBaseURL="C:/MyDocuments/MyWebSites/CohoWinery/"

myWebURL=myBaseURL&"CohoWineryDesignerCrystal"

myExist=False

myInputMsg=_

"Allfileswillhave"".htm""appended.Typeafilename:"

SetmyFolders=Webs(0).RootFolder.Folders

ForEachmyFolderInmyFolders

'ChecktoseeifmyWebURLalreadyexists.

IfmyFolder.IsWebAndmyFolder.Url=myWebURLThen

myExist=True

'CreatemyWebURLifitdoesn'texist.

IfmyExist=FalseThenWebs.Add(myWebURL).Activate

SetmyWeb=ActiveWeb

SetmyFiles=myWeb.RootFolder.Files

'Createfiles.

FormyCount=0ToUBound(myNewFiles)

myNewFilename=InputBox(myInputMsg)

myFileURL=myWeb.Url&"/"&myNewFilename&".htm"

myFiles.AddmyFileURL

myFiles(myFileURL).Edit

'Addtonavigationstructure.

FormyCount=0ToUBound(myNewFiles)

'Checkifthecurrentpageisindex.htm,ifso,skipit.

IfmyFiles(myCount).Title="index.htm"Then

myCount=myCount+1

SetmyChildNode=_

myWeb.RootNavigationNode.Children(0)

'Addnavigationnodetothecurrentpage.

myChildNode.Children.AddmyFiles(myCount).Url,_

myFiles(myCount).Title,fpStructLeftmostChild

myWeb.ApplyNavigationStructure

EndSub

CreatingaWebsitewiththeMakeWebmethod

Ifyoualreadyhaveanexistingfolderthatyou'dliketoconverttoaWebsite,youcanusetheMakeWebmethodwithaWebFolderobjectasshowninthefollowingexample.

NoteThefollowingexampleassumesthatWebs(0)istheCohoWineryWebsiteandthatitcontainsafoldercalledFolderOne.

PrivateSubMakeAWeb()

DimmyWebAsWebEx

SetmyWeb=Webs(0)

myWeb.Activate

SetmyFolder=ActiveWeb.RootFolder.Folders("FolderOne")

myFolder.MakeWeb

EndSub

YouwillneedtocreateanavigationstructureoncePageOneisasubsiteofCohoWinery.

ExploringProceduresThistopicisdesignedtogiveuserswhomaybefamiliarwithMicrosoftFrontPage,butunfamiliarwithMicrosoftVisualBasicforApplications(VBA),abackgroundonsomeofthebasicconceptsinaFrontPage-basedprogrammingenvironment.ProgramminginFrontPageVisualBasicforApplicationsprovidesyouwithHTMLtoolsinanMicrosoftOfficeprogrammingenvironmentwhereyoucancreateproceduresthatperformataskoraseriesoftasks.Forexample,youcould:

CreateaprocedurethatretrievesdatafromaMicrosoftAccessdatabaseanddisplaysthedataonyourWebpage.PublishaMicrosoftPowerPointpresentationforautomaticupdatesovertheInternet.AutomaticallyupdateaMicrosoftExcelspreadsheetwithinputfromusersrespondingtoyourWebsite.

ThistopicprovidesinformationonthefollowingVBAprogrammingconcepts.

Organizecodeformodularuse

Typesofprocedures

Publicandprivateprocedures

Typesofprocedurecalls

Eventproceduresandarguments

CreateatableinFrontPagefromanAccessdatabase

Organizecodeformodularuse

VisualBasicproceduresprovideawayfordeveloperstoorganizecodeformodularuse.Insteadofwritingthesamecalculatorfunctionoverandoverforeachprogram,youcantakethatsegmentofcode(thecalculatorfunction)andcompileitintoageneralprogram,thatcanthenbeaccessedbymanyotherprograms.InVisualBasic,ablockofcodeisenclosedbetweenaprocedureheadingandaclosurestatement—theSubandEndSubstatements.

ThebasicsyntaxofaprocedurewithinVisualBasicisshowninthefollowingcodesample.

[Private|Public|Static]Subprocedurename(arguments)

statements

EndSub

TorunanyofthecompletecodeexamplesincludedintheFrontPageVisualBasicforApplicationsonlinehelp,followthesesteps:

1. OpenFrontPage,selectMacrofromtheToolsmenu,andthenclickVisualBasicEditor.

2. Double-clickMicrosoft_FrontPage(orthecurrentproject)intheProjectwindowandexpandtheModulesfolder.

3. Double-clickModule1toopentheCodewindow.4. Copythecodeblockfromthedocumentation,andthenpasteitintothe

Codewindow.5. ClickRunSub/UserFormonthetoolbar.

YourcodewillautomaticallybesavedwhenyouclosetheVisualBasicEditor.

Typesofprocedures

FrontPageVBAprovidestwotypesofprocedures,SubandFunctionprocedures.Subproceduresperformtasksbutdonotreturnanyvalues.Theymaybecalledfromothersubroutinesorexecutedinresponsetoanevent,suchasamouseclickorakeystroke.

NoteASubprocedurecanbeaneventprocedure,butitcanalsoperformataskwithoutnecessarilyrespondingtoanevent.

ThefollowingprocedureretrievestheversionnumberofFrontPagefromtheactiveWebsitebutdoesn'treturntheversionnumbertoanyotherprocedure.

SubDisplayVersion()

DimmyWebAsWebEx

DimmyVersionAsString

myVersion="FrontPageversionnumber:"&ActiveWeb.Application.Version

EndSub

AFunctionprocedurealsoperformstasks,butitcaninadditionreturnoneormorevaluesasarguments.ThefollowingcodesamplereturnstheversionnumberofFrontPagetoacallingprocedure.

FunctionReturnVersion()AsVariant

DimvarAppVersionAsVariant

varAppVersion=Application.Version

ReturnVersion=varAppVersion

EndFunction

ThevariableReturnVersionnowcontainstheversionnumberofFrontPage.Toaccessthisvalueinthecallingprocedure,youcouldwritecodesimilartothefollowingsample.

SubGetAppVersion()

DimmyAppVersionAsVariant

MsgBox"ThisversionofFrontPageisversion"_

&ReturnVersion

EndSub

Alternatively,youcouldassigntheexpressionReturnVersiontoavariableand

appendthevariabletothemessageboxstatementinsteadofthefunctioncall.

BothSubandFunctionprocedurescanbecalledtoperformtheirtasks,dependingonwhethertheproceduresaredeclaredPublicorPrivate.

AmacroisathirdtermusedtodescribecodeinVBA.AsapublicSubprocedurethatdoesn'ttakearguments,amacromayormaynotcallotherSuborFunctionproceduresandcanbeassignedtocommandbarsandshortcutkeysorrunfromtheMacrodialogbox.

Publicandprivateprocedures

VisualBasicprovidestwowaystoaccessaprocedure.Bydefault,proceduresarepublic—theycanbecalledfromanyotherprocedureinanymodulewithinyourapplication.Forexample,ifyou'vewrittenaprocedurethatlistsimagesbyfilenameonaWebpage,youwouldwanttodeclarethatprocedurepublicsothatyoucoulduseitacrossallofyourWebsites.However,ifyou'vewrittenaprocedurethateditsaspecificdatabase,youwouldwantthatproceduretobeavailableonlytothemodulethathandleseditingthedatabase—inthatcase,youcandeclaretheprocedureprivate.Proceduresthathavebeendeclaredprivatecanonlybereferencedbyotherprocedureswithinthesamemodule.Thefunctionshownpreviouslyhasbeendeclaredapublicfunctioninthefollowingcodesampleandcanbecalledacrossmodulesandprojects.

PublicFunctionReturnVersion()AsVariant

statements

EndFunction

Incontrast,aprocedurethatisusedtoeditadatabaseshouldbedeclaredprivate.

PrivateFunctionEditCustomerName(strFirstNameAsString)

statements

EndFunction

Typesofprocedurecalls

Howdoyouprogrammaticallyrunaprocedure?Youdeclareitthesamewaythatyouwoulduseakeyword,suchasOpen.ThefollowingprocedurecallstheReturnVersionfunctionandassignsthereturnedvaluetoalocalvariable,MyVersion,forthevaluethatispassedtotheprocedure.

SubTestCall()

DimMyVersionAsVariant

MyVersion=ReturnVersion

EndSub

Ifyoudidn'thaveanyinformationtopassfromoneproceduretoanother,youwouldsimplydeclaretheprocedurename,asshowninthefollowingcodesample.

SubTestCall2()

DisplayCompanySplashScreen

EndSub

TheTestCall2procedurecallsanotherprocedure,DisplayCompanySplashScreen,whichdoesn'ttakeanyargumentsorreturnanyvalues.

Eventproceduresandarguments

Ifyouwantanevent,suchasclickingacommandbutton,totriggertheexecutionofcodeincaseswhereyouwouldusuallypassavalueintothecallingprocedure,youcanexecutetheresultsfromthefunctionratherthanreturntheresults.InthiscasetheReturnVersionfunctionbecomesasubroutineandinitiatesthedisplayoftheversionnumberfortheapplication.

SubReturnVersion()

DimvarAppVersionAsVariant

varAppVersion=Application.System.Version

DisplayMsgBoxvarAppVersion

EndSub

TheDisplayMsgBoxsubroutineshowninthefollowingcodesampledisplaysthecontentsofthevariablevarGotAppVersionthatwaspassedfromtheReturnVersionsubroutine.

SubDisplayMsgBox(varGotAppVersionAsVariant)

DimvarDisplayAppVersionAsVariant

varDisplayAppVersion=varGotAppVersion

MsgBox"Thisapplicationisversion"_

&varDisplayAppVersion

EndSub

AneventprocedurecannowinitiatethedisplayofthevaluethatispassedfromtheReturnVersionsubroutine.

PrivateSubCommandButton1_Click()

ReturnVersion

EndSub

CreateatableinFrontPagefromanAccessdatabase

ThefollowingprocedurecombinesobjectsfromthePageobjectmodelandtheWebobjectmodeltoretrievedatafromanopenMicrosoftAccessdatabaseandinsertitintoatableonaFrontPage-basedWebpage.TheParseDBTableprocedureprovidestheparametersfortheParseAccessTablefunctionwhichcallsthefollowingfunctionstocreateandpopulatethetable:

AddDBTableToPage—createsanewtableAddDBRow—insertsarowontotheWebpageAddMemo—retrievesthememosfromtheAccessdatabase,returnsthemasbookmarksatthebottomofthepagebelowthenewtable,andreturnstheURLtothebookmark

NoteTheAccessdatabase,Northwind.mdb,wasusedforthisexample.Toruntheexample,youmusthavereferencesintheVisualBasicEditortotheMicrosoftDAO3.6ObjectLibraryandtheMicrosoftAccessObjectLibrary.YoumustalsoopenanAccessdatabasebeforerunningtheexample,andyoumustaddablanktemporaryfilecalledtmp.htmintheactiveWebsite.IfyouuseadatabaseotherthanNorthwind.mdb,youmustspecifythedatabasenameandtableintheParseDBTableprocedure.

FunctionAddDBTableToPage(myPageAsPageWindowEx,_

myTableNameAsString,myFieldsAsInteger)

DimmyTableAsFPHTMLTable

DimmyHTMLStringAsString

DimmyCountAsInteger

myHTMLString="<tableborder=""2""id=""myRecordSet_"&_

myTableName&""">"&vbCrLf

myHTMLString=myHTMLString&"<tr>"&vbCrLf

FormyCount=1TomyFields

myHTMLString=myHTMLString&"<tdid=""myDBField_"&_

myCount&"""></td>"&vbCrLf

NextmyCount

myHTMLString=myHTMLString&"</tr>"&vbCrLf

myHTMLString=myHTMLString&"</table>"&vbCrLf

CallmyPage.Document.body.insertAdjacentHTML("BeforeEnd",_

myHTMLString)

EndFunction

FunctionAddDBRow(myDBTableAsFPHTMLTable)

DimmyTableRowAsFPHTMLTableRow

SetmyTableRow=myDBTable.rows(0)

myHTMLString=myTableRow.outerHTML

CallmyDBTable.insertAdjacentHTML("BeforeEnd",myHTMLString)

EndFunction

FunctionAddMemo(myCurrentPageAsPageWindowEx,myDBMemoAsString,_

myBkMarkFieldAsString,myIndex)AsString

DimmyMemoBkMarkAsString

DimmyBookMarkAsFPHTMLAnchorElement

myMemoBkMark=myBkMarkField&"_"&myIndex

myHTMLString="<aname="""&myMemoBkMark&""">Memo#"&_

myIndex&"</a>"&vbCrLf

'Addthebookmarktothepage.

CallmyCurrentPage.Document.body.insertAdjacentHTML("BeforeEnd",_

myHTMLString)

SetmyBookMark=myCurrentPage.Document.all(myMemoBkMark)

'Addthememotexttothepage.

CallmyCurrentPage.Document.body.insertAdjacentHTML("BeforeEnd",_

myDBMemo)

AddMemo="<ahref=""#"&myBookMark.Name&""">"

EndFunction

FunctionParseAccessTable(myDBNameAsString,myTableNameAsString)

'Access/DAODeclarations.

DimmyDBAppAsAccess.Application

DimmyRecordSetAsDAO.recordset

DimmyDBFieldAsDAO.Field

'FrontPagePageobjectmodeldeclarations.

DimmyPageAsPageWindowEx

DimmyTableRowAsFPHTMLTableRow

DimmyTableCellAsFPHTMLTableCell

'Functiondeclarations.

DimmyCountAsInteger

DimmyFieldValueAsString

DimmyRecordCountAsInteger

myRecordCount=0

'Functionconstants.

ConstmyTempPage="tmp.htm"

'GetthecurrentAccessdatabase.

OnErrorGoToAccessNotThereYet

SetmyDBApp=GetObject(,"Access.Application")

'Getthedatabasetable.

OnErrorResumeNext

SetmyRecordSet=myDBApp.CurrentDb.OpenRecordset(myTableName)

'AddanewpagetothecurrentWebsite.

SetmyPage=ActiveWeb.LocatePage(myTempPage)

myPage.SaveAsmyTableName&".htm"

'DeletethetemporaryfilefromWebsite.

ActiveWeb.LocatePage(myTempPage).File.Delete

'Addadatabase-readytabletothepagewiththepropernumberoffields.

AddDBTableToPagemyPage,myTableName,myRecordSet.Fields.Count

'Getareferencetothetable.

SetmyTable=myPage.Document.all.tags("table").Item(0)

'Populatethefirstrow.

FormyCount=0TomyRecordSet.Fields.Count-1

myTable.rows(0).cells(myCount).innerHTML="<b>"&_

Trim(myRecordSet.Fields(myCount).Name)&"</b>"

'Populatetherestofthetable.

WhileNot(myRecordSet.EOF)

AddDBRowmyTable

SetmyTableRow=myTable.rows(myTable.rows.Length-1)

FormyCount=0TomyRecordSet.Fields.Count-1

SetmyTableCell=myTableRow.cells(myCount)

IfIsNull(myRecordSet.Fields(myCount))Then

myFieldValue="None"

myFieldValue=Trim(myRecordSet.Fields(myCount).Value)

IfmyRecordSet.Fields(myCount).Type=DAO.dbMemoThen

myFieldValue=AddMemo(myPage,_

myRecordSet.Fields(myCount).Value,_

myRecordSet.Fields(myCount).Name,myRecordCount)

myTableCell.innerHTML=myFieldValue

NextmyCount

myRecordSet.MoveNext

myRecordCount=myRecordCount+1

myPage.Save

myDBApp.Quit

ExitFunction

AccessNotThereYet:

Debug.PrintErr.Number&":"&Err.Description

Resume

EndFunction

PrivateSubParseDBTable()

CallParseAccessTable("Northwind.mdb","Products")

EndSub

SharingProgrammingProjectsMicrosoftFrontPagedoesn'tprovidetheabilitytocreatemultipleprojects,sosharingaprojectmaybealittleconfusingatfirstglance.YoucanshareyourMicrosoftFrontPageprojectsusingoneofthefollowingtwomethods:

AsaComAddIn.Byexportingthe.bas,.cls,and.frmmodulestoadirectoryonyourharddrive(oraserverlocation)sothattheusercanimportthemodulestotheirprojectinFrontPage.

SharingasaCOMAddIn

ForadetaileddescriptionofhowtodevelopaCOMadd-inforFrontPage,seetheFrontPageSoftwareDeveloperKit,whichyoucanviewonlineordownloadfromtheMicrosoftDeveloperNetworkWebsite.

Sharingbyexportingtheproject

YoucanexportyourmodulesfromtheVisualBasicEditorbyselectingthemoduleintheProjectwindowandthenpointingtoExportFileontheFilemenu.IntheExportFiledialogbox,selectthedirectoryyouwantthefiletoresideinandFrontPagetakescareoftherest.

NoteWhenexportingUserFormfiles,youmustalsoincludethe.frxfile.Thisfileisusedduringtheimportprocessanddoesnotneedtobeimported,butdoesneedtobeavailableinthesamedirectoryastheothermodules.

UnderstandingAbsoluteandRelativeURLAddressinginMicrosoftFrontPageMicrosoftFrontPageusesabsoluteURLaddressing.However,FrontPagedoesprovideawaytochangetheaddressingofURLsbetweenabsoluteandrelativeaddressingthroughtheMakeRelandMakeAbsmethods.

WhatisanabsoluteURL?

AURLdefinesthelocationofanobject.WhenaURLisabsolute,itdefinesunambiguouslywheretheobjectislocated.Forexample,http://www.microsoft.com/FrontPage/default.htmistheexactlocationofthewelcomepageforMicrosoftFrontPage.Theobject,default.htm,isstoredintheFrontPagefolderorWebsubsiteontheWebserver,www.microsoft.com.

Adisk-basedWebsitethatcontainsyourWebsitesonyourharddrivemighthaveabaseabsoluteURLsuchasfile:///C:/MyDocuments/MyWebSites,file:///C:/WINNT/Profiles/yourlogonalias/Personal/MyWebSites/index.htm,orfile:///C:/DocumentsandSettings/yourlogonalias/MyDocuments/MyWebSites.

AsWebsitesareupdatedandthestructureofaWebsiteevolves,documentscanoftenbemovedfromonelocationtoanotherinaWebsite.Ifyou'reusingarelativeaddress,youmaybreaksomelinks.Forexample,ifyouhaveadocumentthathasahyperlinktoanobject,youcanuseanabsoluteURLtoensurethatthehyperlinkalwaysreferstothatobject.Forexample,adocumentsuchasfile:///C:/MyDocuments/MyWebs/mydocument.htm,maycontainanabsoluteURLthatreferstothewelcomepage,http://www.microsoft.com/FrontPage/default.htm.Ifthedocument,default.htm,ismovedtoanotherlocation,theabsoluteURLforthedocumentwillalwaysrefertotheobjectontheWebserveratwww.microsoft.cominthesubsitenamedFrontPage.IftheURLforthehyperlinktodefault.htmisarelativeaddress,thelinkcouldbebrokenifmydocument.htmismovedtoadifferentsubsiteormainWebsite.

WhatisarelativeURL?

InsteadofspecifyingeverypieceofaURLthatfullydefineshowtofindanobject,youcanabbreviateaURLtomakeit"relative"toacurrentlocation.RelativeURLsaretypicallyusedwhencreatingaWebsiteinwhichthepagesinitrefertootherpagesonthesite.Apagesuchasfile:///C:/MyDocuments/MyWebSites/mydocument.htmcanhavearelativeURLto"newdocument.htm"orto"../MyWebSites2/default.htm".Inthesetwocases,thereferredaddressesforthesefilesarefile:///C:/MyDocuments/MyWebSites/newdocument.htmandfile:///C:/MyDocuments/MyWebSites2/default.htm.NoticethatthefullWeb

serverorexplicitdirectoryisn'tspecified;thelocationisbasedonwherethedocumentislocated.

RelativeURLsareveryuseful,particularlywhenconstructingasiteinoneplaceandthenpublishingittoanotherplace.Forexample,youmightnotwanttospecifyaservernamewhileauthoringaWebpage,becausetheservernamewillchangewhentheWebsiteispublished.

HowcananabsoluteURLbemaderelative?

URLscanbemaderelativeeithertoaserverortoapage.InordertomakeaURLrelativetoafolderortoaWebsite,youneedtomaketheURLrelativeeithertoaserverortoapage,becauseFrontPagewilltreattheURLasifitwerebeingmaderelativetoapageinthatfolderorWebsite.EachrelativeURL,combinedwithitsbaseURLfullyspecifieswheretheobjectislocated.

Whenyouhaveanabsoluteaddresssuchashttp://www.microsoft.com/mywebsitewithanimagefilecalledMyPicture.gifresidingintheimagesfolderontheWebsite,youcancreatearelativeURLforthataddressbydecidingwhethertherelativeaddresswillrefertoaserverorapage.Foraserver-relativeURL,you'duse"mywebsite/images/MyPicture.gif"withtheservernameasthebasefortherelativeURL,whichfullydefinesthelocationoftheobject.Forapage-relativeURL,you'duse"images/MyPicture,gif"withtheservernameandtheWebsitenameasthebasefortherelativeURL,whichfullydefinesthelocationoftheobject.Forafolder-relativeURL,you'duse"MyPicture.gif"withtheservername,Websitename,andfoldernameasthebasefortherelativeURL;thisrelativeaddressfullydefinesthelocationoftheobject.

Afolder-relativeURLcanalsobespecifiedfromadifferentfolder,forexample,"../images/MyPicture.gif"couldbeusedifthereferringdocumentwereinanothertop-levelfolderonthesameWebsiteandserver.The".."isthenotationusedtoindicateuponefolderlevelfromthecurrentURLaddress.

ProgrammaticAccesstoRelativeURLs

Onceyou'vedecidedwhethertouseserver,Website,orfolder-relativeURLs,youcandeterminewhichobjectstouse.ForserverorWebsite-relativeURLs,youwouldbeworkingwithmethodsrelatedtotheWebExobject.Forfolder-relativeURLs,youwouldbeworkingwithmethodsrelatedtotheWebFolder

object.

ConvertingrelativeandabsoluteURLs

RecommendeduseforFrontPageisabsoluteaddressing.However,onceyouhavespecifiedarelativeURLwithinFrontPage,youcanusetheMakeAbsmethodtoconvertitintoanabsoluteURL.Similarly,ifyouhaveanabsoluteURLandyouwanttoinsertareferenceintoadocumentasarelativeURL,youcanusetheMakeRelmethodtoconverttheaddresstoarelativeaddress.YoucanalsousetheMakeAbsandMakeRelmethodstoconvertahyperlinkforaWebEx,WebFolder,WebFileEx,NavigationNode,orIHTMLDocument2object.

ExploringtheObjectModelinFrontPageTheMicrosoftFrontPageobjectmodelconsistsofthreeseparateobjectmodels—theApplicationobjectmodel,theWebobjectmodel,andthePageobjectmodelthatisbasedontheMicrosoftInternetExplorer4.0Documentobjectmodel.

TheseobjectmodelsaredesignedtoprovideWebdesignerswitharichsetofprogramminginterfacestomanageindividualHTMLdocumentsandFrontPage-basedWebsites.TheobjectmodelsparallelotherMicrosoftOfficeapplicationobjectmodelsascloselyaspossibleinordertoleveragetheexperienceandknowledgeuserscurrentlyhavewithotherprogrammableOfficeapplications.Inaddition,thePageobjectmodeliscompatiblewiththeDocumentobjectmodelofMicrosoftInternetExplorer4.0andlater.ThePageobjectmodelalsoleveragestheexperienceandknowledgeofWebdeveloperswhoprogramdynamicHTML(DHTML)usingscript.

Differencesintheprogramminginterfaces

FrontPageprovidesadesign-timeuserexperienceversusarun-timeuserexperience,becauseHTMLpagesareusuallyviewedinabrowserratherthaninFrontPage.OtherOfficeapplicationsprovidearun-timeuserexperiencethatcontainsanenvironmentwherethedevelopercancreatesolutionsfortheuserthatrunwithintheapplication.WithFrontPage,youcancreateutilitiesforuseduringthedesignphaseoftheHTMLdocumentorWebsiteand,onceyouhavedesignedandbuiltyourWebsite,youcanuseMicrosoftVisualBasicScriptingEdition(VBScript),MicrosoftJScript,andDHTMLtocreateinteractiveeffectsforuseduringrun-timewhenthepageisviewedinabrowser.

VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteforthelatestMicrosoftFrontPagedevelopmentinformation,includingnewtechnicalarticles,downloads,samples,productnews,andmore.

Applicationobjectmodelfunctionality

TheApplicationobjectisthetop-levelobjectintheWebobjectmodelhierarchyandprovidesaccesstoalloftheobjectsinFrontPage,suchastheactiveWebsite,activepage,add-ins,commandbars,system,andacollectionofWebsites.

FrontPagePageobjectmodelfunctionalityandrestrictions

ThePageobjectmodelprovidesaccesstotheHTMLinapageandhasmostofthefunctionalityoftheInternetExplorerDocumentobjectmodel,withsomeexceptions.SomeobjectsandmembersoftheInternetExplorerDocumentobjectmodelprovidefunctionalitythatisonlyusefulinanInternetExplorerenvironment.ThoseobjectsandmembersarenotimplementedforuseinthePageobjectmodel.

Webobjectmodelfunctionality

TheWebobjectmodelprovidesprogrammaticmanagementofmultipleFrontPage-basedWebsitesandtheircontents.ThisobjectmodelisbasedonconventionsusedbytheapplicationsintheMicrosoftOfficeSystemandMicrosoftVisualBasicforApplications(VBA).TheWebobjectmodelalsoprovidessupportforMicrosoftVisualSourceSafewhenaccessedthroughFrontPage.

Objectmodelinteraction

MostoftheprogrammingforFrontPage-basedWebsiteswillcontainacombinationofWebandPageobjectmodelprogrammingelements.Foradditionalinformationandexamplesofthis,seeoneofthefollowingtopics.

AccessingFramesetswithMicrosoftVisualBasic

ModifyingPagesProgrammatically

ProgrammingDynamicElements

AccessingFramesetswithMicrosoftVisualBasicFramesareanimportantpartofthedesignofaWebsite.MicrosoftFrontPageprovidessupportforprogrammingthecontentofframes.Clickoneofthefollowinglinksformoreinformationonaparticulartopic.

Exploringframes

Roleofaframeset

AccessingHTMLtags

Dynamicframesources

Iteratingallframesinapagewindow

ChangingMetatagcontenttoanothercharacterset

Exploringframes

AccessingframeswithinaframesetinFrontPageisrelativelystraightforwardaslongasyoukeepinmindthateachframeaccessesitsownpageandthatyouaccessthecontentsofeachpagethroughthePageobjectmodel.ThetwowindowsinvolvedindisplayingtheframesarethePageWindowExobjectandFPHTMLWindow2objects.TheequivalentexpressionforaccessingthecontentsinthewindowassociatedwiththeactiveframeisSetmyActiveFrameInFrameset=ActivePageWindow.Document.TheActivePageWindowobjectaccessesthepagewindowfortheframe,andtheDocumentobjectaccessestheFPHTMLWindow2object.

NoteYoumaygetpermissiondeniederrorsifyoutrytoaccessobjectswhileinHTMLview.Whenyouwanttoaddcodeortexttoadocumentobject,youmustsettheFpPageViewModeconstantfortheViewModepropertytofpPageViewNormal.ThevaluefortheviewmodecannotbesettofpPageViewHtmlorfpPageViewPreview.Alternatively,intheFrontPageuserinterface(UI),youcannothavetheHTMLtaborthePreviewtabopeninPageview.

Roleofaframeset

AframesetisthecontainerforalloftheframesinaWebwindow.Eachframeiscontainedinanindividualpagewindowandhasanindividualpageassociatedwithit.ByaccessingtheFrameWindowobjectfromtheWebobjectmodel,youaccessanFPHTMLWindow2objectthatcontainstheframepagedocument.Fromtheseobjectsyoucanaccessthewindows,documents,andframesoftheframeset.Inthefollowingstatement,myFramesetisanFPHTMLWindow2objectthatreturnstheframespagedocument.Fromthisobject,youcanaccessthe<FRAME>and<FRAMESET>tags,orthewindowordocumentobjects.

SetmyFrameset=ActivePageWindow.FrameWindow

ThisstatementreturnsanFPHTMLWindow2objectthroughthePageobjectmodel.TheDocumentpropertyofmyFramesetaccessesthePageobjectmodelforthepagethatisequivalenttoaccessingtheframespageHTMLtabinPageviewinFrontPage.

NoteTheFramesPageHTMLandNoFramestabsareonlyavailablewhenframesexistonthecurrentpage.

AccessingHTMLtags

YoucanaccessthesameinformationthataframestagaccessesbydeclaringanobjectasanFPHTMLFrameElement.Someofthepropertiesandmethodsavailableforthisobjectincludeborder,borderColor,click,frameBorder,frameSpacing,innerHTML,innerText,insertAdjacentHTML,andinsertAdjacentText.

DimmyFramesElements()AsFPHTMLFrameElement

YoucanaccesstheinformationforaframesettagbydeclaringanFPHTMLFramesetSiteobject.

DimmyFramesetSiteAsFPHTMLFramesetSite

Dynamicframesources

YoucandynamicallychangetheframesourceintheHTMLcodebyusingthefollowingstatements.ThiscodesetstheframesourcetoanewURL,Inventory_1stQuarter.htm.

DimmyDocAsObject

SetmyDoc=ActivePageWindow.FrameWindow.Document

myDoc.all.tags("frame").Item(0).src=_

"Inventory_1stQuarter.htm"

Iteratingallframesinapagewindow

Toaccessthepropertiesoftheframesetelementsthatresideinaparticularframespage,youmustaccesstheFPHTMLDocumentobjectthroughtheDocumentproperty.ThefollowingexampleiteratesthroughtheframesetandframeelementsfortheactiveframesetinMicrosoftFrontPage.Theframesetarray(myFSElements)compriseseach<FRAMESET>tagontheframespage.Theframesarray(myFramesElements)compriseseach<FRAME>tagontheframespage.Theframewindowsarray(myFramesWindows)compriseseachFPHTMLWindow2objectthatpointstoeachframe.Youpopulateeachofthearraysbyiteratingthroughtheirrespectivetagsorobjects.Oncethearraysarepopulated,youchangetheframeSpacingpropertyintheframesetelementto"10",theborderColorpropertyto"red",andchangevariousotherpropertiesinthedocument.

PrivateSubAccessFramesPage()

DimmyFPWindowAsFPHTMLWindow2

DimmyFSElements()AsIHTMLFrameSetElement

DimmyFramesWindows()AsFPHTMLWindow2

DimmyFramesElements()AsFPHTMLFrameElement

DimmyStyleAsFPHTMLStyle

DimiAsInteger

SetmyFPWindow=ActivePageWindow.FrameWindow

ReDimmyFSElements(myFPWindow.Document.all.tags("FRAMESET").length)

ReDimmyFramesElements(myFPWindow.Document.all.tags("FRAME").length)

ReDimmyFramesWindows(myFPWindow.frames.length)

Fori=0ToUBound(myFSElements)

SetmyFSElements(i)=_

myFPWindow.Document.all.tags("FRAMESET").Item(i)

Fori=0ToUBound(myFramesWindows)

SetmyFramesWindows(i)=myFPWindow.frames(i)

Fori=0ToUBound(myFramesElements)

SetmyFramesElements(i)=_

myFPWindow.Document.all.tags("FRAME").Item(i)

myFSElements(0).frameSpacing="10"

myFramesElements(0).borderColor="red"

WithmyFramesWindows(2).Document

.bgColor="green"

.body.innerHTML="<pid=""cool"">AddedbyFPProgrammability"

SetmyStyle=.all.cool.style

myStyle.backgroundColor="white"

myStyle.display=False

myStyle.textDecorationUnderline=True

myStyle.Font="Tahoma,24"

myStyle.fontStyle="italic"

EndWith

EndSub

ChangingMetatagcontenttoanothercharacterset

Youcanchangeallofthecontent-typeMETAtagstoadifferentcharacterset(CentralEuropean)asshowninthefollowingcodesample.ThecurrentcharactersetisshownintheLanguageSettingsdialogbox(availableforpageproperties).

NoteTheentirecontent-typeMETAtagcontainsastringsimilartothefollowing:

content="text/html;charset=windows-1252"

Thecharactersetis"windows-1252"andisthedefaultcharactersetforU.S.English.

Eachtimetheprogramiteratesthroughtheloop,youaccessthenextframeintheframeWindowobject,whichisthesameasaccessingeachHTMLframestaginsuccession.However,theFramescollectiondoesnotsupporttheFor...eachconstruct.YoucannotaccessHTTP-EQUIVtypeMETAtagsviatheirname;youmustinsteaduseanindexasshowninthefollowingexample.TheexpressionbeginningwithmyContentType.ContentsetsthecharactersettoCentralEuropean.

NoteFrontPageplacesthecontenttypein<META>tagzero(0).

PrivateSubChangeCharSet()

DimmyFramesAsIHTMLFramesCollection2

DimmyFrameAsFPHTMLWindow2

DimmyHTTPEquivAsString

DimmyContentTypeAsObject

DimmyCountAsInteger

SetmyFrames=ActivePageWindow.FrameWindow.frames

SetmyFrame=ActivePageWindow.FrameWindow.frames(0)

myHTTPEquiv=0

FormyCount=0TomyFrames.Length-1

SetmyFrame=myFrames(myCount)

SetmyContentType=_

myFrame.Document.all.tags("meta").Item(myHTTPEquiv)

myContentType.content=_

"text/html;charset=iso-8859-2"

NextmyCount

EndSub

AccessingtheObjectModelinFrontPagefromDesign-TimeControlsSomeofthecontentinthistopicmaynotbeapplicabletosomelanguages.

Adesign-timecontrol(DTC)isoneofaclassofMicrosoftActiveXcontrolsthatisexclusivelyusedatdesign-timeasanaidtoauthoringWebsitecontent.DTCsfunctionjustlikeembeddedwizards—theycanbeeditedtomodifytheoutputthattheDTCgeneratesontheWebpage.Oncethefileisclosed,theDTCbecomesinactive—thetextthattheDTCgeneratedhasbeenembeddedintothefile.

Howaredesign-timecontrolsdifferentfromActiveXcontrols?

Design-timecontrolsdonotcontainabinaryrun-timecomponent,butdohaveaspecialinterfacethatprovidestheabilityforthedesign-timecontroltopersistandgeneratetext.Design-timecontrolsandActiveXcontrolscanco-existonthesamewebpage.FormoreinformationonDTCs,seethedocumentationontheMicrosoftworkshopWebsitefordesign-timecontrols.

Howdodesign-timecontrolsdifferfromVisualInterDev?

FrontPageandMicrosoftVisualInterDevarecompatibleinmostareas.Fordesign-timecontrols,FrontPageprovidesfullaccesstotheDocumentobjectmodelthat'savailableinMicrosoftInternetExplorer.TheWebobjectmodelisalsoavailablefordesign-timecontrolsandprovidesaricharrayofobjects,events,methods,andproperties.FrontPagealsoprovidessupportforremovingtags(ortext)thatisinsertedintoadocumentbydesign-timecontrols.

PropertiessupportedbyFrontPagethatarenotsupportedbyMicrosoftVisualInterDev:

Preview—returnsastringcontainingthecontrolspreviewtext.Tag—returnsthetagcontextforthepreviewstring.

Built-inoptionsinVisualInterDevthatFrontPagedoesn'tsupport:

QueryBuilderDataconnectionsVisualInterDevobjectmodelfor.asppages

HowtoaccesstheFrontPageobjectmodelfromadesign-timecontrol

Adesign-timecontrolisatypeofActiveXcontrol,andthusaccessesitshost'sobjectmodelsimilarlytoothercontrols(seeFPHTMLObjectElementobject).Thedesign-timecontrolhasaUserControlpropertythatreturnstheUserControlobject.ThisobjectinturnhasanExtenderpropertythatreturnstheenvironmentwheretheActiveXcontrolresides.Theexpression,UserControl.extenderreturnstheenvironmentforthespecifiedDTC.

TheExtenderpropertyreturnsFPHTMLObjectElementobjectandprovidesaccesstoallofthepropertiesandmethodsintheFPHTMLObjectElementobject.OneofthesepropertiesistheDocumentpropertythataccessestheFrontPagePageobjectmodelforthedocumentwherethedesign-timecontrolresides.ThefollowingstatementsillustratehowtoaccesstheDocumentpropertyfromaDTC.

DimmyDTCAsFPHTMLObjectElement

DimmyDocAsFPHTMLDocument

DimmyPageWindowAsPageWindowEx

SetmyDTC=UserControl.Extender

SetmyDocument=myDTC.document

SetmyPageWindow=myDoc.parentWindow.external

ThelastSetstatementillustrateshowtoaccesstheWebobjectmodelfromthePageobjectmodel.

CodinginaWindowlessEnvironmentInMicrosoftFrontPage,itispossibletocreateawindowlessenvironmenttocutdownonUserInterface(UI)overhead,buttherearesomedrawbackstoworkinginsuchanenvironment.Forexample,openingapagewiththeViewModepropertysettofpPageViewNoWindow,createsawindowlessenvironmentwherewindowelementsthatrequiretheUIwon'tworkcorrectly.IfyouopenapagewithoutawindowandtrytoaccessitusingcodesuchasPageWindow.Document.ParentWindow,theresultingcodereturnsnothinginsteadofreturninganFPHTMLWindow2object.Thefollowingstatementsprovideaccesstowindowlesspages.

Application.LocatePage(DocumentUrlAsString,_

ViewModeAsFpPageViewMode)AsPageWindowEx

Web.LocatePage(DocumentUrlAsString,ViewModeAsFPPageViewMode)_

AsPageWindowEx

File.Edit(ViewModeAsFpPageViewMode)AsPageWindowEx

ThefollowingtabledescribesthePageWindowExmethodsandpropertiesandtheobjectsorerrormessagestheyreturn.SomemethodsandpropertiesofthePageWindowExobjectaredisabledinawindowlessenvironmentandwillreturntheresultsshowninthefollowingtable.

DisabledMethodorPropertyofthePageWindowObject ReturnedObjectorErrorMessage

ActiveDocument Returns"objectorwithvariablenotset"errormessage.

ActiveFrameWindow Returns"objectorwithvariablenotset"errormessage.

Caption ReturnstheURLforthePageWindowobject.

Document ReturnsaDocumentobject.File ReturnsaFileobject.

ViewMode Thispropertycannotbeset.ItreturnstheconstantfpPageViewNoWindow.

Visible ReturnsFalse.

ReturnstheWebobjectiftheobjectwaslocatedusingthefollowingstatements.

Web.LocatePage

File.Edit

ApplyTheme Returnsarun-timeerror.Close(ForceSave) Closesthepagewindow.Refresh(ForceSave) Refreshesthepagewindow.Save(ForceOverwrite) Savesthepagewindow.SaveAs(ForceOverwrite) SavesthepagewindowtoanewURL.

ShowAll

ModifyingPagesProgrammaticallyThistopicillustrateshowtoworkwiththeFPHTMLDocumentobjectelementswithinthePageobjectmodeleithertochangethecontentsofapageorsimplytoaccessthecontentsofapageforverification.

MicrosoftVisualBasicisapowerfultoolthatyoucanusetomodifycontentinyourWebpages.AsyoubrowsethroughtheObjectBrowser,you'llseemanyofthesametypesofcomponentsthatyou'refamiliarwithinMicrosoftInternetExplorer.

ToonlyviewtheprogrammingelementsthatarecompatiblewiththeFrontPagePageobjectmodel,select"FrontPageEditor"astheobjectlibraryintheObjectBrowser.

YoucanaccesstheHTMLelementsofapageusingtheActiveDocumentorDocumentpropertiesthatreturnthedocumentobjectviathePageWindowExobject.Forexample,thefollowingstatementchangesthebackgroundcolorforthepageintheactivepagewindow.

ActivePageWindow.Document.bgColor="DarkBlue"

Thefollowingexamplechecksforaspecifichyperlink(index.htm)withintheactivedocument.Ifthehyperlinkisfound,theprocedureexits,butifthehyperlinkisn'tfound,theprocedurefirstchecksiftheactivedocumentisindex.htmand,ifnot,thehyperlinkisaddedattheendofthedocument.

PrivateSubVerifyIndexLink()

DimmyLinksAsVariant

DimmyLinkAsVariant

DimmyNumberOfLinksAsInteger

DimmyAddLinkAsBoolean

DimmyLinkNameAsString

DimmyLinkName2AsString

SetmyDoc=ActivePageWindow.Document

SetmyLinks=myDoc.Links

myNumberOfLinks=myLinks.length

myLinkName="index.htm"

myLinkName2=""""&myLinkName&""""

ForEachmyLinkInmyLinks

IfmyLink=myLinkNameThen

myAddLink=True

ExitFor

IfmyAddLink=FalseAndmyDoc.nameProp<>"index"Then

CallmyDoc.body.insertAdjacentHTML("BeforeEnd","<ahref="_

&myLinkName2&">"&myLinkName&"</a>")

ActivePageWindow.Save

EndSub

NoteNoticethatinthelastIfstatementtheactivepagewindowissavedbeforeexitingtheprocedure.ThiswouldbeagoodstatementtoaddtotheOnPageCloseevent.

UnderstandingWebWindowsandPageWindowsInMicrosoftInternetExplorer,thewindowobjectistherootoftheobjecthierarchy.InMicrosoftFrontPage,theApplicationobjectistherootoftheobjecthierarchyandtheWebWindowExobjectisanobjectinthethirdtieroftheobjecthierarchybelongingtothecollectionofWebWindows(secondtier).TheDocumentpropertyisaccessedviathePageWindowExobject(belongingtothecollectionofPageWindows),whoseparentistheWebWindowExobject.TheobjecthierarchyfortheWebWindowscollectionisshowninthefollowingdiagram.

WebWindows WebWindowExPageWindowsPageWindowEx

WhatisaWebWindowExobject?

TheWebWindowExobjectisthewindowcontainerfortheWebsite.WhenyouopenaWebsiteinFrontPage,youseetheWebsiteinits"web"window.FrontPageopensanewwindowforeachWebsiteyouopen.

WhatisaPageWindowExobject?

ThePageWindowExobjectisthecontainerforthewebpage.Whenyouopenapageinawebwindow,thatpageiscontainedinapagewindow(visibleintherightpane).FrontPageopensanewpagewindowforeachpageyouopen;howevereachPageWindowExobjectiscontainedwithintheWebWindowExobjectfortheindividualWebsite.Eachpagethatyou'veopenedisvisibleontheWindowsmenuinFrontPage.

WheredoestheDispFPHTMLDocumentobjectfitin?

TheFPHTMLDocumentobjectcontainstheHTMLelementsforapage.Theelementsforthedocumentareavailableusinganexpressionsuchas

ActivePageWindow.Document.elementwhereelementisoneoftheHTMLelementsavailableinFrontPage.NotethatnotallHTMLelementshavecorrespondingpropertiesthatyoucanusetoaccesstheelement.Forexample,thereisnoheadpropertytoaccesstheHEADelement.Inthesecases,useactivepagewindow.Document.all.tags.item("element")toreturntheobjectthatcorrespondstothespecifiedelement.

ReturninganObjectfromaCollectionTheItempropertyreturnsasingleobjectfromacollection.ThefollowingstatementssetthefileOnevariabletoaWebFileobjectthatrepresentsthefirstfileintheFilescollection.

NoteAllcollectionsintheMicrosoftFrontPageWebandPageobjectmodelsarezero-based,soyouaccessthefirstiteminthecollectionbyusingazero.

DimfileOneAsWebFile

SetfileOne=ActiveWeb.RootFolder.Files.Item(0)

TheItempropertyisthedefaultpropertyformostcollections,soyoucanomittheItemkeywordasshowninthefollowingstatement.

SetfileOne=ActiveWeb.RootFolder.Files(0)

Namedobjects

AlthoughyoucanusuallyspecifyanintegervaluewiththeItemproperty,itmaybemoreconvenienttoreturnanobjectbyname.ThefollowingexampleeditsafilenamedWebSales.htmintheactiveWebpage.

ActiveWeb.RootFolder.Files("WebSales.htm").Edit

UsingEventstoControlActionsTherearetwotypesofeventsinMicrosoftFrontPage—eventsthatareraisefromtheApplicationandWebobjectmodelsandeventsthatareraisedfromthePageobjectmodel.

Applicationevents

TheeventsfortheApplicationobjectmodelcanbeusedtocontrolunderwhatconditionsaWebsiteispublished,whetheryouwanttosaveapagewhenevertheOnPageCloseeventisfired,orwhetheryouwanttosetstyles,fonts,orbackgroundswheneveranewpageiscreated.

Pageevents

IntheMicrosoftInternetExplorerDHTMLobjectmodel,eventhandlersarecreatedusingscriptsforuseatrun-time.

However,intheFrontPagePageobjectmodel,you'reprogrammingwitheventsandobjectsthatarecompatiblewithInternetExplorer,butforuseatdesigntime.Toprogrameventsforruntime,youcanusethestandardMicrosoftVisualBasic5.0(orhigher)keywordstoaccessthePageobjectmodeleventsjustasyouwouldtoaccesstheWebobjectmodelevents.Thismethodcombinesthetwotechniquesdescribedpreviously.ThefollowingexamplecatchestheonclickeventforahyperlinkinFrontPage.

IntheVisualBasicEditor,insertaclassmoduleandnameitCatchOnClick.Addthefollowingcodetotheclassmodule.

DimWithEventseAnchorAsFPHTMLAnchorElement

DimWithEventseDocAsFPHTMLDocument

DimeAsIHTMLEventObj

PrivateSubClass_Initialize()

SeteDoc=ActiveDocument

SeteAnchor=eDoc.links(0)

EndSub

PrivateFunctioneAnchor_onclick()AsBoolean

Sete=eAnchor.Document.parentWindow.event

If(MsgBox("OnClickEventfor"&e.srcElement.tagName&_

"wouldyouliketocanceltheeventbubbling?",_

vbYesNo)=vbYes)Then

e.cancelBubble=True

e.returnValue=False

e.cancelBubble=False

e.returnValue=True

EndFunction

PrivateFunctioneDoc_onclick()AsBoolean

MsgBox"OnClickeventfortheDocumentobject"

EndFunction

Nextaddastandardmoduleandaddthefollowingcode.

PubliceAsCatchOnClick

SubGetClick()

Sete=NewCatchOnClick

EndSub

NoteToruntheexample,performthefollowingsteps:

AddahyperlinktoapageinFrontPage.RuntheGetClickproceduretocreateaglobalinstanceoftheCatchOnClickeventhandlerclass.Clickthehyperlink.

Apromptisdisplayedstatingthattheonclickeventfired.Thepromptalsoqueriestheusertofindoutwhethertheprogramshouldpasstheeventonuptheeventchain.IfYesischosen,theonclickeventispasseduptothedocumentobjecttobehandled.

Tocontrolwhichdocumentobjecttheeventispassedto,youmustsetboththecancelBubbleandreturnValueproperties.ThecancelBubbleeventworkstocanceltheeventfromgoinganyfartheruptheeventchain.SetthecancelBubblepropertyoftheIHTMLEventObjecttoTruewhenyoudon'twanttheonclickeventtobepasseduptothenextlevelofonclickevents,otherwise,setthecancelBubblepropertytoFalse.Forexample,ifyouhaveanimagethathasanonclickeventplacedonadocument,whichalsohasanonclickevent,youwouldsetthecancelBubblepropertyfortheIHTMLEventObjobjecttoTruefortheimage,ifyoudon'twanttheonclickeventtobepassedonuptothedocumentonclickevent.

ThereturnValuepropertyisusedtocontrolthedefaultactiontakenbyFrontPagewhenaneventfires.Usingthepreviousexampleofanimageplacedonadocument,ifthereturnValuepropertyfortheIHTMLEventObjectfortheimageissettoFalseintheonclickevent,thentheshortcutmenuwouldbedisabled(becausetheright-clickcontextmenuisthedefaultactionfortheonclickevent).

ManagingPublishingwithMetaTagsAutomatepublishingyourWebsitebyusingacombinationofeventssuchasOnBeforeWebPublishandmetadatathatcanbeobtainedbyaccessingthedatainthePropertiescollection.Forexample,beforepublishingaWebsite,youmightwanttocheckthemetadataforallofthepagesintheWebsite.TocheckifMicrosoftFrontPagegeneratedallofthepagesinyourWebsite,usethefollowingcodeintheOnBeforeWebPublishingevent,alongwithaneventhandler.

PrivateSubCheckIfFP()

DimmyFileAsWebFile

DimmyMetaTagsAsMetaTags

DimmyMetaTagAsVariant

SetmyFiles=ActiveWeb.RootFolder.Files

ForEachmyFileInmyFiles

SetmyMetaTags=myFile.MetaTags

'Checkforanytextfiles.

IfmyMetaTags.Count=0And_

myFile.Extension<>".asa"Then

MsgBoxmyFile.Name&"wasnotgeneratedbyFrontPage."

'Checkallwebpages.

ForEachmyMetaTagInmyMetaTags

IfmyMetaTag="generator"Then

IfmyFile.Properties("vti_generator")=_

"MicrosoftFrontPage4.0"Then

ExitFor

MsgBoxmyFile.Name&"wasnotgeneratedbyFrontPage."

EndSub

Youcanalsocheckthevalueofthevti_donotpublishpropertykeybeforepublishing.Ifthedocumentisadraftoradocumentthatisn'ttobepublished,thevti_donotpublishpropertykeywillbesettoTrue.Thefollowingexamplechecksthevalueofthevti_donotpublishpropertykey.

DimmyFileAsWebFile

IfmyFile.Properties("vti_donotpublish")=TrueThen

MsgBox"Donotpublish"&myFile.Name

Thevti_donotpublishpropertykeycanbeusedtodisablepublishing.Whenpublishingiscomplete,thefilewillnotbepublishedtotheserver.ThefollowingexampledisablespublishingforthefirstfileintheFilescollection.

SubPublishThisFile(myFileNameAsString,myStatusAsBoolean)

DimmyFileAsWebFile

SetmyFile=ActiveWeb.LocateFile(myFileName)

CallmyFile.Properties.Add("vti_donotpublish",Not(myStatus))

myFile.Properties.ApplyChanges

EndSub

PrivateSubPublishFile()

PublishThisFileActiveweb.RootFolder.Files(0),False

EndSub

ProgrammingDynamicElementsinMicrosoftFrontPageTheobjects,methods,andpropertiesinMicrosoftInternetExplorerareusuallydesignedforrun-timeuse.InMicrosoftFrontPage,mostoftheelementsaredesignedfordesign-timeonly.Youcanprogrammaticallyaddcontenttoanexistingdocument,accessselectionsonapage,createascriptingelement,ormodifyanexistingtable.

AddingcontenttoadocumentusingaTextRange

AccessinguserselectionsusingaTextRange

Addingscripttoapage

Accessingtables

AddingcontenttoadocumentusingaTextRange

YoucanprogrammaticallyaddHTMLcontenttoaWebpagebycreatingatextrangeandaddingthenewcontenttothepageasshowninthefollowingexample.ThetextrangeiscreatedfromtheBODYelementofthemyDocumentvariable.IfthevalueinthemyClearPageparameterisTrue,thentheentirecontentbetweentheopeningandclosingBODYelementisreplacedwiththenewHTMLcontent,otherwisethenewcontentisappendedtotheoriginalcontent.

PublicFunctionAddHTMLToPage(myDocumentAsObject,_

myHTMLTextAsString,myClearPageAsBoolean)AsBoolean

DimmyRangeAsIHTMLTxtRange

DimmyBodyTextAsFPHTMLBody

OnErrorGoToCannotAddHTML

'CreateaTextRangeobject

IfmyClearPageThen

SetmyRange=_

myDocument.all.tags("BODY").Item(0).createTextRange

'Clearthecurrentdocument

CallmyRange.pasteHTML("")

myRange.collapseFalse

SetmyRange=Nothing

SetmyBodyText=myDocument.all.tags("BODY").Item(0)

myBodyText.innerHTML=myBodyText.innerHTML&myHTMLText&vbCrLf

AddHTMLToPage=True

ExitFunction

CannotAddHTML:

AddHTMLToPage=False

EndFunction

SubAddNewHTML()

DimmyBodyElementAsFPHTMLBody

myHTMLString="<B><I>NewSaleonVintageWines!</I></B>"&vbCr

IfAddHTMLToPage(ActivePageWindow.Document,myHTMLString,True)Then

SetmyBodyElement=_

ActivePageWindow.Document.all.tags("BODY").Item(0)

EndSub

AccessinguserselectionsusingaTextRange

YoucanusetheIHTMLTxtRangeobjecttoselectHTMLobjectsormanipulateauserselectiononaspecifieddocument.Thefollowingexampleappliesabackgroundcolortothecurrentselection.

PrivateSubApplyStyleToSelection()

DimmyRangeAsIHTMLTxtRange

SetmyRange=ActiveDocument.selection.createRange

myRange.parentElement.style.backgroundColor="SkyBlue"

EndSub

Addingscripttoapage

ScriptinginMicrosoftFrontPageVisualBasicforApplicationsiseasy.JustloadthescriptintoaStringvariableandinserttheStringtotheHEADelementforthepage.(TheHEADelementisaccessedusinganIHTMLElementobject.)OncetheStringhasbeenaddedtothepage,itisavalidscriptingelementandcanbeaccessedthroughtheFPHTMLScriptElementobjectandmodified.Thefollowingcodeaddsascriptelementtothecurrentpage,verifiesthatthescriptwasadded,addsaquerytotheuserwithOKandCancelbuttons,andthenprintssomeofthescriptelementpropertiesintheImmediatewindowoftheVisualBasicEditor.

PrivateSubCreateAScript()

DimmyScriptElementAsFPHTMLScriptElement

DimmyHTagAsIHTMLElement

DimmyBodyTagAsIHTMLElement

DimmyBodyStringAsString

DimmyTextAsString

'Buildascripttagconstruct.

myHTMLString=myHTMLString&"<scriptlanguage=""VBScript"">"_

&vbCrLf

myHTMLString=myHTMLString&"FunctiondoOK"&vbCrLf

myHTMLString=myHTMLString&_

"msgbox""Pleasewait,anorderformisbeinggenerated..."""&_

vbCrLf

myHTMLString=myHTMLString&"EndFunction"&vbCrLf&vbCrLf

myHTMLString=myHTMLString&"FunctiondoCancel"&vbCrLf

myHTMLString=myHTMLString&_

"msgbox""Exitingorderingprocess."""&vbCrLf

myHTMLString=myHTMLString&"EndFunction"&vbCrLf

myHTMLString=myHTMLString&"</script>"&vbCrLf

'Buildacalltagconstruct.

myBodyString="<CENTER>"&vbCrLf

myBodyString=myBodyString&_

"<BUTTONonclick=""doOK()"">OK</BUTTON>"&vbTab

myBodyString=myBodyString&_

"<BUTTONonclick=""doCancel()"">Cancel</BUTTON>"&vbCrLf

myBodyString=myBodyString&"</CENTER>"

'Addtexttothedocument

myText="I'dliketoordersomevintagewines."

'AccesstheHEADelement.

SetmyHTag=ActivePageWindow.Document.all.tags("HEAD").Item(0)

'AppendthescriptelementtotheHEADelement(myHTag).

myHTag.innerHTML=myHTag.innerHTML&myHTMLString

'Verifythatthescriptelementwasadded.

IfActivePageWindow.Document.scripts.length=1Then

'Accessthescriptelementjustadded.

SetmyScriptElement=ActivePageWindow.Document.scripts(0)

'PrintscriptelementpropertiestotheImmediatewindow.

'JScriptonly:thenextstatementgetstheFOR=attributefrom

'theJScript,otherwiseanemptystringprintsintheImmediate

'window.

Debug.PrintmyScriptElement.htmlFor

'Retrievethecontentofthescript.

Debug.PrintmyScriptElement.outerHTML

'Checkscriptinglanguage.

Debug.PrintmyScriptElement.language

'Addaquerytotheuserandcallthescriptelement.

ActiveDocument.body.insertAdjacentHTML"BeforeEnd",_

"<B><I>"&myText&"</B></I><P>"&myBodyString

EndSub

Accessingtables

AnyonewhohascreatedtablesandworkedwiththeircontentsinHTMLwillfinditeasytouseMicrosoftVisualBasictoaccesstables.Thefollowingprogramaccessesatableonthecurrentpageandinsertsacell.

SubAccessTables()

DimmyRowAsFPHTMLTableRow

DimmyCellAsFPHTMLTableCell

'Getthetable.

SetmyTable=ActiveDocument.all.tags("TABLE").Item(0)

'Getthefirstrow.

SetmyRow=myTable.rows(0)

MsgBoxmyRow.cells.Length

'Getthefirstcell.

SetmyCell=myRow.cells(0)

MsgBoxmyCell.Width

'Addanewcelltothefirstrow.

SetmyCell=myTable.rows(0).insertCell(myRow.cells.Length)

EndSub

ManagingSourceControlProjectsinMicrosoftFrontPageMicrosoftFrontPageprovidestwomethodsofversioning,FrontPageLightWeightsourcecontrol(alsoknownasMicrosoftOffice-stylelockingorFrontPage-basedlocking)andMicrosoftVisualSourceSafe.FrontPageLightWeightsourcecontrolisthedefaultversioningmethodforsourcecontrolprojectsinFrontPage.

VersioningprovidesameasureofcontroloveruserswhomaintainpagesonyourWebsites.Bothsourcecontrolmethodsprovidecheckin,checkout,undocheckout.VisualSourceSafeprovidesotherversioningcapabilities,suchasversiontrackingandrollbackfeatures.

Creatingasourcecontrolproject

Tocreateanewsourcecontrolproject,yousettheRevisionControlProjectpropertytothepathoftheproject(forVisualSourceSafe)orto<FrontPage-basedLocking>asshowninthefollowingstatement.

ActiveWeb.RevisionControlProject="<FrontPage-basedLocking>"

AssumingthattheString"$/CohoWinery"isavalidVisualSourceSafeproject,thefollowingstatementassignstheactiveWebsitetoaVisualSourceSafeproject.

ActiveWeb.RevisionControlProject="$/CohoWinery/Inventory"

Thefollowingexamplecreatesasourcecontrolprojectandchecksouttwofiles.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\CohoWinery".Youmaycreatetwofilescalled"index.htm"and"footnote.htm"orsubstitutefilenamesofyourchoice.

PrivateSubCreateSourceControl()

DimmyWebAsWebEx

DimmyProjectAsString

DimmyFile1AsWebFile

DimmyFile2AsWebFile

SetmyWeb=Webs.Open("C:\MyDocuments\MyWebSites\CohoWinery")

SetmyFile1=myWeb.RootFolder.Files("index.htm")

SetmyFile2=myWeb.RootFolder.Files("footnote.htm")

myProject="<FrontPage-basedLocking>"

myWeb.RevisionControlProject=myProject

myFile1.Checkout

myFile2.Checkout

EndSub

TheCheckoutmethodprovidesaBooleanforcecheckoutargumentforadministrators.

Removingasourcecontrolproject

Onceaprojectiscompleted,youmaydecidetoremoveversioning.Todothis,settheRevisionControlProjectpropertytoanemptyString("")asshowninthefollowingstatement.

myWeb.RevisionControlProject=""

SwitchingbetweenFrontPageLightWeightandVisualSourceSafeprojects

Toswitchbetweenthesetwotypesofversioning,youmustfirstsettheRevisionControlProjectpropertytoanemptyString("")asshowninthefollowingstatement.

myWeb.RevisionControlProject=""

ListsCollectionMultipleobjects Lists

ListMultipleobjects

RepresentsthecollectionofallListobjectsinthecurrentWebsite.ListsallowinformationtobesharedandexchangedbetweendifferentusersanddifferentWebsites.

ThisobjectissupportedonlybyWebpagesorsitesthatarebasedonMicrosoftSharePointServices.

UsingtheListscollection

UsetheListspropertyoftheWebExobjecttoreturnthecollectionofalllistsintheWebsite.UseLists.item(index),whereindexiseitherthenameofthelistoritsnumericpositionwithinthecollection,toreturnasingleListobject.

ThefollowingexampledisplaysthenamesofalllistsintheactiveWebsite.IftheactiveWebsitedoesnotcontainanylists,amessageisdisplayedtotheuser.

SubListAllLists()

'Displaysthenamesofalllistsinthecollection

DimlstWebListAsList

DimstrNameAsString

'Checkifanylistsexist

IfNotActiveWeb.ListsIsNothingThen

'Cyclethroughlists

ForEachlstWebListInActiveWeb.Lists

'addlistnamestostring

IfstrName=""Then

strName=lstWebList.Name&vbCr

strName=strName&lstWebList.Name&vbCr

'Displaynamesofalllists

MsgBox"ThenamesofalllistsinthecurrentWebsiteare:"_

&vbCr&strName

'Otherwisedisplaymessagetouser

MsgBox"ThecurrentWebsitecontainsnolists."

EndSub

UsetheLists.AddmethodtoaddanewlisttotheListscollection.ThefollowingexampleaddsanewlistoftypefpBasicListcalledNewSharetotheactiveWebsite.

SubNewList()

'AddsanewlisttothecurrentWebsite

DimobjAppAsFrontPage.Application

DimobjListsAsLists

SetobjApp=FrontPage.Application

SetobjLists=objApp.ActiveWeb.Lists

'Addnewlist

objLists.AddName:="NewShare",_

ListType:=fpListTypeBasicList,_

Description:="ListofSharedfiles"

'Displaymessagetouser

MsgBox"AnewlistwasaddedtotheListscollection."

EndSub

MetaTagsCollectionWebFile MetaTags

Anarrayofpropertykey/valuepairs.EachitemintheMetaTagscollectionrepresentsaMETAtagcontainedonanHTMLpageinMicrosoftFrontPage.ThereisnoMetaTagobject.

NoteMETAtagsgeneratedbyFrontPage,suchasMETAtagsforathemeorborder,won'tshowupintheMetaTagscollection.TheMetaTagscollectionisonlypropagatedafterthefileissaved.Forexample,ifyouaddanewMETAtagtoapagebyusingtheCodevieworbyprogrammaticallyusingthePageobjectmodelinMicrosoftVisualBasicforApplications,youwon'tbeabletoviewthepropertykey/valuepairsuntilafteryousavethepage.TosavespaceintheMETAdictionary,youcanusethefollowingmethodstodisabletheMETAtagstore:

SettheDisableMetaTagStorekeyonaper-servicebasisSettheDisableMetaTagStorekeyasaglobalsettingunderHKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\SharedTools\WebServerExtensions\AllPortsSetthevti_disablemetatagstoreproperty

TheDisableMetaTagStorekeyfunctionsinthesamewayasotherserversettings;seetheServerExtensionsResourceKitformoreinformationaboutserversettings.

UsingtheMetaTagsCollection

UsetheMetaTagspropertytoreturntheMetaTagscollection.

NoteInthemetadataforFrontPage,thehttp-equivattributecanbeusedinplaceofthenameattribute.FrontPagedoesn'tusethevalueofthehttp-equivattributeinresponsemessageheaders.ThesyntaxforMETAdataisasfollows:

CONTENT=description

HTTP-EQUIV=text

NAME=text

TITLE=text

URL=url

YoucanalsoreturnalistoftheMETAtagsthatexistintheactiveWebsitebyaccessingthefilestructurethroughtherootfolderoftheActiveWebobject,asshowninthefollowingexample.

NoteTorunthisexample,createaformwithatextboxcalledtxtMetaTags(settomultiplelines)andacommandbuttoncalledcmdGetMetaTagInfo,andthencopytheexampleintothecodewindow.

PrivateSubcmdGetMetaTagInfo_Click()

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmyFileNameAsString

DimmyMetaTagNameAsString

DimmyReturnInfoAsString

SetmyWeb=ActiveWeb

WithmyWeb

myFileName=myFile.Name

myMetaTagName=myMetaTag

myReturnInfo=myFileName&":"&myMetaTagName

txtMetaTags.Text=txtMetaTags.Text&myReturnInfo

txtMetaTags.SetFocus

txtMetaTags.CurLine=0

EndWith

EndSub

UsetheApplicationpropertytoreturntheApplicationobject.ThefollowingstatementreturnstheApplicationobject.

myApplication=ActiveWeb.RootFolder.Files(0).MetaTags._

Application

UsetheCountpropertytoreturnthenumberofMETAelementsinthecollection.ThefollowingstatementreturnsthenumberofMETAelementsinthetenthfileoftheActiveWebobject.

myMetaTagCount=ActiveWeb.RootFolder.Files(9).MetaTags.Count

UseItems(index),whereindexisthepropertykeyvalueasastring,ofanitemintheMetaTagscollectiontoreturnthepropertykey/valuepair.ThefollowingexamplereturnstheprogramidentificationtagfromtheMETAtagsinthefirstfileoftheActiveWebobject.

myMetaTagOne=ActiveWeb.RootFolder.Files(0).MetaTags("ProgId")

Commonpropertykeyvaluesare"generator"and"progid."Formoreinformationaboutpropertykeyvalues,seethetableinthePropertiesobject.

UsetheParentpropertywhenyouwanttoreturnthefilecontainerfortheMetaTagscollection.Forexample,thefollowingexamplereturnstheUrlpropertyoftheWebFilecontainerobjectthatisassociatedwiththeMETAtagsforthefirstfileoftheActiveWebobject.

myMetaTagParent=_

ActiveWeb.RootFolder.Files(0).MetaTags.Parent.Url

NavigationNodesCollectionMultipleobjects NavigationNodes

NavigationNodeMultipleobjects

AcollectionofNavigationNodeobjectswithinthenavigationalstructureofaMicrosoftFrontPage-basedWebsite.EachNavigationNodeobjectrepresentsapointertoapageonaWebsite.TheNavigationNodeobjectisamemberoftheNavigationNodescollection.

UsingtheNavigationNodesobject

UsetheNavigationNodepropertytoreturntheNavigationNodeobjectforaWebFileobject.FormoreinformationonreturningthecollectionofchildnodeswithinthenavigationalstructureofaWebsite,seetheChildrenproperty.ThefollowingexamplebuildsalistofthelabelsthatareassociatedwitheachNavigationNodeobjectintheNavigationNodescollection.Theprocedureexitswhenitreachestheendofthenavigationalstructure.

PrivateSubGetNavigationNode()

DimmyWebAsWebEx

DimmyWebFilesAsWebFiles

DimmyWebFileAsWebFile

DimmyNavNodeLabelAsString

DimmyLabelAsString

OnErrorResumeNext

SetmyWeb=ActiveWeb

WithmyFiles

myLabel=myFile.NavigationNode.Label

IfErr<>0ThenExitSub

myNavNodeLabel=myNavNodeLabel&myLabel&vbCRLF

EndWith

EndSub

UseChildren(index),whereindexistheindexnumberofaniteminthecollectionofchildnodes,toreturnasingleNavigationNodeobject.ThefollowingexamplereturnsthefirstNavigationNodeobjectinthecollection—whichisthehomepage.

SetmyNavNodeOne=ActiveWeb.RootNavigationNode.Children(0)

UsetheAddmethodtoaddaNavigationNodeobjecttotheNavigationNodescollection.Thefollowingexampleaddsanodetotherightmostpositioninthecurrentnavigationalstructure.

PrivateSubAddNewNavNode()

DimmyWebAsWebEx

DimmyNewNavNodeAsNavigationNode

DimmyNavChildrenAsNavigationNodes

SetmyWeb=ActiveWeb

SetmyNavChildren=_

myWeb.rootfolder.Files(1).NavigationNode.Children

myNewNavNode=_

myNavChildren.Add("C:\MyWebs\Sale.htm","Sale",fpStructRightmostChild)

EndSub

NoteAfteryoufinishmodifyingyournavigationalstructure,youmustapplythechangesusingtheApplyNavigationStructuremethodbeforethenavigationalstructureisupdatedinFrontPage.

PageWindowsCollectionMultipleobjects PageWindows

PageWindowMultipleobjects

AcollectionofPageWindowExobjects.EachPageWindowExobjectrepresentsanopenWebpageinaMicrosoftFrontPageapplicationwindow.ThePageWindowExobjectisamemberofthePageWindowscollection.

UsingthePageWindowsobject

UsethePageWindowspropertytoreturnthePageWindowscollection.ThefollowingstatementreturnsthePageWindowsobjecttothemyPagesvariable.

myPages=WebWindows(0).PageWindows

UsePageWindows(index),whereindexistheindexnumberofaniteminthePageWindowscollection,toreturnasinglePageWindowExobject.ThefollowingstatementreturnsthefirstPageWindowExobjectinthecollection.

SetmyPageWindow=WebWindows(0).PageWindows(0)

UsetheAddmethodtoaddapagewindowtothePageWindowscollection.ThefollowingexampleopensthespecifiedpageinmyWebOneandaddsthepagetothePageWindowscollection.

DimmyPageWindowsAsPageWindows

SetmyPageWindows=ActiveWeb.WebWindows(0).PageWindows

myPageWindows.Add("C:\MyWebSites\myWebOne\bugrep.htm")

UsetheApplicationpropertytoreturntheApplicationobjectfromthePageWindowscollection.ThefollowingexamplereturnstheApplicationobjectfromthePageWindowscollection.

myAppName=WebWindows.PageWindows.Application.Name

UsetheClosemethodtocloseaPageWindowExobjectorthecollectionofopenPageWindows.ThefollowingstatementclosesthefourthPageWindowExobjectforthefirstWebWindowExobject.

WebWindows(0).PageWindows(3).Close

UseClose(index),whereindexistheindexnumberofaniteminthePageWindowscollection,tocloseasinglePageWindowExobjectasshowninthefollowingstatements.Bothstatementsclosethesamepagewindow.Inthefirststatement,youclosethepagewindowusingtheindexnumberfortheClosemethod,whileinthesecondstatement,youclosethepagewindowbyspecifyingtheindexnumberforthepageyouwanttoclose.

WebWindows(0).PageWindows.Close(2)

WebWindows(0).PageWindows(2).Close

UseClose()toclosealloftheopenPageWindowExobjectsinthePageWindowscollection.ThefollowingstatementclosesalloftheopenpagesinthePageWindowscollection.

WebWindows(0).PageWindows.Close()

UsetheCountpropertytoreturnthetotalnumberofpagewindowsinthePageWindowscollection.ThefollowingexamplereturnsthenumberofpagewindowsinthecollectionofPageWindows.

myPageCount=WebWindows(0).PageWindows.Count

UsetheParentpropertywhenyouwanttoreturnthecontainerforthePageWindowscollection.ThefollowingstatementreturnstheWebWindowExcontainerobjectforthefirstPageWindowExobjectusingtheParentproperty.

SetmyParent=ActiveWeb.WebWindows(0).PageWindows.Parent

PropertiesCollection

Multipleobjects Properties

AcollectionofmetadataasPropertyobjects.EachiteminthePropertiescollectionrepresentsanitemassociatedwithanindividualWebEx,WebFile,orWebFolderobject.Formoreinformation,seethetableofPropertyKeysinUsingthePropertyKeys.Chooseatopicfromthefollowinglisttogodirectlytothattopic.

UsingthePropertiesobject

UsingthePropertiescollectionwithinaWebsite

Usingthepropertykeys

UsingthePropertiesobject

UsetheAddmethodtoaddapropertytothePropertiescollection.ThefollowingstatementaddsacopyrightstatementtothePropertiescollection.

ActiveWeb.Properties.Add"Copyright",_

Youcanalsoaddandremovecategoriesandapprovallevels.

UsetheApplyChangesmethodtoapplyaPropertyobjectthathasbeenaddedtothecollectionofProperties.ThefollowingstatementsaddandapplyacopyrightpropertytothePropertiescollection.

ActiveWeb.Properties.Add"Copyright",_

ActiveWeb.Properties.ApplyChanges

UsetheCountpropertytoreturnthetotalnumberofpropertiesinthePropertiescollection.ThefollowingexamplechecksthatthenumberofpropertiesinthePropertiescollectionhasincreasedsincetheCopyrightpropertywasaddedandappliedtothecollection,andthengoesontoaddthecopyrighttoaWebsitepage.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\CohoWinery",oryoumaysubstituteanalternativeWebsiteURL.

PrivateSubcopyrightAdd()

DimmyWebAsWebEx

DimmyCopyrightAsString

DimmyCountAsInteger

DimmyMessageAsString

myCount=ActiveWeb.Properties.Count

myMessage="Nonewpropertieshavebeenadded."

SetmyWeb=Webs.Open("C:\MyWebSites\CohoWinery")

myWeb.Activate

ActiveWeb.Properties.Add"Copyright",myCopyright

IfmyCount<>ActiveWeb.Properties.Count–1Then

MsgBoxmyMessage

ExitSub

ActiveWeb.RootFolder.Files("Zinfandel.htm").Open

ActiveDocument.body.insertAdjacentText"BeforeEnd",_

ActiveWeb.Properties("Copyright")

ActiveWeb.Close

EndSub

UsetheDeletemethodtodeleteasingleproperty.ThefollowingstatementdeletestheCopyrightpropertyfromthePropertiescollection.

ActiveWeb.Properties.Delete("Copyright")

UsetheParentpropertywhenyouwanttoreturnthecontainerforthePropertiescollection.Forexample,thefollowingstatementreturnstheURLoftheparentWebsite.

myParentURL=ActiveWeb.Properties.Parent.Url

UsingthePropertiescollectionwithinaWebsite

UseProperties(index),whereindexisthePropertyKeyoftheiteminthePropertiescollection,toreturnasingleproperty.ThefollowingexamplereturnsthevalueofthePropertyKeyvti_hassearchbot.

PrivateSubCheckForSearchBot()

DimmyPropertiesAsProperties

DimmyFoundSearchBotAsBoolean

SetmyProperties=ActiveWeb.Properties

WithmyProperties

myFoundSearchBot=.Item("vti_hassearchbot")

EndWith

EndSub

ImportantThevaluesforpropertiesarevariant—thatis,eachvaluecanbeastring,aBoolean,oranarray.YoucanusetheTypename()functiontodeterminethetypeofthepropertyvalue.

NoteTorunthefollowingexampleyoumustcreateaformthatcontainsatextboxcalledtxtCategories.Also,noticethatmyCategoriesisdeclaredasavarianttypeinthisexample.Inapreviousexample,myFoundSearchBotwasdeclaredBoolean—butcouldalsohavebeendeclaredasastring.

PrivateSubGetWebPropertyCategories()

DimmyCategoriesAsVariant

DimmyCategoryAsVariant

DimtxtCategoriesAsString

SetmyProperties=ActiveWeb.Properties

WithmyProperties

myCategories=.Item("vti_categories")

ForEachmyCategoryInmyCategories

txtCategories=txtCategories&"|"&myCategory

EndWith

EndSub

Usingthepropertykeys

ThepropertykeyscanbeavaluabletoolfororganizinginformationaboutyourWebsites.Forexample,youcanaddcategoriestothemasterlistofcategoriesonyourWebsite.

ImportantThecategorynamescanbeaddedtothecategorieslistusingcasesensitivity,butwillnotdisplaywithcasesensitivityintheUserInterface(UI).Becauseofthis,asituationmayoccurwhereausercreatesacategoryontheclient,suchas"WebAdministrators",andaduplicatecategoryexistsontheserver,suchas"webadministrators".Inthiscase,intheUI,MicrosoftFrontPagewillassignbothcategoriestothe"webadministrators"categoryandneitherofthesecanbedeletedfromtheWebsite(intheUI).Programmatically,thecasesensitivitywillcorrectlydisplayintheImmediateandLocalwindowsoftheVisualBasicEditor.

ThefollowingexamplefirstaddsacategorytothepropertiesfortheactiveWebsite,deletestheWaitingcategoryfromthesamelist(vti_categories),andthenaddsthenewcategorytoeachofthefilesintheactiveWebsite.

NoteWhencreatinganewcategory,youmustfirstaddthenewcategorytotheWebsitebeforeyouaddittoanyofthefiles.Theprocedure,AddCategories,addsanewcategorytotheWebsiteandthenextprocedure,AddCategoryToFiles,addsthesamecategorytoallofthefilesintheWebsite.

PrivateSubAddCategories()

DimmyWebAsWebEx

DimmyCategory(2)AsString

DimmyItemAsVariant

SetmyWeb=ActiveWeb

myCategory(0)="+webadministrators"

myCategory(1)="-waiting"

ActiveWeb.Properties("vti_categories")=myCategory

ActiveWeb.Properties.ApplyChanges

'Listalloftheitemsinvti_categoriesintheImmediatewindow

ForEachmyItemInmyWeb.Properties("vti_categories")

Debug.PrintmyItem

EndSub

PrivateSubAddCategoryToFiles()

DimmyWebAsWebEx

DimmyCategories(1)AsString

DimmyFileAsWebFile

DimmyItemAsVariant

SetmyWeb=ActiveWeb

myCategories(0)="+webadministrators"

myFile.Properties("vti_categories")=myCategories

myFile.Properties.ApplyChanges

'Listalltheitemsinvti_categoriesintheImmediatewindow

ForEachmyItemInmyFile.Properties("vti_categories")

Debug.PrintmyItem

EndSub

NoteAlthoughyoucancreatenewcategories,suchas"webadministrators",thataren'tincludedinthecategoriesthatareautomaticallyinstalledwithFrontPage,thesenewcategorieswon'tbevisibleintheUserInterface(UI)untiltheyareaddedtotheWebsite.Noticethatinthepreviousexample,thenewcategorywasaddedtotheWebsitefirstandwillbevisibleintheUI.

ThefollowingtableprovidesdetailedinformationaboutthepropertykeysavailableinFrontPage.NoticethatallpropertykeysinFrontPagestartwith“vti_”.Itissuggestedthatyouprefixthepropertykeysyouwanttoaddwithashortname,suchasanabbreviationforthenameofyourcompany,toreducethechancesofnamingconflictswithotherproperties.

PropertyKey Description Permission

vti_approvallevel

Theapprovallevelsetforapage.TheavailablelevelsareAssignedTo,ReviewStatus,andCategories.

Read/write

ListofavailableapprovallevelsthatcanbeappliedtodocumentsinaWebsite.Thispropertykeyisastringvector(oranarrayof

vti_approvallevelsstrings).UsedtopopulatetheWeb-widelistofknown"reviewstatuses"(alsoknownas"approvallevels")thataresetforadocument.TheapprovallevelsyoucansetareAssignedTo,ReviewStatus,andCategories.

Read-only

vti_approvedby Theauthenticatednameofthepersonwhoapprovedthepage. Read-only

vti_assignedbyTheauthenticatednameofthepersonwhoassignedthepagetoauser.

Read-only

vti_assigneddate Thisisthedatethatthepagewaslastassignedtoauser. Read-only

vti_assignedtoTheauthenticatednameofthepersontowhomthepageisassigned.

Read-only

vti_author

Returnstheauthor'snameinstringformat.Theidentificationoftheauthenticatedauthorwhohas,oris,makingchangestothedocument.

NoteThisisdifferentfromtheAuthorpropertystoredaspartofMicrosoftOfficedocumentproperties,whichcanbesetbytheusertoanyarbitraryvalue.

Read-only

vti_casesensitiveurls

TrueiftheWebsiteisrunningonaserverwhereURLsarecasesensitive,suchasaserverrunningUNIX.Forexample,ifthispropertyissettoTrue,thenafilenamedMyFile.htmandafilenamedmyFile.htmaretreatedastwoseparatefiles.

Read-only

Themasterlistofcategories.Thispropertykeyisastringvector(or

vti_categories

anarrayofstrings)thatisusedforbothWeb-levelanddocument-levelmetadata.AttheWeb-sitelevel,thepropertykeycontainsalistofallknowncategoriesthatexistintheWebsite.Atthedocumentlevel,itcontainsalistofallthecategoriestowhichthespecifieddocumentbelongs.

NoteThesecategoriesareautomaticallyupdatedwheneveracategoryisaddedormodifiedinanyway.

Read/write

vti_clientvercutoff

Youcanusethispropertykeytosetaversioncutoffstring.Thisismostcommonlyusedinamulti-versionenvironmenttopreventolderversionsoftheapplicationfromrunningonaspecificserver.Formoreinformation,seetheFrontPageServerExtensionsResourceKit.

Read/write

vti_dataconns ListofdataconnectionsusedbydatabasefeaturesinFrontPage. Read-only

vti_defaultcharset ThedefaultcharactersetfortheWebsiteorpage. Read-only

vti_defaultlanguage ThedefaultlanguagefortheWebsiteorpage. Read-only

vti_description Providesamulti-linetextboxfortheusertowritecommentsin. Read/write

vti_donotpublish SettoTrueifthepageismarkedas"draft"or"nottobepublished." Read/write

vti_filesize Thesizeofthefileinbytes. Read-onlyThispropertykeycorrespondstothegeneratortagwithinanHTML

vti_generator

document.Thevalueofthevti_generatorpropertykeycontainsthenameoftheapplicationthat"generated"thedocument,whichmaybedifferentfromtheapplicationthatwasinvokedtohandlethepage.Forexample,ifyoucreatedoreditedapagewithMicrosoftWord,andthenretrievedthevalueofthevti_generatorpropertykeyinMicrosoftFrontPageVisualBasicforApplicationsforthatdocument,thevalueofthevti_generatorpropertykeywouldbeMicrosoftWord--eventhoughtheprocedurecallwasgeneratedbyFrontPage.Validvaluesare"MicrosoftWord","MicrosoftAccess","MicrosoftFrontPage",andsoon.

NoteFrontPagedeferstoWordwhenthere'sathemeconflictifthevti_generatorpropertykeycontains"MicrosoftWord".

Read-only

vti_globalpage

Marksapageasglobal,thatis,atop-levelpageinthenavigationstructure,onthesamelevelas,butnotequalto,thehomepage.

Read/write

vti_hasframeset

Trueifthepagecontainsframesets.Thispropertykeyisusedwhenconstructinglinkbarlinks.Whenthepagethatisbeinglinkedisaframeset,thelink'stargetattributeisforcedto"_top".Thiscausesthenewpagetoreplacethecurrentframesettopreventrecursive

Read-only

framesetsatbrowsetime.

vti_hasruntimebots Trueifthepagehasrun-timebotsonit. Read-only

vti_htmlextensionsAconcatenatedstringofextensionsusedtospecifyaWebfile,suchashtm.html.asp.

Read-only

vti_httpdversion TheversionofFrontPagethatisrunningonthehttpdserver. Read-only

vti_imagemapformat

ThispropertykeysetstheURLformatusedbytheserver-sideimagemapprocessor.ValidvaluesareNCSAandCERN.ThispropertykeyisonlyusefulforpriorversionsofFrontPage.FrontPagenowusesclient-sideimagemaps.

Read/write

vti_imagemapurlprefix

Setstheserver-relativeURLoftheserver-sideimage-mapprocessorfortheselectedimage-mapformat.Ifthevalueofthevti_imagemapurlprefixpropertykeyissettoanemptystring(""),server-sideimagemapsarehandledautomaticallybytheFrontPageServerExtensions.Forotherformats,providethenameandlocationoftheimage-mapprocessor.Tospecifyclient-sideimagemaps,setthisvariabletoanemptystring.Formoredetailedinformation,seetheFrontPageServerExtensionsResourceKit.

Read/write

vti_insecureserverurl

Retrievesthehttp://URL(unsecuredURL)foraWebsite.Providescompatibilitywitholderbrowsersthatmaynothavesecurebrowsingcapability.Formoreinformation,seetheFrontPage

Read-only

ServerExtensionsResourceKit.

vti_isbrowsable

Trueifthepagefolderisbrowsable.UseFolder.IsBrowsabletosetthisvalue..

Read-only

vti_ischildweb

Trueifthespecifiedfolderistherootofasubsite.UseFolder.MakeWebandFolder.RemoveWebtomodify.

Read-only

vti_isexecutable

SetthispropertytoTruetoenableifthisfolderismarkedforexecutablecontentontheserver.UseFolder.IsExecutabletosetthisvalue.

Read/write

vti_isscriptable

SetthispropertytoTrueifscriptingisenabledforthisfolder.UseFolder.IsScriptabletosetthisvalue.

Read-write

vti_longfilenames

Trueiftheserversupportsfilenamesthatarelongerthanthestandard8.3fileformat.(The8.3fileformatonlysupportsfilenameswitheightcharactersandextensionswiththreecharacters,suchas"filename.txt".)

Read-only

vti_metatags

ThispropertykeycorrespondstothecontentswithintheMETAtagsinanHTMLdocument.AlloftheinformationcontainedinthispropertykeyisaddedtotheMETAtagscollection.

Read-only

vti_modifiedby Authenticatednameoftheauthorwholastmodifiedthepage. Read-only

vti_navbuttonhomelabel

Theimagefileassociatedwiththebuttonthatlinkstothehomepage.

NoteThisimageisretrievedfrom Read/write

thethemeassociatedwiththefileandisnotcustomizable.

vti_navbuttonhomelabeltext

Thetextthatoverlaysthevti_navbuttonhomelabel.

NoteThistextiscustomizablebytheuser.

Read/write

vti_navbuttonlabeltext

Thetextthatoverlaysthevti_nvabuttonuplabel.

Read/write

vti_navbuttonnextlabel

Theimagefileassociatedwiththebuttonthatlinkstothenextpageinthenavigationstructure.

NoteThisimageisretrievedfromthethemeassociatedwiththefileandisnotcustomizable.

Read/write

vti_navbuttonnextlabeltext

Thetextthatoverlaysthevti_navbuttonnextlabel.

Read/write

vti_navbuttonprevlabel

Theimagefileassociatedwiththebuttonthatlinkstothepreviouspageinthenavigationstructure.

Read/write

Thetextthatoverlaysthevti_navbuttonprevlabel.

vti_navbuttonprevlabeltext NoteThistextiscustomizablebytheuser.

Read/write

vti_navbuttonuplabel

Theimagefileassociatedwiththebuttonthatlinkstothepageonelevelupinthenavigationstructure.

Read/write

vti_noclientimagemaps Trueifclientimagemapsareprohibited. Read-only

vti_nonnavpageTrueifthepageisn'tassociatedwithanavigationnodewithinthenavigationstructure.

Read/write

vti_nosourcecontrol

TrueiftheWebsiteisnotbeingstoredundersourcecontrol.PreventsaddingafiletosourcecontrolifthispropertyissettoTrue.

NoteIfafilehaspreviouslybeenaddedtoasourcecontrolprojectwiththevti_nosourcecontrolpropertysettoFalse,andthepropertyissubsequentlysettoTrue,thefilewillnotberemovedfromthesourcecontrolproject.

Read/write

Thispropertykeycorrespondstothe"originator"METAtaginanHTMLdocument.Thevalueofthispropertykeycontainsthenameoftheapplicationthatcreatedthedocument.Youshouldneveroverwritethispropertykeywiththenameofanotherapplication.The

vti_originator

vti_generatorpropertykeyshouldbeusedtotracktheapplicationthatlast"generated"theHTMLpage.SimplyeditingadocumentinFrontPagewillchangethevalueofthevti_generatorpropertykeyto"MicrosoftFrontPage".Validvaluesare"MicrosoftWord","MicrosoftAccess","MicrosoftFrontPage",andsoon.

NoteFrontPagedeferstoWordwhenthere'sathemeconflictifthevti_generatorpropertykeycontains"MicrosoftWord".

Read-only

vti_privatetext

Thevalueofthispropertykeymustbeaninteger.Zeroornotpresentisthedefault.Anon-zerovaluemeansthatthepagewon'tbeaddedtoanytextindexes.Thispropertykeyonlyworkswiththebuilt-intextindexinginFrontPageandisnotrecognizedbyMicrosoftInternetInformationServices(IIS).

Read/write

vti_progid

Thiscorrespondstothe"progid"METAtaginanHTMLdocument.Thevalueofthispropertykeydetermineswhichapplicationopensthedocumentwhenauserclicks(ordouble-clicks)thedocument'sfilenameinWindowsExplorer.Validvaluesare"FrontPage.Editor.Document","Word.Document","Excel.Sheet","PowerPoint.Slide","Access.Application".

NoteFrontPagedeferstoWord

Read-only

whenthere'sathemeconflictifthevti_generatorpropertykeycontains"MicrosoftWord".

vti_scriptlanguage Indicateswhichscriptinglanguageisenabledontheserver. Read-only

vti_secureserverurl

Retrievesthehttps://URL(securedURL)foraWebsite.ProvidesasecureenvironmentforconfidentialtransactionsovertheInternet.FormoreinformationseetheFrontPageServerExtensionsResourceKit.

Read-only

vti_serveripaddress

TheIPaddressoftheserver.

NoteAnIPaddressbeginningwith127representsalocalserver.

Read-only

vti_serverlanguageThelanguageoftheoperatingsystem.Usedforlocalizationpurposes.

Read-only

vti_showhiddenpages Trueifhiddenpagesaredisplayed. Read-only

vti_sourcecontrolcheckedoutby Authenticatednameoftheauthorwholastcheckedoutapage. Read-only

vti_sourcecontrolerror

Theerrorlastreturnedbythesourcecontrolsystem.ThiserrorisaddedtotheMETAtaginformationifanerroroccurswhilethefileisbeingaddedtoasourcecontrolproject.

Read-only

vti_sourcecontrolproject

Thenameofthesourcecontrolproject.ForaMicrosoftVisualSourceSafeproject,thestringwouldincludethe"$"symbol,asin"$/myProject"

Read-only

Thevalueofthispropertykeyisthetypeofsourcecontrolinuseonthat

vti_sourcecontrolsystem

Website.CanbeMicrosoftVisualSourceSafeorMicrosoftFrontpageLightWeightsourcecontrol.Validvaluesforthesetwotypesofsourcecontrolare"VSS"and"LW",respectively.Thispropertykeyissetwhenasourcecontrolprojectisstarted.Formoreinformationonsourcecontrolprojects,seeManagingSourceControlProjects.

Read-only

vti_sourcecontrolversionAnumberedstringthatcontainstheversionofthesourcecontrolsystemthatisinuse.

Read-only

vti_textextensions

Aconcatenatedstringofextensionsthatarecommonlyusedtodenotetextfiles.Forexample,theconcatenatedstringmightcontain".txt.rpt..."

Read-only

vti_themedefault ThedefaultthemeoftheWebsite. Read-only

vti_themesusecss TrueifCSSisusedtopresentthetheme. Read/write

vti_timecreated

Thetimestampwhenthepagewascreated.ThetimestampisinUniversalTimeCoordinate(UTC)orGreenwichtime.

Read-only

vti_timelastmodified

Thetimethatthepagewaslastmodified.ThetimestampisinUTCtime.Thisisonlysetwhentheauthoreditsthepagedirectly.

Read-only

vti_timelastwrittenThetimethatthepagewaslastrewritten.ThetimestampisinUTCtime.

Read-only

vti_-title Thevalueofthetextbetweenthe<TITLE>tagsonthepage. Read-only

vti_usernames ThelistofknownusernamesforaspecifiedWebsite. Read-only

ThetypeofWebsiteserver.Valid

vti_webservertypevaluesinclude,"MSIIS"forMicrosoftInternetInformationServicesand"PWS"forPersonalWebServer.

Read-only

vti_welcomenames

Aconcatenatedlistoffilenamesthatcanbeusedasthefilenameforthehomepage,suchas"index.htmindex.htmldefault.htm".

Read-only

ThemesCollectionMultipleobjects Themes

AcollectionofThemeobjects.EachThemeobjectrepresentsathemeassociatedwithanHTMLpageoraWebsiteinMicrosoftFrontPage.TheThemeobjectisamemberoftheThemescollection.

UsingtheThemescollection

UsetheThemespropertytoreturntheThemescollection.TheThemespropertycanbeusedwitheithertheApplicationortheWebExobject.TheThemespropertyfortheApplicationobjectisthecollectionofthemesavailableinFrontPage.TheThemespropertyfortheWebExobjectisthecollectionofthemesappliedtothefileswithinaWebsite,orthecollectionofthemesappliedtoaWebsite.ThefollowingstatementillustratesboththeThemesandCountpropertiesandreturnsthenumberofitemsintheThemescollectionthatareavailableinFrontPage.

myTotalThemeCount=Application.Themes.Count

ThefollowingstatementreturnsthenumberofthemeswithintheactiveWebsite.

myWebThemeCount=ActiveWeb.Themes.Count

UseThemes(index),whereindexistheindexnumberofathemeitem,toreturnasingleThemeobject.ThefollowingstatementreturnsthefirstthemeintheThemescollection.

myThemeOne=Application.Themes(0)

UsetheApplicationpropertytoreturntheApplicationobject.ThefollowingexamplereturnstheversionandbuildnumberofFrontPagefromwithintheThemescollection.

NoteTorunthisprocedureyoumusthaveatleastoneopenWebsite.

PrivateSubGetBuildNumber()

DimmyThemesAsThemes

DimmyBuildAsString

SetmyThemes=ActiveWeb.Themes

myBuild=myThemes.Application.Build

EndSub

UsetheParentpropertywhenyouwanttoreturnthecontainerfortheThemescollection.Forexample,thefollowingstatementreturnstheURLassociatedwiththeparentcontaineroftheThemescollection.

myParentUrl=ActiveWeb.Themes.Parent.Url

WebFilesCollectionMultipleobjects WebFiles

WebFileMultipleobjects

AcollectionofWebFileobjects.EachWebFileobjectrepresentsalloftheopenfilesinaWebsite.TheWebFileobjectisamemberoftheWebFilescollection.

UsingtheWebFilesobject

UsetheFilespropertytoreturntheWebFilescollection.ThefollowingstatementreturnstheWebFileobjectsintheWebFilescollection.

SetmyWebFiles=Application.Webs(0).RootFolder.Files

UseWebFiles(index),whereindexistheordinalnumberofanitemintheWebFilescollection,toreturnasingleWebFileobject.ThefollowingstatementreturnsthefirstWebFileobjectinthecollection.

SetmyWebFile=ActiveWeb.RootFolder.Files(0)

UsetheAddmethodtoaddaWebFileobjecttotheWebFilescollection.ThefollowingstatementaddsanewWebFileobjecttothecollectionofWebFiles.

myWebFiles.Add("C:\NewWebWebFiles\SalesStatistics.htm")

UsetheApplicationpropertytoreturntheApplicationobjectfromwithintheWebFilescollection.ThefollowingstatementreturnstheApplicationobjectfromtheWebFilescollection.

myApp=ActiveWeb.RootFolder.Files.Application

UsetheCountpropertytoreturnthenumberofopenfilesintheWebFilescollection.ThefollowingstatementreturnsthenumberoffilesinthecollectionofWebFiles.

myCount=Webs(0).RootFolder.WebFiles.Count

UsetheDeletemethodtodeleteaWebFileobject.ThefollowingstatementdeletesthethirdfileintheWebFilescollection.

Webs(0).RootFolder.Files(2).Delete

UsetheParentpropertywhenyouwanttoreturnthecontainerfortheWebFilescollection.ThefollowingstatementreturnstheURLofthefolderforthesecondfileintheactiveWebsite.

myWebFileParent=ActiveWeb.RootFolder.Files(1).Parent.Url

WebFoldersCollectionMultipleobjects WebFolders

WebFolderMultipleobjects

AcollectionofWebFolderobjects.EachWebFolderobjectwithintheWebFolderscollectionrepresentsafolderinaWebsite.TheWebFolderobjectisamemberoftheWebFolderscollection.

NoteAllofthemethodsthatinvolvechangingthelocationofafolder,suchasCopyorMove,onlychangethelocationwithinthecurrentWebsite;youcannotmoveafolderfromoneWebsitetoaanotherWebsite.

UsingtheWebFoldersobject

UseWebFolders(index),whereindexistheindexnumberofanitemintheWebFolderscollection,toreturnasingleWebFolderobject.ThefollowingexamplereturnsthefirstWebFolderobjectinthecollection.

SetmyFolder=ActiveWeb.RootFolder.Folders(0)

UsetheAddmethodtoaddanewWebFolderobjecttotheWebFolderscollectioninaWebsite.BothofthefollowingstatementsaddaWebFoldertothecollectionofWebFoldersintheactiveWebsite—parenthesesarenotrequiredforthefoldername,asshowninthesecondstatement.

NoteTheFolderUrlargumentwithinthequotes("CohoWinery")shouldonlyincludethenewfoldername,nottheentireURL,unlessyouareaddinganewURLtothelocationdesignatedastheFolderUrl.TheprogramwillfailiftheentireURLisincludedforexistingURLs.

ActiveWeb.RootFolder.Folders.Add("CohoWinery")

ActiveWeb.RootFolder.Folders.Add"CohoWinery"

UsetheCountpropertytoreturnthenumberoftotalnavigationnodesintheWebFolderscollection.ThefollowingstatementreturnsthenumberofWebfoldersintheCohoWineryWebsite.

Webs("C:\WebServerOne\CohoWinery").Folders.Count

UsetheDeletemethodtodeleteafolderfromaWebsite.ThefollowingstatementsdeletethetenthWebFolderobject.Thesecondstatementusesthenameofthefolderinsteadoftheindexnumbertodesignatethefoldertodelete.

ActiveWeb.RootFolder.Folders(9).Delete

ActiveWeb.RootFolder.Folders("TempFolder").Delete

UsetheCopymethodtocopyaWebFolderobject.Thefollowingexamplecopiesafolder(WebFolders(4))toanotherfolderontheactiveWebsite

(ChardonnayInventory).Forpurposesofthisexample,WebFolders(4)isafoldernamedInventoryintheCohoWineryWebsite.Thisfoldercontainstheentirewineinventory—buttheWebdesignerwantedtofeaturethesaleonChardonnaywinesandcreatedatemporaryfolderthatwillbeeditedtocontainonlyChardonnaywine.

PrivateSubCopyInventory()

myFolder.Copy("C:\CohoWinery\ChardonnayInventory,False,True)

EndSub

UsetheParentpropertywhenyouwanttoreturnthecontainerfortheWebFolderscollection.Thefollowingstatementreturnsthecontainerforthefourthfolder.

myParent=Webs.RootFolder.Folders(3).Parent

WebsCollectionApplication Webs

WebMultipleobjects

AcollectionofWebExobjects.EachWebExobjectrepresentsaWebsite,whichcaneitherbedisk-based(onalocalharddrive)orserver-based(onaWebserver).TheWebExobjectisamemberoftheWebscollection.

UsingtheWebscollection

UsetheWebspropertytoreturntheWebscollection.YoucanalsousetheApplicationpropertytoreturntheApplicationobject.ThefollowingstatementusestheApplicationobjecttoreturnthefirstitemintheWebscollectionorusethesecondstatementtoreturntheentirecollectionofWebsites.

SetmyWebOne=Application.Webs(0)

SetmyWebs=Application.Webs

UseWebs(index),whereindexistheindexnumberofanitemintheWebscollection,toreturnasingleWebExobject.ThefollowingstatementreturnsthethirdWebsiteinthecollectionofopenWebExobjects.

SetmyGetWebThree=Webs(2)

UsetheAddmethodtoaddanitemtothelistofavailableitemsintheWebscollection.ThefollowingstatementaddstheCohoWineryWebsitetotheWebscollection.Ifitdoesn'texist,FrontPagewillcreateanewWebsiteatthespecifiedpathandopenit.

Webs.Add("C:\MyDocuments\MyWebSites\CohoWinery")

UsetheApplicationpropertytoreturninformationabouttheapplicationfromwithintheWebscollection.ThefollowingstatementreturnstheversionnumberoftheApplicationobject.

ActiveWeb.Webs.Application.Version

UsetheCountpropertytoreturnthenumberofopenWebsitesintheWebscollection.ThefollowingstatementreturnsthenumberofopenWebsites.

Webs.Count

UsetheDeletemethodtopermanentlydeleteaWebsitefromtheWebscollection.ThefollowingstatementdeletestheCohoWineryWebsite.

Webs.Delete("C:\MyDocuments\MyWebSites\CohoWinery")

UsetheOpenmethodtoopenaWebsite.ThefollowingstatementopensaWebsiteandaddsittothecollectionofitemsintheWebscollection.

Webs.Open("C:\MyDocuments\MyWebSites\CohoWinery")

UsetheParentmethodwhenyouwanttoreturnthecontaineroftheWebscollection,whichistheapplication.ThefollowingstatementreturnstheApplicationobject.

SetmyParent=Webs.Parent

WebWindowsCollection

Multipleobjects WebWindowsWebWindowMultipleobjects

AcollectionofWebWindowExobjects.EachWebWindowobjectrepresentsanopenWebsiteinMicrosoftFrontPage.TheWebWindowExobjectisamemberoftheWebWindowscollection.

UsingtheWebWindowsCollection

UseItems(index),whereindexistheindexnumberofanitemintheWebWindowscollection,toreturnasingleWebWindowExobject.ThefollowingexamplereturnstheCaptionpropertyforthefourthitemintheWebWindowscollection.

FunctionReturnWebWindowCaption()AsString

DimmyCaptionAsString

DimmyWebWindowAsWebWindowEx

SetmyWebWindow=Application.WebWindows(3)

myCaption=myWebWindow.Caption

ReturnWebWindowCaption=myCaption

EndSub

UsetheWebWindowspropertytoreturntheWebWindowscollection.ThefollowingexampleclosesalloftheopenWebWindowExobjectsintheWebWindowscollectionexcepttheActiveWebWindowobject.

PrivateSubCloseWebWindows

DimmyWebWindowsAsWebWindows

DimmyActiveWebWindowAsWebWindowEx

SetmyWebWindows=Application.WebWindows

SetmyActiveWebWindow=ActiveWebWindow

ForEachmyWebWindowInmyWebWindows

IfmyWebWindow.Caption<>myActiveWebWindow.CaptionThen_

myWebWindow.Close

EndSub

UsetheApplicationpropertytoreturntheApplicationobject.Ifyou'realreadyworkingwiththeWebWindowscollectionandyou'dliketochecktheversionnumberoftheapplication,youcaneasilyaccessitthroughyourWithmyWebWindowsstatementasshowninthefollowingexample.

WithmyWebWindows

myWebWindowCount=myWebWindows.Count

myAppVersion=.Application.Version

IfmyAppVersion<"4.0"Then

MsgBox"PleaseupgradeyourFrontPagesoftware."

myCaption=myWebWindow.Caption

WithmyPageWindows

myPageCount=PageWindows.Count

EndWith

YoucanusetheClosemethodtocloseanindividualWebWindowExobject,multipleWebWindowExobjects,orallWebWindowExobjectsinFrontPage.FormoredetailsontheClosemethod,seetheusagedescribedinthefollowingtable.

ImportantFrontPagewillclosetheapplicationifyouusetheClosemethodtocloseallWebWindowExobjectsinFrontPage.

CloseMethodUsage Code

CloseanindividualWebWindowExobjectintheapplication

Application.WebWindows(index).Close

Application.WebWindows.Close(index)

ClosemultipleWebWindowExobjectsintheapplication(asshowninthepreviousexample)

IfmyWebWindow.Caption<>_

myActiveWebWindow.CaptionThen_

myWebWindow.Close

CloseallWebWindowExobjectsintheapplication

Application.WebWindows.Close

Closeanindividual Webs(index).WebWindows(index).Close

WebWindowExobjectinaWebsite

ClosemultipleWebWindowExobjectsinaWebsite

SetmyWeb=Web(index).WebWindows

IfmyWebWindow.Caption_

<>myActiveWebWindow.CaptionThen_

myWebWindow.Close

CloseacollectioninaWebsite

Webs(index).WebWindows.Close

ClosingallWebWindowExobjectsinFrontPagefunctionsthesameastheQuitmethod

Theexpression,Application.WebWindows.Closeisthesameas,Application.Quit.

UsetheCountpropertytoreturnthenumberofWebWindowExobjectsinthecollection.ThefollowingexamplereturnsthenumberofWebWindowExobjects.

Web.WebWindows.Count

UsetheParentpropertywhenyouwanttoreturnthecontainerfortheWebWindowscollection.ThefollowingstatementreturnstheApplicationobject.

Application.WebWindows.Parent.Name

ApplicationObjectApplication Multipleobjects

RepresentstheMicrosoftFrontPageapplication.TheApplicationobjectincludespropertiesandmethodsthatreturntop-levelobjects.Forexample,theActiveDocumentpropertyreturnsadocumentobjectthatreferencestheFrontPagePageobjectmodelthatiscompatiblewithMicrosoftInternetExplorer4.0andlater.

UsingtheApplicationObject

UsetheApplicationpropertytoreturntheApplicationobject.YoucanusetheApplicationpropertyfromanyoftheobjectsinFrontPage.ThefollowingexampleaccessestheApplicationobject,andthendisplaystheOpendialogbox.

Application.FileDialog(msoFileDialogOpen).Show

Manyofthepropertiesandmethodsthatreturnthemostcommonuser-interfaceobjects,suchastheActiveDocumentproperty,canbeusedwithouttheApplicationobjectqualifier.Forexample,insteadofwritingApplication.ActiveDocument.Title,youcanwriteActiveDocument.Title.PropertiesandmethodsthatcanbeusedwithouttheApplicationobjectqualifierareconsidered"global."ToviewglobalpropertiesandmethodsintheObjectBrowser,click<globals>atthetopofthelistintheClassesboxoftheObjectBrowser.

Remarks

TouseAutomationtocontrolFrontPagefromanotherapplication,usetheCreateObjectorGetObjectfunctiontoreturnaFrontPageApplicationobject.ThefollowingMicrosoftWordVisualBasicforApplications(VBA)examplestartsFrontPage,opensanexistingWebsite,andclosestheWebsite.

PrivateSubStartFrontPage()

DimmyNewFPAsVariant

SetmyNewFP=CreateObject("FrontPage.Application")

myNewFP.Webs.Open("C:\MyWebs\AdventureWorks")

myNewFP.Webs.Close"(C:\MyWebs\AdventureWorks")

SetmyNewFP=Nothing

EndSub

BasicListObjectBasicList Multipleobjects

ContainsinformationaboutthebasiclisttypeusedwithinMicrosoftFrontPage.TheBasicListobjectallowsuserstoshareandcategorizeinformationbetweenWebsites.

UsingtheBasicListobject

UseLists.item(index),whereindexiseitherthenameofthebasiclistoritsnumericpositionwithinthecollection,toreturnasingleBasicListobject.ThefollowingexampledisplaysthenamesofallbasiclistsintheactiveWebsite.IftheWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubListAllLists()

'Displaysthenamesofallbasiclistsinthecollection

DimlstWebListAsList

DimstrNameAsString

DimblnFoundAsBoolean

'Setfoundflagtofalse

blnFound=False

'Checkifanylistsexistand,ifsocyclethroughthem

IflstWebList.Type=fpListTypeBasicListThen

'Setbooleanflagtofoundandnamestostring

blnFound=True

IfstrName=""Then

IfblnFound=TrueThen

'Displaynamesofallbasiclists

MsgBox"ThenamesofallbasiclistsinthecurrentWebare:"_

&vbCr&strName

MsgBox"TherearenobasiclistsinthecurrentWeb."

MsgBox"ThecurrentWebcontainsnolists."

EndSub

UsetheListscollection'sAddmethodtocreateanewlistoftypefpListTypeBasicList.ThefollowingexamplecreatesanewlistcalledNewShare.

SubNewList()

'AddsanewlisttothecurrentWebsite

DimobjListsAsLists

'Addnewlistanddisplaysamessagetotheuser.

objLists.AddName:="NewShare",_

ListType:=fpListTypeBasicList,_

MsgBox"AnewlistwasaddedtotheListscollection."

EndSub

DiscussionObjectDiscussion Multipleobjects

ContainsinformationaboutaDiscussionlistinaMicrosoftFrontPageWebsite.

ThisobjectissupportedonlybyWebpagesorsitesthatarebasedonMicrosoftWindowsSharePointServices.

UsingtheDiscussionobject

UsetheItempropertyfortheListscollectiontoreturnasingleDiscussionobject.ThefollowingexampleassumesthefirstlistintheactiveWebsiteisaDiscussionobject,andthenreturnsit.

DimobjDiscussionAsDiscussion

SetobjDiscussion=ActiveWeb.Lists(0)

DocumentLibraryObjectDocumentLibrary Multipleobjects

RepresentsthecollectionofdocumentsinthecurrentWebsite.

UsingtheDocumentLibraryobject

UseLists.Item(index),whereindexiseitherthenameofthedocumentlibraryoritsnumericpositionwithinthecollection,toreturnasingleDocumentLibraryobject.ThefollowingexampledisplaysthenamesofalldocumentlibrariesintheactiveWebsite.IftheWebsitecontainsnodocumentlibraries,amessageisdisplayedtotheuser.

SubListAllLibraries()

'Displaysthenamesofalldocumentlibraries

'inthecollection.

DimlstWebListAsList

DimstrNameAsString

blnFound=False

'Checkifanylistsexistandisso,cyclethroughthem

IflstWebList.Type=fpListTypeDocumentLibraryThen

'Setbooleanflagtofoundandaddnametostring

blnFound=True

IfstrName=""Then

IfblnFound=TrueThen

'Displaynamesofalldocumentlibraries

MsgBox"Thenamesofalldocumentlibrariesinthecurrentwebsiteare:"_

&vbCr&strName

MsgBox"Therearenodocumentlibrariesinthecurrentwebsite."

MsgBox"Thecurrentwebcontainsnolists."

EndSub

UsetheListobject'sAddmethodtocreateanewlistoftypefpListTypeDocumentLibrary.ThefollowingexamplecreatesanewdocumentlibrarycalledNewlibrary.

SubNewLibrary()

'Addsanewlisttothecurrentwebsite

DimobjListsAsLists

'Addnewlist

objLists.AddName:="NewLibrary",_

ListType:=fpListTypeDocumentLibrary,_

MsgBox"AnewlibrarywasaddedtotheListscollection."

EndSub

ListObjectMultipleobjects Lists

ListMultipleobjects

ContainsinformationabouttheListobjectandtheMicrosoftFrontPagecollaborationobjects.TheListobjectisabaseclassthatdefinesthecommonmembersusedbythedifferenttypesoflistsinFrontPage.Forexample,thecollaborationobjects,—theBasicList,Discussion,DocumentLibrary,andSurveyobjects—allowinformationtobesharedandexchangedbetweendifferentusersanddifferentwebsites.TheListobjectisamemberoftheListscollection.

UsingtheListobject

UseLists.Item(index),whereindexiseitherthenameofthelistoritsnumericpositionwithinthecollection,toreturnasingleListobject.ThefollowingexampledisplaysthenamesofalllistsintheactiveWebsite.IftheWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubListAllLists()

'Displaysthenamesofalllistsinthecollection

DimlstWebListAsList

DimstrNameAsString

'Cyclethroughlists

IfstrName=""Then

'Displaynamesofalllists

MsgBox"Thenamesofalllistsinthecurrentwebare:"_

&vbCr&strName

EndSub

Similarly,usetheWebFolderobject'sListpropertytoreturntheListobjectassociatedwiththefolder.

UsetheListobject'sFieldspropertytoreturnacollectionofListFieldobjectsthatdefinethefieldsinthecurrentlist.

ListFieldObjectMultipleobjects ListFields

ListFieldWeb

ContainsinformationaboutthefieldsthatmakeupaListobject.Thefieldsofalistdefinethecolumnsthatappearinthelistandpresentinformationabouttheitemsinthelist.TheListFieldobjectisabaseclassthatdefinesthecommonmembersusedbythedifferenttypesoffieldsinMicrosoftFrontPagelists.

UsingtheListFieldobject

UseListFields.Item(index),whereindexistheeithernameofthefieldorit'spositionwithinthecollectiontoreturnasingleListFieldobject.Thefollowingexampledisplaysthenamesofallfieldsinthecurrentlist.IftheWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubListAllFields()

'Displaysthenameoffieldsinthecurrentlist

DimobjFieldAsListField

DimstrTypeAsString

ForEachobjFieldInobjApp.ActiveWeb.Lists.Item(0).Fields

IfstrType=""Then

'Createnewstring

strType=objField.Name&vbCr

'Addnextfieldnametostring

strType=strType&objField.Name&vbCr

NextobjField

MsgBox"Thenamesofthefieldsinthislistare:"&_

vbCr&strType

MsgBox"Thecurrentwebsitecontainsnolists."

EndSub

ListFieldAttachmentsObjectListFieldAttachments Web

ContainsinformationabouttheattachmentsfieldwhenattachmentsareenabledforalistinaMicrosoftFrontPageWebsite.

UsingtheListFieldAttachmentsobject

UsetheItempropertyfortheListFieldscollectiontoreturnasingleListFieldAttachmentsobject.ThefollowingexamplereturnsthefirstfieldinthethefirstlistintheListscollection.

DimobjListAsBasicList

DimobjFieldAsListFieldAttachments

SetobjList=ActiveWeb.Lists(0)

SetobjField=objList.Fields(0)

ListFieldChoiceObjectListFieldChoice Web

Containsinformationaboutthechoicefield.Thechoicefieldallowstheusertoselectfromaspecifiednumberofoptionsbyprovidingadrop-downlistorradiobuttonsinthelist.

UsingtheListFieldChoiceobject

UseListFields.Item(index),whereindexisthenameorordinalpositionofafieldoftypefpFieldChoicetoreturnasingleListFieldChoiceobject.

UsetheListFields.AddmethodtoaddafieldoftypefpFieldChoicetotheListFieldscollection.ThefollowingexampleaddsanewfieldnamedNewChoiceFieldoftypefpFieldChoice,totheListFieldscollection.UsetheAddChoicemethodtoaddchoicestothelist.Usetheclearmethodtoclearthechoicesfromthelist.

SubDisplayChoice()

'Displaychoice

DimobjLstFldsAslistFields

DimobjFldChoiceAsListFieldChoice

DimstrNameAsString

SetobjLstFlds=objApp.ActiveWeb.Lists.Item(0).Fields

strName="NewChoiceField"

'AddnewfieldoftypefpFieldChoicetolist

objLstFlds.AddName:=strName,Description:="NewChoicevalueField",_

Fieldtype:=fpFieldChoice,Required:=True

MsgBox"AnewFieldnamed"&strName&"wasaddedtothelist"&_

objApp.ActiveWeb.Lists.Item(0).Name&"."

EndSub

ListFieldComputedObjectListFieldComputed Web

Containsinformationaboutfieldscreatedautomaticallybythecomputer.TheListFieldComputedobjectcannotbecreatedbytheuserandinsteadisusedbyMicrosoftFrontPagetocreateareferencefromthelisttoapageintheWebsite.Forexample,inmanylists,theTitlefieldiscreatedbythecomputerandisusedtoreferencethepagecorrespondingtothelistfield.

UsingtheListFieldComputedobject

UseListFields.Item(index)toreturnaListFieldComputedobject,whereindexiseitherthenameofthefieldoritsnumericpositionwithinthecollection.Thefollowingexampledisplaysthenamesofallcomputedfieldsinthecurrentlist.

SubListComputedFields()

'Displaythenamesofcomputedfieldsinthecurrentlist

DimstrTypeAsString

'Checkifitisacomputedfield

IfobjField.Type=fpFieldComputedThen

IfstrType=""Then

'Createnewstring

NextobjField

vbCr&strType

EndSub

ListFieldCounterObjectListFieldCounter Web

Containsinformationaboutthekeycounterusedwithinthelist.

Remarks

ThisfieldiscreatedautomaticallybyMicrosoftFrontPageandcannotbemodifiedbytheuser.

UsingtheListFieldCounterobject

Thefollowingexampledisplaysthenameassociatedwiththecounterfieldinthecurrentlist.

SubListCounterFields()

'Displaysthenameofcounterfieldsinthecurrentlist

DimstrTypeAsString

blnFound=False

'CheckifitisacomputedfieldoftypefpFieldFile

IfobjField.Type=fpFieldCounterThen

blnFound=True

IfstrType=""Then

'Createnewstring

NextobjField

IfblnFound=TrueThen

vbCr&strType

MsgBox"Therearenocounterfieldsinthelist."

EndSub

ListFieldCurrencyObjectListFieldCurrency Web

Containsinformationaboutthefieldtypeusedtoviewcurrencyinformationwithinthelist.TheListFieldCurrencyobjectallowsyoutoviewinformationaboutdifferentcurrencytypeswithinthecurrencyfieldofthelist.

UsingtheListFieldCurrencyobject

UseListFields.Item(index),whereindexisthenameorordinalpositionofafieldoftypefpListFieldCurrency,toreturnasingleListFieldCurrencyobject.

UsetheListFields.AddmethodtoaddafieldoftypefpFieldCurrencytotheListFieldscollection.ThefollowingexampleaddsanewfieldnamedNewCurrencyFieldoftypefpFieldCurrencytotheListFieldscollectionandchangesthecurrencytypetodisplayCanadiandollars.

SubCreateCurrencyField()

'AddnewCurrencyfield

DimobjLstFldsAsListFields

DimobjFldChoiceAsListFieldCurrency

DimstrNameAsString

strName="NewCurrencyField"

'AddnewFieldoftypefpFieldCurrencytolist

objLstFlds.AddName:=strName,Description:="NewCurrencyField",_

Fieldtype:=fpFieldCurrency,Required:=True

SetobjFldChoice=objLstFlds.Item("NewCurrencyField")

'ChangecurrencytypetoCanadian

objFldChoice.Currency=fpCurrencyFieldCanada

EndSub

ListFieldDateTimeObjectListFieldDateTime Web

ContainsinformationaboutthefieldusedtodisplaydatesandtimeswithinaMicrosoftFrontPagelist.TheListFieldDateTimeobjectallowsyoutoviewdateandtimeinformationinavarietyofdifferentconfigurationsdependingonthetypeofdatainthelist.

UsingtheListFieldDateTimeobject

UseListFields.Item(index),whereindexisthenameorordinalpositionofafieldoftypefpListFieldDateTime,toreturnasingleListFieldDateTimeobject.

UsetheListFields.AddmethodtoaddafieldoftypefpListFieldDateTimetotheListFieldscollection.ThefollowingexampleaddsanewfieldnamedNewDateTimeFieldoftypefpListFieldDateTimetotheListFieldscollection.

SubCreateDateTimeField()

'AddnewDate/Timefield

DimstrNameAsString

strName="NewDateTimeField"

'AddnewFieldoftypefpFieldDateTimetolist

objLstFlds.AddName:=strName,Description:="NewDateTimeField",_

Fieldtype:=fpFieldDateTime,Required:=True

EndSub

ListFieldFileObjectListFieldFile Web

Containsinformationaboutanyfilescontainedinthelist.

Remarks

ThisfieldiscreatedautomaticallybyMicrosoftFrontPageandcannotbemodifiedbytheuser.

UsingtheListFieldFileobject

ThefollowingexampledisplaysthenamesofallfieldsoftypefpFieldFileintheactivelist.Ifnofieldsofthistypeexist,oriftheWebcontainsnolists,amessageisdisplayedtotheuser.

SubListFileFields()

'Displaysthenameoffilefieldsinthecurrentlist

DimstrTypeAsString

blnFound=False

'CheckifitisacomputedfieldoftypefpFieldFile

IfobjField.Type=fpFieldFileThen

blnFound=True

IfstrType=""Then

'Createnewstring

NextobjField

IfblnFound=TrueThen

vbCr&strType

MsgBox"Therearenofilefieldsinthelist."

EndSub

ListFieldIntegerObjectListFieldInteger Web

Containsinformationaboutfieldscreatedautomaticallybythecomputer.TheListFieldintegerobjectcannotbecreatedbytheuserandinsteadisusedbyMicrosoftFrontPagetocreateanIDforeachiteminthelist.Forexample,inatypicallist,theIDfieldiscreatedbythecomputerasauniqueidentifierforeachiteminthelist.

UsingtheListFieldIntegerobject

UseListFields.Item(index)toreturnaListFieldIntegerobject,whereindexiseitherthenameofthefieldoritsnumericpositionwithinthecollection.ThefollowingexampledisplaysthenamesofallIntegerfieldsinthecurrentlist.IftheWebsitecontainsnolists,orifthelistcontainsnoIntegerfields,amessageisdisplayedtotheuser.

SubListIntegerFields()

'DisplaysthenameofIntegerfieldsinthecurrentlist

DimstrTypeAsString

blnFound=False

'CheckifitisacomputedfieldoftypefpFieldInteger

IfobjField.Type=fpFieldIntegerThen

blnFound=True

IfstrType=""Then

'Createnewstring

NextobjField

IfblnFound=TrueThen

vbCr&strType

MsgBox"TherearenoIntegerfieldsinthelist."

EndSub

ListFieldLookupObjectListFieldLookup Multipleobjects

ContainsinformationabouttheLookupfield.TheListFieldLookupobjectallowsyoutosearchforinformationwithinthegivenWebsitebasedonaspecifiedfield.

UsingtheListFieldLookupobject

UseListFields.Item(index),whereindexisthenameorordinalpositionofafieldoftypefpFieldLookup,toreturnasingleListFieldLookupobject.

UsetheListFields.AddmethodtoaddafieldoftypeListFieldLookuptotheListFieldscollection.

ThefollowingexampleaddsanewfieldnamedNewFileLookupFieldoftypefpFieldLookuptotheListFieldscollection.

SubCreateLookup()

'AddnewLookupfield

DimobjFldLookupAsListFieldLookup

DimstrNameAsString

strName="NewFileLookupField"

'AddnewFieldoftypefpFieldLookuptolist

objLstFlds.AddName:=strName,Description:="NewLookupField",_

Fieldtype:=fpFieldLookup

SetobjFldLookup=objLstFlds.Item("NewFileLookupField")

MsgBox"Anewfieldnamed"&strName&"wasaddedtothelist"&_

EndSub

ListFieldMultiLineObjectListFieldMultiLine Web

Containsinformationaboutthefieldusedtodisplayinformationcontainingmorethanonelineoftext.Forexample,theListFieldMultiLineobjectcanbeusedtodisplaydescriptionsandsummaries,whichoftenrequiremorethanasingleline.

UsingtheListFieldMultiLineobject

UseListFields.Item(index),whereindexisthenameorordinalpositionofafieldoftypefpFieldMultiLine,toreturnasingleListFieldMultiLineobject.

UsetheListFields.AddmethodtoaddafieldoftypefpFieldMultiLinetotheListFieldscollection.

ThefollowingexampleaddsanewfieldnamedDescriptionoftypefpFieldMultiLinetotheListFieldscollection.Thesubroutinedisplaysthenameofthenewfieldaswellasthenumberoflinesitwillcontain.

SubCreateMultiLine()

'AddnewMultiLineField

DimobjLstFldMultiAsListFieldMultiLine

DimstrNameAsString

strName="Description"

'AddnewFieldoftypefpFieldMultiLinetolist

objLstFlds.AddName:=strName,Description:="DescriptionField",_

Fieldtype:=fpFieldMultiLine

SetobjLstFldMulti=objLstFlds.Item(strName)

objApp.ActiveWeb.Lists.Item(0).Name&".Itcontains"&_

objLstFldMulti.NumberOfLines&"lines."

EndSub

ListFieldNumberObjectListFieldNumber Web

ContainsinformationabouthownumbersaredisplayedinMicrosoftFrontPagelistfields.TheListFieldNumberobjectallowsyoutoconfigurethewayinwhichyouviewnumbersinFrontPagelists.

UsingtheListFieldNumberobject

UseListFields.Item(index),whereindexisthenameorordinalpositionofafieldoftypefpFieldNumber,toreturnasingleListFieldNumberobject.

UsetheListFields.AddmethodtoaddafieldoftypefpFieldNumbertotheListFieldscollection.ThefollowingexampleaddsanewfieldnamedTotaloftypefpFieldNumbertotheListFieldscollection.Thesubroutinedisplaysthenameofthenewfieldandthenameofthelisttowhichitwasadded.

UsetheListFieldNumberobject'sDisplayFormatpropertytochangethewayinwhichthedatawillbedisplayedinthefield.

SubCreateNumberField()

DimstrNameAsString

strName="Total"

'AddnewFieldoftypefpFieldNumbertolist

objLstFlds.AddName:=strName,Description:="NumericTotalField",_

Fieldtype:=fpFieldNumber

EndSub

ListFieldRatingScaleObjectListFieldRatingScale Web

ContainsinformationabouttheratingscalelistfieldforalistinaMicrosoftFrontPageWebsite.TheListFeldRatingScaleobjectisonlyavailableforsurveylists.

UsingtheListFieldRatingScaleObject

UsetheItempropertyfortheListFieldscollectiontoreturnasingleListFieldRatingScaleobject.ThefollowingexamplereturnsthefirstfieldinthefirstlistintheListscollection.ThisexampleassumesthatthefirstlistintheactiveWebisaWebsurveylist.

DimobjListAsBasicList

DimobjFieldAsListFieldRatingScale

SetobjList=ActiveWeb.Lists(0)

SetobjField=objList.Fields(0)

ListFieldsCollectionMultipleobjects ListFields

RepresentsacollectionofListFieldobjectsthatdefinethetextfieldsusedwithinMicrosoftFrontPagelists.TheListFieldobjectisabaseclassthatdefinesthecommonmembersusedbythedifferenttypesoffieldsinFrontPage.Forexample,theListFieldCurrencyandListFieldNumberobjectsallowyoutocustomizethewayinwhichcurrencyandnumericinformationisdisplayed.

UsingtheListFieldscollection

UseFields.Item(index),whereindexiseitherthenameofthelistoritspositionwithinthecollection,toreturnasingleListFieldobject.ThefollowingexampledisplaysthenamesofallfieldsinthefirstlistoftheactiveWebsite.IftheWebsitecontainsnolists,amessageisdisplayedtotheuser.

UsetheAddmethodtoaddanewListFieldobjecttotheListFieldscollection.

SubListFields()

'Displaythenamesoffieldsinthecurrentlist

DimstrTypeAsString

IfstrType=""Then

'Createnewstring

NextobjField

vbCr&strType

EndSub

ListFieldSingleLineObjectListFieldSingleLine Web

Containsinformationaboutthesinglelinefield.ThefpFieldSingleLineobjectisusedtodisplayinformationthattypicallyrequiresnomorethanasinglelineoftext.Forexample,theNameandTitlefieldstypicallyusetheListFieldSingleLineobjecttodisplayinformation.

UsingtheListFieldSingleLineobject

ThefollowingexamplecreatesanewfieldoftypeListFieldSingleLinenamedAlternativeName.Thesubroutinedisplaysthenameofthenewfieldandthenameofthelisttowhichitwasadded.

SubCreateSingleLineField()

'AddnewSingleLineField

DimstrNameAsString

strName="AlternativeName"

'AddnewFieldoftypefpFieldSingleLinetolist

Fieldtype:=fpFieldSingleLine

EndSub

ListFieldTrueFalseObjectListFieldTrueFalse Web

ContainsinformationabouttheBooleanfieldinaMicrosoftFrontPagelist.TheListFieldTrueFalseobjectallowsyoutoprovidetheuserwithasimple,binaryuser-interfaceoption.

UsingtheListFieldTrueFalseobject

ThefollowingexamplecreatesanewfieldoftypefpFieldTrueFalsenamedDefaultPage.Thesubroutinedisplaysthenameofthenewfieldandthenameofthelisttowhichitwasadded.

SubCreateTrueFalseField()

'AddnewTrueFalsefield

DimstrNameAsString

strName="DefaultPage"

'AddnewFieldoftypefpFieldTrueFalsetolist

objLstFlds.AddName:=strName,Description:="Determinesifthisis"&_

"defaultpage",Fieldtype:=fpFieldTrueFalse

EndSub

ListFieldURLObjectListFieldURL Web

ContainsinformationabouttheMicrosoftFrontPagefieldusedtodisplayURLs.TheListFieldURLobjectallowsyoutocustomizethewayURLsappearinthelistfields.TheURLcanbedisplayedasanimageorasalink.UsetheDisplayFormatpropertytochangetheviewsettings.

UsingtheListFieldURLobject

UseListFields.Item(index),whereindexisthenameorordinalpositionofafieldoftypefpFieldURL,toreturnasingleListFieldURLobject.

ThefollowingexamplecreatesanewfieldoftypefpFieldURLanddisplaysthenameofthenewfieldandthenameofthelistintowhichitwasinserted.

SubCreateURLField()

'AddnewURLfield

DimstrNameAsString

strName="Location"

'AddnewFieldoftypefpFieldURLtolist

objLstFlds.AddName:=strName,Description:="Displaysfilelocations",_

Fieldtype:=fpFieldURL

EndSub

NavigationNodeObjectMultipleobjects NavigationNode

Multipleobjects

RepresentsanodeinthenavigationalstructureofaWebsite.TheNavigationNodeobjectisamemberoftheNavigationNodescollection.WithintheNavigationNodescollection,individualNavigationNodeobjectsareindexedbeginningwithzero.

ImportantFromtheNavigationNodeobject,youcanaccessallothernavigationnodesinaWebsite.TheRootNavigationNodeobject,createdbydefaulteachtimeyoucreateanewWebsite,providesthebasisforthenavigationstructure,whichisaccessedthroughtheChildrenproperty.ThefirstchildnodeofthenavigationstructureisusuallythehomepageoftheWebsite,whichcanbeaccessedthroughtheHomeNavigationNodeproperty.However,thefirstchildnodeoftherootnavigationnodecanbeanypage,andmaynotcontainaHomeNavigationNodeobjectatall.

UsingtheNavigationNodeobject

YoucanusetheNavigationNodepropertytoreturntheNavigationNodeobject.ThefollowingexamplebuildsalistofnavigationnodelabelsfortheWebFileobjectoftheWebFilescollection.

DimmyWebAsWebEx

DimmyWebFilesAsWebFiles

DimmyWebFileAsWebFile

DimmyLabelAsString

OnErrorResumeNext

SetmyWeb=ActiveWeb

WithmyFiles

myLabel=myFile.NavigationNode.Label

IfErr<>0ThenExitSub

myNavNodeLabel=myNavNodeLabel&myLabel&vbCRLF

EndWith

EndSub

TheChildrenpropertyreturnsthecollectionofchildnodeswithinthenavigationstructureofaWebsite.ThefollowingstatementreturnsthenumberofchildnodeswithinthenavigationstructureoftheactiveWebsite.

myNavChildrenCount_

=ActiveWeb.RootFolder.Files(0).NavigationNode.Children.Count

UseChildren(index),whereindexistheindexnumberofanavigationnodeitem,toreturnasingleNavigationNodeobject.ThefollowingstatementreturnsthefilenameofthefirstnavigationnodeintheNavigationNodescollection.

myNavNodeName_

=ActiveWeb.RootFolder.Files(0).NavigationNode.Children(0).File.Name

TheFilepropertyreturnstheFileobjectthatisassociatedwiththeNavigationNodeobject.ThefollowingstatementreturnsTrueifthefileisopen.

myNavFile=ActiveWeb.RootFolder.Files(3).NavigationNode.File.IsOpen

TheHomepropertyreturnstheHomeobjectassociatedwiththecurrentnavigationnodeandreferencesinformationsuchastheChildren,File,Label,Next,Prev,andotherpropertiesforthehomepage.ThefollowingstatementreturnstheURLoftheHomepropertyfortheNavigationNodeobject.

myHomePageUrl_

=ActiveWeb.RootFolder.Files(5).NavigationNode.Home.Url

YoucanreturntheLabelpropertytosetorreturntextthatcanbeusedasbuttonswithinthenavigationstructure,orusedfortextinalinkbar.Thefollowingexamplereturnsthelabelforthehomepage.

myLabel=ActiveWeb.RootFolder.Files(0).NavigationNode.Label

UsetheNext,Parent,Prev,orUrlpropertiestoreturnnavigationnodesassociatedwiththespecifiedproperty.ThefollowingexamplereturnstheURLthatisassociatedwiththepreviousNavigationNodeobject.

myPrevNode=ActiveWeb.RootFolder.Files(1).NavigationNode.Prev.Url

UsetheWebpropertytoreturntheWebExobjectassociatedwiththecurrentnavigationnode.ThefollowingexamplereturnstheWebExobjectforthecurrentnavigationnode.

myNavNodeWeb=_

ActiveWeb.RootFolder.Files(2).NavigationNode.Web.Url

UsetheMovemethodtomoveanavigationnodefromonechildnodetoanother.ThefollowingexamplemovesanavigationnodetoachildlocationonasiblingnodeinthesameWebsite.

PrivateSubMoveNavNode()

DimmyNodesAsNavigationNodes

DimmyNodeAsNavigationNode

SetmyNodes=ActiveWeb.RootNavigationNode.Children

SetmyNode=myNodes(4)

myNode.MovemyNodes,myNodes(2)

ActiveWeb.ApplyNavigationStructure

EndSub

PageWindowExObjectPageWindowEx Multipleobjects

RepresentsanopeneditorsessionandencapsulatestheMicrosoftFrontPagePageobjectmodelthatiscompatiblewiththeDocumentobjectmodelforMicrosoftInternetExplorer4.0andlater.ThePageWindowExobjectisamemberofthePageWindowscollectionandrepresentsalloftheopenpagewindowsinthespecifiedWebsite.WithinthePageWindowscollection,individualPageWindowExobjectsareindexedbeginningwithzero.

NoteYoucanalsosubstitutetheCaptionpropertyofthePageWindowobjectinsteadoftheindexnumberwhenaccessingaPageWindowExobject.ThisonlyworkswhenthePageWindowExobjecthasalreadybeensaved.ThefollowingstatementsreturnthePageWindowExobjectforanopenpagewindowthathasacaptionof"C:\MyWebSites\CohoWinery\Zinfandel.htm").

SetobjPageWindow=ActiveWebWindow.PageWindow("Zinfandel.htm")

SetobjPageWindow=WebWindows(0).PageWindow("Zinfandel.htm")

UsingthePageWindowobject

UsePageWindows(index),whereindexistheindexnumberofapagewindowitem,toreturnasinglePageWindowExobject.ThefollowingstatementreturnsthefileURLofthefirstpagewindowiteminthePageWindowscollection.

PgePageOne=WebWindows(0).PageWindows(0).Document.Url

UsetheActiveFrameWindowpropertytoreturntheactiveframeofaPageWindowExobject.ThefollowingstatementreturnstheActiveFrameWindowobject.

NoteTheactiveframeistheframethatcurrentlyhasthefocus;itisshowninFrontPagewithabluebordersurroundingit.

SetobjActiveFrame_

=WebWindows(1).ActivePageWindow.ActiveFrameWindow

UsetheFrameWindowpropertytoreturnanFPHTMLWindow2object,whichcanthenbeusedtoreturntheframescollectionandthecontentofeachoftheframescollectionpages.

objFrameWindow=WebWindows(0).ActivePageWindow.FrameWindow

UsetheDocumentpropertytoreturnthedocumentassociatedwiththePageWindowExobject.ThefollowingstatementreturnsthedocumentassociatedwiththefirstPageWindowExobjectofthefirstWebWindowExobject.

SetobjDoc=WebWindows(0).PageWindows(0).Document

YoucanusetheIsDirtypropertytodetermineifthePageWindowExobjectisdirty—thatis,ifithasbeenmodifiedsincethelastrefreshorsave.TheisDirtypropertyreturnsTrueifthePageWindowExobjectisdirty.ThefollowingexamplesavesthePageWindowExobjectifthefirstiteminthePageWindowscollectionisdirty.

PrivateSubCheckPageWindowIsDirty()

DimobjPageWinAsPageWindowEx

SetobjPageWin=WebWindows(0).PageWindows(0)

IfobjPageWin.IsDirty=TrueThen

objPageWin.Save

EndSub

YoucanusetheViewModepropertytosettheviewforthepageasshowninthefollowingstatement.Formoreinformationontheenumeratedconstantsavailableforthisproperty,seethetableundertheViewModeproperty.

WebWindows(1).PageWindows(1).ViewMode=fpPageViewHtml

SurveyObjectSurvey Multipleobjects

ContainsinformationabouttheMicrosoftFrontPageSurveyobjectthatallowsuserstovoteonissuesandshareinformation.

UsingtheSurveyobject

UseLists.Item(index),whereindexisisthenameorordinalpositionofaListobjectoftypefpListTypeSurvey,toreturnasingleSurveyobject.

ThefollowingexampleliststhenamesofallsurveysintheactiveWebsite.IftheWebsitecontainsnosurveysortheWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubListAllSurveys()

'Displaysthenamesofallsurveyobjectsinthecollection

DimlstWebListAsList

DimstrNameAsString

blnFound=False

'Cyclethroughlists

IflstWebList.Type=fpListTypeSurveyThen

'Setboolenflagtofound

blnFound=True

IfstrName=""Then

IfblnFound=TrueThen

'Displaynamesofallsurveyobjects

MsgBox"ThenamesofallsurveyobjectsinthecurrentWebsiteare:"_

&vbCr&strName

MsgBox"TherearenosurveyobjectsinthecurrentWebsite."

EndSub

UsetheListscollection'sAddmethodtocreateanewlistoftypefpListTypeSurvey.ThefollowingexamplecreatesanewsurveycalledNewSurvey.

SubNewSurvey()

'AddsanewSurveytothecurrentWebsite

DimobjListsAsLists

'Addnewsurvey

objLists.AddName:="NewSurvey",_

ListType:=fpListTypeSurvey,_

Description:="NewSurvey"

MsgBox"AnewsurveywasaddedtotheListscollection."

EndSub

SystemObjectApplication System

Providesaccesstosysteminformationsuchastheoperatingsystem,screenresolution,orregistry.

UsingtheSystemObject

UsetheSystempropertytoreturntheSystemobject.Thefollowingstatementreturnsthenameofthecallingapplication.

mySysApp=System.Application.Name

UsetheBuildandVersionpropertiestoreturnbuildandversioninformationabouttheoperatingsystem.

myVer=System.Version

myBld=System.Build

Thehorizontalandverticalresolutioncanbeusedtodetermineifagraphiccanbedisplayedonaclient’smachine.Thefollowingstatementsreturntheresolutionsettings.

currHorizRes=System.HorizontalResolution

currVertRes=System.Vertical.Resolution

UsetheOperatingSystempropertytoreturnthenameofthecurrentoperatingsystem,asshowninthefollowingstatement.

thisOps=System.OperatingSystem

UsetheParentpropertytoreturntheparentofthespecifiedobject.ThefollowingstatementreturnsparentinformationfortheSystemobject.

PrivateSubGetSystemParentInfo()

DimmySysAsSystem

DimmySysUserNameAsString

SetmySys=System

WithmySys

mySysUserName=.Parent.UserName

EndWith

EndSub

UsetheLanguageDesignationpropertytoreturnathree-letterabbreviationforthelanguageusedfortheoperatingsystem.Thefollowingstatementreturns"enu"asthelanguagedesignationabbreviationfortheEnglish(US)language.

currSystemLanguage=System.LanguageDesignation

UsetheProfileStringpropertytoreturnorsetanentryintheWindowsregistry.Ifusedwithoutparameters,theProfileStringpropertydefaultstothefollowingkey:

HKEY_CURRENT_USERS\Software\Microsoft\FrontPage

TheparametersfortheProfileStringpropertyare:

RegistrySection,whereRegistrySectionisaregistrysubtreesuchasHKEY_CURRENT_USERorHKEY_LOCAL_MACHINE.RegistryKey,whereRegistryKeyisthenextlevelbelowthesectionorsubtreewithsuchkeynamesasSoftwareorNetwork.

ThefollowingexamplereturnstheIdentifierfortheCentralProcessorsubkey.

PrivateSubGetProfileString()

DimmySysAsSystem

DimmyRegSecAsString

DimmyRegKeyInfoAsString

SetmySys=System

myRegSec=_

"HKEY_LOCAL_MACHINE\Hardware\Description\System\CentralProcessor\0"

myRegKeyInfo=mySys.ProfileString(myRegSec,"Identifier")

EndSub

ThemeObjectMultipleobjects Themes

RepresentsathemeinMicrosoftFrontPage.TheThemeobjectisamemberoftheThemescollection.TheThemescollectionrepresentsallthethemesonthelocalmachineorallthemesappliedtoaspecificWebsite.WithintheThemescollection,individualThemeobjectsareindexedbeginningwithzero.

UsingtheThemeobject

UsetheFormatpropertytoreturnformatinformationforatheme.ThefollowingstatementreturnstheformatforthefirstthemeappliedtotheactiveWebsite.

myThemeFormat=ActiveWeb.Themes(1).Format

UsetheLabelpropertytoreturnthenamethatisdisplayedintheThemelistbox.Thisisthefullnameofthetheme.Thefollowingstatementreturnsthelabelforthetheme.

myThemeLbl=ActiveWeb.Themes(1).Label

UsetheNamepropertytoreturnorapplyathemetoaWebpage.TheNamepropertycontainsthedirectorynameforthetheme,whichisanabbreviatedversionofthenameofthethemeasdisplayedintheThemelistbox.Thefollowingexampleliststhenamesofallthemesinthethemescollectioninthebodyoftheactivedocument.

NoteTorunthisexample,youmusthaveaWebsiteopenthathasathemeappliedtotheactivepage,theentireWebsite,oraspecificfileintheWebsite.

SubListThemes()

DimobjThemeAsTheme

ForEachobjThemeInApplication.Themes

ActiveDocument.body.insertAdjacentText"beforeend",objTheme.Name

EndSub

UsetheVersionpropertytoreturntheversionnumberofthetheme.Thefollowingexamplereturnstheversionforatheme.

myThemeVersion=Theme.Version

WebExObjectMultipleobjects Web

Multipleobjects

RepresentsaMicrosoftFrontPageWebsite.TheWebExobjectisamemberoftheWebscollection,whichrepresentsalloftheopenWebsitesinFrontPage.FrontPageprovidestheabilitytocreatemultipleWebExobjectsonaWebserver.WithintheWebscollection,individualWebExobjectsareindexedbeginningwithzero.ThedirectoryhierarchyofaWebsiteinFrontPageissimilartoafolderhierarchy.AnyWebFoldercanrepresentaWebsite,buteveryWebFolderdoesnotnecessarilyrepresentaWebsite.TheWebfolderhierarchyprovidesthelinktofoldersandfilesonaWebserverdirectory.

UsingtheWebobjectproperties

UsetheWebpropertytoreturntheWebExobject.ThefollowingexamplecheckstheWebsite’soperatingsystemforthecapabilityofprocessinglongfilenames.

NoteTorunthisexample,createaformwithacommandbuttoncalledcmdCheckLongFilenames,atextboxcalledtxtLongFilenames,andcopytheexampleintothecodewindow.

PrivateSubcmdCheckLongFilenames()

DimobjPageWinAsPageWindow

SetobjPageWin=ActivePageWindow

WithobjPageWin

If.Web.AllowsLongFilenames=TrueThen

txtlongFilenames=_

"Thisoperatingsystemuseslongfilenames."

ExitSub

txtlongFilenames=_

"Thisoperatingsystemonlyusesshortfilenames."

EndWith

EndSub

UseWebs(index),whereindexistheordinalpositionofaWebsiteintheWebscollection,toreturnasingleWebExobject.ThefollowingexamplereturnstheURLofthefirstWebsiteintheWebscollection.

Application.Webs(0).Url

UsetheActiveWebWindowpropertytoreturntheselectedWebWindowExobject.FromtheWebWindowExobject,youcanaccesstheActiveDocument,ActivePageWindow,orApplicationproperties,alongwithpropertiessuchasCaption,PageWindows,Parent,ViewMode,Visible,andWeb.Thefollowingexamplereturnsthecreationdateandfilesizeoftheactivedocument.

NoteAlthoughDateisanavailabletypeinMicrosoftVisualBasicforApplications(VBA),theWebWindowExobjectreturnsthedateinstringformatanddoesnotautomaticallyconvertthestringtoadateformat.

PrivateSubActiveDocDateSize()

DimobjWebWindowAsWebWindowEx

DimstrFileSizeAsString

DimstrCreateDateAsString

SetobjWebWindow=ActiveWebWindow

WithobjWebWindow

strFileSize=.ActiveDocument.fileSize

strCreateDate=.ActiveDocument.fileCreatedDate

EndWith

EndSub

TheRevisionControlProjectandIsUnderRevisionControlpropertiesreturnthestatusoftheWebExobject’srevisionstate.YoucancontrolversioninginMicrosoftFrontPagethroughMicrosoftVisualSourceSafeorthroughMicrosoftOffice-stylelocking.FormoreinformationonsourcecontrolprojectsandOffice-stylelocking,seeManagingSourceControl.

IfarevisioncontrolprojectdoesnotcorrespondtoavalidVisualSourceSafeproject,FrontPagedefaultstoOffice-stylelocking.ThefollowingexamplereturnstheRevisionControlProjectandIsUnderRevisionControlproperties,andincludesasourcecontrolprojectexample.

NoteTorunthisexample,createamoduleandcopytheexampleintothecodewindow.YoumusthaveaWebsiteopen.

PrivateSubSourceControl()

DimobjWebAsWebEx

SetobjWeb=ActiveWeb

IfNot(objWeb.IsUnderRevisionControl)Then

objWeb.RevisionControlProject="<FrontPage-basedLocking>"

EndSub

PrivateSubReturnRevisionState()

DimobjWebAsWebEx

DimstrRevCtrlProjAsString

DimblnIsUnderRevCtrlAsBoolean

SetobjWeb=ActiveWeb

WithobjWeb

RevCtrlProj=.RevisionControlProject

blnIsUnderRevCtrl=.IsUnderRevisionControl

EndWith

EndSub

UsetheRootFolderandRootNavigationNodepropertiestodeterminetherootfolderorrootnavigationnode.TheRootFolderpropertyreturnsapointertotherootfolderofaWebsite.TheRootNavigationNodepropertyreturnstheNavigationNodeobjectfromwhichyoucanaccessallothernavigationnodesinaWebsite.TheRootNavigationNodeobjectiscreatedbydefaultwhenyoucreateaWebsite,andprovidesthebasisforthenavigationstructure,whichisaccessedthroughtheChildrenproperty.ThefirstchildnodeofthenavigationstructureisthehomepageoftheWebsite.ThefollowingexamplereturnsthenameoftherootfolderandtheURLoftheRootNavigationNodeobject.

PrivateSubGetRootInfo()

DimobjWebAsWebEx

DimstrRootFolderAsString

DimstrHomeNavNodeAsString

SetobjWeb=ActiveWeb

WithobjWeb

strRootFolder=.RootFolder.Name

strHomeNavNode=.RootNavigationNode.Children(0).Url

EndWith

EndSub

UsetheSharedBorderspropertytosetthesharedbordersforaWebsiteeitheronoroff.ThefollowingstatementsetstheSharedBorderspropertytoTrueandturnssharedbordersonforthespecifiedWebsite.

ActiveWeb.SharedBorders(fpBorderTop)=True

UsetheWebWindowspropertytoreturnthecollectionofWebWindowobjectsthatarecontainedwithinthecurrentWebExobject.ThefollowingstatementreturnsacountoftheWebWindowscollection.

Application.WebWindows.Count

UsingtheWebobjectmethods

UsetheActivatemethodtoplacethefocusonthecurrentobject.ThefollowingstatementscheckifmyAdventureWorksWebistheactiveWebsite;ifitisnot,thenmyAdventureWorksWebisactivated.

IfActiveWeb<>myAdventureWorksWebThen

objAdventureWorksWeb.Activate

UsetheApplyNavigationStructuremethodtoapplyanewlycreatedormodifiednavigationstructuretoaWebsite.ThefollowingstatementappliesanavigationstructuretoaWebsite,wherethevariablefortheAdventureWorksWebsiteiswebAdventureWorksWeb.

myAdventureWorksWeb.ApplyNavigationStructure

UsetheCancelRequestsmethodtocancelallserverrequests.ThefollowingstatementcancelsallserverrequestsfortheAdventureWorksWebsite,withwebAdventureWorksWebastheWebobjectvariable.

NoteTheclientwillstopallrequeststotheserver;however,theservermayhavealreadystartedatransaction,inwhichcaseitwillcontinueuntilthetransactionisfinishedandthentheremainingrequests(ifany)willbecancelled.

myAdventureWorksWeb.CancelRequests

UsetheLocateFileorLocateFoldermethodstoreturnaWebFileoraWebFolderobjectwithinaWebsite.Thefollowingexamplelocatesafolderforadisk-basedWebsite.

Application.Web.LocateFolder("C:\MyWebSites\AdventureWorks\images")

UsethePublishmethodtopublishaWebsitetoaWebserver.ThefollowingstatementpublishestheAdventureWorksWebsitetoaPersonalWebServersite.

DimobjWebAsWebEx

SetobjWeb=Application.Web

WithobjWeb

.Publish_

"http://myServer/wwwroot",fpPublishAddToExistingWeb

TheFpWebPublishFlagsenumeratedtypescanbeconcatenatedasshowninthefollowingstatement.

myWeb.Publish_

"http://myServer/wwwroot",fpPublishAddToExistingWeb+_

fpPublishCopySubwebs

WebFileObjectMultipleobjects WebFile

Multipleobjects

RepresentsafileinaMicrosoftFrontPage-basedWebsite.TheWebFileobjectisamemberoftheWebFilescollection.TheWebFilescollectionrepresentsallofthefilesinaspecifiedWebFolderobject.WithintheWebFilescollection,individualWebFileobjectsareindexedbeginningwithzero.TheWebFileobjectissimilartoafileinadirectory-basedhierarchy.FrontPageprovidestheabilitytocreatemultipleWebobjectsonaWebserver.AnyWebFoldercanrepresentaWebsite,buteveryWebFolderdoesnotnecessarilyrepresentaWebsite.

UsingtheFileobject

UseWebFiles(index),whereindexistheordinalnumberofaWebpage,toreturnasingleWebFileobject.ThefollowingexamplereturnsthefilenameofthefirstWebpageintheWebFilescollection.

ActiveWeb.RootFolder.Files(0).Name

UsetheFileobjecttoreturninformationaboutafileonaWebsite.ThefollowingexamplereturnstheName,Title,andUrlpropertiesofeachFileobjectontheactiveWebsite.

NoteTorunthisprogram,youmusthavealeastoneWebsiteopen.

PrivateSubGetWebFileInfo()

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmyTitleAsString

DimmyUrlAsString

SetmyWeb=ActiveWeb

WithmyWeb

myTitle=myFile.Title

myUrl=myFile.Url

EndWith

EndSub

UsetheIsOpenpropertytocheckifafileiscurrentlyopeninPageview.ThefollowingexamplereturnstheIsOpenpropertyforaspecifiedFileobject.NoticethattheEditmethodisusedtoopenthefileinthisexample.Formoreinformationonusingthesemethods,seetheEditmethod.

NoteYoumusthaveaWebsiteopentorunthisprogram.

PrivateSubCheckForOpenFile()

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmyFileToOpenAsString

DimmyMessageAsString

SetmyWeb=ActiveWeb

myFileToOpen="index.htm"

myMessage="Thisfileiscurrentlyopen."

WithmyWeb

IfmyFileName=myFileToOpenThen

IfmyFile.IsOpen=TrueThen

MsgBox(myMessage)

ExitSub

myFile.EditfpPageViewNormal

ExitSub

EndWith

EndSub

UsetheCheckin,Checkout,andUndoCheckoutmethodstomanagefileresourcesthroughsourcecontrolonaWebsite.ThefollowingstatementchecksoutthefirstfileintheactiveWebsite.

NoteYoumusthaveasourcecontrolprojectsetupinorderforthistowork.

myFileCheckedOut=ActiveWeb.RootFolder.Files(1).Checkout

SimilartofilemanagementfeaturesinMicrosoftVisualSourceSafe,FrontPagealsoprovidesanUndoCheckoutmethodthatyoucanusetoreturnafiletoitsoriginalstate.Thefollowingstatementreturnsthefiletoitsoriginalstate.

myFileCheckedOut=ActiveWeb.RootFolder.Files(1).UndoCheckout

YoucanusetheCheckedoutBypropertybeforeattemptingtocheckoutafiletoseeifthefileiscurrentlycheckedoutandbywhom.Thefollowingstatementreturnsthelogonaliasofthepersonwhocheckedoutafileorisnullifthefileisn'tcurrentlycheckedout.

myWhoCheckedOutFile=ActiveWeb.RootFolder.Files(0).CheckedoutBy

UsethePropertiespropertytoreturninformationaboutaWebsite,suchasthetypeofWebserver(vti_webservertype)oriftheWebsitehasasearchbot(vti_hassearchbot).ThePropertiespropertyreturnsacollectionofkey-valuepairsusedtomaintainthemetainformation.ThefollowingstatementreturnsTrueforthevariablemySearchBotiftheWebsitehasasearchbot.

mySearchBot=ActiveWeb.Properties.Item("vti_hassearchbot")

UsetheMetaTagspropertytoreturninformationaboutthemetatagscontainedintheHTMLcodingofafile.TheMetaTagspropertyreturnsacollectionofmetatagsforaFileobject,suchasthegeneratorofthefile.ThefollowingexamplereturnsthefilenameandmetatagsforeachfileinaWebsite.

NoteTorunthisprogram,youmusthavealeastoneWebsiteopen.

PrivateSubGetMetaTags()

DimmyWebAsWebEx

DimmyFileAsWebFile

SetmyWeb=ActiveWeb

WithmyWeb

EndWith

EndSub

UsetheSharedBorderspropertytoreturnthesharedbordersonthecurrentWebpageortosetnewsharedborders.ThefollowingstatementreturnsthetopsharedborderofthefirstfileintheFilescollectionoftheactiveWebsite.

myTopBorder_

=ActiveWeb.RootFolder.Files(0).SharedBorders(fpBorderTop)

YoucanalsosetsharedbordersonaWebpage,asshowninthefollowingstatement.

ActiveWeb.RootFolder.Files(0).SharedBorders(fpBorderTop)=True

UsetheThemePropertiespropertytoreturninformationaboutwhetherthethemeusesvividcolorsoractivegraphics.Thefollowingexamplereturnsthepropertiesofanappliedthemeandaddsvividcolorstothecurrentthemepropertiesifvividcolorshaven'tbeenappliedtothespecifiedobject.

PrivateSubCheckThemeProperties()

DimmyFileAsWebFile

SetmyFile=ActiveWeb.RootFolder.Files(0)

IfmyFile.ThemeProperties(fpThemeActiveGraphics)Then

myFile.ApplyThememyFile.ThemeProperties(fpThemeName),myFile.ThemeProperties(fpThemePropertiesAll)

myFile.ApplyThememyFile.ThemeProperties(fpThemeName),myFile.ThemeProperties(fpThemePropertiesAll)+fpThemeActiveGraphics+fpThemeVividColors

EndSub

UsingFilemethods

UsetheCopy,Delete,Edit,Move,orOpenmethodstomanageyourWebpages.There'sasubtledistinctionbetweentheEditandOpenmethods.WiththeEditmethod,youcanopenandmodifyaFrontPage-compatiblefileintoaPageWindowobject.WiththeOpenmethod,youcanopenbothFrontPage-compatiblefilesandanyothertypeoffilesuchasimageortextfiles,intothefile'sassociatededitor.WhenyouusetheOpenmethodtoopenafiletypethatisnotFrontPage-compatible,FrontPagedoesnotreturnafileobject.Thefollowingexampleopensafile,deletesafile,andmovesafile.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebsSites\CohoWinery".

PrivateSubOpenFile()

DimmyWebAsWebEx

DimmyFileAsWebFile

SetmyWeb=Webs.Open("C:\MyDocuments\MyWebsSites\CohoWinery")

myWeb.Activate

SetmyFile=myWeb.RootFolder.Files("index.htm")

myFile.Open

EndSub

PrivateSubDeleteFile()

DimmyWebAsWebEx

DimmyFileAsWebFile

SetmyWeb=ActiveWeb

SetmyFile=myWeb.RootFolder.Files(0)

myFile.Delete

EndSub

SubMoveFile()

DimmyWebAsWebEx

DimmyFileAsWebFile

SetmyWeb=ActiveWeb

myFile.Move"NewFilename",True,True

EndSub

WebFolderObjectMultipleobjects WebFolder

Multipleobjects

RepresentsafolderinaMicrosoftFrontPage-basedWebsite.TheWebFolderobjectisamemberoftheWebFolderscollection.

NoteTheFolderobjectisapointertotheWebFolderobject.

TheWebFolderscollectionrepresentsallofthefoldersinaspecifiedWebsite.WithintheWebFolderscollection,individualWebFolderobjectsareindexedbeginningwithzero.TheWebFolderobjectissimilartoafolderinadirectory-basedhierarchy;however,therelationshipbetweenWebFolderobjectsandWebobjectsisunique.FrontPageprovidestheabilitytocreatemultipleWebExobjectsonaWebserver.AnyWebFoldercanrepresentaWebsite,buteveryWebFolderdoesnotnecessarilyrepresentaWebsite.ThefolderhierarchyprovidesthelinktofoldersandfilesonaWebserverdirectory.ThenavigationstructureprovidestheunderlyingstructurefortheWebobjectswithinindividualFrontPage-basedWebsites.

UsingtheWebFolderobject

UseWebFolders(index),whereindexisthepropertykeyofafolder,toreturnasingleWebFolderobject.ThefollowingexamplereturnsthefilenameofthefirstfolderitemintheWebFolderscollection.

ActiveDocument.WebFolders(0).Name

UsethecollectionpropertiessuchasFiles,Folders,orProperties,toreturnthecollectionobjectforthespecifieditem.ThefollowingstatementsreturnthefirstspecifiediteminthecollectionfortheactiveWebsite.

myFileOne=ActiveWeb.RootFolder.Files(0)

myFolderOne=ActiveWeb.RootFolder.Folders(0)

myPropertyOne=ActiveWeb.Properties("vti_author")

UsesuchpropertiesasIsExecutable,IsReadable,IsRoot,andsoon,tocheckforthespecifiedstateofthefolder.IfyouhaveCGIscriptsthatyou'dliketoexecute,youcanaddthescriptstoafolderandsettheIsExecutablepropertyofthatfoldertoTrue.Whenyouhavecontentinafolderthatyou'dlikeotherstobrowse,youcansettheIsReadablepropertytoTrue.Ifyouwanttocheckwhetherthecurrentfolderistherootfolder,youcanusetheIsRootproperty.ThefollowingexamplechecksiffilesinthecurrentWebFolderobjectareexecutable,read-only,orlocatedinarootfolder.

PrivateSubGetFolderInfo()

DimmyWebAsWebEx

DimmyIsExeAsBoolean

DimmyIsReadableAsBoolean

DimmyIsRootAsBoolean

SetmyWeb=ActiveWeb

SetmyFolder=myWeb.RootFolder.Folders(1)

WithmyFolder

myIsExe=.IsExecutable

myIsReadable=.IsReadable

myIsRoot=.IsRoot

EndWith

EndSub

TheIsExecutable,IsReadable,andIsWriteablepropertiesreturninformationaboutthestateofthefolder.ThefollowingexamplesshowhowtosettheIsExecutableandIsReadablepropertiesandreadtheIsWriteableproperty.

NoteYoucannotsettheIsWriteableproperty,howeveryoucansettheIsExecutableandIsReadablepropertiesforaWebFolderobject.

SubFolderProperties()

IfmyFolder.IsWritableThen

MsgBox"Folder,"&myFolder.Url&"iswritable"

IfNot(myFolder.IsReadable)Then

MyFolder.IsReadable=True

IfmyFolder.IsExecutableThen

MyFolder.IsExecutable=False

EndSub

Folders(orWebFolderscollection)inFrontPageservetwopurposes.TheycanbefoldersthathelpmanagethecontentsofaWebsiteortheycanbeentireWebsites.AWebsitecanhavemultiplesubWebsitesbelowit.TheIsWebpropertyreturnsTrueifthefolderinquestionisaWebsubsite.ThefollowingexampleusestheIsWebpropertytodetermineifafolderisaWebsubsiteand,ifso,openstheWebsite.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\CohoWinery",oryoumaysubstituteanalternativeWebsiteURL.

PrivateSubCheckFolder()

SetmyFolder=ActiveWeb.RootFolder.Folders("CohoWinery")

IfmyFolder.IsWeb=TrueThen

Webs.OpenmyFolder.Url

EndSub

UsetheUrlpropertytoreturntheURLofthecurrentWebFolderobject.ThefollowingstatementreturnstheabsoluteURLfortheeighthfolderintheactiveWebsite.

myUrl=ActiveWeb.RootFolder.Folders(7).Url

UsetheCopy,Delete,andMovemethodstomaintainyourWebsitestructure.ThefollowingstatementcopiesaWebFolderobjectfromonefoldertoanotherfolder,updatesthelinksduringthecopyprocess,andforcesanoverwriteifthefilealreadyexists.

myFolder.Copy("C:\MyWebSites\NewAdventureProducts",True,True)

WebPackageObjectWebPackage

RepresentsaWebpackagethathasbeencreatedinMicrosoftFrontPageVisualBasicforApplications.TheWebPackageobjectisanin-memoryobjectonlyanddoesnotcorrespondtoanyFrontPageUserInterfaceelement.Instead,usetheWebPackageobjecttoworkwithaWebpackageonceyou'vecreateditincode.

UsingtheWebPackageobject

UsetheCreatePackagemethodtocreateaWebPackageobject.ThefollowingexamplecreatesanewWebpackage.

DimobjPackageAsWebPackage

SetobjPackage=ActiveWeb.CreatePackage("NewWebPackage")

UsetheAddmethodtoaddfilestotheWebpackage.ThefollowingexampleaddsthreefilestotheWebPackageobjectcreatedinthepreviouscode.

objPackage.AddobjWeb.Url&"/test.htm",fpDepsDefault

objPackage.AddobjWeb.Url&"/test2.htm",fpDepsNone

objPackage.AddobjWeb.Url&"/test3.htm",fpDepsImages

UsetheSubject,Author,Comany,andTitlepropertiestoaddinformationaboutaWebpackage.Thefollowingexamplespecifiesthesubject,author,andcompanyfortheWebPackageobjectcreatedabove.(WhenyoucreateaWebpackage,theTitleparameterfortheCreatePackagemethodbecomesthevalueoftheTitleproperty.YoucanchangethetitleofaWebpackagebysettingtheTitlepropertytoanewvalue.)

objPackage.Author="JohnSmith"

objPackage.Company="FourthCoffee"

objPackage.Subject="ThisisanewWebpackageforFourthCoffee."

UsetheRemovemethodtoremovefilesthatwereaddedbyusingtheAddmethod.Thefollowingexampleremovesoneofthefilesaddedabove.

objPackage.RemoveobjWeb.Url&"/test3.htm",fpDepsImages

UsetheSavemethodtosave,orexport,aWebpackage.ThefollowingexamplesavestheWebPackageobjectcreatedabove.

objPackage.Save"c:\NewWebPackage.fwp",True

WebWindowExObject

WebWindowEx Multipleobjects

RepresentsaMicrosoftFrontPageapplicationwindowinwhichaWebsiteisopened.TheWebWindowExobjectisamemberoftheWebWindowscollection.TheWebWindowscollectionrepresentsalloftheopenapplicationwindowsinaspecifiedWebsiteorwithinFrontPage.WithintheWebWindowscollection,individualWebWindowExobjectsareindexedbeginningwithzero.EachWebsitethatisopenedinFrontPageiscontainedinanewWebWindowExobject,unlessitisopenedinawindowlessenvironmentbysettingtheVisiblepropertyoftheWebWindowExobjecttoFalse.Formoreinformationonwindowlessenvironments,seeCodinginaWindowlessEnvironment.

UsingtheWebWindowobject

UsetheWebWindowpropertytoreturninformationaboutanopenWebWindowExobject.YoucanalsousethePageWindowspropertytoreturninformationaboutthecollectionofopenpagesinaWebWindowExobject.UseWebWindows(index),whereindexistheindexnumberofanapplicationwindowitem,toreturnasingleWebWindowobject.ThefollowingstatementreturnstheViewModepropertyofthefirstWebsiteintheWebWindowscollection.

myViewMode=WebWindows(0).ViewMode

YoucanalsousetheViewModepropertytoswitchbetweenviewmodesbysettingtheviewmodeasshowninthefollowingstatement,whichswitchesthecurrentviewmodetoNavigationview.

ActiveWebWindow.ViewMode=fpWebViewStructure

TheActivatemethodputsthefocusonthespecifiedWebWindowExobject.ThefollowingstatementsactivatesthefirstWebsitesinthecollectionofopenwindows.

myWebWindow=WebWindows(0)

myWebWindow.Activate

TheActivePageWindowpropertyreturnstheactivePageWindowExobject.ThefollowingstatementsreturntheURLandthecaptionoftheactivePageWindowExobject.Thevaluereturnedforthecaptioninthiscaseisafilename,suchas"Index.htm".

urlThisDoc=WebWindow.ActivePageWindow.Document.Url

fileName=WebWindow.ActivePageWindow.Caption

YoucanalsoreturntheCaptionpropertyfromtheWebWindowExobject.Inthiscase,thetextthatisreturnedreflectsthetextinthetitlebaroftheFrontPageapplicationwindow,whichconsistsoftheapplicationnameandtheURLofthe

specifiedWebWindowExobject,suchas"MicrosoftFrontPage–C:\MyDocuments\MyWebSites\AdventureWorks".ThefollowingstatementreturnsthevalueoftheCaptionpropertyoftheWebWindowExobject.

thisCaption=WebWindow.Caption

UsetheClosemethodtocloseaWebWindowExobject.ThefollowingstatementclosesthespecifiedWebWindow.

SetmyWebWindowOne=WebWindows(0)

myWebWindowOne.Close

UsetheViewModepropertytoreturnorsetoneofthevaluesshowninthefollowingtable.YoucanalsousetheseenumeratedvaluestoswitchviewsinFrontPage.

EnumermatedConstant Value CorrespondingViewinFrontPageFpWebViewLinks 0 HyperlinksviewFpWebViewFolders 1 FoldersviewFpWebViewStructure 2 NavigationviewFpWebViewPage 3 PageviewfpWebViewAllFiles 4 ViewalistofeveryfileinReportsviewFpWebViewTodo 5 ViewaToDolistinTasksview

FpWebViewBrokenLinks 6 ViewalistofbrokenhyperlinksinReportsview

FpWebFiewSiteSummary 7 SiteSummaryviewinReportsview

ThefollowingstatementsetstheViewModepropertytofpWebViewPage.

WebWindows(0).ViewMode=fpWebViewPage

UsetheVisiblepropertytoreturnorsetaBooleanvalueforthestateofaWebWindowExobject.TheVisiblepropertyreturnsTrueifaWebWindowExobjectisvisible.ThefollowingstatementsetsaWebWindowExobjecttoaninvisiblestate.

WebWindow.Visible=False

UsetheWebpropertytoreturninformationabouttheWebExobject.ThefollowingstatementreturnsthenumberofpropertiesforthespecifiedWebsites.

myProperties=ActiveWeb.WebWindows(0).Web.Properties.Count

ActivateMethodActivatesthespecifiedPageWindowEx,WebEx,orWebWindowExobject.Whenyouhavemultipleobjectsopen,youcanusetheActivatemethodtoworkwithaspecificPageWindowEx,WebEx,orWebWindowExobject.

expression.Activate

expressionAnexpressionthatreturnsaPageWindowEx,WebEx,orWebWindowExobject.

Remarks

TheActivatemethodhasnoeffectonawindowlessPageWindowExobject.

Example

ThisstatementactivatesthehomepagefortheAdventureWorksWebsite.

IfmyWeb.Url="C:\MyWebSites\AdventureWorks"ThenmyWeb.Activate

ShowAll

AddMethodAddmethodasitappliestotheListFieldsobject.

AddsanewListFieldobjecttotheListFieldscollection.

expression.Add(Name,Description,FieldType,Required,DefaultValue)

expressionRequired.Anexpressionthatreturnsoneoftheaboveobjects.

NameRequired.AStringthatrepresentsthenameofthefield.

DescriptionOptional.AStringthatrepresentsadescriptionofthefield.

DefaultValueOptional.AVariantthatdefinesthedefaultvalue.

FieldTypeOptional.AnFpFieldTypeconstantthatrepresentsthetypeofthenewfield.

FpFieldTypecanbeoneoftheseFpFieldTypeconstants.fpFieldAttachmentsfpFieldChoicefpFieldComputedfpFieldCounterfpFieldCurrencyfpFieldDateTimefpFieldFilefpFieldIntegerfpFieldLookupfpFieldMultiLinefpFieldNumberfpFieldRatingScalefpFieldSingleLinedefaultfpFieldTrueFalse

fpFieldURL

RequiredOptional.ABooleanthatdeterminesifthisisarequiredfield.Trueifthefieldisrequired.

AddmethodasitappliestotheListsobject.

AddsanewListobjecttotheListscollection.

expression.Add(Name,ParentFolder,ListType,Description)

expressionRequired.AnexpressionthatreturnsaListsobject.

NameRequired.AStringthatrepresentsthenameofthenewlist.

ParentFolderOptional.AStringthatrepresentstheparentfolderassociatedwiththeList.

ListTypeOptional.AnFpListTypeconstantthatrepresentsthetypeoflist.

FpListTypecanbeoneoftheseFpListTypeconstants.fpListTypeBasicListdefaultfpListTypeDiscussionfpListTypeDocumentLibraryfpListTypeSurvey

DescriptionOptional.AStringthatrepresentsadescriptionoftheListobject.

AddmethodasitappliestotheNavigationNodesobject.

AddsanewfiletothelistofavailableitemsintheNavigationNodescollection.Usethismethodtoaddanewfiletothenavigationstructure.Formoreinformationonusingnavigationnodes,seetheRootNavigationNodepropertyfortheWebobject,ortheChildrenpropertyfortheNavigationNodeobject.

expression.Add(Url,NodeLabel,ModificationType,LeftSibling)

expressionRequired.AnexpressionthatreturnsaNavigationNodescollection.

UrlRequiredString.AstringthatcontainsthepathfortheWebserverwherethefilewillbestored.ThiscanbeanyabsoluteURL,suchashttp://webserverorfile://filesystemfordisk-basedWebs.

NodeLabelRequiredString.AstringoftextusedtoidentifytheNavigationNodeobjectwhenviewingthenavigationstructureinNavigationview.TheNodeLabelargumentisusedonlyasanaidtoidentification.

ModificationTypeRequiredFpStructModType.Thenodemodificationtype.

FpStructModTypecanbeoneoftheseFpStructModTypeconstants.fpStructBaseOnSiblingUsethissettingifyouwanttoaddanewnodetotherightofthenodedesignatedintheleftsiblingargument.fpStructLeftmostChildTheleftmostnodeinthecurrentnavigationstructure.fpStructRightmostChildTherightmostnodeinthecurrentnavigationstructure.

LeftSiblingOptionalVariant.AnindexintotheNavigationNodescollection.ItcanbeeitherastringthatrepresentsaURL,oranumberthatrepresentsanodeinthecollection.

Remarks

AddinganewfileontotheWebserver(usingtheWebFiles.Addmethod)doesn'timplythatyouareautomaticallyintroducingthefileintothenavigationstructure.ANavigationNodeobjectmustbecreatedseparatelyforthefile.TocreateanewNavigationNodeobject,usetheAddmethodfortheNavigationNodescollection.

NoteWhenatemplateisusedtocreateanewWeb,navigationnodesareautomaticallycreatedforthefilesthathavebeenaddedtotheWebbythetemplate.

AddmethodasitappliestothePageWindowsobject.

AddsanewPageWindowExobjecttothelistofavailableopenitemsinthePageWindowscollection.

NoteOpeninganeworexistingfileobjectbyusingtheAddmethodforthePageWindowExobjectalsoaddsthePageWindowExobjectthatisassociatedwiththeopenedfiletothePageWindowscollection.

expression.Add(FileUrl)

expressionRequired.AnexpressionthatreturnsaPageWindowscollectionobject.

FileUrlOptionalString.AstringthatcontainsthepathfortheWebserverwherethepagewillbestored.ThiscanbeanyabsoluteURLforafile,suchashttp://webserver/fileorfile://filesystem/filefordisk-basedWebs.

Remarks

YoucanuseoneofthreemethodswhenyouwanttoopenHTMLpagesinMicrosoftFrontPagePageview—theAdd,EditorOpenmethod.Whenyouwanttoopen,edit,thensaveafileinPageviewthatexistseitheronafileserveroronafilesystemonyourharddisk,usetheAddmethodforthePageWindowsobject,asshowninthefollowingstatements.

NoteItdoesn'tmatterwherethefilesexist;theycouldresideonaharddisk,server,oraFrontPageWeb.

DimmyFileAsString

myFile="C:\AdventureWorksHTMLFiles\Hiking.htm"

ActiveWeb.ActiveWebWindow.PageWindows.Add(myFile)

Withthismethod,youhaven'taddedthefiletoaFrontPage-basedWeb—you'vejustopenedit.IfmyFileispartofaWeb,andtheWebiscurrentlynotopen,FrontPagewillalsoopentheWeb.

WhenyouwanttoopenandeditanHTMLfilethatexistsonaWeb,usetheEditmethodfortheFilescollectionintherootfolder,asshowninthefollowingstatement.

ActiveWeb.RootFolder.Files("Hiking.htm").Edit

YoucanusetheOpenmethodinthesameway.However,youshouldreservetheOpenmethodforopeningfilesthatarenotHTMLfiles,suchasMicrosoftWorddocuments,imagefiles,andsoon.

YoucanalsousetheAddmethodtoopenanewunsavedPageWindowobject.Youcanuseeitherofthefollowingstatementstoopenanunsavedpagewindow.

SetmyUnsavedPageWindow=ActiveWebWindow.PageWindows.Add()

SetmyUnsavedPageWindow=ActiveWebWindow.PageWindows.Add("")

NoteYoucanusetheexpressionActiveWebWindow.PageWindows.Add("C:\My

Documents\MyWebs\index.htm")asavalidexpressionaslongasindex.htmisavalidFrontPage-basedfilethatresidesinMyWebs.However,ifindex.htmdoesnotresideinMyWebs,yourcodewillfail.Toaddanewpage,youmustfollowtheproceduredescribedearlierinthissection.

AddmethodasitappliestothePropertiesobject.

AddsanewpropertytothelistofavailableitemsinthePropertiescollection.

expression.Add(PropertyKey,PropertyValue)

expressionRequired.AnexpressionthatreturnsthePropertiescollection.

PropertyKeyRequiredString.Astringthatcontainsthenameofthepropertythatyouwanttoadd.Formoreinformation,seethetableofpropertiesinthePropertiescollectiontopic.

PropertyValueRequiredVariant.Thevalueoftheproperty.

Remarks

YoucanprogrammaticallyaddandremovecategoriesandapprovalratingsforthePropertiescollection.

AddmethodasitappliestotheWebFilesobject.

AddsanewWebFileobjecttothelistofavailableitemsintheWebFilescollection.AWebFileobjectisnotrestrictiveandcanbeanytypeoffile;itisnotrestrictedtoanHTMLfiletype—itcouldbeanimagefile,amovie,oranexecutablefile.

NoteUsethismethodtoaddanewfiletoaFrontPage-basedWeb.

expression.Add(FileUrl,ForceOverwrite)

expressionRequired.AnexpressionthatreturnsaWebFilescollection.

FileUrlRequiredString.AstringthatcontainstheURLforthefilesuchas"Inventory.htm".ThiscanbeanyabsoluteURLforafile,suchashttp://webserver/fileorfile://filesystem/filefordisk-basedWebs.

ForceOverwriteOptionalBoolean.

Remarks

AccessingasingleWebFileobjectthroughtheWebFilescollectionprovidesreferencetoaWebFileobjectthatdoesn'thaveaccesstothePageobjectmodeluntiltheWebfileisopened.Oncethefileisopen,thePageWindowobjectassociatedwiththefileprovidesaccesstothePageobjectmodelthatiscompatiblewithMicrosoftInternetExplorer4.0andlater.ForfurtherinformationonusingthePageobjectmodelinyourWebpages,seeExploringtheObjectModelinFrontPage.

AddmethodasitappliestotheWebFoldersobject.

AddsanewWebFolderobjecttothelistofavailableitemsintheWebFolderscollection.

expression.Add(FolderUrl)

expressionRequired.AnexpressionthatreturnsaWebFolderscollection.

FolderUrlRequiredString.AstringthatcontainstheURLforthefolder,suchastheImagesfolderinC:\MyWebs.ThiscanbeanyabsoluteURLforafolder,suchashttp://webserver/folderorfile://filesystem/folderfordisk-basedwebs.

AddmethodasitappliestotheWebPackageobject.

ReturnsaBooleanthatrepresentswhetherthespecifiedfilewassuccessfullyaddedtotheWebpackage.

expression.Add(Url,flags)

expressionRequired.AnexpressionthatreturnsaWebPackageobject.

UrlRequiredString.Thepathandfilenameofthefiletobeadded.

flagsOptionalFpDependencyFlags.Specifieshowtohandledependenciesforthespecifiedfile.DependenciesareincludedonlyiftheyexistwithinthecurrentWebsite.

FpDependencyFlagscanbeacombinationofoneormoreofthefollowingFpDependencyFlagsconstants.

fpDepsDefault Includesallimages,linkbars,hyperlinks,lists,sharedborders,andthemes.

fpDepsImages Includesallimages.fpDepsLinkbars Includesalllinkbars.fpDepsLinks Includesallpagestowhichtherearehyperlinks.

fpDepsLists Includesliststhatmaybeneededinorderforthepagetorendercorrectly.

fpDepsNone Includesnodependencies.fpDepsRecurse Includesallfilesthatareinaspecifiedfolder.fpDepsSharedBorders Includesallsharedborders.fpDepsThemes Includesallthemes.

Remarks

UsetheCreatePackagemethodtocreateanewWebpackage.ThenusetheAddmethodtoaddpagesandtheirspecifieddependenciestotheWebpackage.YoucancreateWebpackagesfromfilesinWebsitesbasedonMicrosoftWindowsSharePointServicesandindisk-basedWebsites.

AddmethodasitappliestotheWebsobject.

AddsanewWebtothelistofavailableitemsintheWebscollection.

SecurityAvoidusinghard-codedpasswordsinyourapplications.Ifapasswordisrequiredinaprocedure,requestthepasswordfromtheuser,storeitinavariable,andthenusethevariableinyourcode.Forrecommendedbestpracticesonhowtodothis,seeSecurityNotesforMicrosoftOfficeSolutionDevelopers.

expression.Add(WebUrl,UserName,Password,WebOpenFlags)

expressionRequired.AnexpressionthatreturnsaWebscollectionobject.

WebUrlRequiredString.AstringthatcontainsthepathfortheWebserverwheretheWebwillbestored.ThiscanbeanyabsoluteURLforaWeb,suchashttp://webserverorfile://filesystemfordisk-basedWebs.

UserNameOptionalString.Theuser'slogonnamefortheWebserver.

PasswordOptionalString.Theuser'spasswordfortheWebserver.

WebOpenFlagsOptional.AnFpWebOpenFlagsconstantthatrepresentsthebehaviorofthenewWeb.

FpWebOpenFlagscanbeoneoftheseFpWebOpenFlagsconstants.fpOpenInWindowdefaultfpOpenNoWindow

AddmethodasitappliestotheWebWindowsobject.

AddsanewWebWindowExobjecttotheWebWindowscollection.

expression.Add(ViewModeEx)

expressionRequired.AnexpressionthatreturnsaWebWindowscollection.

ViewModeExRequired.AnFpWebViewModeExenumeratedconstantthatrepresentstheinformationdisplayedinthenewwindow.

FpWebViewModeExcanbeoneoftheseFpWebViewModeExconstants.fpWebViewExAccessibilityfpWebViewExAllFilesfpWebViewExAssignedTofpWebViewExBrokenLinksfpWebViewExBrowserTypesfpWebViewExCategoriesfpWebViewExCheckoutStatusfpWebViewExComponentErrorsfpWebViewExCSSLinksfpWebViewExDailyPageHitsfpWebViewExDailySummaryfpWebViewExFoldersfpWebViewExLinksfpWebViewExMasterPagesfpWebViewExMonthlyPageHitsfpWebViewExMonthlySummaryfpWebViewExNavigationfpWebViewExOlderFilesfpWebViewExOsTypesfpWebViewExPagefpWebViewExPublishStatusfpWebViewExRecentlyAddedFilesfpWebViewExRecentlyChangedFilesfpWebViewExReferringDomainsfpWebViewExReferringURLs

fpWebViewExRemoteSitefpWebViewExReviewStatusfpWebViewExSearchStringsfpWebViewExSharedBordersfpWebViewExSiteSummaryfpWebViewExSlowPagesfpWebViewExThemesfpWebViewExTodofpWebViewExUnlinkedFilesfpWebViewExUsageSummaryfpWebViewExVisitingUsersfpWebViewExWeeklyPageHitsfpWebViewExWeeklySummary

Example

AsitappliestotheNavigationNodesobject.

Thisexampleaddsanewnodecalledfootnote.htmtothelistofitemsintheNavigationNodescollection.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebs\CohoWinery"thatcontainsafilecalledfootnote.htm.Or,youmaysubstituteanalternativeWebsiteURLorfilename.

DimmyHomeAsNavigationNode

DimmyNewNodeAsNavigationNode

DimmyFileUrlAsString

myFileUrl="C:\MyDocuments\MyWebs\CohoWinery\footnote.htm"

SetmyHome=ActiveWeb.HomeNavigationNode

SetmyNewNode=_

myHome.Children.Add(myFileUrl,_

"Footnote",fpStructLeftmostChild)

EndSub

AsitappliestothePageWindowsobject.

ThisexampleaddstheInventorypageforCohoWinerytothelistofitemsinthePageWindowscollection.WhenyouaddapageusingtheFileUrlargument,thepagethatyouwanttoaddmustexistasafile—youcannotcreateanewpageusingthisargument.Tocreateanunsavednewpage,seethedescriptionintheAddmethod.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebs\CohoWinery"thatcontainsafilecalledInventory.htm.Or,youmaysubstituteanalternativeWebsiteURLorfilename.

PrivateSubAddPage()

DimmyPageAsString

SetmyPageWindows=ActiveWeb.ActiveWebWindow.PageWindows

myPage="C:\MyDocuments\MyWebs\CohoWinery\Inventory.htm"

myPageWindows.Add(myPage)

EndSub

AsitappliestothePropertiesobject.

ThisexampleaddsanewfiletothelistofitemsinthePropertiescollection.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebs\CohoWinery\Zinfandel.htm"thatcontainsafilecalledfootnote.htm.Or,youmaysubstituteanalternativeWebsiteURLorfilename.

PrivateSubCopyrightAdd()

DimmyWebAsWebEx

DimmyCopyrightPropertyAsVariant

SetmyWeb=Webs.Open("C:\MyWebs\CohoWinery")

myWeb.Activate

ActiveWeb.Close

EndSub

AsitappliestotheWebsobject.

ThisexampleaddsanewitemtothelistoffilesintheWebscollection.

Webs.Add("C:\MyDocuments\MyWebs\CohoWinery")

AsitappliestotheWebFilesobject.

ThisexampleaddsanewWebFileobjecttothelistofitemsintheFilescollection.

ActiveWeb.RootFolder.Files.Add("C:\NewWebFiles\SalesStatistics.htm")

AsitappliestotheWebFoldersobject.

ThisexampleaddsafoldertothelistofitemsintheWebFolderscollection.

ActiveWeb.RootFolder.Folders.Add("DistributionCenters")

AsitappliestotheWebPackageobject

ThefollowingexamplecreatesanewWebpackageandaddsthepage"test.htm"tothepackage,includingalldependenciesforthepage,andthensavesthenewWebpackage.

DimobjWebAsWebEx

SetobjWeb=ActiveWeb

SetobjPackage=objWeb.CreatePackage("NewWebPackage")

WithobjPackage

.Author="JohnSmith"

.Company="FourthCoffee"

.Subject="ThisisanewWebpackageforFourthCoffee."

.AddobjWeb.Url&"/test.htm",fpDepsDefault

.Save"c:\NewWebPackage.fwp",True

EndWith

AddChoiceMethodAddsanewchoicetothelistofavailablechoicesforthecurrentfield.ThefieldmustbeoftypeListFieldChoice.

expression.AddChoice(text,Index)

expressionRequired.AnexpressionthatreturnsaListFieldChoiceobject.

textRequired.AStringthatrepresentsthetextthatwillappearinthedrop-downlistorbesidearadiobutton.

IndexOptional.ALongthatrepresentsthepositionofthechoicewithinthelistofchoices.

Example

ThefollowingexampleaddstwochoicestoachoicefieldnamedNewChoiceFieldinthefirstlistoftheactiveWebsite.ThenewchoicesareSaleOption1,whichwillappearfirstinthelist,andSaleOption2,whichwillappearsecondinthelist.TherelativepositionsofthechoicesaredeterminedbytheoptionalIndexargument.

SubAddChoice()

'Setareferencetothenewfieldand

'addtwonewchoicestothelist.

SetobjFldChoice=objLstFlds.Item("NewChoiceField")

objFldChoice.AddChoicetext:="SaleOption1",Index:=1

objFldChoice.AddChoicetext:="SaleOption2",Index:=2

EndSub

ShowAll

AddLinkBarMethodReturnsaNavigationNodeobjectthatrepresentsalinkbar.

expression.AddLinkBar(NodeLabel,ModificationType,LeftSibling)

expressionRequired.AnexpressionthatreturnsaNavigationNodescollection.

NodeLabelRequired.AStringthatrepresentsthelabelornameofthelinkbar.

ModificationTypeRequired.AnFpStructModTypeconstantthatrepresentsthestructureofthelinkbar.

FpStructModTypecanbeoneoftheseFpStructModTypeconstants.fpStructBaseOnSiblingBasethelinkbaronitsclosestsiblingnode.fpStructLeftmostChildBasethelinkbaronitsleftmostchildnode.fpStructRightmostChildBasethelinkbaronitsrightmostchildnode.

LeftSiblingOptional.AVariantthatrepresentstheleftsiblingofthenode.Thisvalueisusedtolocatethenewlinkbarinthehierarchy.

Remark

Thenewnodewillnotappearinthelinkbar.Onlythenode'schildrenwillappearinthelinkbar.

NoteThenewlinkbarmustbeaddedtothestructurebeforechildnodescanbeaddedtoit.

Example

Thefollowingexamplecreatesanewlinkbarthatisbasedonitssiblinginthehierarchyofnavigationnodes.

SubNewLinkBar()

DimobjNavNodesAsNavigationNodes

DimobjNavNodeAsNavigationNode

SetobjNavNodes=objApp.ActiveWeb.AllNavigationNodes

'Referenceanodetouseinthemethod.

SetobjNavNode=objNavNodes.Item(1)

'Createnewlinkbarbasedonsibling.

objNavNodes.AddLinkBarNodeLabel:="Newlinkbar",_

ModificationType:=fpStructBaseOnSibling,_

LeftSibling:=objNavNode

'Applynavigationstructuresonodewillappear.

objApp.ActiveWeb.ApplyNavigationStructure

EndSub

ApplyChangesMethodApplychangestothespecifiedobject.ChangestoapropertyofaWebEx,WebFile,orWebFolderobjectarenotapplieduntilyouusetheApplyChangesmethodforthespecifiedobject.

expression.ApplyChanges

expressionAnexpressionthatreturnsaPropertiescollectionobject.

Example

Thisexamplechangesthevalueofthevti_titlepropertyforafilecalledZinfandel.htmandappliesthechange.

PrivateSubChangeProperties()

SetmyProperties=_

ActiveWeb.RootFolder.Files("Zinfandel.htm").Properties

myProperties("vti_title")="RogueCellarsWineList"

myProperties.ApplyChanges

EndSub

ApplyDynamicTemplateMethodAppliesaDynamicWebTemplatetoadocument.

expression.ApplyDynamicTemplate(bzMaster,pState,)

expressionRequired.AnexpressionthatreturnsaWebFileobject.

bzMasterRequiredString.ThepathandfilenamefortheDynamicWebTemplate.

pStateRequiredDynamicTemplateState.SpecifiestheregionmappingfortheDynamicWebTemplate.UsetheSetHeadMappingandSetBodyMappingmethodsoftheDynamicTemplateStateobjecttocustomizeregionmapping.

Remarks

TodetachaDynamicWebTemplateusetheApplyDynamicTemplatemethodwiththebzMasterparametersettoanemptystring.

Example

ThefollowingexampleappliesthespecifiedDynamicWebTemplatefiletothespecifiedfile.

DimobjStateAsDynamicTemplateState

DimobjFileAsWebFile

SetobjState=Application.CreateDynamicTemplateState

SetobjFile=ActiveWeb.LocateFile("home.htm")

objFile.ApplyDynamicTemplate"template.dwt",objState

ApplyNavigationStructureMethodAppliesthenavigationstructuretothespecifiedobject.

expression.ApplyNavigationStructure

expressionAnexpressionthatreturnsaWebExobject.

Remarks

Therearetwodetailstokeepinmindwhenprogrammaticallycreatingfilesandnavigationnodes:

Navigationlabelscannotbeempty.Changestothenavigationstructurecanbelostifyoudon'tapplythenavigationstructurebeforestartingoperationsthataffectthecontentoftheWebsitesuchasmovingoraddingfilesorfolders.

Example

Thisexampleaddsanavigationnodeastherightmostchildnodeandthenappliesthechangestothenavigationstructure.

DimmyWebAsWebEx

DimmyChildNodesAsNavigationNodes

DimmyNewNavNodeAsNavigationNode

SetmyWeb=ActiveWeb

SetmyChildNodes=_

myWeb.RootFolder.Files(1).NavigationNode.Children

myNewNavNode=_

myChildNodes.Add(myWeb.Url&"Sale.htm","Sale",_

EndSub

ApplyTemplateMethodSomeofthecontentinthistopicmaynotbeapplicabletosomelanguages.

AppliesanexistingHTMLtemplatetothecurrentWebsite.

expression.ApplyTemplate(TemplateDir,fOverWrite)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

TemplateDirRequiredString.Thepathofthetemplate.

fOverWriteOptional.ABooleanthatdeterminesifthecurrenttemplatewillbeoverwritten.IfTrue,thecurrenttemplatewillbeoverwritten.IfFalse,thecurrenttemplatewillnotbeoverwritten.ThedefaultvalueisFalse.

Example

ThefollowingexampleaddsaspecifiedtemplatetothecurrentWebsiteusingtheApplyTemplatemethod.ThemethodiscalledwiththefApplyThemesandthefOverWriteargumentssettoFalse.ThethemeswillnotbeappliedtothenewWebsiteandanyexistingtemplatewillnotbeoverwritten.

SubUseTemplate()

'AppliesatemplatetothecurrentWebsitewithoutoverwritingtheoriginaltemplate

'orapplyingthemes.

DimobjWebAsWebEx

DimstrPathAsString

DimstrnameAsString

SetobjWeb=objApp.ActiveWeb

'Setvariabletotemplatedirectory.

strPath="C:\ProgramFiles\MicrosoftOffice\Templates\"

'Prompttheuserforthefilenameofthetemplate.

strname=InputBox("Enterthefilenameofthetemplateyouwishtoapply")

'Addthetemplatenametothepathinorderto

'createafullpathname.

strPath=strPath&strname

'ApplythetemplatetothenewWebsite.

objWeb.ApplyTemplateTemplateDir:=strPath,_

fOverWrite:=False

EndSub

ShowAll

ApplyThemeMethodAppliesthevaluecontainedintheThemeNameargumenttothepropertynamedintheThemePropertiesargument.Forexample,athemecanbeappliedtoaWebFile,WebFiles,PageWindowEx,orWebExobjectinaMicrosoftFrontPage-basedWebsite.

expression.ApplyTheme(ThemeName,ThemeProperties)

expressionAnexpressionthatreturnsanobjectintheAppliesTolist.

ThemeNameRequiredString.Astringthatcontainsthenameofthethemethatyouwanttoapplytoafile.TheThemeNameparametercanbeoneofthefollowing:

aftrnoon concrete modular strtedge

arcs corporat nature studio

arctic cypress network sumipntg

artsy deepblue papyrus sunflowr

axis echo passport tabs

balance eclipse piechart technolo

bars edge pixel topo

blank evergreen poetic travel

blends expeditn profile water

blitz folio quad watermar

blocks glacier radial waves

bluecalm global refined willow

blueprnt highway ricepapr zero

boldstri ice ripple

breeze indust rmnsque

canyon inmotion sandston

capsules iris satin

cascade journal sky

checkers layers slate

citrus level sonora

classic loosegst spiral

compass mdshapes spring

ThemePropertiesOptionalFpThemeProperties.Thepropertiesassociatedwiththetheme.

FpThemePropertiescanbeoneoftheseFpThemePropertiesconstants.fpThemeActiveGraphicsfpThemeBackgroundImagefpThemeCSSfpThemeDefaultSettingsfpThemeNamefpThemeNoBackgroundImagefpThemeNoCSSfpThemeNormalColorsdefaultfpThemeNormalGraphicsfpThemePropertiesAllfpThemePropertiesNonefpThemeVividColors

Remarks

ThefollowingcodeappliestheSumiPaintingthemetoafilewithactivegraphics.

DimstrThemeAsString

strTheme="sumipntg"

CallWebFile.ApplyTheme(strTheme,fpThemeActiveGraphics)

Tochangemorethanonethemepropertywhenapplyingthetheme,usetheplussign(+),asshowninthefollowingexample.

strTheme="sumipntg"

WebFile.ApplyTheme(strTheme,_

fpThemeVividColors+fpThemeActiveGraphics)

Thismethodisessentiallythesameoneyou'duseforapplyingathemetoaPageWindowExorWebExobject.

Example

Thisexamplecontainsafunction,ApplyThemeToFilesInFolder,andaprocedurethatyoucanmodifytoapplyanyoftheavailablethemes.ThisexampleappliestheArtsythemetoallfilesinaspecifiedfolder.

NoteTorunthisexample,copythecodeintoamoduleintheMicrosoftVisualBasicEditorandruntheChangeToArtsyprocedure.

FunctionApplyThemeToFilesInFolder(myThemeNameAsString,_

myFolderObjectAsWebFolder)AsBoolean

DimmyFileAsWebFile

DimmyThemeAsTheme

OnErrorGoToERR

ForEachmyFileInmyFolderObject.Files

CallmyFile.ApplyTheme(myThemeName,fpThemePropertiesAll)

NextmyFile

ApplyThemeToFilesInFolder=True

ExitFunction

MsgBox"Anerroroccurred:"&ERR.Description,vbCritical,"Error!"

ApplyThemeToFilesInFolder=False

ExitFunction

EndFunction

PrivateSubChangeToArtsy()

ApplyThemeToFilesInFolder"artsy",ActiveWeb.RootFolder

EndSub

CancelRequestsMethodImmediatelycancelsallrequeststotheWebExobjectwithoutsaving.

expression.CancelRequests

Example

TheCancelRequestsmethodcanbeusedtostopaprocessthatmaybetakingtoolong,mayappeartobeinaninfiniteloop,orthatmaybecomingfromaquestionablesource.

PrivateSubCancelRequestsToWeb_Click()

DimmyWebAsWebEx

SetmyWeb=ActiveWeb

myWeb.CancelRequests

EndSub

CheckinMethodChecksthespecifiedWebFileobjectintothesourcecontrolproject.

NoteYoumusthaveasourcecontrolprojectinplacebeforeusingthismethod.Forinformationaboutsourcecontrolprojects,refertoManagingSourceControlProjects.

expression.Checkin(Comment,KeepCheckedout)

expressionAnexpressionthatreturnsaWebFileobject.

CommentOptionalString.Adescriptionstring.

KeepCheckedoutOptionalBoolean.Truekeepsthefilecheckedout.DefaultvalueisFalse.

Remarks

TheKeepCheckedoutargumentprovidestheabilitytohavethefileremaininacheckedoutstatewhiletheuserchecksthefileintoMicrosoftVisualSourceSafetorecordthechanges.ThisdoesnotapplytoMicrosoftFrontPageLightWeightsourcecontrol.

Example

Theprograminthisexampleperformsthefollowingitems:

Checksoutafileandputsthepageineditmode.Addsawelcomemessagetothepage.Checksiftheopenpagehasbeenmodified.Savesthepageifithasbeenmodified.Closesthefileandchecksitintotheexistingsourcecontrolproject.

NoteTorunthisexample,youmusthaveasourcecontrolprojectinplaceonaWebsitewithafilecalled"C:\MyDocuments\MyWebSites\RogueCellars\Zinfandel.htm."Or,youmaysubstituteaWebsiteandfileofyourchoice.

PrivateSubCheckinFile()

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmyWelcomeAsString

SetmyWeb=Webs("C:/MyWebSites/RogueCellars")

myWelcome="WelcometomyWebSite!"

SetmyFile=myWeb.RootFolder.Files("Zinfandel.htm")

myFile.Checkout

SetmyPageWindow=myFile.Edit(fpPageViewNormal)

WithmyPageWindow

myPageWindow.Document.body.insertAdjacentText("BeforeEnd",_

myWelcome)

IfmyPageWindow.IsDirty=TrueThenmyPageWindow.Save

.Close

EndWith

myFile.Checkin

EndSub

CheckoutMethodChecksthespecifiedWebFileobjectouttothesourcecontrolproject.

expression.Checkout(ForceCheckout)

ForceCheckoutOptionalBoolean.Forcesacheckout,evenifthefileisalreadycheckedout.Trueforcesacheckoutofthefile.DefaultvalueisFalse.

Remarks

TheForceCheckoutargumentprovidestheadministratorwiththeabilitytoforceacheckoutincaseswhereafilehasbeencheckedoutbyauserwhoisunavailabletocheckthefilebackin.

Example

Theprograminthisexampleperformsthefollowing:

Checksoutafilefromanexistingsourcecontrolprojectandputsthefileineditmode.Addsawelcomemessagetothedocument.Checksiftheopenpagehasbeenmodified.Savesthepage,ifithasbeenmodified.Closesthefileandchecksitintotheexistingsourcecontrolproject.

NoteTorunthisexample,youmusthaveasourcecontrolprojectinplaceonaWebsitewithafilecalled"C:\MyDocuments\MyWebSites\RogueCellars\Zinfandel.htm".Or,youmaysubstituteanalternativeWebsiteandfilename.

PrivateSubCheckoutFile()

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmyWelcomeAsString

SetmyWeb=Webs("C:/MyWebSites/RogueCellars")

myWelcome="WelcometomyWebSite!"

SetmyFile=myWeb.RootFolder.Files("Zinfandel.htm")

myFile.Checkout

SetmyPageWindow=myFile.Edit(fpPageViewNormal)

WithmyPageWindow

myPageWindow.Document.body.insertAdjacentText("BeforeEnd",_

myWelcome)

.Close

EndWith

myFile.Checkin

EndSub

ClearChoicesMethodRemovestheavailablechoicesforachoicefield.

expression.ClearChoices

ShowAll

CloseMethodClosemethodasitappliestothePageWindowExobject.

ClosesthespecifiedPageWindowExobject.

expression.Close(ForceSave,PromptUser)

expressionRequired.Anexpressionthatreturnstheaboveobject.

ForceSaveOptionalBoolean.TrueforcesthespecifiedfiletobesavedbeforetheClosemethodiscompleted.DefaultisFalse.

PromptUserOptionalBoolean.Truepromptstheuserbeforeclosingthepage.DefaultisFalse.

ClosemethodasitappliestothePageWindowsobject.

ClosesthespecifiedpagesinthePageWindowscollection,or,ifNull,closesallopenpagesinthePageWindowscollection.

expression.Close(Index,ForceSave,PromptUser)

IndexOptionalVariant.ReferstoanindividualiteminthePageWindowscollection.Canbeanynumbercorrespondingtoaniteminthecollection,withtheindexstartingatzero.

ForceSaveOptionalBoolean.TrueforcesthespecifiedfiletobesavedbeforetheClosemethodiscompleted.DefaultisFalse.

PromptUserOptionalBoolean.Truepromptstheuserbeforeclosingthepages.DefaultisFalse.

ClosemethodasitappliestotheWebWindowsobject.

ClosesthespecifiedWebWindowExobject.

expression.Close(Index)

IndexOptionalVariant.ReferstoanitemintheWebWindowscollection.Canbeanynumbercorrespondingtoaniteminthecollection,withtheindexstartingatzero.

ClosemethodasitappliestotheWebExandWebWindowExobjects.

Closesthespecifiedobject.

expression.Close

Example

AsitappliestothePageWindowExobject.

Thefollowingexampleclosestheactivepagewindow.

SubCloseWindow()

'Closestheactivepagewindow

IfNotobjApp.ActivePageWindowIsNothingThen

objApp.ActivePageWindow.CloseForceSave:=True

EndSub

AsitappliestothePageWindowscollection.

ThefollowingexampleclosesthefirstpagewindowofthefirstWebsiteintheWebWindowscollection.

SubCloseWindow()

'Closesapagewindow

DimobjPgeWindowsAsPageWindows

SetobjPgeWindows=objApp.ActiveWeb.WebWindows(0).PageWindows

objPgeWindows.CloseIndex:=0,ForceSave:=True

EndSub

AsitappliestotheWebWindowsobject.

ThefollowingexampleclosesallopenWebwindows.

SubCloseWindow()

'ClosesallWebpagewindows.

DimobjPgeWindowsAsWebWindows

SetobjWebWindows=objApp.ActiveWeb.WebWindows

objWebWindows.Close

EndSub

AsitappliestotheWebExandWebWindowExobjects.

ThefollowingexampleclosestheactiveWebsite(ifoneexists).

SubCloseWindow()

'Closestheactivedocument

IfNotobjApp.ActiveWebIsNothingThen

objApp.ActiveDocument.Close

EndSub

ShowAll

ConvertToFieldMethodChangesafieldfromonetypetoanotherandreturnstheobjectspecifiedintheTypeparameter.

expression.ConvertToField(Type)

TypeRequiredFpFieldType.Specifiesthetypeoffieldtowhichtoconvertthespecifiedfield.

FpFieldTypecanbeoneofthefollowingFpFieldTypeconstants.

fpFieldAttachments ReturnsaListFieldAttachmentsobject.fpFieldChoice ReturnsaListFieldChoiceobject.fpFieldComputed ReturnsaListFieldComputedobject.fpFieldCounter ReturnsaListFieldCounterobject.fpFieldCurrency ReturnsaListFieldCurrencyobject.fpFieldDateTime ReturnsaListFieldDateTimeobject.fpFieldFile ReturnsaListFieldFileobject.fpFieldInteger ReturnsaListFieldIntegerobject.fpFieldLookup ReturnsaListFieldLookupobject.fpFieldMultiLine ReturnsaListFieldMultilineobject.fpFieldNumber ReturnsaListFieldNumberobject.fpFieldRatingScale ReturnsaListFieldRatingScaleobject.fpFieldSingleLine ReturnsaListFieldSingleLineobject.fpFieldTrueFalse ReturnsaListFieldTrueFalseobject.fpFieldURL ReturnsaListFieldURLobject.

Remarks

Thefollowingchartspecifieswhetheronefieldtypecanbeconvertedtoanotherfieldtypeandhowtheconversionworksifspecialconversionisnecessary.

FromField/ToField

Text Choice NoteNote(Rich

TextEnabled)

Number

Text N/A Yes Yes Yes

Yes;convertsnumbersandsetsothervaluestoNULL

Choice Yes N/A Yes Yes

Yes;convertsandtruncatestexttolessthan255characters.

Yes;convertsandtruncatestextto255characters.

N/A Yes

Note(RichText

Enabled)

No No Yes N/A No

Number Yes Yes Yes Yes N/A

Currency Yes Yes Yes Yes Yes

DateTime Yes Yes Yes Yes No

Boolean Yes;convertsto0or1.

Yes;convertsto0or1.

Multi-valuechoice

Yes Yes Yes Yes Yes

CopyMethodCopiesthespecifiedobjecttoadesignatedURL.Duringthecopyprocessyoucanchoosetoupdatehyperlinksorforceafileoverwriteifthespecifiedobjecthasthesamenameasthedesignatedobject.

expression.Copy(DestinationUrl,Unused,ForceOverwrite)

expressionAnexpressionthatreturnsaWebFileorWebFolderobject.

DestinationUrlRequiredString.ThetargetURL.

UnusedOptionalBoolean.Thisparameterisunused.SettingitornotsettingitwillhavenoeffectonthefunctionalityoftheCopymethod.

ForceOverwriteOptionalBoolean.Specifieswhethertoforceafileoverwritewhenafileorfolderisfoundwiththesamename.SettheargumenttoTruetoforceafileoverwrite.DefaultvalueisFalse.

Remarks

TheCopymethodonlycopiesfilesorfolderswithinthesameWebsite.YoucannotcopyacrossWebsites.However,youcanusetheSaveAsmethodforthePageWindowExobjecttosaveapagethathasitsfilecurrentlylocatedinoneWebsitetosavethepagetoafileinanotherWebsite.Or,youcanusetheAddmethodfortheWebFileobjecttoaddafilethatiscurrentlylocatedinoneWebsitetoanotherWebsite.

Example

ThisexamplecopiesafilefromtheCohoWineryfoldertoanInventoryfolderwithinthesameWebsite.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\CohoWinery."Or,youmaysubstituteanalternativeWebsiteandfilename.

PrivateSubFileCopy()

DimmyFileAsWebFile

SetmyFile=ActiveWeb.RootFolder.Files("Zinfandel.htm")

myFile.Copy"C:\MyWebSites\CohoWinery\Inventory\Zinfandel.htm"

EndSub

CreateDynamicTemplateStateMethodReturnsaDynamicTemplateStateobjectthatrepresentsasetofregionmappingstousewhenapplyingorupdatingaDynamicWebTemplate.

expression.CreateDynamicTemplateState

expressionRequired.AnexpressionthatreturnsanApplicationobject.

Example

ThefollowingexamplecreatesareferencetoaDynamicWebTemplate.

CreatePackageMethodReturnsaWebPackageobjectthatrepresentsacollectionofpages,files,andfoldersandtheirrelateddependencies,suchasimages,cascadingstylesheets,andJavaScriptfiles.

expression.CreatePackage(Title)

expressionRequired.AnexpressionthatreturnsaWebExobject.

TitleRequiredString.ThenameoftheWebpackage.ThisvaluebecomesthevalueoftheTitlepropertyfortheWebPackageobject.

Remarks

UsetheCreatePackagemethodtocreatetheWebPackageobject.UsetheAddmethodtoaddpagestotheWebpackage.ThenusetheSavemethodtosavethenewWebpackagetodisk.UsetheRemovemethodtoremovefilesthatwereaddedbyusingtheAddmethod.

YoucancreateWebpackagesfromfilesinWebsitesbasedonMicrosoftWindowsSharePointServicesandindisk-basedWebsites.

Example

DimobjWebAsWebEx

SetobjWeb=ActiveWeb

WithobjPackage

.Author="JohnSmith"

EndWith

CreateSearchInfoMethodReturnsaSearchInfoobjectthatrepresentsacustomfindorfindandreplaceoperation.

expression.CreateSearchInfo

Example

ThefollowingexamplefindsthenextoccurrenceofthePelementintheactivedocument.

DimobjSearchAsSearchInfo

DimobjRangeAsIHTMLTxtRange

SetobjSearch=Application.CreateSearchInfo

objSearch.Find="p"

objSearch.Action=fpSearchFindTag

SetobjRange=Application.ActiveDocument.selection.createRange

blnFound=Application.ActiveDocument.Find(objSearch,Nothing,objRange)

IfblnFound=TrueThenobjRange.Select

DecodeURLMethodReturnsaStringthatrepresentsadecodedWebaddressforthespecifiedencodedWebaddress.

expression.DecodeURL(bstrEncodedURL)

bstrEncodedURLRequiredString.TheencodedWebaddresstodecode.

Remarks

DecodingaURLincludesreplacing"%20"withspaces.UsetheEncodeURLmethodtoencodeaWebaddress.

Example

ThefollowingexampledecodesthespecifiedWebaddress.

DimstrDecodedURLAsString

strDecodedURL=Application.DecodeURL_

("http://www.fourthcoffee.com/our%20best%20coffee.htm")

ShowAll

DeleteMethodDeletemethodasitappliestotheNavigationNodesobject.

DeletesanindividualnavigationnodefromthelistofavailablenodesintheNavigationNodescollection.

expression.Delete(Index)

expressionRequired.AnexpressionthatreturnsaNavigationNodesobject.

IndexOptionalVariant.Referstoaniteminthenavigationstructure.Canbeanynumbercorrespondingtoaniteminthenavigationstructure,withtheindexstartingatzero.

DeletemethodasitappliestothePropertiesobject.

DeletesapropertyfromthelistofavailablepropertiesinthePropertiescollection.

expression.Delete(PropertyKey)

expressionRequired.AnexpressionthatreturnsaPropertiesobject.

PropertyKeyRequiredString.Astringthatrepresentsthepropertyname.

DeletemethodasitappliestotheWebExobject.

DeletesaWebsitefromthelistofavailableWebsitesintheWebscollection.

expression.Delete(WebDeleteFlags)

WebDeleteFlagsOptionalFpWebDeleteFlags.DetermineswhatisdeletedfromthecurrentWebsite.DefaultisfpDeleteEntireWeb.

FpWebDeleteFlagscanbeoneoftheseFpWebDeleteFlagsconstants.fpDeleteEntireWebdefaultfpDeleteFrontPageInfoFromWeb

DeletemethodasitappliestotheWebFilesandWebFoldersobjects.

DeletesataskfromthelistofavailabletasksintheWebFilescollection,orafolderorfoldersfromthelistofavailablefoldersintheWebFolderscollection.

expression.Delete(Index)

IndexRequiredVariant.ReferstoanitemintheWebFilesorWebFolderscollection.Canbeanynumbercorrespondingtoaniteminthecollection,withtheindexstartingatzero.

DeletemethodasitappliestotheWebsobject.

DeletesaWebsitefromthelistofavailableWebsitesintheWebscollection.

expression.Delete(Index,WebDeleteFlags)

expressionRequired.AnexpressionthatreturnsaWebsobject.

IndexRequiredVariant.ReferstoanitemintheWebscollection.Canbeanynumbercorrespondingtoaniteminthecollection,withtheindexstartingatzero.

WebDeleteFlagsOptionalFpWebDeleteFlags.DetermineswhatisdeletedfromthecurrentWebsite.DefaultisfpDeleteEntireWeb.

FpWebDeleteFlagscanbeoneoftheseFpWebDeleteFlagsconstants.fpDeleteEntireWebdefaultfpDeleteFrontPageInfoFromWeb

DeletemethodasitappliestoallotherobjectsintheAppliesTolist.

DeletesthespecifiedobjectfromaWebsite.

expression.Delete

Example

AsitappliestotheNavigationNodesobject.

ThisexampledeletesthefourthnavigationnodeofthesecondfileintheactiveWebsite.

NoteYoumustapplythenavigationstructuretotheWebsiteinorderforthechangestobeappliedtotheWebsite.

PrivateSubDeleteNavNode()

DimmyWebAsWebEx

DimmyChildNodesAsNavigationNodes

DimintResponseAsInteger

SetmyWeb=ActiveWeb

SetmyChildNodes=_

myWeb.RootFolder.WebFiles(1).NavigationNode.Children

intResponse=MsgBox("Areyousureyouwantto"&_

"deletethisnavigationnode?",vbYesNo)

IfintResponse=vbYesThen

CallmyChildNodes.Delete(3)

EndSub

AsitappliestothePropertiesobject.

ThisexampledeletestheSaleTextpropertyfromtheSales.htmfile.

PrivateSubDeleteProperty()

DimmyFileAsWebFile

DimmyPropAsString

myProp="SaleText"

SetmyFile=ActiveWeb.RootFolder.Files("Sales.htm")

intResponse=MsgBox("Areyousureyouwanttodeletethe"&_

myProp&"property?",vbYesNo)

Ifintrespons=vbYesThen

myFile.Properties.DeletemyProp

EndSub

AsitappliestotheWebExobject.

ThisexampledeletesatemporaryWebsitecalledTempWeb.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\TempWeb".Or,youmaysubstituteanalternativeWebsiteURL.

PrivateSubDeleteWeb()

DimmyWebAsWebEx

DimmyTempWebAsWebEx

DimmyWebToDeleteAsString

DimintResponseAsString

SetmyWeb=Webs.Open("C:\MyDocuments\MyWebs")

SetmyFolders=myWeb.RootFolder.Folders

myWebToDelete="TempWeb"

IfmyFolder.IsWeb=TrueThen

IfmyFolder.Name=myWebToDeleteThen

intResponse=MsgBox("Areyousureyouwanttodelete"&_

"the"&myFolder.Name&"subWebsite?",vbYesNo)

SetmyTempWeb=Webs.Open(myFolder.Name)

myTempWeb.Delete

ActiveWebWindow.Close

EndSub

AsitappliestotheWebFilescollection.

ThisstatementdeletesafileintheactiveWebsite.

NoteTorunthisexample,youmusthaveafilecalled"C:\MyDocuments\MyWebSites\TempFile.htm".Or,youmaysubstituteanalternativefilename.

PrivateSubDeleteWebFile()

intResponse=MsgBox("Areyousureyouwant"&_

"todeletethisfile?",vbYesNo)

ActiveWeb.RootFolder.Files.Delete"TempFile"

EndSub

ShowAll

EditMethodTheEditmethodisusedtoopenMicrosoftFrontPagecompatiblefilesinapagewindow.ThesefilesincludefileformatssuchasHTML,CSS,andASP.Toopenfilesofothertypes,usetheOpenmethod.

NoteHTMLfileswithoutextensionswillnotopenwiththeEditmethod.

expression.Edit(ViewMode)

ViewModeOptionalFpPageViewMode.

FpPageViewModecanbeoneoftheseFpPageViewModeconstants.fpPageViewDefaultdefaultfpPageViewHtmlfpPageViewNoFramesfpPageViewNormalfpPageViewNoWindowfpPageViewPreview

Example

ThisexampleshowshowtousetheEditmethodtoopenafileforediting.

NoteTorunthisprogram,youmusthaveaWebsiteopenthatcontainsafilecalled"RedWines.htm."Or,youmaysubstituteafileofyourchoice.

PrivateSubModifyFile()

DimmyFileAsWebFile

SetmyFile=ActiveWeb.RootFolder.Files("RedWines.htm")

myFile.Edit

EndSub

EncodeURLMethodReturnsaStringthatrepresentstheencodedWebaddressforthespecifiedWebaddress.

expression.EncodeURL(bstrDecodedURL)

bstrDecodedURLRequiredString.TheWebaddresstoencode.

Remarks

EncodingaURLincludesreplacingspaceswith"%20".UsetheDecodeURLmethodtodecodeaWebaddress.

Example

thefollowingexampleencodesthespecifiedWebaddress.

DimstrEncodedURLAsString

strEncodedURL=Application.EncodeURL_

("http://www.fourthcoffee.com/ourbestcoffee.htm")

ShowAll

ImportWebPackageMethodReturnsanFpPkgImportResultthatrepresentswhetherthespecifiedpackagewasimportedorwhethertherewereproblemswiththeimport.

FpPkgImportResultcanbeoneofthefollowingFpPkgImportResultconstants.

fpPkgImportCancelled Importwascancelledbytheuser.fpPkgImportComplete Importwascompletedsuccessfully.

fpPkgImportErrorInPackageImportwascancelledbecauseanerrorinthepackagewasfound(forexample,aninvalidmanifestordamagedfiles).

fpPkgImportFailed Importfailedforanunknownreason.

fpPkgImportNotTrusted

ImportwascancelledbecausethepackagewasnotsignedbyatrustedcertificateortheFpPkgTrustLevelparameterwasnotsettofpPkgTrustAll.

fpPkgImportServerNotSupportedImportwascancelledbecausetheserveronwhichtheWebsiteislocateddoesnotsupportWebpackages.

fpPkgImportStopped

Importwascancelledbecauseafile,folder,orlistconflictcausedtheimportprocesstostopasaresultofthevalueofthefpConflictOptsparameter

expression.ImportWebPackage(packageFileName,urlDeployTo,FpPkgTrustLevel,fpConflictOpts)

packageFileNameRequiredString.Thepathandfilenameofthepackagetobeimported.

urlDeployToRequiredString.Thepathtowhichtoimportthefilesincluded

intheWebpackage.

FpPkgTrustLevelRequiredFpPkgTrustLevel.SpecifieswhethertotrustallWebpackagesoronlythosethataredigitallysignedbyatrustedsource.

FpPkgTrustLevelcanbeoneofthefollowingFpPkgTrustLevelconstants.

fpPkgTrustAllfpPkgTrustCertificateStore

fpConflictOptsRequiredFpPkgImportConflictOpts.Specifieshowtohandleconflicts.

FpPkgImportConflictOptscanbeoneofthefollowingFpPkgImportConflictOptsconstants.

fpPkgFileConflictMaskfpPkgListConflictMask

fpPkgOnConflictSkipSkipsimportinganyfilesifaconflictariseswhenimportingaWebpackage,andcontinuestheimportprocess.

fpPkgOnConflictStop

StopstheimportprocessifanyconflictariseswhenimportingaWebpackage,andcontinuestheimportprocess.

fpPkgOnFileConflictOverwrite Ifafileconflictexists,overwritesthatfile.

fpPkgOnFileConflictSkip

SkipsimportingafileintheWebpackagethatconflictswithafileintheWebsite,andcontinuestheimportprocess.

fpPkgOnFileConflictStopStopstheimportprocessifafileiftheWebpackageconflictswithanexistingfileintheWebsite.

fpPkgOnListConflictMergeOrRename

Mergeslistsiftheyarecompatible;otherwise,theWeblistsarebackedupandimported,andtheimportprocesscontinues.

fpPkgOnListConflictMergeOrSkipMergeslistsifcompatible;otherwise,theimportprocessskipstheconflictinglistsandcontinues.

fpPkgOnListConflictMergeOrStop Mergeslistsifcompatible;otherwise,theimportprocessstops.

fpPkgOnListConflictRename Backsupallconflictinglistsandcontinuestheimportprocess.

fpPkgOnListConflictSkip Skipsdeploymentofalistifalistconflictexists.

fpPkgOnListConflictStop StopstheimportprocessofaWebpackageifalistconflictexists.

Remarks

YoucanimportWebpackagesonlyintoWebsitesbasedonMicrosoftWindowsSharePointServices.

Example

ThefollowingexampleimportsthespecifiedWebpackageintoanewfolderintheactiveWebsite.

DimobjWebAsWebEx

DimobjFolderAsWebFolder

SetobjWeb=ActiveWeb

SetobjFolder=objWeb.AllFolders.Add("NewWebPackageFolder")

objWeb.ImportWebPackage"c:\NewWebPackage.fwp",objFolder.Url,_

fpPkgTrustCertificateStore,fpPkgOnListConflictSkip

LocateFileMethodReturnsthespecifiedWebFileobject.

expression.LocateFile(FileUrl)

FileUrlRequiredString.DefaultvalueisthefileportionoftheURL.

Example

ThisexamplelocatesafileintherootdirectoryoftheWebsiteandputsthefileineditmode.

NoteYoumusthaveaWebsiteopenandafilecalled"Zinfandel.htm,"oryoumaysubstituteafileofyourchoice.

PrivateSubLocateAFile()

DimmyFileAsWebFile

SetmyFile=Webs(0).LocateFile("Zinfandel.htm")

myFile.Edit

EndSub

Inmostcases,youwouldprobablyusetheentireURLfortheStringargumentoftheLocateFilemethod—forexample,ifyouwantedtolocatethefileFirst_Qtr.htminC:/MyDocuments/MyWebSites/RogueCellars/Inventory/First_Qtr.htm.AnytimeafolderexistsinaleveldeeperthantherootdirectoryoftheWebsite,usetheentireURLasshowninthefollowingexample.

PrivateSubGetFile()

DimmyFileAsString

DimmyFileFoundAsWebFile

myFile=_

"C:/MyDocuments/MyWebSites/RogueCellars/Inventory/First_Qtr.htm"

SetmyFileFound=Webs(0).LocateFile(myFile)

EndSub

However,thereisashortcut.Forexample,ifyouwanttolocateafileinanimagesfolderthatresidesintherootdirectoryoftheWebsite,youcanusearelativeaddressbyusingaforwardslashfollowedbythesubfolderandfilenameasshowninthefollowingstatement.

SetmyFileFound=Webs(0).LocateFile("images/JPG/myJPGFileList.htm")

NoteYoucannotsubstituteabackslashinarelativeaddress.

LocateFolderMethodReturnsthespecifiedWebFolderobject.

expression.LocateFolder(FolderUrl)

expressionAnexpressionthatreturnsaWebFolderobject.

FolderUrlRequiredString.ThedefaultvalueisthefolderportionoftheURL.

Example

ThisexamplelocatesafolderintherootdirectoryofaWebsite.

NoteYoumusthaveaWebsiteopenforalloftheseexamples.

PrivateSubLocateAFolder()

DimmyFolderFoundAsWebFolder

SetmyFolderFound=Webs(0).LocateFolder("images")

EndSub

Inmostcases,youwouldprobablyusetheentireURLfortheStringargumentoftheLocateFoldermethod.Forexample,afoldermaybeseverallevelsdeepinthefolderhierarchy,suchasC:/MyDocuments/MyWebSites/RogueCellars/Inventory/First_Quarter—andyouwanttolocateFirst_Quarter.AnytimeafolderexistsinaleveldeeperthantherootdirectoryoftheWebsite,usetheentireURLasshowninthefollowingexample.

PrivateSubGetFolder()

DimmyFolderAsString

DimmyFolderFoundAsWebFolder

myFolder=_

"C:/MyDocuments/MyWebSites/RogueCellars/Inventory/First_Quarter"

SetmyFolderFound=_

Webs(0).LocateFolder(myFolder)

EndSub

However,thereisashortcut.Forexample,ifyouwanttolocateanimagesfolderthatresidesintherootdirectoryoftheWebsite,youcanusearelativeURLbyusingaforwardslashfollowedbythesubfoldernameasshowninthefollowingstatement.

SetmyFolderFound=Webs(0).LocateFolder("images/JPG")

NoteYoucannotsubstituteabackslashinarelativeURL.

ShowAll

LocatePageMethodLocatePagemethodasitappliestotheApplicationobject.

ReturnsaPageWindowExobjectforthespecifiedobject.

expression.LocatePage(DocumentUrl,ViewMode)

DocumentUrlRequired.AStringthatrepresentsthedocumentorfileportionoftheentireURL.ThiscanbeanyabsoluteURL,suchas"http://webserver/file"or"file://filesystem/file"fordisk-basedWebsites.ThedefaultvalueisthefileportionoftheURL.

ViewModeOptional.AnFpPageViewModeconstantthatrepresentstheviewmode.

LocatePagemethodasitappliestotheWebExobject.

ReturnsthePageWindowExobjectassociatedwiththecurrentWebsite.

expression.LocatePage(FileUrl,ViewMode)

FileUrlRequired.AStringthatrepresentsthedocumentorfileportionoftheentireURL.

ViewModeOptional.AnFpPageViewModeconstantthatrepresentstheviewmode.

Example

ThisexamplelocatesapageintherootWebsiteandasubsite.

PrivateSubLocatePages()

DimmyRootPageAsPageWindowEx

DimmyWebPageAsPageWindowEx

SetmyRootPage=_

Application.LocatePage("Zinfandel.htm",fpPageViewNormal)

SetmyWebPage=_

Webs(1).LocatePage("Zinfandel.htm",fpPageViewNormal)

EndSub

MakeAbsMethodReturnsaStringthatrepresentsanabsoluteURLfortheStringspecifiedintheURLparameter,usingtheURLBaseparameterasthestartingpoint.IftheURLisalreadyabsolute,theURLisreturnedunchanged.FormoreinformationaboutabsoluteandrelativeURLs,refertoUnderstandingAbsoluteandRelativeURLAddressing.

expression.MakeAbs(UrlBase,Url)

expressionAnexpressionthatreturnsaApplicationobject.

UrlBaseRequiredVariant.AbaseURL.CanbeastringoraWebEx,WebFolder,WebFile,NavigationNode,orIHTMLDocument2object.

UrlRequiredString.AstringthatcontainstheentireURLfortheWebsite.ThiscanbeanyURLforaWebsite,suchas"http://webserver/folder"or"file://filesystem/folder"fordisk-basedWebsites.

Example

ThisexamplechangesarelativeURLtoanabsoluteURL.

NoteTorunthisexample,youmusthaveaWebsiteandafilecalled"C:\MyDocuments\MyWebSites\RogueCellars\Zinfandel.htm."Or,youmaysubstituteanalternativeWebsiteURLorfilename.

PrivateSubMakeURLAbsolute()

DimmyBaseURLAsWebEx

DimmyAbsAddressAsString

DimmyLocalUrlAsString

myBaseURL=Webs.Open("C:\MyWebSites")

myLocalUrl="Zinfandel.htm"

myAbsAddress=MakeAbs(myBaseURL,myLocalUrl)

EndSub

MakeRelMethodReturnsaStringthatrepresentsarelativeURLfortheStringspecifiedintheURLparameter,usingtheURLBaseparameterasthestartingpoint.IftheURLisalreadyrelativetotheURLBaseparameter,theURLisreturnedunchanged.FormoreinformationaboutabsoluteandrelativeURLs,refertoUnderstandingAbsoluteandRelativeURLAddressing.

expression.MakeRel(UrlBase,Url)

expressionAnexpressionthatreturnsanApplicationobject.

UrlBaseRequiredVariant.AbaseURL.CanbeastringoraWebEx,WebFolder,WebFile,NavigationNode,orIHTMLDocument2object.

UrlRequiredString.AstringthatcontainstheentireURL.ThiscanbeanyURLforaWebsite,suchas"http://webserver/folder"or"file://filesystem/folder"fordisk-basedWebsites.

Example

ThisexamplechangesanabsoluteURLtoarelativeURL,addsahyperlinktotheactivedocumentusingtherelativeURL,andthensavesthechangestothedocument.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\RogueCellars."Youmustalsohavetwofiles,onecalled"Zinfandel.htm"andtheothercalled"index.htm,"whichhasanabsoluteURL(thedefaultstate).Or,youmaysubstituteanalternativeWebsiteURLandfilenames.

PrivateSubMakeURLRelative()

DimmyFileAsWebFile

DimmyFile2AsWebFile

DimmyBaseURLAsWebEx

DimmyRelAddressAsString

DimmyRelAddress2AsString

SetmyBaseURL=Webs.Open("C:\MyDocuments\MyWebSites\RogueCellars")

SetmyFile=myBaseURL.RootFolder.Files("Zinfandel.htm")

SetmyFile2=myBaseURL.RootFolder.Files("index.htm")

SetmyDoc=myFile.Edit(fpPageViewNormal).Document

myRelAddress=MakeRel(myBaseURL,myFile2.Url)

myRelAddress2=""""&myRelAddress&""""

CallmyDoc.body.insertAdjacentHTML("BeforeEnd","<ahref="_

&myRelAddress2&">"&myRelAddress&"</a>")

EndSub

MakeWebMethodCreatesanewWebsitefromanexistingfolder.TocreateanewWebsitewithoutfirstcreatingafolder,seetheAddmethod.

SecurityAvoidusinghard-codedpasswordsinyourapplications.Ifapasswordisrequiredinaprocedure,requestthepasswordfromtheuser,storeitinavariable,andthenusethevariableinyourcode.Forrecommendedbestpracticesonhowtodothis,seeSecurityNotesforMicrosoftOfficeSolutionDevelopers.

expression.MakeWeb(UserName,Password)

UserNameOptionalString.Thelogonnameoftheuser.YoucanusethisoptiontocreateadefaultusernamefortheWebsite.

PasswordOptionalString.Thepasswordoftheuser.YoucanusethisoptiontocreateadefaultpasswordfortheWebsite.

Example

ThisexamplecreatesanewWebsitefromanexistingfoldernamed"Distributors,"whichisafolderintheRogueCellarsWebsite.ThisexampleassumesthatthereisaWebsiteonyourlocalcomputernamedRogueCellarsthatcontainsafoldernamedDistributors.Alternatively,youcansubstituteadifferentWebsiteandfoldername.

PrivateSubMakeWeb()

DimmyWebAsWebEx

SetmyWeb=Webs("C:\MyWebSites\RogueCellars")

myWeb.Activate

SetmyFolder=Active.RootFolder.Folders("Distributors")

myFolder.MakeWeb

EndSub

ShowAll

MoveMethod(WebObjectModel)MovemethodasitappliestotheWebFileandWebFolderobjects.

MovesthespecifiedobjectfromitscurrentlocationtoadesignatedURL.

expression.Move(DestinationUrl,UpdateLinks,ForceOverwrite)

expressionAnexpressionthatreturnsoneoftheaboveobjects.

DestinationUrlRequiredString.ThetargetURL,suchas"C:\MyDocuments\MyWebSites\AdventureWorks".

UpdateLinksRequiredBoolean.Truetoupdatelinksduringthemoveprocess.

ForceOverwriteRequiredBoolean.Truetooverwriteduplicatefilesorfolders.

MovemethodasitappliestotheNavigationNodeobject.

Movesanavigationnodefromonelocationtoanotherinthenavigationstructure.ReturnsaNavigationNodeobjectthatrepresentsthenodeafterithasbeenmoved.

expression.Move(NodeCollection,NewLeftSibling)

expressionAnexpressionthatreturnsaNavigationNodeobject.

NodeCollectionRequiredNavigationNodes.Thetargetnavigationcollection.

NewLeftSiblingOptionalVariant.Thenavigationnodethatwillprecedethenewnodeinthenavigationstructure.Ifitisnotspecified,thenodewillbecomethelastnodeinthetargetnodecollectionspecifiedintheNodeCollectionparameter.

Example

AsitappliestotheWebFileobject.

Thefollowingstatementmovesafilefromonepositioninthefilestructuretoanother.

myFile.Move("C:\MyDocuments\MyWebSites\AdventureWorks\Images",_

True,False)

AsitappliestotheNavigationNodeobject.

Thefollowingexamplemovesanodefromthefifthpositioninthenavigationstructuretothefourthpositioninthenavigationstructurebydesignatingthethirdnodeasthenewleftsibling.

PrivateSubMoveNavNode()

DimmyNodesAsNavigationNodes

SetmyNodes=ActiveWeb.RootNavigationNode.Children

SetmyNode=myNodes(4)

myNode.Move(myNodes,2)

EndSub

OnTimeMethodStartsabackgroundtimerthatrunsamacroonthespecifieddateatthespecifiedtime.

expression.OnTime(When,Name,Tolerance)

WhenRequiredVariant.Thetimeatwhichthemacroistoberun.Canbeastringthatspecifiesatime(forexample,"4:30pm"or"16:30"),oritcanbeaserialnumberreturnedbyafunctionsuchasTimeValueorTimeSerial(forexample,TimeValue("2:30pm")orTimeSerial(14,30,00)).Youcanalsoincludethedate(forexample,"6/304:15pm"orTimeValue("6/304:15pm")).

UsethesumofthereturnvaluesoftheNowfunctionandeithertheTimeValueorTimeSerialfunctiontosetatimertorunamacroaspecifiedamountoftimeafterthestatementisrun.Forexample,useNow+TimeValue("00:05:30")torunamacro5minutesand30secondsafterthestatementisrun.

NameRequiredString.Thenameofthemacrotoberun.Usethecompletemacropathtoensurethatthecorrectmacroisrun(forexample,"Project.Module1.Macro1").Forthemacrotorun,thedocumentortemplatemustbeavailablebothwhentheOnTimemethodisrunandwhenthetimespecifiedbyWhenarrives.

ToleranceOptionalVariant.Themaximumtime(inseconds)thatcanelapsebeforeamacrothatwasn'trunatthetimespecifiedbyWheniscanceled.Macrosmaynotalwaysrunatthespecifiedtime.Forexample,ifadialogboxisbeingdisplayed,themacrowillbedelayeduntilMicrosoftFrontPagehascompletedthetask.Ifthisargumentis0(zero)oromitted,themacroisrunregardlessofhowmuchtimehaselapsedsincethetimespecifiedbyWhen.

Remarks

MicrosoftFrontPagecanmaintainonlyonebackgroundtimersetbytheOnTimemethod.Ifyoustartanothertimerbeforeanexistingtimerruns,theexistingtimeriscanceled.

Example

Thisexamplerunsthemacronamed"Macro1"inthecurrentmoduleat3:55P.M.

Application.OnTimeWhen:=Timevalue("15:55:00"),Name:="Macro1"

Thisexamplerunsthemacronamed"Macro1"15secondsfromthetimetheexampleisrun.Themacronameincludestheprojectandmodulename.

Application.OnTimeWhen:=Now+TimeValue("00:00:15"),_

Name:="Project1.Module1.Macro1"

Thisexamplerunsthemacronamed"Start"at1:30P.M.Themacronameincludestheprojectandmodulename.

ShowAll

OpenMethodOpenmethodasitappliestotheWebFileobject.

OpensafileinaWebsite.

expression.Open

OpenmethodasitappliestotheWebsobject.

OpensaWebsite.ReturnsaWebExobject.

expression.Open(szWebUrl,UserName,Password,WebOpenFlags)

expressionRequired.AnexpressionthatreturnsaWebsobject.

szWebUrlRequiredString.ThebaseURLoftheWebsite,suchas"C:\MyWebSites".ThiscanbeanyabsoluteURL,suchas"http://webserver"or"file://filesystem"fordisk-basedWebsites.

UserNameOptionalString.Thelogonnameoftheuser.

PasswordOptionalString.AdesignatedstringofcharacterstovalidateaccesstothespecifiedWebsite.

WebOpenFlagsOptionalFpWebOpenFlags.

NoteAvoidusinghard-codedpasswordsinyourapplications.Ifapasswordisrequiredinaprocedure,requestthepasswordfromtheuser,storeitinavariable,andthenusethevariableinyourcode.Forrecommendedbestpracticesonhowtodothis,seeSecurityNotesforMicrosoftOfficeSolutionDevelopers.

FpWebOpenFlagscanbeoneoftheseFpWebOpenFlagsconstants.fpOpenInWindowdefaultfpOpenNoWindow

Example

ThefollowingexampleopenstheRogueCellarsWebsiteandtheOktoberfestSalefile,andperformsthefollowingtasks:

Addstexttothefilebycreatingapropertytoholdthetext.AccessesthePageobjectmodelusingtheActiveDocumentpropertyandtheinsertAdjacentTextmethod.AddstexttothepagebysubstitutingmySalePropforthetextparameterintheinsertAdjacentTextmethod.ClosesMicrosoftFrontPage.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\RogueCellars",oryoumaysubstituteanalternativeWebsiteURLandfilename.

PrivateSubAddSaleText()

DimobjWebAsWeb

DimobjFileAsWebFile

DimstrSalePropAsString

DimstrSaleTextAsString

strSaleText="VintageWinesforOktoberfestSale!!!"

SetobjWeb=Webs.Open("C:\MyDocuments\MyWebSites\RogueCellars")

SetobjFile=ActiveWeb.RootFolder.Files("Sale.htm")

objFile.Properties.Add"SaleText",mySaleText

strSaleProp=objFile.Properties("SaleText")

objFile.Open

ActiveDocument.body.insertAdjacentText"BeforeEnd",strSaleProp

WebWindows.Close

EndSub

ShowAll

PublishMethodPublishesaWebsitetoaWebserver.

expression.Publish(DestinationUrl,PublishFlags,UserName,Password)

DestinationUrlRequiredString.AstringthatcontainstheentiretargetURLfortheWebsite,suchas“http://wwwroot/AdventureWorks”.ThiscanbeanyURLforaWebsite,suchashttp://webserver/folderorfile://filesystem/folderfordisk-basedWebsites.

PublishFlagsOptionalFpWebPublishFlags.

FpWebPublishFlagscanbeoneoftheseFpWebPublishFlagsconstants.fpPublishAddToExistingWebfpPublishCopyAllFilesfpPublishCopySubwebsfpPublishIncrementalfpPublishLogInTempDirfpPublishNoDeleteUnmatchedfpPublishUseLastPublishTimefpPublishNonedefault

UserNameOptionalString.ThenameoftheuserwhoispublishingtheWebsite.

PasswordOptionalString.Thepasswordoftheuser.

Example

ThefollowingexamplepublishestheactiveWebsite.

NoteIftheWebsiteyouarepublishingtoisanexistingWebsite,youmustusetheargumentfpPublishAddToExistingWeb,otherwiseyourWebsitewon'tbepublished.IftheWebsiteyouarepublishingtodoesn'texist,don'tusethefpPublishAddToExistingWebargumentbecauseyourWebsitewon'tbepublished.

PrivateSubPublishMyWeb()

DimmyWebAsWebEx

DimmyBaseURLAsString

DimmyPublishParamAsFpWebPublishFlags

SetmyWeb=Application.ActiveWeb

myBaseURL="http://www.Adventure-Works.com"

myPublishParam=fpPublishAddToExistingWeb

myWeb.PublishmyBaseURL,myPublishParam

EndSub

QuitMethodQuitstheapplication.ThismethoddoesnotsaveanychangesthathavenotbeenpreviouslysavedusingtheSaveorSaveAscommand,butimmediatelyexitstheactiveapplication.

expression.Quit

Example

ThisexamplequitstheapplicationwithoutsavinganychangesthatweremadesincethepreviousSaveorSaveAscommandwasexecuted.

PrivateSubQuitApp()

Application.Quit

EndSub

RecalcHyperlinksMethodRecalculatesallmetadataontheserverforthespecifiedWebsite.Thisoperationwillrebuildallhyperlinks,titlesforWebpages,themesonpages,andsooninaMicrosoftFrontPageWebsite.

NoteThisoperationmaytakealongtimetocompletedependingontheamountofmetadataontheserver.

expression.RecalcHyperlinks

Example

ThefollowingexamplerecalculatesthehyperlinksfortheactiveWebsite.

PrivateSubRecalcLinks()

DimmyWebAsWebEx

myWeb.RecalcHyperlinks

EndSub

ShowAll

RefreshMethod(WebObjectModel)RefreshmethodasitappliestotheWebExobject.

RefreshesthespecifiedWebExobject.

expression.Refresh(FetchAll)

FetchAllOptionalBoolean.Truetoretrieveallinformationforalldocumentsregardlessofview.WhensettoFalsethisargumentretrievesonlytheinformationnecessarytosupportthecurrentview.However,iftheReportsorHyperlinkviewisopen,Falserefreshesalldocuments.DefaultisFalse.

RefreshmethodasitappliestothePageWindowExobject.

Refreshesthespecifiedpagewithanoptiontosavechanges.

expression.Refresh(SaveChanges)

expressionRequired.AnexpressionthatreturnsaPageWindowExobject.

SaveChangesOptionalBoolean.Truetosavechanges.

Example

ThefollowingstatementsrefreshtheactivepageandthefirstpageofthefirstWebsiteopened.

ActivePageWindow.Refresh

WebWindows(0).PageWindows(0).Refresh

Youcanusethefollowingstatementtosaveanychangesyoumayhavemadetotheactivepage.

ActivePageWindow.Refresh(True)

YoucanusethefollowingstatementstorefreshtheactiveWebsiteandthefirstWebsiteopened.

ActiveWeb.Refresh

Webs(0).Refresh

ShowAll

RemoveMethod(WebObjectModel)ReturnsaBooleanthatrepresentswhetheraspecifiedfilewassuccessfullyremovedfromaWebpackage.

expression.Remove(Url,flags)

UrlRequiredString.ThepathandfilenameofthefiletoremovefromtheWebpackage.

flagsRequiredFpDependencyFlags.SpecifieswhichdependenciestoincludewhenremovingtheWebpackage.

FpDependencyFlagscanbeacombinationofoneormoreofthefollowingFpDependencyFlagsconstants.

fpDepsDefault Removesallimages,linkbars,hyperlinks,lists,sharedborders,andthemes.

fpDepsImages Removesallimages.fpDepsLinkbars Removesalllinkbars.fpDepsLinks Removesallpagestowhichtherearehyperlinks.

fpDepsLists Removesliststhatmaybeneededinorderforthepagetorendercorrectly.

fpDepsNone Removesnodependencies.fpDepsRecurse Removesallfilesthatareinaspecifiedfolder.fpDepsSharedBorders Removesallsharedborders.fpDepsThemes Removesallthemes.

Example

ThefollowingexamplecreatesaWebpackageandaddsthreefilestoit,removesthelastfileaddedtothepackage,andthensavesthepackagetothelocaldrive.

SetobjWeb=ActiveWeb

WithobjPackage

.AddobjWeb.Url&"/test2.htm",fpDepsNone

.AddobjWeb.Url&"/test3.htm",fpDepsImages

.RemoveobjWeb.Url&"/test3.htm",fpDepsImages

.Author="JohnSmith"

EndWith

RemoveChoiceMethodRemovesthespecifiedchoicefromthespecifiedfield.

expression.RemoveChoice(Index)

IndexRequired.ALongthatrepresentsthepositionofthechoicewithinthearray.

Example

ThefollowingexampleremovesthefirstchoicefromtheNewChoiceFieldfieldinthefirstlistoftheactiveWebsite.

SubRemoveChoice()

'Removesfirstchoicefromarray

DimobjListFieldsAslistFields

DimobjListFieldAsListFieldChoice

SetobjListFields=objApp.ActiveWeb.Lists.Item(0).Fields

SetobjListField=objListFields.Item("NewChoiceField")

'Removefirstchoiceinlist

objListField.RemoveChoiceIndex:=0

EndSub

RemoveWebMethodRemovesaWebsite.

expression.RemoveWeb(UserName,Password)

UserNameOptionalString.Thelogonnameoftheuser.

PasswordOptionalString.Thepasswordoftheuser.

Remarks

TheRemoveWebmethodisthecomplementoftheMakeWebmethod.JustastheMakeWebmethodcreatesthemetadatafortheWebsitefromafolder,theRemoveWebmethodremovesthemetadatafortheWebsitefromafolder,butthefolderremainsintact.ThisisdifferentfromtheDeletemethodfortheWebExobject,wheretheentirecontentsofthespecifiedWebsiteareremoved.

Example

ThefollowingexampleremovesaWebsitefromafolder.Thefolderanditscontentsremainintact,butthefolderisnolongeraWebsite.

NoteYoumusthavetheWebsitethatcontainsthefolderopen.

PrivateSubWebRemove()

SetmyWebFolders=Webs(0).RootFolder.Folders

IfmyFolder.Name="TempWeb"Then

myFolder.RemoveWeb

ExitFor

EndSub

RunMethodRunsthedesignatedMicrosoftVisualBasicmacro.YoucanusetheRunmethodtoexecuteaspecifiedprocedureinMicrosoftFrontPage.YoucanalsousetheRunmethodfromwithintheprocedureofanActiveXcontrolthatcarriesoutinstructionstoqueryormodifyaFrontPage-basedWebsite.

NoteYoucannotpassparameterstoaprocedureusingtheRunmethod.UsetheCallstatementtopassparameterstoaprocedure.

expression.Run(MacroName,safeArrayOfParams)

MacroNameRequiredString.Thenameofthemacro,add-in,orscript.

safeArrayOfParamsRequired.AParamArrayoftypeVariant.

Example

Thefollowingexamplerunsamacrofromanotherprocedure.

NoteTorunthisexample,youmusthaveaWebsitenamedRogueCellarsoryoucansubstituteadifferentWebsiteinplaceoftheRogueCellarsWebsite.CopythefollowingproceduresintoacodemoduleandrunStartMacro.

PrivateSubStartMacro()

DimmyMacroAsString

myMacro="OpenRogueCellars"

Run(myMacro)

EndSub

SubOpenRogueCellars()

DimmyWebAsWeb

SetmyWeb=Webs.Open("C:\MyWebSites\RogueCellars")

EndSub

ShowAll

SaveMethodAsitappliestotheWebPackageobject.

SavesaWebpackagewiththespecifiedfilename.

expression.Save(strFileName,fOverWrite)

strFileNameRequiredString.ThepathandfilenameoftheWebpackage.Webpackageshavean.fwpfilenameextension.TheSavemethoddoesnotautomaticallyincludethisfilenameextension,soyoushouldspecifyitaspartofthefilename.

fOverWriteRequiredLong.Falsetonotoverwriteanexistingfilewiththesamefilename.

Savesaspecifiedpage.

expression.Save(ForceOverwrite)

expressionAnexpressionthatreturnsaPageWindowExobject.

ForceOverwriteOptionalBoolean.Falsetonotsaveoveranexistingfile.ThedefaultvalueisTrue.

Example

AsitappliestotheWebPackageobject.

DimobjWebAsWebEx

SetobjWeb=ActiveWeb

WithobjPackage

.Author="JohnSmith"

.Save"C:\MyDocuments\NewWebPackage.fwp",True

EndWith

Thefollowingexamplecreatesaproperty,addsittoafile,andthensavesthepage.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\RogueCellars",oryoumaysubstituteanalternativeWebsiteURLandfilename.

PrivateSubAddSaleText()

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmySalePropAsString

DimmySaleTextAsString

mySaleText="VintageWinesforOktoberfestSale!!!"

SetmyWeb=Webs.Open("C:\MyDocuments\MyWebSites\RogueCellars")

SetmyFile=ActiveWeb.RootFolder.Files("Sale.htm")

myFile.Properties.Add"SaleText",mySaleText

mySaleProp=myFile.Properties("SaleText")

myFile.Open

ActiveDocument.body.insertAdjacentText"BeforeEnd",mySaleProp

WebWindows.Close

EndSub

SaveAsMethodWritesthespecifiedpageobjecttothedestinationURL.

expression.SaveAs(DestinationUrl,ForceOverwrite)

expressionAnexpressionthatreturnsaPageWindowExobject.

DestinationUrlRequiredString.AstringthatcontainstheentireURLfortheWebsite,suchas“C:\MyDocuments\MyWebSites\AdventureWorks\index.htm”.ThiscanbeanyURLforaWebsite,suchashttp://webserver/folder/fileorfile://filesystem/folder/filefordisk-basedWebsites.

ForceOverwriteOptionalBoolean.Falsetonotsaveoveranexistingfile.ThedefaultvalueisTrue.

Example

ThefollowingexamplesavesanexistingfiletoanotherWebsiteunderanewname.(Itisn'tnecessarytochangethenameofthefile.)TheprogramfirstactivatesthecontainerWebsite,andthenitopensthefileandsavesittoadifferentWebsitewithanewname.

NoteYoumusthaveafilenamedZinfandel.htmintheC:\MyWebSitesfolder,orchangethenameofthefileintheprogramtomatchanexistingfileinyourWebsite.

PrivateSubSaveAsNewFile()

DimmyFileAsWebFile

Webs("C:\MyWebSites").Activate

SetmyFile=ActiveWeb.RootFolder.Files("Zinfandel.htm")

myFile.Open

SetmyPageWindow=ActivePageWindow

myPageWindow.SaveAs("C:\MyWebSites\RogueCellars\ZinfandelSale.htm")

myPageWindow.Close

EndSub

ShowAll

SaveReportMethodSavesaspecifiedreporttoanHTMLfileontheuser'scomputer.

expression.SaveReport(reportviewModeEx,DestinationUrl,Title,ForceOverwrite)

expressionRequired.AnexpressionthatreturnsaWebWindowExobject.

reportviewModeExRequired.AnFpWebViewModeExconstantthatrepresentsthetypeofreportyouwanttosave.

FpWebViewModeExcanbeoneoftheseFpWebViewModeExconstants.fpWebViewExAllFilesfpWebViewExAssignedTofpWebViewExBrokenLinksfpWebViewExBrowserTypesfpWebViewExCategoriesfpWebViewExCheckoutStatusfpWebViewExComponentErrorsfpWebViewExDailyPageHitsfpWebViewExDailySummaryfpWebViewExFoldersfpWebViewExLinksfpWebViewExMonthlyPageHitsfpWebViewExMonthlySummaryfpWebViewExNavigationfpWebViewExOlderFilesfpWebViewExOsTypesfpWebViewExPagefpWebViewExPublishStatusfpWebViewExRecentlyAddedFilesfpWebViewExRecentlyChangedFiles

fpWebViewExReferringDomainsfpWebViewExReferringURLsfpWebViewExReviewStatusfpWebViewExSearchStringsfpWebViewExSiteSummaryfpWebViewExSlowPagesfpWebViewExTodofpWebViewExUnlinkedFilesfpWebViewExUsageSummaryfpWebViewExVisitingUsersfpWebViewExWeeklyPageHitsfpWebViewExWeeklySummary

DestinationUrlRequired.AStringthatrepresentsthetargetfilenameforthereport.

TitleRequired.AStringthatrepresentsthetitleofthenewreport.

ForceOverwriteOptional.ABooleanthatindicatesifanypreviouslycreatedreportwiththesamefilenamewillbeoverwrittenbythenewreport.IfTrue,anexistingfilewillbeoverwritten.ThedefaultvalueisTrue.

Example

ThefollowingexamplesavesareportofallfilesinthecurrentWebsitetoafilenamedReport1.htmonthelocaluser'scomputer.Thereportwilloverwriteanyexistingreportinthe\Reportsdirectorywiththename"Report1.htm".

SubReportSave()

'Savesaspecifiedreporttoaspecifiedlocation.

DimobjWebwdwAsWebWindowEx

SetobjWebwdw=objApp.ActiveWebWindow

'Savethereport

objWebwdw.SaveReportreportviewModeEx:=fpWebViewExAllFiles,_

Title:="CurrentProjectProgress",_

DestinationURL:="C:\NewProject\Reports\Report1.htm",_

ForceOverwrite:=True

EndSub

SetChoicesMethodSetthechoicesforafieldoftypechoicetotheitemsindicatedintheppsaChoicesargument.

expression.SetChoices(ppsaChoices)

ppsaChoicesRequiredString.Anarrayofitemsthatrepresentthechoicesinthelistfield.

ShowBordersShadingDialogMethodDisplaystheBordersandShadingdialogboxandreturnsaStringthatrepresentstheCascadingStyleSheetpropertysettingsforthebordersandshadingpropertiesselectedintheBordersandShadingdialogbox.AvalueisreturnedwhentheusersclicksOK.IftheuserclicksCancel,anemptyStringisreturned.

expression.ShowBordersShadingDialog(strCSSIn)

strCSSInOptionalVariant.AStringthatrepresentstheinitialcustomsettingsforthedialogbox.

Example

ThefollowingexampledisplaystheBordersandShadingdialogbox,andthensetstheborderstylefortheactiveelementtothebordersettingsreturned.

DimstrCSSAsString

DimstrCSSInAsString

strCSSIn="border:3double#00FFFF"

strCSS=Application.ShowBordersShadingDialog(strCSSIn)

IfstrCSS<>""ThenActiveDocument.activeElement_

.Style.Border=strCSS

ShowFontDialogMethodDisplaystheFontdialogboxandreturnsaStringthatrepresentstheCascadingStyleSheetpropertiesforthefontpropertiesselectedintheFontdialogbox.AvalueisreturnedwhentheusersclicksOK.IftheuserclicksCancel,anemptyStringisreturned.

expression.ShowFontDialog(strCSSIn)

Example

ThefollowingexampledisplaystheFontdialogbox,andthensetsthefontstylefortheactiveelementtothefontsettingsreturned.

DimstrCSSAsString

DimstrCSSInAsString

strCSSIn="font-size:14pt;color:#FF0000"

strCSS=Application.ShowFontDialog(strCSSIn)

IfstrCSS<>""ThenActiveDocument_

.activeElement.Style.Font=strCSS

ShowHTMLDialogMethodDisplaysacustomdialogboxbyusingthecontentsofanHTMLpage.ReturnsaVariant.

expression.ShowHTMLDialog(Url,pVarArgIn)

UrlRequiredString.Thepathandfilenameofthepagetorenderasadialogbox.

pVarArgInOptionalVariant.Datausedtosettheinitialsettingsofthecustomdialogbox.

Example

ThefollowingexampledisplaysthespecifiedWebpageinaMicrosoftWindowsdialogbox.

Application.ShowHTMLDialog("c:\test.htm")

ShowHyperlinkParametersMethodDisplaystheHyperlinkParameterdialogboxandreturnsaStringthatrepresentsthehyperlinkplustheparameters,separatedbyaquestionmark.

expression.ShowHyperlinkParameters(bstrPath,bstrQuery,bstrColumns,bstrColTypes)

bstrPathRequiredString.SpecifiestheWebaddressforthehyperlink.

bstrQueryRequiredString.Specifiesthequerystringtopassinwhenopeningthelinkedpage.

bstrColumnsRequiredString.Specifiesacomma-delimitedStringthatcontainsthenamesofthedatabasecolumnsthatareavailableforuseintheURL.

bstrColTypesRequiredString.Specifiesacomma-delimitedStringthatrepresentsthedatatypevaluesofthedatabasecolumns.

Remarks

ThevaluesforthebstrColTypesparameterincludethefollowing.

Datatype Value Description

adArray 819 Whencombinedwithanotherdatatype,indicatesanarrayoftheotherdatatype.

adBigInt 20 Indicatesan8-bytesignedinteger.adBinary 128 Indicatesabinaryvalue.adBoolean 11 IndicatesaBooleanvalue.adBSTR 8 Indicatesanull-terminatedcharacterstring.

adChapter 136 Indicatesa4-bytechaptervaluethatidentifiesrowsinachildrowset.

adChar 129 Indicatesastringvalue.

adCurrency 6Indicatesacurrencyvalue.Currencyisafixed-pointnumberwithfourdigitstotherightofthedecimalpointandisstoredinaneight-bytesignedinteger.

adDate 7

Indicatesadatevalue.Adatevalueisstoredasadouble,thewholepartofwhichisthenumberofdayssinceDecember30,1899,andthefractionalpartofwhichisthefractionofaday.

adDBDate 133 Indicatesadatevalue(yyyymmdd).adDBTime 134 Indicatesatimevalue(hhmmss).

adDBTimeStamp 135 Indicatesadate/timestamp(yyyymmddhhmmssplusafractioninbillionths).

adDecimal 14 Indicatesanexactnumericvaluewithafixedprecisionandscale.

adDouble 5 Indicatesadouble-precisionfloating-pointvalue.adEmpty 0 Indicatesnovalue.adError 10 Indicatesa32-biterrorcode.

adFileTime 64 Indicatesa64-bitvaluerepresentingthenumberof100-nanosecondintervalssinceJanuary1,1601.

adGUID 72 Indicatesagloballyuniqueidentifier(GUID).

adIDispatch 9 IndicatesapointertoanIDispatchinterfaceonaCOMobject.(ADOdoesnotcurrentlysupportthisdatatype.Usagemaycauseunpredictableresults.)

adInteger 3 Indicatesa4-bytesignedinteger.

adIUnknown 13IndicatesapointertoanIUknowninterfaceonaCOMobject.(ADOdoesnotcurrentlysupportthisdatatype.Usagemaycauseunpredictableresults.)

adLongVarBinary 205 Indicatesalongbinaryvalue.adLongVarChar 201 Indicatesalongstringvalue.adLongVarWChar 203 Indicatesalongnull-terminatedUnicodevalue.

adNumeric 131 Indicatesanexactnumericvaluewithafixedprecisionandscale.

adPropVariant 138 IndicatesanAutomationPROPVARIANT.adSingle 4 Indicatesasingle-precisionfloatingpoint.adSmallInt 2 Indicatesa2-bytesignedinteger.adTinyInt 16 Indicatesa1-bytesignedinteger.adUnsignedBigInt 21 Indicatesan8-byteunsignedinteger.adUnsignedInt 19 Indicatesa4-byteunsignedinteger.adUnsignedSmallInt 18 Indicatesa2-byteunsignedinteger.adUnsignedTinyInt 17 Indicatesa1-byteunsignedinteger.adUserDefined 132 Indicatesauser-definedvariable.adVarBinary 204 Indicatesabinaryvalue.adVarChar 200 Indicatesastringvalue.

adVariant 12IndicatesanAutomationVariant.(ADOdoesnotcurrentlysupportthisdatatype.Usagemaycauseunpredictableresults.)

adVarNumeric 139 Indicatesanumericvalue.adVarWChar 202 Indicatesanull-terminatedUnicodecharacterstring.adWChar 130 Indicatesanull-terminatedUnicodecharacterstring.

FormoreinformationonActiveXdatatypes,seeActiveXDataObject(ADO)ontheMicrosoftDeveloperNetwork(MSDN)Website.

Example

ThefollowingexampledisplaystheHyperlinkParameterdialogboxwiththefollowingURLandsettings.

Application.ShowHyperlinkParameters"http://www.fourthcoffee.com/coffee.asp",_

"type=black","CategoryID,CategoryName,Description","3,202,202"

ShowImportWebPackageDialogMethodReturnsaBooleanthatindicateswhetherthemethodsuccessfullyaddedthespecifiedWebpackage.

expression.ShowImportWebPackageDialog(packageFileName,urlImportedTo)

packageFileNameRequiredString.ThepathandfilenameoftheWebpackagetoimport.

urlImportedToRequiredString.ThepathandfilenameofwheretoimporttheWebpackage.

Remarks

YoucanimportWebpackagesonlyintoWebsitesbasedonMicrosoftWindowsSharePointServices.

Example

ThefollowingexampledisplaystheImportWebPackagedialogbox,andthenindicateswhetherthespecifiedWebpackagewasaddedsuccessfullytothespecifiedWebsite.

DimblnResponseAsBoolean

blnResponse=Application.ShowImportWebPackageDialog_

("c:\NewWebPackage.fwp",ActiveWeb.Url)

IfblnResponse=TrueThen

MsgBox"TheWebpackagewasaddedsuccessfully."

MsgBox"UnabletoaddtheWebpackagetothespecifiedsite."_

&vbCrLf&"Contactyouradministratorforassistance."

ShowPickURLDialogMethodDisplaysthetheEditHyperlinkdialogboxandreturnsaStringthatrepresentstheURLtothefilethattheuserhasselectedintheEditHyperlinkdialogbox.

expression.ShowPickURLDialog(strBaseURL,strFileURL)

strBaseURLOptionalVariant.ThebaseURLfortheresultinghyperlink.

strFileURLOptionalVariant.Theselectedpageforanewhyperlink.TheusermaychangethisbyselectingadifferentpageintheEditHyperlinkdialogbox.

Example

ThefollowingexampledisplaysthetheEditHyperlinkdialogbox.

DimstrURLAsString

DimobjSelectionAsIHTMLTxtRange

DimstrHyperlinkAsString

strURL=Application.ShowPickURLDialog_

(ActiveWeb.Url,"c:\test.htm")

SetobjSelection=ActiveDocument.selection.createRange

WithobjSelection

strHyperlink="<ahref="""&strURL&""">"&.Text&"</a>"

.pasteHTMLstrHyperlink

EndWith

ShowPositionDialogMethodReturnsaStringthatrepresentsthevalueofthepositionattributeforacascadingstylesheet.

expression.ShowPositionDialog(strCSSIn)

Example

Thefollowingexamplesetsthepositionattributefortheactiveelementintheactivedocument.NotethatusingthesetAttributemethodoverwritesanyotherstyleattributesettingsfortheactiveelement.

DimstrCSSAsString

DimstrCSSInAsString

strCSSIn="position:absolute;left:750"

strCSS=Application.ShowPositionDialog(strCSSIn)

IfstrCSS<>""ThenActiveDocument.activeElement_

.setAttribute"style",strCSS

SplitArgsMethodReturnsaVariantthatrepresentsanarrayoftheindividualitemsinthespecifiedstringseparatedbythespecifiedcharacterstring.

expression.SplitArgs(String,Tokens)

StringRequiredString.Thestringcontainingthedata.

TokensRequiredString.ThecharacterstringthatseparatestheitemsintheStringparameter.

Remarks

TheSplitArgsmethodissimilartotheSplitfunctioninMicrosoftVisualBasic;however,theSplitArgsmethodwillnotbreakquote-delimitedstrings.

Example

Thefollowingexamplesplitsthespecifiedstringintoanarrayoftheitemsinthespecifiedstringthatareseparatedbyacomma.

DimvarArray()AsVariant

varArray=Application.SplitArgs("this,isa,test",",")

UndoCheckoutMethodReturnsthespecifiedfiletoitspriorstateinthesourcecontrolprojectwithoutsavinganychangesthatmayhavebeenmade.

expression.UndoCheckout

Example

Thefollowingexamplechecksafileintoitspriorstate(itsstatebeforecheckout).Thefilemustbepartofasourcecontrolproject.

NoteTorunthisprocedure,youmusthaveasourcecontrolprojectinplacewithaWebsiteopenandapagecalledZinfandel.htmcontainedintheWebsite.Or,substituteanalternateWebsiteandfilename.

PrivateSubUndoCheckout()

DimmyWebAsWebEx

SetmyWeb=("C:/MyWebSites/RogueCellars")

myWeb.RootFolder.Files("Zinfandel.htm").UndoCheckout

EndSub

UpdateDynamicTemplateMethodUpdatesthepagesthatareattachedtoaDynamicWebTemplatesothatanychangestotheDynamicWebTemplateareappliedtopagesthatreferencetheDynamicWebTemplate.

expression.UpdateDynamicTemplate(type,pbzLog)

pStateRequiredDynamicTemplateState.SpecifiestheregionmappingtousewhenupdatingtheDynamicWebTemplate.UsetheSetHeadMappingandSetBodyMappingmethodsoftheDynamicTemplateStateobjecttocustomizeregionmapping.

pbzLogRequiredString.AByRefparameterthatreturnsaStringcontainingthelogentryabouttheupdateprocessforafile.Inthecaseofanerror,itreturnsinformationthatindicateswhichfileshavefailed.

Remarks

Ifanerroroccurs,theupdateprocesswillterminateunlesstheSkipOnQuerypropertyissettoTrue.

Example

ThefollowingexampleupdatestheDynamicWebTemplatereferencesinthespecifiedfile.

DimobjFileAsWebFile

DimstrLogAsString

SetobjFile=ActiveWeb.LocateFile("home.htm")

objFile.UpdateDynamicTemplateobjState,strLog

VerifyAllLinksMethodVerifiesallhyperlinksinthespecifiedWebsite.

NoteTheBrokenHyperlinksreportusestheVerifyAllLinksmethodtodisplayanypageswithbrokenhyperlinks.

expression.VerifyAllLinks

expressionRequired.AnexpressionthatreturnsaWebWindowExobject

Example

ThefollowingexampleusestheVerifyAllLinksmethodtocheckforbrokenlinksintheactiveWebsite,andthenswitchestotheBrokenHyperlinksreportview.

SubVerifyLinks()

'Verifiesbrokenlinksinthecurrentview

'Verifyalllinksinthecurrentweb.

objWebwdw.VerifyAllLinks

EndSub

ActiveDocumentPropertyReturnsanFPHTMLDocumentobjectthatrepresentstheWebpagecurrentlydisplayedintheMicrosoftFrontPageapplicationwindow.

expression.ActiveDocument

Remarks

ThisobjectprovidesaccesstotheMicrosoftFrontPagePageObjectModelelementsthatarecompatiblewithMicrosoftInternetExplorer4.0andlater.ThisobjectmodelprovidesprogrammaticaccesstotheHTMLinthespecifiedpage.

Example

ThefollowingstatementreturnstheactivedocumentinFrontPage.

myDoc=Application.ActiveDocument

Thefollowingstatementreturnstheactivedocumentforthespecifiedpagewindow.

myDoc=Application.WebWindows(0).PageWindows(0).ActiveDocument

ActiveFrameWindowPropertyReturnsanFPHTMLWindow2objectthatrepresentsthedocumentdisplayedintheactivepagewindow.

NoteIftheactivepagecontainsframes,theActiveFrameWindowpropertyreturnsthecurrentlyselectedframe,ifoneisselected,ortheframespageitself,ifnoneoftheframesisselected.Ifapagedoesnotcontainframes,theActiveFrameWindowpropertyreturnsthewindowcontainingthespecifiedpage.

expression.ActiveFrameWindow

NoteAccessingtheActiveFrameWindowpropertyisthesameasaccessingtheparentwindowthroughtheactivepagewindowasfollows:

ActivePageWindow.Document.parentWindow

Example

ThefollowingexampleretrievestheActiveFrameWindowobject.

PrivateSubGetActiveFrame()

DimmyFrameAsFPHTMLWindow2

SetmyPageWindow=_

ActiveWeb.ActiveWebWindow.ActivePageWindow

SetmyFrame=myPageWindow.ActiveFrameWindow

EndSub

ActivePageWindowPropertyReturnsaPageWindowExobjectthatrepresentsthewindowinwhichthecurrentpageisdisplayed.

expression.ActivePageWindow

Example

ThefollowingexamplereturnsthePageWindowExobjectfortheApplicationobject.

PrivateSubGetActivePageWindow()

SetmyPageWindow=ActivePageWindow

EndSub

ThefollowingexamplereturnsthePageWindowExobjectfromtheWebWindowExobject.

PrivateSubGetActivePageWindow()

SetmyPage=ActiveWebWindow.ActivePageWindow

EndSub

ActiveWebPropertyReturnsaWebExobjectthatrepresentstheWebsitecurrentlyopeninMicrosoftFrontPage.

expression.ActiveWeb

Remarks

TheMicrosoftFrontPageVisualBasicforApplicationsobjectmodelprovidesaccesstotheWebobjectmodelthroughtheActiveWebproperty.FormoreinformationabouttheFrontPageobjectmodels,seeExploringtheObjectModelinFrontPage.

Example

ThisexampleusestheActiveWebpropertytolocatetheWebpageindex.htmandchangesthebackgroundcolorofthepage.

NoteTorunthisexample,createaformwithonecommandbuttoncalledcmdActiveWebColorChangeandpastethefollowingcodeinthecodewindow.YoumusthaveaWebpagecalledindex.htmforthisproceduretochangethebackgroundcolor.

PrivateSubcmdActiveWebBKGRDColorChange_Click()

DimmyPageWinAsPageWindowEx

SetmyPageWin=Application.ActiveWeb.LocatePage("index.htm")

myPageWin.Document.bgColor="PapayaWhip"

EndSub

NoteMicrosoftVisualBasicprovidescolorconstantswitha"vb"prefix,suchasvbCyan.FrontPagebuildsWebpagesinHTML,whichusesdifferentcolorconstantsthanVisualBasic.IfyouusethecolorconstantsprovidedwithVisualBasicinyourexistingprograms,youmayneedtochangethesetotheequivalenthexadecimalcolorvalueswhenyouportyourprogramstoaFrontPage-basedWebsite,orwhenyouusecolorsacrossMicrosoftOfficeapplicationsthatincludeaFrontPage-basedWebsite.

ActiveWebWindowPropertyReturnsaWebWindowExobjectthatrepresentsthewindowinwhichthecurrentlyopenWebsiteisdisplayed.

expression.ActiveWebWindow

Example

ThisexampleprintsthevalueoftheActiveDocument.nameProppropertyfortheWebExobject.

NoteTorunthisexample,createaformwithacommandbuttoncalled"cmdActiveWebWindowDisplay"andalabelcalled"lblWebWindowDisplay".Pastethefollowingcodeinthecodewindow.YoumusthaveaMicrosoftFrontPage-basedWebpageopenforthisproceduretoreturnadocumentname.

PrivateSubcmdActiveWebWindowDisplay_Click()

OnErrorResumeNext

DimmyCurrentWebWindowAsWebWindowEx

SetmyCurrentWebWindow=Application.ActiveWebWindow

WithmyCurrentWebWindow

lblWebWindowDisplay.Caption=.ActiveDocument.nameProp

EndWith

EndSub

AllFilesPropertyReturnsaWebFilescollectionthatrepresentsallfilesinthespecifiedWebsite.

expression.AllFiles

Remarks

TheWebFilescollectionreturnsallfilesinthecollectionregardlessoftheirpositionintheWebsitehierarchy.

Example

ThefollowingexamplesearchesthroughthefilesintheactiveWebsiteforapagewiththetitle"MainPage."Ifthepageisfound,itisopenedinMicrosoftFrontPage.

SubFindFileTitle()

'ReturnsacollectionofallfilesinthecurrentWebsite.

DimobjWebFileAsWebFile

DimobjWebFilesAsWebFiles

'CreateareferencetotheWebFilescollection.

SetobjWebFiles=objApp.ActiveWeb.AllFiles

'CheckeachfileinthecollectionforthetitleMainPage.

ForEachobjWebFileInobjWebFiles

'Ifthetitleisfoundopenthepageintheeditor.

IfobjWebFile.Title="MainPage"Then

objWebFile.Open

'Ifnotfound,checknextfile.

NextobjWebFile

EndSub

AllFoldersPropertyReturnsaWebFolderscollectionthatrepresentsallfoldersinthecurrentWebsite.

expression.AllFolders

Remarks

TheWebFolderscollectionreturnsallfoldersinthecollectionregardlessoftheirpositionintheWebsitehierarchy.

Example

ThefollowingexamplesearchesthroughtheWebFolderscollectionforafoldernamed"Folder1."Ifthefolderisfound,theexamplesearchesforafilewiththetitle"MainPage."Ifthetitleisfound,thefileisopenedinMicrosoftFrontPage.

SubWebFoldersFind()

DimobjWebFolderAsWebFolder

DimobjWebFoldersAsWebFolders

'CreateareferencetotheWebFolderscollection.

SetobjWebFolders=objApp.ActiveWeb.AllFolders

'Checkeachfolderinthecollectionforthename"Folder1".

ForEachobjWebFolderInobjWebFolders

'Ifthefolderisfoundthensearchthrougheach

'fileinthefolderforafilewiththetitle

'MainPageandopenthefileifitexists.

IfobjWebFolder.Name="Folder1"Then

Fori=1ToobjWebFolder.Files.Count

IfobjWebFolder.Files.Item(i).Title="MainPage"Then

objWebFolder.Files.Item(i).Open

ExitFor

'Ifnotfoundchecknextfile.

NextobjWebFolder

EndSub

AllNavigationNodesPropertyReturnsaNavigationNodescollectionobjectthatrepresentsallofthenavigationnodesinthespecifiedWebsite.

NoteNavigationnodesareusedtodisplayagraphicrepresentationofthecurrentWebsiteinNavigationview.

expression.AllNavigationNodes

Example

ThefollowingexamplereturnsareferencetotheNavigationNodescollectionanddisplaysthefilenameofthefirstobjectinthecollectionandthetitleoftheWebsiteinwhichitexists.

SubAllNavigationNodes()

'CreateareferencetotheNavigationNodescollection.

'Returnareferencetothefirstnodeinthecollection.

SetobjNavNode=objNavNodes.Item(0)

'DisplaythefilenameandtheWebofthefirst

'navigationnodeinthecollection

MsgBox"TheURLofthisfileis"&objNavNode.Url&_

vbCr&".Itisfoundinthe"_

&objNavNode.Web.Title&"Website."

EndSub

AllowAttachmentsPropertySetsorreturnsaBooleanthatrepresentswhetheralistallowsallowsattachments.

expression.AllowAttachments

AllowFillInChoicesPropertySetsorreturnsaBooleanthatrepresentswhetherachoicefieldallowsuserstoenteracustomchoice.

expression.AllowFillInChoices

AllowModeratePropertySetsorreturnsaBooleanthatrepresentswhethertoallowusingthemoderationsettinginalist.

expression.AllowModerate

AllowMultipleResponsesPropertyReturnsorsetsaBooleanthatdetermineswhetheruserscanrespondmorethanoncetoagivensurvey.IfFalse,ausercanonlyrespondoncetoasurvey.

expression.AllowMultipleResponses

expressionRequired.AnexpressionthatreturnsaSurveyobject.

Example

ThefollowingexamplesetstheAllowMultipleResponsespropertyofallSurveyobjectsintheactiveWebsitetoFalsesothatuserscanonlyrespondoncetoagivensurvey.

SubChangeResponses()

'Setsnumberofresponsestooneperuser.

DimobjListAsObject

DimobjListsAsLists

'Cyclethrougheachlistandcheckforlisttype.

ForEachobjListInobjLists

'Ifit'saSurveythenchangeresponsestosingle.

IfobjList.Type=fpListTypeSurveyThen

objList.AllowMultipleResponses=False

EndSub

AllowRichHTMLPropertySetsorreturnsaBooleanthatrepresentswhethertodisplaytheRichTextFormat(RTF)editcontrolinthebrowser.

expression.AllowRichHTML

expressionRequired.AnexpressionthatreturnsaListFieldMultiLineobject.

AllowsLongFilenamesPropertyReturnsTrueiftheoperatingsystemonthemachinewheretheWebsiteresidesacceptslongfilenames.Read-onlyBoolean.

expression.AllowsLongFilenames

Example

ThefollowingexamplecheckswhethertheactiveWebsiteallowslongfilenames.TheexampleassumestheexistenceofaprocedurenamedConvertLongFilenames.

IfActiveWeb.AllowsLongFilenames=TrueThen

ExitSub

CallConvertLongFilenames()

AnswerWizardPropertySomeofthecontentinthistopicmaynotbeapplicabletosomelanguages.

ReturnsanAnswerWizardobjectthatcontainsthefilesusedbytheHelpsearchengine.

expression.AnswerWizard

Example

ThisexampleaddsanAnswerWizardfileandretrievestheCreatorandCountproperties.

NoteTheCreatorpropertyforMicrosoftFrontPageisdifferentfromtheCreatorpropertyusedbyotherMicrosoftOfficeobjects,suchastheAnswerWizardobject.TheCreatorpropertyforFrontPageusesastringformat,whileOfficeobjectsusea32-bitintegertoidentifytheapplicationthatcreatedthefile.Inthisexample,you'llnotethattheCreatorpropertyreturnsa32-bitintegerratherthantheFrontPagestringformatbecausetheAnswerWizardobjectisanOfficesharedobject.Formoreinformation,usetheObjectBrowserforalllibrariesorMicrosoftVisualBasicHelptoviewmoredetailedinformationabouttheCreatorpropertyforMicrosoftOfficeobjects.

PrivateSubGetAnswerWizardInfo()

DimmyAWAsAnswerWizard

DimmyAWFilesAsAnswerWizardFiles

DimmyAWCountAsInteger

DimmyAWCreatorAsString

SetmyAW=ActiveWeb.Application.AnswerWizard

SetmyAW=myAW.Files

WithmyAWFiles

myAWCreator=.Creator

.Add("myAWFile")

myAWCount=.Count

EndWith

EndSub

ApplicationPropertyReturnsanApplicationobjectthatrepresentstheMicrosoftFrontPageapplication.

expression.Application

Example

TheapplicationnamecanbedirectlyaccessedfromtheobjectsandcollectionsintheFrontPageobjectmodel.ThisstatementshowstheFrontPageapplicationaccessedfromtheFilescollection.

SetcurrApp=ActiveWeb.RootFolder.Files.Application

AssistantPropertySomeofthecontentinthistopicmaynotbeapplicabletosomelanguages.

ReturnsanAssistantobjectthatrepresentstheMicrosoftOfficeAssistant.Read-only.

expression.Assistant

Example

ThefollowingexamplereturnsareferencetotheMicrosoftOfficeAssistantandmodifiesitsproperties.ThesubroutinedisplaystheAssistantonthescreen,turnsanimationsoundson,andsetstheMoveWhenInTheWaypropertytoTrue.TheAssistantwillnowmovetoanotherlocationonthescreenifitisintheuser'sway.

SubfpAsst()

'CreatesareferencetotheOfficeAssistantandmodifiesitsproperties

DimobjAsstAsAssistant

'ReturnareferencetotheOfficeAssistant

SetobjAsst=objApp.Assistant

WithobjAsst

'Makeassistantvisible

.Visible=True

'Allowsoundsduringanimations

.Sounds=True

'MovetheAssistantoutofthewaywhenneeded

.MoveWhenInTheWay=True

EndWith

EndSub

AuthorPropertySetsorreturnsaStringthatrepresentsthenameoftheauthorwhocreatedaWebpackage.

expression.Author

Example

DimobjWebAsWebEx

SetobjWeb=ActiveWeb

WithobjPackage

.Author="JohnSmith"

EndWith

BuildPropertyReturnsthebuildnumberforthespecifiedobject.Read-onlyString.

expression.Build()

Remarks

IftheApplicationobjectisspecified,theBuildpropertyreturnsthebuildnumberoftheapplication.WhentheSystemobjectisspecified,thispropertyreturnsthebuildnumberoftheoperatingsystem.Forexample,theformatusedontheAboutdialogboxforanapplicationmightlooklikethis:“Version:4.0.0.xxxx,”wherexxxxisthebuildnumberoftheapplication.WhentheBuildpropertyfortheSystemobjectisaccessed,itreturnsthecurrentbuildoftheoperatingsystemasyoumightseeusedonthePropertiespageoftheSystemdialogbox.

Example

Thefollowingstatementreturnsthebuildnumberoftheapplication.

myAppBuild=Application.Build

Youcanaccessthesystembuildasshowninthefollowingstatement.

mySysbuild=System.Build

CaptionPropertyReturnsaStringthatrepresentseitherthecaptiontextinthetitlebarortheURLofapage.

expression.Caption

Remarks

TheCaptionpropertyreturnsdifferentvaluesdependingontheobject.Forexample,theCaptionpropertyforthePageWindowExobjectreturnsthefileURLoftheopenpage,whiletheCaptionpropertyfortheWebWindowExobjectreturnsthetextofthetitlebarfortheMicrosoftFrontPageapplicationwindow.

Example

Thisstatementreturnsthecaptionoftheactivepage.

myCaption=ActivePageWindow.Caption

ThefollowingexampledemonstratesaccessingboththeactiveWebWindowExandPageWindowExobjectsusingtheWithandForstatements.

PrivateSubGetPageWindowCaption()

DimmyPageWindowCaptionsAsString

DimmyWebWindowCaptionAsString

SetmyWebWindow=Application.ActiveWebWindow

SetmyPageWindows=myWebWindow.PageWindows

WithmyWebWindow

myWebWindowCaption=.Caption

EndWith

ForEachmyPageWindowInmyPageWindows

myPageWindowCaptions=myPageWindowCaptions&myPageWindow.Caption

EndSub

CheckedoutByPropertyReturnsaStringthatrepresentsthelogonnameofthepersontowhomthespecifiedfileischeckedout.

NoteYoumusthaveasourcecontrolprojectinplacebeforeusingthismethod.

expression.CheckedoutBy

Example

Thisexampleretrievesthelogonaliasofthepersonwhocheckedoutthefile.

NoteYoumusthaveasourcecontrolprojecttorunthisexample.

PrivateSubGetCheckedOutBy()

DimmyCheckedOutAliasAsString

myCheckedOutAlias=_

ActiveWeb.RootFolder.Files(0).CheckedoutBy

EndSub

ChildrenPropertyReturnsaNavigationNodescollectionthatrepresentsthecollectionofchildnodesforanavigationnode.

expression.Children

expressionRequired.AnexpressionthatreturnsaNavigationNodeobject.

Example

Thefollowingexamplereturnsthenumberofchildnodesthatexistdirectlybelowthehomepagenavigationnode.

PrivateSubGetChildrenCount()

DimmyCountAsInteger

myCount=ActiveWeb.HomeNavigationNode.Children.Count

EndSub

ChoicesPropertyReturnsorsetsaStringthatrepresentsanarrayofallchoicesinthecurrentfield.

expression.Choices

Example

Thefollowingexampledisplaysthetextforallchoicesinthefield"NewChoiceField."Ifthefieldcontainsnochoices,amessageisdisplayedtotheuser.Thefield"NewChoiceField"isanobjectoftypeListFieldChoice.

SubViewChoices()

'Displaysthechoicesinthecurrentfield

DimVarChoicesAsVariant

DimstrChoiceAsString

'Referencechoicefield

SetobjFldChoice=objLstFlds.Item("NewChoiceField")

blnFound=False

ForEachVarChoiceInobjFldChoice.Choices

IfstrChoice=""Then

'iffirstvalueinstring

strChoice=VarChoice&vbCr

'Thelistcontainsatleastonechoice

blnFound=True

'addvaluetostring

strChoice=strChoice&VarChoice&vbCr

NextVarChoice

IfblnFound=TrueThen

'Displaychoices

MsgBox"Thecurrentlistcontainsthefollowingchoices:"&_

vbCr&strChoice

MsgBox"Thecurrentfieldcontainsnochoices."

EndSub

COMAddInsPropertyReturnsaCOMAddInscollectionthatrepresentsalltheComponentObjectModel(COM)add-inscurrentlyloadedinMicrosoftFrontPage.ThesearelistedintheCOMAdd-Insdialogbox(Add-InscommandontheToolsmenu).

expression.COMAddIns

Remarks

AlloftheFrontPageadd-insthatareregisteredintheMicrosoftWindowsRegistryarelocatedunderthefollowingkey:

HKEY_CURRENT_USER\Software\Microsoft\Office\version\FrontPage\AddIns

Add-insdesignedforadministratorsareregisteredunder:

HKey_Local_Machine\Software\Microsoft\Office\version\FrontPage\Addins

Example

Thefollowingexamplereturnsthenumberofadd-insavailabletoFrontPage.

PrivateSubGetCOMAddIns()

DimmyWebAsWebEx

DimmyAddinCountAsInteger

SetmyWeb=ActiveWeb

myAddinCount=Application.COMAddIns.Count

EndSub

CommandBarsPropertyReturnsaCommandBarscollectionthatrepresentsthemenuandtoolbarsdisplayedinMicrosoftFrontPage.

expression.CommandBars

Remarks

Youcan'taccessFrontPage-specificpop-upshortcutmenususingtheCommandBarscollection.Forexample,youcan'taccesstheshortcutmenuthatappearswhenyouright-clickapageinPageview.However,youcancreateyourownpop-upshortcutmenususingtheShowPopupmethodfortheCommandBarobject.

Example

Thefollowingthreeproceduressetupanewmenuitemonatoolbar.

Procedure1

SubAddMenuItem()

DimnewMenuAsCommandBarControl

DimtoolsMenuAsCommandBar

SettoolsMenu=Application.CommandBars("Tools")

SetnewMenu=_

toolsMenu.Controls.Add(msoControlButton,,,,True)

newMenu.Caption="New&MenuItem"

EndSub

Thefollowingprocedureconnectstheclickeventtothecustombuttonandmustbeaddedtoaclassorformmodule.Themoduleshownisaformmodule.ThisprocedureaddsanewitemtotheToolsmenuandconnectstheeventsofthecustombuttonbyassigningthevariablee_NewMenu(usedintheWithEventsstatement)tothecustombuttonvariablenewMenu.

Procedure2

PrivateSubAddButton_Click()

DimnewMenuAsCommandBarControl

DimWithEventse_NewMenuAsCommandBarButton

SubAddMenuItemWithEventHook()

DimtoolsMenuAsCommandBar

SettoolsMenu=Application.CommandBars("Tools")

SetnewMenu=_

toolsMenu.Controls.Add(msoControlButton,,,,True)

Sete_NewMenu=newMenu

newMenu.Caption="New&MenuItem"

EndSub

PrivateSube_NewMenu_Click(ByValCtrlAs_

Office.CommandBarButton,CancelDefaultAsBoolean)

MsgBox"MenuItemClicked"

Ctrl.Caption="Clicked"

EndSub

ToexecuteFrontPagecustommenuitemsusingtheCommandBarscollection,indexthemenuitemandcalltheexecutemethodforthatitem.ThefollowingexampleinsertsaMicrosoftOfficespreadsheetcontrolattheinsertionpoint.

Procedure3

SubExecuteMenu()

DimIAsString

DimCAsString

DimOAsString

I="Insert"

C="C&omponent"

O="OfficeSp&readsheet"

CommandBars(I).Controls(C).Controls(O).Execute

EndSub

ThefollowingexamplereturnsthestatusofvariouspropertiesofthecommandbarsintheactiveWebsite.

PrivateSubGetCommandBars()

DimmyWebAsWebEx

DimmyCBAsObject

DimmyCBCountAsInteger

DimmyDisplayFontsAsBoolean

DimmyDisplayKeysInToolTipsAsBoolean

DimmyLargeButtonsAsBoolean

DimmyMenuAnimationStyleAsString

SetmyWeb=ActiveWeb

SetmyCB=Application.CommandBars

WithmyCB

myCBCount=.Count

myDisplayFonts=.DisplayFonts

myDisplayKeysInToolTips=.DisplayKeysInTooltips

myLargeButtons=.LargeButtons

myMenuAnimationStyle=.MenuAnimationStyle

EndWith

EndSub

Thefollowingexampleisatoolthatiteratesthroughthecommandbarsandreturnsseveralpropertiesfromeachmenu.

NoteTorunthisexample,createaformthathasatextboxcalledtxtComBarandacommandbuttoncalledcmdComBar,andcopythefollowingcodetothecodewindow.

PrivateSubcmdComBar_Click()

DimmyWebAsWebEx

DimmyComBarsAsObject

DimmyComBarAsObject

DimmyTextAsString

DimmyNameAsString

DimmyAdaptMenuAsString

DimmyEnabledMenuAsString

DimmyMenuHeightAsString

DimmyMenuWidthAsString

SetmyWeb=ActiveWeb

SetmyComBars=Application.CommandBars

myName="Name:"

myAdaptMenu="MenuAdaptive?"

myEnabledMenu="MenuEnabled?"

myMenuHeight="MenuHeight:"

myMenuWidth="MenuWidth:"

txtComBar.Locked=True

txtComBar.maxLength=10000

txtComBar.MultiLine=True

txtComBar.ScrollBars=fmScrollBarsVertical

WithmyComBars

ForEachmyComBarInmyComBars

WithmyComBar

myText=myText&myName&.Name&vbCrLf

myText=myText&myAdaptMenu&.AdaptiveMenu&vbCrLf

myText=myText&myEnabledMenu&.Enabled&vbCrLf

myText=myText&myMenuHeight&.Height&vbCrLf

myText=myText&myMenuWidth&.Width&vbCrLf

txtComBar.Text=myText

EndWith

txtComBar.SetFocus

txtComBar.CurLine=0

EndWith

EndSub

CompanyPropertySetsorreturnsaStringthatrepresentsthenameofthecompanythatcreatedaWebpackage.

expression.Company

Example

DimobjWebAsWebEx

SetobjWeb=ActiveWeb

WithobjPackage

.Author="JohnSmith"

EndWith

ComputationFormulaPropertySetsorreturnsaStringthatrepresentstheformulausedtogetavalueforacalculatedfield.

expression.ComputationFormula

expressionRequired.AnexpressionthatreturnsaListFieldComputedobject.

ShowAll

ConnectionSpeedPropertyReturnsorsetsanFpConnectionSpeedvaluethatindicatestheuser'sInternetconnectiontype.

FpConnectionSpeedcanbeoneoftheseFpConnectionSpeedconstants.fpConnect14414400baud-ratemodemfpConnect28828800baud-ratemodemfpConnect56K56600baud-ratemodemfpConnectISDNISDNconnectionfpConnectT1T1connectionfpConnectT3T3connection

expression.ConnectionSpeed

Remarks

TheConnectionSpeedpropertyisusedinconjunctionwiththeSlowPagepropertytodeterminethesimulateddownloadtimeofaWebpage.ThedefaultvalueisfpConnect144.

Example

ThefollowingexamplesetstheConnectionSpeedpropertytofpConnect56K,simulatinga56Kmodem.Theamountoftimeafiletakestodownloadandthecriteriausedtodeterminea"slow"pageintheReportsviewwillbebasedonthisvalue.

SubSpeedOfConnection()

'ModifiestheConnectionSpeedproperty

WithobjApp

'Settheconnectiontypeto56Kmodem

.ConnectionSpeed=fpConnect56K

EndWith

EndSub

CountPropertyReturnsthenumberofitemsinthespecifiedcollection.Read-onlyVariant.

expression.Count

Remarks

Somecollectionsare0-basedandsomeare1-based.TheCountpropertyforcollectionsbeginswith1eventhoughyouaccessthefirstiteminacollectionwitha0.

Example

ThefollowingexamplereturnsthenumberofthemesandfoldersintheactiveWebsite.

PrivateSubGetWebCount()

DimmyWebAsWebEx

DimmyCountAsInteger

SetmyWeb=ActiveWeb

WithmyWeb

myThemeCount=.Themes.Count

myFolderCount=.RootFolder.Folders.Count

EndWith

EndSub

CreatorPropertyReturnsaStringthatrepresentsthenameoftheapplicationinwhichthisobjectwascreated.IftheobjectwascreatedinMicrosoftFrontPage,thispropertyreturnstheString"FrontPage.Editor.Document".

NoteTheCreatorpropertyforFrontPageisdifferentfromtheCreatorpropertyusedbyotherMicrosoftOfficeobjects.TheCreatorpropertyforFrontPageusesastringformat,whileOfficeobjectsusea32-bitintegertoidentifytheapplicationthatcreatedthefile.

expression.Creator

Example

ThisexamplechecksifthecreatorofafileisFrontPage.

PrivateSubGetCreator()

DimmyCreatorAsString

myCreator=ActiveWeb.RootFolder.Files(0).Creator

IfmyCreator<>"FrontPage.Editor.Document"Then

MsgBox"ThisfilewasnotcreatedbyFrontPage."

EndSub

ShowAll

CurrencyPropertyReturnsorsetsanFpCurrencyFieldFormatenumeratedconstantthatdeterminesthetypeofcurrencytobeusedinthecurrencyfield.Read/write.

FpCurrencyFieldFormatcanbeoneoftheseFpCurrencyFieldFormatconstants.fpCurrencyFieldArgentinafpCurrencyFieldAustraliafpCurrencyFieldAustriafpCurrencyFieldBelgiumBFfpCurrencyFieldBelgiumFBfpCurrencyFieldBoliviafpCurrencyFieldBrazilfpCurrencyFieldCanadafpCurrencyFieldCanadaFfpCurrencyFieldChilefpCurrencyFieldColombiafpCurrencyFieldCostaRicafpCurrencyFieldCzechfpCurrencyFieldDenmarkfpCurrencyFieldDominicanRepublicfpCurrencyFieldEcuadorfpCurrencyFieldElSalvadorfpCurrencyFieldEurofpCurrencyFieldEuroPostfixfpCurrencyFieldFinlandfpCurrencyFieldFrancefpCurrencyFieldGermanyfpCurrencyFieldGreecefpCurrencyFieldGuatemalafpCurrencyFieldHonduras

fpCurrencyFieldHongKongfpCurrencyFieldHungaryfpCurrencyFieldIrelandfpCurrencyFieldItalyfpCurrencyFieldJapanfpCurrencyFieldKoreafpCurrencyFieldMexicofpCurrencyFieldNetherlandsfpCurrencyFieldNewZealandfpCurrencyFieldNicaraguafpCurrencyFieldNorwayfpCurrencyFieldPanamafpCurrencyFieldParaguayfpCurrencyFieldPerufpCurrencyFieldPolandfpCurrencyFieldPortugalfpCurrencyFieldPRChinafpCurrencyFieldRussiafpCurrencyFieldSingaporefpCurrencyFieldSlovakiafpCurrencyFieldSloveniafpCurrencyFieldSouthAfricafpCurrencyFieldSpainfpCurrencyFieldSwedenfpCurrencyFieldSwitzerlandfpCurrencyFieldTaiwanfpCurrencyFieldTurkeyfpCurrencyFieldUnitedKingdomfpCurrencyFieldUnitedStatesfpCurrencyFieldUruguayfpCurrencyFieldVenezuela

expression.Currency

expressionRequired.AnexpressionthatreturnsaListFieldCurrencyobject.

Remarks

Thedefaultvalueforthisfieldisdeterminedbytheuser'ssystemsettings.

Example

ThefollowingexamplecreatesanewfieldoftypefpFieldCurrencyandchangesthedefaultcurrencysettingtodisplayCanadian.

SubCreateCurrencyField()

'AddnewCurrencyfield

DimobjFldChoiceAsListFieldCurrency

DimstrNameAsString

strName="NewCurrencyField"

'AddnewFieldoftypefpFieldCurrencytolist

objLstFlds.AddName:=strName,Description:="NewChoicevalueField",_

Fieldtype:=fpFieldCurrency,Required:=True

SetobjFldChoice=objLstFlds.Item("NewCurrencyField")

'ChangecurrencytypetoCanadian

objFldChoice.Currency=fpCurrencyFieldCanada

EndSub

DefaultTextPropertySetsorreturnsaStringthatrepresentsthedefaultvalueforahyperlinkfield,whichistheURLandthetextdisplayedtextforthehyperlink.

expression.DefaultText

expressionRequired.AnexpressionthatreturnsaListFieldURLobject.

DefaultValuePropertyReturnsorsetsaVariantthatdefinesthedefaultvalueofthefield.Read/write.

expression.DefaultValue

Remarks

Thedefaultvalueofallpre-populatedfieldsisEmpty.

Example

Thefollowingexampledisplaysthenamesofallfieldsinthelistandtheirassociateddefaultvalues.IftheactiveWebsitedoesnotcontainanylists,amessageisdisplayedtotheuser.

SubFieldDefaultValue()

'Displaythedefaultvalueofthefield

DimstrTypeAsString

'Displayfieldsinfirstlistofcollection

IfstrType=""Then

strType=objField.Name&"-"&_

objField.DefaultValue&vbCr

'addvaluetostring

strType=strType&objField.Name&"-"&_

NextobjField

MsgBox"Thenamesofthefieldsinthislistandtheirdefault"&_

"valuesare:"&vbCr&strType

EndSub

DefaultViewPagePropertyReturnsorsetsaStringthatdefinestherelativeURLtothepagethatisviewedwhenthelistisopened.ThispropertycorrespondstothedefaultviewpagefieldontheSupportingFilestabofthePropertiesdialogbox.

expression.DefaultViewPage

Remarks

ThedefaultstartpageisAllItems.htm.

Example

ThefollowingexampleliststhenamesofalllistsinthedocumentandtheircorrespondingdefaultviewpageURLs.Thesubroutinecreatesasinglestringcontainingalllistnamesanddefaultviewpagesanddisplaystheformattedmessagetotheuser.

SubViewDefaultPage()

'Letstheuserviewthedefaultview

'pageforalllistsintheweb.

DimlstWebListAsList

DimstrURLAsString

'Cyclethroughlists

'adddefaultviewpagesnamestostring

IfstrURL=""Then

strURL=lstWebList.Name&"-"&_

lstWebList.DefaultViewPage&vbCr

strURL=strURL&lstWebList.Name&"-"&_

lstWebList.DefaultViewPage&vbCr

'Displaydefaultviewpagesofalllists

MsgBox"Thedefaultviewpagesofalllistsinthecurrentwebare:"_

&vbCr&vbCr&strURL

EndSub

DescriptionPropertyReturnsorsetsaStringthatrepresentsthedescriptionforthecurrentlist.Thedescriptionappearsbelowthetitleofthelistonthedefaultviewpage.Read/write.

expression.Description

Example

Thefollowingexamplepromptstheusertoenteradescriptionforthefirstlistinthecollection,andthenchangestheDescriptionpropertybasedontheuser'sinput.

SubSetDescription()

'Setthelistdescription

DimobjWebAsWebEx

DimlstWebListAsList

DimStrDescAsString

'Referencefirstlistincollection

SetlstWebList=objWeb.Lists.Item(0)

'Getnewdescriptionfromuser

StrDesc=InputBox("Enteranewdescriptionforthelist"&_

lstWebList.Name&".")

'Setdescriptionproperty

lstWebList.Description=StrDesc

EndSub

ShowAll

DesignSecurityPropertyReturnsorsetsanFpListDesignSecurityconstantthatdefinesthesecuritypermissionsoftheList.

FpListDesignSecuritycanbeoneoftheseFpListDesignSecurityconstants.fpListDesignSecurityCreatorOnlythecreatorofthelisthaspermissiontomodifyit.fpListDesignSecurityEveryoneAllusershavepermissiontomodifythelist.

expression.DesignSecurity

Example

ThefollowingexamplechangesthesecuritymodeofeachBasicListobjectinthecurrentweb.ThesubroutinechangestheDesignSecuritypropertytofpListDesignSecurityEveryoneifitisn'talreadyset.Oncethepropertyisset,alluserscaneditthedesignsettingsofBasicListobjectsinthecurrentweb.

NoteUsetheApplyChangesmethodtosaveanychangesmadetothelist.

SubSetSecurityType()

'ChangessecuritytypeofallBasicLists.

DimobjListAsList

DimobjListsAsLists

'Cyclethrougheachlistandcheckforlisttype

'Ifit'saBasicListthanchangepermissions

IfobjList.Type=fpListTypeBasicListThen

IfobjList.DesignSecurity<>_

fpListDesignSecurityEveryoneThen

objList.DesignSecurity=_

fpListDesignSecurityEveryone

objList.ApplyChanges

EndSub

DisplayFormPropertyReturnsorsetsaStringthatrepresentstherelativeURLoftheformthatcontainstheuserinterfaceassociatedwiththelist.Read/write.

expression.DisplayForm

Example

ThefollowingexampledisplaysthenamesofalllistsintheactiveWebsiteandtherelativeURLsoftheirassociatedWebforms.

SubViewFormURL()

'DisplaystheURLoftheform

'associatedwiththelist

DimlstWebListAsList

DimstrURLAsString

'CyclethroughlistsandaddURLstostring

IfstrURL=""Then

lstWebList.DisplayForm&vbCr

'DisplayURLsofallformsinWebsite

MsgBox"TherelativeURLsoftheformsare:"_

&vbCr&vbCr&strURL

EndSub

ShowAll

DisplayFormatPropertyDisplayFormatpropertyasitappliestotheListFieldChoiceobject.

ReturnsorsetsanFpChoiceFieldFormatenumeratedconstantthatrepresentsthetypeofuserinterfacecontrolusedbythefield.Read/write.

FpChoiceFieldFormatcanbeoneoftheseFpChoiceFieldFormatconstants.fpChoiceFieldDropdownfpChoiceFieldRadioButtons

expression.DisplayFormat

DisplayFormatpropertyasitappliestotheListFieldDateTimeobject.

ReturnsorsetsanFpDateTimeFieldFormatenumeratedconstantthatrepresentsthewayinwhichthedateandtimevaluesaredisplayed.Read/write.

FpDateTimeFieldFormatcanbeoneoftheseFpDateTimeFieldFormatconstants.fpDateTimeFieldDateAndTimefpDateTimeFieldDateOnlyfpDateTimeFieldTimeOnly

expressionRequired.AnexpressionthatreturnsaListFieldDateTimeobject.

DisplayFormatpropertyasitappliestotheListFieldNumberobject.

ReturnsorsetsanFpNumberFieldFormatenumeratedconstantthatdeterminesthewayinwhichnumbersaredisplayedintheList.Read/write.

FpNumberFieldFormatcanbeoneoftheseFpNumberFieldFormatconstants.fpNumberFieldAutoThenumberwillbeautomaticallyformatted.fpNumberFieldFiveDecimalsThenumberwillbedisplayedwithfivedecimalplaces.fpNumberFieldFourDecimalsThenumberwillbedisplayedwithfourdecimalplaces.fpNumberFieldIntegerThenumberwillbedisplayedasanintegerwithnodecimalplaces.fpNumberFieldOneDecimalThenumberwillbedisplayedwithonedecimalplace.fpNumberFieldThreeDecimalsThenumberwillbedisplayedwiththreedecimalplaces.fpNumberFieldTwoDecimalsThenumberwillbedisplayedwithtwodecimalplaces.

expressionRequired.AnexpressionthatreturnsaListFieldNumberobject.

DisplayFormatpropertyasitappliestotheListFieldURLobject.

ReturnsorsetsanFpURLFieldFormatenumeratedconstantthatrepresentstheimage-linkinginformation.Read/write.

FpURLFieldFormatcanbeoneoftheseFpURLFieldFormatconstants.fpURLFieldImagefpURLFieldLink

expressionRequired.AnexpressionthatreturnsaListFieldURLobject.

Example

AsitappliestotheListFieldChoiceobject.

ThefollowingexamplechangesthedisplaytypeofafieldnamedNewChoiceFieldinthefirstlistoftheactiveWebsite.Thechoiceswillnowbedisplayedinadrop-downlist.

SubChangeViewFormat()

'Changethedisplaytypeofthefield

DimobjListFieldsAsListFields

DimobjListFieldAsListFieldChoice

SetobjListFields=objApp.ActiveWeb.Lists.Item(0).Fields

SetobjListField=objListFields.Item("NewChoiceField")

'ChangedisplayformattoDropDownlist

objListField.DisplayFormat=fpChoiceFieldDropdown

EndSub

DocumentProperty(WebObjectModel)ReturnsanFPHTMLDocumentobject,providingaccesstothePageobjectmodelinMicrosoftFrontPagethatiscompatiblewithMicrosoftInternetExplorer4.0andlater.FormoreinformationonthePageobjectmodel,seeExploringtheObjectModelinFrontPage.

expression.Document

Example

ThefollowingexampleopensapageandusestheinsertAdjacentTextmethodtoaddtexttothedocument.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\RogueCellars"thatcontainsafilenamedSales.htm.YoumaysubstituteanalternativeWebsiteURLorfilename.

PrivateSubAddTextToDoc()

DimmyWebAsWebEx

DimmyTextAsString

SetmyWeb=_

Webs.Open("C:\MyDocuments\MyWebSites\RogueCellars")

myWeb.Activate

myText="WinterSaleBeginsNovember1st!"

SetmyPageWindow=_

ActiveWeb.RootFolder.Files("Sales.htm").Edit

myPageWindow.Document.body.insertAdjacentText_

"BeforeEnd",myText

ActiveWeb.Close

EndSub

DownloadTimePropertyReturnsaLongthatrepresentsthesimulatedamountoftime(inseconds)agivenfilewilltaketodownload.Read-only.

expression.DownloadTime

Remarks

ThispropertyisusedinconjunctionwiththeConnectionSpeedpropertytodeterminewhichfileswillappearintheSlowPagesreport.

Example

ThefollowingexampledisplaysthenamesofallfilesinthecurrentWebsitewithadownloadtimegreaterthanaspecifiedvalue.Thesubroutinepromptstheusertoenteradownloadtimeinseconds.ItthensearchesthrougheachfileintheAllcollectionanddisplaysthenamesofanyfilewithadownloadtimegreaterthanthespecifiednumberofseconds.TheNamepropertyvalueisaddedtoaStringcontainingthenamesofallmatchingfilesinthecollection.TheString,storedinthevariablestrName,isthendisplayedtotheuser.IfnomatchingfilesarefoundintheWebsite,amessageisdisplayedtotheuser.

SubDownloadTime()

'Displaysthenamesofallfileswithadownloadtimegreaterthan

'agivenvalue

DimobjwebFileAsWebFile

DimobjWebFielsAsWebFiles

DimstrSecAsString'Userinputvalue

DimstrNamesAsString'Nameofallmatchingfiles

DimblnFoundAsBoolean'Booleanflag

SetobjWebFiles=objApp.ActiveWeb.AllFiles

blnFound=False

'Promptusertoenterinput

strSec=InputBox("Enterthenumberofsecondsdownloadtime.")

'Searchthrougheachfileinthecollection

ForEachobjwebFileInobjWebFiles

'Ifuserinputislessthandownloadtime

IfstrSec<objwebFile.DownloadTimeThen

blnFound=True

IfstrName=""Then

strName=strName&objwebFile.Name

'Otherwiseaddnextfilenametostring

strName=strName&","&vbCr&objwebFile.Name

NextobjwebFile

IfblnFound=TrueThen

'Displaynamesofallfilesthatmatchthecriteria

MsgBox"Thefilesthattakelongerthan"&_

strSec&"secondstodownloadare:"&vbCr&vbCr&_

strName&"."

'Nofiles,displaymessage

MsgBox"Therearenofilesthatmatchyourcriteria."

EndSub

DynamicTemplatePropertyReturnsaStringthatrepresentsreturnsthepathandfilenameofaDynamicWebTemplate.AnemptyStringindicatesthatnoDynamicWebTemplateisattached.

expression.DynamicTemplate

Remarks

Ifanerroroccurs,theupdateprocesswillterminateunlesstheSkipOnQuerypropertyissettoTrue.

Example

ThefollowingexampleupdatestheDynamicWebTemplateforeachfileintheactiveWebsiteifaDynamicWebTemplateisattached.

DimobjFileAsWebFile

DimstrLogAsString

ForEachobjFileInActiveWeb.AllFiles

IfobjFile.DynamicTemplate<>""Then_

objFile.UpdateDynamicTemplateobjState,strLog

EditFormPropertyReturnsorsetsaStringthatrepresentstherelativeURLoftheformusedforeditingthecurrentlistinMicrosoftFrontPage.Theeditformallowsyoutomodifythecolumnsinthecurrentlist.Read/write.

expression.EditForm

Remarks

ThedefaultfilenameisEditForm.htm.

Example

ThefollowingexampledisplaysthenamesofalllistsintheactiveWebsiteandtherelativeURLoftheirassociatededitforms.

SubViewEditFormURL()

'DisplaystheURLoftheform

'associatedwitheditingthelist

DimlstWebListAsList

DimstrURLAsString

IfstrURL=""Then

lstWebList.EditForm&vbCr

'DisplayURLsofalleditingformsinWebsite

MsgBox"TherelativeURLsoftheeditingformsare:"_

&vbCr&vbCr&strURL

EndSub

ShowAll

EditSecurityPropertyReturnsorsetsanFpListEditSecurityconstantthatdetermineswhichuserscaneditthecurrentlist.

FpListEditSecuritycanbeoneoftheseFpListEditSecurityconstants.fpListEditSecurityAllAlluserscaneditthelist.fpListEditSecurityNoneNouserscaneditthelist.fpListEditSecurityOnlyOwnUserscanonlyedittheirownlists.

expression.EditSecurity

Example

ThefollowingexamplechangestheeditpermissionsofalllistsoftypefpListTypeBasicListtofpListEditSecurityOnlyOwn.Oncethepropertyisset,userscaneditonlyliststhattheyhavecreated.

SubChangeEditPermissions()

'ChangesthepermissionsofallBasicListsintheweb

DimobjListAsObject

DimobjListsAsLists

'Ifit'saBasicListthenchangepermissions

IfobjList.EditSecurity<>fpListEditSecurityOnlyOwnThen

objList.EditSecurity=fpListEditSecurityOnlyOwn

EndSub

EndNumberPropertySetsorreturnsaLongthatrepresentstheendingnumberforthenumberscaleinaratingscalefield.

expression.EndNumber

expressionRequired.AnexpressionthatreturnsaListFieldRatingScaleobject.

ExtensionPropertyReturnsaStringthatrepresentstheextensionforthespecifiedfile.Read-only.

expression.Extension

Example

ThisstatementreturnstheextensionofthefirstpageintherootfolderoftheactiveWebsite.

myHomePageExt=ActiveWeb.RootFolder.File(0).Extension

FieldsPropertyReturnsaListFieldscollectionthatrepresentsallfieldsinthecurrentlist.TheListFieldscollectioncontainsListFieldobjectsthatcorrespondtothecolumnpropertiesofalistmemberdocument.

expression.Fields

Example

ThefollowingexampledisplaysthenamesofallfieldsinthefirstlistoftheListscollection.

SubDisplayFields()

'Returnsthefieldscollection

DimlstWebListAsList

DimlstFieldsAsListFields

DimlstFieldAsListField

DimStrNameAsString

SetlstWebList=objApp.ActiveWeb.Lists.Item(0)

SetlstFields=lstWebList.Fields

ForEachlstFieldInlstFields

'addURLstostring

IfStrName=""Then

'Ifemptystring

StrName=lstField.Name&vbCr

'addnamestostring

StrName=StrName&lstField.Name&vbCr

'Displayformattedstring

MsgBox"Thelist"&lstWebList.Name&_

"containsthefollowingfields"&vbCr&vbCr&_

StrName

EndSub

FilePropertyReturnsaWebFileobjectthatrepresentstheWebpageassociatedwiththespecifiedobject.

expression.File

Example

ThisexamplereturnsthenameoftheWebpageassociatedwithanavigationnodeintheactiveWebsite.

PrivateSubGetFileFromNavNode()

DimmyNavNodeAsNavigationNode

DimmyNavNodesAsNavigationNodes

DimmyNavFilesAsString

DimmyNavFileAsString

OnErrorResumeNext

SetmyNavNodes=ActiveWeb.HomeNavigationNode.Children

ForEachmyNavNodeInmyNavNodes

myNavFile=myNavNode.File.Name

IfERR<>0ThenExitSub

myNavFiles=myNavFiles&myNavFile&vbCrLf

EndSub

ShowAll

FileDialogPropertyReturnsaFileDialogobjectthatrepresentsasingleinstanceofafiledialogbox.

expression.FileDialog(DialogType)

DialogTypeRequiredMsoFileDialogType.Thetypeofdialogboxtoopen.

MsoFileDialogTypecanbeoneoftheseMsoFileDialogTypeconstants.msoFileDialogFilePickermsoFileDialogFolderPickermsoFileDialogOpenmsoFileDialogSaveAs

Example

ThefollowingexampledisplaystheSaveAsdialogbox.

SubShowSaveAsDialog()

'DisplaytheSaveAsdialogbox

DimdlgSaveAsAsFileDialog

'Setthedialogtype

SetdlgSaveAs=Application.FileDialog(msoFileDialogSaveAs)

'Displaythedialog

dlgSaveAs.Show

EndSub

ThefollowingexampledisplaystheOpendialogbox,andallowstheusertoopenmultiplefilesatthesametime.

SubShowOpenDialog()

'DisplaytheOpendialogbox

DimdlgOpenAsFileDialog

'SetthedialogboxtypetoOpen

SetdlgOpen=Application.FileDialog(msoFileDialogOpen)

'Displaythedialogbox

WithdlgOpen

.AllowMultiSelect=True

EndWith

EndSub

ThefollowingexampledisplaystheOpendialogbox,andallowstheusertoopenmultiplefilesatthesametime.IfthedocumentsareHTMLfiles,theyareopenedinMicrosoftFrontPage.

SubShowOpenDialog()

'DisplaytheOpendialogbox

DimdlgOpenAsFileDialog

'SetthedialogboxtypetoOpen

DimiasInteger

SetdlgOpen=Application.FileDialog(msoFileDialogOpen)

'Displaythedialogbox

WithdlgOpen

.AllowMultiSelect=True

EndWith

Fori=1TodlgOpen.SelectedItems.Count

IfRight(dlgOpen.SelectedItems(i),3)="htm"Then

ActiveWebWindow.PageWindows.AdddlgOpen.SelectedItems(i)

EndSub

FileDialogViewPagePropertyReturnsorsetsaStringthatrepresentstherelativeURLofthepageassociatedwiththeDocumentLibraryobject.Read/write.

expression.FileDialogViewPage

expressionRequired.AnexpressionthatreturnsaDocumentLibraryobject.

Example

ThefollowingexamplecreatesanewdocumentlibrarycalledNewLibraryanddisplaystherelativeURLoftheFiledialogpage.

SubNewLibrary()

'Addanewlisttothecurrentweb

DimobjListsAsLists

DimobjLibraryAsDocumentLibrary

'Addnewlist

SetobjLibrary=objLists.Item("NewLibrary")

MsgBox"AnewlistwasaddedtotheListscollection."&_

"Thepageassociatedwiththefiledialogis"&_

objLibrary.FileDialogViewPage&"."

EndSub

FilesPropertySomeofthecontentinthistopicmaynotbeapplicabletosomelanguages.

ReturnsaWebFilescollectionthatrepresentstheitemsinthespecifiedWebfolder.Read-onlyobject.

expression.Files

expressionRequired.AnexpressionthatreturnsaWebFolderobject.

Remarks

TheFilespropertyisanaccessorpropertyusedtoaccesstheWebFilescollection.Toaccessthecollection,declareavariableoftypeWebFilesasshowninthestatementDimmyFilesAsWebFiles,andthensetthevariablemyFilestoWeb.RootFolder.Files.

Example

ThefollowingexampleretrievesallofthepropertiesofafileandconcatenatestheMETAtagsintoastringwithapipe("|")delimiterseparatingthedata.

NoteThePropertyKeysshowninthisexampleapplytoaWebsitecreatedwiththeOnePageWebSitetemplate.OthertemplatesmayuseotherPropertyKeys.FormoreinformationaboutusingPropertyKeys,seethePropertiescollection.

PrivateSubGetFileProperties()

DimmyFileAsWebFile

DimmyAuthorAsString

DimmyModifiedByAsString

DimmyTimeCreatedAsString

DimmyTimeLastModifiedAsString

DimmyFileSizeAsString

DimmyTitleAsString

DimmyMetaTagsAsVariant

DimmyProgIDAsVariant

DimmyGeneratorAsString

DimmyTimeLastWrittenAsString

DimmyMetaTagListAsString

SetmyProperties=myFile.Properties

myAuthor=myAuthor&myProperties("vti_author")

myModifiedBy=myModifiedBy&_

myProperties("vti_modifiedby)&"|"

myTimeCreated=myTimeCreated&_

myProperties("vti_timecreated")&"|"

myTimeLastModified=myTimeLastModified&_

myProperties("vti_timelastmodified")&"|"

myFileSize=myFileSize&_

myProperties("vti_FileSize)&"|"

myTitle=myTitle&myProperties("vti_title")&"|"

myProgID=myProgID&myProperties("vti_title")&"|"

myGenerator=myGenerator&_

myProperties("vti_generator")&"|"

myTimeLastWritten=myTimeLastWritten&_

myProperties("vti_timelastwritten")&"|"

myMetaTags=myProperties("vti_metatags")

myMetaTagList=myMetaTagList&myMetaTag&"|"

EndSub

FileSaveFormPropertyReturnsorsetsaStringthatrepresentstherelativeURLoftheformpagethatisdisplayedwhenfilesaresaved.Read/write.

expression.FileSaveForm

Example

Thefollowingexamplecreatesanewdocumentlibrarycalled"NewLibrary"anddisplaystherelativeURLofthepageassociatedwithsavingafiletothelibrary.

SubNewLibrary()

'Addsanewlisttothecurrentweb

DimobjListsAsLists

'Addnewlist

MsgBox"AnewlistwasaddedtotheListscollection."&_

"TheURLofthepageassociatedwiththeSavedialogis"&_

objLibrary.FileSaveForm&"."

EndSub

FileSearchPropertyReturnsaFileSearchobjectthatprovidesaccesstofilesearchcapabilitieswithinaWebsite.

expression.FileSearch

Remarks

TheFileSearchobjectisaMicrosoftOfficesharedobjectanddoesnotacceptaURLasafilenameorfoldernamevalue.

Example

ThefollowingexamplesearchestheAdventureWorksWebsiteanditssubdirectoriesandreturnsthenumberofIndex.htmfilesfound.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\AdventureWorks".Asanalternative,youcanchangethevaluefortheLookInpropertytoaWebsitethatiscurrentlyavailabletoyou.YoumayalsoneedtosetareferencetotheMicrosoftOfficeObjectLibrary(ReferencesoptionontheToolsmenu).

PrivateSubWebFileSearch()

DimmyFileSearchAsFileSearch

DimmyFileCountAsInteger

SetmyFileSearch=Application.FileSearch

WithmyFileSearch

.FileName="index.htm"

.LookIn="C:\MyWebSites\AdventureWorks"

.SearchSubFolders=True

.Execute

myFileCount=.FoundFiles.Count

EndWith

EndSub

FolderPropertyReturnsaWebFolderobjectthatrepresentsthefolderassociatedwiththelist.TheWebfolderhierarchyprovidesthelinktofoldersandfilesonaWebserverdirectory.ThenavigationstructureprovidestheunderlyingstructurefortheWebobjectswithinindividualMicrosoftFrontPageWebsites.

expression.Folder

Example

ThefollowingexampledisplaysthenameoftheWebfolderassociatedwiththecurrentlist.IfthecurrentWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubReturnFolder()

'Returnsthefolderassociatedwiththelist

IfNotobjApp.ActiveWeb.ListsIsNothingThen

SetobjFolder=objApp.ActiveWeb.Lists(0).Folder

MsgBox"ThenameoftheassociatedWebfolderis:"&_

objFolder.Name&"."

MsgBox"TheActiveWebsitecontainsnolists."

EndSub

FoldersPropertySomeofthecontentinthistopicmaynotbeapplicabletosomelanguages.

ReturnsaWebFolderscollectionthatrepresentsthechildfolderscontainedthespecifiedfolder.Read-only.

expression.Folders

Remarks

TheFolderspropertyreturnstheWebFolderscollectionforthespecifiedWebsite.Toaccessthecollection,youdeclareavariableoftypeWebFoldersasinthestatementDimmyFoldersAsWebFolders,andthensetthevariabletoWeb.RootFolder.Folders.

Example

Thefollowingexampleretrievestwoofthepropertiesofafolderandconcatenatesthedataintoastringwithapipe("|")delimiterseparatingthedata.

NoteThePropertyKeysshowninthisexampleapplytoaWebsitecreatedwiththeOnePageWebSitetemplate.OthertemplatesmayuseotherPropertyKeys.FormoreinformationaboutusingPropertyKeys,seethePropertiescollection.

PrivateSubGetFolderProperties()

DimmyHasSubDirsAsString

DimmyIsScriptableAsString

SetmyFolders=ActiveWeb.RootFolder.Folders

SetmyProperties=myFolder.Properties

myHasSubDirs=myHasSubDirs&_

myProperties("vti_hassubdirs")&"|"

myIsScriptable=myIsScriptable&_

myProperties("vti_isscriptable")&"|"

EndSub

FormatPropertyReturnsaStringthatrepresentstheformatofthespecifiedThemeobject.Read-only.

expression.Format

expressionRequired.AnexpressionthatreturnsaThemeobject.

Remarks

ThethemeformatreflectsthedifferencebetweentheformatsforthedifferentversionsofMicrosoftFrontPage.Forexample,theformatnumberforFrontPage98canbeeither0.0or1.0,whiletheformatnumberforFrontPage2000is2.0,andsoon.

Example

ThefollowingexampleretrievestheformatoftheappliedthemefortheactiveWebsite.

PrivateSubGetThemeFormat()

DimmyFormatAsString

myFormat=ActiveWeb.Themes(0).Format

EndSub

FrameWindowPropertyReturnsanFPHTMLWindow2objectthatrepresentsthepagewindowandaccessestheInternetExplorerWindowobjects.

NoteTheDocumentpropertyoftheFPHTMLWindow2objectpointstotheFPHTMLDocumentobjectoftheframespage.

expression.FrameWindow

Example

ThisexampleretrievestheIHTMLLocationpropertyoftheFrameWindowobject.

PrivateSubGetFrameWindowLocation()

DimmyWebAsWebEx

DimmyFrameWindowLocationAsString

SetmyWeb=Webs("C:\MyWebs\CohoWinery")

SetmyPage=_

myWeb.ActiveWebWindow.ActivePageWindow

myFrameWindowLocation=myPage.FrameWindow.Location.href

EndSub

HomePropertyReturnsaHomeNavigationNodeobjectthatrepresentsthenavigationnodeforaspecifiedpage.

expression.Home

Example

Thefollowingexamplesearchesforanavigationnodewiththelabel"Sale",andthenupdatesit.

PrivateSubChangeNavLabel()

DimmyFileAsWebFile

IfmyFile.NavigationNode.Home.Label="Sale"Then

myFile.NavigationNode.Home.Label="SalesItems"

EndSub

HomeNavigationNodePropertyReturnsaNavigationNodeobjectforthehomepage.

expression.HomeNavigationNode

Remarks

Thehomenavigationnodeisthestartingpointforallnavigationaddressingwithinthenavigationstructure.Wheneveryouwanttoadd,move,ordeleteanode,changeanyoftheattributesforanode,orjustaccessthecurrentnavigationstructure,youusetheHomeNavigationNodeobjectasastartingpoint.TheonlytimeyouwouldusetheRootNavigationNodeobjecttoaccessthenavigationstructureiswhenyouwanttoaddoraccessanavigationnodeatthesamelevelastheHomeNavigationNodeobject.

Example

ThefollowingexampleaccessestheHomeNavigationNodeobjectandretrievestheURLforthehomepage.

PrivateSubGetHomeNavigationNode()

DimmyWebAsWebEx

DimmyHomeNodeAsNavigationNode

DimmyHomeUrlAsString

SetmyWeb=ActiveWeb

myHomeNode=myWeb.HomeNavigationNode

myHomeUrl=myHomeNode.Url

EndSub

HorizontalResolutionPropertyReturnsthehorizontalresolutionofthescreeninpixels.Read-onlyLong.

expression.HorizontalResolution()

expressionRequired.AnexpressionthatreturnsaSystemobject.

Example

Thefollowingexamplereturnsthehorizontalresolutionofthescreen.

myHoriz=System.HorizontalResolution

InNavBarsPropertyTruetospecifythatthecurrentpagewillbevisibleintheWebsite'slinkbars.Read/writeBoolean.

NoteAlinkbarisasetofhyperlinksusedfornavigatingaWebsite.

expression.InNavBars

Remarks

AllpageswiththeInNavBarspropertysettoFalsewillappeargrayedoutinNavigationview.

Example

Thefollowingexamplepromptstheusertoselectwhichnavigationnodeswillappearinthelinkbar.IftheuserselectsYes,thecurrentpagewillappearinthelinkbar.IftheuserselectsNo,thecurrentpagewillnotappearinthelinkbarandwillappeargrayedoutinNavigationview.TheuserispromptedforeachnavigationnodeintheactiveWebsite.

SubAllNavigationNodes()

'Returnacollectionofallnavigationnodesusedinthecurrentweb

'Allowsyoutoselectwhichpageswillappearinthelinkbar

DimstrAnsAsString

'CreateareferencetotheNavigationNodescollection

'Foreachnodeinthecollection

ForEachobjNavNodeInobjNavNodes

'Prompttheuser

strAns=MsgBox("Doyouwantthepage"&objNavNode.Label&_

"toappearinthelinkbar?",vbYesNo)

'Ifuseranswersyes,settoTrue

IfstrAns=vbYesThen

objNavNode.InNavBars=True

'Ifno,settoFalse

objNavNode.InNavBars=False

'Gotonextnode

NextobjNavNode

EndSub

IsDirtyPropertyTrueifthepagedisplayedinthespecifiedpagewindowhaschangedsincethelasttimetheusersavedthepage.Read-writeBoolean.

expression.IsDirty

Example

Thefollowingexamplechecksiftheactivepagehaschanged,andthenexecutestheSavemethodifthepagehasbeenmodified.

PrivateSubDirtyDocument()

DimmySaveCheckAsBoolean

SetmyDoc=WebWindows(0).PageWindows(0).Document

CallmyDoc.body.insertAdjacentHTML("BeforeEnd",_

"<b>modified</b>")

IfActivePageWindow.IsDirty=TrueThen

EndSub

IsExecutablePropertyReturnsorsetsaBooleanthatrepresentsthesettingforexecutepermissionforaWebFolderobject.

expression.IsExecutable

Example

ThisexampleretrievesthesettingoftheIsExecutablepropertyforaWebFolderobject.

PrivateSubCheckExecutable()

DimmyExeStatusAsBoolean

SetmyFolder=ActiveWeb.RootFolder.Folders("images")

myExeStatus=myFolder.IsExecutable

EndSub

IsHiddenPropertySetsorreturnsaBooleanthatrepresentswhetheralistisdisplayedinthebrowser.

expression.IsHidden

IsHiddenFoldersEnabledPropertyTruetodisplayhiddenfoldersinthespecifiedWebsite.Read/writeBoolean.

expression.IsHiddenFoldersEnabled

Example

ThefollowingexamplepromptstheusertodisplayhiddenfoldersinthecurrentWebsite.TheIsHiddenFoldersEnabledpropertyissetbasedontheuser'sresponse.

SubViewAllFolders()

'Promptstheusertoviewhiddenfolders

DimobjWebAsWebEx

DimstrAnsAsString

'promptuser

strAns=MsgBox("Doyouwanttoviewhiddenfolders?",vbYesNo)

'Setvalueofpropertytomatchuser'sresponse

IfstrAns=vbYesThen

objWeb.IsHiddenFoldersEnabled=True

objWeb.IsHiddenFoldersEnabled=False

EndSub

IsLinkBarPropertyTrueindicatesthatthenavigationnodeisalinkbar.Read-onlyBoolean.

NoteLinkbarsprovidehypertextlinksthatallowyoutonavigatethroughthepagesinthecurrentWebsite.

expression.IsLinkBar

Example

ThefollowingexampletraversesthenavigationnodehierarchyanddisplaysthenamesofanylinkbarsintheWebsite.Ifnolinkbarsarefoundamessageisdisplayedtotheuser.

SubDisplayLinkBar()

'ReturnacollectionofallnavigationnodesusedinthecurrentWebsite

'Searchesthroughthecollectionanddisplaysthenamesofalllinkbars

DimstrAnsAsString

blnFound=False

'Foreachnodeinthecollection

ForEachobjNavNodeInobjNavNodes

'IfsettoTrue,thisisalinkbar

IfobjNavNode.IsLinkBar=TrueThen

MsgBoxobjNavNode.Label&"isalinkbar."

blnFound=True

'Gotonextnode

NextobjNavNode

'Ifnolinkbarsarefound,displayamessage

IfblnFound=FalseThen

MsgBox"TherearenolinkbarsinthecurrentWebsite."

EndSub

IsModifiedPropertyReturnsaBooleanthatrepresentswhetheralisthasbeenchangedsincethelasttimethelistwasupdated.

expression.IsModified

IsOpenPropertyTrueifthespecifiedWebpageisdisplayedinthepagewindow.Read-onlyBoolean.

expression.IsOpen

Example

ThefollowingexampleusestheIsOpenpropertytocheckifafilenamed"index.htm"isopen,andopensitifitisn't.

PrivateSubCheckForOpenFile()

DimmyWebAsWebEx

DimmyFileAsWebFile

SetmyWeb=ActiveWeb

WithmyWeb

IfmyFile.Name="index.htm"Then

IfmyFile.IsOpen=TrueThen

MsgBox"Thisfileisopen,tryagainlater."

ExitSub

myFile.Open

ExitSub

EndWith

EndSub

IsOrphanPropertyTrueindicatesthatthefilecannotbereachedbyhyperlinkfromanypageintheWebsite.Read-only.

expression.IsOrphan

Example

ThefollowingexamplesearchesthroughthecurrentWebsiteanddisplaysthenamesofallorphanfiles.AnorphanfileisdenotedbyitsIsOrphanproperty.OnceafileisfoundwithanIsOrphanpropertythatequalsTrue,theLabelpropertyvalueisaddedtoaStringcontainingthenamesofallorphannodesintheWebsite.Thenamesoftheorphanfiles,storedintheStringvariablestrName,arethendisplayedtotheuser.IfnoorphanfilesarefoundintheWebsite,amessageisdisplayedtotheuser.

SubListOrphans()

'Displaysthenamesoforphanfiles.

DimobjWebFileAsWebFile

DimstrNameAsString

'ForeachfileintheWebsitesite

ForEachobjWebFileInActiveWeb.AllFiles

'Checkifthefileisanorpahn

IfobjWebFile.IsOrphanThen

strName=strName&objWebFile.Name&"|"

IfstrName<>""Then

'Displaynamesofallorphanpages

MsgBox"TheorphanpagesinthecurrentWebsiteare:"&vbCr&vbCr&_

strName&"."

'Noorphans,displaymessage

MsgBox"TherearenoorphanpagesintheWebsite."

EndSub

IsReadablePropertyTrueindicatesthatafolderishasreadpermission.Read/writeBoolean.

expression.IsReadable

Example

ThefollowingexampleretrievesthesettingoftheIsReadablepropertyforafoldercalled"images"intheactiveWebsite.

PrivateSubCheckReadable()

DimmyReadStatusAsBoolean

myReadStatus=myFolder.IsReadable

EndSub

IsRootPropertyTrueifthespecifiedWebfolderistherootfolderintheWebsite.Read-onlyBoolean.

expression.IsRoot

Example

ThefollowingexampleretrievesthesettingoftheIsRootpropertyforaWebFolderobject.

DimmyIsRootAsBoolean

myIsRoot=myFolder.IsRoot

EndSub

IsUnderRevisionControlPropertyTrueifsourcecontrolisusedonfilesinthespecifiedWebsite.Read-onlyBoolean.

expression.IsUnderRevisionControl

Remarks

YoumusthaveasourcecontrolprojectcreatedthroughMicrosoftVisualSourceSafeorMicrosoftOfficeinordertouserevisioncontrol.Forinformationaboutsourcecontrolprojects,refertoManagingSourceControlProjects.

Example

Thefollowingexamplecreatesasourcecontrolprojectandthen,inthesecondprocedure,checksthestateoftheIsUnderRevisionControlproperty.

PrivateSubSourceControlProject()

DimmyWebAsWebEx

SetmyWeb=ActiveWeb

IfNot(myWeb.IsUnderRevisionControl)Then

myWeb.RevisionControlProject=_

"<FrontPage-basedLocking>"

EndSub

PrivateSubGetRevisionState()

DimmyWebAsWebEx

DimmyRevCtrlProjAsString

DimmyIsRevCtrlAsBoolean

SetmyWeb=ActiveWeb

WithmyWeb

myRevCtrlProj=.RevisionControlProject

myIsUnderRevCtrl=.IsUnderRevisionControl

EndWith

EndSub

IsWebPropertyTrueifthespecifiedWebfolderistherootfolderforaWebsite,whichmaybetherootfolderfortheactiveWebsiteorasubsiteoffoftheactiveWebsite.Read-only.

expression.IsWeb

Example

ThisexampleretrievesthesettingoftheIsWebpropertyforaWebFolderobject.

DimmyWebStatusAsBoolean

myWebStatus=myFolder.IsWeb

EndSub

IsWritablePropertyTrueifafolderhaswritepermissions.Read-onlyBoolean.

expression.IsWritable

Example

ThefollowingexampleretrievesthesettingoftheIsWritablepropertyforaWebFolderobject.

DimmyWritableStatusAsBoolean

myWritableStatus=myFolder.IsWritable

EndSub

ShowAll

ItemPropertyItempropertyasitappliestotheMetaTagsobject.

ReturnsaVariantrepresentingapropertykey/valuepair.

expression.Item(PropertyKey)

PropertyKeyRequiredString.Astringthatcontainsanindexnumberofthecollection.Theindexstartsatzero.

ItempropertyasitappliestothePropertiesobject.

ReturnsorsetsaVariantthatrepresentsaproperty.Read/write.

expression.Item(PropertyKey)

PropertyKeyRequiredString.Astringthatcontainsanindexnumberofthecollection.Theindexstartsatzero.

ItempropertyasitappliestoallotherobjectsintheAppliesTolist.

Returnsaanindividualobjectinacollection.

expression.Item(Index)

IndexRequiredVariant.Thenameorordinalvalueoftheobjectwithinthecollection.Indexstartsatzero.

Example

AsitappliestotheNavigationNodescollection.

Thefollowingexampledemonstratesreturningavaluebyindexinganiteminthecollection.ThisexamplereturnsthelabelforthefirstnavigationnodeinthenavigationstructureoftheactiveWeb.

NoteYouaccesstheNavigationNodescollectionthroughtheChildrenpropertyoftheRootNavigationNodepropertyoftheactiveWeb.

DimmyWebAsWebEx

DimmyNavNodesAsNavigationNodes

SetmyWeb=ActiveWeb

myNavNodeLabel=myWeb.RootNavigationNode_

.Children.Item(0).LabelEndSub

AsitappliestotheMetaTagsobject.

ThefollowingstatementreturnsthecontentsofaMETAtagthatexistsonaWebpageintheactiveWeb,anddemonstratesthePropertyKeyargument.

myMetaTagContents=ActiveWeb.RootFolder.Files_

.Item(0).MetaTags.Item("generator")

Itisn'talwaysnecessarytospecifytheindexorpropertynameoftheItempropertywhenreturningvaluesfromacollection.ThefollowingexamplereturnsalistoffilenamesofeachWebpagethatcontainsaMETAtagnameequivalentto"generator"intheactiveWeb,withoutspecifyingtheItemproperty.FindGeneratorTagsretrievesalistofthefilesthatcontainthe"generator"METAtagandaddsvalueoftheItempropertytothevariablemyMetaTag,becauseinthiscasethevalueoftheItempropertyisthesameasthefilename.Thisisdifferentfromthepreviousexample,whichreturnedthecontentsofthe"generator"METAtag.

FunctionFindGeneratorTags()AsString

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmyReturnFileNameAsString

SetmyWeb=ActiveWeb

WithmyWeb

IfmyMetaTagName="generator"Then

myReturnFileName=myReturnFileName&myFile.Name

EndWith

FindGeneratorTags=myReturnFileName

EndFunction

ShowAll

LabelPropertyAsitappliestotheNavigationNodeobject.

SetsorreturnsaStringthatrepresentsthelabelassociatedwiththeactivenavigationnode.ThislabelisusedasareferenceforindividualnavigationnodesinNavigationview.Read/write.

expression.Label()

Remarks

UsethetextintheLabelpropertyforthetextinabannerorbuttonthatlinkstoanothernavigationnodeinthenavigationstructure.

AsitappliestotheThemeobject.

ReturnsaStringthatrepresentsthenameofthespecifiedtheme.

expression.Label()

expressionRequired.AnexpressionthatreturnsaThemeobject.

Example

AsitappliestotheNavigationNodeobject.

Thefollowingexamplesetsthetextforthelabelofthefirstchildnode.ThelabelshowstheplacementofthenodeinNavigationview.

PrivateSubAddLabelToNavigationNode()

SetmyNode=ActiveWeb.HomeNavigationNode.Children(0)

myNewNode.Label="FinancePage"

EndSub

AsitappliestotheThemeobject.

Thefollowingexampleretrievesthenameofatheme.

NoteTorunthisprocedure,youmusthaveanopenWebsitewithapagethathaspreviouslyhadathemeappliedtoit.

PrivateSubGetThemeName()

DimmyThemeAsString

myTheme=ActiveWeb.Themes(0).Label

EndSub

LanguageDesignationPropertyReturnstheabbreviatednameofthedesignatedlanguageofthesystemsoftware.Read-onlyString.

expression.LanguageDesignation()

Remarks

Usingthetwo-letterlanguageabbreviationfromtheISOStandard639andaddingathirdletter,suchas"u"fortheUnitedStates,createsthethree-letterabbreviation.

Youcanalsogetthetwo-letterlanguageabbreviationwithGetLocaleInfo()byspecifyingLOCALE_SABBREVLANGNAMEastheLCType.Theabbreviatedname"enu"isreturnedfortheEnglish(U.S.)languageandisthesameabbreviationthatisreturnedwiththeLanguageDesignationproperty.

Example

Thisexampledisplaystheabbreviatednameofthedesignatedlanguageofthesystemsoftware.

myLang=System.LanguageDesignation

LanguageSettingsPropertyReturnstheLanguageSettingsobjectfortheMicrosoftFrontPageapplication.Read-onlyLanguageSettings.

expression.LanguageSettings()

Example

ThefollowingexamplereturnstheLanguageIDpropertyfortheuserinterfaceandsetstheLanguagePreferredForEditingproperties.

TheLanguageSettingspropertyhasarequiredconstantcalledMsoAppLanguageID.TheenumeratedvaluesforthisconstantaremsoLanguageIDHelp,msoLanguageIDInstall,msoLanguageIDUI,andmsoLanguageIDUIPrevious.TheLanguagePreferredForEditingpropertyalsohasenumeratedconstantsfortheavailablelanguages.Formoredetailedinformation,seetheLanguageSettingsobject.

PrivateSubGetLanguageInfo()

DimmyLSetAsLanguageSettings

DimmyLangIDAsString

DimprfLangAsString

SetmyLSet=Application.LanguageSettings

WithmyLSet

myLangID=.LanguageID(msoLanguageIDUI)

prfLang=_

.LanguagePreferredForEditing(msoLanguageIDEnglishUS)_

EndWith

EndSub

ListPropertyReturnsaListobjectthatrepresentsthelistassociatedwiththespecifiedfolder.

expression.List

Example

ThefollowingexamplereturnsthelistobjectassociatedwiththesecondfolderintheactiveWebsiteanddisplaysthenamesofallfieldsinthelist.

SubReturnList()

'Returnsthelistassociatedwithafolder

DimobjListFieldAsListField

DimobjListAsList

DimstrNameAsString

ForEachobjFolderInobjApp.ActiveWeb.AllFolders

IfNotobjFolder.ListIsNothingThen

'ReturntheListusingtheListproperty

SetobjList=objFolder.List

ForEachobjListFieldInobjList.Fields

'Addlistnamestostring

IfstrName=""Then

strName=objListField.Name&vbCr

strName=strName&objListField.Name&vbCr

MsgBox"Thefieldnameswithinthe"&objList.Name&"listare:"&vbCr&_

strName

EndSub

ListsPropertyReturnsaListscollectionobjectthatrepresentsacollectionofalllistsinaWebsite.AlistcanbeaDocumentLibraryobject,aBasicListobject,oraSurveyobject.

expression.Lists

Example

ThefollowingexamplereturnsareferencetotheListscollectionusingtheListspropertyfortheactiveWebsite.Theexampledisplaysthenameofeachlistinthecollection.

SubViewLists()

'ReturnsacollectionofalllistsintheWebsite

DimobjWebAsWebEx

DimobjlistsAsLists

DimobjlistAsList

'ReferencetheListscollection

Setobjlists=objWeb.Lists

'DisplaythenameofeachlistintheListscollection

Fori=1Toobjlists.Count

MsgBox"Thenameofthelistis"&objlists.Item(i).Name

EndSub

LookupFieldPropertyReturnsaListFieldobjectthatdefinesthefieldonwhichtoperformasearch.

expression.LookupField

expressionRequired.AnexpressionthatreturnsaListFieldLookupobject.

Example

ThefollowingexamplecreatesanewfieldoftypefpFieldLookupanddisplaysthenameofthenewfieldandthenameofthefieldthatisbeingsearched.

SubCreateLookup()

'AddsnewLookupfield

DimobjFldLookupAsListFieldLookup

DimObjFieldAsListField

DimstrNameAsString

strName="NewFileLookupField"

'AddnewFieldoftypefpFieldLookuptolist

objLstFlds.AddName:=strName,Description:="NewLookupField",_

Fieldtype:=fpFieldLookup

SetobjFldLookup=objLstFlds.Item("NewFileLookupField")

objApp.ActiveWeb.Lists.Item(0).Name&".Thefieldusedforthe"&_

"lookupis"&objFldLookup.LookupField.Name&"."

EndSub

MaximumValuePropertyReturnsorsetsaVariantthatspecifiesthemaximumvalueallowedforthisfield.ThispropertyistheequivalentofsettingtheMaximumvalueallowedfieldintheModifyFielddialogboxoftheuserinterface.Read/write.

expression.MaximumValue

Remarks

Anerrormessagewillbedisplayedtotheuserifinvaliddataisenteredintothisfield.UsetheMinimumValuepropertyvaluetosettheminimumvalueforthefield.

Example

ThefollowingexampledisplaysthenamesandmaximumvaluesofallfieldsoftypefpFieldNumberandfpFieldCurrencyinthefirstlistoftheactiveWebsite.Ifthelistcontainsnofieldsofthistype,amessageisdisplayedtotheuser.

SubDisplayMaximum()

'DisplaysthemaximumvalueofallListFieldNumber

'andListFieldCurrencyfieldsinthelist

DimstrNameAsString

DimobjLstFldAsObject

DimstrValuesAsString

'Cyclethroughlistsandaddvaluetostring

ForEachobjLstFldInobjLstFlds

If(objLstFld.Type=fpFieldNumber)Or(objLstFld.Type=fpFieldCurrency)Then

strValues=strValues&objLstFld.Name&vbTab&_

objLstFld.MaximumValue&vbCr

NextobjLstFld

IfstrValues<>""Then

MsgBox"Thefieldsandtheirmaximumvaluesare:"&vbCr&_

vbCr&strValues

MsgBox"TherearenoListFieldNumberorListFieldCurrencyfieldsinthecurrentlist."

EndSub

ThefollowingexamplechangesthemaximumvalueofallfieldsoftypeListFieldNumberinthefirstlistoftheactiveWebsitetoaconstantwiththevalue200.

NoteUsetheApplyChangesmethodtoapplyanychangesmadetothelist.

SubChangeMaximum()

'Changesmaximumvalueforallfieldsoftype

'ListFieldNumber

DimstrNameAsString

ConstvarMaxAsVariant=200

IfobjApp.ActiveWeb.Lists.Count>0Then

'Cyclethroughlistsandchangevalues

IfobjLstFld.Type=fpFieldNumberThen

objLstFld.MaximumValue=varMax

NextobjLstFld

objApp.ActiveWeb.Lists(0).ApplyChanges

MsgBox"TheactiveWebsitecontainsnolists."

EndSub

MaxLengthProperty(WebObjectModel)ReturnsorsetsaLongthatrepresentsthemaximumlength(incharacters)ofthespecifiedfield.Read/write.

expression.MaxLength

expressionRequired.AnexpressionthatreturnsaListFieldSingleLineobject.

Example

ThefollowingexampleaddsanewfieldoftypefpFieldSingleLinetotheListFieldscollectionofthefirstlistintheactiveWebsiteanddisplaysthenameofthenewfield,thenameofthelisttowhichitwasadded,andthemaximumlengthincharactersofthenewfield.

SubCreateSingleLineField()

'AddnewSingleLineField

DimobjListFieldAsListFieldSingleLine

DimstrNameAsString

strName="AlternativeName"

'AddnewfieldoftypefpFieldSingleLinetolist

Fieldtype:=fpFieldSingleLine

SetobjListField=objLstFlds.Item("AlternativeName")

MsgBox"Anewfieldnamed"&strName&_

"wasaddedtothelist"&_

objApp.ActiveWeb.Lists.Item(0).Name&

_".Themaximumlengthofthe"&_

"fieldis"&objListField.MaxLength&"characters."

EndSub

MetaTagsPropertyReturnstheMetaTagscollectionforthespecifiedWebFileobject.

expression.MetaTags

Example

ThefollowingexampleiteratesthroughtheMETAtagscollectionineachfileintheactiveWebsiteandconcatenatesthefilenamesandMETAtagnamesintoastringcalledmyReturnInfo.

PrivateSubGetMetaTagInfo_Click()

DimmyWebAsWebEx

DimmyFileAsWebFile

DimmyReturnInfoAsString

SetmyWeb=ActiveWeb

WithmyWeb

myReturnInfo=myFileName&":"_

&myMetaTagName

EndWith

EndSub

MinimumValuePropertyReturnsorsetsaVariantthatspecifiestheminimumallowedvalueforthefield.ThispropertyistheequivalentofsettingtheMinimumvalueallowedfieldintheModifyFielddialogboxoftheuserinterface.Read/write.

expression.MinimumValue

Remarks

Anerrormessagewillbedisplayedtotheuserifinvalidinformationisenteredintothisfield.UsetheMaximumValuepropertytosetthemaximumallowedvalueofthefield.

Example

ThefollowingexampledisplaysthenamesandminimumvaluesforallfieldsoftypefpFieldNumberandfpFieldCurrencyinthefirstlistoftheactiveWebsite.

SubDisplayMinimum()

'DisplaystheminimumvalueofallListFieldNumber

'andListFieldCurrencyfieldsinthelist

DimstrNameAsString

DimstrValuesAsString

'Cyclethroughlistsandaddvaluetostring

If(objLstFld.Type=fpFieldNumber)Or(objLstFld.Type=fpFieldCurrency)Then

strValues=strValues&objLstFld.Name&vbTab&_

objLstFld.MinimumValue&vbCr

NextobjLstFld

IfstrValues<>""Then

MsgBox"Thefieldsandtheirminimumvaluesare:"&vbCr&_

vbCr&strValues

MsgBox"TherearenoListFieldNumberorListFieldCurrencyfieldsinthecurrentlist."

EndSub

ThefollowingexamplechangestheminimumvalueofallfieldsoftypefpListFieldNumberinthefirstlistintheactiveWebsitetoaconstantwiththevalue200.

SubChangeMinimum()

'Changesminimumvalueforallfieldsoftype

'ListFieldNumber

DimstrNameAsString

ConstvarMinAsVariant=1

IfobjApp.ActiveWeb.Lists.Count>0Then

'Cyclethroughlistsandchangevalues

objLstFld.MinimumValue=varMin

NextobjLstFld

objApp.ActiveWeb.Lists(0).ApplyChanges

EndSub

MonthsShownPropertyReturnsorsetsaLongthatdetermineshowmanymonthswillbedisplayedintheMicrosoftFrontPageReportsview.Read/write.

expression.MonthsShown

Example

Thefollowingexamplepromptstheusertoenterthenumberofmonthsheorshewantstoviewinthereport,andthensetstheMonthsShownpropertytothatvalue.Thesubroutine"SetMonths"promptstheuserforinput,performsavalidationontheinputdata,convertsittothecorrecttypeandsetstheMonthsShownpropertytothenewvalue.Ifthevalueisofanincorrecttype,anerrormessageisdisplayedtotheuser.

SubSetMonthsShown()

'ModifiestheMonthsShownproperty

CallSetMonths(objApp)

EndSub

SubSetMonths(ByRefobjAppAsApplication)

'SetsthenumberofmonthstoviewinReportsview

DimvarNumAsVariant

DimlngNumAsLong

'Prompttheusertoenteravalue

varNum=InputBox("Enterthenumberofmonthsyouwishtoviewinthereport.")

'Checktoseethatthevalueisofthecorrecttype

IfIsNumeric(varNum)Then

'Ifit'snumeric,convertittoLong

lngNum=CLng(varNum)

'SettheMonthsShownvaluetothenewvalue

objApp.MonthsShown=lngNum

'Displaythenewsettinginformationtotheuser

MsgBox"TheMonthsShownvaluewassetcorrectly."&_

"Thenumberofmonthsthatwillbeshownis"_

&lngNum&"."

'Otherwise,displayanerrormessagetotheuser

MsgBox"Theinputvaluewasincorrect",vbCritical

EndSub

NamePropertyReturnsaStringthatrepresentsthenameassignedtothespecifiedobject.Read-onlyString.

expression.Name

Remarks

ThenameofafileorfolderisusuallythelastpartoftheURL.Forexample,ifyouhaveaURLof"C:\MyWebSites\AdventureWorks\index.htm",thevalueoftheNamepropertyforthefileis"index.htm".Similarly,"Images"isthevalueoftheNamepropertyforthefolderintheURL"C:\MyWebSites\AdventureWorks\Images".

Example

ThefollowingstatementreturnstheapplicationnamewithAppNameasthestringvariable.

AppName=Application.Name

NavigationNodePropertyReturnsaNavigationNodeobjectthatrepresentsthecurrentnodeinthenavigationstructure.

expression.NavigationNode

Remarks

IfaNavigationNodeisnotfoundwithinthenavigationstructureforthespecifiedWebsite,theNavigationNodepropertyreturnsNull.

Example

ThefollowingexampleusestheNavigationNodepropertytoreturnthefilenameassociatedwiththenavigationnode.

PrivateSubGetNavNode()

DimmyWebAsWebEx

SetmyWeb=ActiveWeb

SetmyNavNode=_

myWeb.RootNavigationNode.Files(0).NavigationNode

WithmyNavNode

myNavNodeLabel=.Label

EndWith

EndSub

NewFormPropertyReturnsorsetsaStringthatrepresentstheformusedforaddingnewcontenttothecurrentlistinMicrosoftFrontPage.Read/write.

expression.NewForm

Remarks

ThedefaultfilenamefortheBasicListandSurveyobjectsisNewForm.htm.ThedefaultfilenamefortheDocumentLibraryobjectisUpload.htm.

Example

ThefollowingexampledisplaysthenameofeachlistintheactiveWebsiteandtherelativeURLsoftheirassociatedNewformpages.IftheactiveWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubViewNewFormURL()

'DisplaytheURLoftheform

'associatedwithaddingnewcontent

DimlstWebListAsList

DimstrURLAsString

IfstrURL=""Then

lstWebList.NewForm&vbCr

'DisplayURLsofallNewformsinWebsite

MsgBox"TherelativeURLsoftheNewformsare:"_

&vbCr&vbCr&strURL

EndSub

NewPageorWebPropertyReturnsaNewFileobjectthatrepresentsapageorWebsitelistedontheNewtaskpane.

expression.NewPageorWeb

Example

ThefollowingexamplecreatesanewinstanceoftheNewFileobjectandaddsafilenamed"template.htm"totheNewtaskpane.ThenewfilelistingwillshowupundertheOtherfilessectionlistedatthebottomofthetaskpane.

SubNewPage()

'CreatesanewpageusingtheNewFileobject

DimobjNewFileAsNewFile

'CreateareferencetoaninstanceoftheNewFileobject

SetobjNewFile=objApp.NewPageorWeb

objNewFile.Add"template.htm"

EndSub

NextPropertyReturnsaNavigationNodeobjectthatrepresentsthenextnavigationnodeinthenavigationsequence.Read-onlyObject.

expression.Next

Remarks

AlthoughtheNextpropertyisamemberoftheNavigationNodeclass,thispropertynavigateswithintheChildrencollectionofthespecifiedNavigationNodeobject.

NoteTheChildrencollectiondoesnotwrap,sothatcodesuchasChildren(Children.Count–1).Nextreturnsan"ObjectvariableorWithblockvariablenotset"error.

Example

Thefollowingexamplemovesthenavigationpointertothenextnode,unlessthecurrentnodeisthelastnodeofthelevelinthenavigationstructure.

PrivateSubMoveNext()

DimtheNodeAsNavigationNode

DimtheNextNodeAsNavigationNode

OnErrorResumeNext

SettheNode=ActiveWeb.HomeNavigationNode.Children(1)

SettheNextNode=theNode.Next

IfErr<>0then

MsgBox"Endofthecurrentnavigationrow"

EndSub

NumberOfLinesPropertyReturnsorsetsaLongthatrepresentsthenumberoflinesthatwillappearinthefield.Read/write.

expression.NumberOfLines

expressionRequired.AnexpressionthatreturnsaListFieldMultiLineobject.

Example

ThefollowingexampleaddsanewListFieldMultiLinefieldnamed"Description"totheListFieldscollection.Thesubroutinedisplaysthenameofthenewfieldaswellasthenumberoflinesitwillcontain.

SubCreateMultiLine()

DimObjFieldAsListField

DimobjLstFldMultiAsListFieldMultiLine

DimstrNameAsString

strName="Description"

'AddnewFieldoftypefpFieldMultiLinetolist

objLstFlds.AddName:=strName,Description:="DescriptionField",_

Fieldtype:=fpFieldMultiLine

SetobjLstFldMulti=objLstFlds.Item(strName)

objLstFldMulti.NumberOfLines=5

objApp.ActiveWeb.Lists.Item(0).Name&".Itcontains"&_

objLstFldMulti.NumberOfLines&"lines."

EndSub

OlderFilePropertyReturnsorsetsaLongthatdeterminesthenumberofdaysthatafilemustexistinaWebsite(withoutbeingmodified)beforeitisclassifiedasolder.Onceafileisclassifiedasolder,itappearsintheOlderFilesviewintheReportsview.Read/write.

expression.OlderFile

Remarks

UsetheRecentFilepropertytoreturnorsetthenumberofdaysthataneworrecentlymodifiedfileshowsupintheRecentlyAddedFileslistintheReportsview.

Example

Thefollowingexamplepromptstheusertoenteravaluethatspecifiesthenumberofdaysafilemustexistbeforeitisclassifiedasolder.ThesubroutineSetOldValpromptstheuserforinput,performsavalidationontheinputdata,convertsittothecorrecttype,andsetstheOlderFilepropertytothenewvalue.Ifthevalueisofanincorrecttype,anerrormessageisdisplayedtotheuser.

SubFPOldFile()

'Setsavaluethatdetermineshowoldafileis

CallSetOldVal(objApp)

EndSub

SubSetOldVal(ByRefobjAppAsApplication)

'Setsthevaluethatdetermineshowoldafileis

DimvarNumAsVariant

DimlngNumAsLong

varNum=InputBox("Enterthenumberofdaysafilecanexist"&

_"beforeitisclassifiedasold.")

lngNum=CLng(varNum)

'SettheOlderFIlevaluetothenewvalue

objApp.OlderFile=lngNum

MsgBox"TheOlderFilevaluewassetcorrectly."&vbCr&_

"Thenumberofdaysafterwhichafilebecomesoldis"_&lngNum&"."

MsgBox"Theinputvaluewasincorrect.",vbCritical

EndSub

OperatingSystemPropertyReturnsaStringthatrepresentsthenameofthecurrentoperatingsystem,forexample,“Windows”or“WindowsNT”.

expression.OperatingSystem()

Example

Thefollowingexampledisplayssysteminformationinalabelonaform.

lblSystemInfo.Caption=System.OperatingSystem

ThisexampleprintsthenameofthecurrentoperatingsystemintheImmediatewindow.

myOpSys=System.OperatingSystem

ShowAll

OptimizeHTMLFlagsPropertyReturnsorsetsanFpOptimizeHTMLFlagsconstantthatrepresentshowtheHyperTextMarkupLanguage(HTML)isoptimizedinaWebpage.

FpOptimizeHTMLFlagscanbeoneormoreofthefollowingFpOptimizeHTMLFlagsconstants.

fpHtmlOptAdjacentTags Combinesadjacentelementsofthesametype.

fpHtmlOptAuthorComponents RemovesAuthor-TimeFrontPageWebcomponentcomments.

fpHtmlOptBrowseComponents RemovesBrowse-TimeFrontPageWebcomponentcomments.

fpHtmlOptCellFormattingAttr Removescellformattingsttributes.

fpHtmlOptDwtCmnts RemovesDynamicWebTemplatecomments.

fpHtmlOptEmpty Removesemptytags.

fpHtmlOptGeneratorRemovesMETAelementsthatcontainGeneratorandProgramaticIdentifierinformation.

fpHtmlOptHTMLAllWhitespace Removesallwhitespacesthatdon'taffectrendering.

fpHtmlOptHTMLCmnts RemovesallotherHTMLcomments.

fpHtmlOptHTMLLeadWhitespace Removesleadingwhitespacesfromeachline.fpHtmlOptHTMLMisnest Removesincorrectlynestedtags.fpHtmlOptOn Enablesoptimization.fpHtmlOptScriptCmnts Removesscriptcomments.fpHtmlOptThemes Removesthemecomments.

fpHtmlOptTrcImageAttr RemovesimagetracingattributesfromtheBODYelement.

fpHtmlOptUnusedStyles Removesunusedstyles.RemovesVectorMarkupLanguage

fpHtmlOptVMLGraphics (VML)fromapagethatusesOfficedrawingsandWordArt.

fpHtmlOptWordHTML RemovesWord-specificHTMLmarkup.

expression.OptimizeHTMLFlags

Remarks

UsefpHTMLOptOntoturnoptimizationon.Specifyadditionaloptimizationsettingsbyseparatingeachwithanampersand(&).

Example

ThefollowingexampleturnsoptimizationonforthecurrentpageandspecifiesthatallMicrosoftFrontPageWebcomponentcommentsaretoberemovedfromthepage.

Application.OptimizeHTMLFlags=fpHtmlOptOn_

+fpHtmlOptAuthorComponents+fpHtmlOptBrowseComponents

ShowAll

OptimizeHTMLPublishFlagsPropertySetsorreturnsoneormoreFpOptimizeHTMLFlagsconstantsthatrepresentshowtheHyperTextMarkupLanguage(HTML)inthepagesofaWebsiteisoptimizedduringpublishing.

FpOptimizeHTMLFlagscanbeoneormoreofthefollowingFpOptimizeHTMLFlagsconstants.

fpHtmlOptAuthorComponents RemovesAuthor-TimeFrontPageWebcomponentcomments.

fpHtmlOptBrowseComponents RemovesBrowse-TimeFrontPageWebcomponentcomments.

fpHtmlOptCellFormattingAttr Removescellformattingattributes.

fpHtmlOptDwtCmnts RemovesDynamicWebTemplatecomments.

fpHtmlOptGeneratorRemovesMETAelementsthatcontainGeneratorandProgramaticIdentifierinformation.

fpHtmlOptHTMLAllWhitespace Removesallwhitespacesthatdon'taffectrendering.

fpHtmlOptHTMLCmnts RemovesallHTMLcomments.

fpHtmlOptHTMLLeadWhitespace Removesleadingwhitespacesfromeachline.fpHtmlOptOn Enablesoptimization.fpHtmlOptScriptCmnts Removesscriptcomments.fpHtmlOptThemes Removesthemecomments.

fpHtmlOptTrcImageAttr RemovesimagetracingattributesfromtheBODYelement.

fpHtmlOptVMLGraphicsRemovesVectorMarkupLanguage(VML)fromapagethatusesOfficedrawingsandWordArt.

fpHtmlOptWordHTML RemovesWord-specificHTMLmarkup.

expression.OptimizeHTMLPublishFlags

expressionRequired.AnexpressionthatreturnsoneaWebExobject.

Remarks

UsefpHTMLOptOntoturnoptimizationon.Specifyadditionaloptimizationsettingsbyseparatingeachwithanampersand(&).

Example

ThefollowingexampleturnsoptimizationonfortheactiveWebsiteandspecifiesthatallMicrosoftFrontPageWebcomponentcommentsaretoberemovedwhenpublishingthesite.

ActiveWeb.OptimizeHTMLPublishFlags=fpHtmlOptOn_

+fpHtmlOptAuthorComponents+fpHtmlOptBrowseComponents

OrganizationNamePropertyReturnsthenameoftheorganizationfortheapplication.Read-onlyString.

NoteThenameoftheorganizationisusuallysetduringtheinstallationofanapplicationoroperatingsystem.

Example

InsteadofcreatingacompanynamevariableforyourWebpage,youcanusetheorganizationnameasshowninthefollowingstatement.

myCompanyName=Application.OrganizationName

PageWindowsPropertyReturnsthespecifiedPageWindowExobject.

expression.PageWindows

Example

ThefollowingexampleretrievesapagewindowthatcontainsthepageSpain.htmandsetstheviewmodetoPreview.

NoteTorunthisprocedure,youmusthaveanopenWebsitethatcontainsanopenpagecalledSpain.htm,orsubstituteafileofyourchoice.

PrivateSubSetPagePreview()

SetmyPage=ActiveWebWindow.PageWindows("Spain.htm")

myPage.ViewMode=fpPageViewPreview

EndSub

ParentPropertyReturnsanObjectthatrepresentstheParentobjectforthespecifiedobject.

expression.Parent

Remarks

SpecifyingtheParentpropertyofaWebFileobjectreturnstheWebFolderobject.WhenanobjectiscontainedinaWebsite,theParentpropertyreturnstheWebExobject.Forexample,iftheThemeobjectiscontainedinaWebExobjectcalled"AdventureWorksWeb",theParentpropertyreturns"AdventureWorksWeb";otherwise,forathemereferencedoutsideofaWebExobject,theParentpropertyreturnsthenameoftheApplicationobject—inthiscase,"MicrosoftFrontPage".However,whentheSystemobjectisspecifiedfromaclientcomputer,theParentpropertyreturnstheApplicationobjectofthehost,nottheclient.

Thefollowingtabledescribesthevaluesreturnedforthedifferentobjecttypes.

Object DescriptionMetaTags ReturnstheWebFileobjectfortheMETAtags.

NavigationNodeReturnstheparentNavigationNodeobject,exceptinthecaseoftheRootNavigationNodeobject,whoseparentistheWebExobject.

NavigationNodes ReturnstheparentNavigationNodeobjectforthecollectionofnavigationnodesbasedonthenavigationstructure.

PageWindowEx ReturnstheWebWindowExorApplicationobjectinwhichthepageresides.

PageWindows ReturnstheApplicationobjectthatcontainsthecollection.

Properties ReturnstheWebEx,WebFile,orWebFolderobjectfromtheMETAtaginformation.

System ReturnstheApplicationobject.Theme ReturnstheparentWebExorWebFileobjectforthetheme.Themes ReturnstheWebExobjectthatcontainsthecollection.WebEx ReturnstheApplicationobject.WebFile ReturnstheWebFolderobject.WebFiles ReturnstheparentWebFolderobject.

WebFolderReturnseithertheparentWebFolderobject(ifit'sasubfolder)ortheWebExobjectfortherootfolder.

WebFolders ReturnstheWebFolderobjectthatcontainsthecollection.Webs ReturnstheApplicationobject.

WebWindowEx ReturnstheApplicationobjectthatcontainsthespecifiedobject.

WebWindows ReturnstheApplicationobjectthatcontainsthecollection.

Example

Inthefollowingexample,myParentreturnsthefiletypeandbuildoftheparentapplicationfortheactiveWebsite.

PrivateSubGetParentInfo()

DimmyWebAsWebEx

DimmyParentAsString

DimmyParentBuildAsString

WithmyWeb

myParent=.Parent.FileSearch.FileType

myParentBuild=.Parent.Build

EndWith

EndSub

PrevPropertyReturnsaNavigationNodeobjectthatrepresentsthepreviousnavigationnodeinthenavigationsequence.Read-only.

expression.Prev

Example

Thefollowingexamplemovesthenavigationpointertothepreviousnode,unlessthecurrentnodeisthefirstnodeofthelevelinthenavigationstructure.

PrivateSubMovePrev()

DimtheNodeasNavigationNode

DimthePrevNodeasNavigationNode

OnErrorResumeNext

SettheNode=ActiveWeb.HomeNavigationNode.Children(1)

SetthePrevNode=theNode.Prev

IfErr<>0Then

MsgBox"Thecurrentnavigationlevelstartshere."

EndSub

PreviewDocumentPropertyReturnsanIHTMLDocument2objectthatrepresentsthedocumentinthepreviewmodeofthePageview.

expression.PreviewDocument

Remarks

ThePreviewDocumentpropertyreturnsnothingiftheactivepagewindowisnotcurrentlyinpreviewmode.

Example

Thefollowingexampledisplaysthetitleofthedocumentcurrentlyinpreviewmode.Ifthereisnodocumentinpreviewmode,amessageisdisplayedtotheuser.

SubPreviewDocument()

'Displaysthetitleofthedocumentcurrentlyinpreviewmode

DimFPAppAsFrontPage.Application

DimobjPageWindowAsPageWindowEx

SetFPApp=FrontPage.Application

SetobjPageWindow=FPApp.ActivePageWindow

'Ifthepagewindowisinpreviewmode,displaythetitle

IfobjPageWindow.ViewMode=fpPageViewPreviewThen

MsgBox"Thetitleofthedocumentis:"_

&objPageWindow.PreviewDocument.Title

MsgBox"Thepagewindowisnotinpreviewmode."

EndSub

ProductCodePropertyReturnsthegloballyuniqueidentifier(GUID)forMicrosoftFrontPage.Read-onlyString.

expression.ProductCode()

Example

ThisstatementreturnstheProductIDforFrontPage.

mySystem=Application.ProductCode

ProfileStringPropertyReturnsorsetsaStringthatrepresentsanentryintheMicrosoftWindowsregistryunderthefollowingsubkey:

HKEY_CURRENT_USER\Software\Microsoft\FrontPage\

expression.ProfileString(RegistrySection,RegistryKey)

RegistrySectionRequiredString.Asubkeybelowthe"HKEY_CURRENT_USER\Software\Microsoft\FrontPage\"subkeyintheWindowsregistry.

RegistryKeyRequiredString.ThenameoftheentryinthesubkeyspecifiedbyszSection.Forexample,SoftwareorNetworkintheRegistryEditoraresubkeys.

Example

Thefollowingexamplereturnsthevalueofthesubkey,0(zero),intheRecentlyUsedURLsentry.

NoteTorunthisexample,youmusthaverecentlyopenedapagethatexistsinoneofyourWebsites.

PrivateSubGetRegRecentlyUsedInfo()

DimmySecKeyAsString

DimmyRegKeyAsString

DimmyProfileAsString

mySecKey="HKEY_CURRENT_USER\Software"

mySecKey=mySecKey&_

"\Microsoft\FrontPage\Editor\RecentlyUsedURLs"

myRegKey="0"

myProfile=System.ProfileString(mySecKey,myRegKey)

EndSub

PropertiesPropertyReturnsaPropertiescollectionthatrepresentsthepropertiesforthespecifiedobject.

expression.Properties

Example

ThefollowingexampleaddsanewpropertyanddisplaysitontheactiveWebpage.

NoteTorunthisexample,youmusthaveaWebsitecalled"C:\MyDocuments\MyWebSites\RogueCellars"andafilecalled"Zinfandel.htm".Or,youmaysubstituteanalternativeWebsiteURLandfilename.

PrivateSubCopyrightAdd()

DimmyWebAsWebEx

SetmyWeb=Webs.Open("C:\MyDocuments\MyWebSites\RogueCellars")

myWeb.Activate

ActiveWeb.Close

EndSub

ReadOnlyPropertyReturnsaBooleanthatdeterminesifaspecifiedfieldhasread-onlypermissions.IfTrue,thefieldcannotbemodifiedbytheuser.Read-only.

expression.ReadOnly

Example

Thefollowingexamplestoresthenamesanddefaultvaluesofallfieldswithread-onlypermissionsinthefirstlistoftheactiveWebsite.IftheactiveWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubFieldPermissions()

'Displaysread/writepermissionsofall

'fieldsinthelist.

DimobjFieldsAslistFields

DimstrPermsAsString

SetobjFields=objApp.ActiveWeb.Lists.Item(0).Fields

ForEachobjFieldInobjFields

'Iffieldisread-only,addtolist

IfobjField.ReadOnly=TrueThen

IfstrPerms=""Then

strPerms=objField.Name&"-"&_

'addvaluetostring

strType=strPerms&objField.Name&"-"&_

NextobjField

'displaymessagetouser

EndSub

ShowAll

ReadSecurityPropertyReturnsorsetsanFpListReadSecurityconstantthatrepresentswhichuserscanreadtheinformationinaspecifiedlist.Read/write.

FpListReadSecuritycanbeoneoftheseFpListReadSecurityconstants.fpListReadSecurityAllAlluserscanreadthelist.fpListReadSecurityOnlyOwnOnlythecreatorofthelistcanreadit.

expression.ReadSecurity

Example

ThefollowingexamplechangesthereadpermissionsofalllistsoftypefpListBasicListintheactiveWebsitetofpListReadSecurityAll.AlluserscannowreadalllistsoftypefpListTypeBasicList.

NoteUsetheApplyChangesmethodtosaveanychangestothelist.

SubChangePermissions()

'ChangespermissionofallBasicListsinthecurrentWebsite

DimobjListAsObject

DimobjListsAsLists

'Ifit'saBasicListthenchangepermissions

IfobjList.ReadSecurity<>fpListReadSecurityAllThen

objList.ReadSecurity=fpListReadSecurityAll

EndSub

RecentFilePropertyReturnsorsetsaLongthatrepresentsthenumberofdaysthataneworrecentlymodifiedfileshowsupintheRecentlyAddedFileslistinReportsview.Forexample,iftheRecentFilepropertyissetto20,anewfileorafilethathasbeenmodifiedwillbeclassifiedasrecentforthefirst20daysofitsexistence.Read/write.

expression.RecentFile

Remarks

UsetheOlderFilepropertytosetthenumberofdaysafileexistsinaWebsitewithoutbeingmodifiedbeforeitshowsupintheOlderFileslistinReportsview.

Example

Thefollowingexamplepromptstheusertoenterthenumberofdaysafilecanexistwiththeclassificationrecent,andthensetstheRecentFilepropertytothatvalue.ThesubroutineSetRecentpromptstheuserforinput,performsavalidationontheinputdata,convertsittothecorrecttype,andsetstheRecentFilepropertytothenewvalue.Ifthevalueisofanincorrecttype,anerrormessageisdisplayedtotheuser.

SubFPRecentFile()

'Setsavaluethatdetermineshowlongafilecanbeclassifiedrecent

CallSetRecent(objApp)

EndSub

SubSetRecent(ByRefobjAppAsApplication)

'Setsthevaluethatdetermineshowlongafilewillbeclassifiedasrecent

DimvarNumAsVariant

DimlngNumAsLong

varNum=InputBox("Enterthenumberofdaysafile"&_

"canexistbeforeitisclassifiedasold.")

lngNum=CLng(varNum)

'SettheRecentFilevaluetothenewvalue

objApp.RecentFile=lngNum

MsgBox"TheRecentFilevaluewassetcorrectly."&vbCr&_

"Thenumberofdaysanewormodifiedfilewillbeclassifiedasrecentis"_

&lngNum&"."

MsgBox"Theinputvaluewasincorrect.",vbCritical

EndSub

RequiredPropertyReturnsorsetsaBooleanthatdeterminesifthefieldisrequired.Ifthefieldisrequired,itcannotberemovedfromthecurrentlist.Read/write.

expression.Required

Example

Thefollowingexampledisplaysthenamesanddefaultvaluesofallrequiredfieldsinthecurrentlist.IfnorequiredfieldsexistoriftheactiveWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubDisplayRequiredFields()

'Displaysthenamesanddefaultvalues

'ofallrequiredfieldsinthefirstlistof

'theweb.

DimobjFieldsAsListFields

DimstrReqAsString

DimBlnFoundAsBoolean

SetobjFields=objApp.ActiveWeb.Lists.Item(0).Fields

'setfoundflagtofalse

BlnFound=False

ForEachobjFieldInobjFields

'Iffieldisrequired,addtolist

IfobjField.Required=TrueThen

IfstrReq=""Then

strReq=objField.Name&"-"&_

'Thelistcontainsatleast1requiredfield

BlnFound=True

'addvaluetostring

strReq=strReq&objField.Name&"-"&_

NextobjField

'displaymessagetouser

MsgBox"Theactivewebcontainsnolists."

IfBlnFound=TrueThen

MsgBox"Thecurrentlistcontainsthefollowingrequiredfields:"&_

vbCr&strReq

MsgBox"Thecurrentlistcontainsnorequiredfield(s)."

EndSub

ShowAll

ReturnTypePropertyReturnsanFpFieldTypethatrepresentsthetypeoffield.

FpFieldTypecanbeoneofthefollowingFpFieldTypeconstants.

fpFieldAttachments ReturnsaListFieldAttachmentsobject.fpFieldChoice ReturnsaListFieldChoiceobject.fpFieldComputed ReturnsaListFieldComputedobject.fpFieldCounter ReturnsaListFieldCounterobject.fpFieldCurrency ReturnsaListFieldCurrencyobject.fpFieldDateTime ReturnsaListFieldDateTimeobject.fpFieldFile ReturnsaListFieldFileobject.fpFieldInteger ReturnsaListFieldIntegerobject.fpFieldLookup ReturnsaListFieldLookupobject.fpFieldMultiLine ReturnsaListFieldMultilineobject.fpFieldNumber ReturnsaListFieldNumberobject.fpFieldRatingScale ReturnsaListFieldRatingScaleobject.fpFieldSingleLine ReturnsaListFieldSingleLineobject.fpFieldTrueFalse ReturnsaListFieldTrueFalseobject.fpFieldURL ReturnsaListFieldURLobject.

expression.ReturnType

RevisionControlProjectPropertyReturnsorsetstheRevisionControlProjectproperty.Read/writeString.

expression.RevisionControlProject()

Remarks

ArevisioncontrolprojectcaneitherbeaMicrosoftVisualSourceSafeproject,oraFrontPage-basedlockingproject.ForaVisualSourceSafecontrolproject,youmuststarttheRevisionControlProjectpropertywiththestring"$/";foraFrontPage-basedlockingcontrolproject,youmustsettheRevisionControlProjectpropertyto"<FrontPage-basedLocking>".

Toremoveasourcecontrolproject,settheRevisionControlProjectpropertytoanemptystring.

Example

ThefollowingexamplesetstheRevisionControlProjectpropertyinaVisualSourceSafeproject.

PrivateSubSetRevisionControlProjectName()

DimmyWebAsWebEx

DimmyRevisionControlProjectAsString

SetmyWeb=ActiveWeb

myRevisionControlProject=_

"$/RogueCellars/RogueCellarsUpdate"

myWeb.RevisionControlProject=_

myRevisionControlProject

EndSub

RootFolderPropertyReturnsaWebFolderobjectthatrepresentstheactiveWebExobject'sroot.

expression.RootFolder()

Example

Thefollowingstatementreturnsthenameoftherootfolder.

ActiveWeb.RootFolder.Name

RootNavigationNodePropertyReturnsaNavigationNodeobjectthatrepresentsthetop-levelnavigationnode.

expression.RootNavigationNode()

Remarks

YoucanusetheRootNavigationNodepropertytodeterminetherootnavigationnode.TheRootNavigationNodepropertyreturnstheNavigationNodeobjectfromwhichyoucanaccessallothernavigationnodesinaWebsite.TheRootNavigationNodeobjectiscreatedbydefaultwhenyoucreateaWebsiteandprovidesthebasisforthenavigationstructure,whichisaccessedthroughtheChildrencollection.ThefirstchildnodeofthenavigationstructureisthehomepageoftheWebsite.

Example

Thefollowingexampleaddsaglobalnavigationnodetotherightofthehomenavigationnode.

PrivateSubAddNode()

DimmyRNodeAsNavigationNode

DimmyPageAsString

SetmyRNode=ActiveWeb.RootNavigationNode

myPage="http://myServer/myWeb/search.htm"

CallmyRNode.Children.Add(myPage,"Search",_

EndSub

ShowAll

SelectedFilesPropertyReturnsanarrayofWebFileobjectsrepresentingtheselectedfiles.

expression.SelectedFiles

Remarks

YoumusthaveFoldersviewopeninMicrosoftFrontPageinordertoselectmultiplefilesandyoumustusetherightpanetoselectthefiles.FromFoldersviewyoucanselectmultiplefilesinasingleWebsiteorinmultipleWebsites.IfyoumustusePageview,youcanonlyselectonefileperWebsitefromtheleftpane.

YoucanusethefpWebViewFoldersconstantoftheViewModepropertytosettheviewtotheFoldersview.

Example

Thefollowingexampleconcatenatesthenamesoftheselectedfiles.

NoteThedelimiterusedtoseparatethefilenamesinthevariablemySelNameisaspace.

PrivateSubGetSelectedFileNames()

DimmySelFilesAsVariant

DimmySelFileAsWebFile

DimmySelNameAsString

DimmyCountAsInteger

SetmyWebWindows=WebWindows

mySelFiles=ActiveWebWindow.SelectedFiles

FormyCount=0ToUBound(mySelFiles)

SetmySelFile=mySelFiles(myCount)

mySelName=mySelName&""&mySelFile.Name

EndSub

SelectedFoldersPropertyReturnsanarrayofWebFolderobjectsrepresentingtheselectedfolders.

expression.SelectedFolders

Remarks

YoumusthaveFoldersviewopeninMicrosoftFrontPageinordertoselectmultiplefoldersandyoumustusetherightpanetoselectthefolders.FromFoldersview,youcanselectmultiplefoldersinasingleWebsiteorinmultipleWebsites.IfyoumustusePageview,youcanonlyselectonefolderperWebsitefromthefoldersintheleftpane.

NoteIfyou'reprogrammaticallyselectingfolders,youcanusethefpWebViewFoldersconstantoftheViewModepropertytosettheviewtoFoldersview.

Example

Thefollowingexampleconcatenatesthenamesoftheselectedfolders.

NoteThedelimiterusedtoseparatethefoldernamesinthevariablemySelNameisaspace.

PrivateSubGetSelectedFolderNames()

DimmySelFoldersAsVariant

DimmySelFolderAsWebFolder

DimmySelNameAsString

DimmyCountAsInteger

SetmyWebWindows=WebWindows

mySelFolders=ActiveWebwindow.SelectedFolders

FormyCount=0ToUBound(mySelFolders)

SetmySelFolder=mySelFolders(myCount)

mySelName=mySelName&""&mySelFolder.Name

EndSub

ShowAll

SharedBordersPropertyTrueifanysharedbordersareinusefortheWebExorWebFileobject.Read/writeVariant.

expression.SharedBorders(BorderIndex)

expressionRequired.AnexpressionthatreturnsaWebExorWebFileobject.

BorderIndexOptionalFpSharedBorders.TheborderindexcanbeoneoftheFpSharedBordersconstants.ThedefaultconstantisfpBorderTop.

FpSharedBorders Value DescriptionfpBorderTop 1 Setsaborderforthetopofapage.fpBorderLeft 2 Setsaborderfortheleftsideofapage.fpBorderRight 4 Setsaborderfortherightsideofapage.fpBorderBottom 8 Setsaborderforthebottomofapage.fpBorderAll 255or&HFF Setsbordersonallsidesofapage.

Remarks

Sharedborders,suchastheconstantfpBorderLeft,canbeusedtosetindividualbordervalues.

NoteThedefaultsharedborderisusedifasharedborderisnotspecified.

Example

ThefollowingexamplesetsthesharedborderfortheactiveWebsite.

PrivateSubSetSharedBorders()

ActiveWeb.SharedBorders(fpBorderLeft)=True

EndSub

ShowAsPercentagePropertyReturnsorsetsaBooleanthatdeterminesifthevalueinthefieldwillbedisplayedasapercentage.Read/write.

expression.ShowAsPercentage

Example

ThefollowingexamplesetstheShowAsPercentagepropertyofallfieldsoftypefpFieldNumbertoTrue.Thevaluesinthefieldswillnowappearaspercentages.

SubDisplayAsPercentage()

'DisplaysallfieldsoftypefpFieldNumberas

'apercentage

DimstrNameAsString

'Cyclethroughlistsanddisplaysasapercentage

objLstFld.ShowAsPercentage=True

NextobjLstFld

objApp.ActiveWeb.Lists.Item(0).ApplyChanges

EndSub

ShowStartupDialogPropertyReturnsorsetsaBooleanthatdeterminesiftheNewtaskpanewillbedisplayedwhenMicrosoftFrontPageisstarted.

expression.ShowStartupDialog

Remarks

TheShowStartuppropertyisglobal,meaningthatanychangeswillnottakeaffectuntilFrontPageisrestarted.

Example

ThefollowingexamplesetstheShowStartupDialogpropertytoTrue.ThenexttimeFrontPageisstarted,theNewpanewillappear.

SubTaskPaneStartup()

'ModifestheStartuptaskpaneproperty

WithobjApp

'SettoTrue,thetaskpanewillappearonstartup

.ShowStartupDialog=True

EndWith

EndSub

ShowUserNamesInResultsPropertyReturnsorsetsaBooleanthatdeterminesifthenamesofuserswhohavecompletedthesurveywillbevisible.Read/write.

expression.ShowUserNamesInResults

expressionRequired.AnexpressionthatreturnsaSurveyobject.

Example

ThefollowingexamplesetstheShowUserNamesInResultspropertyforeachSurveyobjectintheactiveWebsitetoTrue,displayingthenamesofalluserswhocompletedthesurvey.

SubChangePermissions()

'ChangespermissionofallBasicListsinthecurrentWebsite

DimobjListAsObject

DimobjListsAsLists

'Ifit'saSurveythenchangepermissions

IfobjList.Type=fpListTypeSurveyThen

IfobjList.ShowUserNamesInResults<>TrueThen

objList.ShowUserNamesInResults=True

EndSub

SlowPagePropertyReturnsorsetsaLongthatspecifiesthenumberofsecondsapagecantaketodownloadbeforeitisclassifiedasslow.PagesthatareclassifiedasslowappearintheSlowPageslistintheMicrosoftFrontPageReportsview.Read/write.

expression.SlowPage

Remarks

TheSlowPagepropertyisusedinconjunctionwiththeConnectionSpeedpropertytodeterminethesimulateddownloadtimeofaWebpage.

Example

ThefollowingexamplesetstheSlowPagepropertyto10seconds,indicatingthatallpagesthattakeover10secondstodownload(inthiscase,usinga56Kmodem)willbeclassifiedasslowintheFrontPageReportsview.

SubSetSlowPage()

'ModifiestheSlowPageproperty

WithobjApp

'Setvalueto10,slowpagestakeatleast10seconds

.SlowPage=10

'Setuser'sconnectionspeedto56Kmodem

.ConnectionSpeed=fpConnect56K

EndWith

EndSub

StartNumberPropertyReturnsaLongthatrepresentsthestartingnumberforthenumberscaleinaratingscalefield.

expression.StartNumber

expressionRequired.AnexpressionthatreturnsaListFieldRatingScaleobject.

SubjectPropertySetsorreturnsaStringthatrepresentsthesubjectofaWebpackage.

expression.Subject

Example

DimobjWebAsWebEx

SetobjWeb=ActiveWeb

WithobjPackage

.Author="JohnSmith"

EndWith

SubTreePropertyReturnsaNavigationNodescollectionobjectthatrepresentsacollectionofallthenodesinthesubtreeofthecurrentnavigationnode.Asubtreeofanodeisdefinedasallnodeswhichareadjacenttoorattachedtotheparentnodeandappearbelowtheparentnodeinthetreehierarchy.

expression.SubTree

Example

ThefollowingexamplepromptstheusertoenterthenameofanavigationnodeinthecurrentWebsiteandreturnsthesubtreeforthatparticularnode.Ifthenodeisfound,itslabelpropertyvalueisaddedtoaStringcontainingthenamesofallnodesintheparentnode'ssubtree.TheStringstoredinthevariablestrSubNodesisdisplayedtotheuser.IfthenodeisnotfoundintheWebsite,amessageisdisplayedtotheuser.

SubDisplaySubTree()

'Returnsthesubtreeofagivennode

DimobjSubTreeAsNavigationNodes

DimobjSubNodeAsNavigationNode

DimstrAnsAsString'Userinput

DimblnFoundAsBoolean'Booleanfoundflag

DimintCountAsInteger'Integercounter

DimstrSubNodesAsString'Namesofallsubnodes

blnFound=False

intCount=0

'Prompttheusertoenterthenameofthenode

strAns=InputBox("Enterthenameofthenodeforwhich"&_

"youwanttoviewthesubtree.")

'Whilethenodeisnotfoundandtherearemorenodesinthetree

DoWhile(NotblnFound=True)And(intCount<=objNavNodes.Count-1)

'Compareuserinputwithnodelabel

IfTrim(strAns)=objNavNodes.Item(intCount).LabelThen

'Iffound,returnnode

SetobjNavNode=objNavNodes.Item(intCount)

'Setfoundflagtotrue

blnFound=True

'Otherwiseincreasecounter,keepchecking

intCount=intCount+1

IfblnFound=TrueThen

SetobjSubTree=objNavNode.SubTree

ForEachobjSubNodeInobjSubTree

'Ifthestringisemptyorhasnotyetbeenset

IfstrSubNodes=""Then

strSubNodes=strSubNodes&objSubNode.Label

'otherwiseaddnextnodelabletostring

strSubNodes=strSubNodes&","&vbCr&objSubNode.Label

NextobjSubNode

'Displaynamesofallnodesinsubtree

MsgBox"Thenodesfoundinthesubtreeof"&objNavNode.Label&"are:"_

&vbCr&vbCr&strSubNodes&"."

'Ifnotfound,displaymessagetouser

MsgBox"Thenavigationnode"&strAns&"wasnotfound."

EndSub

ShowAll

SubViewModePropertyReturnsorsetsanFpWebSubViewconstantthatdeterminestheviewtypeinthecurrentsubwindow.Read/write.

FpWebSubViewcanbeoneoftheseFpWebSubViewconstants.fpWebSubViewFoldersChangethecurrentsubwindowviewtoFoldersview.fpWebSubViewNavigationChangethecurrentsubwindowtoNavigationview.fpWebSubViewNoneClosethecurrentsubwindow.

expression.SubViewMode

Example

ThefollowingexamplepromptstheusertoopenthesubwindowinFoldersviewifthesubwindowisnotcurrentlyvisible.Ifthesubwindowiscurrentlyopen,theuserisnotpromptedandtheprogramends.

SubSubModeType()

'Modifiesthesubwindowviewmodeofthecurrentwebwindow

DimstrAnsAsString

'Checkifthesubwindowisopenorclosed

IfobjWebwdw.SubViewMode=fpWebSubViewNoneThen

strAns=MsgBox("Thesubwindowisnotvisible."&_

"Wouldyouliketoviewthesubwindow?",vbYesNo)

'Prompttheusertoopenthesubwindow

IfstrAns=vbYesThen

'ChangethesubwindowtoFolderview

objWebwdw.SubViewMode=fpWebSubViewFolders

EndSub

SystemPropertyReturnstheSystemobject.

expression.System()

Example

Thisstatementreturnsthecurrentoperatingsystem.

mySystem=Application.System.OperatingSystem

TemplatePropertyReturnsorsetsaStringthatrepresentsthefilepathofthetemplateappliedtothedocumentlibrary.Read/write.

expression.Template

Example

ThefollowingexamplecreatesareferencetoadocumentlibrarynamedNewLibraryanddisplaysthefilepathofthetemplateassociatedwiththelibrary.

SubTemplatePath()

'Displaysthefilepathofthetemplate

DimobjListsAsLists

MsgBox"Thefilepathofthetemplateassociatedwiththe"&_

"documentlibraryis"&objLibrary.Template&"."

EndSub

ShowAll

ThemePropertiesPropertyReturnstheThemeobjectforthespecifiedobject.

expression.ThemeProperties(PropertyIndex)

expressionAnexpressionthatreturnsaPageWindowEx,WebEx,orWebFileobject.

PropertyIndexOptionalFpThemeProperties.Returnsorsetsthethemeproperties.

FormoredetailedinformationontheindividualTypeconstantsshowninthefollowingtable,seethetablesandlistsintheApplyThememethod.

FpThemeProperties Value Description

fpThemeActiveGraphics 16or&H10 Returnstheactivegraphicsconstant.

fpThemeBackgroundImage 1 Returnsabackgroundimage.

fpThemeCSS 4096or&H1000 Returnsthecascadingstylesheet.

fpThemeDefaultSettings16777216or&H1000000

Returnsthethemeappliedtotheweb.

fpThemeName33554432or&H2000000

ReturnstheThemeNameconstant.

fpThemeNoBackgroundImage 0 Returnsabackgroundwithoutanimage.

fpThemeNoCSS 0Returnsthispropertyifacascadingstylesheethasnotbeensetorisnotwanted.

fpThemeNormalColors 0 Returnsthecolormodefornormalcolor.Returnsthegraphicsmodefor

fpThemeNormalGraphics 0 normalgraphics.

fpThemePropertiesAll 4369or&H1111

Returnsallofthethemeproperties.Afterathemeisappliedtoanobject,thefpThemePropertiesAllpropertycombinesallthepropertiesappliedtotheobject.

fpThemePropertiesNone 0 Returnsnoneforthethemeproperties.

fpThemeVivdColors 256 Returnsthevividcolorsproperty.

Example

Thefollowingexamplechecksthethemepropertiesforactivegraphics.Ifactivegraphicshavebeenapplied,thenvividcolorsareappliedinadditiontothethemepropertiesthatarealreadyappliedtotheactivepagewindow.Ifactivegraphicsaren'tapplied,thenactivegraphicsandvividcolorsarebothappliedtotheactivepagewindow.

PrivateSubGetThemeProperties()

SetmyPageWindow=ActiveWeb.ActiveWebWindow.ActivePageWindow

IfmyPageWindow.ThemeProperties(fpThemeActiveGraphics)Then

myPageWindow.AppyTheme(fpThemePropertiesAll+_

fpThemeVividColors)

ExitSub

myPageWindow.ApplyTheme(fpThemePropertiesAll+_

fpThemeActiveGraphics+fpThemeVividColors)

EndSub

Thefollowingexampleaddsabackgroundpicturetothespecifiedfile.

PrivateSubAddBackgroundImage()

DimmyFileAsWebFile

SetmyFile=Webs(0).Rootfolder.Files("index.htm")

IfmyFile.ThemeProperties(fpThemeBackgroundImage)=0Then

myFile.ApplyThememyFile.ThemeProperties(fpThemeName),_

myfile.ThemeProperties(fpThemePropertiesAll)+_

fpThemeBackgroundImage

EndSub

ThemesPropertyReturnsaThemescollectionthatrepresentsthethemesavailableforthespecifiedobject.

expression.Themes

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliestolist.

Remarks

TheThemespropertyasappliedtotheApplicationobjectreturnsthecollectionofthemesavailabletobeapplied.WhentheThemespropertyisappliedtotheWebExobject,itreturnsthecollectionofthemesthathavebeenappliedtotheWebsite.ThisisthesameasthelistthatappearsintheWeb’s_themedirectory.IfathemeisappliedtoaWebExobject,therewillbeonethemeinthecollection.However,ifapageinaWebsitehasitsowntheme,separatefromthethemethatwasappliedtotheWebsite,thentheThemescollectionfortheWebExobjectwillhavetwothemesinit—thethemethatwasoriginallyappliedtotheWebsite,andthethemethatwasappliedspecificallytothepage.

Example

Thefollowingexamplesearchesforaspecificthemeamongthethemesthatareavailablelocallyontheclient,aswellasthethemesappliedtotheactiveWebsite.

PrivateSubSearchAllThemes()

DimmyThemeAsTheme

DimmyThemeToFindAsString

DimmyIsFoundAsBoolean

myThemeToFind="blends"

myIsFound=False

ForEachmyThemeInApplication.Themes

IfmyTheme.Label=myThemeToFindThen

myIsFound=True

ExitFor

ForEachmyThemeInActiveWeb.Themes

IfmyTheme.Label=myThemeToFindThen

myIsFound=True

ExitFor

EndSub

TitlePropertyReturnsthetitleofthespecifiedobject.Read-onlyorread/writeStringdependingonthespecifiedobject.

expression.Title

Remarks

FortheWebExandWebFileobjectstheTitlepropertyreturnsthetitleoftheactiveWebExobjectasaread/writeString.

Example

Atthesametimeasyou'retraversingthenavigationnodes,youcanalsoreturnthetitle(filename)ofthefilethat'sassociatedwithaparticularnode.ThefollowingexamplereturnsthetitleofthefileassociatedwithanavigationnodeintheactiveWebsite.

PrivateSubGetFileFromNavNode()

DimmyWebAsWebEx

DimmyFileFromNavNodeAsString

SetmyWeb=ActiveWeb

SetmyNavNode=_

myWeb.RootNavigationNode.File.NavigationNode

WithmyNavNode

myFileFromNavNode=.File.Title

EndWith

EndSub

ThefollowingexampleshowshowyoucansetthetitleofthefirstfileintheWebsite.

PrivateSubSetTitle()

DimmyWebAsWebEx

DimmyNewTitleAsString

DimmyFileAsWebFile

MyNewTitle="Inventory.htm"

SetmyWeb=ActiveWeb

MyFile.Title=myNewTitle

EndSub

ShowAll

TypePropertyTypepropertyasitappliestotheBasicList,DocumentLibrary,List,and

Surveyobjects.

ReturnsanFpListTypeconstantthatrepresentsthetypeofthecurrentlist.Read-only.

FpListTypecanbeoneoftheseFpListTypeconstants.fpListTypeBasicListfpListTypeDocumentLibraryfpListTypeSurveyfpListTypeDiscussion

expression.Type

TypepropertyasitappliestoallotherobjectsintheAppliesTolist.

ReturnsanFpFieldTypeconstantthatrepresentsthetypeofthecurrentfield.Read-only.

FpFieldTypecanbeoneoftheseFpFieldTypeconstants.fpFieldAttachmentsfpFieldChoicefpFieldComputedfpFieldCounterfpFieldCurrencyfpFieldDateTimefpFieldFilefpFieldIntegerfpFieldLookupfpFieldMultiLine

fpFieldNumberfpFieldRatingScalefpFieldSingleLinefpFieldTrueFalsefpFieldURL

expression.Type

expressionRequired.Anexpressionthatreturnsoneoftheobjectsasmentionedabove.

Example

AsitappliestotheBasicList,DocumentLibrary,List,andSurveyobjects.

ThefollowingexampledisplaysthenamesofalllistsintheactiveWebsiteandtheirassociatedtypenames.IftheactiveWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubViewListTypes()

'Displaysthenameofthelistand

'itsassociatedtype

DimlstWebListAsList

DimstrTypeAsString

'Cyclethroughlists

'addtypestostring

IfstrType=""Then

strType=lstWebList.Name&"-"&_

lstWebList.Type&vbCr

strType=strType&lstWebList.Name&"-"&_

lstWebList.Type&vbCr

'Displaytypesofalllistsintheweb

MsgBox"Thelisttypesinthecurrentwebare:"_

&vbCr&strType

EndSub

AsitappliestotheListFieldobject.

ThefollowingexampledisplaysthenamesofallfieldsinthefirstlistoftheListscollectionandtheirassociatedtypenames.IftheactiveWebsitecontainsnolists,amessageisdisplayedtotheuser.

SubFieldtype()

'Displaysthefieldtypesofthecurrentlist

DimstrTypeAsString

IfstrType=""Then

strType=objField.Name&"-"&_

objField.Type&vbCr

strType=strType&objField.Name&"-"&_

objField.Type&vbCr

NextobjField

MsgBox"Thenamesofthefieldsinthislistandtheirtypesare:"&_

vbCr&strType

EndSub

UrlPropertyReturnstheURLforthespecifiedobject.Read-onlyString.

expression.Url

Remarks

URLscanbeabsoluteorrelative.AnabsoluteURLcontainstheexactpathtothespecifiedobjectwhilearelativeURLmaycontaincharacterssuchas"../..","?",or";"dependingontheURLaccessschemeusedtoparsetherelativeURL.TheMicrosoftFrontPageobjectmodelalwaysusesabsoluteURLs.FormoreinformationonURLs,seeUnderstandingAbsoluteandRelativeURLsinFrontPage.

Example

ThefollowingexamplereturnstheURLofthefirstfileintherootfolderoftheactiveWebsite.

PrivateSubGetFileUrl()

DimmyFileAsWebFile

DimmyURLAsString

SetmyFile=ActiveWeb.RootFolder.Files(0)

myURL=myFile.Url

EndSub

UserNamePropertyReturnsthelogonnameoftheuserthatiscurrentlyloggedontothenetworkoroperatingsystem.Read/writeString.

expression.UserName

Remarks

TheUserNamepropertyisthedefaultparameterwheneverausernameisrequiredforaparameterintheWebObjectModel.Forexample,theWebs.OpenandWebs.PublishmethodsbothrequireaUserNameparameter.Whentheparameterisn'tspecified,thedefaultparameteristheusernameoftheusercurrentlyloggedon.

Example

Thefollowingexamplereturnsthecurrentuser'slogonname.

myLogonName=Application.UserName

VBEPropertyReturnsaVBEobjectthatrepresentstheMicrosoftVisualBasicEditor.

expression.VBE

Example

ThefollowingexamplecreatesareferencetotheVisualBasicEditoranddisplaysthenameoftheactiveprojecttotheuser.

SubReturnVBE()

'CreatesareferencetotheVBEanddisplaysamessagetouser

'Displaythenameoftheactiveproject

MsgBox"Thenameoftheactiveprojectis:"&_

objApp.VBE.ActiveVBProject.Name

EndSub

VersionPropertyReturnstheversionofthespecifiedobjectwiththeformat:"x.x.x",wherexrepresentsanumberintheversion.Read-onlyString.

expression.Version()

Remarks

IftheApplicationobjectisspecified,theVersionpropertyreturnstheversionoftheapplication.WhentheVersionpropertyfortheSystemobjectisaccessed,itreturnsthecurrentversionoftheoperatingsystemasyoumightseeusedonthePropertiespageoftheSystemdialogbox.

Example

Thefollowingexamplereturnstheversionoftheapplication.

PublicSubGetAppVersion()

DimmyAppVersionAsString

myAppVersion=Application.Version

EndSub

VerticalResolutionPropertyReturnstheverticalresolutionofthescreeninpixels.Read-onlyLong.

expression.VerticalResolution()

Example

Thisexamplereturnstheverticalresolutionofthescreen.

myVerticalRes=System.VerticalResolution

ShowAll

ViewModeProperty(WebObjectModel)

ViewModepropertyasitappliestothePageWindowExobject.

ReturnsorsetsanFpPageViewModeconstantthatrepresentstheviewmodeoftheactivepagewindow.Read/write.

FpPageViewModecanbeoneoftheseFpPageViewModeconstants.fpPageViewNoFramesfpPageViewNormalfpPageViewNoWindowfpPageViewPreviewfpPageViewDefaultfpPageViewHtml

expression.ViewMode

ViewModepropertyasitappliestotheWebWindowExobject.

ReturnsorsetsanFpWebViewModeconstantthatdefinestheviewmodeofthecurrentwindow.Read/write.

FpWebViewModecanbeoneoftheseFpWebViewModeconstants.fpWebViewAllFilesfpWebViewBrokenLinksfpWebViewFoldersfpWebViewLinksfpWebViewPagefpWebViewSiteSummaryfpWebViewStructure

fpWebViewTodo

expression.ViewMode

ViewModepropertyasitappliestotheFPHTMLDocumentandIFPDocumentobjects.

ReturnsaLongthatrepresentstheviewmodeofthedocument.Read-only.

expression.ViewMode(ViewMode)

expressionRequired.AnexpressionthatreturnsanFPHTMLDocumentorIFPDocumentobject.

ViewModeRequiredLong.Thenewviewingmode.

Example

ThefollowingexamplechangestheviewmodeoftheactivewindowtothevaluefpPageViewNormal(Designview)ifitisnotalreadyinthedefaultviewmode.

SubChangeViewMode()

'Changestheviewmodeoftheactivewindow

DimfpAppAsFrontPage.Application

DimobjPageAsPageWindowEx

SetfpApp=FrontPage.Application

SetobjPage=fpApp.ActivePageWindow

IfobjPage.ViewMode<>fpPageViewDefaultThen

objPage.ViewMode=fpPageViewNormal

MsgBox"Thecurrentpagewindowhasbeenrestored"&_

"tonormalview."

EndSub

AsitappliestotheWebWindowExobject.

ThefollowingexamplechangestheviewmodeoftheactiveWebsitewindowtofpWebBrokenLinks(BrokenLinksview)ifthewindowisnotalreadyintheview.

SubChangeViewMode()

DimobjWebWindowAsWebWindowEx

SetobjWebWindow=fpApp.ActiveWebWindow

IfobjWebWindow.ViewMode<>fpWebViewBrokenLinksThen

objWebWindow.ViewMode=fpWebViewBrokenLinks

MsgBox"Thecurrentpagewindowhasbeenrestored"&_

"toBrokenLinksview."

EndSub

AsitappliestotheFPHTMLDocumentobject.

Thefollowingexampledisplaystheviewmodeoftheactivedocument.

SubDisplayViewMode()

DimobjDocAsFPHTMLDocument

SetobjDoc=fpApp.ActiveDocument

SelectCaseobjDoc.ViewMode

MsgBox"ThedocumentisinNormalmode."

MsgBox"ThedocumentisinHTMLmode"

MsgBox"ThedocumentisinPreviewmode"

EndSelect

EndSub

ShowAll

ViewModeExPropertyReturnsorsetsanFpWebViewModeExenumeratedconstantthatrepresentsthecurrentviewmodeoftheWebsitewindow.Read/write.

FpWebViewModeExcanbeoneoftheseFpWebViewModeExconstants.fpWebViewExAccessibilityfpWebViewExAllFilesfpWebViewExAssignedTofpWebViewExBrokenLinksfpWebViewExBrowserTypesfpWebViewExCategoriesfpWebViewExCheckoutStatusfpWebViewExComponentErrorsfpWebViewExCSSLinksfpWebViewExDailyPageHitsfpWebViewExDailySummaryfpWebViewExFoldersfpWebViewExLinksfpWebViewExMasterPagesfpWebViewExMonthlyPageHitsfpWebViewExMonthlySummaryfpWebViewExNavigationfpWebViewExOlderFilesfpWebViewExOsTypesfpWebViewExPagefpWebViewExPublishStatusfpWebViewExRecentlyAddedFilesfpWebViewExRecentlyChangedFilesfpWebViewExReferringDomainsfpWebViewExReferringURLsfpWebViewExRemoteSite

fpWebViewExReviewStatusfpWebViewExSearchStringsfpWebViewExSharedBordersfpWebViewExSiteSummaryfpWebViewExSlowPagesfpWebViewExThemesfpWebViewExTodofpWebViewExUnlinkedFilesfpWebViewExUsageSummaryfpWebViewExVisitingUsersfpWebViewExWeeklyPageHitsfpWebViewExWeeklySummary

expression.ViewModeEx

Example

Thefollowingexamplechangestheviewmodetodisplaythedailypagehits.

SubViewPageHits()

'Changesthecurrentviewmodetoviewpagehits

ActiveWeb.ActiveWebWindow.ViewModeEx=fpWebViewExDailyPageHits

EndSub

ViewPagesPropertyRreturnsaStringarraythatrepresentsalistofpagesthatcontainaviewforthelist.

expression.ViewPages

VisiblePropertyReturnsorsetsthevisiblestateofthePageWindowExorWebWindowExobject.ThevisiblestateforthePageWindowExobjectisread-onlyBoolean.ThevisiblestatefortheWebWindowExobjectisread/writeBoolean.

expression.Visible

Example

Inthefollowingexample,theGetVisibleStateprocedurereturnsthevisiblestateofthefirstPageWindowExobjectfromtheCheckIfVisiblefunction.

PrivateSubGetVisibleState()

DimmyIsVisibleAsBoolean

myIsVisible=CheckIfVisible

EndSub

FunctionCheckIfVisible()AsBoolean

DimmyVisibleStateAsBoolean

SetmyPage=Application.Webs(0).WebWindows(0).PageWindows(0)

myVisibleState=myPage.Visible

CheckIfVisible=myVisibleState

EndFunction

ThefollowingexamplesetsthevisiblestateofaWebWindowExobjecttoawindowlessstate.

PrivateSubOpenInNoWindow()

SetmyWebWindow=Webs(0).WebWindows(0)

myWebWindow.Visible=False

EndSub

WebPropertyReturnsaWebExobjectthatrepresentsaMicrosoftFrontPageWebsite.

expression.Web

Example

ThefollowingexamplereturnsthetitleoftheactiveWebsite.

PrivateSubGetWebTitle()

DimmyWebAsWebEx

DimmyWebNameAsString

SetmyWeb=ActiveWeb

myWebName=myWeb.RootFolder.Web.Title

EndSub

WebsPropertyReturnsthecollectionofopenWebsitesforthespecifiedobject.

expression.Webs

Example

ThefollowingexamplecreatesanarraythatcontainsalloftheURLsforalltheopensubsitesinyourWebsite.

NoteYoumustopenanyWebsitesforwhichyouwishtoretrievetheURLs.

PrivateSubGetWebs()

DimmyWebsAsWebs

DimmyWebAsWebEx

DimmyOpenWebs()AsVariant

DimiAsInteger

DimmyWebCountAsInteger

SetmyWebs=Application.Webs

myWebCount=myWebs.Count

ReDimmyOpenWebs(myWebCount)

ForEachmyWebInmyWebs

myOpenWebs(i)=myWeb.Url

LoopUntili>myWebCount

EndSub

WebWindowsPropertyReturnsthecollectionofopenWebWindowsobjectsinthespecifiedobject.

expression.WebWindows

Example

ThefollowingexamplechecksifanyoftheWebwindowsaresettoPageview,andchangesthosethatareinPageviewtoFoldersview.

PrivateSubGetViewModes()

DimmyViewAsFpWebViewMode

SetmyWebs=Webs

SetmyWebWindows=myWebs.WebWindows

myView=myWebWindow.ViewMode

IfmyView=fpWebViewPageThen

myWebWindow.ViewMode=fpWebViewFolders

EndSub

OnActivateEventOccurswhenthepagewindoworWebwindowobtainsthefocusandbecomesthecurrentwindow.

PrivateSubexpression_OnActivate()

expressionAvariablewhichreferencesanobjectoftypePageWindowExorWebWindowExdeclaredwitheventsinaclassmodule.

Example

ThefollowingexampleusestheIsDirtypropertytodetermineifthepageshowninthespecifiedwindowhaschangedsincethelastrefreshorsaveandsavesthedocumentthathaschanged.

PrivateSubPageWindowEx_OnActivate()

'Displaysamessagewhenthewindowobtainsfocus

IfPageWindowEx.IsDirtyThen

PageWindowEx.Save

EndSub

OnAfterPageSaveEventOccursafterapageissaved.

PrivateSubApplication_OnAfterPageSave(ByValpPageAsPageWindowEx,SuccessAsBoolean)

pPageRequiredPageWindowExobject.

SuccessRequiredBoolean.TrueifthePageWindowExobjectwassuccessfullysaved.

Remarks

TheOnAfterPageSaveeventisassociatedwiththeApplicationobject.AftertheusersavesapageorclosesMicrosoftFrontPage,theOnAfterPageSaveeventfiresandexecutesthecodethatyouspecifiedwithintheeventprocedure.

Example

Thefollowingexampledisplaysamessageboxafterthepagehasbeensavedanddisplaysthefilenameofthepage.

NoteTorunthisexample,youmusthaveatleastoneopenWebsiteandoneopenpagewithinthatWebsite.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdSaveandabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

PrivateWithEventseFPApplicationAsApplication

PrivateSubUserForm_Initialize()

SeteFPApplication=NewApplication

EndSub

PrivateSubcmdSave_Click()

myPageWindow.Save

EndSub

PrivateSubcmdCancel_Click()

'Hidetheform.

frmLaunchEvents.Hide

ExitSub

EndSub

PrivateSubeFPApplication_OnAfterPageSave(ByValpPageAs_

PageWindow,SuccessAsBoolean)

IfSuccess=TrueThen

MsgBox"Thefollowingpagewassaved:"&pPage.File.Name

MsgBox"Therewasaproblemwithsavingyourpage:"&_

pPage.File.Name

EndSub

OnAfterPageWindowViewChangeEventOccurswhenapagewindowhasswitchedviewtypes.

PrivateSubexpression_OnAfterPageWindowViewChange(ByValpPageAsPageWindowEx)

expressionAnobjectoftypeApplicationdeclaredusingtheWithEventskeywordinaclassmodule.

pPageThePageWindowExobjectinwhichtheviewhaschanged.

Example

Thefollowingexamplepromptstheusertorefreshthewindowafterithaschangedviewmodes.

PrivateSubobjApp_OnAfterPageWindowViewChange(ByValpPageAsPageWindowEx)

'Occurswhenaviewchanges

DimstrAnsAsString

'Promptusertorefreshview

strAns=MsgBox("Theviewhaschanged,wouldyouliketorefreshthewindow?",vbYesNo)

IfstrAns=vbYesThen

pPage.Refresh

EndSub

OnAfterPublishEventOccursafteraWebsiteispublished.

PrivateSubexpression_OnAfterPublish(SuccessAsBoolean)

expressionAvariablenamewhichreferencesanobjectoftypeWebExdeclaredwitheventsinaclassmodule.

SuccessABooleanthatdeterminesifthepublishoperationwassuccessful.IfTrue,thentheWebsitewassuccessfullypublished.

Example

ThefollowingexampledisplaysamessagetotheuserbasedontheresultofthePublishmethod.

PrivateSubobjWeb_OnAfterPublish(SuccessAsBoolean)

'Occursafterawebispublished

IfSuccess=TrueThen

MsgBox"Thewebwaspublishedsuccessfully."

MsgBox"Anerroroccurred,thewebwasnotpublished.",vbExclamation

EndSub

OnAfterSaveEventOccursaftertheactivedocumenthasbeensavedbytheuser.

PrivateSubexpression_OnAfterSave(SuccessAsBoolean)

expressionAvariablenamewhichreferencesanobjectoftypePageWindowExdeclaredusingtheWithEventskeywordinaclassmodule.

SuccessABooleanthatindicatesiftheoperationwassuccessful.IfTrue,thefilewassaved.

Example

Theeventinthefollowingexampleoccursaftertheactivedocumentissavedinanextendedpagewindow.Amessageisdisplayedtotheuserbasedontheresultoftheoperation.

PrivateSubPageWindowEx_OnAfterSave(SuccessAsBoolean)

'DisplaysmessagebasedonvalueofSuccess

IfSuccess=TrueThen

MsgBox"Thefile"&PageWindowEx.ActiveDocument.Title&"wassaved."

MsgBox"Thefile"&PageWindowEx.ActiveDocument.Title&"wasnotsaved."

EndSub

OnAfterSubViewChangeEventOccursaftertheWebwindowsubviewchanges.

PrivateSubexpression_OnAfterSubViewChange()

expressionAvariablenamewhichreferencesanobjectoftypeWebWindowExdeclaredusingtheWithEventskeywordinaclassmodule.

Example

ThefollowingexampledisplaysamessagetotheuserwheneverthesubviewoftheactiveWebsitewindowchangesorafterthesubviewcloses.

PrivateSubobjWebWindow_OnAfterSubViewChange()

'Displayamessageindicatingwhichviewthesubwindowiscurrentlyin

SelectCaseobjwebWindow.SubViewMode

CasefpWebSubViewFolders

MsgBox"TheviewinthesubwindowhaschangedtoFolderView."

CasefpWebSubViewNavigation

MsgBox"TheviewinthesubwindowhaschangedtoNavigationView."

CasefpWebSubViewNone

MsgBox"Thesubwindowhasclosed."

EndSelect

EndSub

OnAfterViewChangeEventOccursaftertheviewhaschangedintheactivepagewindoworWebsitewindow.

PrivateSubexpression_OnAfterViewChange()

expressionAvariablenamewhichreferencesanobjectintheAppliesTolistdeclaredusingtheWithEventskeywordinaclassmodule.

Example

Thefollowingexampledisplaysthenameofthenewpagewindowviewmode.

PrivateSubPageWindowEx_OnAfterViewChange()

'Occurswhentheviewchangesintheactivewindow

MsgBox"Thepagehaschangedto"&PageWindowEx.ViewMode&"."

EndSub

OnAfterWebPublishEventOccursafteraWebsiteispublished.

PrivateSubexpression_OnAfterWebPublish(ByValpWebAsWebEx,SuccessAsBoolean)

expressionAvariablenamewhichreferencesanobjectintheAppliesTolistdeclaredusingtheWithEventskeywordinaclassmodule.

pWebRequiredWebEx.ThespecifiedWebExobject.

SuccessRequiredBoolean.TrueifthespecifiedWebwassuccessfullypublished.

Remarks

TheOnAfterWebPublisheventisassociatedwiththeApplicationobject.AftertheuserpublishesaWebsiteinMicrosoftFrontPage,theOnAfterWebPublisheventfiresandexecutesthecodethatyouspecifiedwithintheeventprocedure.

Example

Thefollowingexamplecreatesapropertycalled"Published"withthevalueofTrueafteraWebsitehasbeenpublished.

NoteTorunthisexampleyoumusthaveoneWebsiteopen.ThisexampleusesaWebsitecalledRogueCellars.YoucancreateaWebsitecalledRogueCellars,oryoucansubstituteaWebsiteofyourchoiceinthefollowingcodesample.

CreateaformcalledfrmLaunchEvents.frmandaddtwocommandbuttons,abuttoncalledcmdPublishWeb,andabuttoncalledcmdCancel.Thenaddthefollowingcodetotheformcodewindow.

OptionExplicit

PrivatepPageAsPageWindowEx

EndSub

PrivateSubcmdPublishWeb_Click()

ActiveWeb.Publish"C:\MyDocuments\MyWebSites\RogueCellars"

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnAfterWebPublish(ByValpWebAsWebEx,SuccessAsBoolean)

IfSuccess=TrueThen

pWeb.Properties.Add"Published",True

pWeb.Properties.ApplyChanges

MsgBox"Therewasaproblempublishingyour"&pWeb&"web."

EndSub

OnAfterWebWindowSubViewChangeEventOccursaftertheFolderListintheWebviewsubwindowhaschangedfromFoldersviewtoNavigationview.

PrivateSubapplication__OnAfterWebWindowSubViewChange(ByValpWebWindowAsWebWindowEx)

applicationAnobjectoftypeApplicationdeclaredwitheventsinaclassmodule.

pWebWindowTheWebWindowExobjectinwhichtheviewhaschanged.

Example

Thefollowingexampledisplaysthenameoftheviewtypeinthesubwindow,unlessthesubwindowisclosedbytheuser.

PrivateSubobjApp_OnAfterWebWindowSubViewChange(ByValpWebWindowAsWebWindowEx

'OccurswhenasubviewintheWebwindowchanges

'Displayamessageindicatingwhatviewthesubwindowiscurrentlyin

SelectCasepWebWindow.SubViewMode

CasefpWebSubViewFolders

MsgBox"TheviewinthesubwindowhaschangedtoFolderView."

CasefpWebSubViewNavigation

MsgBox"TheviewinthesubwindowhaschangedtoNavigationView."

CasefpWebSubViewNone

MsgBox"Thesubwindowhasclosed."

EndSelect

EndSub

OnAfterWebWindowViewChangeEventOccursaftertheWebsitewindowviewhaschanged.

PrivateSubexpression_OnAfterWebWindowViewChange(ByValpWebWindowAsWebWindowEx)

pWebWindowTheWebWindowExobjectinwhichtheviewhaschanged.

Example

Thefollowingexampledisplaysthenameofthenewviewtypetotheusereverytimetheviewischanged.

PrivateSubobjApp_OnAfterWebWindowViewChange(ByValpWebWindowAsWebWindowEx)

'OccursaftertheWebsitewindowviewchanges.

MsgBox"Theviewhaschangedto"&pWebWindow.ViewModeEx&"mode."

EndSub

OnBeforePageSaveEventOccursbeforeapageissaved.

PrivateSubexpression_OnBeforePageSave(ByValpPageAsPageWindowEx,SaveAsUIAsBoolean,CancelAsBoolean

pPageRequiredPageWindowEx.ThespecifiedPageWindowExobject.

SaveAsUIRequiredBoolean.TruewhentheSaveAsdialogboxisusedtosaveapage.Thiscanbethefirsttimethepageissavedorwhenthepageissavedasanewpage.Falsewhenwhenanexistingpageissaved.

CancelRequiredBoolean.CausesMicrosoftFrontPagetoabortthesavewhensettoTrue.WhenCancelisprogrammaticallysettoTrue,theusercanabortthesaveprocessbyclickingtheCancelbuttonontheform.DefaultisFalse.

Remarks

TheOnBeforePageSaveeventisassociatedwiththeApplicationobject.WhentheusersavesapageorclosesFrontPage,theOnBeforePageSaveeventfiresandexecutesthecodethatyouspecifiedwithintheeventprocedure.

NoteIfyousetCanceltoTrue,thepagewon'tbesaved.

Example

Thefollowingexampledisplaysamessageboxbeforethepagehasbeensavedanddisplaysthedocumenttitleofthefileforthepage.

NoteTorunthisexample,youmusthaveatleastoneopenWebsiteandoneopenpagewithinthatsite.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdSave,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdSave_Click()

myPageWindow.Save

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnBeforePageSave(ByValpPageAs_

PageWindowEx,SaveAsUIAsBoolean,CancelAsBoolean)

MsgBox"Thefollowingpagewillbesaved:"&pPage.File.Name_

&"willbesavedwiththetitle:"&pPage.Document.Title

EndSub

OnBeforePageWindowViewChangeEventOccursbeforethecurrentPagewindowviewischanged.

PrivateSubapplication__OnBeforePageWindowViewChange(ByValpPageAsPageWindowEx,ByValTargetViewAsFpPageViewMode,CancelAsBoolean)

applicationAnobjectoftypeApplicationdeclaredusingtheWithEventskeywordinaclassmodule.

pPageThePageWindowExobjectinwhichtheviewhaschanged.

TargetViewThespecifiedtargetwindowtype.

CancelABooleanthatdeterminesiftheeventwillbecancelled.IfFalse,theeventwillnotbecancelled.IfTrue,theeventwillbecancelled.

Remarks

Thiseventcanbecancelled.

Example

Thefollowingexamplepromptstheuserbeforethecurrentviewischanged.TheCancelargumentismodifiedbasedontheuser'sresponse.

PrivateSubobjApp_OnBeforePageWindowViewChange(ByValpPageAsPageWindowEx,_

ByValTargetViewAsFpPageViewMode,CancelAsBoolean)

'Promptstheuserbeforechangingtheviewtype

DimstrAnsAsString

'Promptusertochangeview

strAns=MsgBox("Areyousureyouwanttochangethecurrentview?",_

vbYesNo)

IfstrAns=vbYesThen

'Don'tcancelevent

Cancel=False

'Cancelevent

Cancel=True

EndSub

OnBeforePublishEventOccursbeforeaWebsiteispublished.

PrivateSubexpression_OnBeforePublish(DestinationAsString,CancelAsBoolean)

expressionAvariablenamewhichreferencesanobjectoftypeWebExdeclaredusingtheWithEventskeywordinaclassmodule.

DestinationAStringthatspecifiestheURLofthepublishedWebsite.

CancelABooleanthatspecifieswhethertocancelthepublishoperation.TruecancelspublishingtheWebsite.

Remarks

Thiseventcanbecancelled.

Example

ThefollowingexampledisplaysamessagetotheuserbeforeaWebsiteispublished.Italsoallowstheusertocanceltheeventbeforeitoccurs.

PrivateSubexpression_OnBeforePublish(DestinationAsString,CancelAsBoolean)

'Occursbeforeawebispublished.

DimblnAnsAsBoolean

blnAns=MsgBox_

("Areyousureyouwanttopublishtothefollowingdestination:"&_

Destination)

IfblnAns=FalseThen

Cancel=True

Cancel=False

EndSub

OnBeforeSaveEventOccursbeforeapageinanactiveextendedpagewindowissaved.

PrivateSubexpression_OnBeforeSave(SaveAsUIAsBoolean,CancelAsBoolean)

expressionAvariablenamethatreferencesanobjectoftypePageWindowExdeclaredusingtheWithEventskeywordinaclassmodule.

SaveAsUIABooleanthatdeterminesiftheuserinterfacewillbedisplayed.IfTrue,theSaveAsdialogboxwillbedisplayed.

CancelABooleanthatdeterminesifthesaveoperationwillbecancelled.IfTrue,thedocumentwillnotbesaved.

Example

Thefollowingexamplepromptstheuserbeforesavingthedocument.IftheuserclicksNo,thedocumentwillnotbesaved.IftheuserclicksYes,thedocumentwillbesaved.

PrivateSubPageWindowEx_OnBeforeSave(SaveAsUIAsBoolean,CancelAsBoolean)

'Promptuserbeforesavingthedocument

DimstrAnsAsString

strAns=MsgBox("Doyoureallywanttosavethedocument?",vbYesNo)

'Changecancelvaluebasedonuserinput

IfstrAns=VbNoThen

Cancel=True

EndSub

OnBeforeSubViewChangeEventOccursbeforethesubviewoftheWebsitewindowchanges.

PrivateSubexpression_OnBeforeSubViewChange(ByValTargetSubViewAsFpWebSubView,CancelAsBoolean)

TargetSubViewAnFpWebSubViewenumeratedconstantthatrepresentsthenewsubviewtype.

CancelABooleanthatdeterminesiftheoperationwillbecancelled.IfFalse,thesubviewwillchangeviewtypes.

Example

ThefollowingexamplepromptstheuserbeforechangingthesubviewoftheWebsitewindow.IftheuserclicksNo,thesubviewwillnotchange.IftheuserclicksYes,thesubviewwillchangetoanewviewtype.

PrivateSubobjwebWindow_OnBeforeSubViewChange

(ByValTargetSubViewAsFpWebSubView,CancelAsBoolean)

'Occurswhenthesubviewoftheactivewebwindowischanged

DimstrAnsAsString

'Promptuser

strAns=MsgBox("Areyousureyouwanttochangethesubview?",vbYesNo)

IfstrAns=vbYesThen

Cancel=False

Cancel=True

EndSub

ShowAll

OnBeforeViewChangeEventOnBeforeViewChangeeventasitappliestothePageWindowExobject.

Occursbeforetheviewmodeofthepagewindowchanges.

PrivateSubexpression_OnBeforeViewChange(ByValTargetViewAsFpPageViewMode,CancelAsBoolean)

TargetViewAnFpPageViewModeenumeratedconstantthatrepresentsthenewviewtype.

CancelABooleanthatdeterminesiftheoperationwillbecancelled.IfTrue,theviewwillnotbechanged.

OnBeforeViewChangeeventasitappliestotheWebWindowExobject.

OccursbeforetheviewmodeoftheWebsitewindowchanges.

PrivateSubexpression_OnBeforeViewChange(ByValTargetViewAsFpWebViewModeEx,CancelAsBoolean)

TargetViewAnFpWebViewModeExenumeratedconstantthatrepresentsthenewviewtype.

CancelABooleanthatdeterminesiftheoperationwillbecancelled.IfTrue,theviewwillnotbechanged.

Example

Thefollowingexamplepromptstheuserbeforechangingtheviewofthepagewindow.IftheuserclicksYes,theviewischanged.

PrivateSubPageWindowEx_OnBeforeViewChange(ByValTargetViewAsFpPageViewMode,_

CancelAsBoolean)

'Promptsuserbeforechangingviews

DimblnAnsAsBoolean

strAns=MsgBox("Areyousureyouwanttochangethecurrentview?",_

vbYesNo)

IfstrAns=vbYesThen

Cancel=False

Cancel=True

EndSub

OnBeforeWebPublishEventOccursbeforeaWebsiteispublished.

PrivateSubexpression_OnBeforeWebPublish(ByValpWebAsWebEx,DestinationAsString,CancelAsBoolean)

expressionThevariablenameofanobjectoftypeApplicationdeclaredusingtheWithEventskeywordinaclassmodule.

pWebRequiredWebEx.ThespecifiedWebExobject.

DestinationRequiredString.TheURLofthetargetlocation.

CancelRequiredBoolean.CausesMicrosoftFrontPagetoabortthepublishwhensettoTrue.WhenCancelisprogrammaticallysettoTrue,theusercanabortthesaveprocessbyclickingtheCancelbuttonontheform.DefaultisFalse.

Remarks

TheOnBeforeWebPublisheventisassociatedwiththeApplicationobject.WhentheuserpublishesaWebsiteinFrontPage,theOnBeforeWebPublisheventfiresandexecutesthecodewithintheeventprocedure.

Example

ThefollowingexampleaddsacopyrightstringtotheindexpageofthespecifiedWebsite.

NoteTorunthisexample,youmusthaveatleastoneopenWebsite.ThisexampleusesaWebsitecalledRogueCellars.YoucancreateaWebsitecalledRogueCellarsoryoucansubstituteaWebsiteofyourchoiceinthefollowingcodesample.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdPublishWeb,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdPublishWeb_Click()

ActiveWeb.Publish"C:\MyDocuments\MyWebSites\RogueCellars"

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnBeforeWebPublish(ByValpWebAsWebEx,_

DestinationAsString,CancelAsBoolean)

DimmyIndexFileAsWebFile

SetmyIndexFile=pWeb.RootFolder.Files("index.htm")

myIndexFile.Open

IfmyIndexFile.Application.ActiveDocument.body.outerText<>_

myCopyrightThen

myIndexFile.Application.ActiveDocument.body.insertAdjacentText_

"BeforeEnd",myCopyright

ActivePageWindow.Close

EndSub

OnBeforeWebWindowSubViewChangeEventOccursbeforethesubwindowofthecurrentWebwindowischangedbytheuser.

PrivateSubexpression_OnBeforeWebWindowSubViewChange(ByValpwebwindowAsWebWindowEx,ByValTargetSubViewAsFpWebSubView,CancelAsBoolean)

pWebWindowTheWebWindowExobjectthatcontainsthesubwindow.

TargetSubViewThesubwindowviewtype.

Example

Thefollowingexamplepromptstheuserbeforechangingthecurrentsubwindowview.TheCancelargumentismodifiedbasedontheusers'response.

PrivateSubobjApp_OnBeforeWebWindowSubViewChange(ByValpwebwindowAsWebWindowEx,_

ByValTargetSubViewAsFpWebSubView,CancelAsBoolean)

'Occursbeforethewebwindowsubviewischanged.Promptstheusertoverifythechange

DimstrAnsAsString

'Prompttheuserbeforechangingviews

strAns=MsgBox("Areyousureyouwanttochangethesubwindowview?",_

vbYesNo)

IfstrAns=vbYesThen

'Yes,don'tcanceltheevent

Cancel=False

'No,canceltheevent

Cancel=True

EndSub

OnBeforeWebWindowViewChangeEventOccursbeforetheWebsitewindowviewchanges.

PrivateSubexpression__OnBeforeWebWindowViewChange(ByValpWebWindowAsWebWindowEx,ByValTargetViewAsFpWebViewModeEx,CancelAsBoolean)

pWebWindowTheWebWindowExobjectthatcontainstheview.

TargetViewTheFPWebViewModeExwindowviewtype.

Example

Thefollowingexamplepromptstheuserbeforechangingthecurrentview.TheCancelargumentismodifiedbasedontheusers'response.

PrivateSubobjApp_OnBeforeWebWindowViewChange(ByValpWebWindowAsWebWindowEx,_

ByValTargetViewAsFpWebViewModeEx,CancelAsBoolean)

'Occursbeforetheviewischangedinthewebwindow.Promptstheusertoverifythechange

DimstrAnsAsString

'Prompttheuserbeforechangingviews

strAns=MsgBox("Areyousureyouwanttochangetheviewmode?",_

vbYesNo)

IfstrAns=vbYesThen

'Yes,don'tcanceltheevent

Cancel=False

'No,canceltheevent

Cancel=True

EndSub

ShowAll

OnCloseEventOnCloseeventasitappliestothePageWindowExobject.

Occurswhentheactivepagewindowisclosedbytheuser.

PrivateSubexpression_OnClose(CancelAsBoolean)

CancelABooleanthatdeterminesiftheoperationwillbecancelled.Truecancelsclosingtheactivepagewindow.

OnCloseeventasitappliestotheWebExobject.

OccurswhentheactiveWebsitewindowisclosedbytheuser.

PrivateSubexpression_OnClose(pCancelAsBoolean)

expressionAvariablenamewhichreferencesanobjectoftypeWebExdeclaredusingtheWithEventskeywordaclassmodule.

CancelABooleanthatdeterminesiftheoperationwillbecancelled.TruecancelsclosingtheactiveWebsite.

Example

Thefollowingexamplepromptstheuserbeforeclosingtheactivepagewindow.IftheuserclicksNo,thewindowwillnotclose.

PrivateSubPageWindowEx_OnClose(CancelAsBoolean)

'Displaysamessage

DimstrAnsAsString

'Promptuser

strAns=MsgBox("Areyousureyouwanttoclosetheactivepagewindow?",_

vbYesNo)

IfstrAns=vbYesThen

Cancel=False

Cancel=True

EndSub

OnDeactivateEventOccurswhenauserswitchestoanotherapplicationwindowandtheactiveWebsitewindowlosesthefocus.

PrivateSubexpression_OnDeactivate()

Example

Thefollowingexampledisplaysamessagetotheuserwhenthewindowisdeactivated.

PrivateSubobjWebWindow_OnDeactivate()

'Occurswhenthecurrentwebwindowisdeactivated

MsgBox"Thewindowhasbeendeactivated."

EndSub

OnPageCloseEventOccurswhenapageisclosed.

PrivateSubexpression_OnPageClose(ByValpPageAsPageWindowEx,CancelAsBoolean)

pPageRequiredPageWindowEx.ThespecifiedPageWindowExobject.

CancelRequiredBoolean.CausesMicrosoftFrontPagetoaborttheclosewhensettoTrue.WhenCancelisprogrammaticallysettoTrue,theusercanabortthesaveprocessbyclickingtheCancelbuttonontheform.DefaultisFalse.

Remarks

TheOnPageCloseeventisassociatedwiththeApplicationobject.WhentheuserclosesaPageWindowExobject,theOnPageCloseeventfiresandexecutesthecodewithintheeventprocedure.

Example

ThefollowingexampleusestheIsDirtypropertytocheckifapagehasbeenmodified,andifithassavesthepagebeforeclosingit.

NoteTorunthisexample,youmusthaveatleastoneopenWebsiteandoneopenpagewithinthatWebsite.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdClosePage,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdClosePage_Click()

ActivePageWindow.Close

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnPageClose(ByValpPageAs_

PageWindowEx,CancelAsBoolean)

IfpPage.IsDirty=TrueThenpPage.Save

EndSub

OnPageNewEventOccurswhenanewpageiscreated.

PrivateSubexpression_OnPageNew(ByValpPageAsPageWindowEx)

pPageRequiredPageWindowEx.APageWindowExobject.

Remarks

Whentheusercreatesanewpagewithinaframeset,theOnPageNeweventisonlyfiredonce—whenthepagecontainingtheframesettagsisopened.ThenMicrosoftFrontPageexecutesthecodewithintheeventprocedure.

NoteTheOnPageNeweventonlyfiresforthedefaultframeset,eveniftherearemoreframesonthepage.ThiseventonlyfiresifFrontPageisinPageview.IfFrontPageisinanyotherview,theOnPageNeweventwon'tfire.

Example

Thefollowingexampleappliesathemetoanewpage.

NoteTorunthisexample,youmusthaveatleastoneopenWebsite.ThisexampleusesRogueCellarsasthespecifiedWebsiteandZinfandel.htmasthespecifiedpage.YoucancreateaWebsiteandpageusingthesenamesoryoucansubstituteaWebsiteandpageofyourchoice.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdAddPage,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdAddPage_Click()

DimmyFileAsString

myFile=_

"C:/MyDocuments/MyWebSites/RogueCellars/Zinfandel.htm"

myPageWindows.Add(myFile)

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnPageNew(ByValpPageAsPageWindowEx)

pPage.ApplyTheme("artsy")

EndSub

OnPageOpenEventOccurswhenapageisopened.

PrivateSubexpression_OnPageOpen(ByValpPageAsPageWindowEx)

pPageRequiredPageWindowEx.APageWindowExobject.

Remarks

TheOnPageOpeneventisassociatedwiththeApplicationobject.Whentheuseropensapage,MicrosoftFrontPageopenstheframesetforthepageandfirestheOnPageOpeneventforthedefaultframeset.ThenFrontPageexecutesthecodethatyouspecifiedwithintheeventprocedure.

NoteTheOnPageOpeneventonlyfiresforthedefaultframeset,eveniftherearemoreframesonthepage.TheOnPageOpeneventonlyfiresifthepageisnotopen.

Example

ThefollowingexamplechangesthetitleoftheFPHTMLDocumentobject,whenthedocumentisopenedinaPageWindowExobject.

NoteTorunthisexample,youmusthaveatleastoneopenWebsite.ThisexampleusesRogueCellarsasthespecifiedWebsiteandZinfandel.htmasthespecifiedpage.YoucancreateaWebsiteandpageusingthesenamesoryoucansubstituteaWebsiteandpageofyourchoice.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdAddPage,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdAddPage_Click()

DimmyFileAsString

myFile=_

"C:/MyDocuments/MyWebSites/RogueCellars/Zinfandel.htm"

myPageWindows.Add(myFile)

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnPageOpen(ByValpPageAs_

PageWindowEx)

SetmyDoc=pPage.ActiveDocument

myDoc.Title="RogueCellarsHomePage"

EndSub

OnPageWindowActivateEventOccurswhenthepageinthecurrentwindowobtainsthefocus.

PrivateSubexpression_OnPageWindowActivate(ByValpPageAsPageWindowEx)

pPageThePageWindowExobjectthatcontainstheview.

Example

Thefollowingexamplepromptstheusertorefreshthepageeachtimethepagewindowobtainsthefocus.

PrivateSubobjApp_OnPageWindowActivate(ByValpPageAsPageWindowEx)

'Occurswhencurrentpageinthemainwindowobtainsfocus.

'Promptstheusertorefreshthecurrentpage.

DimstrAnsAsString

strAns=MsgBox("Doyouwanttorefreshthepage"&pPage.Caption&"?",_

vbYesNo)

IfstrAns=vbYesThen

pPage.Refresh

EndSub

OnRecalculateHyperlinksEventOccursbeforethehyperlinkstructureinHyperlinksviewisrecalculatedtoviewanychangesmadetotheWebsite.

PrivateSubexpression_OnRecalculateHyperlinks(ByValpWebAsWebEx,CancelAsBoolean)

pWebTheWebExobjectthatcontainstheview.

Example

Thefollowingexamplepromptstheuserbeforerecalculatingthehyperlinkstructure.Iftheuseraccepts,theeventwillcontinueandthehyperlinkswillberecalculated.

PrivateSubobjApp_OnRecalculateHyperlinks(ByValpWebAsWebEx,CancelAsBoolean)

'Occurswhenthecurrentweb'shyperlinksarerecalculated.

DimstrAnsAsString

strAns=MsgBox("Thisactionwillcausethehyperlinksstructuretoberecalculated."_

&"Doyouwanttocontinue?",vbYesNo)

'SetvalueofCancelargumenttousers'response

IfstrAns=vbYesThen

Cancel=False

Cancel=True

EndSub

OnWebCloseEventOccurswhenaWebsiteisclosed.

PrivateSubexpression_OnWebClose(ByValpWebAsWebEx,CancelAsBoolean)

pWebRequiredWebEx.AWebExobject.

CancelRequiredBoolean.Trueiftheclosingprocesswascancelledthroughtheuserinterface,orifCancelwassettoTrue.DefaultisFalse.

Remarks

TheOnWebCloseeventisassociatedwiththeApplicationobject.WhenyoucloseaWebsite,theOnWebCloseeventfiresandexecutesthecodethatyouspecifiedwithintheeventprocedure.

Example

Thefollowingexampleiteratesthroughtheopenpagesand,ifnecessary,savesthembeforetheWebsiteisclosed.

NoteTorunthisexample,youmusthaveatleastoneopenWebsiteandoneopenpagewithinthatWebsite.ThisexampleusesRogueCellarsasthespecifiedWebsite.YoucancreateaWebsitecalledRogueCellarsorsubstituteaWebsiteofyourchoice.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdCloseWeb,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdCloseWeb_Click()

Webs("C:/MyDocuments/MyWebSites/RogueCellars").Close

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnWebClose(ByValpWebAsWebEx,_

CancelAsBoolean)

SetmyPageWindows=pWeb.ActiveWebWindow.PageWindows

ForEachmyPageWindowInmyPageWindows

EndSub

ShowAll

OnWebFileCheckOutEventOccurswhenafileinthecurrentWebsiteischeckedout.

PrivateSubexpression_OnWebFileCheckOut(ByValpWebAsWeb,ByValpFileAsWebFile,CheckedOutAsBoolean,pCheckOutOptionAsFpCheckOutOption)

expressionThevariablenamethatreferencesanobjectoftypeApplicationdeclaredusingtheWithEventskeywordinaclassmodule.

pWebThecurrentWebExobjectthatcontainsthefile.

pFileTheWebFilebeingcheckedout.

CheckedOutABooleanthatindicatesthestatusofthefile.IfTrue,thefileischeckedout.IfFalse,thefilehasnotbeencheckedout.

pCheckOutoptionFpCheckOutOption.Specifiesthecheckoutfileoption.

FpCheckOutOptioncanbeoneoftheseFpCheckOutOptionconstants.FPCheckOutDefault.Checkthefileout.FPCheckOutCancelCancelthefilecheckout.FPCheckOutReadOnlyChecksoutaread-onlyversionofthefile.FPCheckOutPromptUserPromptstheuserbeforecheckingoutthefile.

Example

Thefollowingexamplepromptstheuserbeforethefileischeckedout.

PrivateSubobjApp_OnWebFileCheckOut(ByValpWebAsWeb,ByValpFileAsWebFile,

_CheckedOutAsBoolean,_

pCheckOutOptionAsFpCheckOutOption)

'Occurswhenafileinthecurrentwebischeckedout.

'Prompttheuserbeforecheckingoutthefile

pCheckOutOption=fpCheckOutPromptUser

EndSub

OnWebNewEventOccurswhenanewWebsiteiscreated.

PrivateSubexpression_OnWebNew(ByValpWebAsWeb)

Remarks

TheOnWebNeweventisassociatedwiththeApplicationobject.WhentheusercreatesanewWebsiteinMicrosoftFrontPage,theOnWebNeweventfiresandexecutesthecodewithintheeventprocedure.

Example

ThefollowingexamplecreatesatemporaryWebsiteandaddsanewfile.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdCreateWeb,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdCreateWeb_Click()

Webs.Add("C:/MyDocuments/MyWebSites/TempWeb")

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnWebNew(ByValpWebAsWeb)

DimmyFileAsWebFile

SetmyFile=pWeb.RootFolder.Files.Add("index.htm")

myFile.Open

EndSub

OnWebOpenEventOccurswhenaWebsiteisopened.

PrivateSubexpression_OnWebOpen(ByValpWebAsWeb)

Remarks

TheOnWebOpeneventisassociatedwiththeApplicationobject.WhentheuseropensaWebsiteinMicrosoftFrontPage,theOnWebOpeneventfiresandexecutesthecodethatyouspecifiedwithintheeventprocedure.

Example

ThefollowingexampleopenstheIndex.htmfilewhenaWebsiteisopened.

NoteThisexampleusesRogueCellarsasthespecifiedWebsitetobeopened.YoucancreateaWebsitecalledRogueCellarsoryoucansubstituteaWebsiteofyourchoice.

CreateaformcalledfrmLaunchEvents.frmandaddtwobuttons,abuttoncalledcmdOpenWeb,andabuttoncalledcmdCancel.Addthefollowingcodetotheformcodewindow.

OptionExplicit

EndSub

PrivateSubcmdOpenWeb_Click()

Webs.Open("C:/MyDocuments/MyWebSites/RogueCellars")

EndSub

'Hidetheform.

ExitSub

EndSub

PrivateSubeFPApplication_OnWebOpen(ByValpWebAsWeb)

DimmyFileAsWebFile

SetmyFile=pWeb.RootFolder.Files.Add("index.htm")

myFile.Open

EndSub

WindowActivateEventOccurswhenawindowisactivated.

PrivateSubexpression_WindowActivate(ByValpWebWindowAsWebWindowEx)

pWebWindowTheWebWindowExobject.

Remarks

WhenaninstanceofMicrosoftFrontPageobtainsthefocus,aWindowActivateeventwillfireforeachopenwindow.

Example

ThefollowingexamplepromptstheusertoclosethewindowwhentheFrontPagewindowobtainsthefocus.

PrivateSubexpression_WindowActivate(ByValpWebWindowAsWebWindowEx)

'OccurswhenaFrontPagewindowobtainsfocus.

DimstrAnsAsString

strAns=MsgBox("Areyousureyouwanttoopenthewindow"_

&pWebWindow.Caption&"?",_

vbYesNo)

IfstrAns=vbNoThen

pWebWindow.Close

EndSub

WindowDeactivateEventOccurswhenaWebwindowisdeactivated.

PrivateSubexpression_WindowDeactivate(ByValpWebWindowAsWebWindowEx)

expressionThevariablenameofanobjectoftypeApplicationdeclaredwitheventsinaclassmodule.

pWebWindowTheWebWindowExobject.

Example

Thefollowingexamplepromptstheusertoclosethewindowwhenthewindowlosesthefocus.

PrivateSubexpression_WindowDeactivate(ByValpWebWindowAsWebWindowEx)

'OccurswhenaMicrosoftFrontPagewindowlosesfocus.

DimstrAnsAsString

strAns=MsgBox("Doyouwanttoclosethiswindow?"_

&pWebWindow.Caption&"?",_

vbYesNo)

IfstrAns=vbYesThen

pWebWindow.Close

EndSub

ShowAll

FrontPageWebObjectModelEnumeratedConstantsThistopicprovidesalistofallenumeratedconstantsintheMicrosoftFrontPageWebObjectModel.

FpCheckOutOption

Constant ValuefpCheckOut 1fpCheckOutCancel 3fpCheckOutPromptUser 0fpCheckOutReadOnly 2

FpChoiceFieldFormat

Constant ValuefpChoiceFieldCheckBoxes 2fpChoiceFieldDropdown 0fpChoiceFieldRadioButtons 1

FpConnectionSpeed

Constant ValuefpConnect1000K 9fpConnect128K 3fpConnect144 0fpConnect1500K 4fpConnect256K 6fpConnect288 1fpConnect384K 7fpConnect512K 8

fpConnect56K 2fpConnectISDN 3fpConnectT1 4fpConnectT3 5

FpCurrencyFieldFormat

Constant ValuefpCurrencyFieldAlgerian 5121fpCurrencyFieldArgentina 11274fpCurrencyFieldAustralia 3081fpCurrencyFieldAustria 3079fpCurrencyFieldBahraini 15361fpCurrencyFieldBelgiumBF 2067fpCurrencyFieldBelgiumFB 2060fpCurrencyFieldBolivia 16394fpCurrencyFieldBrazil 1046fpCurrencyFieldCanada 4105fpCurrencyFieldCanadaF 3084fpCurrencyFieldChile 13322fpCurrencyFieldColombia 9226fpCurrencyFieldCostaRica 5130fpCurrencyFieldCzech 1029fpCurrencyFieldDenmark 1030fpCurrencyFieldDominicanRepublic 7178fpCurrencyFieldEcuador 12298fpCurrencyFieldEgyptian 3073fpCurrencyFieldElSalvador 17418fpCurrencyFieldEuro -1fpCurrencyFieldEuroPostfix -2fpCurrencyFieldFinland 1035fpCurrencyFieldFrance 1036fpCurrencyFieldGermany 1031

fpCurrencyFieldGreece 1032fpCurrencyFieldGuatemala 4106fpCurrencyFieldHonduras 18442fpCurrencyFieldHongKong 3076fpCurrencyFieldHungary 1038fpCurrencyFieldIndian 1081fpCurrencyFieldIranian 1065fpCurrencyFieldIraqi 2049fpCurrencyFieldIreland 6153fpCurrencyFieldIsraeli 1037fpCurrencyFieldItaly 1040fpCurrencyFieldJapan 1041fpCurrencyFieldJordanian 11265fpCurrencyFieldKorea 1042fpCurrencyFieldKuwaiti 13313fpCurrencyFieldLebanese 12289fpCurrencyFieldLibyan 4097fpCurrencyFieldMexico 2058fpCurrencyFieldMoroccan 6145fpCurrencyFieldNetherlands 1043fpCurrencyFieldNewZealand 5129fpCurrencyFieldNicaragua 19466fpCurrencyFieldNorway 1044fpCurrencyFieldOmani 8193fpCurrencyFieldPakistani 1056fpCurrencyFieldPanama 6154fpCurrencyFieldParaguay 15370fpCurrencyFieldPeru 10250fpCurrencyFieldPoland 1045fpCurrencyFieldPortugal 2070fpCurrencyFieldPRChina 2052fpCurrencyFieldQatari 16385fpCurrencyFieldRussia 1049

fpCurrencyFieldSaudiArabian 1025fpCurrencyFieldSingapore 4100fpCurrencyFieldSlovakia 1051fpCurrencyFieldSlovenia 1060fpCurrencyFieldSouthAfrica 7177fpCurrencyFieldSpain 1034fpCurrencyFieldSweden 1053fpCurrencyFieldSwitzerland 2055fpCurrencyFieldSyrian 10241fpCurrencyFieldTaiwan 1028fpCurrencyFieldThai 1054fpCurrencyFieldTunisian 7169fpCurrencyFieldTurkey 1055fpCurrencyFieldUAE 14337fpCurrencyFieldUnitedKingdom 2057fpCurrencyFieldUnitedStates 1033fpCurrencyFieldUruguay 14346fpCurrencyFieldVenezuela 8202fpCurrencyFieldVietnamese 1066fpCurrencyFieldYemeni 9217

FpDateTimeFieldFormat

Constant ValuefpDateTimeFieldDateAndTime 0fpDateTimeFieldDateOnly 1

FpDependencyFlags

Constant ValuefpDepsDefault 255fpDepsImages 2fpDepsLinkbars 16fpDepsLinks 1

fpDepsLists 4fpDepsNavbars 32fpDepsNone 0fpDepsRecurse 256fpDepsSharedBorders 128fpDepsThemes 8fpDepsWebParts 64

FpFieldType

Constant ValuefpFieldAttachments 13fpFieldChoice 5fpFieldComputed 11fpFieldCounter 9fpFieldCurrency 3fpFieldDateTime 4fpFieldFile 12fpFieldInteger 10fpFieldLookup 6fpFieldMultiLine 1fpFieldNumber 2fpFieldRatingScale 14fpFieldSingleLine 0fpFieldTrueFalse 7fpFieldURL 8

FpFolderType

Constant ValuefpFolderDHTMLSharedLib 1

FpListDesignSecurity

Constant ValuefpListDesignSecurityCreator 1fpListDesignSecurityEveryone 0

FpListEditSecurity

Constant ValuefpListEditSecurityAll 0fpListEditSecurityNone 2fpListEditSecurityOnlyOwn 1

FpListReadSecurity

Constant ValuefpListReadSecurityAll 0fpListReadSecurityOnlyOwn 1

FpListType

Constant ValuefpListTypeBasicList 0fpListTypeDiscussion 3fpListTypeDocumentLibrary 2fpListTypeSurvey 1

FpNumberFieldFormat

Constant ValuefpNumberFieldAuto -1fpNumberFieldFiveDecimals 5fpNumberFieldFourDecimals 4fpNumberFieldInteger 0fpNumberFieldOneDecimal 1fpNumberFieldThreeDecimals 3

fpNumberFieldTwoDecimals 2

FpOptimizeHTMLFlags

Constant ValuefpHtmlOptAdjacentTags 64fpHtmlOptAuthorComponents 8fpHtmlOptBots 8fpHtmlOptBrowseComponents 131072fpHtmlOptCellFormattingAttr 256fpHtmlOptDreamWeaver 2fpHtmlOptDwtCmnts 1024fpHtmlOptEmpty 32fpHtmlOptGenerator 16fpHtmlOptHTMLAllWhitespace 16384fpHtmlOptHTMLCmnts 4096fpHtmlOptHTMLLeadWhitespace 8192fpHtmlOptHTMLMisnest 32768fpHtmlOptOn -2147483648fpHtmlOptScriptCmnts 2048fpHtmlOptThemes 4fpHtmlOptTrcImageAttr 512fpHtmlOptUnusedStyles 65536fpHtmlOptVMLGraphics 128fpHtmlOptWordHTML 1

FpPageViewMode

Constant ValuefpPageViewDefault 0fpPageViewHtml 2fpPageViewInBetween 512fpPageViewInvalid -1fpPageViewNoFrames 4

fpPageViewNormal 1fpPageViewNoWindow 128fpPageViewPreview 8fpPageViewPrintPreview 256fpPageViewSplit 16fpPageViewText 32fpPageViewXml 64

FpPkgImportConflictOpts

Constant ValuefpPkgFileConflictMask 15fpPkgListConflictMask 240fpPkgOnConflictSkip 17fpPkgOnConflictStop 0fpPkgOnFileConflictOverwrite 2fpPkgOnFileConflictSkip 1fpPkgOnFileConflictStop 0fpPkgOnListConflictMergeOrRename 64fpPkgOnListConflictMergeOrSkip 48fpPkgOnListConflictMergeOrStop 32fpPkgOnListConflictRename 80fpPkgOnListConflictSkip 16fpPkgOnListConflictStop 0

FpPkgImportResult

Constant ValuefpPkgImportCancelled 2fpPkgImportComplete 0fpPkgImportErrorInPackage 3fpPkgImportFailed 1fpPkgImportNotTrusted 5fpPkgImportServerNotSupported 6

fpPkgImportStopped 4

FpPkgTrustLevel

Constant ValuefpPkgTrustAll 1fpPkgTrustCertificateStore 2

FpSharedBorders

Constant Value_fpBorderNone 0fpBorderAll 255fpBorderBottom 8fpBorderLeft 2fpBorderRight 4fpBorderTop 1

FpStructModType

Constant ValuefpStructBaseOnSibling 0fpStructLeftmostChild 1fpStructRightmostChild 2

FpThemeProperties

Constant ValuefpThemeActiveGraphics 16fpThemeBackgroundImage 1fpThemeCSS 4096fpThemeDefaultSettings 16777216fpThemeName 33554432fpThemeNoBackgroundImage 0

fpThemeNoCSS 0fpThemeNormalColors 0fpThemeNormalGraphics 0fpThemePropertiesAll 4369fpThemePropertiesNone 0fpThemeVividColors 256

FpURLComponent

Constant ValuefpURLComponentBookmark 256fpURLComponentFileExtension 128fpURLComponentFileName 64fpURLComponentPassword 4fpURLComponentPath 32fpURLComponentPort 16fpURLComponentQuery 512fpURLComponentScheme 1fpURLComponentServer 8fpURLComponentUserName 2

FpURLFieldFormat

Constant ValuefpURLFieldImage 1fpURLFieldLink 0

FpWebDeleteFlags

Constant ValuefpDeleteEntireWeb 0fpDeleteFrontPageInfoFromWeb 1

FpWebOpenFlags

Constant ValuefpOpenInWindow 0fpOpenNoWindow 2

FpWebPublishFlags

Constant ValuefpPublishAddToExistingWeb 2fpPublishCopyAllFiles 64fpPublishCopySubwebs 4fpPublishIncremental 1fpPublishLogInTempDir 8fpPublishNoDeleteUnmatched 16fpPublishNone 0fpPublishRemoteToLocal 128fpPublishSynchronize 256fpPublishUseLastPublishTime 32fpPublishUsingDav 512fpPublishUsingPassiveFtp 1024

FpWebSubView

Constant ValuefpWebSubViewFolders 1fpWebSubViewNavigation 2fpWebSubViewNone 0

FpWebViewMode

Constant ValuefpWebViewAllFiles 4fpWebViewBrokenLinks 6fpWebViewFolders 1fpWebViewLinks 0

fpWebViewPage 3fpWebViewRemoteSite 8fpWebViewSiteSummary 7fpWebViewStructure 2fpWebViewTodo 5

FpWebViewModeEx

Constant ValuefpWebViewExAccessibility 37fpWebViewExAllFiles 4fpWebViewExAssignedTo 13fpWebViewExBrokenLinks 6fpWebViewExBrowserTypes 29fpWebViewExCategories 17fpWebViewExCheckoutStatus 16fpWebViewExComponentErrors 18fpWebViewExCSSLinks 33fpWebViewExDailyPageHits 19fpWebViewExDailySummary 22fpWebViewExFolders 1fpWebViewExLinks 0fpWebViewExMasterPages 32fpWebViewExMonthlyPageHits 21fpWebViewExMonthlySummary 24fpWebViewExNavigation 2fpWebViewExOlderFiles 8fpWebViewExOsTypes 28fpWebViewExPage 3fpWebViewExPublishStatus 15fpWebViewExRecentlyAddedFiles 9fpWebViewExRecentlyChangedFiles 10fpWebViewExReferringDomains 25

fpWebViewExReferringURLs 26fpWebViewExRemoteSite 34fpWebViewExReviewStatus 14fpWebViewExSearchStrings 27fpWebViewExSharedBorders 36fpWebViewExSiteSummary 7fpWebViewExSlowPages 11fpWebViewExThemes 35fpWebViewExTodo 5fpWebViewExUnlinkedFiles 12fpWebViewExUsageSummary 31fpWebViewExVisitingUsers 30fpWebViewExWeeklyPageHits 20fpWebViewExWeeklySummary 23

documentation.help · BasicList ListFields Web Lists NavigationNode WebFile NavigationNodes...

Documents

Transcript of documentation.help · BasicList ListFields Web Lists NavigationNode WebFile NavigationNodes...

Moon component - documentation.help · algorithms the book "Calendrical Calculations" by Nachum Dershowitz and Edward M. Reingold. For updates and a listing of bugs (often with patches

The Bahamas State of the Environment Reportbest.gov.bs/Documents/GEO Bahamas 2005 Report (webfile).pdf · Acknowlegements ii Foreword iii Introduction vii Chapter 1 Socio-Economic

NSIS Users Manual - documentation.help · Appendix F: Changelog and Release Notes 3.02 Changelog Major Changes Minor Changes Translations 3.01 Changelog Major Changes Minor Changes

LibUsbDotNet 2.2.8Introduction C# - documentation.help · C# LibUsbDotNet 2.2.8Introduction LibUsbDotNet is a .NET C# USB library for WinUsb, libusb-win32, and Linux libusb v1.x developers.

ADR effect on WebFile - Attorney - About the Commissionvwc.state.va.us/sites/default/files/documents/ADR-Effect-on-WebFile.pdf · In general, any communication made in or in connection

Transferring Bank Match Files to the Massachusetts ... · PDF fileTransferring Bank Match Files to the Massachusetts Department of Revenue ... state.ma.us/webfile/business ... like

Visual Basic Scripting - documentation.help · Microsoft® Visual Basic® Scripting Edition Looping Through Code VBScript Tutorial Previous Next Using Loops to Repeat Code Looping

AutoCAD 2008 ÍøÂç¹ÜÀíÔ±ÊÖ²á - documentation.help fileAutoCAD 2008 > > > Autodesk lmtools.exe LMTOOLS 1. “” (Windows XP & 2000) “”“” “Autodesk” “Network

NI DataSocket Server Help - documentation.help · from National Instruments FieldPoint modules, National Instruments LabVIEW Datalogging and Supervisory Control (DSC) Module processes,

Still filing paper? WebFile instead! - Mass.Gov filing paper? WebFile instead! ... What Is E-File? ... filed their state income tax returns in the Commonwealth.

Webfolders on a pc

Internship Report Format - Adnan Menderes Universityakademik.adu.edu.tr/fakulte/muhendislik/webfolders/S01.pdf · ADNAN MENDERES UNIVERSITY . FACULTY OF ENGINEERING . Internship Report

WebFile Guide for Claimants

Struts 2.0(i18n) //documentation.help/Struts-2.0-cn/documentation.pdf · Struts 1.xStruts 2.0Tag Library Struts 1.x Struts 2.0 HTMLTiles LogicBean URI“/struts-tags” UIUI expression

Microsoft ActiveX Data Objects 2.5 (ADO) - documentation.help · object represents a folder of documents, the document source provider populates those objects with a unique set of

Cyber Incident Response Plan - Roane State Community College › webfolders › SCHUTTEA › Roane State … · the notification process to TBR, establishing a call center and post

Release Notes - Portal WebFILE/PET_Enhance_Releas… · Web viewSoftware Version 15.0.2 Prepared for AASBS by TechFlow, Inc. Version 1.0 October 02, 2014 Table of Contents 1.0Task

XIAOMI CORPORATION 2018 INTERIM REPORTi01.appmifile.com/webfile/globalweb/company/ir/... · 4. Internet services Revenue from our internet services segment grew 63.6% year-on-year

sempozyum program katlamalı 10052017 convdarbesempozyumu.adu.edu.tr/webfolders/topics/spk.pdf · Title: sempozyum program katlamalı 10052017_conv.cdr Author: PC Created Date: 5/15/2017

AutoLISP Developer's Guide - documentation.help · AutoLISP Developer's Guide > Introduction > AutoLISP and Visual LISP > What Visual LISP Offers During the development cycle of an