Microsoft Office InfoPath 2003 Developer's ReferenceSchema.xsd The XML Schema files that are used to...

ShowAll

AbouttheInfoPathDeveloper'sReference

TheInfoPathDeveloper'sReferencecontainsHelpinthefollowingareas:

ProgrammingConceptsContainsconceptualinformationaboutMicrosoftOfficeInfoPath2003formdevelopment.Subjectareasincludeformarchitecture,theformdefinition(.xsf)file,theprogrammingenvironment,andusingtheInfoPathobjectmodel.

DeveloperSampleFormsContainsdocumentationforasetofformsdesignedtodemonstratevariousdevelopmenttechniquesforcustomizingandimplementingInfoPathfeatures.

InfoPathObjectModelReferenceContainsdocumentationfortheInfoPathobjectmodel,includingallofitscollections,objects,properties,methods,events,andenumerations.

InfoPathXSFReferenceContainsdocumentationfortheInfoPath.xsffile,includingallofitsnamespaces,types,groups,elements,andattributes.

ShowAll

AboutActiveXcontrols

YoucanhostActiveXcontrolsinforms.Thesecontrolscanbepreexisting(withsomeconstraints)orcanbewrittenspecificallyforInfoPath.

WriteanActiveXcontrol

AddanActiveXcontroltotheInfoPathdesignenvironment

DeployanActiveXcontrol

ShowAll

AboutADO.NETdatasetintegration

YoucaneasilyconnectformstoWebservicesthatreceivedatafromandsubmitdatatoADO.NETdatasets.

ConnectingformstoWebservicestoreceivedata

ConnectingformstoWebservicestoreceiveandsubmitdata

ConnectingformstoWebservicestosubmitdata

Thereareafewlimitationsondatasets:

Onlyonedatasetisallowedwhenaformisedited.

Copyingandpastingofnesteddatasetsupdatestheforeignkeytopointtotheparentvalues.

DeleteRuleandUpdateRulepropertiesarenotsupported.

Constraintsorrelationshipscannotbedisabled.

ShowAll

Aboutbackwardcompatibility

InMicrosoftOffice2003EditionsServicePack1,existingformsfunctionthesamewaytheydidinMicrosoftOfficeInfoPath2003,whiletakingadvantageoftheimprovementsandnewfeaturesincludedintheservicepack.ToensurecompatibilityforusersofMicrosoftOfficeInfoPath2003withoutServicePack1orlaterinstalled,however,certainfeaturesarenotavailabletoexistingforms.

ThefollowingsectionsdescribeareasoffunctionalitythatmaybeaffectedwhenyouareworkingwithmorethanoneversionofInfoPath.

Upgradingexistingforms

Creatingnewformtemplates

Removingnewfeaturesfromaformtemplate

Disablingnewfeatures

Openingformtemplatesthatcontainformcodewithupdatedobjectmodelmembers

LaunchingandautomatingInfoPathfromanotherapplication

ShowAll

Aboutchangingaform'smaindatasource

Attimes,youmayneedtomodifyaformtouseadifferentXMLSchema,databaseserver,orWebservicebeforeorafterdeployment.Youdonothavetomodifytheformdefinitionfile(.xsf)toaccomplishthistask,however,becausewithMicrosoftOfficeInfoPath2003ServicePack1orlater,youcanchangethemaindatasourceofyourformthroughtheInfoPathdesigner.

Thestepsyouneedtotaketodothisdiffer,dependingonwhetheryourform'smaindatasourceisanXMLSchema,anXMLdocument,oradataconnection.

ChangethemaindatasourceofaformbasedonanXMLSchemaorXMLdocument.

Changethemaindatasourceofaformbasedonadataconnection.

Aboutdigitalsignatures

Takeadvantageofthefollowingnewfunctionsthathavebeenaddedtothedigitalsignaturesfeature:

Enablesignaturesfortheentireform,orforspecificsetsofdataintheformthatcanbesignedseparately.

Foreachsetofdatathatcanbesigned,specifywhetherasingleormultiplesignaturesareallowedandwhattheirrelationshipwillbe.Forexample,youcanspecifywhethertheyareparallelcosignaturesorwhethereachnewsignaturecountersignsalltheearlierones.

Specifyamessagetobeshowntoformusersastheysigntheform.

Insertandseeasignatureinthedocument,andviewtheformasitwaspresentedtoeachsigner.

Viewverifiablenonrepudiationinformationthathasbeenaddedtoeachsignatureforincreasedsecurity.Thisadditionalinformationispartofthesignatureandcannotberemovedwithoutinvalidatingthesignature.Atanytime,youcanrecallthisdatabyclickingonthesignatureintheform.

Addcustominformationtothesignatureblockinfullytrustedformsthroughanextensivedigitalsignatureobjectmodel.

Accessasignaturethroughasnapshot.Thesnapshotisafilein.pngformat.Itcontainsaviewofthesignaturewithintheformandhasallitsnonrepudiationinformation.

ShowAll

Aboutenablingformstosubmitdata

MicrosoftOfficeInfoPath2003allowsyoutosubmitdataenteredintoaformtoaWebserviceoraWindowsSharePointServicesformlibrary,orasanattachmenttoane-mailmessage.

SetupaconnectiontoaSharePointServicesformlibrarythatisenabledforformsubmission.

Setupane-mailmessagethatisenabledforformsubmission.

SetupaconnectiontoaWebservicethatisenabledfordatasubmission.

ShowAll

Aboutformarchitecture

MicrosoftOfficeInfoPath2003formsarecomposedofseveralfilesandcomponentsthatarecombinedtoprovidespecificfunctionalityforaparticularenduserscenarioorbusinessneed.InfoPathformscanvaryincomplexitydependingonthetypeofneedthattheyaddress.

AnInfoPathformisessentiallyatypeofapplicationthatcreatesaspecifiedclassofXMLdocuments,definestheirlayoutandeditingbehavior,enforcestheirdataconsistency,andprovidestheroutinginformationthatindicateswheretheyshouldbestored.

ItisimportanttounderstandthatInfoPathformsarecomposedofseveraldifferentfilesofmanydifferenttypes;thesefilesarecollectivelyknownastheformfiles.Usually,anInfoPathformiscomposedofthefollowingtypesoffiles.

Name Extension DescriptionFormdefinition

.xsf AnInfoPath-generatedfilethatcontainsinformationaboutalloftheotherfilesandcomponentsusedinaform.Thisfileservesasthemanifestfortheform.

XMLSchema

.xsd TheXMLSchemafilesthatareusedtoconstrainandvalidateaform'sunderlyingXMLdocumentfiles.

View .xsl Thepresentationlogicfilesthatareusedtopresent,view,andtransformthedatacontainedinaform'sunderlyingXMLdocumentfiles.

XMLtemplate

.xml The.xmlfilethatcontainsthedefaultdatathatisdisplayedinaviewwhenanewformiscreated.

XMLcomponenttemplate

.xct The.xmlfilerepresentationsoftheeditingcontrolsthatareusedwhencreatingandfillingoutaform.

Presentation .htm,.gif,.bmp,andothers

Thefilesusedinconjunctionwiththeviewfilestocreateacustomuserinterface.

Businesslogic

.js,.vbs Thescriptfiles(MicrosoftJScriptandMicrosoftVBScript)thatcontainprogrammingcodeusedtoimplementspecificeditingbehavior,datavalidation,eventhandlers,controlofdataflow,andothercustombusinesslogic.

Binary .dll,.exe ThecustomComponentObjectModel(COM)componentsthatprovideadditionalbusinesslogic.

Formtemplate

.xsn Thecompressedfileformat(.cab)thatpackagesalltheformfilesintoonefile.

ShowAll

AboutHumanWorkflowServicessupport

HumanWorkflowServices(HWS)isaserviceprovidedbyMicrosoftBizTalkServer2004thatenablesclientapplicationstobuildandmanagehuman-orientedworkflow.MicrosoftOfficeInfoPath2003providesaccesstothisservicebywayoftheWorkflowtaskpane.Inthistaskpane,userscanstartandtrackHWSactionsandrespondtoHWStasks.InfoPathdoesnotprovideadesignerinterfacetoenabletheWorkflowtaskpane;allHWSfunctionalityisenabledbymodifyingtheformdefinitionfile(.xsf).

UsingtheWorkflowTaskPaneTheWorkflowtaskpaneallowstheusertostartorextendaworkfloworrespondtoatask.

ThethreesectionsoftheWorkflowtaskpaneare:

StartWorkflowConsistsoftheactionbuttonsthatcanbeusedtostartaworkflow.ThissectionisonlyvisibleforformsthatareHWSenabledandthatdonothaveanexistingworkflowassociatedwiththem.

ActionTracksthestatusofactionsandtheirassociatedtasks.Onceauserstartsanaction,theactionrunsandistrackedbytheHWSservice.InfoPathdisplaysthestatusoftheactionandwhoisassignedthetask.

TaskAllowstheusertoworkwithtasks.Whenataskisassignedtoauser,InfoPathdisplaysthestatusofthetask,abuttontoresponddirectlytothetask,andoneormorebuttonstostartnewactions.

EnablingtheWorkflowtaskpane

Addingallowedactionstoforms

Addingallowedtaskstoforms

UsingtheOnClickeventtoaddactionandtaskbuttons

CreatinganHWSAdapterBecausetheWorkflowtaskpanedoesnotsubmitdatatotheHWSserviceautomatically,youmustcreateanHWSadaptertosubmittheform.

Thereisnodesignerinterfaceassociatedtothesubmitadapters.Toenabletheseadapters,modifytheformdefinitionfile(.xsf)toincludethehwsAdapterelementwithinthedataAdapterselement.

LikeotherInfoPathWebserviceadapters,theelementmustincludeanamefortheadapterandthelocationoftheWebServicesDescriptionLanguage(WSDL),andmustspecifywhethertheadapterallowssubmittingandquerying.BecausetheseadaptersareonlyusedtosubmitdatatoanHWSservice,thesubmitAllowedattributemustbesetto"yes".ThequeryAllowedattributecanbeomitted,whichcorrespondstoadefaultvalueof"no",oritcanbeincludedandsetto"no".

Aspartofthedesignofactionsandtasks,youcanspecifyadditionalparametersthatarespecifictoeachactionortask.BelowisanexampleofanadapterthatstartsaworkflowwithanApprovalaction.ThevaluetouseforthehwsOperationelementtypeis"addActionToNewActivityFlow".ThetypeIDattributeusestheactionTypeIDattributevalue,whichisaGUID.

<xsf:hwsAdaptername="StartApproval"wsdlUrl="http://.../HWSService.asmx?WSDL"submitAllowed="yes"queryAllowed="no"><xsf:hwsOperationtype="addActionToNewActivityFlow"typeID=”{guid}”serviceUrl="http://.../HWSService.asmx"><xsf:inputsource="HWSMessage1.xml"><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param1"replaceWith="/my:myFields/my:param1"/><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param2"replaceWith="/a:foo/b:bar"dataObject=”Aux1”/></xsf:input></xsf:hwsOperation></xsf:hwsAdapter>

ThehwsAdapterelementhasthesamedefaultinterfaceastheothersubmitadapterssupportedbyInfoPath,buttheHWSsubmitadaptersdonotappearintheinterface.Instead,toinvokeasubmitaction,youmust

addittoyourcode,asshowninthefollowingexample:

XDocument.DataAdapters.Item("StartApproval").Submit();

Atruntime,whenthesubmitoperationisinvoked,abuttonwiththecaption,GetStatus,appearsontheWorkflowtaskpane.Thisbuttonallowstheusertorefreshthetaskpanesothatitshowsthecurrentworkflowinformation.

DefiningHWSsubmitoperationsforactions

DefiningHWSreceiveoperations

ShowAll

AboutprogrammingInfoPath

MicrosoftOfficeInfoPath2003providesdeveloperswitharichdevelopmentenvironmentforcustomizingforms.Formscanbecustomizedbywritingprogrammingcodetorespondtoformanddatavalidationevents,toaccessandmanipulateaform'sunderlyingXMLdocument,toimplementcustomdatasubmissionandmerges,andtoimplementaccesstoexternaldatasources.Customizingaformcanalsoinvolvealteringoneoftheformfilestosuitaspecificrequirement.

ItisimportanttounderstandafewkeyconceptsthatareinvolvedinprogramminganInfoPathform.TheseconceptsincludetheInfoPathprogrammingcomponents,programmaticanddeclarativeprogramming,theInfoPathprogramminglanguages,andtheInfoPathprogrammingenvironment.

InfoPathprogrammingcomponents

Programmaticanddeclarativedevelopment

InfoPathprogramminglanguagesandtheprogrammingenvironment

ShowAll

Aboutsecondarydatasources

MicrosoftOfficeInfoPath2003ServicePack1addstheabilitytoconnectmultipledatasourcestoaformsimultaneously.Usingmultipledatasourcesinyourformsallowsyoutobuildcomplexfunctionalitysuchaslookuplistsorofflinedatastores.

MainandsecondarydatasourcesThemaindatasourcecorrespondstothegroupsandfieldscontainingthedatathatunderliestheformandissavedastheformfile.

Asecondarydatasourceisusedtostoredatafromadditionaldatasources.Wheneveranewdataconnectioniscreatedforretrievingdata—forexample,byusingtheAddbuttonoftheDataConnectionsdialogbox—theretrieveddataisnotstoredinthemaindatasourcebutinasecondarydatasource.Thesecondarydatasourcereceivesthedatafromanydataconnectionusedforquerying,whetheritisanXMLdocument,adatabase,aWebservice,oraSharePointlibraryorlist.

TheDataSourcetaskpanedisplaysthestructure(groupsandfields)ofeachdatasource,bothmainandsecondary,andisusedforbindinggroupsorfieldsinthedatasourcetocontrolsintheform.Whenauserfillsouttheform,thecontrolsdisplaythedatafromthedatasourceandallowittobeupdatedduringediting.

NewfeaturesforworkingwithsecondarydatasourcesThefollowingsectionsdescribethechangesmadetoworkingwithsecondarydatasourcesinInfoPathServicePack1.

TheDataConnectionsdialogbox

DataSourcetaskpane

Fieldsandgroups

Controlsavailableforbindingtosecondarydatasources

ShowAll

Aboutsecurityanddeployment

AdditionalsecurityfeaturesanddeploymentfunctionalityhavebeenaddedtoMicrosoftOfficeInfoPath2003inServicePack1.Supporthasbeenaddedtoallowformtemplatestobemovedfromonelocationtoanotherorsentasanattachmenttoane-mailmessage.Inaddition,supporthasbeenaddedtotheInfoPathdesignmodetofacilitatethecreationanddeploymentoffullytrustedforms.

Securitylevels

Formtemplatescanhaveoneofthreedifferentsecuritylevels,dependingonwheretheformislocated.Thesesecuritylevelsareasfollows:

Restricted

Domain

FullTrust

NoteAllformsgeneratedintheInfoPathdesignerhaveasecuritylevelassociatedwiththem.InfoPathwillattempttoopenformsattheirassociatedsecuritylevel.Ifthesecuritylevelassociatedwiththeformishigherthanthesecuritylevelthatcanbegrantedtoit,theformwillnotopen.

Formsaregrantedsecuritylevelsbasedonthelocationfromwhichtheformwasopened.Formoreinformation,seetheTrustlevelssection.

TrustlevelsThehighestleveloftrustgrantedtoaformtemplateisdeterminedbythe"cachedfrom"location(thatis,wheretheformiscachedfrom)andotherverificationcode,asdescribedinthefollowingtable.Theattributeslistedinthetable(forexample,HTTP,UNC,requireFullTrust)arecache-basedentriesthatareusedtodeterminetheleveloftrustgrantedtoaform.

TrustLevelGranted

HighestLevelofTrustGrantedFullTrust

ClientComputer(Sandboxed)

Intranet(Sandboxed)

file:LocationId=CachedFromLocation

file:LocationId<>CachedFromLocationornoLocationId(regardlessofwheretheformcamefrom)

CachedFromLocation:IntranetHTTPorHTTPS

CachedFromLocation:InternetHTTPorHTTPS

CachedFromLocation:UNC XInstalledTemplate(requireFullTrust="yes")

InstalledTemplate(requireFullTrust="no")

Templatewithtrustedpublishercertificate

ExtractedFormFiles X

AllformfilesopenedintheInfoPatheditorareboundbyasetofconditionsthatdeterminethesecuritylevelinwhichtheformwillopen

andwhetheritwillopen.WhenanInfoPathformisopenedintheeditor,itwilleitherbeopenedwithanappropriatesecuritylevel,oritwillfailtoload.Ifaformrequestsahighersecuritylevelthanitcanbegranted(aformcanrequestaspecificsecuritylevelusingthetrustLevelorrequireFullTrustattribute),itwillnotbepermittedtoload.Otherwise,itwillbeloadedwiththesecuritylevelitrequests.Iftheformtemplateisnotpermittedtoopenwiththerequestedsecuritylevel,theuserwillnotbeabletoopentheformandwillreceivethe"InsufficientSecurityPrivilegeWarning"errormessage.

Thefollowingtabledescribestheconditionsrequiredforopeningaformateachsecuritylevelandtheresultantbehaviorwhentheuserattemptstoopentheform:

Formasksfor: Formasksfor:

EditorOpens/Fails

FullTrust(requireFullTrust="yes")

DomainTrust(trustLevel="Domain"orblank)

HighesttrustlevelInfoPathcangrantbasedonevidence

Trusted(installedortrustedcertificate)

EditoropensatFullTrustlevel

DomainTrust:ClientComputer

Failstoopen EditoropensatDomainlevel

Highesttrust

levelInfoPathcangrantbasedonevidence

DomainTrust:Intranet

DomainTrust:Internet

HighesttrustlevelInfoPathcangrantbasedonevidence Restricted

Failstoopen Failstoopen

Specifyingasecuritylevel

Maildeploymentandmobileformtemplates

MicrosoftOfficeInfoPath2003ServicePack1allowsyoutosendyourformtemplatesasanattachmenttoane-mailmessageandtomovethemfromonelocationtoanother.Maildeploymentisaneasyandeffectivewaytodistributeformsforinterofficeuseaswellastodeployformstoremoteusers.

Understandingformidentity

Designingaformtosendasanattachmenttoane-mailmessage

Sharingformsbye-mailmessageorfromacommonsharedlocation

Compatibility

ShowAll

Abouttheformdefinitionfile

TheMicrosoftOfficeInfoPath2003formdefinition(.xsf)file,commonlyreferredtoasthe.xsffile,servesasthemanifestofanInfoPathform.The.xsffileisautomaticallycreatedbyInfoPathwhenanewformtemplateiscreatedandsavedindesignmode.Asformdesignersanddeveloperschangetheformtemplateoraddnewfeaturestoit,InfoPathupdatesthe.xsffiletoreflectthosechanges.

NoteThe.xsffilecanalsobemodifieddirectlybyusinganytextorXMLeditor,suchasMicrosoftNotepad.However,careshouldbetakenwhenmakingmodificationstothe.xsffile:ifaninvalidentryismade,theformthatthefileisassociatedwithmaybeleftinanunusablestate.However,somecustomizationscanbemadetothe.xsffilethatcannotbegeneratedindesignmode.

The.xsffileisthecorefileofanInfoPathformbecauseitcontainsinformationabouttheformasawhole.Someofthedataitcontainsincludesprocessingmetadata,userinterfacecustomizations,schemadefinitions,views,businesslogicdeclarations,eventhandlers,anddeploymentinformation.

Thefollowingaresomeoftheitemsthatthe.xsffilecontains:

Auniqueidentifierfortheform

Globalmetadatainformationabouttheform,includingdeploymentandpublishinginformation

TheXMLSchemadefinitionsfortheXMLdocumentthattheformproduces

Definitionofviewsandtheirassociateduserinterfacecomponents(menus,toolbars,andbuttons)

Definitionofeditingactionsthataremadeavailableusinguserinterfacecomponents,andhowtheiravailabilitywillbedeterminedcontextually

Workflowandroutinginformation

Eventhandlers,datavalidation,andbusinesslogicthatisassociatedwithindividualXMLnodesoftheform'sunderlyingXMLdocument,orwiththe

XMLdocumentitself

Eventhandlersassociatedwiththeformasawhole

Packaginginformationaboutallofthefilescontainedwithintheformtemplate

The.xsffileisbasedonthexsfnamespace.ItsrootelementisthexDocumentClasselement.

NoteAcompletereferencetothe.xsffile,includingallofitselements,attributes,andotherentities,canbefoundintheInfoPathXSFReferencethatispartoftheInfoPathDeveloper'sReference,availableintheInfoPathHelpsystemandtheMicrosoftScriptEditor(MSE)Helpsystem.

ShowAll

Abouttheprogrammingenvironment

MicrosoftOfficeInfoPath2003usestheMicrosoftScriptEditor(MSE)asitsprimaryintegrateddevelopmentenvironment.MicrosoftJScriptandMicrosoftVBScriptaretheprogramminglanguagesthatareusedinMSEtocreatecustombusinesslogicforaform.

MSEcanbeopenedwhenworkingwithaformindesignmodebypointingtoScriptontheToolsmenuandclickingMicrosoftScriptEditor,orbypressingALT+SHIFT+F11.WhenyouopenMSEfromInfoPath,theMSEcodeeditorappearsandtheform'sdefaultscriptingfile(witheithera.jsor.vbsextension,dependingonthescriptinglanguagesetfortheform)opensinthecodeeditingwindow.

WorkingwithMSEinanInfoPathforminvolvesseveraltasks,includingsettingthedefaultscriptinglanguage,creatinganeventhandler,anddebuggingscriptingcode.

Settingthedefaultscriptinglanguage

Creatinganeventhandler

Debuggingscriptingcode

NoteFormoreinformationaboutusingMSE,clickMicrosoftScriptEditorHelpontheHelpmenuwhenworkinginMSE.

AboutVisualStudio.NETintegration

MicrosoftOfficeInfoPath2003ServicePack1orlaterallowsyoutouseMicrosoftVisualStudio.NETtowritemanagedcodeinsteadofscriptforformcodeinnewInfoPathformtemplatesortoaddmanagedcodetoexistingformtemplates.TouseVisualStudio.NETtocreate,debug,andbuildInfoPathprojectsthatuseMicrosoftVisualC#orVisualBasic.NETmanagedcode,youmustdownloadtheMicrosoft®OfficeInfoPath™2003ToolkitforVisualStudio®.NETfromtheInfoPathDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteandinstallitwithVisualStudio.NET2003.TheintegrationfeaturesprovidedbythetoolkitallowyoutouseacombinationofInfoPathforformdesignandVisualStudio.NETforwritinganddebuggingformcode.TheseintegrationfeaturesallowyoutotakeadvantageofsuchfeaturesoftheVisualStudio.NETdevelopmentenvironmentas:

Buildingyourprojectindebugorreleaseconfigurations.

UsingIntelliSensesupportintheCodeEditorsuchasstatementcompletion,memberslists,andinlineparameterinformation.

PressingF1intheCodeEditortodisplaycontext-sensitivehelpinformationabouttypes,members,andothercodekeywords.

UsingVisualStudio.NETdebuggingfeatures.

Additionally,usingmanagedcodeinInfoPathprojectsallowsyoutotakeadvantageofthefeaturesofthe.NETFrameworkcommonlanguageruntime(CLR)andtomakecallsintothecomprehensive,object-orientedcollectionofreusabletypesprovidedbythe.NETFrameworkclasslibrary.

FormoreinformationonusingVisualStudio.NETtocreateInfoPathprojects,seethedocumentationinstalledwiththeMicrosoftOfficeInfoPath2003ToolkitforVisualStudio.NET.

ShowAll

AboutXMLSchemaimprovements

ManyimprovementshavebeenmadeforXMLSchema(.xsd)supportinMicrosoftOfficeInfoPath2003ServicePack1.

NativesupportforthefollowingXMLSchemaconstructshavebeenaddedtoInfoPath:

Abstracttypes

Abstractelementsandsubstitutiongroups

Requiredwildcard(<any>)

Repeatingoroptionalmodelgroupsintheschema(sequence,choice,group,andallwithminOccursormaxOccursdifferentfrom1)

Inlineschemas

InteractiveincrementalcreationofthedatasourceTosupportabstracttypesorelementsandrequiredwildcards,creationofthedatasourceisnowinteractive.Forexample,schemacreationisnotpossibleiftheschemadelegatespartofitssyntaxtootherschemas.Thiscanhappenwhenatypeoranelementisdefinedasabstractorwhenthecontentmodelofanelementcontainsan<any>.Whenoneoftheseconditionsoccurs,InfoPathwillprompttheusertospecifyaschemasourcethatcontainstheneededdatabeforeproceeding.Thisprocessisrepeateduntiltheschemacollectionthatisloadedcontainsenoughinformationtogenerateacompletedatasource.

BettermodelgroupsupportModelgroupsspecifiedas"choice"or"sequence"andwithminOccursormaxOccursnotequalto1arenowshownintheDataSourcetaskpane.Theycanbeboundtocontrols,andtheycanbetreatedasagroupinthedatasource.

NoteModelgroupsdesignatedas"group"or"all"arenotdisplayedintheDataSourcetaskpane.

NativesupportforinlineschemasInlineschemasarenativelysupportedduringdesign.ThisfeatureallowsyoutouseanXMLdocumentthatcontainsitsownschemaasadatasource.

SupportfordatasourcechangeTheunderlyingdatastructureofaformcannowbechangedduringformcreation.ClickingConvertMainDataSourceontheToolsmenuallowsyoutoconvertthecurrentdatasourcewhileretainingtheinformationthatdependsonit.

Changingadatasourceisrestrictedtothefollowingpaths:

Convertingfromablankform,XMLSchema,orXMLfiletoanotherXMLSchemaorXMLfile.

ConvertingfromaWebserviceorotherdataconnectiontoanotherWebserviceordataconnection.

Onceyouspecifythenewdatasource,alldependentdatawillbemappedtothenewdatasource.Ifthedatacannotbemapped,controlswillappearunboundintheview.

NoteChangingthedatasourcedoesnotupdatethecodeassociatedwiththeform.Also,afterusingtheConvertMainDataSourcecommand,youcannotusetheUndocommandontheEditmenutoreverttotheoriginaldatasource.

RecursivetemplatesupportTheRepeatingRecursiveSectioncontroladdsrecursivestructuresofarbitrarydepthtoaform.

ThiscontrolisnowthedefaultcontrolwhenyoudragarecursivestructurefromtheDataSourcetaskpane.

Thepropertiesoftherecursivesectioncorrespondtothepropertiesofanordinarysection,withtheexceptionthatdigitalsignaturesarenotallowed.TheonlypropertythatcanbesetintheinternalrecursiveblockisthedefaultvalueoftheXMLfragmentforadditionalrecursivesectionsinsertedwithintheoutermostinstance.

ShowAll

AbouttheInfoPathobjectmodel

TheMicrosoftOfficeInfoPath2003objectmodelisaCOM-basedobjectmodelthatcanbeusedtointeractwithInfoPathformsandtheirunderlyingXMLdocuments.ItissimilartootherMicrosoftOfficeapplicationobjectmodelsinthatitimplementsinterfacesforcollections,objects,properties,methods,andevents.However,theInfoPathobjectmodelisprimarilyusedinscriptingcode,usingtheMicrosoftScriptEditor(MSE)thatisbuiltintoInfoPath.

NoteUnlikeotherOfficeapplicationsthatsupportcompleteapplicationautomation,theInfoPathobjectmodelsupportsautomationofonlycertainfeaturesoftherun-timeeditingenvironment.

ThefollowingsectionsdiscusstheInfoPathfunctionalareasthattheobjectmodelrepresents,thelocationsfromwhichtheobjectmodelcanbeaccessed,andthelevelsofobjectmodelsecurity.

Objectmodelfunctionalareas

Objectmodelaccess

Objectmodelsecurity

ViewingServicePack1objectmodelchangesfromtheObjectBrowser

ShowAll

Accessingapplicationdata

TheMicrosoftOfficeInfoPath2003objectmodelprovidesobjectsandcollectionsthatcanbeusedtogainaccesstoinformationabouttheInfoPathapplication,includinginformationrelatedtoaform'sunderlyingXMLdocumentandtheformdefinition(.xsf)file.Thisdataisaccessedthroughthetop-levelobjectintheInfoPathobjectmodelhierarchy—theApplicationobject.

UsingtheApplicationobject,InfoPathformdeveloperscanaccessinformationaboutthecurrentlyinstalledinstanceofInfoPath,includingitsnameandversionnumber.Inthefollowingexample,theNameandVersionpropertiesoftheApplicationobjectreturndatainamessageboxtotheuser:

Application.XDocuments(0).UI.Alert("Applicationname:"+Application.Name+"\nApplicationversion:"+Application.Version);

NotethattheAlertmethodoftheUIobject,whichisaccessedthroughtheXDocumentobject,isusedtodisplayamessageboxtotheuser.BecausetheXDocumentobjectthatrepresentsthecurrentlyopenform'sunderlyingXMLdocumentisembeddedintheInfoPathscriptengine,thepreviousexamplecanalsobewrittenasfollows:

XDocument.UI.Alert("Applicationname:"+Application.Name+"\nApplicationversion:"+Application.Version);

NoteThe\ncharacterreferencesinthetextforthealertmessageisastandardnewlinefeedthatcausesthetexttobreakandbeplacedonanewlineinthemessagebox.

Accessingdataaboutaform'sXMLdocument

Accessingdataaboutaform's.xsffile

ShowAll

Accessingexternaldatasources

WhenworkingwithaMicrosoftOfficeInfoPath2003form,youcanwritescriptingcodetoaccesstheform'ssecondarydatasources,whicharetypicallyexternaltotheprimarydatasourceofaform,andthenmanipulatethedatathattheycontain.TheInfoPathobjectmodelsupportsaccesstoaform'sexternaldatasourcesthroughtheuseoftheDataObjectobjectinassociationwiththeDataObjectscollection.

TheInfoPathobjectmodelalsoprovidesasetofdataadapterobjects,containinginformationaboutthesecondarydatasources,andaccesstothedatathattheycontain.ThetypeofdataadapterthatisreturnedbytheDataObjectobjectdependsonthetypeofdatasourcethatwasselectedwhenthesecondarydatasourcewascreatedindesignmode.

OverviewoftheDataObjectscollection

OverviewoftheDataObjectobject

Overviewofthedataadapterobjects

UsingtheDataObjectscollectionandtheDataObjectobject

ShowAll

Accessingformdata

WhenyouwanttoextendthefunctionalityofaMicrosoftOfficeInfoPath2003form,itisoftennecessarytoprogrammaticallyaccessinformationabouttheform'sunderlyingXMLdocument,accessthedatathattheXMLdocumentcontains,orperformsomeactionontheXMLdocument.TheInfoPathobjectmodelsupportsaccessandmanipulationofaform'sunderlyingXMLdocumentthroughtheuseoftheXDocumentobjectinassociationwiththeXDocumentscollection.

TheXDocumentobjectisoneofthemostusefulobjectswithintheInfoPathobjectmodelbecauseitprovidesavarietyofproperties,methods,andeventsthatnotonlyinteractwithaform'sunderlyingXMLdocument,butalsoperformmanyoftheactionsthatarewithintheInfoPathuserinterface.

OverviewoftheXDocumentscollection

OverviewoftheXDocumentobject

UsingtheXDocumentscollectionandtheXDocumentobject

ShowAll

AutomatingInfoPath

MicrosoftOfficeInfoPath2003ServicePack1offersexpandedapplicationautomationintheformofmethodsoftheApplicationobjectandtheXDocumentscollection.

OverviewoftheApplicationandXDocumentobjects

Forbackwardcompatibility,theautomationofInfoPathisaccomplishedbyusingtheExternalApplicationobjectfromaprogramminglanguageorenvironmentthatsupportstheComponentObjectModel(COM).

OverviewoftheExternalApplicationobject

UsingtheExternalApplicationobject

ShowAll

Displayingalertsanddialogboxes

WhenwritingprogrammingcodetoextendthefunctionalityofaMicrosoftOfficeInfoPath2003form,itisoftenusefultoprovidetheuserwithinformationinadialogbox.ProgrammaticallydisplayingadialogboxisaccomplishedinInfoPathbyusingtheUIobject.

OverviewoftheUIobject

UsingtheUIobject

ShowAll

Handlingerrors

Whencreatingcustomapplications,developersmustoftenperformerrorhandlingthatinvolveswritingprogrammingcodetocheckforerrorsraisedbytheapplicationortocreateandraisecustomerrors.TheMicrosoftOfficeInfoPath2003objectmodelsupportserrorhandlingthroughtheuseoftheErrorobjectinassociationwiththeErrorscollection.

InInfoPath,errorscanoccurwhenaform'sXMLSchemaisvalidated,whenacustomvalidationconstraintfails,whenanerrorisgeneratedbytheReportErrormethodoftheDataDOMEventobject,orwhenanerroriscreatedusingtheAddmethodoftheErrorscollection.

OverviewoftheErrorscollection

OverviewoftheErrorobject

UsingtheErrorscollectionandtheErrorobject

ShowAll

Respondingtoformevents

YoucanwritescriptingcodetorespondtovariouseventsthatcanoccurinMicrosoftOfficeInfoPath2003asauserfillsoutaform.InInfoPath,eventstaketheformofeventhandlersthatarecreatedwhenworkingwithaformindesignmode.

InfoPatheventhandlersmustbeinitiallycreatedindesignmodebecause,inadditiontothescriptingdeclarationsthatarecreatedinaform'sprimaryscriptingfile,entriesarealsomadeintheformdefinition(.xsf)file.Afteryouhavecreatedaneventhandler,youshouldnotalteritsdeclarationintheprimaryscriptingfile.

ForinformationaboutcreatingtheInfoPatheventhandlers,seeAbouttheprogrammingenvironment.

Overviewoftheeventobjects

Usingtheeventobjects

ShowAll

Workingwithformwindows

WhenworkingprogrammaticallywithaMicrosoftOfficeInfoPath2003form,youcanwritescriptingcodetoaccesstheform'swindows,andthencustomizesomeoftheitemsthattheycontain.TheInfoPathobjectmodelsupportsaccesstoaform'swindowsthroughtheuseoftheWindowobjectinassociationwiththeWindowscollection.

TherearetwotypesofwindowsinanInfoPathform:theeditingwindowthatisusedastheformareawhenauserfillsoutaform,andthedesigningwindowthatisusedasthedesignmodewhenauserdesignsaform.Whenwritingscriptingcodeinaform,itistheeditingwindowthatprovidesthemostusefulfunctionality,becauseyoucanusetheWindowobjectassociatedwithittoaccessavarietyofpropertiesandmethodsthatcanbeusedtocustomizeaform.

OverviewoftheWindowscollection

OverviewoftheWindowobject

UsingtheWindowscollectionandtheWindowobject

ShowAll

Workingwithviews

WhenworkingwithaMicrosoftOfficeInfoPath2003form,youcanwritescriptingcodetoaccesstheform'sviews,andthenperformavarietyofactionsonthedatathattheviewscontain.TheInfoPathobjectmodelsupportsaccesstoaform'sviewsthroughtheuseoftheViewobject.

OverviewoftheViewobject

UsingtheViewobject

ShowAll

Aboutthedevelopersampleforms

TheMicrosoftOfficeInfoPath2003developersampleformsareasetofformsdesignedtodemonstratevariousdevelopmenttechniquesforcustomizingandimplementingInfoPathfeatures.Thefollowingtablelistseachofthedevelopersampleformsandthefeaturesthattheyillustrate.

Name Filename DescriptionDataValidation

D_VALID.XSN Demonstratesthewaysinwhichdatacanbevalidatedinaform.Methodscoveredincludeschema-based,custom,andscript-basedvalidation.

Events EVENTS.XSN Demonstratestheeventsthatcanbeusedinaform.Eventscoveredincludeformevents,datavalidationevents,andcontrolevents.

StructuralEditing

CD_EDIT.XSN DemonstratesthewaysinwhichthesourceXMLdocumentofaformmaybeedited,andhowtheeditingactionsthatareavailabletoauserarebasedoncontext.Methodscoveredincludefieldandstructuralediting,withexamplesofeditingusingcontrolsandscriptingcode.

UserInterface

UIBASICS.XSNDemonstratesthewaysinwhichtheInfoPathuserinterfacecanbecustomizedinaform.Methodscoveredincludemenuitems,toolbars,customtaskpanes,andcustomdialogboxes.

Usingthedevelopersampleforms

ShowAll

AbouttheDataValidationdevelopersampleform

TheDataValidationdevelopersampleformdemonstratesthevarietyofwaysinwhichdatacanbevalidatedinMicrosoftOfficeInfoPath2003.Thissampleformisdividedintothreesections,eachdemonstratingoneofthethreemethodsofdatavalidation:schema-basedvalidation,customvalidation,andscript-basedvalidation.

Totestthefeaturesofthesampleform,simplychooseanyfieldandenterdatathatdoesnotcomplywiththevalidationconstraintthatisassociatedwithit.Thevalidationconstraintscanbeviewedbyrestingthemousepointeroverthequestionmarkiconnexttoeachfield.Whenyoumovethecursoroutofthefield,youreceiveoneoftwopossibleerrorindications:aninlinealertoradialogboxalert.

NoteToseeallofthefilesthatmakeuptheDataValidationdevelopersampleform,opentheformandclickExtractFormFilesontheFilemenuwhileindesignmode.Thisextractsalloftheformfilesfromtheformtemplatefileandsavesthemtoaspecifiedfolderonyourharddisk.

TolearnhoweachofthedatavalidationmethodsisimplementedintheDataValidationdevelopersampleform,seethefollowingtopics:

Schema-basedvalidationintheDataValidationdevelopersampleform

CustomvalidationintheDataValidationdevelopersampleform

Script-basedvalidationintheDataValidationdevelopersampleform

ShowAll

Schema-basedvalidationintheDataValidationdevelopersampleform

Schema-baseddatavalidationinMicrosoftOfficeInfoPath2003isdeterminedbytheXMLSchemaassociatedwithaform.Schema-basedvalidationoccursbydefaultwheneverauserfillsoutaform.Aftertheuserentersdataintoafieldandmovesoutofthatfield,thedataisimmediatelycheckedagainsttheXMLSchema.

IntheDataValidationdevelopersampleform,schema-basedvalidationisusedtoverifythatanumberfallswithinacertainrange,verifythetypeofdatainafield,verifythatafieldcontainsdata,andlimitthenumberofrowsthatcanbeaddedtoatable.

NoteInfoPathsupportsthecreationofonlydatatypeandrequiredfieldconstraintsinXMLSchemasindesignmode.However,theuseofotherkindsofconstraintsintheschemaissupported.Tocreateotherkindsofschema-basedvalidation,youmustedityourXMLSchemafilesusingMicrosoftNotepadorsomeothertexteditor.

Rangecheckinganddata-typevalidationintheschema

Requiredfieldsintheschema

Structuralvalidationintheschema

ShowAll

CustomvalidationintheDataValidationdevelopersampleform

Custom(ordeclarative)validationinMicrosoftOfficeInfoPath2003isusedtocheckforrequiredfields,verifyarangeofvalues,andensuretheaccuracyofafield.YoucanusetheDataValidationdialogboxtocreatecomplexvalidationconstraintsthatperformcalculationsandvalidatethedatainotherfields.Validationerrorscanbedisplayedasinlinealertsordialogboxalerts.Ineithercase,youcanwriteerrormessagesthattelltheuserhowtofixtheinvalidentry.Aswithschema-basedvalidation,customvalidationconstraintsareattachedtofieldsintheform,andthevalidationisinvokedwhenauserchangesthedatainafield.

NoteTheDataValidationdialogboxisavailableviathePropertiesdialogboxforeachoftheOfficeInfoPath2003controls.

WhenyoucreateacustomdatavalidationconstraintintheDataValidationdialogbox,OfficeInfoPath2003createsanerrorConditionelementwithinthecustomValidationsectionoftheformdefinition(.xsf)file.Thefollowingisanexampleofthevalidationconstraintscreatedinthe.xsffileforthecostfieldintheDataValidationdevelopersampleform:

<xsf:customValidation><xsf:errorConditionmatch="/sampleData/travelExpenses/expense/cost"expressionContext="."expression=".<0or.>500"><xsf:errorMessagetype="modeless"shortMessage="Thecostoftheitemmustbemorethan$0.00andcannotgoover$500.00.">Thecostoftheitemmustbemorethan$0.00andcannotgoover$500.00.</xsf:errorMessage></xsf:errorCondition></xsf:customValidation>

ThematchattributeoftheerrorConditionelementspecifiestheXPathexpressionthatisusedtobindthecustomdatavalidationconstrainttothefield,andtheexpressionattributeisusedtospecifytheconstraint.

TheerrorMessageelementisnestedwithintheerrorConditionelementandisusedtospecifytheerrormessagethatappearswhenthevalueoftheassociatedfieldviolatestheconstraint.TheshortMessageattributeequatestotheScreenTipfieldintheDataValidationdialogbox,andthevalueoftheerrorMessageelementequatestotheMessagefieldintheDataValidationdialogbox.Thetypeattributeisusedtospecifyerrortype.

ShowAll

Script-basedvalidationintheDataValidationdevelopersampleform

Script-basedvalidationisspecifiedinthebusinesslogicscriptfileassociatedwithaMicrosoftOfficeInfoPath2003form,anditprovidesmoreflexibilitythancustomvalidationorschema-basedvalidation.Usingscript-basedvalidation,youcanspecifywhenafieldshouldbevalidated(forexample,whentheuserfirsttypesdataintoafield,aftertheuserleavesafield,orafterdataisvalidatedbytheschema).Youcanalsowritescriptthatrunswhenaformisopenedorwhentheuserswitchesviews.Thescriptyouwritecanperformavarietyoffunctions,includingcomparingfields,calculatingvalues,showingerrormessages,updatingvalues,andrevisingotherfields.

NoteInfoPathsupportswritingscriptinMicrosoftVBScriptandMicrosoftJScript.However,youcannotmixthescriptinglanguagesusedwithinasingleform.

Tocreatescript-baseddatavalidation,youuseInfoPathdesignmodetocreateaneventhandler(alsocalledaneventfunction),andthenyouwritescriptingcodefortheeventhandlerusingtheMicrosoftScriptEditor(MSE).Foreacheventhandlerthatyoucreate,InfoPathplacesanentryintheformdefinition(.xsf)filethatcontainsthenameoftheeventhandlerandtheXMLDocumentObjectModel(DOM)nodethattheeventhandlerisassociatedwith.

Becausetheeventhandlerisreferencedinthe.xsffile,youcannotcreateaneweventhandlerentirelyfromwithinMSE—youmustinitiallycreatetheeventhandlerinInfoPathdesignmode.SinceInfoPathisusedtocreatethedeclarationoftheeventhandler,youcannotmodifytheeventhandlernameoritsargumentsonceithasbeencreated.

Eventhandlersintheformdefinitionfile

Script-basedeventhandlersandfunctions

UsingtheDataDOMEventobject

ShowAll

AbouttheEventsdevelopersampleform

TheEventsdevelopersampleformdemonstratessomeoftheeventsthatmaybeusedinaMicrosoftOfficeInfoPath2003form.InInfoPath,eventsareusedtoimplementclient-sidebusinesslogic,whichmayincludedatavalidation,controllingthebehaviorofaform,respondingtotheactionsofcontrolsonaform,orsubmittingaform.

TheEventsdevelopersampleformisbasedonthescenarioofacustomercontactsystem.Itcontainsthreeviewsthatareusedtomanagecustomerinformation:

NewCustomerViewUsedtoenternewcustomerinformation.Customerinformationmustbeenteredinthisviewbeforetheotherviewscanbeused.

ContactCustomerViewUsedtosetthedatesonwhichthecustomershouldbecontactedandtorecordthatthecustomerhasbeencontacted.

ArchiveCustomerViewUsedtoshowcustomerinformation,recordnotesaboutthecustomer,andrecordthatthecustomerrecordhasbeenarchived.

Totestthefeaturesofthesampleform,entercustomerinformationinNewCustomerview,andthenclickSwitchToContactCustomerViewtoswitchviews.AfterenteringcustomercontactinformationinContactCustomerview,youcanclickSwitchToArchiveCustomerViewtoswitchtothelistofarchivedcustomercontactinformation.

NoteToseeallofthefilesthatmakeuptheEventsdevelopersampleform,opentheformandclickExtractFormFilesontheFilemenuwhileindesignmode.Thisextractsalloftheformfilesfromtheformtemplatefileandsavesthemtoaspecifiedfolderonyourharddisk.

TolearnhoweacheventisimplementedintheEventsdevelopersampleform,seethefollowingtopics:

FormeventsintheEventsdevelopersampleform

DatavalidationeventsintheEventsdevelopersampleform

ControleventsintheEventsdevelopersampleform

ShowAll

FormeventsintheEventsdevelopersampleform

TheEventsdevelopersampleformimplementsavarietyofMicrosoftOfficeInfoPath2003formeventsthatcanbeusedtorespondtospecificactivitiesthatoccurwhenaformisopenedandwhileitisbeingfilledout.Formeventscanoccurwhenaform'sversionnumberisvalidated,whenaformisopened,whenaformviewischanged,andafteraformhasbeenmergedwithanotherform.

ThefollowingtablelistseachoftheformeventsimplementedintheEventsdevelopersampleform,alongwithadescriptionofhowtheyareused.

Event DescriptionOnVersionUpgradeUsedtoverifythattheversionnumberoftheform

beingopenedmatchestheversionnumberoftheformwhenitwasoriginallydesigned.Iftheversionnumbersdonotmatch,thiseventoccursandscriptingcodecanbeusedtoupdatetheformordisplayanerrormessage.

OnLoad Usedtoinitializetheformasitisbeingopened.Whenthiseventoccurs,scriptingcodecanbeusedtosettheappropriateviewbasedondatacontainedintheform.

OnSwitchView Usedwhenchangingfromoneviewtoanother.Thiseventoccurswhenauserchangesviews,andscriptingcodecanbeusedtoinsertdataintotheform.

OnAfterImport Usedtoprovideadditionalprocessingafteraformhasbeenmergedwithanotherform.Thiseventoccursafterdataisimportedfromanotherform,andscriptingcodecanbeusedtosettheappropriateviewbasedonthemergeddatacontainedintheform.

NoteTheOnSubmitRequesteventisalsoaformevent,butitwasnotusedintheEventsdevelopersampleform.

UsingtheOnVersionUpgradeevent

UsingtheOnLoadevent

UsingtheOnSwitchViewevent

UsingtheOnAfterImportevent

ShowAll

DatavalidationeventsintheEventsdevelopersampleform

TheEventsdevelopersampleformimplementsavarietyofMicrosoftOfficeInfoPath2003datavalidationeventsthatcanbeusedtovalidatedatathatisenteredintoaform.Datavalidationeventscanoccurafterachangehasbeenmadetoafieldorgroup,afterachangehasbeenmadetoafieldorgroupbutbeforethedataiscommitted,andafterachangehasbeenmadetoafieldorgroupandafterthedataiscommitted.

Touseoneofthedatavalidationevents,youmustfirstcreatetheeventintheFieldorGroupPropertiesdialogboxthatisavailablefromtheDataSourcetaskpane.Toaccessthisdialogbox,right-clickoneofthefieldsorgroupsinthetaskpane,andthenclickProperties.OntheValidationandScripttab,selecttheeventyouwishtocreate,andthenclickEdit;thisopensMicrosoftScriptEditor(MSE)anddisplaystheInfoPath-generatedeventhandler.

NoteEventhandlersinInfoPathmustbecreatedindesignmode.

ThefollowingtablelistseachofthedatavalidationeventsimplementedintheEventsdevelopersampleform,alongwithadescriptionofhowtheyareused.

Event DescriptionOnValidate Usedtovalidatethedatacontainedinthe

ContactDatesgroup.Whenthiseventoccurs,scriptingcodeisusedtoverifythatthedatesusedarewithinaspecifiedrange.

OnBeforeChange UsedtovalidatethedatacontainedintheEmailCampaignStart,PhoneContactStart,andRepresentativeVisitdatefields.Whenthiseventoccurs,scriptingcodeisusedtoimplementbusinesslogicthatchecksfortheexistenceofcertaindatesbeforeotherscanbeenteredorremoved.

OnAfterChange UsedtocallafunctionthatcalculatesthetotalcampaigncostsandupdatestheCampaignCost

field.

UsingtheOnValidateevent

UsingtheOnBeforeChangeevent

UsingtheOnAfterChangeevent

ShowAll

ControleventsintheEventsdevelopersampleform

TheEventsdevelopersampleformimplementsasingleMicrosoftOfficeInfoPath2003controleventthatcanrespondtoabuttonclick;thisistheOnClickevent.TheOnClickeventoccursafterauserclicksabuttononaform.

NoteTheOnClickeventistheonlycontroleventsupportedbyInfoPath.

TousetheOnClickevent,youmustfirstcreatetheeventintheButtonPropertiesdialogboxthatisavailableontheshortcutmenuforthebuttoncontrol.OntheGeneraltab,setScriptastheAction,andthenclickMicrosoftScriptEditor.ThiswillopenMicrosoftScriptEditor(MSE)anddisplaytheInfoPath-generatedeventhandler.

NoteEventhandlersinInfoPathmustbecreatedindesignmode.

IntheEventsdevelopersampleform,theOnClickeventisimplementedforthethreebuttonsthatareusedtoswitchbetweenviews.ThefollowingexamplefromtheEventsdevelopersampleformshowstheOnClickeventhandlerfortheSwitchtoNewCustomerViewbutton:

functionbtnSwitchNew::OnClick(eventObj){XDocument.View.SwitchView("NewCustomer")}

NoteThenameofthebuttonusedintheeventhandlerdeclarationisdeterminedbythevaluesetfortheScriptIDboxintheButtonPropertiesdialogbox.

ShowAll

AbouttheStructuralEditingdevelopersampleform

TheStructuralEditingdevelopersampleformdemonstratessomeofthewaysinwhichtheunderlyingXMLdocumentofaMicrosoftOfficeInfoPath2003formmaybeeditedusingacombinationofcontrols,menuitems,toolbarbuttons,andscript.WhenfillingoutaforminInfoPath,usersareessentiallyeditinganXMLdocumentinaneasy-to-use,graphicalformat.AlthoughtheStructuralEditingdevelopersampleformisprimarilyintendedtodemonstratestructuralediting,itisusedtoillustratetwotypesofeditingthatcanoccurinaform:

FieldeditingEditingthatmodifiesthetextinafield(anelementorattributeintheform'sunderlyingXMLdocument).Forexample,enteringdatadirectlyintoatextboxcontrolchangestheunderlyingdataintheelementorattributethatthecontrolisboundto.

StructuraleditingEditingthatchangesthestructureoftheform'sunderlyingXMLdocument.StructuraleditingallowsfragmentsofXML(elementsandtheirassociatedchildelements,attributes,andcontent)tobeinserted,removed,orreplacedinasingleoperation.Forexample,addingitemstoarepeatingsection,repeatingtable,orlistcontrolcreatesnewelementsandattributeswithinthepartoftheXMLdocumentthatthecontrolisboundto.

BothfieldeditingandstructuraleditingareusuallyimplementedbyusingcontrolsthatconnectaformtoanunderlyingXMLdocument,allowinguserstoenterormodifythedatathattheXMLdocumentcontains.However,youmayalsoimplementfieldorstructuraleditingbyusingscriptingcodeinconjunctionwiththeInfoPathobjectmodel.

Inadditiontofieldandstructuralediting,InfoPathprovidestheconceptofeditingcontext,whichmeansthateditingactionscanbedependentonthecurrentselectionorinsertionpoint.Forexample,theAddPartBeforeCurrentbuttononthePartToolbarcustomtoolbaroftheStructuralEditingdevelopersampleforminsertsanewrowinthePartstableatapositionbasedonthecurrentcontext.Thebuttonisenabledonlyifthecurrentselectionisonorwithinoneoftherowsinthetable.

Totestthefeaturesofthesampleform,simplytypedatadirectlyintothefieldsontheform,orusetheInsertmenu,thePartCatalogcustomtask

pane,theshortcutmenu,orthePartToolbarcustomtoolbartoinsertorremoverowsinthePartstable.

NoteToseeallofthefilesthatmakeuptheStructuralEditingdevelopersampleform,opentheformandclickExtractFormFilesontheFilemenuwhileindesignmode.Thisextractsalloftheformfilesfromtheformtemplatefileandsavesthemtoaspecifiedfolderonyourharddisk.

TolearnhoweditingfeaturesareimplementedintheStructuralEditingdevelopersampleform,seethefollowingtopics:

FieldeditingintheStructuralEditingdevelopersampleform

StructuraleditingintheStructuralEditingdevelopersampleform

EditingcontextintheStructuralEditingdevelopersampleform

ShowAll

FieldeditingintheStructuralEditingdevelopersampleform

FieldeditinginaMicrosoftOfficeInfoPath2003formoccurswhendataisentereddirectlyintoaformfield(usuallyatextboxcontrol)asauserfillsoutaform.ThedatathatisenteredisstoredasavalueoftheelementorattributeoftheXMLfield(elementorattribute)intheunderlyingXMLdocumentthatthecontrolisboundto.Forexample,intheStructuralEditingdevelopersampleform,textboxesareusedforeditingthedatacontainedinthePartNumber,Description,Quantity,andUnitPricefields.

Fieldeditingusuallyoccurswhenauserentersdatawithinacontrolonaform;thedatathattheuserentersisstoredintheform'sunderlyingXMLdocument.However,youcanalsousescriptingcodetomanipulatethedatacontainedintheform'sunderlyingXMLdocumentbymodifyingtheXMLdocumentitself.Iftheformincludesacontrolsuchasatextboxthatisboundtothemodifieddata,thedatadisplayedintheformwillbeupdatedautomatically.

Usingcontrolsforfieldediting

Usingscriptforfieldediting

ShowAll

StructuraleditingintheStructuralEditingdevelopersampleform

StructuraleditinginaMicrosoftOfficeInfoPath2003formoccurswhenauserisfillingoutaform,andthetypeofeditingactionsthattheuserperformsresultsinastructuralchangetotheform'sunderlyingXMLdocument.StructuralchangesinvolveinsertingorremovingelementsandattributesintheunderlyingXMLdocumentthattheformisboundto.Forexample,intheStructuralEditingdevelopersampleform,structuralchangesaremadewhenauserinsertsorremovesitemsfromthePartstableortheNotesbulletedlist.

StructuraleditingcontrolshavepredeterminededitingactionsthatcanbeassociatedwithtoolbarbuttonsandmenuitemsinInfoPathuserinterfaceareas.TheCommandsdialogboxthatisavailablefromastructuraleditingcontrol'sPropertiesdialogboxallowsyoutochoosewhicheditingactionsofthecontrolareavailabletousers,whichuserinterfaceareatheyappearin,andthelabelsthatareusedfortheassociatedbuttonormenuitems.Thestructuraleditingcontrolsusedinthissampleformincludearepeatingtableandabulletedlist.

StructuraleditingcanbeimplementedbyusinganInfoPathstructuraleditingcontrol,orbyusingscriptingcodetodirectlymanipulatethedatacontainedintheform'sunderlyingXMLdocument.Iftheformincludesacontrolsuchasarepeatingsectionthatisboundtothemodified(insertedordeleted)data,thedatadisplayedintheformwillbeupdatedautomatically.

Usingcontrolsforstructuralediting

Usingscriptforstructuralediting

ShowAll

EditingcontextintheStructuralEditingdevelopersampleform

EditingcontextinaMicrosoftOfficeInfoPath2003formisthedependenceofeditingactionsonthecurrentselectionorinsertionpoint.Forexample,ifarowintheStructuralEditingdevelopersampleformPartstableisselected,thebuttonsforaddingorremovingpartsonthePartToolbarcustomtoolbarareenabledandwillinsertorremoverowsinthePartstableatapositionbasedonthecurrentcontext.Ifcurrentselectionisnotonorwithinoneoftherowsinthetable,thebuttonsaredisabled.

NoteThePartToolbarcustomtoolbarwascreatedbymodifyingthedefaultFormtoolbar.

ThefollowingaresomeoftheareasintheInfoPathuserinterfaceinwhicheditingcontextisapplicable:

InsertmenuMenuitemsavailableontheInsertmenu.Thesetypicallyincludemenuitemsforinsertingitemsinatableorsection.

ShortcutmenuMenuitemsavailableontheshortcutmenu.Thesetypicallyincludemenuitemsforinsertingorremovingitemsinatable,section,orlist.

TablemenuMenuitemsavailableontheTablemenu.Thesetypicallyincludemenuitemsforinsertingorremovingitemsinatable.

CustomtoolbarButtonsandmenuitemsavailableonacustomtoolbar.Thesetypicallyincludebuttonsormenuitemsforinsertingorremovingitemsinatableorsection,orbuttonsthatcallscriptingcode.

IntheStructuralEditingdevelopersampleform,arepeatingtablecontrolisusedtoimplementatablethatallowsuserstoeditalistofpartsinaninvoice.WhenauserchoosestoeditthetableusingtheInsertmenu,thePartToolbarcustomtoolbar,ortheshortcutmenu,InfoPathdeterminesthecontrolbeingused,andbasedontheeditingactionssetindesignmodeforthatcontrol,performstheappropriateeditingofthesourceXMLdocument.

Thestructuraleditingcontrolshavepredeterminededitingactionsthat

canbeassociatedwithtoolbarbuttonsandmenuitemsinInfoPathuserinterfaceareas.TheCommandsdialogboxthatisavailablefromastructuraleditingcontrol'sPropertiesdialogboxallowsyoutochoosewhicheditingactionsofthecontrolareavailabletousers,whichuserinterfaceareatheyappearin,andthelabelsthatareusedfortheassociatedbuttonsormenuitems.InthePartstableoftheStructuralEditingdevelopersampleform,thefollowingeditingactionsareenabled:

InsertEnabledontheInsertmenu.AllowsausertoinsertanewrowinthePartstable.

InsertAboveEnabledontheshortcutmenuandthePartToolbarcustomtoolbar.AllowsausertoinsertanewrowinthePartstablethatisabovethecurrentlyselectedrow.

InsertBelowEnabledontheshortcutmenuandthePartToolbarcustomtoolbar.AllowsausertoinsertanewrowinthePartstablethatisbelowthecurrentlyselectedrow.

RemoveEnabledontheshortcutmenuandthePartToolbarcustomtoolbar.Allowsausertoremovethecurrentlyselectedrow.

NoteOthereditingactionscanbeusedinarepeatingtablecontrolthatarenotimplementedintheStructuralEditingdevelopersampleform.

ShowAll

AbouttheUserInterfacedevelopersampleform

TheUserInterfacedevelopersampleformdemonstratesthevarietyofwaysinwhichtheuserinterfacecanbecustomizedinaMicrosoftOfficeInfoPath2003form.Theuserinterfacefeaturescustomizedinthissampleformincludemenuitemsonthemenubar,shortcutmenus,toolbarbuttonsontheFormtoolbar,andacustomtaskpane.

Totestthefeaturesofthesampleform,simplyadd,modify,orremoveCDsbyusingtheInsertmenu,theCDCollectionToolbar,ortheshortcutmenubuttonswhilefillingouttheform.YoucanswitchbetweenCDCollectionandAllTracksviewsbyusingtheViewmenuorthecustomtaskpane.

NoteToseeallofthefilesthatmakeuptheUserInterfacedevelopersampleform,opentheformandclickExtractFormFilesontheFilemenuwhileindesignmode.Thisextractsalloftheformfilesfromtheformtemplatefileandsavesthemtoaspecifiedfolderonyourharddisk.

TolearnhoweachoftheuserinterfacefeaturesisimplementedintheUserInterfacedevelopersampleform,seethefollowingtopics:

CustommenusintheUserInterfacedevelopersampleform

CustomtoolbarsintheUserInterfacedevelopersampleform

CustomtaskpanesintheUserInterfacedevelopersampleform

ShowAll

CustommenusintheUserInterfacedevelopersampleform

MicrosoftOfficeInfoPath2003providestheabilitytocontrolwhereandhowyouwantmenuitemstoappearwithintheuserinterface,primarilybyenablingordisablingthemonvariousbuilt-inmenususedwithaform.SomeofthemenusthatyoucancustomizeincludeView,Insert,andTable,aswellasshortcutmenusthataredisplayedwhenauserclickstheshortcutmenubuttonassociatedwithacertainrepeatingtable,repeatingsection,oroptionalsection.Menuscanbecustomizedforrepeatingtables,repeatingsections,optionalsections,andviews.

NoteManyoftheotherstandardInfoPathmenuscanalsobecustomized;theUserInterfacedevelopersampleformdemonstrateshowtocustomizeaselectfew.

SeveralcustommenusareimplementedintheUserInterfacedevelopersampleform.Thefollowingtableliststheviews,tables,andsectionsoftheUserInterfacedevelopersampleform,alongwiththecustommenuitemsthatwereimplementedforeachofthem.

Name Type CustommenuitemsCDCollection

View CDCollectionmenuitemontheViewmenu.

AllTracks View AllTracksmenuitemontheViewmenu.CD Repeating

sectionCDmenuitemontheSectionsubmenuoftheInsertmenu.

InsertCDabove,InsertCDbelow,andRemoveCDmenuitemsontheshortcutmenufortheCDtable.

Track Repeatingtable

TrackmenuitemontheSectionsubmenuoftheInsertmenu.

InsertTrackmenuitemontheshortcutmenufortheCDtable.

InsertTracksandRemoveTracksmenuitemson

theTablemenu.

InsertTrackabove,InsertTrackbelow,andRemoveTrackmenuitemsontheshortcutmenufortheTracktable.

Label Optionalsection

LabelmenuitemontheSectionsubmenuoftheInsertmenu.

InsertLabelmenuitemontheshortcutmenufortheCDtable.

RemoveLabelmenuitemontheshortcutmenufortheLabelcontrol.

NoteWhenyoucustomizemenusinInfoPath,thosecustomizationsareappliedattheviewlevel.Thismeansthatthecustomizationsyoumakearenotgloballyappliedtoallviews.Toapplythesamecustommenustomorethanoneview,youmustmakethemenucustomizationsineachview.

CustomizingtheViewmenu

CustomizingtheInsertmenu

CustomizingtheTablemenu

Customizingshortcutmenus

ShowAll

CustomtoolbarsintheUserInterfacedevelopersampleform

TheUserInterfacedevelopersampleformimplementsasinglecustomtoolbar,theCDCollectionToolbar,thatallowsuserstoaddorremoveaCD,Track,orLabel.Bydefault,MicrosoftOfficeInfoPath2003hasonebuilt-incustomtoolbar,theFormtoolbar,thatcanbeusedtocreatecustommenuitemsthatuserscanclicktoperformvariousactionsonaform.

TocustomizetheFormtoolbarindesignmode,youusethePropertiesdialogboxfortheparticularrepeatingsection,repeatingtable,oroptionalsectionthatyouareworkingwith.ThePropertiesdialogboxisaccessedbyright-clickingthesectionortableandclickingthePropertiesmenuitemontheshortcutmenu.InthePropertiesdialogboxforrepeatingtablesandoptionalsections,youclickCustomizeCommandstoopentheCommandsdialogbox.Forrepeatingsections,theCustomizeCommandbuttonisavailableintheSectionPropertiesdialogboxthatopenswhenyouchoosetomodifythedefaultsettingsofasection.TheCommandsdialogboxallowsyoutoassociatecertaineditingactionswithvariouscommandlocationsavailableonthemenusandtoolbarsinanInfoPathform.Tocreateacustomtoolbar,youselecttheFormToolbarlocation.

NoteIntheUserInterfacedevelopersampleform,thecommandlocationistheCDCollectionToolbar,sincethedefaultnameoftheFormtoolbarwasmodified.Modificationstothedefaultnameofatoolbarcanbemademanuallyintheformdefinition(.xsf)filebychangingthevalueofthecaptionattributeofthetoolbarelement.

Whenyoucustomizeatoolbar,InfoPathcreatesentriesinthe.xsffileusingbuttonelementswithinthetoolbarelement.Thecaptionthatappearsasthenameofthetoolbarisdeterminedbythecaptionattributeofthetoolbarelement,andthecaptionthatappearsasthenameofabuttononthetoolbarisdeterminedbythecaptionattributeofabuttonelement.

AsyouassociateeditingactionswiththecustomtoolbarusingtheCommandsdialogbox,menuitemsareplaceddirectlyonthetoolbar.

However,itispossibletocreatemenusonthetoolbarandthenaddmenuitemstothosemenus.Thisisaccomplishedbynestingthebuttonelementsofthetoolbarwithinamenuelementinthe.xsffile.

Thefollowingisasectionfromthe.xsffileoftheUserInterfacedevelopersampleformthatcontainsthetoolbarelement.Notetheuseofthemenuelementtocreateamenuonthetoolbar.

<xsf:toolbarcaption="CDCollectionToolbar"name="CDCollectionToolbar"><xsf:buttonaction="xCollection::insert"xmlToEdit="CD_10"caption="NewCD"showIf="always"></xsf:button><xsf:buttonaction="xCollection::insert"xmlToEdit="Track_14"caption="NewTrack"showIf="always"></xsf:button><xsf:buttonaction="xOptional::insert"xmlToEdit="Label_16"caption="NewLabel"showIf="always"></xsf:button><xsf:menucaption="Remove"><xsf:buttonaction="xCollection::remove"xmlToEdit="CD_10"caption="CD"

showIf="always"></xsf:button><xsf:buttonaction="xCollection::remove"xmlToEdit="Track_14"caption="Track"showIf="always"></xsf:button><xsf:buttonaction="xOptional::remove"xmlToEdit="Label_16"caption="Label"showIf="always"></xsf:button></xsf:menu></xsf:toolbar>

Addingmenustoatoolbarisafeatureofthe.xsffileandisnotavailablewhenusingtheCommandsdialogboxindesignmode.

WhileInfoPathimplementsasinglecustomtoolbar,youcanaddmultipletoolbarstoaformbycreatingadditionaltoolbarelementswithinthe.xsffile.Onceyouhavecreatedtheadditionaltoolbarsbymanuallyeditingthe.xsffile,thosetoolbarsareavailableintheCommandsdialogbox,andyoucanthenassociateeditingactionswiththem.

ShowAll

CustomtaskpanesintheUserInterfacedevelopersampleform

TheUserInterfacedevelopersampleformimplementsacustomtaskpanethatisusedtoswitchviewsandperformothergeneral-purposeoperations,suchassortingthelistofCDs.Customtaskpanesare.htmlfilesthataredisplayedintheMicrosoftOfficeInfoPath2003taskpaneasauserfillsoutaform.Therecanbeonlyonecustomtaskpaneassociatedwithaform.

Tocreateacustomtaskpane,youmustfirstcreatean.htmlfilebyusinganHTMLeditorsuchasMicrosoftFrontPage.Youassociatethis.htmlfilewithaformbyusingtheAdvancedtabintheFormOptionsdialogboxthatisavailableontheToolsmenuindesignmode.TheAdvancedtaballowsyoutoaddthe.htmlfileandanyothersupportingfiles,suchasacascadingstylesheet(.cssfile),usingtheResourceManager.(TheResourceManagercanalsobeaccessedbyclickingResourceManagerontheToolsmenuindesignmode.)Afterthe.htmlfilehasbeenaddedasaresource,youcanselecttheEnablecustomtaskpanecheckboxandsetthenameandlocationofyourcustomtaskpane.

NoteYoumustaddthe.htmlfiletotheformusingtheResourceManagerbeforeyoucanmakethefileacustomtaskpane.

Whenyouaddacustomtaskpanetoaform,InfoPathcreatesentriesintheformdefinition(.xsf)fileusingthetaskpaneelement.Thecaptionattributeofthetaskpaneelementisusedtostorethenameofthecustomtaskpane,whilethehrefattributeisusedtostorethe.htmlfilename.Thefollowingisasectionfromthe.xsffileoftheUserInterfacedevelopersampleformthatcontainsthetaskpaneelement:

<xsf:taskpanecaption="CustomTaskPane"href="taskpane.htm"></xsf:taskpane>

InadditiontousingstandardHTMLmarkup,youcanalsousescriptingcodewithinthetaskpanethatcallstheInfoPathobjectmodel.Inthe

UserInterfacedevelopersampleform,theExtensionpropertyoftheXDocumentobjectisusedtogainaccesstothebusinesslogicfunctionscontainedintheform'sprimaryscriptfile.

Thefollowingisasectionfromthe.htmlfileusedasthecustomtaskpaneintheUserInterfacedevelopersampleform.ThecalltotheInfoPathobjectmodel'sExtensionpropertyisusedintheonClickeventfortheSortCDshyperlink.Whentheuserclicksthislink,theSortfunctionwithintheform'sprimaryscriptfileiscalled.TheSortfunctionthentakesthesourceXMLdocumentfortheformandsortsthecollectionofCDsalphabeticallyaccordingtoartistandtrack.

<divclass="action"><ahref=""onClick="gobjXDocument.Extension.Sort();returnfalse;">SortCDsbyartist/title</a></div>

NoteToviewthebusinesslogicfunctionsfortheUserInterfacedevelopersampleform,youcanopenMicrosoftScriptEditor(MSE)inInfoPathdesignmodebyclickingtheToolsmenu,pointingtoScript,andclickingMicrosoftScriptEditor,orbypressingALT+SHIFT+F11.

InfoPathObjectModelDiagram

Application ActiveWindowWindowsWindowCommandBarsMailEnvelopeTaskPanesTaskPaneHTMLDocumentHTMLWindowWindowXDocument

XDocumentUserXDocumentsXDocumentDataObjectsDataObjectDOMQueryAdapterADOAdapterWebServiceAdapterXMLFileAdapter

DataAdaptersDAVAdapterEmailAdapterHWSAdapterSharePointListAdapter

Legend

Automationobject

ExternalApplication

Eventobjects

DataDOMEvent

DocActionEvent

DocContextChangeEvent

DocEvent

DocReturnEvent

MergeEvent

SaveEvent

SignEvent

VersionUpgradeEvent

General-purposecollection

XMLNodes

WebServiceAdapterDOMErrorsError

ExtensionQueryAdapter

ADOAdapterWebServiceAdapterXMLFileAdapter

SignedDataBlocksSignedDataBlockSignaturesSignatureCertificate

SolutionDOM

UIUtil

DateMath

ViewWindow

ViewInfosViewInfo

DataAdaptersCollection

ContainsadataadapterobjectcorrespondingtoeachdataconnectionusedwithinaMicrosoftOfficeInfoPath2003form.

RemarksEachdataconnectionisusedtoretrievedata(insertedintothemaindatasourceorintoasecondarydatasource)ortosubmitdata.

Adataconnectionusedtoretrievedataforthemaindatasourcewillcorrespondtooneofthefollowingdataadapterobjecttypes:

WebServiceAdapter

ADOAdapter

NoteAnAdoAdapterobjectusedtoretrievedataforthemaindatasourcecanalsosubmitdata.

Adataconnectionusedtoretrievedataforasecondarydatasourcewillcorrespondtooneofthefollowingdataadapterobjecttypes:

ADOAdapter

SharepointListAdapter

WebServiceAdapter

XMLFileAdapter

Adataconnectionusedonlyforsubmittingdatawillcorrespondtooneofthefollowingdataadapterobjecttypes:

EmailAdapter

DAVAdapter

HWSAdapter

WebServiceAdapter

TheDataAdapterscollectioncanbeaccessedusingtheDataAdapterspropertyoftheXDocumentobject.

NoteThisobjectmodelmemberisnotsupportedwhentheDisableServicePackfeaturesoptionontheAdvancedtaboftheOptionsdialogboxinInfoPathisselectedorwhenMicrosoftOffice2003Service

Pack1orlaterisnotinstalled.AnyformthatimplementsthisobjectmodelmemberinitscodewillgenerateanerrormessageifitisopenedinInfoPathwhenservicepackfeaturesaredisabledorunavailable.

ShowAll

DataObjectsCollection

DataObjects DataObject

ContainsaDataObjectobjectforeachsecondarydatasourceusedwithinaMicrosoftOfficeInfoPath2003form.EachDataObjectobjectprovidesaccesstotheparticulardataadapterobjectthatwasusedtoconnecttotheexternaldatasource.

RemarksTheDataObjectscollectionimplementspropertiesthatcanbeusedtoaccessaform'sassociatedDataObjectobjects,anditisaccessiblethroughtheDataObjectspropertyoftheXDocumentobject.

NoteTheDataObjectscollectioncanbeusedonlytogetthecountofDataObjectobjectsthatitcontainsortoreturnareferencetoaspecifiedDataObjectobject.Itcannotbeusedtocreate,add,orremoveDataObjectobjects.

UsingtheDataObjectscollectionInthefollowingexample,implementedasanOnClickeventhandlerforabuttononaform,theDataObjectspropertyoftheXDocumentobjectisusedtosetareferencetotheDataObjectscollection.ThecodethenloopsthroughthecollectionanddisplaysthepositionalindexandnameofeachDataObjectobjectthatitcontains:

functionShowDataObjectNames::OnClick(eventObj){//SetareferencetotheDataObjectscollection.varobjDataObjects=XDocument.DataObjects;

//Loopthroughthecollectionanddisplaythename//ofeachDataObjectobjectthatitcontains.for(i=0;i<objDataObjects.Count;i++){XDocument.UI.Alert("Dataobject"+i+":"+objDataObjects(i).Name);}objDataObjects=null;}

FormoreinformationaboutusingtheDataObjectscollection,seeAccessingexternaldatasources.

ErrorsCollection

Errors Error

ContainsanErrorobjectforeacherrorwithinaMicrosoftOfficeInfoPath2003form.AnErrorobjectcontainsinformationaboutanInfoPatherror,includingitsdetailedmessage,shortmessage,code,type,andtheXMLnodethatisassociatedwithit.

RemarksTheErrorscollectionisafull-featuredcollection—itprovidespropertiesandmethodsforadding,deleting,andgainingaccesstotheErrorobjectsthatitcontains.

InadditiontomanagingtheerrorsgeneratedbyInfoPath,theErrorscollectioncanalsobeusedtocreatecustomerrorsusingtheAddmethod.

NoteCustomerrorscanalsobecreatedusingtheReportErrormethodoftheDataDOMEventobject.

UsingtheErrorscollectionTheErrorscollectionisaccessedthroughtheErrorspropertyoftheXDocumentobject.TheErrorscollectionisassociatedwithaform'sunderlyingXMLdocumentsothatwhenanerroroccurs,itoccurswithintheXMLdocument.

Inthefollowingexample,theCountpropertyoftheErrorscollectionisusedgetthecountoferrorscurrentlycontainedinthecollection:

XDocument.UI.Alert("Countoferrors:"+XDocument.Errors.Count);

TodeleteaspecificerrorfromtheErrorscollection,usetheDeletemethod,passingtheXMLcodeandconditionnameasarguments:

XDocument.Errors.Delete(myXMLNode,"MyErrorName");

TodeletealloftheerrorsintheErrorscollection,usetheDeleteAllmethod:

XDocument.Errors.DeleteAll();

TosetareferencetoanerrorwithintheErrorscollection,usetheItemproperty:

varobjError;

objError=XDocument.Errors.Item(0);//Or...objError=XDocument.Errors(0);

FormoreinformationaboutusingtheErrorscollection,seeHandlingerrors.

SignaturesCollection

ContainsacollectionofSignatureobjectsforeachsignatureintheMicrosoftOfficeInfoPath2003formorSignedDataBlockobject.

RemarksTheSignaturescollectionimplementspropertiesandamethodthatcanbeusedtoaccessaform'sassociatedSignatureobjectsandtocreateasignature.ItisaccessiblethroughtheSignedDataBlockobject.

NoteThisobjectmodelmemberisnotsupportedwhentheDisableServicePackfeaturesoptionontheAdvancedtaboftheOptionsdialogboxinInfoPathisselectedorwhenMicrosoftOffice2003ServicePack1orlaterisnotinstalled.AnyformthatimplementsthisobjectmodelmemberinitscodewillgenerateanerrormessageifitisopenedinInfoPathwhenservicepackfeaturesaredisabledorunavailable.

UsingtheSignaturescollectionWhenusingtheCreatemethod,thesignatureisnotwrittenuntiltheSignmethodiscalledontheSignatureobject.ThesemethodscanbecalledonlyfromtheOnSigneventhandler.

ShowAll

SignedDataBlocksCollection

ThecollectionoftheSignedDataBlockobjectsintheformtemplateasdefinedintheformdefinitionfile(.xsf).

RemarksTheSignedDataBlockscollectionimplementspropertiesthatcanbeusedtoaccesstheSignedDataBlockobjectsassociatedwithaform.TheSignedDataBlockscollectionisaccessiblethroughtheSignedDataBlockspropertyoftheXDocumentobject.

ShowAll

TaskPanesCollection

TaskPanes TaskPane

ContainsacollectionofTaskPaneobjectsthatrepresentthetaskpanesassociatedwithawindowinMicrosoftOfficeInfoPath2003.

RemarksTheTaskPanescollectionprovidespropertiesthatcanbeusedtoaccessacollectionoftaskpaneobjects,anditisaccessedthroughtheTaskPanespropertyoftheWindowobject.

NoteTheTaskPanescollectioncanbeusedonlytogetthecountofTaskPaneobjectsthatitcontainsandtoreturnareferencetoaspecifiedTaskPaneobject.ItcannotbeusedtoaddorremoveTaskPaneobjects.

UsingtheTaskPanescollectionInthefollowingexample,theTaskPanespropertyoftheWindowobjectisusedtosetareferencetotheTaskPanescollection:

varobjTaskPanes;

objTaskPanes=XDocument.View.Window.TaskPanes;

Inthefollowingexample,theItempropertyoftheTaskPanescollectionisusedtosetareferencetoaspecifiedTaskPaneobject.ThenthecodeusestheVisiblepropertyoftheTaskPaneobjecttomakethetaskpanevisible.

varobjTaskPane;

//Showthebuilt-inHelptaskpane.objTaskPane=XDocument.View.Window.TaskPanes(4);objTaskPane.Visible=true;

NoteTheItempropertyargumentisthetypeoftaskpanetoreturn,basedontheTypepropertyoftheTaskPaneobject,notthepositionoftheTaskPaneobjectintheTaskPanescollection.

ShowAll

ViewInfosCollection

ViewInfos ViewInfo

ContainsaViewInfoobjectforeachviewwithinaMicrosoftOfficeInfoPath2003form.ViewInfoobjectscontaindescriptiveinformationabouttheviewsthattheyareassociatedwith.

RemarksTheViewInfoscollectionimplementspropertiesthatcanbeusedtoaccessaform'sassociatedViewInfoobjects,anditisaccessiblethroughtheViewInfospropertyoftheXDocumentobject.

NoteTheViewInfoscollectioncanbeusedonlytogetthecountofViewInfoobjectsthatitcontainsortoreturnareferencetoaspecifiedViewInfoobject.Itcannotbeusedtocreate,add,orremoveViewInfoobjects.

UsingtheViewInfoscollectionInthefollowingexample,implementedasanOnClickeventhandlerforabuttononaform,theViewInfospropertyoftheXDocumentobjectisusedtosetareferencetotheViewInfoscollection.ThecodethenloopsthroughthecollectionanddisplaysthepositionalindexandnameofeachViewInfoobjectthatitcontains.

functionShowViewNames::OnClick(eventObj){//SetareferencetotheViewInfoscollection.varobjViewInfos=XDocument.ViewInfos;

//Loopthroughthecollectionanddisplaythename//ofeachViewInfoobjectthatitcontains.for(i=0;i<objViewInfos.Count;i++){XDocument.UI.Alert("Viewname"+i+":"+objViewInfos(i).Name);}objViewInfos=null;}

ShowAll

WindowsCollection

Windows Window

ContainsaWindowobjectforeachwindowwithinaMicrosoftOfficeInfoPath2003form.WindowobjectsrepresentthetwotypesofwindowsthatareusedintheInfoPathapplication:theeditingwindowthatisusedastheformareawhenauserfillsoutaform,andthedesigningwindowthatisusedasthedesignmodewhenauserdesignsaform.

RemarksTheWindowscollectionimplementspropertiesthatcanbeusedtoaccessaform'sassociatedWindowobjects,anditisaccessiblethroughtheWindowspropertyoftheXDocumentobject.

NoteTheWindowscollectioncanbeusedonlytogetthecountofWindowobjectsthatitcontainsortoreturnareferencetoaspecifiedWindowobject.Itcannotbeusedtocreate,add,orremoveWindowobjects.

UsingtheWindowscollectionInthefollowingexample,implementedasanOnClickeventhandlerforabuttononaform,theWindowspropertyoftheApplicationobjectisusedtosetareferencetotheWindowscollection.ThecodethenloopsthroughthecollectionanddisplaysthetypeofeachWindowobjectthatitcontains.

functionShowWindowTypes::OnClick(eventObj){//SetareferencetotheWindowscollection.varobjWindows=Application.Windows;varstrWindowType;

//Loopthroughthecollectionanddisplaythetype//ofeachWindowobjectthatitcontains.for(i=0;i<objWindows.Count;i++){switch(objWindows(i).Type){case0:strWindowType="Editingwindow";break;case1:strWindowType="Designingwindow";break;}

XDocument.UI.Alert("Windowtype"+i+":"+strWindowType);}objWindows=null;strWindowType=null;}

FormoreinformationaboutusingtheWindowscollection,seeWorkingwithformwindows.

XDocumentsCollection

XDocuments XDocument

ContainsanXDocumentobjectforeachMicrosoftOfficeInfoPath2003formthatiscurrentlyopen.TheXDocumentobjectrepresentsaform'sunderlyingXMLdocumentandcanbeusedtointeractwiththeXMLdatathataformcontains.

RemarksTheXDocumentscollectionimplementsanumberofpropertiesandmethodsthatcanbeusedtoaccessaform'sassociatedXDocumentobject,ortocreateandopentheformsthemselves.TheXDocumentscollectionisaccessedthroughtheXDocumentspropertyoftheApplicationobject.

UsingtheXDocumentscollectionInthefollowingexample,theOpenmethodoftheXDocumentscollectionisusedtoopenanexistingform:

Application.XDocuments.Open("C:\\MyForm.xml");

YoucanalsocreateanewformbasedonanexistingformusingtheNewmethod:

Application.XDocuments.New("C:\\MyForm.xml");

ToaccessanXDocumentobjectcontainedintheXDocumentscollection,youcanpassthepositionalindexorthelocationpathtotheItemmethod:

varobjXDoc;

objXDoc=Application.XDocuments(0);//or...objXDoc=Application.XDocuments("C:\\MyForm.xml");

FormoreinformationaboutusingtheXDocumentscollection,seeAccessingformdata.

ShowAll

XMLNodesCollection

XMLNodes

ContainsacollectionofXMLDocumentObjectModel(DOM)nodes.TheXMLNodescollectionisageneral-purposecollectionthatisusedbyanumberofMicrosoftOfficeInfoPath2003methods.

RemarksTheXMLNodescollectionprovidespropertiesthatcanbeusedtoaccessacollectionofXMLDOMnodes,anditisreturnedbyboththeGetSelectedNodesandGetContextNodesmethodsoftheViewobject.

AfteryouhavesetareferencetooneoftheXMLDOMnodeobjectsthattheXMLNodescollectioncontains,youcanuseanyofthepropertiesandmethodsthattheXMLDOMprovidesforinteractingwithanXMLnodeobject.

NoteTolearnmoreabouttheXMLDOMandallofthepropertiesandmethodsthatitsupports,seetheMSXML5.0SDKdocumentationintheMicrosoftScriptEditor(MSE)Helpsystem.

UsingtheXMLNodescollectionInthefollowingexample,areferenceissettoacollectionofXMLDOMnodesreturnedbytheGetSelectedNodesmethodoftheViewobject.ThenthecodedisplaysthenameandsourceXMLofthefirstnodefoundinthecollectionusingamessagebox:

varobjXMLNodes;

objXMLNodes=XDocument.View.GetSelectedNodes();

if(objXMLNodes.Count>0){XDocument.UI.Alert(objXMLNodes(0).nodeName+"\n\n"+objXMLNodes(0).text);}

ShowAll

ADOAdapterObject

ADOAdapter

RepresentsaconnectiontoaMicrosoftActiveXDataObjects/OLEDBdatasource.TheADOAdapterobjectisatypeofMicrosoftOfficeInfoPath2003dataadapterthatcontainsalltheinformationnecessaryforretrievingandsubmittingdatatoanexternaldatasource.

RemarksForsecondarydatasources,theADOAdapterobjectprovidespropertiesthatcanbeusedtogetandsetinformationaboutthedataadapter'sconnectionstring,SQLcommandtext,andtimeoutvalue.ItalsoprovidesamethodforcreatinganSQLcommandtextfragmentbasedonaspecifiedXMLnode.

IfanADO/OLEDBdatasourceisusedastheprimarydatasourceforaform,theADOAdapterobjectisaccessiblethroughtheQueryAdapterpropertyoftheXDocumentobject.

NoteTheADOAdapterobjectislimitedtoworkonlywithMicrosoftSQLServerandMicrosoftAccessdatabases.

UsingtheADOAdapterobjectTheADOAdapterobjectisaccessiblethroughtheQueryAdapterpropertyoftheDataObjectobject,andDataObjectobjectsareaccessiblethroughtheDataObjectspropertyoftheXDocumentobject.

Inthefollowingexample,theTimeoutpropertyoftheADOAdapterobjectisusedtosetthetimeoutforaparticularqueryoperation,returningthetimeouttoitsoriginalvalueafterthequeryoperationiscomplete:

functionRunLongQuery(){

varobjADOAdapter;varintTimeout;//SetareferencetotheADOAdapterobject.objADOAdapter=XDocument.DataObjects("CityDropDownList").QueryAdapter;

//Savetheoriginaltimeoutvalue.intTimeout=objADOAdapter.Timeout;

//Setalongertimeoutvalueandthenrunthequery.objADOAdapter.Timeout=60;XDocument.DataObjects("CityDropDownList").Query();

//Restoretheoriginaltimeoutvalue.objADOAdapter.Timeout=intTimeout;objADOAdapter=null;intTimeout=null;}

FormoreinformationaboutusingtheADOAdapterobject,see

Accessingexternaldatasources.

ShowAll

ApplicationObject

Application

RepresentstheMicrosoftOfficeInfoPath2003application.TheApplicationobjectincludespropertiesandmethodsthatreturnreferencestothehigh-levelobjectsoftheInfoPathobjectmodel.Forexample,theXDocumentspropertyreturnsareferencetoacollectionofXDocumentobjects.

RemarksTheApplicationobjectisthetop-levelobjectintheInfoPathobjectmodel,anditprovidesanumberofpropertiesandmethodsthatcanbeusedtoaccesslower-levelcollectionsandobjectsintheobjectmodel,andtoperformavarietyofgeneralpurposefunctions.

UsingtheApplicationobjectTheApplicationobjectcanbeuseddirectlyinscriptingcodeasinthefollowingMicrosoftJScriptexample,whichusestheAlertmethodoftheUIobject,accessedthroughtheXDocumentobject,todisplayamessageboxthatindicatestheversionnumberofthecurrentinstanceofInfoPath:

XDocument.UI.Alert("Applicationversion:"+Application.Version);

NotethattheXDocumentpropertywasnotqualifiedwiththenameoftheApplicationobject.ThisisbecauseboththeApplicationobjectandtheXDocumentobjectareembeddeddirectlyintheInfoPathscriptengine,andthereforetheydonothavetobeexplicitlydeclared.However,theydoneedtobedeclaredwhenusedinanexpressionorargument,astheexampleabovedemonstrates.

NoteTheApplicationobjectcontainsthefollowingmethodsthatcanbeusedwithinInfoPath:

Method DescriptionFormatString FormatsthespecifiedstringorXMLnode

accordingtothespecifiedcategoryandoptionsparameters.

IsDestinationReachable ReturnsaBooleanvalueindicatingwhetherthespecifiedUniformResourceLocator(URL),universalnamingconvention(UNC)path,orIPaddressofthedestinationcomputercanbeconnectedtofromtheclientcomputer.

NewADODBConnection CreatesandreturnsareferencetoanemptyActiveXDataObjects(ADO)Connectionobject.

NewADODBRecordset CreatesandreturnsareferencetoanemptyActiveXDataObjects(ADO)Recordsetobject.

NoteTheApplicationobjectcontainsthefollowingmethodsthatcanbe

usedforexternalautomation:

Method DescriptionCacheSolution Examinestheformtemplateinthecacheand,if

necessary,updatesitfromthepublishedlocationoftheformtemplate.

Quit QuitstheMicrosoftOfficeInfoPath2003application.

RegisterSolution InstallsthespecifiedMicrosoftOfficeInfoPathformtemplate.

UnregisterSolutionUninstallsthespecifiedMicrosoftOfficeInfoPath2003formtemplate.

TheXDocumentscollectioncontainsthefollowingadditionalmethodsthatcanbeusedforexternalautomation:

Method DescriptionClose ClosesthespecifiedMicrosoftOffice

InfoPath2003form.New CreatesanewMicrosoftOfficeInfoPath

2003formbasedonthespecifiedform.NewFromSolution CreatesanewMicrosoftOfficeInfoPath

2003formbasedonthespecifiedformtemplate.

NewFromSolutionWithData CreatesanewMicrosoftOfficeInfoPath2003formusingthespecifiedXMLdataandformtemplate.

Open OpensthespecifiedMicrosoftOfficeInfoPath2003form.

AlthoughtheExternalApplicationobjectisdeprecatedinMicrosoftOfficeInfoPath2003ServicePack1,replacedwiththemethodsintheabovetables,ExternalApplicationmethodsarestillavailableforbackwardcompatibility.

FormoreinformationaboutusingtheApplicationobject,seeAccessingapplicationdata.

ButtonObject

TheButtonobjectistheMicrosoftOfficeInfoPath2003objectthatisusedtoimplementtheOnClickeventthatisassociatedwithabuttononanInfoPathform.Thisobjectcannotbeuseddirectlyincode.

ShowAll

CertificateObject

RepresentstheX.509digitalcertificatethathasbeenusedtocreateasignature.

RemarksNoteThisobjectmodelmemberisnotsupportedwhentheDisableServicePackfeaturesoptionontheAdvancedtaboftheOptionsdialogboxinInfoPathisselectedorwhenMicrosoftOffice2003ServicePack1orlaterisnotinstalled.AnyformthatimplementsthisobjectmodelmemberinitscodewillgenerateanerrormessageifitisopenedinInfoPathwhenservicepackfeaturesaredisabledorunavailable.

UsingtheCertificateobjectUsetheCertificatepropertyoftheSignatureobjecttoreturnaCertificateobject.

TheCertificateobjectcontainsthefollowingproperties,whichcanbeusedtoreturninformationaboutadigitalcertificate:

Property DescriptionIssuedTo Returnstowhomthedigitalcertificateisissued.IssuedBy Returnstheissuerofthedigitalcertificate.ExpirationDateReturnstheexpirationdateofthedigitalcertificate.Status Returnsthestatusofthedigitalcertificate.

ShowAll

DataDOMObject

DataDOM

TheDataDOMobjectistheMicrosoftOfficeInfoPath2003objectthatisusedtoimplementthedatavalidationeventsthatareassociatedwiththeXDocumentobject.Thisobjectcannotbeuseddirectlyinscriptingcode.

ShowAll

DataDOMEventObject

DataDOMEvent

AneventobjectthatisusedduringMicrosoftOfficeInfoPath2003datavalidationevents.TheDataDOMEventobjectprovidesanumberofpropertiesandamethodthatcanbeusedwithinadatavalidationeventtoprogrammaticallyinteractwiththedatathatisbeingvalidatedandtoprovidearesponseifthedataisnotvalid.

RemarksTheDataDOMEventobjectispassedasaparametertotheOnBeforeChange,OnValidate,andOnAfterChangeevents.

NoteTheOnValidateeventcanoccurwithoutachangeintheform'sunderlyingXMLdocument.

TheDataDOMEventobjectisusedtogetinformationabouttheXMLDocumentObjectModel(DOM)nodethatisbeingchanged,anditalsoprovidesapropertyforgettingareferencetoaform'sunderlyingXMLdocument.Inaddition,itprovidespropertiesforhandlingthechangeindata,includingrejectingthechangeandcreatinganerrormessage.

NoteTheDataDOMEventobjectispassedasanargumenttooneofthedatavalidationeventhandlers.Itspropertiesandmethodareonlyavailableduringtheeventthatitispassedto.

UsingtheDataDOMEventobjectInthefollowingexamplefromtheDataValidationdevelopersampleform,theDataDOMEventobjectisusedtocheckthevalueofthenodeusingtheSiteproperty.Ifthedatavalidationfails,theReportErrormethodisusedtocreateacustomerror.

functionmsoxd__itemB_quantityListB::OnValidate(eventObj){if(parseInt(eventObj.Site.nodeTypedValue,10)>50)eventObj.ReportError(eventObj.Site,"Invalidquantity."+"Thetotalnumberofeachtypeofblockcannotexceed50.",false);

if(parseInt(eventObj.Site.nodeTypedValue,10)<0)eventObj.ReportError(eventObj.Site,"Invalidquantity."+"Thetotalnumberofeachtypeofblockcannotbelessthan0.",false);}

FormoreinformationaboutusingtheDataDOMEventobject,seeRespondingtoformevents.

ShowAll

DataObjectObject

DataObjects DataObject

Representsalinktothedataadapterofasecondarydatasource.TheDataObjectobjectactsasanintermediarybetweenaMicrosoftOfficeInfoPath2003formandthedataadapterobjectthatisusedtoaccessdatathatiscontainedinanexternaldatasource.

TheDataObjectobjectprovidespropertiesandmethodsthatcanbeusedtoprogrammaticallyinteractwithdataadapterobjects,includingretrievinginformationaboutthedataadapterobjectsandaccessingthedatathattheyconnectto.TheDataObjectobjectisaccessiblethroughtheDataObjectspropertyoftheXDocumentobject.

RemarksAnexternaldatasourcecantaketheformofaMicrosoftAccessorMicrosoftSQLServerdatabase,an.xmlfile,oranXMLWebservice.Thetypeofdataadapterobjectusedtoaccesstheexternaldatasourcedependsonthetypeofdatasource.TheDataObjectobjectprovidesacommonsetofpropertiesandamethodthatcanbeusedforalltypesofdataadapterobjects,andeachofthedataadapterobjectsprovidesitsownsetofpropertiesandmethods.

MicrosoftOfficeInfoPath2003supportsthreetypesofdataadapters:

1. ActiveXDataObjectsRepresentedbytheADOAdapterobject.

2. WebservicesRepresentedbytheWebServiceAdapterobject.

3. XMLfileRepresentedbytheXMLFileAdapterobject.

UsingtheDataObjectobjectInthefollowingcodesample,thenameofthesecondarydatasourceispassedtotheItempropertyoftheDataObjectscollection,whichreturnsareferencetotheDataObjectobject,which,inthiscase,isassociatedwithanADOAdapterdataadapterobject.UsingtheQueryAdapterpropertyoftheDataObjectobject,theADOAdapterdataadapterobject'sConnectionpropertyisusedtodisplaytheADOconnectionstringinamessagebox.

functionTestDataObjects(){varobjDataObject;//Setareferencetothespecifieddataobject.objDataObject=XDocument.DataObjects("CityList");//DisplaytheconnectioninformationfortheADOAdapterobject.XDocument.UI.Alert("DataAdapter:"+objDataObject.QueryAdapter.Connection);objDataObject=null;}

FormoreinformationaboutusingtheDataObjectobject,seeAccessingexternaldatasources.

ShowAll

DateObject

Providesseveraldate-relatedmethodsthatcanbeusedinMicrosoftOfficeInfoPath2003forms.

RemarksUsetheDatepropertyoftheUtilobjecttoreturnaDateobject.

UsingtheDateobjectTheDateobjectcontainsthefollowingmethods:

Method DescriptionNow ReturnsaVariantthatrepresentsthecurrentsystemdateand

timeinISOformat.Today ReturnsaVariantcontainingthecurrentsystemdateinISO

format.

ShowAll

DAVAdapterObject

RepresentsaconnectiontosubmitforminformationtoaMicrosoftWindowsSharePointServicesserver,orotherserversthatsupportDAVconnections.

RemarksUsetheItempropertyoftheDataAdapterscollectiontoreturnaDAVAdapterobject.

UsingtheDAVAdapterobjectTheDAVAdapterobjectcontainsthefollowingproperties:

Property DescriptionFileName ReturnsorsetsthefilenameforthecurrentMicrosoft

OfficeInfoPath2003formwhenitissubmittedbytheDAVAdapterobject.

FolderURL ReturnsorsetsthetheUniformResourceLocator(URL)towhichtheformwillbesubmittedbytheDAVAdapterobject.

Name ReturnsthenameofaDAVAdapterobject.QueryAllowed CorrespondstothequeryAllowedattributeintheform

definitionfile(.xsf).AlwaysreturnsFalsefortheDAVAdapterobject.

SubmitAllowed CorrespondstothesubmitAllowedattributeintheformdefinitionfile(.xsf).AlwaysreturnsTruefortheDAVAdapterobject.

TheDAVAdapterobjectcontainsthefollowingmethods:

Method DescriptionQuery BecausetheDAVAdapterobjectisavailableforsubmitting

dataonly,thismethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

Submit Executesthesubmitoperationontheassociatedadapter.SubmitData SubmitsthespecifiedDOMelementorDOMdocumenttoa

dataadapter.

ShowAll

DocActionEventObject

DocActionEvent

AneventobjectthatisusedduringaMicrosoftOfficeInfoPath2003buttonclickevent.TheDocActionEventobjectprovidesanumberofpropertiesthatcanbeusedwithinabuttonclickeventtoprogrammaticallyinteractwiththedatainaform'sunderlyingXMLdocumentandtocontrolthesuccessorfailureoftheevent.

RemarksTheDocActionEventobjectispassedasaparametertotheOnClickeventbuttonthatiscontainedinaviewofanInfoPathform.ItspropertiesareavailableonlyduringtheOnClickevent.

UsingtheDocActionEventobjectInthefollowingexample,theSourcepropertyoftheDocActionEventobjectisusedtodisplaythesourceXMLdataoftheinner-mostXMLDocumentObjectModel(DOM)nodeoftheform'sunderlyingXMLdocument,whichcontainsthebutton:

functionShowDocActionEventSource::OnClick(eventObj){XDocument.UI.Alert("Source:"+eventObj.Source.xml);}

FormoreinformationaboutusingtheDocActionEventobject,seeRespondingtoformevents.

DocContextChangeEventObject

AneventobjectthatisusedduringaMicrosoftOfficeInfoPath2003contextchangeevent.TheDocContextChangeEventobjectprovidesanumberofpropertiesthatcanbeusedwithinacontextchangetoprogrammaticallyinteractwiththedatainaform'sunderlyingXMLdocument,toprovidecontextualfeedbacktotheuser,ortoperformactionsfortheuser.

RemarksTheDocContextChangeEventobjectispassedasaparametertotheOnContextChangeevent.

TheDocContextChangeEventobjectisusedtogetinformationabouttheXMLDocumentObjectModel(DOM)nodethatisthecurrentcontextoftheform'sunderlyingXMLdocument.Inaddition,itprovidesinformationaboutthetypeofcontextchangeandwhetherthechangehappenedinresponsetoanundoorredooperationperformedbytheuser.

AsdescribedintheOnContextChangeeventtopic,theTypepropertyreturnsonlythevalue"ContextNode"forcontextchangesinMicrosoftInfoPath2003ServicePack1.Nevertheless,ifcodeinaneventhandlerperformsactionsthatdependoncurrentfunctionality,thatcodeshouldstillbedesignedtocheckthevalueoftheTypeproperty,becausefutureversionsofInfoPathmayusedifferentvaluesfordifferentcontextchanges.

UsingtheDocContextChangeEventobjectWhentheIsUndoRedopropertyoftheDocContextChangeEventobjectisTrue,thecontextchangewascausedbyanundoorredooperationratherthananexplicitusercontextchange.OperationsperformedintheOnContextChangeeventhandlerthatmodifytheXMLDOMshouldbeavoidedinresponsetoundoorredoactions,becausetheymayinterferewiththeuser'sintentiontorevertdatatoapreviousstate.

ExampleInthefollowingexample,anodenamedlastChangedisupdatedinresponsetocontextchanges:

functionXDocument::OnContextChange(eventObj){if(eventObj.Type=="ContextNode"&&!eventObj.IsUndoRedo){varoContextNode=eventObj.Context;varoLastChangedNode=XDocument.DOM.selectSingleNode("my:lastChanged");oLastChangedNode.text=oContextNode.nodeName;}}

DocEventObject

DocEvent

AneventobjectthatisusedduringaMicrosoftOfficeInfoPath2003mergeorviewswitchingevent.TheDocEventobjectprovidestheXDocumentpropertythatcanbeusedwithinamergeorviewswitchingeventtoprogrammaticallyinteractwiththedatainaform'sunderlyingXMLdocument.

RemarksTheDocEventobjectispassedasaparametertotheOnSwitchViewandOnAfterChangeeventsofanInfoPathform.TheXDocumentpropertythatitprovidesisavailableonlyduringtheseevents.

UsingtheDocEventobjectInthefollowingexample,theXDocumentpropertyoftheDocEventobjectisusedtodisplaythesourceXMLofaform'sunderlyingXMLdocumentusingtheDOMpropertyoftheXDocumentobject:

functionXDocument::OnSwitchView(eventObj){XDocument.UI.Alert("ThesourceXML:"+eventObj.XDocument.DOM.xml);}

FormoreinformationaboutusingtheDocEventobject,seeRespondingtoformevents.

DocReturnEventObject

DocReturnEvent

AneventobjectthatisusedduringaMicrosoftOfficeInfoPath2003loadorsubmissionevent.TheDocReturnEventobjectprovidestheXDocumentpropertythatcanbeusedwithinaloadorsubmissioneventtoprogrammaticallyinteractwiththedatainaform'sunderlyingXMLdocument.ItalsoprovidestheReturnStatuspropertythatisusedtospecifywhethertheeventissuccessful.

RemarksTheDocReturnEventobjectispassedasaparametertotheOnLoadandOnSubmitRequesteventsofanInfoPathform.Thepropertiesthatitprovidesareavailableonlyduringtheseevents.

UsingtheDocReturnEventobjectInthefollowingexample,theXDocumentpropertyoftheDocReturnEventobjectisusedtodisplaythesourceXMLofaform'sunderlyingXMLdocumentusingtheDOMpropertyoftheXDocumentobject:

functionXDocument::OnLoad(eventObj){XDocument.UI.Alert("ThesourceXML:"+eventObj.XDocument.DOM.xml);eventObj.ReturnStatus=true;}

FormoreinformationaboutusingtheDocReturnEventobject,seeRespondingtoformevents.

ShowAll

EmailAdapterObject

Representsthedataadapterforsubmittingforminformationine-mailbyusingMicrosoftOfficeOutlook.

UsingtheEmailAdapterobjectUsetheItempropertyoftheDataAdapterscollectiontoreturnanEmailAdapterobject.

Inthefollowingexample,areferencetotheEmailAdapterobjectissetbypassingthenameoftheEmailAdapterobjecttotheItempropertyoftheDataAdapterscollection:

varobjEmailAdapter;objEmailAdapter=XDocument.DataAdapters("MainSubmit");

Afterthereferencehasbeenset,youcanusethepropertiesoftheEmailAdapterobjectasshowninthefollowingexample,whichsetstheTopropertiesandtheSubjectproperty,thensubmitstheform.

objEmailAdapter.To="list@example.com";objEmailAdapter.Subject="StatusReport";objEmailAdapter.Submit();

TheEmailAdapterobjectcontainsthefollowingproperties:

Property DescriptionAttachmentFileNameReturnsorsetsthefilenametobeusedforthe

currentformwhenattachedtothee-mailmessageforanEmailAdapterobject.

BCC ReturnsorsetstheBCCrecipientsforanEmailAdapterobject.

CC ReturnsorsetstheCCrecipientsforanEmailAdapterobject.

Intro Returnsorsetstheintroductioninthebodyofthee-mailmessageforanEmailAdapterobject.

Name ReturnsthenameofanEmailAdapterobject.QueryAllowed CorrespondstothequeryAllowedattributeinthe

formdefinitionfile(.xsf).AlwaysreturnsFalsefortheEmailAdapterobject.

Subject Returnsorsetsthesubjectofthee-mailmessageforthespecifiedEmailAdapterobject.

SubmitAllowed CorrespondstothesubmitAllowedattributeintheformdefinitionfile(.xsf).AlwaysreturnsTruefortheEmailAdapterobject.

To ReturnsorsetstheTorecipientsforthespecifiedEmailAdapterobject.

TheEmailAdapterobjectcontainsthefollowingmethods:

Method DescriptionQuery BecausetheEmailAdapterobjectisavailablefor

submittingdataonly,thismethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

Submit Executesthesubmitoperationontheassociateddataadapter.

SubmitData SubmitsthespecifiedDOMelementorDOMdocumenttoadataadapter.

ShowAll

ErrorObject

Errors Error

RepresentsanerrorinaMicrosoftOfficeInfoPath2003form.EachErrorobjectinInfoPathiseachassociatedwithanXMLDocumentObjectModel(DOM)nodefromaform'sunderlyingXMLdocument.WhendatavalidationfailsforaparticularXMLDOMnode,InfoPathcreatesanErrorobjectandplacesitintheErrorscollection.

RemarksThatarethreetypesofdatavalidationerrorsthatcanoccurinanInfoPathform:

SCHEMA_VALIDATIONDatavalidationfailedasaresultofanXMLSchema–definedconstraint.

SYSTEM_GENERATEDDatavalidationfailedasaresultofconstraintsdefinedintheformdefinition(.xsf)fileorasaresultofscriptingcodecallingtheReportErrormethodoftheDataDOMEventobject.

USER_SPECIFIEDDatavalidationfailedasaresultofacustomscriptingerrorusingtheAddmethodoftheErrorscollection.

NoteTheTypepropertyoftheErrorobjectcanbeusedtodeterminethetypeofdatavalidationerrorthathasoccurred.

UsingtheErrorObjectTheErrorobjectprovidesanumberofpropertiesthatcanbeusedtoprogrammaticallyinteractwithanInfoPathdatavalidationerror.TheErrorobjectisaccessedthroughtheErrorspropertyoftheXDocumentobject,whichreturnsareferencetotheErrorscollection.

Inthefollowingexample,theItempropertyoftheErrorscollectionisusedtosetareferencetoanErrorobject;thentheShortErrorMessagepropertyoftheErrorobjectisisusedtodisplaytheerrormessageinamessagebox:

varobjError;

objError=XDocument.Errors(0);XDocument.UI.Alert("Errormessage:"+objError.ShortErrorMessage);

FormoreinformationaboutusingtheErrorobject,seeHandlingerrors.

ShowAll

ExternalApplicationObject

ExternalApplication

RepresentstheMicrosoftOfficeInfoPath2003application.TheExternalApplicationobjectimplementsalimitedsetofmethodsthatcanbeusedforautomatingInfoPathbyanexternalComponentObjectModel(COM)–basedprogramminglanguage.

RemarksTheExternalApplicationobjectcanbeusedtoperformalimitedsetofInfoPathoperationssuchascreating,opening,orclosingaform;registeringorunregisteringaformtemplate;orsimplyquittingtheapplication.

UsingtheExternalApplicationobjectTousetheExternalApplicationobject,youmustfirstcreateareferencetoitusingtheProgIDoftheInfoPathobjectmodelalongwiththenameoftheExternalApplicationobject.ThefollowingexampledemonstratescreatingareferencetotheExternalApplicationobjectusingtheVisualBasicforApplications(VBA)programminglanguage:

DimobjIPAsObjectSetobjIP=CreateObject("InfoPath.ExternalApplication")

NoteThisexampleuseslate-bindingforcreatingthereferencetotheExternalApplicationobject;youcanalsouseearly-bindingbysettingareferencetotheInfoPathobjectmodelinyourprogrammingenvironment.

AfteryouhavecreatedareferencetotheExternalApplicationobject,youcanthenusethemethodsthatitprovidestointeractwithInfoPath.Inthefollowingexample,writteninVBA,theOpenmethodoftheExternalApplicationobjectisusedtoopenaformbasedonthespecifiedUniformResourceIdentifier(URI):

PublicSubOpenForm()

DimobjIPAsObject

'CreatetheExternalApplicationobjectandopenaspecifiedform.SetobjIP=CreateObject("InfoPath.ExternalApplication")objIP.Open("C:\MyForms\Form1.xml")

SetobjIP=Nothing

EndSub

FormoreinformationaboutusingtheExternalApplicationobject,seeAutomatingInfoPath.

ShowAll

HTMLTaskPaneObject

HTMLTaskPane

RepresentsacustomtaskpaneinaMicrosoftOfficeInfoPath2003formthatisassociatedwithawindow.TheHTMLTaskPaneobjectprovidesanumberofpropertiesandmethodsforworkingwiththeInfoPathcustomtaskpane,anditprovidespropertiesandmethodstotheTaskPaneobjectasaninheritedobject.

RemarksThepropertiesandmethodsthatareavailableforanInfoPathtaskpanearedeterminedbythetypeoftaskpanethatyouareworkingwith.IftheTypepropertyoftheTaskPaneobjectreturns0,thetaskpaneisacustomtaskpaneandthepropertiesandmethodsthatareavailableareprovidedbytheHTMLTaskPaneobject.IftheTypepropertyreturnsanyothervalue,thetaskpaneisabuilt-intaskpaneandthepropertiesareprovidedbytheTaskPaneobjectdirectly.

TheTypepropertyisbasedontheXdTaskPaneTypeenumeration.TheseenumeratedvaluesarealsousedasargumentstotheItempropertyoftheTaskPanescollectionforreturningareferencetoaspecifiedtypeoftaskpane.

NoteThepropertiesandmethodsoftheHTMLTaskPaneobjectcannotbecalledduringanOnLoadeventbecausetheviewisnotyetloadedwhenthiseventoccurs,andtaskpanesareassociatedwiththeview.

UsingtheHTMLTaskPaneobjectInthefollowingexamplefromtheUserInterfacedevelopersampleform,theItempropertyoftheTaskPanescollectionisusedtosetaglobalreferencetotheTaskPaneobjectthatrepresentsthecustomtaskpane.ThecodethencallsascriptingfunctiondefinedintheHTMLcodeofthecustomtaskpaneusingtheHTMLDocumentpropertyoftheHTMLTaskPaneobject,whichisinheritedbytheTaskPaneobject.

functionSetTaskPaneState(){

//EnsureViewhasloadedbeforetryingtoaccessthetaskpane.if(XDocument.View){//Getareferencetothecustomtaskpane.Itisalwaysthe0-th//taskpaneintheTaskPanescollection.if(gobjTaskPane==null)gobjTaskPane=XDocument.View.Window.TaskPanes.Item(0);

//Ensurethatthetaskpaneiscompletelyloaded.if(gobjTaskPane.HTMLDocument.readyState=="complete"){varstrTaskPaneViewId="TP_"+XDocument.View.Name.replace(/\W+/g,"");

//CallascriptfunctiondefinedinthetaskpaneHTMLpage.gobjTaskPane.HTMLDocument.parentWindow.SelectView(strTaskPaneViewId);}}}

ShowAll

HTMLTaskPaneExternalObject

HTMLTaskPaneExternal

RepresentsalinktotheMicrosoftOfficeInfoPath2003objectmodel.TheHTMLTaskPaneExternalobjectisusedtoexposetheInfoPathobjectmodeltotheDynamicHTML(DHTML)scriptingcodeinacustomtaskpane.

TheHTMLTaskPaneExternalobjectprovidesanumberofpropertiesforaccessingcertainpartsoftheInfoPathobjectmodel,includingtheXDocumentobjectandtheWindowobject.

RemarksTheHTMLTaskPaneExternalobjectfacilitatesusingtheInfoPathobjectmodelwithinthescriptingcodethatispartofacustomtaskpane.TheobjectisexposedthroughtheexternalpropertyoftheDHTMLwindowobject.

UsingtheHTMLTaskPaneExternalobjectInthefollowingexample,theHTMLTaskPaneExternalobjectisusedthroughtheexternalpropertyoftheDHTMLwindowobjecttosetareferencetotheXDocumentobjectthatispartoftheInfoPathobjectmodel:

varobjXDoc;

objXDoc=window.external.XDocument;objXDoc.View.SwitchView("View2");

ShowAll

HWSAdapterObject

RepresentsaconnectiontosubmitforminformationtoaMicrosoftBiztalk2004HWS(HumanWorkflowServices)server.

UsingtheHWSAdapterobjectTheHWSAdapterobjectcontainsthefollowingproperties:

Property DescriptionName ReturnsthenameofanHWSAdapterobject.QueryAllowed CorrespondstothequeryAllowedattributeintheform

definitionfile(.xsf).AlwaysreturnsFalsefortheHWSAdapterobject.

SubmitAllowed CorrespondstothesubmitAllowedattributeintheformdefinitionfile(.xsf).AlwaysreturnsTruefortheHWSAdapterobject.

TheHWSAdapterobjectcontainsthefollowingmethods:

Method DescriptionQuery BecausetheHWSAdapterobjectisavailableforsubmitting

dataonly,thismethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

Submit Executesthesubmitoperationontheassociatedadapter.

InfoPathControlObject

DefinesmethodsusedfromtheimplementationofanActiveXcontrolforinitializing,uninitializing,enabling,disabling,andsavingthestateofacontrol.

RemarksTheInfoPathControlandInfoPathControlSiteobjectsandtheirmethodsandpropertiesaredesignedtobeusedonlyfromtheimplementationofanActiveXcontrol.TheseobjectsandtheirmembersarenotsupportedinInfoPathformcode.FormoreinformationonhowtocreateActiveXcontrolsthatworkwithInfoPath,seetheInfoPathDeveloperCenter.

NoteThisobjectmodelmemberisnotsupportedwhentheDisableServicePackfeaturesoptionontheAdvancedtaboftheOptionsdialogboxinInfoPathisselectedorwhenMicrosoftOffice2003EditionsServicePack1orlaterisnotinstalled.AnyformtemplatethatcontainsaviewwithanActiveXcontrolthatimplementsthisobjectmodelmemberinitscodewillgenerateanerrormessageifitisopenedinInfoPathwhenservicepackfeaturesaredisabledorunavailable.

UsingtheInfoPathControlObjectTheInfoPathControlobjectdefinesthefollowingmethodsthatmustbeimplementedbythedeveloperofanActiveXcontrolforuseonInfoPathforms.

Method DescriptionEnable DefinesamethodthatInfoPathcallswhenitneedstoenable

ordisableaninstanceofthecontrolinaview.Init Definesamethodthatperformsanyinitializationroutines

requiredwhenaninstanceofthecontrolisaddedtoanInfoPathform.

SaveState DefinesamethodthatInfoPathcallswhenitneedstosavethestateofaninstanceofthecontrolinaview.

Uninit Definesamethodthatperformsanycleanuproutinesrequiredbeforeaninstanceofthecontrolisremovedfromaview.

InfoPathControlSiteObject

RepresentstheobjectthatInfoPathpassestoanActiveXcontrolwhenitisinitializedinanInfoPathview.TheInfoPathControlSiteobjectdefinestheXDocumentpropertyforaccessingtheXDocumentobjectassociatedwithaform,andtheNodepropertyforaccessingtheXMLnodetowhichthecontrolisbound.

RemarksTheInfoPathControlSiteobjectshouldnotbeimplementedbythedeveloperofanActiveXcontrol.ItrepresentsaninterfacethatisimplementedbyInfoPathitself.

TheInfoPathControlandInfoPathControlSiteobjectsandtheirmethodsandpropertiesaredesignedtobeusedonlyfromtheimplementationofanActiveXcontrol.TheseobjectsandtheirmembersarenotsupportedinInfoPathformcode.FormoreinformationonhowtocreateActiveXcontrolsthatworkwithInfoPath,seetheInfoPathDeveloperCenter.

MailEnvelopeObject

MailEnvelope

Representsacustome-mailmessageinaMicrosoftOfficeInfoPath2003form.TheMailEnvelopeobjectprovidesanumberofpropertiesthatcanbeusedtoprogrammaticallycreateacustome-mailmessagewithinthedefaulte-maileditor,anditattachesthecurrentlyopenInfoPathformtothemessage.

RemarksAfterthee-mailmessageiscreated,thedefaulte-maileditorwilldisplaythee-mailmessage;userscantheninspectandeditthee-mailmessagebeforesendingit.

NoteTheMailEnvelopeobjectcannotbeusedtosendthee-mailmessagesitcreates;usersmustmanuallysendthee-mailmessages.

YoucanalsousetheShowMailItemmethodoftheUIobjecttoprogrammaticallycreatee-mailmessages.

UsingtheMailEnvelopeobjectTheMailEnvelopeobjectisaccessedthroughtheMailEnvelopepropertyoftheWindowobject.

InthefollowingexamplefromtheMeetingAgendasampleform,theMailEnvelopepropertyoftheWindowobjectisusedtosetareferencetotheMailEnvelopeobjectthatisassociatedwiththecurrentlyactivewindow.ThecodethenusestheMailEnvelopeobjecttocreateacustome-mailmessage.

functionSendMeetingAgendaBtn::OnClick(oEvent){varrgRecipients=newArray();varxmlRecipients=getNodeList("/mtg:meetingAgenda/mtg:attendees/mtg:attendee/mtg:emailAddressPrimary");varxmlRecipient;

while(xmlRecipient=xmlRecipients.nextNode())rgRecipients.push(xmlRecipient.text);

try{varoEnvelope=Application.ActiveWindow.MailEnvelope; oEnvelope.Subject=getNode("/mtg:meetingAgenda/mtg:subject").text;oEnvelope.To=rgRecipients.join(";");oEnvelope.Visible=true;}catch(ex){XDocument.UI.Alert(ex.description);}}

ShowAll

MathObject

Providesseveralmath-relatedmethodsthatcanbeusedinMicrosoftOfficeInfoPath2003forms.

RemarksUsetheMathpropertyoftheUtilobjecttoretunaMathobject.

UsingtheMathobjectTheMathobjectcontainsthefollowingmethods:

Function DescriptionAvg Returnstheaveragevalueofallthenumericalelementsina

nodeset.Eval Returnsthesetofresultscalculatedwhentheexpressionis

appliedtoeachsetofelementsinthecontext.Max Returnsthelargestvalueofallthenumericalelementsina

nodeset.Min Returnsthesmallestvalueofallthenumericalelementsina

nodeset.Nz Replacesemptyvaluesinthespecifiednodelistwith"0"

(zero).

MergeEventObject

AneventobjectthatisusedduringanOnMergeRequestevent.TheMergeEventobjectprovidespropertiesandmethodsthatcanbeusedduringanOnMergeRequesteventtoprogrammaticallyinteractwithaform'sunderlyingXMLdocumentandtodeterminemergepropertiessuchasthenumberoffilesbeingmerged.

RemarksDuringasinglemergeformsoperation,multipleOnMergeRequesteventswilloccur.OneOnMergeRequesteventwilloccurforeachfilebeingmerged.

UsingtheMergeEventobjectTheMergeEventobjectispassedasaparametertotheOnMergeRequesteventofanInfoPathform.Thepropertiesthatitprovidesareavailableonlyduringthisevent.

ExampleInthefollowingexample,theDOMpropertyandReturnStatuspropertyoftheMergeEventobjectandtheImportDOMmethodoftheXDocumentobjectareusedtoimport(merge)aformfromtheOnMergeRequesteventhandler:

functionXDocument::OnMergeRequest(eventObj){XDocument.ImportDOM(eventObj.DOM);

eventObj.ReturnStatus=true;}

SaveEventObject

AneventobjectthatisusedduringanOnSaveRequestevent.TheSaveEventobjectprovidesanumberofpropertiesandmethodsthatcanbeusedduringasaveoperationfromtheOnSaveRequesteventhandlertoprogrammaticallyinteractwithaform'sunderlyingXMLdocument,determinesaveproperties,andperformthesaveoperation.

UsingtheSaveEventsobjectTheSaveEventobjectispassedasaparametertotheOnSaveRequesteventofanInfoPathform.Thepropertiesthatitprovidesareavailableonlyduringthisevent.Thisobjectexpireswhenthesaveeventexpiressoitmaynotbestoredandusedoutsideofthescopeofthesaveevent.

ExampleInthefollowingexample,theReturnStatuspropertyandthePerformSaveOperationmethodoftheSaveEventobjectareusedtoperformastandardInfoPathsaveoperation:

functionXDocument::OnSaveRequest(eventObj){eventObj.PerformSaveOperation();eventObj.ReturnStatus=true;}

ShowAll

SharepointListAdapterObject

RepresentsaconnectiontoaSharePointlistordocumentlibrary.TheSharePointListAdapterobjectrepresentstheOfficeInfoPath2003dataadapterforretrievingdatafromaSharePointlistordocumentlibrary.

UsingtheSharepointListAdapterObjectForasecondarydatasource,theSharePointListAdapterobjectisaccessiblethroughtheQueryAdapterpropertyofadataadapterobject.DataadapterobjectsareaccessiblethroughtheDataAdapterspropertyoftheXDocumentobject.

TheSharepointListAdapterobjectcontainsthefollowingproperties:

Property DescriptionName ReturnsthenameoftheSharepointListAdapter

object.QueryAllowed Aread-onlypropertyoftypeBooleanthatcorresponds

tothequeryAllowedattributeintheformdefinitionfile(.xsf).AlwaysreturnsTruefortheSharepointListAdapterobject.

SiteUrl Aread-onlypropertyreturningtheUniformResourceLocator(URL)oftheSharePointsitethatthisadaptercanqueryfrom.

SubmitAllowed CorrespondstothesubmitAllowedattributeintheformdefinitionfile(.xsf).AlwaysreturnsFalsefortheSharepointListAdapterobject.

TheSharepointListAdapterobjectcontainsthefollowingmethods:

Method DescriptionQuery ReadsdatafromtheSharepointListAdapterobject.Submit BecausetheSharepointListAdapterobjectisavailablefor

receivingdataonly,thismethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

ExampleInthefollowingexample,areferencetotheSharePointListAdapterobjectisaccessedthroughtheQueryAdapterpropertyofadataadapterobjectbypassingthenameofthedataadapterobjecttotheItempropertyoftheDataAdapterscollection:

varobjSPLAdapter;objSPLAdapter=XDocument.DataAdapters("Announcements").QueryAdapter;

Afterthereferencehasbeenset,youcanusethemethodsoftheSharePointListAdapterobjectasshowninthefollowingexample,whichrequeriestheSharePointlistorlibrarytoupdatetheDOMpropertyofthedataadapterobject:

objSPLAdapter.Query();

ShowAll

SignatureObject

Representsadigitalsignaturethathasbeenaddedtoaformorsetofsigneddatainaform.

UsingtheSignatureobjectUsetheItempropertyoftheSignaturescollectiontoreturnaSignatureobject.

TheSignatureobjectcontainsthefollowingproperties,whichcanbeusedtoreturninformationaboutadigitalsignature:

Property DescriptionComment Returnsthetextcommentthatwasaddedto

thedigitalsignature.Status Returnsthestatusofthespecifieddigital

signatureSignatureBlockXmlNode ReturnstheXMLnodecorrespondingthe

digitalsignature.Certificate ReturnstheCertificateobjectfortheX.509

digitalcertificatethatwasusedwhensigningaformorasetofsigneddata.

TheSignatureobjectcontainsthefollowingmethod:

Method DescriptionSign WritestheXMLdigitalsignatureblockandcomputesthe

cryptographichashforthesigneddata.

ShowAll

SignedDataBlockObject

RepresentsasetofsigneddatainaMicrosoftOfficeInfoPath2003form.TheSignedDataBlockobjectprovidesanumberofpropertiesandonemethodthatcanbeusedtoprogrammaticallyinteractwithasetofsigneddata.

UsingtheSignedDataBlockobjectTheSignedDataBlockobjectcontainsthefollowingread-onlyproperties:

Property DescriptionXPath ReturnstheXPathexpressionofthe

setofsigneddatarepresentedbytheSignedDataBlockobject.

Name ReturnsthenameoftheSignedDataBlock.

Caption ReturnsthefriendlynameoftheSignedDataBlock.

SignatureRelation ReturnstherelationamongmultiplesignaturesontheSignedDataBlock.

Signatures ReturnsacollectionofthesignaturesofaSignedDataBlock.

XPathNamespaceDeclarations ReturnsthenamespacedefinitionsfortheSignedDataBlock.

SignatureContainer ReturnstherootXMLnodeofthesub-treethatcontainsthesignature(s).

TheSignedDataBlockobjectcontainsthefollowingmethod:

Method DescriptionSign InvokestheDigitalSignaturesdialogboxtoaddadigital

signaturetotheSignedDataBlocksectionoftheform.

ShowAll

SignEventObject

AneventobjectthatisusedduringtheOnSignevent.

UsingtheSignEventobjectUsetheSignedDataBlockpropertyoftheSignEventObjectobjecttodeterminewhichsigneddatablockistriggeringtheOnSignevent.TheOnSigneventisraisedforafullytrustedformtemplateonly.

ExampleInthefollowingexample,theSignEventobjectisusedtoaddasignatureandtimestamptoaSignedDataBlockobject:

[InfoPathEventHandler(EventType=InfoPathEventType.OnSign)]publicvoidOnSign(SignEvente){Signaturesignature=e.SignedDataBlock.Signatures.Create(); signature.Sign();

//Countersignthesignaturewithatrustedtimestamp.

//GettheXMLnodestoringthesignatureblock. IXMLDOMNodeoNodeSig=signature.SignatureBlockXmlNode; IXMLDOMNodeoNodeSigValue=oNodeSig.selectSingleNode(".//*[local-name(.)=’signatureValue’]"); //Gettimestampfromtimestampservice(fictitious). MyTrustedTimeStampingServices=newMyTrustedTimeStampingService(); stringstrVerifiedTimeStamp=s.AddTimeStamp(oNodeSigValue.text); //Addthevaluereturnedfromthetimestampingservicetothe //unsignedpartofthesignatureblock. IXMLDOMNodeoNodeObj=oNodeSig.selectSingleNode(".//*[local-name(.)=’Object’]"); IXMLDOMNodeoNode=oNodeObj.cloneNode(false); oNode.text=strVerifiedTimeStamp; oNodeObj.parentNode.appendChild(oNode);

e.ReturnStatus=true;}

ShowAll

SolutionObject

Solution

CorrespondstoaMicrosoftOfficeInfoPath2003formtemplate.TheSolutionobjectimplementspropertiesforgettinginformationaboutaformtemplate,includingitsversionnumber,theUniformResourceLocator(URL)ofitsextractedformfiles,theURLitwasloadedfrom,andanXMLDocumentObjectModel(DOM)containingitsformdefinition(.xsf)file.

RemarksTheSolutionobjectisaccessedthroughtheSolutionpropertyoftheXDocumentobject.

UsingtheSolutionobjectInthefollowingexample,areferenceissettotheSolutionobject,thenthecodegetsthenameofthepersonwhoauthoredtheformfromthe.xsfusingtheDOMpropertyoftheSolutionobject.Atestisthenmadetodetermineifthereisanauthorvalue,andtheresultsaredisplayedinamessagebox.

functionSolutionInfo::OnClick(eventObj){varobjSolution=XDocument.Solution;varstrSolutionVersion=objSolution.Version;varobjAuthorNode=objSolution.DOM.selectSingleNode("xsf:xDocumentClass/@author");varstrAuthorText;

if(objAuthorNode!=null)strAuthorText=objAuthorNode.text;elsestrAuthorText="Authornotavailable.";

XDocument.UI.Alert("Version:"+strSolutionVersion+"\nAuthor:"+strAuthorText);}

FormoreinformationaboutusingtheSolutionobject,seeAccessingapplicationdata.

ShowAll

TaskPaneObject

TaskPanes TaskPane

RepresentsataskpaneinaMicrosoftOfficeInfoPath2003formthatisassociatedwithawindow.TheTaskPaneobjectprovidesanumberofpropertiesforworkingwiththeInfoPathbuilt-intaskpanes,andtheHTMLTaskPaneobjectinheritsthosepropertiesandmethodsforworkingwithacustomtaskpane.

RemarksThepropertiesandmethodsthatareavailableforanInfoPathtaskpanearedeterminedbythetypeoftaskpanethatyouareworkingwith.IftheTypepropertyoftheTaskPaneobjectreturns0,thetaskpaneisacustomtaskpaneandthepropertiesandmethodsthatareavailableareprovidedbytheHTMLTaskPaneobject.IftheTypepropertyreturnsanyothervalue,thetaskpaneisabuilt-intaskpaneandthepropertiesareprovidedbytheTaskPaneobjectdirectly.

NoteTheTypepropertyisbasedontheXdTaskPaneTypeenumeration.TheseenumeratedvaluesarealsousedasargumentstotheItempropertyoftheTaskPanescollectionforreturningareferencetoaspecifiedtypeoftaskpane.

UsingtheTaskPaneobjectInthefollowingexamplefromtheUserInterfacedevelopersampleform,theItempropertyoftheTaskPanescollectionisusedtosetaglobalreferencetotheTaskPaneobjectthatrepresentsthecustomtaskpane.ThecodethencallsascriptingfunctiondefinedintheHTMLcodeofthecustomtaskpaneusingtheHTMLDocumentpropertyoftheHTMLTaskPaneobject,whichisinheritedbytheTaskPaneobject.

functionSetTaskPaneState(){

//EnsureViewhasloadedbeforetryingtoaccessthetaskpane.if(XDocument.View){//Getareferencetothecustomtaskpane.Itisalwaysthe0-th//taskpaneintheTaskPanescollection.if(gobjTaskPane==null)gobjTaskPane=XDocument.View.Window.TaskPanes.Item(0);

//Ensurethatthetaskpaneiscompletelyloaded.if(gobjTaskPane.HTMLDocument.readyState=="complete"){varstrTaskPaneViewId="TP_"+XDocument.View.Name.replace(/\W+/g,"");

//CallascriptfunctiondefinedinthetaskpaneHTMLpage.gobjTaskPane.HTMLDocument.parentWindow.SelectView(strTaskPaneViewId);}}}

UIObject

RepresentsvarioususerinterfacecomponentsthatcanbeusedinaMicrosoftOfficeInfoPath2003form.TheUI(userinterface)objectprovidesanumberofmethodsfordisplayingcustomandbuilt-indialogboxes.

RemarksTheUIobjectisusedtoprogrammaticallydisplayvarioustypesofdialogboxestousersastheyfilloutaform.ItisnotusedformodifyingtheInfoPathuserinterface.

UsingtheUIobjectTheUIobjectisaccessedthroughtheUIpropertyoftheXDocumentobject.

TheUIobjectprovidestheAlertmethod,whichisusedtodisplayasimplemessageboxwithsomecustomtext,asshowninthefollowingexample:

XDocument.UI.Alert("Custommessagetextgoeshere.");

Oneofthebuilt-inInfoPathdialogboxesthattheUIobjectcandisplayistheDigitalSignaturesdialogbox;thisdialogboxcanbedisplayedtotheuserbyusingtheShowSignatureDialogmethod,asfollows:

XDocument.UI.ShowSignatureDialog();

NoteTheShowSignatureDialogmethodcanbeusedonlyinformsthathavebeenenabledfordigitalsigning.Themethodwillreturnanerrorifusedinaformthatisnotenabledfordigitalsigning.

FormoreinformationaboutusingtheUIobject,seeDisplayingalertsanddialogboxes.

UserObject

Providesmethodsthatcanbeusedtoreturninformationaboutthecurrentuser.

UsingtheUserobjectUsetheUserpropertyoftheApplicationobjecttoreturnaUserobject.

TheUserobjectcontainsthefollowingmethods:

Method DescriptionIsCurrentUser ReturnsTrueifthecurrentusermatchesthespecified

username.IsUserMemberOfReturnsTrueifcurrentuserisamemberofthe

specifiedgroup.

ShowAll

UtilObject

ProvidesutilitymethodsthatcanbeusedwithMicrosoftOfficeInfoPath2003forms.

UsingtheUtilobjectUsetheUtilpropertyoftheXDocumentobjecttocreateaUtilobject.

TheUtilobjectcontainsthefollowingproperties:

Property DescriptionDate UsethispropertytoreturnaDateobject,whichprovides

severaldate-relatedmethods.Math UsethispropertytoreturnaMathobject,whichprovides

severalmath-relatedmethods.

TheUtilobjectcontainsthefollowingmethod:

Method DescriptionMatch Indicateswhetherastringmatchesaspecifiedpattern.

ShowAll

VersionUpgradeEventObject

VersionUpgradeEvent

AneventobjectthatisusedduringaMicrosoftOfficeInfoPath2003versionupgradeevent.TheVersionUpgradeEventobjectprovidesanumberofpropertiesthatcanbeusedwithinaversionupgradeeventtoprogrammaticallyinteractwithaform'sunderlyingXMLdocument,determinetheversionnumbersoftheformandformtemplate,andprovidearesponseindicatingthesuccessoftheversionupgradeprocess.

RemarksTheVersionUpgradeEventobjectispassedasaparametertotheOnVersionUpgradeeventofanInfoPathform.Thepropertiesthatitprovidesareavailableonlyduringthisevent.

UsingtheVersionUpgradeEventobjectInthefollowingexample,theDocumentVersionandSolutionVersionpropertiesoftheVersionUpgradeEventobjectareusedtodisplaytheversionnumbersoftheformandformtemplate:

functionXDocument::OnVersionUpgrade(eventObj){XDocument.UI.Alert("Theformversion:"+eventObj.DocumentVersion+"\nTheformtemplateversion:"+eventObj.SolutionVersion);eventObj.ReturnStatus=true;}

FormoreinformationaboutusingtheVersionUpgradeEventobject,seeRespondingtoformevents.

ViewObject

RepresentsaviewwithinaMicrosoftOfficeInfoPath2003form.TheViewobjectprovidesanumberofpropertiesandmethodsthatcanbeusedtoprogrammaticallyinteractwithanInfoPathview,includingmethodsforselectingdatacontainedintheview,switchingfromoneviewtoanother,synchronizingtheviewwithaform'sunderlyingXMLdocument,andexecutinganInfoPatheditingaction.

RemarksInfoPathformscancontainoneormoreviews,andoneviewisalwaysdefinedasthedefaultview.WhenyouworkwithaviewusingtheViewobject,youareaccessingthecurrentlyactiveview.

NoteTheInfoPathobjectmodelalsoprovidestheViewInfoscollection,whichcanbeusedtogetinformationaboutalloftheviewsimplementedinaform.

UsingtheViewobjectTheViewobjectisaccessedthroughtheViewpropertyoftheXDocumentobject.Forexample,thefollowingcodesetsareferencetoaform'scurrentlyactiveview:

varobjView;

objView=XDocument.View;

Tochangethecurrentlyactiveview,youcanusetheSwitchViewmethodoftheViewobjectasfollows:

XDocument.View.SwitchView("View2");

Toforceanupdateofaviewbasedonchangesinaform'sunderlyingXMLdocument,youcanusetheForceUpdatemethodoftheViewobject,asshownhere:

XDocument.View.ForceUpdate();

FormoreinformationaboutusingtheViewobject,seeWorkingwithviews.

ViewInfoObject

ViewInfos ViewInfo

ContainsdescriptiveinformationaboutaviewwithinaMicrosoftOfficeInfoPath2003form.

RemarksTheViewInfoobjectprovidespropertiesthatcanbeusedtogetthenameofaviewanddeterminewhetheraviewisthedefaultviewoftheform.TheViewInfoobjectisaccessiblethroughtheViewInfospropertyoftheXDocumentobject.

NoteToworkwiththeviewprogrammatically,usetheViewobject.

UsingtheViewInfoobjectInthefollowingexample,theIsDefaultpropertyoftheViewInfoobjectisusedtodeterminewhetheraviewisthedefaultviewoftheform.ThenthecodeusestheNamepropertyoftheViewInfoobjecttodisplaythenameofthedefaultviewinamessagebox.

varobjViewInfos;

//SetareferencetotheViewInfoscollection.objViewInfos=XDocument.ViewInfos;

//Determinethedefaultviewanddisplaya//messageboxwithitsname.for(i=0;i<objViewInfos.Count;i++){if(objViewInfos(i).IsDefault)XDocument.UI.Alert("Thedefaultviewis:"+XDocument.ViewInfos(0).Name);}

ShowAll

WebServiceAdapterObject

WebServiceAdapter

RepresentsaconnectiontoanXMLWebservice.TheWebServiceAdapterobjectisatypeofMicrosoftOfficeInfoPath2003dataadapterthatcontainsalltheinformationnecessaryforretrievingdatafromandsubmittingdatatoanexternaldatasource.

RemarksTheWebServiceAdapterobjectprovidespropertiesthatcanbeusedtogetandsetinformationaboutthedataadapter'sinputandoperationstrings.ItalsoprovidesapropertyforgettingtheUniformResourceLocator(URL)oftheWebServicesDescriptionLanguage(WSDL)fileoftheXMLWebservice.

UsingtheWebServiceAdapterobjectForsecondarydatasources,theWebServiceAdapterobjectisaccessiblethroughtheQueryAdapterpropertyoftheDataObjectobject,andDataObjectobjectsareaccessiblethroughtheDataObjectspropertyoftheXDocumentobject.

IfaWebserviceisusedastheprimarydatasourceforaform,theWebServiceAdapterobjectisaccessiblethroughtheQueryAdapterpropertyoftheXDocumentobject.

Inthefollowingexample,areferencetotheWebServiceAdapterobjectissetbyusingtheQueryAdapterpropertyoftheDataObjectobjectbypassingthenameoftheDataObjectobjecttotheItempropertyoftheDataObjectscollection:

varobjWSAdapter;

objWSAdapter=XDocument.DataObjects("GetCityList").QueryAdapter;

Afterthereferencehasbeenset,youcanusethepropertiesoftheWebServiceAdapterobjectasshowninthefollowingexample,whichsetsareferencetotheXMLnodereturnedbytheInputproperty:

varobjInputNode;

objInputNode=XDocument.DataObjects("GetCityList").QueryAdapter.Input;

Notethatinthiscase,theQueryAdapterpropertywasusedtoaccesstheInputpropertyoftheWebServiceAdapterobject.

FormoreinformationaboutusingtheWebServiceAdapterobject,seeAccessingexternaldatasources.

TheWebServiceAdapterobjectcontainsthefollowingproperties:

Property Description

ErrorsLocation ApropertyoftypeIXMLDOMNodethatsetsorretrievestheerrorsnodeunderwhichtheWebServiceAdapterobjectwillwritetheerrordetailsreturnedbytheWebservice.Theinitialvalueisnull.

Input SetsorretrievesastringthatcontainsthesourceXMLoftheinputelementcontainedintheformdefinitionfile(.xsf).

Name Aread-onlypropertyoftypeStringthatreturnsthenameoftheWebServiceAdapterobject.

Operation SetsorretrievesastringthatcontainsthesourceXMLoftheoperationelementcontainedintheformdefinition(.xsf)file.

OutputLocation ApropertyoftypeIXMLDOMNodethatsetsorretrievestheoutputnodeunderwhichtheWebServiceAdapterobjectwillcopythereturnedXML.

QueryAllowed Aread-onlypropertyoftypeBooleanthatcorrespondstothequeryAllowedattributeintheformdefinition(.xsf)file.

SubmitAllowed Aread-onlypropertyoftypeBooleanthatcorrespondstothesubmitAllowedattributeintheformdefinitionfile(.xsf).

Timeout ApropertyoftypeLongthatsetsorretrievesthelengthoftime,inseconds,fortheWebServiceAdapterobjecttotime-outonsubsequentrequests.Thedefaultvalueis30seconds.

WSDLURL Aread-onlypropertythatreturnsastringthatcontainstheUniformResourceLocator(URL)oftheWebServicesDescriptionLanguage(WSDL)filefortheWebserviceassociatedwiththeWebServiceAdapterobject.

TheWebServiceAdapterobjectcontainsthefollowingmethods:

Method PropertyGenerateDataSetDiffGram ReturnsanADO.NetDataSetcontainingan

inlineschemadescribingthedataandthe

DiffGramoftheDataSet.TheDiffGramfortheinputdataDomisgenerated,usingthesiblingnodeOriginalDatatocomputethedifferencebetweentheOriginalDataandtheinputdataDom.

Query ExecutestheQuerymethodontheWebServiceAdapterobject.FailsiftheQueryAllowedpropertyisFalse.

Submit ExecutestheSubmitmethodontheWebServiceAdapterobject.FailsiftheSubmitAllowedpropertyisFalse.

ShowAll

WindowObject

Windows Window

RepresentsawindowthatisusedintheMicrosoftOfficeInfoPath2003application.WindowobjectsrepresentthetwotypesofwindowsthatareusedintheInfoPathapplication:theeditingwindowthatisusedastheformareawhenauserfillsoutaform,andthedesigningwindowthatisusedasthedesignmodewhenauserdesignsaform.

RemarksTheWindowobjectprovidesanumberofpropertiesandmethodsthatcanbeusedtoprogrammaticallyinteractwithInfoPathwindows,includingtheabilitytoactivateorcloseawindowandtheabilitytointeractwiththetaskpanesandcommandbarsthattheycontain.TheWindowobjectalsoprovidesapropertyforaccessingtheform'sunderlyingXMLdocumentthatisassociatedwiththewindow.

NoteSomepropertiesoftheWindowobjectareonlyavailablewhenusingtheeditingwindowtype;theywillreturnanerrorifusedwiththedesigningwindowtype.

UsingtheWindowobjectTheWindowobjectsofanInfoPathformareaccessedthroughtheItempropertyoftheWindowscollection.ThetypeofwindowcanbedeterminedbytheTypepropertyoftheWindowobject.

YoucanaccessthecurrentlyopenwindowdirectlybyusingtheActiveWindowpropertyoftheApplicationobject,withoutgoingthroughtheWindowscollection.YoucanalsoaccesstheWindowobjectthatisassociatedwithaviewbyusingtheWindowpropertyoftheViewobject.

Inthefollowingexample,implementedasanOnClickeventhandlerforabuttoncontrol,theActiveWindowpropertyisusedtosetareferencetothecurrentwindow.Thenthecodechecksthewindowtype;ifitistheeditingwindowtype,itdisplaysthenumberoftaskpanescontainedinthewindowinamessagebox.

functionWindowObject::OnClick(eventObj){

varobjWindow;//Setareferencetothecurrentwindow.objWindow=Application.ActiveWindow;//Checkthatthewindowisaneditingwindowtype.if(objWindow.Type==0){//Displaythenumberoftaskpanesinthewindow.XDocument.UI.Alert("Numberoftaskpanes:"+objWindow.TaskPanes.Count);}objWindow=null;}

FormoreinformationaboutusingtheWindowobject,seeWorkingwithformwindows.

ShowAll

XDocumentObject

XDocuments XDocument

RepresentstheunderlyingXMLdocumentofaMicrosoftOfficeInfoPath2003form.

RemarksTheXDocumentobjectisakeyobjectintheInfoPathobjectmodelthatprovidesproperties,methods,andeventsthatcanbeusedtoprogrammaticallyinteractwithandmanipulatethesourceXMLdataofaform.

NoteTheXDocumentobjectisembeddedintheInfoPathscriptengine.WhiletheXDocumentobjectcanbeaccessedusingtheXDocumentscollection,inmostcasesyouwillaccessitdirectly,withoutgoingthroughthecollection.

UsingtheXDocumentobjectThesourceXMLdataofaformtakestheformofanXMLDocumentObjectModel(DOM),whichisaccessedthroughtheDOMpropertyoftheXDocumentobject.TheXDocumentobjectalsoprovidesanumberofpropertiesthatcanbeusedtogetinformationabouttheformanditsunderlyingXMLdocument.Forexample,thefollowingcodecheckstoseewhetherdataintheformhasbeenchangedbyusingtheIsDirtyproperty:

if(XDocument.IsDirty)XDocument.UI.Alert("Formhasbeenchanged.");elseXDocument.UI.Alert("Formhasnotbeenchanged.");

InadditiontoinformationabouttheformanditsunderlyingXMLdocument,theXDocumentobjectprovidesanumberofmethodsthatcanbeusedontheform,suchasprinting,saving,andsubmitting.Italsoprovidesanumberofeventsthatcanbeusedtorespondtovariousactionsthatoccurattheformlevel,suchasloadingofaform,switchingviews,oramergeoperation.

AccessingtheXDocumentobjectTheXDocumentobjectcanbeaccessedinavarietyplaceswithintheInfoPathobjectmodel.ThefollowingtablesummarizesthelocationswheretheXDocumentobjectisavailable.

Name DescriptionXDocumentscollection

AccessedfromtheApplicationobject.ProvidestheItempropertyforaccessingthetheXDocumentobjectsthatitcontains.

DataDOMEventobject ProvidesanXDocumentpropertyforaccessingthesourceXMLdataduringanXMLDOMchange.

DocActionEventobject

ProvidesanXDocumentpropertyforaccessingthesourceXMLdataduringabuttonclickintheformarea.

DocEventobject ProvidesanXDocumentpropertyforaccessingthesourceXMLdataduringaswitchvieworformmergeoperation.

DocReturnEventobject

ProvidesanXDocumentpropertyforaccessingthesourceXMLduringtheloadingorsubmissionofaform.

VersionUpgradeEventobject

ProvidesanXDocumentpropertyforaccessingthesourceXMLduringduringtheversionupgradeoperation.

Windowobject ProvidesanXDocumentpropertyforaccessingtheXDocumentobjectassociatedwiththewindow.

NoteFormoreinformationaboutusingtheXDocumentobject,seeAccessingformdata.

ShowAll

XMLFileAdapterObject

XMLFileAdapter

RepresentsaconnectiontoanXMLfile.TheXMLFileAdapterobjectisatypeofMicrosoftOfficeInfoPath2003dataadapterthatcontainsalltheinformationnecessaryforretrievingandsubmittingdatatoanexternaldatasource.

RemarksTheXMLFileAdapterobjectprovidestheFileURLproperty,whichcanbeusedgetorsettheUniformResourceLocator(URL)oftheXMLfilethatisbeingusedanexternaldatasource.

UsingtheXMLFileAdapterobjectForsecondarydatasources,theXMLFileAdapterobjectisaccessiblethroughtheQueryAdapterpropertyoftheDataObjectobject,andDataObjectobjectsareaccessiblethroughtheDataObjectspropertyoftheXDocumentobject.

Inthefollowingexample,areferencetotheXMLFileAdapterobjectissetbyusingtheQueryAdapterpropertyoftheDataObjectobjectbypassingthenameoftheDataObjectobjecttotheItempropertyoftheDataObjectscollection:

varobjXMLFileAdapter;

objXMLFileAdapter=XDocument.DataObjects("GetXMLCityList").QueryAdapter;

FormoreinformationaboutusingtheXMLFileAdapterobject,seeAccessingexternaldatasources.

ActiveProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetherthewindowassociatedwiththeWindowobjectistheactivewindow.

expression.Active

expressionRequired.AnexpressionthatreturnsareferencetotheWindowobject.

SecurityLevel0:Canbeaccessedwithoutrestrictions.

RemarksTodesignateawindowastheactivewindow,usetheActivatemethodoftheWindowobject.

ExampleInthefollowingexample,theActivepropertyoftheWindowobjectisusedtodeterminewhetherthefirstwindowcontainedintheWindowscollectionistheactivewindow:

if(Application.Windows(0).Active){XDocument.UI.Alert("Thewindowisactive.");}

ActiveWindowProperty

Aread-onlypropertythatreturnsareferencetoaWindowobjectthatrepresentsthecurrentlyactivewindow.ThetypeofwindowreturnedisbasedontheXdWindowTypeenumeration.

expression.ActiveWindow

expressionRequired.AnexpressionthatreturnstheApplicationobject.

RemarksUsingtheActiveWindowproperty,youcangainimmediateaccesstothewindowthatiscurrentlybeingviewedbytheuser,andthenusethepropertiesandmethodsoftheWindowobjectthatitreturns.

ExampleInthefollowingexamplefromtheMeetingAgendasampleform,theActiveWindowpropertyisusedtogainaccesstotheMailEnvelopepropertyoftheWindowobjectthatreturnsaMailEnvelopeobject.

varoEnvelope=Application.ActiveWindow.MailEnvelope;

oEnvelope.Subject=getNode("/mtg:meetingAgenda/mtg:subject").text;oEnvelope.To=rgRecipients.join(";");oEnvelope.Visible=true;

AttachmentFileNameProperty

Returnsorsetsastringthatrepresentsthefilenametobeusedforthecurrentformwhentheformisattachedtothee-mailmessageofanEmailAdapterobject.

expression.AttachmentFileName

expressionRequired.AnexpressionthatreturnsareferencetoanEmailAdapterobject.

SecurityLevel2:Canbeaccessedonlybyformsrunninginthesamedomainasthecurrentlyopenform,orbyformsthathavebeengrantedcross-domainpermissions.

RemarksThe".xml"filenameextensionwillbeappendedtothestringifitisnotalreadyincluded.

IftheAttachmentFileNamepropertyissettonull,theformwillnotbeattachedtothee-mailmessage.

ExampleThisexampleshowshowtousetheAttachmentFileNamepropertyofaninstanceoftheEmailAdapterobjecttochangethenameoftheformwhenitisattachedtothee-mailmessagebeforetheEmailAdapterobjectissubmitted:

objEmailAdapter.AttachmentFileName=strName+"–"+strDate+".xml";

BCCProperty(EmailAdapterObject)

ReturnsorsetsastringthatrepresentstheBCCrecipientsofane-mailmessageassociatedwithanEmailAdapterobject.

expression.BCC

RemarksThevaluemustbeasemicolon-delimitedstringthatcanberesolvedintoalistofvalide-mailaddressesbytheuser'se-mailclient.

ExampleThisexampleshowshowtousetheBCCpropertyofaninstanceoftheEmailAdapterobjecttochangetheBCCrecipientsbeforetheEmailAdapterissubmitted:

objEmailAdapter.BCC=oEmailAdapter.BCC+";newUser@example.com";

BCCProperty(Index)

TheBCCpropertysetsorretrievesastringcontainingtheblindcarboncopy(BCC)valueforane-mailmessage.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaBCCpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheBCCproperty.

BCCpropertyasitappliestotheEmailAdapterobject.

BCCpropertyasitappliestotheMailEnvelopeobject.

BCCProperty(MailEnvelopeObject)

Setsorretrievesastringcontainingtheblindcarboncopy(BCC)valueusedintheMailEnvelopeobjectthatisassociatedwithaWindowobject.

expression.BCC

expressionRequired.AnexpressionthatreturnsareferencetotheMailEnvelopeobject.

RemarksThevaluessetfortheBCCpropertyshouldbeastringofvalide-mailaddresses.Youcanspecifymultiplee-mailaddressesbyusing";"betweeneachofthem,asshowninthefollowingexample:

objEmail.BCC="someone@example.com;someone@example.com"

ExampleInthefollowingexample,theBCCpropertyoftheMailEnvelopeobjectisusedtosettheBCCvalueofacustome-mailmessage:

functionCreateMailEnvelope::OnClick(eventObj){varobjEmail;

objEmail=Application.ActiveWindow.MailEnvelope;objEmail.To="someone@example.com";objEmail.CC="someone@example.com";objEmail.BCC="someone@example.com";objEmail.Subject="Teste-mailmessage";objEmail.Visible=true;objEmail=null;}

CaptionProperty(Index)

ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaCaptionpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheCaptionproperty.

CaptionpropertyasitappliestotheSignedDataBlockobject.

CaptionpropertyasitappliestotheWindowobject.

CaptionProperty(SignedDataBlockObject)

Aread-onlypropertythatreturnsthefriendlynameoftheSignedDataBlockobject.

expression.Caption

expressionRequired.AnexpressionthatreturnsareferencetotheSignedDataBlockobject.

CaptionProperty(WindowObject)

Aread/writepropertythatreturnsorsetsthecaptiontextforthewindowrepresentedbytheWindowobject.

expression.Caption

RemarksWhensettingthecaptiontextforawindow,thecaptionwillalwaysbefollowedby"-MicrosoftOfficeInfoPath2003".

ExampleInthefollowingexample,theCaptionpropertyisusedtosetthecaptiontextoftheactivewindow.

varstrCaption="MyCaption";

Application.ActiveWindow.Caption=strCaption;

CCProperty(EmailAdapterObject)

Returnsorsetsastringthatrepresentsthecarboncopy(CC)recipientsforthee-mailmessageassociatedwithanEmailAdapterobject.

expression.CC

ExampleThisexampleshowshowtousetheCCpropertyofaninstanceoftheEmailAdapterobjecttochangetheCCrecipientsbeforetheEmailAdapterobjectissubmitted:

objEmailAdapter.CC=oEmailAdapter.CC+";newUser@example.com";

CCProperty(MailEnvelopeObject)

Setsorretrievesastringcontainingthecarboncopy(CC)valueusedintheMailEnvelopeobjectthatisassociatedwithaWindowobject.

expression.CC

RemarksThevaluessetfortheCCpropertyshouldbeastringofvalide-mailaddresses.Youcanspecifymultiplee-mailaddressesbyusing";"betweeneachofthem,asshowninthefollowingexample:

objEmail.CC="someone@example.com;someone@example.com"

ExampleInthefollowingexample,theCCpropertyoftheMailEnvelopeobjectisusedtosettheCCvalueofacustome-mailmessage:

CCPropety(Index)

TheCCpropertysetsorretrievesastringcontainingthecarboncopy(CC)valueforane-mailmessage.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaCCpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheCCproperty.

CCpropertyasitappliestotheEmailAdapterobject.

CCpropertyasitappliestotheMailEnvelopeobject.

ShowAll

CertificateProperty

Aread-onlypropertythatreturnstheCertificateobjectfortheX.509digitalcertificatethatwasusedtosignaformorasetofsigneddatainaform.

expression.Certificate

expressionRequired.AnexpressionthatreturnsaSignatureobject.

ShowAll

CommandProperty

SetsorretrievestheSQLcommandstringtextforanADOAdapterobject.

expression.Command

expressionRequired.AnexpressionthatreturnsareferencetotheADOAdapterobject.

RemarksTheCommandpropertyoftheADOAdapterobjectcontainstheSQLcommandtextthatisusedbytheADOdataadaptertosubmitdatatoandretrievedatafromanActiveXDataObjects/OLEDBexternaldatasource.

ExampleInthefollowingexample,theCommandpropertyoftheADOAdapterobjectisusedtodisplaytheSQLcommandtextoftheADOdataadapterinamessagebox:

varobjADOAdapter;

objADOAdapter=XDocument.DataObjects("CityList").QueryAdapter;XDocument.UI.Alert("SQLcommandtext:"+objADOAdapter.Command

CommandBarsProperty

Aread-onlypropertythatreturnsareferencetotheMicrosoftOfficeCommandBarscollectionobjectcontainedinthewindowthatisassociatedwiththeWindowobject.

expression.CommandBars

SecurityLevel3:Canbeaccessedonlybyfullytrustedforms.

RemarksTheCommandBarspropertycanbeusedonlybyfullytrustedforms.Ifusedbyaformthatisnotfullytrusted,theCommandBarspropertywillreturna"permissiondenied"error.

ExampleInthefollowingexample,theCommandBarspropertyoftheWindowobjectisusedtosetareferencetotheCommandBarscollectionobject:

varobjCommandBars;objCommandBars=Application.ActiveWindow.CommandBars;

ShowAll

CommentProperty

Aread-onlypropertythatreturnsthetextcommentthatwasaddedtothedigitalsignatureassociatedwithaformorasectionofaform.

expression.Comment

ConditionNameProperty

Aread-onlypropertythatreturnsastringvaluecontainingthenameoftheErrorobject.

expression.ConditionName

expressionRequired.AnexpressionthatreturnsareferencetotheErrorobject.

RemarksTheConditionNamepropertyisusedonlyforcustomerrors;itisnotusedforschemavalidation–generatedorsystem-generatederrors.Ifthetypeoferrorisschemavalidationgeneratedorsystemgenerated,theConditionNamepropertywillreturnnull.

ExampleInthefollowingexample,theConditionNamepropertyoftheErrorobjectisusedtodisplaythenameofacustomerrorinamessagebox:

varobjError;

objError=XDocument.Errors(0);XDocument.UI.Alert("Errorname:"+objError.ConditionName);

ShowAll

ConnectionProperty

SetsorretrievestheconnectionstringusedforanADOAdapterobject.

expression.Connection

RemarksTheConnectionpropertyoftheADOAdapterobjectcontainstheconnectionstringthatisusedbytheADOdataadaptertoconnecttoanActiveXDataObjects/OLEDBexternaldatasource.

ExampleInthefollowingexample,theConnectionpropertyoftheADOAdapterobjectisusedtodisplaytheconnectionstringoftheADOdataadapterinamessagebox:

varobjADOAdapter;

objADOAdapter=XDocument.DataObjects("CityList").QueryAdapter;XDocument.UI.Alert("Connectionstring:"+objADOAdapter.Connection

ContextProperty

Aread-onlypropertythatreturnsareferencetotheXMLDocumentObjectModel(DOM)nodethatisthenewcontextnodeprovidedbytheDocContextChangeEventobject.

expression.Context

expressionRequired.AnexpressionthatreturnsareferencetotheDocContextChangeEventobject.

CountProperty(DataAdaptersCollection)

Aread-onlypropertythatreturnsthenumberofdataadaptersintheDataAdaptersCollectioncollection.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetoaDataAdaptersCollectioncollection.

ShowAll

CountProperty(DataObjectsCollection)

Aread-onlypropertythatreturnsacountofthenumberofDataObjectobjectscontainedintheDataObjectscollection.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetotheDataObjectscollection.

RemarksTheCountpropertyreturnsalongintegervalue.

ExampleInthefollowingexample,theCountpropertyisusedwithinaMicrosoftJScriptforlooptoiteratethroughthecollectionofDataObjectobjectsanddisplayamessageboxindicatingthenameofeachDataObjectobjectassociatedwiththeform:

for(i=0;i<XDocument.DataObjects.Count;i++){XDocument.UI.Alert("DataObjectname:"+XDocument.DataObjects(i).Name);}

ShowAll

CountProperty(ErrorsCollection)

Aread-onlypropertythatreturnsacountofthenumberofErrorobjectscontainedintheErrorscollection.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetotheErrorscollection.

ExampleInthefollowingexample,theCountpropertyisusedwithinaMicrosoftJScriptforlooptoiteratethroughthecollectionofErrorobjectsanddisplayamessageboxindicatingtheshorterrormessageofeacherror:

for(i=0;i<XDocument.Errors.Count;i++){XDocument.UI.Alert("Errormessage:"+XDocument.Errors(i).ShortErrorMessage);}

CountProperty(Index)

TheCountpropertyreturnsacountofthenumberofobjectscontainedinacollection.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickaCountpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheCountproperty.

CountpropertyasitappliestotheDataAdapterscollection.

CountpropertyasitappliestotheDataObjectscollection.

CountpropertyasitappliestotheErrorscollection.

CountpropertyasitappliestotheMergeEventobject.

CountpropertyasitappliestotheSignaturescollection.

CountpropertyasitappliestotheSignedDataBlockscollection.

CountpropertyasitappliestotheTaskPanescollection.

CountpropertyasitappliestotheViewInfoscollection.

CountpropertyasitappliestotheWindowscollection.

CountpropertyasitappliestotheXDocumentscollection.

CountpropertyasitappliestotheXMLNodescollection.

CountProperty(MergeEventObject)

Aread-onlypropertythatreturnsacountofthenumberofformsbeingmergedinamergingoperation.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetoaMergeEventobject.

RemarksTheCountpropertycanbeusedincombinationwiththeIndexpropertyoftheMergeEventobjecttodeterminewhenthelastformwasmerged.

ExampleThisexampleshowshowtousetheIndexpropertyalongwiththeCountpropertyofaninstanceoftheMergeEventobjecttodetermineifthecurrentformisthelastformbeingmerged:

varfLast=eventObj.Index+1==eventObj.Count;

CountProperty(SignaturesCollection)

Aread-onlypropertythatreturnsthenumberofSignatureobjectsintheSignaturescollection.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetoaSignaturescollection.

ShowAll

CountProperty(SignedDataBlocksCollection)

Aread-onlypropertythatreturnsthenumberofSignedDataBlockobjectsintheformtemplate.

expression.Count

expressionRequired.AnexpressionthatreturnsaSignedDataBlockscollection.

ShowAll

CountProperty(TaskPanesCollection)

Aread-onlypropertythatreturnsacountofthenumberofTaskPaneobjectscontainedintheTaskPanescollection.

expression.Count

expressionRequired.ReturnsareferencetotheTaskPanescollection.

ExampleInthefollowingexample,theCountpropertyisusedwithinaMicrosoftJScriptforlooptoiteratethroughthecollectionofTaskPaneobjects.ItcheckstheVisiblepropertyofeachTaskPaneobjectandifitisTrue,setsittoFalse.

varobjTaskPanes;

objTaskPanes=XDocument.View.Window.TaskPanes;

for(i=0;i<objTaskPanes.Count;i++){if(objTaskPanes(i).Visible=true)objTaskPanes(i).Visible=false;}

ShowAll

CountProperty(ViewInfosCollection)

Aread-onlypropertythatreturnsacountofthenumberofViewInfoobjectscontainedintheViewInfoscollection.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetotheViewInfoscollection.

ExampleInthefollowingexample,theCountpropertyisusedwithinaMicrosoftJScriptforlooptoiteratethroughthecollectionofViewInfoobjectsanddisplayamessageboxindicatingthenameofeachviewimplementedintheform:

for(i=0;i<XDocument.ViewInfos.Count;i++){XDocument.UI.Alert("Viewname:"+XDocument.ViewInfos(i).Name);}

ShowAll

CountProperty(WindowsCollection)

Aread-onlypropertythatreturnsacountofthenumberofWindowobjectscontainedintheWindowscollection.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetotheWindowscollection.

ExampleInthefollowingexample,theCountpropertyisusedwithinaMicrosoftJScriptforlooptoiteratethroughthecollectionofWindowobjectsanddisplayamessageboxindicatingthewindowtypevalue:

for(i=0;i<Application.Windows.Count;i++){XDocument.UI.Alert("Windowtype:"+Application.Windows(i).Type);}

ShowAll

CountProperty(XDocumentsCollection)

Aread-onlypropertythatreturnsacountofthenumberofXDocumentobjectscontainedintheXDocumentscollection.

expression.Count

expressionRequired.AnexpressionthatreturnsareferencetotheXDocumentscollection.

ExampleInthefollowingexample,theCountpropertyoftheXDocumentscollectionisusedwithinaJScriptforlooptoiteratethroughthecollectionofXDocumentobjectsanddisplayamessageboxindicatingtheUniformResourceIdentifier(URI)locationforeachcurrentlyopenform:

for(i=0;i<Application.XDocuments.Count;i++){XDocument.UI.Alert("XDocumentURI:"+Application.XDocuments(i).URI);}

ShowAll

CountProperty(XMLNodesCollection)

Aread-onlypropertythatreturnsacountofthenumberofXMLDocumentObjectModel(DOM)nodeobjectscontainedintheXMLNodescollection.

expression.Count

expressionRequired.ReturnsareferencetotheXMLNodescollection.

ExampleInthefollowingexample,theCountpropertyisusedwithinaMicrosoftJScriptforlooptoiteratethroughthecollectionofXMLDOMnodeobjectsreturnedbytheGetSelectedNodesmethodoftheViewobjectanddisplayamessageboxindicatingthenameofeachXMLDOMnodethatiscontainedintheXMLNodescollection:

varobjXMLNodes;

for(i=0;i<objXMLNodes.Count;i++){XDocument.UI.Alert("XMLDOMnodename:"+objXMLNodes(i).nodeName);}

DataAdaptersProperty

Aread-onlypropertythatreturnsareferencetotheDataAdapterscollectionthatisassociatedwithaMicrosoftOfficeInfoPath2003form.

expression.DataAdapters

expressionRequired.AnexpressionthatreturnsareferencetoanXDocumentobject.

ExampleInthefollowingexample,theDataAdapterspropertyoftheXDocumentobjectisusedtosetareferencetoadataadaptercalled"Mainquery":

varobjDataAdapter;objDataAdapter=XDocument.DataAdapters("Mainquery");

ShowAll

DataObjectsProperty

Aread-onlypropertythatreturnsareferencetotheDataObjectscollectionthatisassociatedwithaMicrosoftOfficeInfoPath2003form.

expression.DataObjects

RemarksTheDataObjectscollectionprovidesprogrammaticaccesstoaform'ssecondarydatasources.EachsecondarydatasourceiscontainedinaDataObjectobjectwithintheDataObjectscollection.

ExampleInthefollowingexample,theDataObjectspropertyoftheXDocumentobjectisusedtosetareferencetotheCityListsecondarydatasource:

varobjDataObject;objDataObject=XDocument.DataObjects("CityList");

DateProperty

Aread-onlypropertythatreturnsareferencetotheDateobject.

expression.Date

expressionRequired.AnexpressionthatreturnsareferencetotheUtilobject.

RemarksYoucanaccessallofthemethodsthattheDateobjectprovidesbyusingtheDateproperty.

DetailedErrorMessageProperty

SetsorretrievesthestringvaluecontainingthedetailederrormessageofanErrorobject.

expression.DetailedErrorMessage

RemarksThedetailederrormessageisthelongererrormessagethatuserscanchoosetoviewwhendatavalidationfailsintheirforms.

ExampleInthefollowingexample,theDetailedErrorMessagepropertyoftheErrorobjectisusedtodisplaythedetailedmessageofanerrorinamessagebox:

varobjError;

objError=XDocument.Errors(0);XDocument.UI.Alert("Errorname:"+objError.DetailedErrorMessage

DocumentVersionProperty

Aread-onlypropertythatreturnsastringcontainingtheversionnumberofaMicrosoftOfficeInfoPath2003form.

expression.DocumentVersion

expressionRequired.AnexpressionthatreturnsareferencetotheVersionUpgradeEventobject.

RemarksThispropertycanbeusedonlyduringtheOnVersionUpgradeevent.

ExampleInthefollowingexample,theDocumentVersionpropertyoftheVersionUpgradeEventobjectisusedtodisplaytheversionnumberofanInfoPathforminamessagebox:

functionXDocument::OnVersionUpgrade(eventObj){XDocument.UI.Alert("Theformversion:"+eventObj.DocumentVersion"\nTheformtemplateversion:"+eventObj.SolutionVersion);eventObj.ReturnStatus=true;}

ShowAll

DOMProperty(DataObjectObject)

Aread-onlypropertythatreturnsareferencetoanXMLDocumentObjectModel(DOM)thatisassociatedwithaDataObjectobject.

expression.DOM

expressionRequired.AnexpressionthatreturnsareferencetotheDataObjectobject.

RemarksTheDOMpropertyallowsyoutoprogrammaticallyaccessandmanipulatethesourceXMLofasecondarydatasourcethatisrepresentedbytheDataObjectobject.AfteryouhavesetareferencetotheXMLDOM,whichcontainsthesourceXMLdataofasecondarydatasource,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.

ExampleInthefollowingexample,theDOMpropertyoftheDataObjectobjectisusedtoreturnallofthecontentsofaform'ssecondarydatasourceusingthexmlpropertyoftheXMLDOM:

varstrXML;strXML=XDocument.DataObjects("CityList").DOM.xml;

ShowAll

DOMProperty(Index)

TheDOMpropertyreturnsareferencetotheDocumentObjectModel(DOM).ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaDOMpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheDOMproperty.

DOMpropertyasitappliestotheDataObjectobject.

DOMpropertyasitappliestotheMergeEventobject.

DOMpropertyasitappliestotheSolutionobject.

DOMpropertyasitappliestotheXDocumentobject.

ShowAll

DOMProperty(MergeEventObject)

Aread-onlypropertythatreturnsareferencetoaform'sunderlyingXMLdocumentasanXMLDocumentObjectModel(DOM)constructionforthecurrentforminvolvedinamergingoperation.

expression.DOM

RemarksTheDOMpropertyallowsyoutoaccessandmanipulatethesourceXMLofaformprogrammatically.AfteryouhavesetareferencetotheXMLDOM,whichcontainsthesourceXMLdataofaform,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.

NoteTolearnmoreabouttheXMLDOMandthepropertiesandmethodsthatitsupports,seetheMSXML5.0SDKdocumentationintheMicrosoftScriptEditor(MSE)Helpsystem.

ExampleThisexampleshowshowtousetheDOMpropertyofaninstanceoftheMergeEventobjecttomergethedataintothecurrentform:

XDocument.ImportDOM(eventObj.DOM);

ShowAll

DOMProperty(SolutionObject)

Aread-onlypropertythatreturnsareferencetoanXMLDocumentObjectModel(DOM)thatcontainsthesourceXMLoftheformdefinition(.xsf)file.

expression.DOM

expressionRequired.AnexpressionthatreturnsareferencetoaSolutionobject.

RemarksTheDOMpropertyoftheSolutionobjectallowsyoutoprogrammaticallyaccessandmanipulatethesourceXMLofthe.xsffile.AfteryouhavesetareferencetotheXMLDOM,whichcontainsthesourceXMLdataofthe.xsffile,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.

ExampleInthefollowingexample,theDOMpropertyoftheSolutionobjectisusedtoreturnallofthecontentsofaform's.xsffileusingthexmlpropertyoftheXMLDOM:

varstrXML;

strXML=XDocument.Solution.DOM.xml;

ShowAll

DOMProperty(XDocumentObject)

Aread-onlypropertythatreturnsareferencetoaform'sunderlyingXMLdocumentintheformofanXMLDocumentObjectModel(DOM).

expression.DOM

RemarksAkeypropertyoftheXDocumentobject,theDOMpropertyallowsyoutoprogrammaticallyaccessandmanipulatethesourceXMLofaform.AfteryouhavesetareferencetotheXMLDOM,whichcontainsthesourceXMLdataofaform,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.

ExampleInthefollowingexample,theDOMpropertyoftheXDocumentobjectisusedtoreturnallofthecontentsofaform'sunderlyingXMLdocumentusingthexmlpropertyoftheXMLDOM:

varstrXML;strXML=XDocument.DOM.xml;

ErrorCodeProperty

SetsorretrievestheerrorcodeofanErrorobject.

expression.ErrorCode

RemarksTheErrorCodepropertyisimplementedasalonginteger.

ExampleInthefollowingexample,theErrorCodepropertyoftheErrorobjectisusedtodisplaytheerrorcodenumberofanerrorinamessagebox:

varobjError;

objError=XDocument.Errors(0);XDocument.UI.Alert("Errorname:"+objError.ErrorCode);

ErrorsProperty

Aread-onlypropertythatreturnsareferencetotheErrorscollectionthatisassociatedwithaMicrosoftOfficeInfoPath2003form.

expression.Errors

RemarksTheErrorscollectionisassociatedwithaform'sunderlyingXMLdocumentsothatwhenanerroroccurs,itoccurswithintheXMLdocument.AfteryousetareferencetotheErrorscollection,youcanaccessallofitspropertiesandmethodsformanagingtheerrorswithinanInfoPathform.

ExampleInthefollowingexample,theErrorspropertyoftheXDocumentobjectisusedtoreturnthecountofthenumberorerrorsandthendisplaythatvalueinamessagebox:

varintErrors;

intErrors=XDocument.Errors.Count;XDocument.UI.Alert("Totalnumberoferrors:"+intErrors);

ShowAll

ErrorsLocationProperty

Aread/writepropertythatspecifiestheXMLDocumentObjectModel(DOM)nodeunderwhichtheadapterwillcopyreturnederrorsasXML.

expression.ErrorsLocation

expressionRequired.AnexpressionthatreturnsareferencetoaWebServiceAdapterobject.

RemarksTheinitialvalueoftheErrorsLocationpropertyisnull.

ShowAll

ExpirationDateProperty

Aread-onlypropertythatreturnstheexpirationdateofadigitalcertificateinthelocalized'SHORTDATE'format.

expression.ExpirationDate

expressionRequired.AnexpressionthatreturnsaCertificateobject.

ShowAll

ExtensionProperty

Aread-onlypropertythatreturnsareferencetotheglobalscriptingobject,whichexposesthefunctionsandglobalvariablescontainedinaMicrosoftOfficeInfoPath2003form'sprimaryscriptingfile.

expression.Extension

RemarksTheExtensionpropertyfacilitatesusingthefunctionsandglobalvariablesimplementedinanInfoPathform'sscriptingfile.Usually,itisusedfromacustomtaskpane,fromacustomdialogbox,orintheXSLTransformation(XSLT)ofaviewwheredirectaccesstothefunctionsandvariablesmaybeneeded.

Forexample,ifyouweretodeclareaglobalvariableinyourscriptingfilesuchasthefollowing,

varconstCity="Redmond";

YoucouldaccessthatvalueinthecodeofyourcustomtaskpaneordialogboxbyusingtheExtensionproperty,asshownhere:

XDocument.Extension.constCity;

TousetheExtensionpropertywithinacustomtaskpane,youmustfirstsetareferencetotheXDocumentobjectbyusingtheDynamicHTML(DHTML)externalpropertyoftheDHTMLwindowobject,asshowninthisexample:

objXDocument=window.external.XDocument;

ExampleInthefollowingexample,theExtensionpropertyoftheXDocumentobjectisusedtoaccessacustomfunction:

objXDocument=window.external.XDocument;objXDocument.Extension.MyCustomFunction();

FileNameProperty(DAVAdapterObject)

ReturnsorsetsastringthatrepresentsthefilenamethatthecurrentMicrosoftOfficeInfoPath2003formwillbegivenwhentheformissubmittedbytheDAVAdapterobject.

expression.FileName

expressionRequired.AnexpressionthatreturnsareferencetotheDAVAdapterobject

RemarksThe".xml"filenameextensionwillbeappendedtothestringifitisnotalreadyincluded.IftheFileNamepropertyissettonull,theformisgiventhename"Form.xml"whenitissubmitted.

ExampleThefollowingexampleshowshowtousetheFileNamepropertyofaninstanceoftheDAVAdapterobjecttosetthefilenameofthesubmittedform:

objDAVAdapter.FileName=strName+"–"+strDate+".xml";

FileNameProperty(Index)

ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickaFileNamepropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheFileNameproperty.

FileNamepropertyasitappliestotheDAVAdapterobject.

FileNamepropertyasitappliestotheSaveEventobject.

FileNameProperty(SaveEventObject)

Aread-onlypropertythatreturnsastringthatrepresentsthefilenametobeusedintheOnSaveRequestevent.

expression.FileName

expressionRequired.AnexpressionthatreturnsareferencetoaSaveEventobject.

RemarksIftheIsSaveAspropertyoftheSaveEventobjectistrue,andasaveoperationhasnotyetoccurred,theFileNamepropertyreturnsanemptystring.IftheIsSaveAspropertyistrueandasaveoperationhasalreadyoccurred,thevaluereturnedbytheFileNamepropertyisthefilenameunderwhichtheformwassaved.IftheSaveEventobjectrepresentsasaveoperation(thatis,theIsSaveAspropertyoftheSaveEventobjectisfalse),theFileNamepropertyreturnsthesamevalueastheURIpropertyoftheXDocumentobject.

ExampleInthefollowingexample,theFileNamepropertyoftheSaveEventobjectisusedinanotificationtotheuserbeforeasaveoperation:

XDocument.UI.Alert("Youareabouttosavethefollowingfile:"+eventObj.

ShowAll

FileURLProperty

SetsorretrievestheUniformResourceLocator(URL)oftheXMLfilethatisassociatedwiththeXMLFileAdapterobject.

expression.FileURL

expressionRequired.AnexpressionthatreturnsareferencetotheXMLFileAdapterobject.

RemarksTheFileURLpropertysetsandretrievesastringvalue.

ExampleInthefollowingexample,theFileURLpropertyoftheXMLFileAdapterobject,accessedthroughtheQueryAdapterpropertyoftheXDocumentobject,isusedtodisplaytheURLoftheXMLfileinamessagebox:

XDocument.UI.Alert("XMLfileURL:"+XDocument.QueryAdapter.

FolderURLProperty

ApropertythatreturnsorsetsastringthatrepresentstheUniformResourceLocator(URL)towhichtheformwillbesubmittedbytheDAVAdapterobject.

expression.FolderURL

expressionRequired.AnexpressionthatreturnsareferencetotheDAVAdapterobject.

RemarksTheSubmitmethodoftheDAVAdapterobjectwillfailifthevalueoftheFolderURLpropertydoesnotbeginwitheitherthe"http:"orthe"https:"prefix.TheSubmitmethodwillalsofailifthesitespecifiedbytheFolderURLpropertyisnotavailable,oriftheURLisnotinthesamesecuritydomainastheformtemplate.

ExampleThisexampleshowshowtousetheFolderURLpropertyofaninstanceoftheDavAdapterobjecttochangethefoldertowhichtheformdatawillbesubmitted:

objDavAdapter.FolderURL=objDavAdapter.FolderURL+"data/";

HeightProperty

Aread/writepropertyoftypelongintegerthatspecifiestheheightofthethewindowrepresentedbytheWindowobject,measuredinpoints.

expression.Height

RemarksThispropertywillreturnanerrorifitissetonawindowthatisminimizedormaximized.

Thispropertycan'tbesettoavaluethatislargerthanthevaluereturnedbytheUsableHeightproperty.

ShowAll

HTMLDocumentProperty

ReturnsareferencetoanHTMLdocumentobjectoftheMicrosoftOfficeInfoPath2003customtaskpane.

expression.HTMLDocument

expressionRequired.AnexpressionthatreturnsareferencetotheHTMLdocumentobject.

RemarksTheHTMLDocumentpropertyoftheHTMLTaskPaneobjectisoneofthepropertiesinheritedbytheTaskPaneobjectwhenthetypeofthetaskpaneis0,whichmeansthatitisthecustomtaskpane.

UsingtheHTMLDocumentmethod,youcancallscriptingfunctionscontainedintheHTMLcodeofthetaskpanefromtheprimaryscriptingfileofaform,andyoucanalsodirectlymanipulatetheHTMLcodeofthetaskpaneusinganyofthepropertiesandmethodsthattheHTMLdocumentobjectprovides.

ExampleInthefollowingexample,theHTMLDocumentpropertyoftheHTMLTaskPaneobjectisusedtosetareferencetotheHTMLdocumentobjectofthecustomtaskpane.ThenthecodecallstheTaskPaneSwitchViewcustomfunctionthatisdefinedintheHTMLcodeofthecustomtaskpane.

varobjHTMLDoc;

objHTMLDoc=XDocument.View.Window.TaskPanes(0).HTMLDocumentobjHTMLDoc.parentWindow.TaskPaneSwitchView();

ShowAll

HTMLWindowProperty

ReturnsareferencetoanHTMLwindowobjectoftheMicrosoftOfficeInfoPath2003customtaskpane.

expression.HTMLWindow

expressionRequired.AnexpressionthatreturnsareferencetotheHTMLwindowobject.

RemarksTheHTMLWindowpropertyoftheHTMLTaskPaneobjectisoneofthepropertiesinheritedbytheTaskPaneobjectwhenthetypeofthetaskpaneis0,whichmeansthatitisthecustomtaskpane.

UsingtheHTMLWindowproperty,youcancallscriptingfunctionscontainedintheHTMLcodeofthetaskpanefromtheprimaryscriptingfileofaform,andyoucanalsodirectlymanipulatetheHTMLcodeofthetaskpaneusinganyofthepropertiesandmethodsthattheHTMLdocumentobjectprovides.

NoteTheHTMLWindowpropertyprovidesthesamefunctionalityastheHTMLDocumentproperty,butitisonlyavailablewhenusingfullytrustedforms.Iftheformisnotfullytrusted,youcanusetheHTMLDocumentproperty.

ExampleInthefollowingexample,theHTMLWindowpropertyoftheHTMLTaskPaneobjectisusedtosetareferencetotheHTMLwindowobjectofthecustomtaskpaneofafullytrustedform.ThenthecodecallstheTaskPaneSwitchViewcustomfunctionthatisdefinedintheHTMLcodeofthecustomtaskpane.

varobjHTMLDoc;

objHTMLDoc=XDocument.View.Window.TaskPanes(0).HTMLWindowobjHTMLDoc.parentWindow.TaskPaneSwitchView();

IndexProperty

Aread-onlypropertythatreturnsthe0-basedindexoftheformthatiscurrentlybeingmerged.

expression.Index

RemarksThevalueoftheIndexpropertyoftheMergeEventobjectincreasesfrom0toCount-1foreachmergeeventthatoccurswhenformsaremerged.

WhenusedincombinationwiththeCountpropertyoftheMergeEventobject,theIndexpropertycanbeusedtodeterminewhenthelastformhasbeenmerged.

ExampleThisexampleshowshowtousetheIndexpropertyalongwiththeCountpropertyofaninstanceoftheMergeEventobjecttodetermineifthecurrentformisthelastformtobemerged:

varfLast=eventObj.Index+1==eventObj.Count;

ShowAll

InputProperty

SetsorretrievesastringvaluethatcontainsthesourceXMLoftheinputelementcontainedintheformdefinition(.xsf)file.

expression.Input

expressionRequired.AnexpressionthatreturnsareferencetotheWebServiceAdapterobject.

RemarksTheinputelementofthe.xsffilecontainsinformationaboutthepartsoftheinputSimpleObjectAccessProtocol(SOAP)messagethatareusedtocommunicatewiththeWebservice.SpecificpartsintheSOAPmessagearereplacedbyMicrosoftOfficeInfoPath2003withdatafromwithintheform.ItisusedwhenasecondarydatasourceispopulatedwithdatafromaWebservice,andInfoPathneedstopassargumentstotheWebservicetoretrievethedatathatitprovides.

ExampleInthefollowingexample,theInputpropertyoftheWebServiceAdapterobjectisusedtodisplaytheinputstringoftheWebservicedataadapterinamessagebox:

varobjWSAdapter;

objWSAdapter=XDocument.DataObjects("WebCityList").QueryAdapter;XDocument.UI.Alert("Inputstring:"+objWSAdapter.Input);

IntroProperty

Returnsorsetsastringthatrepresentstheintroductioninthebodyofthee-mailmessageforanEmailAdapterobject.

expression.Intro

ExampleThisexampleshowshowtousetheIntropropertyofaninstanceoftheEmailAdapterobjecttochangetheintroductionofthebodyofthee-mailmessagebeforetheEmailAdapterissubmitted:

objEmailAdapter.Intro="Hereismystatusreportfortheweek.";

IsCancelledProperty

Aread/writepropertythatprovidesadditionalinformationforuseintheOnSaveRequesteventinconjunctionwiththeReturnStatusproperty.

expression.IsCancelled

RemarksWhenclosingInfoPath,theuserispromptedtosavethedocumentiftheIsDirtypropertyoftheXDocumentobjectistrue.IftheIsCancelledpropertyistrue,InfoPathwillbepreventedfromclosingifthesaveoperationfails(thatis,theReturnStatuspropertyisfalse).

ExampleInthefollowingexample,theIsCancelledpropertyoftheSaveEventobjectisusedtoensurethatthedocumentdoesnotcloseifthesaveoperationwascancelled:

eventObj.IsCancelled=eventObj.PerformSaveOperation();if(eventObj.IsCancelled)return;eventObj.ReturnStatus=true;

IsDefaultProperty

SetsorretrievesaBooleanvaluethatindicateswhethertheviewisdefinedasthedefaultviewinaMicrosoftOfficeInfoPath2003form.

expression.IsDefault

expressionRequired.AnexpressionthatreturnsareferencetotheViewInfoobject.

RemarksTheIsDefaultpropertyoftheViewInfoobjectcanbeusedtodeterminewhetheraviewisthedefaultview,anditcanbeusedtoprogrammaticallychangethedefaultviewbeforethefirstviewisloaded.

ExampleInthefollowingexample,theIsDefaultpropertyisusedtomakethesecondviewcontainedintheViewInfoscollectionthedefaultview:

XDocument.ViewInfos(1).IsDefault=true;

IsDirtyProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetherthedatainaMicrosoftOfficeInfoPath2003formhasbeenmodifiedsinceitwaslastsaved.

expression.IsDirty

RemarksIftheIsDirtypropertyisTrue,dataintheform'sunderlyingXMLdocumenthasbeenchangedsinceitwaslastsaved.IfFalse,nochangeshaveoccurred.

NoteChangesthatoccurduringtheOnLoadeventwillnotresultintheIsDirtypropertybeingsettoTrue.

ExampleInthefollowingexample,theIsDirtypropertyoftheXDocumentobjectisusedtodeterminewhetherdataintheformhasbeenchanged:

if(XDocument.IsDirty)XDocument.UI.Alert("Datahasbeenchanged.");elseXDocument.UI.Alert("Datahasnotbeenchanged.");

ShowAll

IsDOMReadOnlyProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetherthedataintheunderlyingXMLdocumentofaMicrosoftOfficeInfoPath2003formhasbeenplacedinaread-onlystate.

expression.IsDOMReadOnly

RemarksIftheIsDOMReadOnlypropertyisTrue,dataintheform'sunderlyingXMLdocumentisinaread-onlystateandcannotbechanged.IfFalse,thedataintheform'sunderlyingXMLdocumentcanbechanged.

Todeterminewhethertheformhasbeenplacedinaread-onlystate,usetheIsReadOnlypropertyoftheXDocumentobject.

Thedatainaform'sXMLdocumentwillbeplacedinaread-onlystateinthefollowingscenarios:

Theformisdigitallysigned

TheformisinReducedFunctionalityMode(RFM)mode

DuringtheOnBeforeChangeevent

DuringtheOnValidateevent

Duringanundoorredooperation

ExampleInthefollowingexample,theIsDOMReadOnlypropertyoftheXDocumentobjectisusedtodeterminewhetherdataintheform'sunderlyingXMLdocumenthasbeenplacedinaread-onlystate.Ifithas,areturnstatementisusedtoexittheeventhandler.

functionmsoxd__item::OnAfterChange(objEvent){

//DeterminewhethertheXMLDOMisread-only.if(XDocument.IsDOMReadOnly)return;

//Continuenormalprocessing...

IsNewProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetheranewlycreatedMicrosoftOfficeInfoPath2003formhasbeensaved.

expression.IsNew

RemarksIftheIsNewpropertyisTrue,dataintheform'sunderlyingXMLdocumenthasnotbeensavedsincetheformwasinitiallycreated.IfFalse,thedatainthenewform'sunderlyingXMLdocumenthasbeensaved.

ExampleInthefollowingexample,theIsNewpropertyoftheXDocumentobjectisusedtodeterminewhetherthedatainanewformhasbeensaved:

if(XDocument.IsNew)XDocument.UI.Alert("Pleasesaveyourform.");elsereturn;

IsReadOnlyProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetheraMicrosoftOfficeInfoPath2003formisinread-onlymode.

expression.IsReadOnly

RemarksIftheIsReadOnlypropertyisTrue,theformhasbeenplacedinaread-onlystate.Changescanstillbemadetotheform,butitcannotbesavedusingasaveoperation,itmustbesavedusingasave-asoperation.

Todeterminewhethertheform'sunderlyingXMLdocumenthasbeenplacedinaread-onlystate,usetheIsDOMReadOnlypropertyoftheXDocumentobject.

ExampleInthefollowingexample,theIsReadOnlypropertyoftheXDocumentobjectisusedtodeterminewhethertheformisinaread-onlystate:

if(XDocument.IsReadOnly)XDocument.UI.Alert("Theformcannotbemodified.");elsereturn;

IsRecoveredProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetheraMicrosoftOfficeInfoPath2003formwaslastsavedbyanAutoRecoversaveoperation.

expression.IsRecovered

ExampleThefollowingexampleshowshowtousetheIsRecoveredpropertytoindicate,whentheformisopened,whethertheformwaslastsavedbyanAutoRecoversaveoperation:

functionXDocument::OnLoad(eventObj){XDocument.UI.Alert("LastsavedbyanAutoRecoversaveoperation:"+XDocument.}

IsSaveAsProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetherthePerformSaveOperationmethodoftheSaveEventobjectwillbeperformedasa"save"operationorasa"saveas"operation.

expression.IsSaveAs

RemarksTheIsSaveAspropertyreturnstruewhentheeventwastriggeredbyacalltotheSaveAsmethod,orbyacalltotheSavemethodwhenthedocumentisnew,orbyacalltoeithermethodwhenthedocumentisread-only.Otherwise,theIsSaveAspropertyreturnsFalse.

ExampleInthefollowingexample,theIsSaveAspropertyoftheSaveEventobjectisusedtodetermineiftheuserwillbepresentedwithaSaveAsdialogbox;otherwise,itwillinformtheuserthattheformwillsimplybesaved.

if(!eventObj.IsSaveAs){XDocument.UI.Alert(“Abouttosavethisform.”);}eventObj.PerformSaveOperation();

ShowAll

IsSignedProperty

Aread-onlypropertythatreturnsaBooleanvaluethatindicateswhetheraMicrosoftOfficeInfoPath2003formhasbeendigitallysignedusingdigitalsignatures.

expression.IsSigned

RemarksIftheIsSignedpropertyisTrue,theformhasbeendigitallysigned.IfFalse,theformhasnotbeendigitallysigned.

InfoPathusesXMLSignaturestodigitallysignforms.

NoteIfaformhasbeendigitallysigned,itsunderlyingXMLdocumentisplacedinaread-onlystate.

ExampleInthefollowingexample,theIsSignedpropertyoftheXDocumentobjectisusedtodeterminewhetheraformhasbeendigitallysigned:

if(XDocument.IsSigned)XDocument.UI.Alert("Thisformcontainsdigitalsignatures.");elsereturn;

ShowAll

IssuedByProperty

Aread-onlypropertythatreturnstheissuerofthedigitalcertificate.

expression.IssuedBy

ShowAll

IssuedToProperty

Aread-onlypropertythatreturnsastringrepresentingtowhomthedigitalcertificateisissued.

expression.IssuedTo

ShowAll

IsUndoRedoProperty(DataDOMEventObject)

Aread-onlypropertythatreturnsaBooleanvalueindicatingwhetherthedatavalidationeventoccursduringanundooperationoraredooperation.

expression.IsUndoRedo

expressionRequired.ReturnsareferencetotheDataDOMEventobject.

RemarksWhenanundooraredooperationtakesplace,theform'sunderlyingXMLdocumentisplacedinaread-onlystateandcannotbemodified.ThiscansometimesoccurduringanOnAfterChangeevent;whenitdoes,theIsUndoRedopropertyisusedtobypassthescript-baseddatavalidationthatitcontains.

ExampleInthefollowingexamplefromtheDataValidationdevelopersampleform,theIsUndoRedopropertyisusedtodeterminewhethertheeventisoccurringduringanundoorredooperation.Ifitis,theeventhandlerisexitedusingthereturn;statement.

functionmsoxd__itemB_quantityListB::OnAfterChange(eventObj){if(eventObj.IsUndoRedo){//AnundoorredooperationhasoccurredandtheDOMisread-only.return;}XDocument.DOM.selectSingleNode("/sampleData/listB/total").text=GetTotal("/sampleData/listB/itemB/quantityListB");}

IsUndoRedoProperty(DocContextChangeEventObject)

Aread-onlypropertythatreturnsaBooleanvalueindicatingwhetherthecontextchangeeventoccurredinresponsetoundoingoperationorredoinganoperation.

expression.IsUndoRedo

expressionRequired.ReturnsareferencetoaDocContextChangeEventobject.

IsUndoRedoProperty(Index)

ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickanIsUndoRedopropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheIsUndoRedoproperty.

IsUndoRedopropertyasitappliestotheDataDOMEventobject.

IsUndoRedopropertyasitappliestotheDocContextChangeEventobject.

ShowAll

ItemProperty(DataAdaptersCollection)

Aread-onlypropertythatreturnsareferencetothespecifieddataadapterobjectfromtheDataAdaptersCollectioncollection,basedonpositionorname.

expression.Item(ByValvarIndexAsVariant)AsObject

expressionRequired.AnexpressionthatreturnsareferencetotheDataAdapterscollection.

varIndexRequiredVariant.AnexpressionthatspecifiesthepositionofamemberoftheDataAdapterscollection.Iftheargumentisanumericexpression,itmustbeanumberfrom0tothevalueofthecollection'sCountpropertyminus1.Iftheargumentisastringexpression,itmustbethenameofamemberofthecollection.

returnsAreferencetoadataadapterobject.

ExampleInthefollowingexample,theItempropertyoftheDataAdapterscollectionisusedtoreturnareferencetoadataadapterinthecollection:

varobjDataAdapter;objDataAdapter=XDocument.DataAdapters.Item(0);

BecausetheItempropertyisthedefaultpropertyoftheDataAdapterscollection,itcanalsobeusedasfollows:

varobjDataAdapter;objDataAdapter=XDocument.DataAdapters(0);

YoucanalsousethenameofadataadapterastheargumenttotheItemmethod,asshowninthefollowingexample:

varobjDataAdapter;objDataAdapter=XDocument.DataAdapters("MyDataAdapter");

ShowAll

ItemProperty(DataObjectsCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedDataObjectobjectfromtheDataObjectscollection.

expression.Item(ByValvarIndexAsVariant)AsDataObject

expressionRequired.AnexpressionthatreturnsareferencetotheDataObjectscollection.

varIndexRequiredVariant.AnexpressionthatspecifiesthepositionofamemberoftheDataObjectscollection.Ifanumericexpression,theargumentmustbeanumberfrom0tothevalueofthecollection'sCountpropertyminus1.Ifastringexpression,theargumentmustbethenameofamemberofthecollection.

returnsAreferencetoaDataObjectobject.

RemarksIfthevalueprovidedforthevarIndexargumentdoesnotmatchanyexistingmemberofthecollection,anerroroccurs.

AfteryouhavesetareferencetotheDataObjectobjectthattheItempropertyreturns,youcanaccessanyofitspropertiesormethods.

ExampleInthefollowingexample,theItempropertyoftheDataObjectscollectionisusedtoreturnareferencetoaDataObjectobject:

varobjDataObject;objDataObject=XDocument.DataObjects.Item(0);

BecausetheItempropertyisthedefaultpropertyoftheDataObjectscollection,itcanalsobeusedasfollows:

varobjDataObject;objDataObject=XDocument.DataObjects(0);

YoucanalsousethenameoftheDataObjectobjectastheargumenttotheItemmethod,asshowninthefollowingexample:

varobjDataObject;objDataObject=XDocument.DataObjects("MyDataObject");

ItemProperty(ErrorsCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedErrorobjectfromtheErrorscollection.

expression.Item(ByValindexAsLong)AsError

indexRequiredLongInteger.AnexpressionthatspecifiesthepositionofamemberoftheErrorscollection.Theargumentmustbeanumberfrom0tothevalueofthecollection'sCountpropertyminus1.

returnsAreferencetoanErrorobject.

RemarksIfthevalueprovidedfortheindexargumentdoesnotmatchanyexistingmemberofthecollection,anerroroccurs.

AfteryouhavesetareferencetotheErrorobjectthattheItempropertyreturns,youcanaccessanyofitspropertiesormethods.

ExampleInthefollowingexample,theItempropertyoftheErrorscollectionisusedtoreturnareferencetoanErrorobject:

varobjError;objError=XDocument.Errors.Item(0);

BecausetheItempropertyisthedefaultpropertyoftheErrorscollection,itcanalsobeusedasfollows:

varobjError;objError=XDocument.Errors(0);

ItemProperty(Index)

TheItempropertyreturnsareferencetoanobjectcontainedinacollection.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickanItempropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheItemproperty.

ItempropertyasitappliestotheDataAdapterscollection.

ItempropertyasitappliestotheDataObjectscollection.

ItempropertyasitappliestotheErrorscollection.

ItempropertyasitappliestotheSignaturescollection.

ItempropertyasitappliestotheSignedDataBlockscollection.

ItempropertyasitappliestotheTaskPanescollection.

ItempropertyasitappliestotheViewInfoscollection.

ItempropertyasitappliestotheWindowscollection.

ItempropertyasitappliestotheXDocumentscollection.

ItempropertyasitappliestotheXMLNodescollection.

ShowAll

ItemProperty(SignaturesCollection)

Aread-onlypropertythatreturnsareferencetothespecifieddigitalsignaturefromtheSignaturescollection.

expression.Item(ByValvarIndexAsVariant)AsSignature

expressionRequired.AnexpressionthatreturnsareferencetotheSignaturescollection.

varIndexRequiredVariant.AnumericexpressionthatspecifiesthepositionofamemberoftheSignaturescollection.Theargumentmustbeanumberfrom0tothevalueofthecollection'sCountpropertyminus1.

returnsAreferencetoadigitalsignature.

ItemProperty(SignedDataBlocksCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedSignedDataBlockobjectfromtheSignedDataBlockscollection,basedonpositionorname.

expression.Item(ByValvarIndexAsVariant)AsSignedDataBlock

expressionRequired.AnexpressionthatreturnsaSignedDataBlockscollection.

varIndexRequiredVariant.AnexpressionthatspecifiesthepositionofamemberoftheSignedDataBlockscollection.Ifthisargumentisanumericexpression,itmustbeanumberfrom0tothevalueofthecollection'sCountpropertyminus1.Ifthisargumentisastringexpression,itmustbethenameofamemberofthecollection.

returnsAreferencetoaSignedDataBlockobject.

ShowAll

ItemProperty(TaskPanesCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedTaskPaneobjectfromtheTaskPanescollection.

expression.Item(ByValvarIndexAsVariant)AsTaskPane

expressionRequired.ReturnsareferencetotheTaskPanescollection.

varIndexRequiredVariant.Anumericexpressionthatspecifiesthetypeoftaskpane.BasedontheXdTaskPaneTypeenumeration.

returnsAreferencetoaTaskPaneobject.

AfteryouhavesetareferencetotheTaskPaneobjectthattheItempropertyreturns,youcanaccessanyofitspropertiesandmethods.

ExampleInthefollowingexample,theItempropertyoftheTaskPanescollectionisusedtoreturnareferencetoaspecifiedTaskPaneobject:

varobjTaskPane;

objTaskPane=XDocument.View.Window.TaskPanes.Item(4);

BecausetheItempropertyisthedefaultpropertyoftheTaskPanescollection,itcanalsobeusedasfollows:

varobjTaskPane;

objTaskPane=XDocument.View.Window.TaskPanes(4);

ShowAll

ItemProperty(ViewInfosCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedViewInfoobjectfromtheViewInfoscollection.

expression.Item(ByValvarIndexAsVariant)AsViewInfo

expressionRequired.AnexpressionthatreturnsareferencetotheViewInfoscollection.

varIndexRequiredVariant.AnexpressionthatspecifiesthepositionofamemberoftheViewInfoscollection.Ifanumericexpression,theargumentmustbeanumberfrom0tothevalueofthecollection'sCountpropertyminus1.Ifastringexpression,theargumentmustbethenameofamemberofthecollection.

returnsAreferencetoaViewInfoobject.

AfteryouhavesetareferencetotheViewInfoobjectthattheItempropertyreturns,youcanaccessanyofitsproperties.

ExampleInthefollowingexample,theItempropertyoftheViewInfoscollectionisusedtoreturnareferencetoaViewInfoobject:

varobjViewInfo;objViewInfo=XDocument.ViewInfos.Item(0);

BecausetheItempropertyisthedefaultpropertyoftheViewInfoscollection,itcanalsobeusedasfollows:

varobjViewInfo;objViewInfo=XDocument.ViewInfos(0);

YoucanalsousethenameoftheViewInfoobject,whichisthenameofaview,astheargumenttotheItemmethod,asshowninthefollowingexample:

varobjViewInfo;objViewInfo=XDocument.ViewInfos("MyView");

ItemProperty(WindowsCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedWindowobjectfromtheWindowscollection.

expression.Item(ByValvarIndexAsVariant)AsWindow

expressionRequired.AnexpressionthatreturnsareferencetotheWindowscollection.

varIndexRequiredVariant.AnexpressionthatspecifiesthepositionofamemberoftheWindowscollection.Theargumentmustbeanumberfrom0tothevalueofthecollection'scountpropertyminus1.

returnsAreferencetoaWindowobject.

AfteryouhavesetareferencetotheWindowobjectthattheItempropertyreturns,youcanaccessanyofitspropertiesandmethods.

ExampleInthefollowingexample,theItempropertyoftheWindowscollectionisusedtoreturnareferencetoaWindowobject:

varobjWindow;objWindow=Application.Windows.Item(0);

BecausetheItempropertyisthedefaultpropertyoftheWindowscollection,itcanalsobeusedasfollows:

varobjWindow;objWindow=Application.Windows(0);

ShowAll

ItemProperty(XDocumentsCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedXDocumentobjectfromtheXDocumentscollection.

expression.Item(ByValvarIndexAsVariant)AsXDocument

varIndexRequiredVariant.AnexpressionthatspecifiesthepositionofamemberoftheXDocumentscollection.Ifanumericexpression,theargumentmustbeanumberfrom0tothevalueofthecollection'sCountpropertyminus1.Ifastringexpression,theargumentmustbetheUniformResourceLocator(URL)pathofamemberofthecollection.

returnsAreferencetoanXDocumentobject.

AfteryouhavesetareferencetotheXDocumentobjectthattheItempropertyreturns,youcanaccessanyofitspropertiesormethods.

ExampleInthefollowingexample,theItempropertyoftheXDocumentscollectionisusedtoreturnareferencetoanXDocumentobject:

varobjXDoc;objXDoc=Application.XDocuments.Item(0);

BecausetheItempropertyisthedefaultpropertyoftheXDocumentscollection,itcanalsobeusedasfollows:

varobjXDoc;objXDoc=Application.XDocuments(0);

YoucanalsousethenameoftheXDocumentastheargumenttotheItemmethod,asshowninthefollowingexample:

varobjXDoc;objXDoc=Application.XDocuments("MyForm");

ShowAll

ItemProperty(XMLNodesCollection)

Aread-onlypropertythatreturnsareferencetothespecifiedXMLDocumentObjectModel(DOM)nodefromtheXMLNodescollection.

expression.Item(ByValvarIndexAsVariant)AsIXMLDOMNode

expressionRequired.ReturnsareferencetotheXMLNodescollection.

varIndexRequiredVariant.AnumericexpressionthatspecifiesthepositionofamemberoftheXMLNodescollection.Theargumentmustbeanumberfrom0tothevalueofthecollection'scountpropertyminus1.

returnsAreferencetoanXMLDOMnodeobject.

AfteryouhavesetareferencetotheXMLDOMnodeobjectthattheItempropertyreturns,youcanaccessanyofitspropertiesandmethods.

ExampleInthefollowingexample,theItempropertyoftheXMLNodescollectionisusedtoreturnareferencetoanXMLDOMnodeobject:

varobjXMLNodes;varobjXMLNode;

objXMLNodes=XDocument.View.GetContextNodes();objXMLNode=objXMLNodes.Item(0);

BecausetheItempropertyisthedefaultpropertyoftheXMLNodescollection,itcanalsobeusedasfollows:

varobjXMLNodes;varobjXMLNode;

objXMLNodes=XDocument.View.GetContextNodes();objXMLNode=objXMLNodes(0);

LanguageProperty

SetsorretrievesaMicrosoftOfficeInfoPath2003form'sdefaultlanguagecode.

expression.Language

RemarksThelanguagesettingsforanInfoPathformcanalsobeaccessedusingtheLanguageSettingspropertyoftheApplicationobject.

ExampleInthefollowingexample,theLanguagepropertyoftheXDocumentobjectisusedtodisplayaform'scurrentlanguagesettinginamessagebox:

XDocument.UI.Alert("Thecurrentlanguageis:"+XDocument.Language

ShowAll

LanguageSettingsProperty

Aread-onlypropertythatreturnsareferencetotheMicrosoftOfficeLanguageSettingsobject.

expression.LanguageSettings

expressionAnexpressionthatreturnsareferencetotheApplicationobject.

RemarksTheLanguageSettingspropertyisavailableonlywhenusingscriptingcode.

AfteryouestablishareferencetotheLanguageSettingsobject,youcanaccessallthepropertiesandmethodsoftheobject.

ExampleThefollowingexampleusestheLanguageIDpropertyoftheLanguageSettingsobjecttoreturntheLCIDvalue(afour-digitnumber)forthelanguagethatiscurrentlybeingusedfortheOfficehelpsystem:

Application.LanguageSettings.LanguageID(3);

NoteBecauseMicrosoftOfficeInfoPath2003usesscriptingcodeinsteadofVisualBasicforApplications(VBA),youcannotusethenamesofenumeratedvalues;youmustusethenumericalvaluesoftheenumerations,asinthepreviousexample(msoLanguageIDHelp=3).

LeftProperty

Aread/writepropertyoftypelongintegerthatspecifiesthehorizontalpositionofthewindowrepresentedbytheWindowobject,measuredinpoints.

expression.Left

expressionRequired.AnexpressionthatreturnsareferencetoaWindowobject.

RemarksThispropertywillreturnanerrorifitissetonawindowthatisminimizedormaximized.

Settingthispropertytoapositionthatisoffthescreen,willactuallycausethewindowtobedisplayedonthescreen.

MachineOnlineStateProperty

Aread-onlypropertyoftypeXdMachineOnlineStatethatreturnsthecurrentconnectionstateoftheclientcomputer.

expression.MachineOnlineState

expressionRequired.AnexpressionthatreturnsareferencetotheApplicationobject.

ShowAll

MailEnvelopeProperty

Aread-onlypropertythatreturnsareferencetotheMailEnvelopeobjectassociatedwiththewindowthatisrepresentedbytheWindowobject.

expression.MailEnvelope

RemarksTheMailEnvelopepropertycanbeusedonlywiththeeditingwindowtypes;ifusedwithadesigningwindowtype,itwillreturnanerror.Itwillalsoreturnanerrorifnoformisopenintheformarea.

ExampleInthefollowingexample,theMailEnvelopepropertyoftheWindowobjectisusedtosetareferencetotheMailEnvelopeobject,whichisthenusedtocreateanddisplayacustome-mailmessage:

varobjEmail;

objEmail=Application.ActiveWindow.MailEnvelope;objEmail.Subject="Teste-mailmessage";objEmail.Visible=true;

ShowAll

MatchExpressionProperty

Aread-onlypropertythatreturnsastringvaluecontainingtheXPathexpressionfortheXMLDocumentObjectModel(DOM)nodeforwhichtheeventiscurrentlybeingprocessed.

expression.MatchExpression

RemarksTheXPathexpressionthattheMatchExpressionpropertycontainspointstoanXMLDOMnodeintheform'sunderlyingXMLdocument.Thisisthenodethatiscurrentlybeingvalidatedbythedatavalidationeventhandler.

ExampleInthefollowingexample,theMatchExpressionpropertyoftheDataDOMEventobjectisusedtodisplaytheXPathexpressionoftheXMLDOMnodethatiscurrentlybeingvalidated:

XDocument.UI.Alert("Matchexpression:"+eventObj.MatchExpression

MathProperty

Aread-onlypropertythatreturnsareferencetotheMathobject.

expression.Math

expressionRequired.AnexpressionthatreturnsareferencetotheUtilobject.

RemarksUsingtheMathproperty,youcanaccessallofthemethodsthattheMathobjectprovides.

NameProperty(ADOAdapterObject)

Aread-onlypropertythatreturnsthenameofanADOAdapterobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetoanADOAdapterobject.

NameProperty(ApplicationObject)

Aread-onlypropertythatreturnsastringcontainingthenameoftheMicrosoftOfficeInfoPath2003application.

expression.Name

RemarksThenameoftheapplicationdoesnotcontaintheversionnumber.Toobtaintheversionnumberofanapplication,usetheVersionpropertyoftheApplicationobject.

ExampleInthefollowingexample,theAlertmethodoftheUIobject,accessedthroughtheXDocumentobject,isusedtodisplayamessageboxthatindicatesthenameoftheapplication:

XDocument.UI.Alert("Applicationname:"+Application.Name);

ShowAll

NameProperty(DataObjectObject)

Aread-onlypropertythatreturnsastringvalueindicatingthenameoftheassociatedDataObjectobject.

expression.Name

RemarksThenameoftheDataObjectobjectisthesameasthenameofthesecondarydatasourcethatitrepresents.ThenameoftheDataObjectobjectcanalsobeusedastheargumenttotheItempropertyoftheDataObjectscollection.

ExampleInthefollowingexample,theNamepropertyoftheDataObjectobjectisusedtotodisplaythenameoftheDataObjectobjectinamessagebox:

varobjDataObject;

objDataObject=XDocument.DataObjects(0);XDocument.UI.Alert("DataObjectname:"+objDataObject.Name);

NameProperty(DAVAdapterObject)

Aread-onlypropertythatreturnsthenameofaDAVAdapterobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetoaDAVAdapterobject.

NameProperty(EmailAdapterObject)

Aread-onlypropertythatreturnsthenameofanEmailAdapterobject.

expression.Name

NameProperty(HWSAdapterObject)

Aread-onlypropertythatreturnsthenameofanHWSAdapterobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetoaHWSAdapterobject.

NameProperty(Index)

TheNamepropertyreturnsastringthatspecifiesthenameofanobject.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaNamepropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheNameproperty.

NamepropertyasitappliestotheADOAdapterobject.

NamepropertyasitappliestotheApplicationobject.

NamepropertyasitappliestotheDataObjectobject.

NamepropertyasitappliestotheDAVAdapterobject.

NamepropertyasitappliestotheEmailAdapterobject.

NamepropertyasitappliestotheHWSAdapterobject.

NamepropertyasitappliestotheSharepointListAdapterobject.

NamepropertyasitappliestotheSignedDataBlockobject.

NamepropertyasitappliestotheViewobject.

NamepropertyasitappliestotheViewInfoobject.

NamepropertyasitappliestotheWebServiceAdapterobject.

NamepropertyasitappliestotheXMLFileAdapterobject.

NameProperty(SharePointListAdapterObject)

Aread-onlypropertythatreturnsthenameofaSharepointListAdapterobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetoaSharePointListAdapterobject

NameProperty(SignedDataBlockObject)

Aread-onlypropertythatreturnsthenameofaSignedDataBlockobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetoaSignedDataBlockobject.

NameProperty(ViewObject)

Aread-onlypropertythatreturnsastringcontainingthenameoftheviewthatisrepresentedbytheViewobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetotheViewobject.

RemarksTodeterminewhetheraviewisthedefaultview,usetheViewInfoobject.

ExampleInthefollowingexamplefromtheEventsdevelopersampleform,theNamepropertyoftheViewobjectisusedtodeterminewhichviewtheuserhasswitchedto.IftheviewistheArchiveCustomerview,anotevalueisaddedtotheform'sunderlyingXMLdocument:

functionXDocument::OnSwitchView(eventObj){varoDate=newDate();

if(XDocument.View.Name=="ArchiveCustomer"){varoNotesNode=XDocument.DOM.selectSingleNode("/Customers/CustomerInfo/Notes");varoDivNode=XDocument.DOM.createNode(1,"div","http://www.w3.org/1999/xhtml");

oDivNode.text="Noterecorded"+oDate.toString();oNotesNode.appendChild(oDivNode);}}

NameProperty(ViewInfoObject)

Aread-onlypropertythatreturnsastringvalueindicatingthenameoftheviewthatisassociatedwiththeViewInfoobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetotheViewInfoobject.

RemarksThenameoftheViewInfoobjectisthesameasthenameoftheviewthatitrepresents.ThenameoftheViewInfoobjectcanalsobeusedastheargumenttotheItempropertyoftheViewInfoscollection.

ExampleInthefollowingexample,theNamepropertyoftheViewInfoobjectisusedtotodisplaythenameofaviewinamessagebox:

varobjViewInfo;

objViewInfo=XDocument.ViewInfos(0);XDocument.UI.Alert("Viewname:"+objViewInfo.Name);

NameProperty(WebServiceAdapterObject)

Aread-onlypropertythatreturnsthenameofaWebServiceAdapterobject.

expression.Name

NameProperty(XMLFileAdapterObject)

Aread-onlypropertythatreturnsthenameofanXMLFileAdapterobject.

expression.Name

expressionRequired.AnexpressionthatreturnsareferencetoanXMLFileAdapterobject.

ShowAll

NewValueProperty

Aread-onlypropertythatreturnsastringvalueindicatingthevalueofanXMLDocumentObjectModel(DOM)nodethatisbeingupdatedorinsertedduringadatavalidationevent.

expression.NewValue

RemarksTheNewValuepropertycontainsthevalueoftheXMLDOMnodethatwillreplacetheexistingvalue.TogettheoriginalvalueoftheXMLDOMnode,usetheOldValuepropertyoftheDataDOMEventobject.

ExampleInthefollowingexamplefromtheADO(ActiveXDataObjects)developersampleform,theNewValuepropertyoftheDataDOMEventobjectisusedtodeterminewhetherthenewvalueoftheXMLDOMnodeisanemptystring.Ifitisnot,thecodesetsotherfieldstobeemptystrings.

functionmsoxd__Employees_EmployeeID_attr::OnAfterChange(eventObj){if(eventObj.IsUndoRedo){//AnundoorredooperationhasoccurredandtheDOMisread-only.return;}if(eventObj.NewValue=="")return;

if(XDocument.DOM.selectSingleNode('/dfs:myFields/dfs:queryFields/q:Employees/@FirstName').text!="")XDocument.DOM.selectSingleNode('/dfs:myFields/dfs:queryFields/q:Employees/@FirstName').text="";

if(XDocument.DOM.selectSingleNode('/dfs:myFields/dfs:queryFields/q:Employees/@LastName').text!="")XDocument.DOM.selectSingleNode('/dfs:myFields/dfs:queryFields/q:Employees/@LastName').text="";}

ShowAll

NodeProperty(ErrorObject)

Aread-onlypropertythatreturnsareferencetotheXMLDocumentObjectModel(DOM)nodeofaform'sunderlyingXMLdocumentthatisassociatedwithanErrorobject.

expression.Node

RemarksUsingtheNodeproperty,youcanaccessallofthepropertiesandmethodsthattheXMLDOMnodeobjectprovides.

ExampleInthefollowingexample,theNodepropertyoftheErrorobjectisusedtodisplaytheXMLnodeofanerrorinamessagebox:

varobjError;

objError=XDocument.Errors(0);XDocument.UI.Alert("Errorname:"+objError.Node.xml);

ShowAll

NodeProperty(Index)

TheNodepropertyreturnsareferencetotheXMLDocumentObjectModel(DOM)nodeofaform'sunderlyingXMLdocumentthatisassociatedwithaparticularobject.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaNodepropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheNodeproperty.

NodepropertyasitappliestotheErrorobject.

NodepropertyasitappliestotheInfoPathControlSiteobject.

NodeProperty(InfoPathControlSiteObject)

RetrievesareferencetotheXMLnodetowhichtheActiveXcontrolisbound.

expression.Node

expressionRequired.AnexpressionthatreturnsareferencetotheInfoPathControlSiteobject.

ShowAll

OldValueProperty

Aread-onlypropertythatreturnsastringvalueindicatingtheoriginalvalueofanXMLDocumentObjectModel(DOM)nodethatisbeingupdatedordeletedduringadatavalidationevent.

expression.OldValue

RemarksTheOldValuepropertycontainstheoriginalvalueoftheXMLDOMnodethatwillbereplacedwithanewvalueordeleted.TogetthenewvalueoftheXMLDOMnode,usetheNewValuepropertyoftheDataDOMEventobject.

ExampleInthefollowingexample,theOldValuepropertyoftheDataDOMEventobjectisusedtodisplaytheoriginalvalueofanXMLDOMnode,alongwithitsnewvalue:

XDocument.UI.Alert("Originalvalue:"+eventObj.OldValue+"\nNewvalue:"+eventObj.NewValue);

ShowAll

OperationProperty(DataDOMEventObject)

Aread-onlypropertythatreturnsastringvalueindicatingthetypeofactionthatisappliedtoanXMLDocumentObjectModel(DOM)nodeduringadatavalidationevent.

expression.Operation

RemarksThevaluesthattheOperationpropertyreturnsincludeInsert,Update,andDelete.

ExampleInthefollowingexamplefromtheStructuralEditingdevelopersampleform,theOperationpropertyoftheDataDOMEventobjectisusedtocheckthetypeofactionthatisoccurring;ifitisadeleteaction,thecodecallsacustomfunction:

functionmsoxd__item::OnAfterChange(eventObj){if(!eventObj.IsUndoRedo&&eventObj.Operation=="Delete"&&eventObj.Site.nodeName=="item"&&eventObj.Source.nodeName=="item"){Calculate();}}

OperationProperty(Index)

TheOperationpropertyeitherspecifiesorreturnsastringthatrepresentsaWebservicecommandstring,orreturnsthenameofaneventaction.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickanOperationpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheOperationproperty.

OperationpropertyasitappliestotheDataDOMEventobject.

OperationpropertyasitappliestotheWebServiceAdapterobject.

ShowAll

OperationProperty(WebServiceAdapterObject)

SetsorretrievesastringvaluethatcontainsthesourceXMLoftheoperationelementcontainedintheformdefinition(.xsf)file.

expression.Operation

RemarksTheoperationelementofthe.xsffilecontainsinformationabouttheWebservice,includingitsname,themethodusedforretrievingandsubmittingdata,anditsUniformResourceLocator(URL).

ExampleInthefollowingexample,theOperationpropertyoftheWebServiceAdapterobjectisusedtodisplaytheoperationstringoftheWebservicedataadapterinamessagebox:

varobjWSAdapter;

objWSAdapter=XDocument.DataObjects("WebCityList").QueryAdapter;XDocument.UI.Alert("Operationstring:"+objWSAdapter.Operation

ShowAll

OutputLocationProperty

Aread/writepropertythatspecifiestheXMLDocumentObjectModel(DOM)nodeunderwhichtheadapterwillcopytheXMLreturnedbytheXMLWebservice.

expression.OutputLocation

RemarksIfthevalueoftheOutputLocationpropertyisnotsetonaqueryadapter,itwillcorrespondtothedataFieldselementinthedatasourceassociatedwiththedataconnection.

ShowAll

PackageURLProperty

Aread-onlypropertythatreturnsastringcontainingtheUniformResourceLocator(URL)ofthecachefolderthatcontainsaMicrosoftOfficeInfoPath2003form'sextractedformfiles.

expression.PackageURL

RemarksThePackageURLpropertyissetatruntime,andtheURLitcontainspointstothefolderwheretheformtemplate'sfilesarecached.

ExampleInthefollowingexample,thePackageURLpropertyoftheSolutionobjectisusedtodisplaythefolder'sURLinamessagebox:

XDocument.UI.Alert("PackageURL:"+XDocument.Solution.PackageURL

ShowAll

ParentProperty

Aread-onlypropertythatreturnsareferencetotheXMLDocumentObjectModel(DOM)nodeoftheparentoftheXMLDOMnodebeingchangedduringadatavalidationevent.

expression.Parent

RemarksAfteryouhavesetareferencetotheXMLDOMnodethattheParentpropertyreturns,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.Thiscanbeespeciallyusefulduringdeleteoperations,becausetheParentpropertymapstothelocationoftheXMLDOMnodethatwasremoved.

ExampleInthefollowingpartialexamplefromtheDataValidationdevelopersampleform,theParentpropertyoftheDataDOMEventobjectisusedtocheckthenameoftheparentnode;ifitmatchescertaincriteria,anerrormessageisdisplayed:

functionmsoxd__shippingDates::OnBeforeChange(eventObj){varobjOrderDate=newDate(XDocument.DOM.selectSingleNode('/sampleData/shippingDates/orderDate').text.replace(/(.*)-(.*)-(.*)/,"$2-$3-$1"));varobjShipDate=newDate(XDocument.DOM.selectSingleNode('/sampleData/shippingDates/shipDate').text.replace(/(.*)-(.*)-(.*)/,"$2-$3-$1"));...

if(objShipDate.toString()!="NaN"&&objOrderDate.toString()=="NaN"){eventObj.ReturnMessage="TheShipDateisinvalidwithoutanorderdate.";

if(eventObj.Parent.nodeName=="orderDate")eventObj.ReturnMessage+="YoumustdeletetheShipDate"+"beforedeletingtheOrderDate.";

eventObj.ReturnStatus=false;return;}...}

ShowAll

QueryAdapterProperty(DataObjectObject)

Aread-onlypropertythatreturnsareferencetothedataadapterobjectthatisusedforasecondarydatasource.

expression.QueryAdapter

RemarksAfteryouhavesetareferencetothedataadapterobjectthattheQueryAdapterpropertyreturns,youcanusethepropertiesandmethodsthattheparticulardataadapterobjectcontains.

ExampleInthefollowingexample,theQueryAdapterpropertyoftheDataObjectobjectisusedtoreturnareferencetothedataadapterthatisassociatedwiththeDataObjectobject,which,inthiscase,isanADOAdapterdataadapterobject.ThecodethenusestheCommandpropertyoftheADOAdapterobjecttodisplaytheSQLcommandtextinamessagebox:

varobjDataAdapter;

objDataAdapter=XDocument.DataObjects("CityList").QueryAdapterXDocument.UI.Alert("SQLcommandtext:"+objDataAdapter.Command);

QueryAdapterProperty(Index)

TheQueryAdapterpropertyreturnsareferencetoatypeofdataadapterobjectsuchastheADOAdapter,WebServiceAdapter,orXMLFileAdapterobject.ThispropertyisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaQueryAdapterpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheQueryAdapterproperty.

QueryAdapterpropertyasitappliestotheDataObjectobject.

QueryAdapterpropertyasitappliestotheXDocumentobject.

ShowAll

QueryAdapterProperty(XDocumentObject)

Aread-onlypropertythatreturnsareferencetothedataadapterobjectthatisassociatedwithaMicrosoftOfficeInfoPath2003form.

expression.QueryAdapter

RemarksDataadapterobjectsprovidedifferentpropertiesandmethodsthatretrieveandsubmitdatatoexternaldatasources;thedataadapterthatisassociatedwithaformisdependentonthetypeofdatasourcethatwasusedwhentheformwasinitiallycreated.

TheQueryAdapterpropertyallowsyoutoaccessanInfoPathform'sprimarydatasource.Toaccessthedataadapterobjectsusedforaform'ssecondarydatasources,usetheDataObjectspropertyoftheXDocumentobject.

NoteTheXMLFileAdapterobjectcannotbeusedwiththeQueryAdapterpropertyoftheXDocumentobject,itisonlyusedforsecondarydatasources.Toaccessaform'sunderlyingXMLdocument,usetheDOMpropertyoftheXDocumentobject.

ExampleInthefollowingexample,theQueryAdapterpropertyoftheXDocumentobjectisusedtosetareferencetotheADOAdapterdataadapterobject;thentheCommandpropertyoftheADOAdapterobjectisusedtodisplaytheSQLcommandtextinamessagebox:

varobjADOAdapter;

objADOAdapter=XDocument.QueryAdapter;XDocument.UI.Alert("SQLcommandtext:"+objADOAdapter.Command);

ShowAll

QueryAllowedProperty(ADOAdapterObject)

Aread-onlypropertyoftypeBooleanthatalwaysreturnsTrue,correspondingtothequeryAllowedattributeintheformdefinitionfile(.xsf).

expression.QueryAllowed

expressionAnexpressionthatreturnsanADOAdapterobject.

ShowAll

QueryAllowedProperty(DAVAdapterObject)

Aread-onlypropertyoftypeBooleanthatalwaysreturnsFalse,correspondingtothequeryAllowedattributeintheformdefinitionfile(.xsf).

expressionAnexpressionthatreturnsaDAVAdapterobject.

ShowAll

QueryAllowedProperty(EmailAdapterObject)

Aread-onlypropertyoftypeBooleanthatalwaysreturnsFalse,correspondingtothequeryAllowedattributeintheformdefinitionfile(.xsf).

expressionAnexpressionthatreturnsanEmailAdapterobject.

ShowAll

QueryAllowedProperty(HWSAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluethatisalwaysFalse,correspondingtothequeryAllowedattributeintheformdefinitionfile(.xsf).

expressionAnexpressionthatreturnsanHWSAdapterobject.

ShowAll

QueryAllowedProperty(Index)

TheQueryAllowedpropertyreturnsavaluethatcorrespondstothequeryAllowedattributeintheformdefinitionfile(.xsf).ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaQueryAllowedpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheQueryAllowedproperty.

QueryAllowedpropertyasitappliestotheADOAdapterobject.

QueryAllowedpropertyasitappliestotheDAVAdapterobject.

QueryAllowedpropertyasitappliestotheEmailAdapterobject.

QueryAllowedpropertyasitappliestotheHWSAdapterobject.

QueryAllowedpropertyasitappliestotheSharepointListAdapterobject.

QueryAllowedpropertyasitappliestotheWebServiceAdapterobject.

QueryAllowedpropertyasitappliestotheXMLFileAdapterobject.

ShowAll

QueryAllowedProperty(SharePointListAdapterObject)

expressionAnexpressionthatreturnsaSharepointListAdapterObjectobject.

ShowAll

QueryAllowedProperty(WebServiceAdapterObject)

Aread-onlypropertyoftypeBooleanthatcorrespondstothequeryAllowedattributeintheformdefinitionfile(.xsf).ThedefaultvalueisFalse.

expressionAnexpressionthatreturnsaWebServiceAdapterobject.

ShowAll

QueryAllowedProperty(XMLFileAdapterObject)

expressionAnexpressionthatreturnsanXMLFileAdapterobject.

ShowAll

ReturnMessageProperty

Setsorretrievesastringvalueindicatingtheerrormessagethatwillbereturnedifthedatavalidationeventisnotsuccessful.

expression.ReturnMessage

RemarksUsedinconjunctionwiththeReturnStatuspropertyoftheDataDOMEventobject,theReturnStatuspropertydisplaysamessageboxtotheuserwiththespecifiedtextmessage.

ExampleInthefollowingexample,theReturnMessagepropertyoftheDataDOMEventobjectisusedtodisplayamessagetotheuserifthedatavalidationfortheXMLDOMnodefails:

functionmsoxd__id_attr::OnBeforeChange(eventObj){if(eventObj.NewValue==""){eventObj.ReturnMessage="Youmustsupplyavalueforthisfield.";eventObj.ReturnStatus=false;return;}}

ShowAll

ReturnStatusProperty(DataDOMEventObject)

SetsorretrievesaBooleanvalueindicatingthereturnstatusofthedatavalidationevent.

expression.ReturnStatus

RemarksIftheReturnStatuspropertyissettoFalse,thechangestotheXMLDocumentObjectModel(DOM)nodearenotacceptedandthedatavalidationeventfails.IfsettoTrue,nodatavalidationerrorhasoccurredandthedatavalidationeventissuccessful.

ExampleInthefollowingexample,theReturnStatuspropertyoftheDataDOMEventobjectisusedtoindicatethatthedatavalidationeventwasnotsuccessful.ThecodealsousestheReturnMessagepropertyoftheDataDOMEventobjecttodisplayamessagetotheuser.

functionmsoxd__id_attr::OnBeforeChange(eventObj){if(eventObj.NewValue==""){eventObj.ReturnMessage="Youmustsupplyavalueforthisfield.";eventObj.ReturnStatus=false;return;}}

ReturnStatusProperty(DocActionEventObject)

SetsorretrievesaBooleanvalueindicatingthereturnstatusoftheOnClickevent.

expressionRequired.ReturnsareferencetotheDocActionEventobject.

RemarksIftheReturnStatuspropertyissettoFalse,theOnClickeventfails.IfsettoTrue,theOnClickeventissuccessful.ThedefaultvalueisTrue.

NoteSettingtheReturnStatuspropertytofalsewillcauseamessageboxtobedisplayedwhichindicateswhathasfailed.

ExampleInthefollowingexample,theReturnStatuspropertyoftheDocActionEventobjectisusedtoindicatethattheOnClickeventwasnotsuccessful:

functionDocActionEventCancel::OnClick(eventObj){//Canceltheevent.eventObj.ReturnStatus=false;}

ReturnStatusProperty(DocReturnEventObject)

SetsorretrievesaBooleanvalueindicatingthereturnstatusoftheOnLoadandOnSubmitRequestevents.

expressionRequired.ReturnsareferencetotheDocReturnEventobject.

RemarksIftheReturnStatuspropertyissettoFalse,theOnLoadandOnSubmitRequesteventsfail.IfsettoTrue,theOnLoadandOnSubmitRequesteventsaresuccessful.ThedefaultvaluefortheOnLoadeventisTrue,andthedefaultvaluefortheOnSubmitRequesteventisFalse.

ExampleInthefollowingexample,theReturnStatuspropertyoftheDocReturnEventobjectisusedtoindicatethattheOnLoadeventwasnotsuccessful:

functionXDocument::OnLoad(eventObj){//Canceltheevent.eventObj.ReturnStatus=false;}

ReturnStatusProperty(Index)

TheReturnStatuspropertyreturnsaBooleanvalueindicatingwhetherthechangesthatoccurredduringtheeventareacceptedorrejected.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaReturnStatuspropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheReturnStatusproperty.

ReturnStatuspropertyasitappliestotheDataDOMEventobject.

ReturnStatuspropertyasitappliestotheDocActionEventobject.

ReturnStatuspropertyasitappliestotheDocReturnEventobject.

ReturnStatuspropertyasitappliestotheMergeEventobject.

ReturnStatuspropertyasitappliestotheSaveEventobject.

ReturnStatuspropertyasitappliestotheVersionUpgradeEventobject.

ReturnStatusProperty(MergeEventObject)

Aread-writepropertythatsetsorretrievesaBooleanvalueindicatingthereturnstatusoftheOnMergeRequestevent.

RemarksThedefaultvalueoftheReturnStatuspropertyoftheMergeEventobjectisFalse.IfthispropertyisnotsettoTrue,theeventhandlerfortheOnMergeRequesteventwillfail.

ReturnStatusProperty(SaveEventObject)

SetsorretrievesaBooleanvalueindicatingthereturnstatusoftheOnSaveRequestevent.

ReturnStatusProperty(SignEventObject)

SetsorretrievesaBooleanvalueindicatingthereturnstatusoftheOnSignevent.

expressionRequired.AnexpressionthatreturnsareferencetoaSignEventobject.

ReturnStatusProperty(VersionUpgradeEventObject)

SetsorretrievesaBooleanvalueindicatingthereturnstatusoftheOnVersionUpgradeevent.

expressionRequired.ReturnsareferencetotheVersionUpgradeEventobject.

RemarksIftheReturnStatuspropertyissettoFalse,theOnVersionUpgradeeventfailsandtheformisnotopened.IfsettoTrue,theOnVersionUpgradeeventissuccessful.

ExampleInthefollowingexample,theReturnStatuspropertyoftheVersionUpgradeEventobjectisusedtoindicatethattheOnVersionUpgradeeventwasnotsuccessful:

functionXDocument::OnVersionUpgrade(eventObj){//Canceltheevent.eventObj.ReturnStatus=false;}

RoleProperty

Setsorretrievestheuser'scurrentrole.

expression.Role

ExampleInthefollowingexample,theRolepropertyisusedtodeterminethecurrentuser'srole.

varstrCurrentRole=XDocument.Role;

RollBackProperty(MergeEventobject)

Aread/writepropertythatprovidesadditionalinformationtotheOnMergeRequesteventalongwiththeReturnStatuspropertyflag.

expression.RollBack

RemarksIftheReturnStatuspropertyoftheMergeEventobjectissettoTrue,thispropertyisignored.

IftheReturnStatuspropertyisFalseandtheRollBackpropertyisTrue,theentiremergingoperationwillbecancelledandrolledbacktothestatebeforetheoperationwasinitiated.IftheRollBackpropertyisFalse,mergingthecurrentformwillfail,butthemergingoperationwillcontinuewiththenextform.

ExampleInthefollowingexample,theRollBackpropertyoftheMergeEventobjectisusedtorollbacktheentireoperationifamergefails.

try{XDocument.ImportDOM(eventObj.DOM)}catch(ex){eventObj.ReturnStatus=false;eventObj.RollBack=true;}

ShortErrorMessageProperty

SetsorretrievesthestringvaluecontainingtheshorterrormessageofanErrorobject.

expression.ShortErrorMessage

RemarksTheshorterrormessageistheToolTipthatusersviewwhendatavalidationfailsintheirforms.

ExampleInthefollowingexample,theShortErrorMessagepropertyoftheErrorobjectisusedtodisplaytheshortmessageofanerrorinamessagebox:

varobjError;

objError=XDocument.Errors(0);XDocument.UI.Alert("Errorname:"+objError.ShortErrorMessage);

ShowAll

SignatureBlockXmlNodeProperty

Aread-onlypropertythatreturnstheXMLnodecorrespondingadigitalsignature.

expression.SignatureBlockXmlNode

SignatureContainerProperty

Aread-onlypropertythatreturnstherootXMLnodeofthesubtreecontainingthesignaturesintheSignedDataBlockobject.

expression.SignatureContainer

SignatureRelationProperty

Aread-onlypropertythatreturnstherelationamongmultiplesignaturesoftheSignedDataBlockobject,expressedasXdSignatureRelationenumeratedconstants.

expression.SignatureRelation

SignaturesProperty

Aread-onlypropertythatreturnsareferencetotheSignaturescollectionassociatedwiththeSignedDataBlockobject.

expression.Signatures

SignedDataBlockProperty

Aread-onlypropertythatreturnsthesigneddatablockthattriggerstheOnSignevent.

expression.SignedDataBlock

expressionRequired.AnexpressionthatreturnsaSignEventobject.

SignedDataBlocksProperty

Aread-onlypropertythatreturnsareferencetotheSignedDataBlockscollectionthatisassociatedwithanXDocumentobject.

expression.SignedDataBlocks

RemarksTheSignedDataBlockspropertyisusedtoobtainareferencetotheSignedDataBlockscollection.

ShowAll

SiteProperty

Aread-onlypropertythatreturnsareferencetotheXMLDocumentObjectModel(DOM)nodewherethedatavalidationeventiscurrentlybeingprocessed.

expression.Site

RemarksAfteryouhavesetareferencetotheXMLDOMnodethattheSitepropertyreturns,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.

ExampleInthefollowingexamplefromtheDataValidationdevelopersampleform,theSitepropertyoftheDataDOMEventobjectisusedtocheckthevalueoftheXMLDOMnode;ifitmatchescertaincriteria,anerroriscreated:

functionmsoxd__itemB_quantityListB::OnValidate(eventObj){if(parseInt(eventObj.Site.nodeTypedValue,10)>50)eventObj.ReportError(eventObj.Site,"Invalidquantity."+"Thetotalnumberofeachtypeofblockcannotexceed50.",false);

if(parseInt(eventObj.Site.nodeTypedValue,10)<0)eventObj.ReportError(eventObj.Site,"Invalidquantity."+"Thetotalnumberofeachtypeofblockcannotbelessthan0.",false);}

ShowAll

SiteUrlProperty

Aread-onlypropertyreturningtheUniformResourceLocator(URL)oftheWindowsSharePointServicessitethattheSharepointListAdapterwillquery.

expression.SiteUrl

expressionRequired.AnexpressionthatreturnsareferencetoaSharePointListAdapterobject.

ExampleThefollowingexampleshowshowtousetheSiteUrlpropertyofaSharePointListAdapterobjecttostoretheURLlocationinalocalvariable:

varstrSiteURL=XDocument.DataAdapters["Announcements"].SiteUrl

ShowAll

SolutionProperty

Aread-onlypropertythatreturnsareferencetotheSolutionobjectthatisassociatedwithaMicrosoftOfficeInfoPath2003form.

expression.Solution

RemarksTheSolutionobjectprovidesaccesstoinformationaboutaform'sassociatedformdefinition(.xsf)file,includingaccesstoanXMLDocumentObjectModel(DOM)thatcontainsallofthesourceXMLofthe.xsffile.

ExampleInthefollowingexample,theSolutionpropertyoftheXDocumentobjectisusedtoloadavariablewiththeXMLcontentsofthe.xsffile:

varstrXSF;strXSF=XDocument.Solution.DOM.xml;

ShowAll

SolutionVersionProperty

Aread-onlypropertythatreturnsastringcontainingtheversionnumberofaMicrosoftOfficeInfoPath2003formtemplate.

expression.SolutionVersion

expressionRequired.AnexpressionthatreturnsareferencetotheVersionUpgradeEventobject.

RemarksThispropertycanbeusedonlyduringtheOnVersionUpgradeevent.

ExampleInthefollowingexample,theSolutionVersionpropertyoftheVersionUpgradeEventobjectisusedtodisplaytheversionnumberofanInfoPathformtemplateinamessagebox:

functionXDocument::OnVersionUpgrade(eventObj){XDocument.UI.Alert("Theformversion:"+eventObj.DocumentVersion+"\nTheformtemplateversion:"+eventObj.SolutionVersion);eventObj.ReturnStatus=true;}

ShowAll

SourceProperty(DataDOMEventObject)

Aread-onlypropertythatreturnsareferencetotheXMLDocumentObjectModel(DOM)wherethedatavalidationeventisoccurring.

expression.Source

RemarksAferyouhavesetareferencetotheXMLDOMnodethattheSourcepropertyreturns,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.

ExampleInthefollowingexamplefromtheStructuralEditingdevelopersampleform,theSourcepropertyoftheDataDOMEventobjectisusedtoreturnareferencetotheXMLDOMnodethatcausedtheinitialchange.Ifthenodenamematchescertaincriteria,acustomfunctioniscalled.

functionmsoxd__quantity::OnAfterChange(eventObj){if(!eventObj.IsUndoRedo&&eventObj.Source.nodeName!="item")Calculate(eventObj.Site.parentNode);}

ShowAll

SourceProperty(DocActionEventObject)

Aread-onlypropertythatreturnsareferencetotheinner-mostXMLDocumentObjectModel(DOM)nodeofaform'sunderlyingXMLdocument.

expression.Source

RemarksAfteryouhavesetareferencetotheXMLDOMnodethattheSourcepropertyreturns,youcanuseanyofthepropertiesandmethodsthataresupportedbytheXMLDOM.

ExampleInthefollowingexample,theSourcepropertyoftheDocActionEventobjectisusedtodisplaythesourceXMLdataoftheXMLDOMnodeinamessagebox:

functionDocActionEventSource::OnClick(eventObj){XDocument.UI.Alert("Source:"+eventObj.Source.xml);}

ShowAll

SourceProperty(Index)

TheSourcepropertyreturnsareferencetotheXMLDocumentObjectModel(DOM)nodecontainingthesourceXMLofthedatabeingchangedduringanevent.ThispropertyisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaSourcepropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheSourceproperty.

SourcepropertyasitappliestotheDataDOMEventobject.

SourcepropertyasitappliestotheDocActionEventobject.

ShowAll

StatusProperty(CertificateObject)

Aread-onlypropertythatreturnsthestatusofthedigitalcertificate.ThestatusthatisreturnedisoneoftheXdCertificateStatusenumeratedconstants.

expression.Status

StatusProperty(Index)

ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickaStatuspropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheStatusproperty.

StatuspropertyasitappliestotheCertificateobject.

StatuspropertyasitappliestotheSignatureobject.

ShowAll

StatusProperty(SignatureObject)

Aread-onlypropertythatreturnsthestatusofthespecifieddigitalsignature.ThestatusthatisreturnedisbasedontheXdSignatureStatusenumeration

expression.Status

RemarksTheStatuspropertyonlyverifieswhetherthehashofthedigitalsignatureisvalid.Itdoesnotverifythechainoftrustofthedigitalcertificate,nordoesitverifythattheimageoftheviewcapturedatthetimethesignaturewasaddedmatchesthecurrentviewofthesignedform.

SubjectProperty(EmailAdapterObject)

Returnsorsetsastringthatrepresentsthesubjectofthee-mailmessageassociatedwiththespecifiedEmailAdapterobject.

expression.Subject

ExampleThisexampleshowshowtousetheSubjectpropertyofaninstanceoftheEmailAdapterobjecttochangethesubjectofthee-mailmessagebeforetheEmailAdapterobjectissubmitted:

objEmailAdapter.Subject="WeeklyStatusReport";

SubjectProperty(MailEnvelopeObject)

SetsorretrievesastringcontainingthesubjectvalueusedintheMailEnvelopeobjectthatisassociatedwithaWindowobject.

expression.Subject

RemarksTheMailEnvelopeobjectdoesnotsupporttheprogrammaticcreationofthebodyofane-mailmessage.Usersenterthebodytextafterthee-mailmessageisdisplayedinthedefaulte-maileditor.

ExampleInthefollowingexample,theSubjectpropertyoftheMailEnvelopeobjectisusedtosetthesubjectvalueofacustome-mailmessage:

ShowAll

SubmitAllowedProperty(ADOAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluecorrespondingtothesubmitAllowedattributeintheformdefinitionfile(.xsf).

expression.SubmitAllowed

RemarksThedefaultvalueoftheSubmitAllowedpropertyisFalse,asisthedefaultvalueforthesubmitAllowedattribute.IfthesubmitAllowedattributeissettoTrue,theADOconnectionsupportssubmittingdataaswellasquerying.

ShowAll

SubmitAllowedProperty(DAVAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluethatalwaysreturnsFalse,correspondingtothesubmitAllowedattributeintheformdefinitionfile(.xsf).

ShowAll

SubmitAllowedProperty(EmailAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluethatalwaysreturnsTrue,correspondingtothesubmitAllowedattributeintheformdefinitionfile(.xsf).

ShowAll

SubmitAllowedProperty(HWSAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluethatisalwaysTrue,correspondingtothesubmitAllowedattributeintheformdefinitionfile(.xsf).

expressionRequired.AnexpressionthatreturnsareferencetoaHWSAdapterobject.

SubmitAllowedProperty(Index)

TheSubmitAllowedpropertyreturnsavaluethatcorrespondstothesumitAllowedattributeintheformdefinitionfile(.xsf).ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaSubmitAllowedpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheSubmitAllowedproperty.

SubmitAllowedpropertyasitappliestotheADOAdapterobject.

SubmitAllowedpropertyasitappliestotheDAVAdapterobject.

SubmitAllowedpropertyasitappliestotheEmailAdapterobject.

SubmitAllowedpropertyasitappliestotheHWSAdapterobject.

SubmitAllowedpropertyasitappliestotheSharepointListAdapterobject.

SubmitAllowedpropertyasitappliestotheWebServiceAdapterobject.

SubmitAllowedpropertyasitappliestotheXMLFileAdapterobject.

ShowAll

SubmitAllowedProperty(SharePointListAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluecorrespondingtothesubmitAllowedattributeintheformdefinitionfile(.xsf).AlwaysreturnsFalsefortheSharePointListAdapterobject.

expressionRequired.AnexpressionthatreturnsareferencetoaSharepointListAdapterobject.

ShowAll

SubmitAllowedProperty(WebServiceAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluecorrespondingtothesubmitAllowedattributeintheformdefinitionfile(.xsf).ThedefaultvalueisFalse.

ShowAll

SubmitAllowedProperty(XMLFileAdapterObject)

Aread-onlypropertythatreturnsaBooleanvaluethatalwaysreturnsFalse,correspondingtothesubmitAllowedattributeintheformdefinitionfile(.xsf).

TaskPanesProperty

Aread-onlypropertythatreturnsareferencetotheTaskPanescollectionthatisassociatedwiththeWindowobject.

expression.TaskPanes

RemarksTheTaskPanespropertycanbeusedonlywiththeeditingwindowtypes;ifusedwithadesigningwindowtype,itwillreturnanerror.

ExampleInthefollowingexample,theTaskPanespropertyoftheWindowobjectisusedtosetareferencetotheTaskPanescollection:

varobjTaskPanes;

objTaskPanes=Application.ActiveWindow.TaskPanes;

ShowAll

TimeoutProperty(ADOAdapterObject)

SetsorretrievesthelongintegertimeoutvalueforanADOAdapterobject.

expression.Timeout

RemarksTheTimeoutpropertyoftheADOAdapterobjectcontainsthetimeoutvaluethatisusedbytheADOdataadaptertoregulatethetimeusedtosubmitandretrievedatafromanActiveXDataObjects/OLEDBexternaldatasource.

ExampleInthefollowingexample,theTimeoutpropertyoftheADOAdapterobjectisusedtodisplaythetimeoutvalueoftheADOdataadapterinamessagebox:

varobjADOAdapter;

objADOAdapter=XDocument.DataObjects("CityList").QueryAdapter;XDocument.UI.Alert("SQLcommandtext:"+objADOAdapter.Timeout

ShowAll

TimeoutProperty(Index)

TheTimeoutpropertysetsorretrievesthetime-outvalueforsometypesofdataadapters.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaTimeoutpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheTimeoutproperty.

TimeoutpropertyasitappliestotheADOAdapterobject.

TimeoutpropertyasitappliestotheWebServiceAdapterobject.

TimeoutProperty(WebServiceAdapterObject)

Setsorretrievesthelongintegertime-outvalueinsecondsforaWebServiceAdapterobject.

expression.Timeout

RemarksThedefaultvalueoftheTimeoutpropertyoftheWebServiceAdapterobjectis30seconds.

ToProperty(EmailAdapterObject)

Returnsorsetsastringthatrepresentstherecipientsforthee-mailmessageassociatedwithaspecifiedEmailAdapterobject.

expression.To

ExampleThisexampleshowshowtousetheTopropertyofaninstanceoftheEmailAdapterobjecttochangetherecipientsofane-mailmessagebeforetheEmailAdapterobjectissubmitted:

objEmailAdapter.To=objEmailAdapter.To+";newUser@example.com";

ToProperty(Index)

TheTopropertyreturnsorsetstherecipientsofane-mailmessage.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaTopropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheToproperty.

TopropertyasitappliestotheEmailAdapterobject.

TopropertyasitappliestotheMailEnvelopeobject.

ToProperty(MailEnvelopeObject)

Setsorretrievesastringcontainingthesend-tovalueusedintheMailEnvelopeobjectthatisassociatedwithaWindowobject.

expression.To

RemarksThevaluessetfortheTopropertyshouldbeastringofvalide-mailaddresses.Youcanspecifymultiplee-mailaddressesbyusing";"betweeneachofthem,asshowninthefollowingexample:

objEmail.To="someone@example.com;someone@example.com"

ExampleInthefollowingexample,theTopropertyoftheMailEnvelopeobjectisusedtosetthesend-tovalueofacustome-mailmessage:

TopProperty

Aread/writepropertyoftypelongintegerthatspecifiestheverticalpositionofthewindowrepresentedbytheWindowobject,measuredinpoints.

expression.Top

RemarksTheToppropertywillreturnanerrorifitissetonawindowthatisminimizedormaximized.

SettingtheToppropertytoapositionthatisoffthescreen,willcausetheentirewindowtobedisplayedonthescreen.

TypeProperty(DocContextChangeEventObject)

Aread-onlypropertythatreturnsastringcontainingthetypeofcontextchangeeventthatoccurredwhentheOnContextChangeeventwastriggered.

expression.Type

expressionRequired.AnexpressionthatreturnsareferencetotheDocContextChangeEventobject.

RemarksAsdescribedintheOnContextChangeeventtopic,theTypepropertyreturnsonlythevalue"ContextNode"forcontextchangesinMicrosoftInfoPath2003ServicePack1.Nevertheless,ifcodeinaneventhandlerperformsactionsthatdependoncurrentfunctionality,thatcodeshouldstillbedesignedtocheckthevalueoftheTypeproperty,becausefutureversionsofInfoPathmayusedifferentvaluesfordifferentcontextchanges.

ShowAll

TypeProperty(ErrorObject)

Aread-onlypropertythatreturnsastringvaluecontainingthetypeofanErrorobject.

expression.Type

RemarksTherearethreetypesorerrors:

SCHEMA_VALIDATIONDatavalidationfailedasaresultofanXMLSchema–definedconstraint.

SYSTEM_GENERATEDDatavalidationfailedasaresultofconstraintsdefinedintheformdefinition(.xsf)fileorasaresultofscriptingcodecallingtheReportErrormethodoftheDataDOMEventobject.

USER_SPECIFIEDDatavalidationfailedasaresultofacustomscriptingerrorusingtheAddmethodoftheErrorscollection.

ExampleInthefollowingexample,theTypepropertyoftheErrorobjectisusedtodisplaythetypeofanerrorinamessagebox:

varobjError;

objError=XDocument.Errors(0);XDocument.UI.Alert("Errorname:"+objError.Type);

ShowAll

TypeProperty(HTMLTaskPaneObject)

Aread-onlypropertythatreturnsavalueindicatingthetypeoftaskpanerepresentedbytheHTMLTaskPaneobject,whichisalwaysacustomtaskpane.

expression.Type

expressionRequired.AnexpressionthatreturnsareferencetotheHTMLTaskPaneobject.BasedontheXdTaskPaneTypeenumeration.

RemarksTheTypepropertyoftheHTMLTaskPaneobjectisoneofthepropertiesinheritedfromtheTaskPaneobjectwhenthetypeofthetaskpaneis0,whichmeansthatitisthecustomtaskpane.

ExampleInthefollowingexample,theItempropertyoftheTaskPanescollectionisusedtosetareferencetotheHTMLTaskPaneobjectthatrepresentsthecustomtaskpane.ThentheVisiblepropertyoftheHTMLTaskPaneobjectisusedtomakethecustomtaskpaneappearintheMicrosoftOfficeInfoPath2003userinterface.ThetypevalueofthecustomtaskpaneisthesameasthevaluepassedtotheItemproperty.

varobjTaskPane;

objTaskPane=XDocument.View.Window.TaskPanes(0);objTaskPane.Visible=true;

TypeProperty(Index)

TheTypepropertyreturnsavalueindicatingthetypeoftheobject.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaTypepropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheTypeproperty.

TypepropertyasitappliestotheDocContextChangeEventobject.

TypepropertyasitappliestotheErrorobject.

TypepropertyasitappliestotheHTMLTaskPaneobject.

TypepropertyasitappliestotheTaskPaneobject.

TypepropertyasitappliestotheWindowobject.

ShowAll

TypeProperty(TaskPaneObject)

Aread-onlypropertythatreturnsavalueindicatingthetypeoftaskpanerepresentedbytheTaskPaneobject.

expression.Type

expressionRequired.AnexpressionthatreturnsareferencetotheTaskPaneobject.BasedontheXdTaskPaneTypeenumeration.

RemarksIftheTypepropertyoftheTaskPaneobjectreturns0,thetaskpaneisacustomtaskpane.IftheTypepropertyreturnsanyothervalue,thetaskpaneisabuilt-intaskpane.

ExampleInthefollowingexample,theItempropertyoftheTaskPanescollectionisusedtosetareferencetotheTaskPaneobjectthatrepresentsthebuilt-inHelptaskpane.ThentheVisiblepropertyoftheTaskPaneobjectisusedtomaketheHelptaskpaneappearintheMicrosoftOfficeInfoPath2003userinterface.

varobjTaskPane;

objTaskPane=XDocument.View.Window.TaskPanes.Item(4);objTaskPane.Visible=true;

ShowAll

TypeProperty(WindowObject)

Aread-onlypropertythatreturnsalongintegervaluethatindicatesthetypeofwindowthatisrepresentedbytheWindowobject.ThevaluereturnedisbasedontheXdWindowTypeenumeration.

expression.Type

RemarksTheWindowobjectsrepresentthetwotypesofwindowsthatareusedintheInfoPathapplication:theeditingwindowthatisusedastheformareawhenauserfillsoutaform,andthedesigningwindowthatisusedasthedesignmodewhenauserdesignsaform.

ExampleInthefollowingexample,theTypepropertyoftheWindowobjectisusedtodeterminethetypeofwindowthatisthecurrentlyactivewindow:

if(Application.ActiveWindow.Type==0)XDocument.UI.Alert("Theactivewindowisaneditingwindow.");elseXDocument.UI.Alert("Theactivewindowisadesigningwindow.");

UIProperty

ReturnsareferencetotheMicrosoftOfficeInfoPath2003UIobject.

expression.UI

RemarksTheUI(userinterface)objectprovidesanumberofmethodsthatcanbeusedtodisplaycustomandbuilt-indialogboxes.

ExampleInthefollowingexample,theUIpropertyoftheXDocumentobjectisusedtodisplayasimplemessageboxusingtheAlertmethod:

XDocument.UI.Alert("Hereisthemessagetext.");

ShowAll

URIProperty(Index)

TheURIpropertyreturnsastringvaluethatspecifiesaUniformResourceIdentifier(URI)location.ThispropertyisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaURIpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheURIproperty.

URIpropertyasitappliestotheSolutionobject.

URIpropertyasitappliestotheXDocumentobject.

ShowAll

URIProperty(SolutionObject)

Aread-onlypropertythatreturnsastringvaluecontainingtheUniformResourceIdentifier(URI)ofaMicrosoftOfficeInfoPath2003formtemplate.

expression.URI

RemarksThevalueoftheURIpropertyoftheSolutionobjectcantaketheformofaUniformResourceLocator(URL)orUniformResourceName(URN),dependingonthelocationfromwhichtheformwasopened.

ExampleInthefollowingexample,theURIpropertyoftheSolutionobjectisusedtodisplayaformtemplate'sURIinamessagebox:

XDocument.UI.Alert("URI:"+XDocument.Solution.URI);

ShowAll

URIProperty(XDocumentObject)

Aread-onlypropertythatreturnsastringvaluecontainingtheUniformResourceIdentifier(URI)ofaMicrosoftOfficeInfoPath2003form.

expression.URI

RemarksTheURIpropertycanbeusedasthenameofaformwhenaccessedthroughtheXDocumentscollection,asshowninthefollowingexample:

Application.XDocuments(XDocument.URI);

ExampleInthefollowingexample,theURIpropertyoftheXDocumentobjectisusedtodisplayaform'sURIinamessagebox:

XDocument.UI.Alert("URI:"+XDocument.URI);

UsableHeightProperty

Aread-onlypropertyoftypelongintegerthatreturnstheavailablescreenheight(themaximumnumberofpointstowhichyoucansettheheightofanInfoPathdocumentwindow.)

expression.UsableHeight

expressionRequired.AnexpressionthatreturnsareferencetoanApplicationobject.

UsableWidthProperty

Aread-onlypropertyoftypelongintegerthatreturnstheavailablescreenwidth(themaximumnumberofpointstowhichyoucansetthewidthofanInfoPathdocumentwindow.)

expression.UsableWidth

UserProperty

Aread-onlypropertythatreturnsareferencetotheUserobject.

expression.User

UtilProperty

Read-onlypropertythatreturnsareferencetotheUtilobject.

expression.Util

ShowAll

VersionProperty(ApplicationObject)

Aread-onlypropertythatreturnsastringcontainingtheMicrosoftOfficeInfoPath2003versionnumber.

expression.Version

RemarksTheversionnumberoftheapplicationdoesnotcontainthename.Toobtainthenameofanapplication,usetheNamepropertyoftheApplicationobject.

Toobtaintheversionnumberofaformtemplate,usetheVersionpropertyoftheSolutionobject.

ExampleInthefollowingexample,theVersionpropertyoftheApplicationobjectisusedtodisplaytheapplication'sversionnumberinamessagebox:

XDocument.UI.Alert("Applicationversion:"+Application.Version);

VersionProperty(Index)

TheVersionpropertyreturnsastringvaluethatspecifiesaversionnumber.ThispropertyisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaVersionpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheVersionproperty.

VersionpropertyasitappliestotheApplicationobject.

VersionpropertyasitappliestotheSolutionobject.

ShowAll

VersionProperty(SolutionObject)

Aread-onlypropertythatreturnsastringcontainingtheversionnumberofaMicrosoftOfficeInfoPath2003formtemplate.

expression.Version

expressionRequired.AnexpressionthatreturnsareferencetotheSolutionobject.

RemarksToobtaintheversionnumberoftheInfoPathapplication,usetheVersionpropertyoftheApplicationobject.

ExampleInthefollowingexample,theVersionpropertyoftheSolutionobjectisusedtodisplayaformtemplate'sversionnumberinamessagebox:

XDocument.UI.Alert("Formtemplateversion:"+XDocument.Solution.

ViewProperty

Aread-onlypropertythatreturnsareferencetotheViewobjectassociatedwithaMicrosoftOfficeInfoPath2003form.

expression.View

RemarksTheViewobjectthattheViewpropertyaccessesrepresentstheviewthatiscurrentlyactiveinanInfoPathform.AfteryouhavesetareferencetotheViewobject,youcanaccessanyofitspropertiesandmethodstoprogrammaticallyinteractwiththeview.

ExampleInthefollowingexample,theViewpropertyoftheXDocumentobjectisusedtosetareferencetotheViewobject;then,usingtheNamepropertyoftheViewobject,itdisplaysthenameoftheviewinamessagebox:

varobjView;

objView=XDocument.View;XDocument.UI.Alert("Viewname:"+objView.Name);

ViewInfosProperty

Aread-onlypropertythatreturnsareferencetotheViewInfoscollectionassociatedwithaMicrosoftOfficeInfoPath2003form.

expression.ViewInfos

RemarksTheViewInfoscollectioncontainsacollectionofViewInfoobjectsthatcontaininformationabouteachoftheviewsimplementedinanInfoPathform.

ExampleInthefollowingexample,theViewInfospropertyoftheXDocumentobjectisusedtosetareferencetotheViewInfoscollection;then,usingtheCountpropertyoftheViewInfoscollection,itloopsthroughthecollectiontodeterminethedefaultviewusingtheIsDefaultpropertyoftheViewInfoobject.Whenthedefaultviewisfound,thecodedisplaysthenameoftheviewinamessagebox.

varobjViewInfos;objViewInfos=XDocument.ViewInfos;for(i=0;i<objViewInfos.Count;i++){if(objViewInfos(i).IsDefault)XDocument.UI.Alert("Thedefaultviewis:"+objViewInfos(i).Name);}

ShowAll

VisibleProperty(HTMLTaskPaneObject)

SetsorretrievesaBooleanvalueindicatingthatthetaskpanerepresentedbytheHTMLTaskPaneobject,whichisalwaysacustomtaskpane,isvisibleintheMicrosoftOfficeInfoPath2003userinterface.

expression.Visible

expressionRequired.AnexpressionthatreturnsareferencetotheHTMLTaskPaneobject.

RemarksTheVisiblepropertyoftheHTMLTaskPaneobjectisoneofthepropertiesinheritedfromtheTaskPaneobjectwhenthetypeofthetaskpaneis0,whichmeansthatitisthecustomtaskpane.

SettingtheVisiblepropertytoTruecausesthetaskpanetoappearintheuserinterface,andsettingittoFalsecausesittoberemovedfromtheuserinterface.

ExampleInthefollowingexample,theItempropertyoftheTaskPanescollectionisusedtosetareferencetotheHTMLTaskPaneobjectthatrepresentsthecustomtaskpane.ThentheVisiblepropertyoftheHTMLTaskPaneobjectisusedtomakethecustomtaskpaneappearintheInfoPathuserinterface.

varobjTaskPane;

VisibleProperty(Index)

TheVisiblepropertyspecifiesorreturnsaBooleanvalueindicatingwhethertheuserinterfacecomponentrepresentedbytheobjectisvisibleintheuserinterface.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaVisiblepropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheVisibleproperty.

VisiblepropertyasitappliestotheHTMLTaskPaneobject.

VisiblepropertyasitappliestotheMailEnvelopeobject.

VisiblepropertyasitappliestotheTaskPaneobject.

VisibleProperty(MailEnvelopeObject)

SetsorretrievesaBooleanvaluethatindicatesthevisibilityofthecustome-mailmessagecreatedwiththeMailEnvelopeobjectthatisassociatedwithaWindowobject.

expression.Visible

RemarksWhentheVisiblepropertyoftheMailEnvelopeobjectissettoTrue,thecustome-mailmessagewillbedisplayedusingthedefaulte-maileditor.Ifthereisnodefaulte-maileditorconfigured,theVisiblepropertywillreturnanerror.

ExampleInthefollowingexample,theVisiblepropertyoftheMailEnvelopeobjectisusedtodisplayacustome-mailmessageinthedefaulte-maileditor:

ShowAll

VisibleProperty(TaskPaneObject)

SetsorretrievesaBooleanvalueindicatingthatthetaskpanerepresentedbytheTaskPaneobjectisvisibleintheMicrosoftOfficeInfoPath2003userinterface.

expression.Visible

expressionRequired.AnexpressionthatreturnsareferencetotheTaskPaneobject.

RemarksSettingtheVisiblepropertytoTruecausesthetaskpanetoappearintheuserinterface,andsettingittoFalsecausesittoberemovedfromtheuserinterface.

ExampleInthefollowingexample,theItempropertyoftheTaskPanescollectionisusedtosetareferencetotheTaskPaneobjectthatrepresentsthebuilt-inHelptaskpane.ThentheVisiblepropertyoftheTaskPanesobjectisusedtomaketheHelptaskpaneappearintheInfoPathuserinterface.

varobjTaskPane;

WidthProperty

Aread/writepropertyoftypelongintegerthatspecifiesthewidthofthewindowrepresentedbytheWindowobject,measuredinpoints.

expression.Width

RemarksTheWidthpropertywillreturnanerrorifitissetonawindowthatisminimizedormaximized.

TheWidthpropertycan'tbesettoavaluethatislargerthanthevaluereturnedbytheUsableWidthproperty.

ShowAll

WindowProperty(HTMLTaskPaneExternalObject)

Aread-onlypropertythatreturnsareferencetotheWindowobjectassociatedwithacustomtaskpane.

expression.Window

expressionRequired.AnexpressionthatreturnsareferencetotheHTMLTaskPaneExternalobject.

RemarksTheWindowobjectreturnedbytheWindowpropertyrepresentsthecurrentlyactiveMicrosoftOfficeInfoPath2003windowthatisassociatedwiththecustomtaskpane.

ExampleInthefollowingexample,theHTMLTaskPaneExternalobjectisusedthroughtheexternalpropertyoftheDynamicHTML(DHTML)windowobjecttosetareferencetotheWindowobjectthatispartoftheInfoPathobjectmodel:

varobjWindow;

objWindow=window.external.Window;objWindow.MailEnvelope.Visible=true;

WindowProperty(Index)

TheWindowpropertyreturnsareferencetoaWindowobject.ThispropertyisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaWindowpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheWindowproperty.

WindowpropertyasitappliestotheHTMLTaskPaneExternalobject.

WindowpropertyasitappliestotheViewobject.

ShowAll

WindowProperty(ViewObject)

Aread-onlypropertythatreturnsareferencetothewindowobjectassociatedwithaview.

expression.Window

RemarksTheWindowobjectreturnedbytheWindowpropertyrepresentsthecurrentlyactiveMicrosoftOfficeInfoPath2003window.ItcanalsobeaccessedthroughtheWindowscollection.

ExampleInthefollowingexample,theWindowpropertyoftheViewobjectisusedtosetareferencetothefirsttaskpanecontainedintheTaskPanescollection:

varobjTaskPane;

objTaskPane=XDocument.View.Window.TaskPanes(0);

WindowsProperty

Aread-onlypropertythatreturnsareferencetotheWindowscollection.

expression.Windows

RemarksAfteryouhavesetareferencetotheWindowscollection,youcanuseitspropertiestoaccesseachoftheWindowobjectsthatitcontains.

NoteTheWindowscollectioncanbeusedonlytogetthecountoftheWindowobjectsthatitcontainsortoreturnareferencetoaWindowobject.ItcannotbeusedtoaddorremoveWindowobjects.

ExampleInthefollowingexample,theWindowspropertyisusedtoaccesstheCountpropertyoftheWindowscollectionanddisplaythevalueinamessagebox:

XDocument.UI.Alert("CountofWindows:"+Application.Windows.Count);

WindowStateProperty

Aread/writepropertyoftypeXdWindowStatethatreturnsorsetsthestateofthewindowrepresentedbytheWindowobject.

expression.WindowState

ShowAll

WSDLURLProperty

Aread-onlypropertythatreturnsastringvaluecontainingtheUniformResourceLocator(URL)oftheWebServicesDescriptionLanguage(WSDL)filefortheWebserviceassociatedwiththeWebServiceAdapterobject.

expression.WSDLURL

RemarksTheWSDLfileisanXMLdocumentthatdefinestheformatofmessagesanXMLWebserviceunderstands.TheservicedescriptionservesasanagreementthatdefinesthebehaviorofanXMLWebserviceandinstructspotentialclientsinhowtointeractwithit.ThebehaviorofanXMLWebserviceisdeterminedbymessagingpatternsthattheservicedefinesandsupports.ThesepatternsconceptuallydictatewhattheserviceconsumercanexpecttohappenwhenaproperlyformattedmessageissubmittedtotheXMLWebservice.

ExampleInthefollowingexample,theWSDLURLpropertyoftheWebServiceAdapterobjectisusedtodisplaytheURLoftheWSDLfilethatisusedfortheWebservice:

varobjWSAdapter;

objWSAdapter=XDocument.DataObjects("WebCityList").QueryAdapter;XDocument.UI.Alert("WSDLfileURL:"+objWSAdapter.WSDLURL

ShowAll

XDocumentProperty(DataDOMEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeDataDOMEventobjectduringadatavalidationevent.

expression.XDocument

RemarksAfteryouhavesetareferencetotheXDocumentobjectthattheXDocumentpropertyoftheDataDOMEventobjectreturns,youcanuseanyofthepropertiesandmethodsthatitprovides.

ExampleInthefollowingexample,theXDocumentpropertyoftheDataDOMEventobjectisusedtosetareferencetotheXDocumentobject:

varobjXDoc;

objXDoc=eventObj.XDocument;

XDocumentProperty(DocActionEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeDocActionEventobjectduringanOnClickevent.

RemarksAfteryouhavesetareferencetotheXDocumentobjectthattheXDocumentpropertyoftheDocActionEventobjectreturns,youcanuseanyofthepropertiesandmethodsthatitprovides.

ExampleInthefollowingexample,theXDocumentpropertyoftheDocActionEventobjectisusedtosetareferencetotheXDocumentobject:

varobjXDoc;

XDocumentProperty(DocContextChangeEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeDocContextChangeEventobjectinanOnContextChangeevent.

expressionRequired.ReturnsareferencetoaDocContextChangeEventobject.

XDocumentProperty(DocEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeDocEventobjectduringanOnSwitchVieworOnAfterChangeevent.

expressionRequired.ReturnsareferencetotheDocEventobject.

RemarksAfteryouhavesetareferencetotheXDocumentobjectthattheXDocumentpropertyoftheDocEventobjectreturns,youcanuseanyofthepropertiesandmethodsthatitprovides.

ExampleInthefollowingexample,theXDocumentpropertyoftheDocEventobjectisusedtosetareferencetotheXDocumentobject:

varobjXDoc;

XDocumentProperty(DocReturnEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeDocReturnEventobjectduringanOnLoadorOnSubmitRequestevent.

expressionRequired.ReturnsareferencetotheDocReturnEventobject.

RemarksAfteryouhavesetareferencetotheXDocumentobjectthattheXDocumentpropertyoftheDocReturnEventobjectreturns,youcanuseanyofthepropertiesandmethodsthatitprovides.

ExampleInthefollowingexample,theXDocumentpropertyoftheDocReturnEventobjectisusedtosetareferencetotheXDocumentobject:

varobjXDoc;

ShowAll

XDocumentProperty(HTMLTaskPaneExternalObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectassociatedwithacustomtaskpane.

expressionRequired.AnexpressionthatreturnsareferencetotheHTMLTaskPaneExternalobject.

RemarksTheXDocumentobjectreturnedbytheXDocumentpropertyrepresentstheform'sunderlyingXMLdocumentthatisassociatedwiththecustomtaskpane.

ExampleInthefollowingexample,theHTMLTaskPaneExternalobjectisusedthroughtheexternalpropertyoftheDynamicHTML(DHTML)windowobjecttosetareferencetotheXDocumentobjectthatispartoftheInfoPathobjectmodel:

varobjXDoc;

objXDoc=window.external.XDocument;objXDoc.View.SwitchView("View2");

XDocumentProperty(Index)

TheXDocumentpropertyreturnsareferencetoanXDocumentobject.ThispropertyisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelobjects.ClickanXDocumentpropertylinkbelowtoviewtheHelptopicforaspecificimplementationoftheXDocumentproperty.

XDocumentpropertyasitappliestotheDataDOMEventobject.

XDocumentpropertyasitappliestotheDocActionEventobject.

XDocumentpropertyasitappliestotheDocContextChangeEventobject.

XDocumentpropertyasitappliestotheDocEventobject.

XDocumentpropertyasitappliestotheDocReturnEventobject.

XDocumentpropertyasitappliestotheHTMLTaskPaneExternalobject.

XDocumentpropertyasitappliestotheMergeEventobject.

XDocumentpropertyasitappliestotheSaveEventobject.

XDocumentpropertyasitappliestotheVersionUpgradeEventobject.

XDocumentpropertyasitappliestotheWindowobject.

XDocumentProperty(InfoPathControlSiteObject)

RetrievesareferencetotheXDocumentobjectassociatedwiththeviewthatcontainsthecontrol.

expressionRequired.AnexpressionthatreturnsareferencetotheInfoPathControlobject.

XDocumentProperty(MergeEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeMergeEventobjectinanOnMergeRequestevent.

expressionRequired.ReturnsareferencetoaMergeEventobject.

XDocumentProperty(SignEventObject)

RetrievesareferencetotheXDocumentobjectassociatedwiththeOnSignevent.

expressionRequired.AnexpressionthatreturnsareferencetoaSignEventobject.

XDocumentProperty(VersionUpgradeEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeVersionUpgradeEventobjectduringanOnVersionUpgradeevent.

expressionRequired.ReturnsareferencetotheVersionUpgradeEventobject.

RemarksAfteryouhavesetareferencetotheXDocumentobjectthattheXDocumentpropertyoftheVersionUpgradeEventobjectreturns,youcanuseanyofthepropertiesandmethodsthatitprovides.

ExampleInthefollowingexample,theXDocumentpropertyoftheVersionUpgradeEventobjectisusedtosetareferencetotheXDocumentobject:

varobjXDoc;

ShowAll

XDocumentProperty(WindowObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththewindowthatisrepresentedbytheWindowobject.

RemarksTheXDocumentpropertycanbeusedonlywiththeeditingwindowtypes;ifusedwithadesigningwindowtype,itwillreturnanerror.Itwillalsoreturnanerrorifnoformisopenintheformarea.

ExampleInthefollowingexample,theXDocumentpropertyoftheWindowobjectisusedtosetareferencetotheform'sunderlyingXMLdocumentthatisassociatedwiththecurrentlyactivewindow:

varobjXDoc;

objXDoc=Application.ActiveWindow.XDocument;

XDocumentsProperty

Aread-onlypropertythatreturnsareferencetotheXDocumentscollection.

expression.XDocuments

RemarksAfteryouhavesetareferencetotheXDocumentscollection,youcanuseitspropertiestoaccesseachoftheXDocumentobjectsthatitcontains.

ExampleInthefollowingexample,theXDocumentspropertyisusedtoaccesstheCountpropertyoftheXDocumentscollectionanddisplaythevalueinamessagebox:

XDocument.UI.Alert("CountofXDocuments:"+Application.XDocuments

ShowAll

XPathProperty

Aread-onlypropertythatreturnstheXPathexpressionofaSignedDataBlockobject.

expression.XPath

ShowAll

XPathNamespaceDeclarationsProperty

Aread-onlypropertycontainingthenamespacedeclarationsfortheXPathexpressionreturnedbytheXPathpropertyofaSignedDataBlockobject.

expression.XPathNamespaceDeclarations

expressionRequired.AnexpressionthatreturnsareferencetoaSignedDataBlockobject

ActivateMethod

ActivatesthewindowthatisrepresentedbytheWindowobject.

expression.Activate()

RemarksTheActivatemethodcanbeusedonlywiththeeditingwindowtypes;ifusedwithadesigningwindowtype,itwillreturnanerror.

Todeterminewhetherawindowistheactivewindow,usetheActivepropertyoftheWindowobject.

ExampleInthefollowingexample,theActivatemethodoftheWindowobjectisusedtoactivateawindowthatisassociatedwiththeview.Notethecheckofthewindowtype.

varobjWindow;

//Setareferencetoaview'sassociatedwindow.objWindow=XDocument.View.Window;if(objWindow.Type==0){//Makethewindowtheactivewindow.objWindow.Activate();}

objWindow=null;

ShowAll

AddMethod

AddsanErrorobjecttotheErrorscollectionandreturnsareferencetothenewErrorobject.

expression.Add(ByValvarNodeAsVariant,ByValbstrConditionNameAsString,ByValbstrShortErrorMessageAsString,[ByValbstrDetailedErrorMessageAsString],[ByVallErrorCodeAsLong],[ByValbstrTypeAsString="modeless"])AsError

varNodeRequiredVariant.TheXMLnodethattheerrorwillbeassociatedwith.

bstrConditionNameRequiredString.Thenameoftheerror.

bstrShortErrorMessageRequiredString.Theshortmessagefortheerror.

bstrDetailedErrorMessageOptionalString.Thedetailedmessagefortheerror.

lErrorCodeOptionalLongInteger.Defaultvalueis0.Theerrorcodeoftheerror.

bstrTypeOptionalString.Defaultvalueis"modeless".Thetypeoferrorprocessing.Theothersupportedvalueis"modal".

returnsAreferencetothenewlycreatedErrorobject.

RemarksTheAddmethodisusedtocreatecustomerrormessagesinaMicrosoftOfficeInfoPath2003form.TherearetwotypesoferrorsthatcanbecreatedusingtheAddmethod:

modelessTheuserisnotifiedoftheerrorwithaninlinealertandcanchoosetoreturntothepreviousvaluewithanundooperation.

modalTheuserisnotifiedoftheerrorwithadialogboxalert.AfterclickingOKinthedialogboxalert,theerrorwillappearasaninlinealertandtheusercanchoosetoreturntothepreviousvaluewithanundooperation.

NoteCustomerrorscanalsobecreatedusingtheReportErrormethodoftheDataDOMEventobject.

ExampleInthefollowingexample,theAddmethodoftheErrorscollectionisusedtocreateacustomerrormessage:

varobjErrors;varobjError;

objErrors=XDocument.Errors;objError=objErrors.Add(MyXMLNode,"ValidationError","Thedataisinvalid.");

AlertMethod

DisplaysamessageboxwithacustomtextmessageinaMicrosoftOfficeInfoPath2003form.

expression.Alert(ByValbstrAlertStringAsString)

expressionRequired.AnexpressionthatreturnsareferencetotheUIobject.

bstrAlertStringRequiredString.Thetexttobedisplayed.

RemarksTheAlertmethoddisplaysasimplemessageboxthatusesaninformationiconandanOKbutton.Onlythetextinthemessageboxcanbecustomized.

NoteCarriagereturnscanbeinsertedintothetextofthecustommessagebyusingthestandard\ncharacters.

ExampleInthefollowingexample,theAlertmethodoftheUIobjectisusedtodisplayamessagebox:

XDocument.UI.Alert("Custommessagetextgoeshere.");

AvgMethod

ReturnsaVariantthatistheaveragevalueofallofthenumericalelementsinanodeset.

expression.Avg(ByValpxmllistInputAsIXMLDOMNodeList)AsVariant

expressionRequired.AnexpressionthatreturnsareferencetotheMathobject.

pxmllistInputRequiredIXMLDOMNodeList.Thenodesetthatcontainsthevaluestobeaveraged.

returnsAVariantthatrepresentstheaveragevalueofallthenumericalelementsinanodeset.

Security0:Canbeaccessedwithoutrestrictions.

ExampleInthefollowingexample,thevariableaverageAgeissettotheaveragevalueofallofthenumericalelementsinthemy:agesnodeset.

varages=XDocument.DOM.selectNodes("//my:ages");varaverageAge=XDocument.Util.Math.Avg(ages);

BuildSQLFromXMLNodesMethod

ReturnsastringcontaininganSQLcommandtextfragmentusingthespecifiedXMLnode.

expression.BuildSQLFromXMLNodes(ByRefpXmlNodeAsIXMLDOMNode)AsString

pXmlNodeRequiredObject.TheXMLnodetobeconvertedtoanSQLfragment.

returnsString.

RemarksThefragmentofSQLthattheBuildSQLFromXMLNodesmethodgeneratesisanSQLWHEREclauseintheformoffield=value.TheXMLnodethatyouuseforthepXmlNodeargumentshouldbeadescendantofthedfs:queryFieldsnode;whenyouhavetheSQLcommandtextfragment,youcanaddittotheexistingSQLcommandstringoftheADOAdapterobjectusingtheCommandproperty.

ExampleInthefollowingexample,theBuildSQLFromXMLNodesmethodoftheADOAdapterobjectisusedtocreateanSQLcommandtextfragmentbasedonaspecifiedXMLnode.ThisexampleisbasedonaformthatusestheOrderstableintheMicrosoftSQLServerNorthwindsampledatabase.

functionQueryGreaterThan(){varobjQueryFieldNode;varstrWhereClause;varstrOldCommand;varobjQueryFieldAttributes;varobjCurQueryFieldAttribute;

//BuildtheWHEREclausefromtheQueryFieldsintheform's//underlyingXMLDOM.objQueryFieldNode=XDocument.DOM.selectSingleNode("dfs:myFields/dfs:queryFields/q:Orders");strWhereClause=XDocument.QueryAdapter.BuildSQLFromXMLNodes(objQueryFieldNode);

//Replacethe'='signswith'>=',andappendtheclauseto//theSQLcommandtext.strWhereClause=strWhereClause.replace(/=/,">=");strOldCommand=XDocument.QueryAdapter.Command;if(strWhereClause!=""){XDocument.QueryAdapter.Command=strOldCommand+"where"+strWhereClause;}

//CleartheQueryFieldssotheWHEREclauseisn't//automaticallygenerated.objQueryFieldAttributes=objQueryFieldNode.attributes;while(objCurQueryFieldAttribute=objQueryFieldAttributes.nextNode()){objCurQueryFieldAttribute.text="";}//Performthequery.try{XDocument.Query();}catch(e){XDocument.UI.Alert("Failedtoquery.\n\n"+e.message);}//Resetthecommandsothatsubsequentqueriesarebasedon//thecorrectSQLcommandtextstring.XDocument.QueryAdapter.Command=strOldCommand;

//Cleanup.objQueryFieldNode=null;strWhereClause=null;strOldCommand=null;objQueryFieldAttributes=null;objCurQueryFieldAttribute=null;

ShowAll

CacheSolutionMethod(ApplicationObject)

Examinestheformtemplateinthecacheand,ifnecessary,updatesitfromthepublishedlocationoftheformtemplate.

expression.CacheSolution(ByValbstrSolutionURIAsString)

bstrSolutionURIRequiredString.ThestringthatspecifiestheUniformResourceIdentifier(URI)oftheformtemplate.Thisparametercanbespecifiedasaformdefinition(.xsf)fileoraformtemplate(.xsn)file.

RemarksIftheformtemplatethatcurrentlyexistsinthecachematchestheformtemplatefromthepublishedlocation,nocachingtakesplace.Ifthecomputerisofflineandtheformisalreadyinthecache,thecacheiskeptandnoupdatewilloccur.

ExampleInthefollowingVisualBasicforApplications(VBA)example,theCacheSolutionmethodoftheApplicationobjectisusedtocacheaformtemplate:

PublicSubCacheFormTemplate()

DimIAsIntegerDimobjAppAsObjectDimaryForms(2)AsString

'CreateareferencetotheApplicationobject.SetobjApp=CreateObject("InfoPath.Application")

'Populatethearraywithformtemplatelocations.aryForms(0)="\\MyServer\MyForms\MyForm.xsn"aryForms(1)="\\MyServer\MyForms\manifest.xsf"

'Loopthroughthearrayandcachetheformtemplates.ForI=0ToUBound(aryForms)-1objApp.CacheSolution(aryForms(I))NextI

EndSub

ShowAll

CacheSolutionMethod(ExternalApplicationObject)

Examinestheformtemplateinthecacheand,ifnecessary,updatesitfromthepublishedlocationoftheformtemplate.

expression.CacheSolution(ByValbstrSolutionURIAsString)

expressionRequired.AnexpressionthatreturnsareferencetotheExternalApplicationobject.

bstrSolutionURIRequiredString.ThestringvaluethatspecifiestheUniformResourceIdentifier(URI)oftheformtemplate.Thisparametercanbespecifiedasaformdefinition(.xsf)fileoraformtemplate(.xsn)file

RemarksIftheformtemplatethatcurrentlyexistsinthecachematchestheformtemplatefromthepublishedlocation,nocachingtakesplace.Ifthecomputerisofflineandtheformisalreadyinthecache,thecacheiskeptandnoupdatewilloccur.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theCacheSolutionmethodoftheExternalApplicationobjectisusedtocacheaformtemplate:

PublicSubCacheFormTemplate()

DimIAsIntegerDimobjExternalAppAsObjectDimaryForms(2)AsString

'CreateareferencetotheExternalApplicationobject.SetobjExternalApp=CreateObject("InfoPath.ExternalApplication")

'Populatethearraywithformtemplatelocations.aryForms(0)="\\MyServer\MyForms\MyForm.xsn"aryForms(1)="\\MyServer\MyForms\manifest.xsf"

'Loopthroughthearrayandcachetheformtemplates.ForI=0ToUBound(aryForms)-1objExternalApp.CacheSolution(aryForms(I))NextI

EndSub

ShowAll

CacheSolutionMethod(Index)

TheCacheSolutionmethodexaminestheformtemplateinthecacheand,ifnecessary,updatesitfromthepublishedlocationoftheformtemplate.ThismethodisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickaCacheSolutionmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheCacheSolutionmethod.

CacheSolutionmethodasitappliestotheApplicationobject.

CacheSolutionmethodasitappliestotheExternalApplicationobject.

ShowAll

CloseMethod(ExternalApplicationObject)

ClosesthespecifiedMicrosoftOfficeInfoPath2003form.

expression.Close(ByValbstrDocumentURIAsString)

bstrDocumentURIRequiredString.ThestringvaluethatspecifiestheUniformResourceIdentifier(URI)ofaform.

RemarksTheClosemethodclosesthecurrentlyopenformwithoutquittingtheInfoPathapplication.WhenusingtheClosemethod,theformisclosedunconditionally,meaningthatanychangesmadetothedataintheformarenotsaved.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theClosemethodoftheExternalApplicationobjectisusedtoclosethecurrentlyopenform:

PublicSubAutomateInfoPathForm()

DimobjIPAsObject

'CreateareferencetotheExternalApplicationobject.SetobjIP=CreateObject("InfoPath.ExternalApplication")

'OpenanInfoPathform.objIP.Open("C:\MyForms\Form1.xml")MsgBox("TheInfoPathformhasbeenopened.")

'ClosetheInfoPathform.objIP.Close("C:\MyForms\Form1.xml")MsgBox("TheInfoPathformhasbeenclosed.")

'QuittheInfoPathapplication.objIP.QuitMsgBox("TheInfoPathapplicationhasbeenclosed.")

SetobjIP=Nothing

EndSub

CloseMethod(Index)

TheClosemethodclosestheitemassociatedwiththespecifiedcollectionorobject.ThismethodisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollectionsandobjects.ClickaClosemethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheClosemethod.

ClosemethodasitappliestotheExternalApplicationobject.

ClosemethodasitappliestotheWindowobject.

ClosemethodasitappliestotheXDocumentscollection.

ShowAll

CloseMethod(WindowObject)

ClosesthewindowthatisrepresentedbytheWindowobject.

expression.Close([ByValbForceAsBoolean])

bForceOptionalBoolean.DefaultvalueisFalse.Determineswhetheropendocumentswillbesaved.

RemarksTheClosemethodwillclosetheassociatedwindowandtheformsthatitcontains.IfthebForceparameterissettoTrue,allformswillbeclosedwithoutsaving,eveniftheycontainchangessincetheywerelastsaved.IfsettoFalse,userswillbepromptedtosavetheirchanges.

TheClosemethodcanbeusedonlywiththeeditingwindowtypes;ifusedwithadesigningwindowtype,itwillreturnanerror.Inaddition,theClosemethodcanonlybeusedwiththeOnSubmitRequestandOnClickeventhandlers.Ifusedwithanyothertypeofeventhandler,itwillreturnanerror.

NoteIfthewindowbeingclosedistheonlywindowopeninMicrosoftOfficeInfoPath2003,theInfoPathapplicationwillalsobeclosed.

ExampleInthefollowingexample,theClosemethodoftheWindowobjectisusedtoclosethecurrentlyactivewindow,forcingasaveifchangesintheformhaveoccurred:

Application.ActiveWindow.Close(false);

ShowAll

CloseMethod(XDocumentsCollection)

ClosesthespecifiedMicrosoftOfficeInfoPath2003form.

expression.Close(ByValvarIndexAsVariant)

varIndexRequiredVariant.ThestringvaluethatspecifiestheUniformResourceIdentifier(URI)ofaform,alongintegervaluethatspecifiesthepositionalindexofanXDocumentobjectwithintheXDocumentscollection,orareferencetoanXDocumentobject.

RemarksTheClosemethodclosesthecurrentlyopenformwithoutquittingtheInfoPathapplication.Theformisclosedunconditionally,meaningthatanychangesmadetothedataintheformarenotsaved.

ExampleInthefollowingexample,theClosemethodoftheXDocumentscollectionisusedtoclosethecurrentlyopenformusingthepositionalindexofanXDocumentobjectcontainedinthecollection:

Application.XDocuments.Close(0);

Alternatively,youcanpassareferencetoanXDocumentobject:

varobjXDoc;

objXDoc=Application.XDocuments(0);Application.XDocuments.Close(objXDoc);

ConfirmMethod

Displaysamessageboxwithbuttonsforinputfromauser.ThevaluethatisreturnedisoneoftheXdConfirmChoiceenumeratedconstants.

expression.Confirm(promptAsString,buttonsAsXdConfirmButtons)AsXdConfirmChoice

expressionRequired.AnexpressionthatreturnsareferencetotheUIobject

bstrPromptRequiredString.Thetextmessagetobedisplayed.

lButtonsRequiredXdConfirmButtons.Specifiesthenumberandtypeofbuttonstodisplay.YoumayspecifyanyofthevaluesoftheXdConfirmButtonsenumeration.

Security2:Canbeaccessedonlybyformsrunninginthesamedomainasthecurrentlyopenform,orbyformsthathavebeengrantedcross-domainpermissions.

Remarks

ExampleInthefollowingexample,theConfirmmethodoftheUIobjectisusedtodisplayadialogboxwithYesandNobuttons:

XDocument.UI.Confirm("Doyouwishtocontinue?",4);

CreateMethod

CreatesanewSignatureobject.ThismethodcanbecalledonlyfromtheOnSigneventhandler.

expression.Create()

expressionRequired.AnexpressionthatreturnsaSignaturescollection.

RemarksThedigitalsignatureinnotactuallywrittentothefileuntiltheSignmethodiscalledforthenewlycreatedSignatureobject.

ShowAll

CreateDOMMethod

CreatesanewinstanceoftheXMLDocumentObjectModel(DOM)inmemory.

expression.CreateDOM()AsXMLDOMDocument

returnsAreferencetotheXMLDOM.

RemarksUsingtheCreateDOMmethodtocreateaninstanceoftheXMLDOMisequivalenttousingthefollowingmethodofcreatingaMicrosoftXMLCoreServices(MSXML)5.0DOMDocumentobject:

varobjDoc=newActiveXObject("Msxml2.DOMDocument.5.0");NoteThisobjectmodelmemberisnotsupportedwhentheDisableServicePackfeaturesoptionontheAdvancedtaboftheOptionsdialogboxinInfoPathisselectedorwhenMicrosoftOffice2003ServicePack1orlaterisnotinstalled.AnyformthatimplementsthisobjectmodelmemberinitscodewillgenerateanerrormessageifitisopenedinInfoPathwhenservicepackfeaturesaredisabledorunavailable.

ExampleInthefollowingexample,theCreateDOMmethodoftheXDocumentobjectisusedtocreateaninstanceofXMLDOMandassignittoavariable.

varobjDOM=XDocument.CreateDOM();

ShowAll

DeleteMethod

DeletesthespecifiedErrorobjectfromtheErrorscollection.

expression.Delete(ByValvarNodeAsVariant,ByValbstrConditionNameAsString)

varNodeRequiredVariant.TheXMLDocumentObjectModel(DOM)nodeassociatedwiththeerror.

bstrConditionNameRequiredString.Thenameoftheerror.

RemarksTheDeletemethoddeletesalltheErrorobjectsintheErrorscollectionthatareassociatedwiththespecifiedXMLnodeandthathavethesamename.TodeletealloftheErrorobjectscontainedintheErrorscollection,usetheDeleteAllmethod.

NoteTheDeletemethodwillonlydeleteerrorsthatwerecreatedusingtheAddmethodoftheErrorscollection.Itcannotbeusedtodeleteerrorsthatoccurbecauseofschemaordatavalidationconstraints,orerrorsthatwerecreatedusingtheReportErrormethodoftheDataDOMEventobject.

ExampleInthefollowingexample,theDeletemethodoftheErrorscollectionisusedtodeletealltheerrorsbasedontheirassociatedXMLnodeandname:

XDocument.Errors.Delete(MyXMLNode,"ValidationError");

DeleteAllMethod

DeletesalloftheErrorobjectscontainedintheErrorscollection.

expression.DeleteAll()

RemarksTodeleteaspecificErrorobjectfromtheErrorscollection,usetheDeletemethod.

NoteUnliketheDeletemethodthatwillonlydeleteerrorsthatwerecreatedusingtheAddmethodoftheErrorscollection,theDeleteAllmethodwilldeleteallerrorsintheErrorscollection,regardlessofhowtheywerecreated.

ExampleInthefollowingexample,theDeleteAllmethodoftheErrorscollectionisusedtodeletealltheerrorsthatitcontains:

XDocument.Errors.DeleteAll();

DisableAutoUpdateMethod

Disablesautomaticsynchronizationbetweenaform'sunderlyingXMLdocumentandtheassociatedViewobject.

expression.DisableAutoUpdate()

RemarksTheviewsinaMicrosoftOfficeInfoPath2003formareautomaticallysynchronizedwiththedatathatiscontainedinaform'sunderlyingXMLdocument.YoucanoverridethisbyusingtheDisableAutoUpdatemethod.Youmayneedtodothisforperformancereasons,suchaswhenyouareprogramaticallymakingmanychangestoaform'sunderlyingXMLdocumentandyoudonotwanttheviewtoberefresheduntilthechangesarecomplete.

AutomaticsynchronizationcanbeenabledusingtheEnableAutoUpdatemethodoftheViewobject.

ExampleInthefollowingexample,theDisableAutoUpdatemethodoftheViewobjectisusedtodisablesynchronizationbetweenaform'sunderlyingXMLdocumentandtheviewthatitisassociatedwith:

XDocument.View.DisableAutoUpdate();

EnableMethod

DefinesamethodthatmustbeprovidedbythedeveloperforInfoPathtocallwhenitneedstoenableordisableaninstanceofthecontrolinaview.

expression.Enable(vfEnabledAsBoolean)

vfEnabledRequired.ABooleanvaluethatspecifieswhetherthecontrolisenabled.

RemarksInfoPathwillcalltheEnablemethodtoenableordisablethecontrol,suchaswhentheviewisbeingrefreshedorclosed,whenthedocumentissignedandshouldnotbeedited,orwhenrulesareappliedtotheformthatmustdisablethecontrol.

EnableAutoUpdateMethod

Enablesautomaticsynchronizationbetweenaform'sunderlyingXMLdocumentandtheassociatedViewobject.

expression.EnableAutoUpdate()

RemarksTheviewsinaMicrosoftOfficeInfoPath2003formareautomaticallysynchronizedwiththedatathatiscontainedinaform'sunderlyingXMLdocument.However,thiscanbeoverriddenusingtheDisableAutoUpdatemethod.Tore-enablesynchronization,usetheEnableAutoUpdatemethod.

ExampleInthefollowingexample,theEnableAutoUpdatemethodoftheViewobjectisusedtoenablesynchronizationbetweenaform'sunderlyingXMLdocumentandtheviewthatitisassociatedwith:

XDocument.View.EnableAutoUpdate();

EvalMethod

ReturnsaVariantcontainingthesetofresultscalculatedwhentheexpressionisappliedtoeachsetofelementsinthecontext.

expression.Eval(ByValnodeListAsIXMLDOMNodeList,ByValbstrExpressionasString)AsVariant

nodeListRequiredIXMLDOMNodeList.Thenodethatsetsthecontextfortheexpression.

bstrExpressionRequiredString.Theexpressiontobeappliedtoeachsetofnodesinthespecifiedcontext.

ExampleInthefollowingexample,thevariablemaxCostissettothelargestcostvalue,wherecostiscalculatedbymultiplyingpricebyquantity.

varnodes=XDocument.DOM.selectNodes("/my:items/my:item");varmaxCost=XDocument.Util.Math.Max(XDocument.Util.Math.Eval

ShowAll

ExecuteActionMethod

ExecutesaMicrosoftOfficeInfoPath2003editingcommandagainstaform'sunderlyingXMLdocument,basedonthedataselectedintheviewthatisassociatedwiththeViewobject.

expression.ExecuteAction(ByValbstrActionAsString,[ByValvarXmlToEditAsVariant])

bstrActionRequiredString.Thenameoftheeditingactiontoperform.

varXmlToEditOptionalVariant.Thenameofthefieldorgrouptowhichtoapplytheeditingaction.ThisisequivalenttothevalueofthenameattributeinthexmlToEditelementoftheformdefinition(.xsf)file.

RemarksTheExecuteActionmethodisusedtoprogrammaticallyperformbuilt-inInfoPatheditingactionsagainstaform'sunderlyingXMLdocument,basedontheselectedcontextinaview.

Theactionthatisexecutedwillbethesameactionthatwouldbeusedwhenclickingonanequivalentmenuortoolbarbutton;namelyoneforwhichthebuttonelementinthe.xsffilehascorrespondingxmlToEditandactionattributes.Aswithusingabutton,theactionwillbebasedoncurrentselection:itwillactontheselectedcontext(andinthecasewheretheselectionwouldleadthebuttontobedisabled,thentheExecuteActionmethodwillhavenoeffect).

NoteItispossiblewithscriptingcodetofirstsettheselectioncontextbyusingtheSelectNodesorSelectTextmethodsoftheViewobject,thencallingtheExecuteActionmethodtoactonthatcontext.

TheExecuteActionmethodwillreturnanerrorforthefollowingreasons:

ThebstrActionparameterdoesnotcontainavalideditingcomponentname.

ThevarXmlToEditparameterdoesnotmatchaneditingcomponentthatisdefinedintheview.

ThevarXmlToEditparameterisrequiredforaspecificeditingaction.

Theeditingactionisnotapplicabletotheselectedcontext.

Validparametercombinations

NoteInsomecases,callingtheExecuteActionmethodfromtheOnClickeventforabuttoninaviewmaycauseanerror.Thisisbecausetheselectedcontextchangestothebuttonwhenthebuttonisclicked.Inthiscase,itisbettertouseabutton(orlink)onacustomtaskpane,toolbar,ormenutocalltheExecuteActionmethod.

ExampleInthefollowingexample,theExecuteActionmethodoftheViewobjectisusedtodeleteselecteddataandplaceitontheclipboard:

XDocument.View.ExecuteAction("Cut");

Inthefollowingexample,theExecuteActionmethodoftheViewobjectisusedtoinsertdatausingthexCollectioneditingcomponent,basedontheselectedcontext:

XDocument.View.ExecuteAction("xCollection::insert","group1_1");

ExportMethod

Exportstheviewtoafileofthespecifiedformat.

expression.Export(ByValbstrURLAsString,ByValbstrFormatAsString)

bstrURLRequiredString.Thedirectorylocationthattheexportedviewfilewillbewrittento.

bstrFormatRequiredString.Thetypeoffileformattoexportto.Onlythe"MHT"valueissupported.

RemarksIfusedinaformthatisnotfullytrusted,theExportmethodwillreturna"permissiondenied"error.

ExampleInthefollowingexample,theExportmethodoftheViewobjectisusedtoexportthecurrentview:

XDocument.View.Export("C:\\MyView","MHT");

ShowAll

ForceUpdateMethod

Forcessynchronizationbetweenaform'sunderlyingXMLdocumentandtheassociatedViewobject.

expression.ForceUpdate()

RemarksTheviewsinaMicrosoftOfficeInfoPath2003formareautomaticallysynchronizedwiththedatathatiscontainedinaform'sunderlyingXMLdocument.However,youcanforcesynchronizationtooccurusingtheForceUpdatemethod.Thisisalsousefulwhendatainasecondarydatasourcehaschangedandneedstoberefreshedintheview.

AutomaticsynchronizationcanbedisabledusingtheDisableAutoUpdatemethodandenabledusingtheEnableAutoUpdatemethod.

ExampleInthefollowingexample,theForceUpdatemethodoftheViewobjectisusedtoforcesynchronizationbetweenaform'sunderlyingXMLdocumentandtheviewthatitisassociatedwith:

ShowAll

FormatStringMethod

FormatsthespecifiedstringorXMLnodeaccordingtothespecifiedcategoryandoptionsparameters.

expression.FormatString(ByValvarInput,ByValbstrCategoryAsString,ByValbstrOptionsAsString)AsString

varInputRequiredStringorXMLnode.ThestringvalueorXMLnodetobeformatted.

bstrCategoryRequiredString.Thestringvaluethatspecifiesthecategoryusedforformatting.Valuesincludenumber,percentage,currency,date,time,anddatetime.

bstrOptionsRequiredString.Thestringvaluethatspecifiestheoptionsusedforformatting.Takestheformofacase-sensitivestringintheformat"optionName:value".

returnsString.

RemarksTheFormatStringmethodcanbeusedanywhereinyourscriptingcodeinwhichyouneedtochangetheformatofaspecifiedstring.ItmustbequalifiedwiththeApplicationobjectname,anditsreturnvaluemustbeassignedtoavariableorusedasanexpressionthatrequiresastringvalue.

ThefollowingsectionslistthevaluesthatmaybeusedforthebstrCategoryandbstrOptionsparameters:

Listofcategories

Listofoptions

ExampleInthefollowingexample,theFormatStringmethodoftheApplicationobjectisusedtoformatthespecifieddatestringintoalongdateformat:

Application.FormatString("2003-01-08","date","dateFormat:LongDate");

ShowAll

GenerateDataSetDiffGramMethod

ReturnsanXMLDataSet,containinganinlineschemadescribingthedataandtheDataSet'sDiffGram.

expression.GenerateDataSetDiffGram(ByValpNodeAsIXMLDocumentObject)AsIXMLDocumentObject

pNodeRequiredIXMLDocumentObject.AnXMLDocumentObjectModel(DOM)nodethatcontainstheXMLdataoftheDataSetwhoseDiffGramwillbecreated.

RemarksTheDiffGramfortheinputpNodeisgeneratedusingthesiblingnodeoriginalDatatocomputethedifferencebetweentheoriginalDataandtheinputpNode.

ShowAll

GetContextNodesMethod

ReturnsareferencetoanXMLNodescollectionthatispopulatedwithXMLDocumentObjectModel(DOM)nodesbasedonthecurrentcontext.ItconsistsofthesequenceofXMLDOMnodesthataremappedfromtheview,correspondingtothecurrentXSLTransformation(XSLT)node,startingatthecurrentselectionandwalkingupthroughtheviewancestorstotheBODYtag.expression.GetContextNodes([ByValvarNodeAsVariant],[ByValvarViewContextAsVariant])AsXMLNodes

varNodeOptionalVariant.AnXMLDOMnode.

varViewContextOptionalVariant.TheIDofthecontrolthatisusedforthecontext.

returnsAreferencetotheXMLNodescollection.

RemarksIfnoparametersareused,thecontextnodesarebasedonthecurrentselection.Ifparametersareused,thenthecontextnodesreturnedarethosethatwouldbereturnedbasedontheselectionthatwouldbeobtainedfromcallingtheSelectNodesmethodoftheViewobject.

ExampleInthefollowingpartialexamplefromtheStructuralEditingdevelopersampleform,theGetContextNodesmethodoftheViewobjectisusedtoreturnacollectionofXMLDOMnodesbasedonthecurrentcontext.ThenthecodeloopsthroughthecollectionofXMLDOMnodeslookingforaparticularnode.Whenitisfound,thecodecallsthecustomApplyDiscountToItemfunctiontoupdatethedatathatthenodecontains.

objContextNodes=XDocument.View.GetContextNodes();

//Scanthelistofcontextnodesforanitemnodeandifoneisfound//applythediscounttoit.for(vari=0;i<objContextNodes.Count;i++){if(objContextNodes.item(i).nodeName=="item"){ApplyDiscountToItem(objContextNodes.item(i),intPercentage);blnAppliedDiscount=true;break;}}

ShowAll

GetDataVariableMethod

Returnsastringcontainingthevalueofthespecifiedvariable,whichisapredefinedvariablestoredasaprocessinginstructionattributeintheform'sunderlyingXMLdocument.

expression.GetDataVariable(ByVallVariableNumberAsLong)AsString

lVariableNumberRequiredLong.Thenumberofthevariable.

returnsString.

RemarksIfthevariableisnotdefinedorisempty,theGetDataVariablemethodwillreturnanemptystring.Tosetavariable,usetheSetDataVariablemethodoftheXDocumentobject.

NoteInfoPathonlysupportsusingtheinitialViewvariable,whichisthevariableusedtospecifytheinitialviewdisplayedwhenaformisopened.Thenumberofthisvariableisalways1,anditsvaluemustbethenameofaviewwithintheform.

ExampleInthefollowingexample,theGetDataVariablemethodoftheXDocumentobjectisusedtoreturnthevalueofthefirstvariable:

varstrVariable1;strVariable1=XDocument.GetDataVariable(1);

ShowAll

GetDOMMethod

ReturnsareferencetotheXMLDocumentObjectModel(DOM)ofthespecifiedDataObjectobjectassociatedwiththeXDocumentobject.

expression.GetDOM(ByValbstrNameAsString)AsXMLDOMDocument

bstrNameRequiredString.ThenameofaDataObjectobject.

returnsAreferencetoanXMLDOMdocumentobject.

RemarksAfteryouhaveareferencetotheXMLDOMthattheGetDOMmethodreturns,youcanuseanyofthepropertiesandmethodsthattheXMLDOMsupportstomanipulatethedatathattheDOMcontains.

NoteFormoreinformationabouttheXMLDOM,seetheMSXML5.0SDKdocumentationintheMicrosoftScriptEditor(MSE)Helpsystem.

ExampleInthefollowingexample,theGetDOMmethodoftheXDocumentobjectisusedtosetareferencetotheXMLDOMthatitreturns,whichinthiscaseistheDataObjectobjectnamedCityDropDownList:

varobjXml;

objXml=XDocument.GetDOM("CityDropDownList");

GetNamedNodePropertyMethod

ReturnsthevalueofanamedpropertyforthespecifiedXMLnode,whichmustbeanonattributenodeinthemaindatasource.

expression.GetNamedNodeProperty(ByValvarMainDOMNodeAsVariant,ByValbstrPropertyNameAsString,ByValbstrDefaultValueAsString)AsString

varMainDOMNodeRequiredVariant.AnXMLnodecorrespondingtoanonattributenodeinthemaindatasource,forwhichanamedpropertyistobeset.

bstrPropertyNameRequiredString.Specifiesthenameofthepropertywhosevalueistobereturned.

bstrDefaultValueRequiredString.Specifiesthedefaultvaluetobereturnedifthepropertyhasnotbeenset.

returnsAstringcorrespondingtothecurrentvalueofthenamedpropertyforthespecifiedXMLnodeinthemaindatasource.IfthespecifiedpropertyhasnotbeensetforthisXMLnode,thespecifieddefaultstringisreturned.

RemarksNamedpropertiesallowuserstoassociatestringswithuser-definedpropertiesofXMLelementnodesinthemaindatasource.ThevalueofanamedpropertycanbesetbyusingtheSetNamedNodePropertymethod.UsetheGetNamedNodePropertymethodtoreadthevalueofanamedproperty.

ExampleThefollowingexampledemonstratessettingandgettingthevalueofanamedproperty(withthename"cost")ofanXMLnode(called"item"):

varobjXMLNode=XDocument.DOM.selectSingleNode("/items/item");

varstrTest=XDocument.GetNamedNodeProperty(objXMLNode,'cost','Valuenotset');

//Thevalueofthe"cost"namedpropertyissetto100.XDocument.SetNamedNodeProperty(objXMLNode,'cost','100');

strTest=XDocument.GetNamedNodeProperty(objXMLNode,'cost','Valuenotset');

InthefollowingXSLexample,the"cost"namedpropertyoftheitemnodeisdisplayed:

<xsl:value-ofselect="xdXDocument:GetNamedNodeProperty(item,'cost','empty')"/>

ShowAll

GetSelectedNodesMethod

ReturnsareferencetoanXMLNodescollectionthatispopulatedwithXMLDocumentObjectModel(DOM)nodesbasedonthecurrentselectionofitemsinaview.

expression.GetSelectedNodes()AsXMLNodes

returnsAreferencetotheXMLNodescollection.

RemarksIfnoitemsareselectedinaview,orifonlytextisselected,thentheGetSelectedNodesmethodreturnsanemptycollection.

ExampleInthefollowingexample,theGetSelectedNodesmethodoftheViewobjectisusedtosetareferencetoacollectionofXMLDOMnodesbasedonwhatiscurrentlyselectedintheview.Thenthecodedetermineswhethernodeswerereturnedand,iftheywere,displaysinformationaboutthefirstnodefoundintheXMLNodescollectioninamessagebox.

if(objXMLNodes.Count>0){XDocument.UI.Alert(objXMLNodes(0).nodeName+"\n\n"+objXMLNodes(0).text);}

ImportDOMMethod

ImportsthespecifiedXMLdataintothecurrentform.

expression.ImportDOM(ByValpxDocAsIXMLDocumentObject)

pxDocRequiredIXMLDocument.TheXMLdatathatistobeimported(merged)intothecurrentlyopenform.

RemarksUsingtheobjectmodeltoimportaformprogrammaticallyisequivalenttoperformingamergeoperationusingtheMergeFormscommandontheFilemenuinInfoPath.

ExampleInthefollowingexample,theImportDOMmethodoftheXDocumentobjectisusedtoimportaformfromtheOnMergeRequesteventhandler:

XDocument::OnMergeRequest(eventObj){XDocument.ImportDOM(eventObj.DOM);eventObj.ReturnStatus=true;}

ShowAll

ImportFileMethod

Importsthespecifiedformintothecurrentform.

expression.ImportFile(ByValbstrFileURIAsString)

bstrFileURIRequiredString.TheUniformResourceIdentifier(URI)oftheformthatistobeimported(merged)intothecurrentlyopenform.

RemarksUsingtheobjectmodeltoprogrammaticallyimportaformisequivalenttoperformingamergeoperationintheuserinterface.

ExampleInthefollowingexample,theImportFilemethodoftheXDocumentobjectisusedtoimportaform:

XDocument.ImportFile("C:\SomeOtherForm.xml");

InitMethod

DefinesamethodthatmustbeprovidedbythedevelopertoperformanyinitializationroutinesrequiredwhenaninstanceofthecontrolisaddedtoanInfoPathform.

expression.Init(pControlSiteAsInfoPathControlSite)

pControlSiteRequired.AninstanceoftheInfoPathControlSiteobject.

RemarksInfoPathcallstheInitmethodwhenauseraddsaninstanceofthecontroltoaview.InfoPathpassesaninstanceoftheInfoPathControlSiteobjecttotheInitmethodwhenthecontrolisinitialized.TheInfoPathControlSiteobjectprovidestheNodepropertythatprovidesaccesstotheXMLDOMnodetowhichthecontrolisbound,andtheXDocumentpropertyforaccessingtheXDocumentobjectassociatedwithaform,whichinturnprovidesaccesstothefullInfoPathobjectmodel.

ShowAll

IsCurrentUserMethod

ReturnsTrueifthecurrentusermatchesthespecifiedusername.

expression.IsCurrentUser(ByValbstrUsernameAsString)AsBoolean

expressionRequired.AnexpressionthatreturnsareferencetotheUserobject.

bstrUsernameRequiredString.Theusernameintheformatof"domain\username."

returnsABooleanvalueindicatingwhetherthespecifiedusernamematchesthenameofthecurrentuser.

RemarksEventhoughtheIsCurrentUsermethodismarkedassecuritylevel0,itisnotalwaysaccessible.WhenacallismadetotheIsCurrentUsermethod,InfoPathfirstperformsasecuritychecktodetermineifaccesstothismethodisallowed.Thesecuritycheckconfirmswhetherthecallingcodeistrustedornotanditdeterminesthelocationofthecallingcode.

Ifthecallingcodeistrusted(asitiswhen,forexample,theIsCurrentUsermethodiscalledfromaninstalledorsignedInfoPathformtemplate,orfromtrustedexternalcode,suchasanexecutablefileonthelocalcomputer),InfoPathwillallowfullaccesstotheIsCurrentUsermethod.

Ifthecallingcodeisnottrusted(asinthecircumstanceofacallcomingfromadomain-basedInfoPathformtemplateorfromscriptexecutinginMicrosoftInternetExplorer),InfoPathfirstcheckswherethecallisbeingmadefrom.IfthecallisfromcodethatisnottrustedinanInfoPathformtemplateataURLsuchas"http://www.contoso.com/example.xsn",thenthecallisfromtheInternetzone.InfoPathdeniesaccesstotheIsCurrentUsermethodforallcallsthatarenottrustedcomingfromtheInternetzone.IfthecallisfromaURLsuchas"http://contoso/example.xsn",thenthecallisfromtheIntranetzone.ForacallthatisnottrustedfromtheIntranetzone,InfoPathcheckswhethertheInternetExploreruserauthenticationsettingsallowautomaticlogon(intheIntranetzoneonlyorforeverylogon).IfInternetExplorerisconfiguredforautomaticlogon,thenInfoPathallowsfullaccesstotheIsCurrentUsermethod.Otherwise,accesstotheIsCurrentUsermethodisdenied.

ExampleInthefollowingexample,theIsCurrentUsermethodoftheUserobjectisusedtodetermineifthecurrentuserequals"UserDomain\NancyDavilio".

varfUserMatched;fUserMatched=Application.User.IsCurrentUser("UserDomain\NancyDavolio")

ShowAll

IsDestinationReachableMethod

ReturnsaBooleanvalueindicatingwhetherthespecifiedUniformResourceLocator(URL),universalnamingconvention(UNC)path,orIPaddressofthedestinationcomputercanbeconnectedtofromtheclientcomputer.

expression.IsDestinationReachable(ByValbstrDestinationAsString,[ByValbstrBehaviorAsString)AsBoolean

bstrDestinationRequiredString.Specifiesthelocationtocheckfornetworkconnectivity.IPaddresses,aUNCpaths,oraURLsareacceptablevalues.

returnsABooleanvalueindicatingwhetherthedestinationisreachable.Trueifthespecifieddestinationcanbeconnectedto;otherwise,False.

NoteIfanIPaddressisspecified,thesecuritylevelforthismethodbecomeslevel3.ItisnotpossibletodeterminethedomainfromtheIPaddress,thereforethecallermusthavethefulltrustpermission.

RemarksForUNCandURLstrings,validvaluesarethoseincludingonlytheservername,forexamplehttp://MyServeror\\MyServer.Valuessuchashttp://MyServer/MyVirtualDirectoryor\\MyServer\MySharearenotconsideredvalid.

ShowAll

IsUserMemberOfMethod

ReturnsaBooleanvaluethatindicateswhetherthecurrentuserisamemberofthespecifiedgroup.

expression.IsUserMemberOf(ByValbstrGroupnameAsString)AsBoolean

expressionRequired.AnexpressionthatreturnsareferencetotheUserobject.

bstrGroupnameRequiredString.Thegroupnameintheformatof"domain\groupname."

RemarksEventhoughtheIsUserMemberOfmethodismarkedassecuritylevel0,itisnotalwaysaccessible.WhenacallismadetotheIsUserMemberOfmethod,InfoPathfirstperformsasecuritychecktodetermineifaccesstothismethodisallowed.Thesecuritycheckconfirmswhetherthecallingcodeistrustedornotanditdeterminesthelocationofthecallingcode.

Ifthecallingcodeistrusted(asitiswhen,forexample,theIsUserMemberOfmethodiscalledfromaninstalledorsignedInfoPathformtemplate,orfromtrustedexternalcode,suchasanexecutablefileonthelocalcomputer),InfoPathwillallowfullaccesstotheIsUserMemberOfmethod.

Ifthecallingcodeisnottrusted(asinthecircumstanceofacallcomingfromadomain-basedInfoPathformtemplateorfromscriptexecutinginMicrosoftInternetExplorer),InfoPathfirstcheckswherethecallisbeingmadefrom.IfthecallisfromcodethatisnottrustedinanInfoPathformtemplateataURLsuchas"http://www.contoso.com/example.xsn",thenthecallisfromtheInternetzone.InfoPathwilldenyaccesstotheIsUserMemberOfmethodforallcallsthatarenottrustedcomingfromtheInternetzone.IfthecallisfromaURLsuchas"http://contoso/example.xsn",thenthecallisfromtheIntranetzone.ForacallthatisnottrustedfromtheIntranetzone,InfoPathcheckswhethertheInternetExploreruserauthenticationsettingsallowautomaticlogon(intheIntranetzoneonlyorforeverylogon).IfInternetExplorerisconfiguredforautomaticlogon,thenInfoPathcheckstheuser'sgroupmembership.Ifthegroupmembershipispublic,InfoPathallowsfullaccesstotheIsUserMemberOfmethod.Ifthegroupmembershipisnotfullypublic,InfoPathhidestheresult.Thatis,InfoPathtreatsthegroupmembershipasifitwerenotvisible.ThereturnvalueinthiscaseisalwaysFalsebecausethegroupmembershipisnotpublic.InfoPathdoesnotreportthataccessisdenied.

NoteGroupmembershipinformationisfullypublicifaccesstoitisallowedandtheinformationisvisiblebyallnon-anonymoususers.Ifevenasinglenon-anonymoususerhasbeenspecificallydeniedaccesstomembershipinformation,thenthegroupmembershipinformationisnot

fullypublic.

ExampleInthefollowingexample,theIsUserMemberOfmethodoftheUserobjectisusedtodetermineifthecurrentuserisamemberofthe"GroupDomain\Administrators"group.

varfGroupMatched;fGroupMatched=Application.User.IsUserMemberOf("GroupDomain\Administrators")

MatchMethod

ReturnsaBooleanvaluethatindicateswhetherthetestmatchesthespecifiedpattern.

expression.Match(ByValbstrValueAsString,ByValbstrPatternAsString)AsBoolean

bstrValueRequiredString.Thestringtotestagainstthepattern.

bstrPatternRequiredString.Thepatterntouse.

returnsABooleanvaluethatindicateswhetherthestringmatchesthepattern.

RemarksTheMatchmethodcanbeusedtotestanystringagainstaregularexpression.TheregularexpressionmustconformtotheW3C'sXMLSchemaspecificationforregularexpressions(http://www.w3.org/TR/xmlschema-2/#regexs).

NoteTheXMLSchemaspecificationforregularexpressionsisdifferentfromregularexpressionsinPerl.

ExampleInthefollowingexample,thevariableisSSNValidissettoavaluethatindicateswhetherornotthevaluestoredinthemy:SSNnodeisalegalSocialSecurityNumber:

varSSN=XDocument.DOM.selectSingleNode(“//my:SSN”);varisSSNValid=XDocument.Util.Match(SSN.text,"\\d\\d\\d-\\d\\d-\\d\\d\\d\\d");

MaxMethod

ReturnsaVariantthatisthelargestvalueofallofthenumericalelementsinanodeset.

expression.Max(ByValpxmllistInputAsIXMLDOMNodeList)AsVariant

pxmllistInputRequiredIXMLDOMNodeList.Thenodesettosearchforthelargestvalue.

returnsAVariantthatrepresentsthelargestvalueofallthenumericalelementsinanodeset.

ExampleInthefollowingexample,maxAgeissettothemaximumvalueofallofthenumericalelementsinthemy:agesnodeset:

varages=XDocument.DOM.selectNodes("//my:ages");varmaxAge=XDocument.Util.Math.Max(ages);

MinMethod

ReturnsaVariantthatisthesmallestvalueofallofthenumericalelementsinanodeset.

expression.Min(ByValpxmllistInputAsIXMLDOMNodeList)AsVariant

pxmllistInputRequiredIXMLDOMNodeList.Thenodesettosearchforthesmallestvalue.

returnsAVariantthatrepresentsthesmallestvalueofallthenumericalelementsinanodeset.

ExampleInthefollowingexample,thevariableminAgeissettotheminimumvalueofallofthenumericalelementsinthemy:agesnodeset:

varages=XDocument.DOM.selectNodes("//my:ages");varmaxAge=XDocument.Util.Math.Min(ages);

ShowAll

NavigateMethod

LoadsthespecifiedHTMLdocumentintotheMicrosoftOfficeInfoPath2003customtaskpane.

expression.Navigate(ByValbstrURLAsString)

expressionRequired.AnexpressionthatreturnsareferencetotheHTMLTaskPaneobject.

bstrURLRequiredString.TheUniformResourceLocator(URL)oftheHTMLdocumenttonavigateto.

RemarksTheNavigatemethodoftheHTMLTaskPaneobjectisoneofthemethodsinheritedbytheTaskPaneobjectwhenthetypeofthetaskpaneis0,whichmeansthatitisthecustomtaskpane.

NoteTheNavigatemethodcannotbecalledduringanOnLoadeventbecausetheviewisnotyetloadedwhenthiseventoccurs,andtaskpanesareassociatedwiththeview.

ExampleInthefollowingexample,theNavigatemethodoftheHTMLTaskPaneobjectisusedtoloadanHTMLdocumentintothecustomtaskpane.TheHTMLdocumentthatitloadsisonethatisincludedintheformfilesoftheformtemplate:

varobjTaskPane;

//Setareferencetothecustomtaskpane.objTaskPane=XDocument.View.Window.TaskPanes(0);objTaskPane.Navigate("taskpane2.htm");

ShowAll

NewMethod(ExternalApplicationObject)

CreatesanewMicrosoftOfficeInfoPath2003formbasedonaspecifiedform.

expression.New(ByValbstrDocumentURIAsString,[ByValdwBehaviorAsLong=1])

dwBehaviorOptionalLong.Defaultvalueis1.Alongvaluethatspecifieshowtheformshouldbeopened.ThevaluesarebasedontheXdDocumentVersionModeenumeration.

RemarksTheNewmethodcanbeusedtoonlycreateanewformbasedonanexistingform;itcannotbeusedtocreateanewformbasedonaformtemplate.Tocreateaformfromaformtemplate,usetheNewFromSolutionmethodoftheExternalApplicationobject.

WhenyouusetheNewmethod,InfoPathisopenedandthenewformisreadytobefilledout.

NoteYoucannotusetheClosemethodoftheExternalApplicationobjecttocloseafromthathasbeenopenedwiththeNewmethod.WhentheNewmethodcreatesaform,thenameofthatformisnotyetknown.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theNewmethodoftheExternalApplicationobjectisusedtocreateanewformbasedonaspecifiedform:

PublicSubCreateFromForm()

DimobjIPAsObject

'CreateanInfoPathform.objIP.New("C:\MyForms\Form1.xml")MsgBox("TheInfoPathformhasbeencreated.")

SetobjIP=Nothing

EndSub

NewMethod(Index)

TheNewmethodcreatesanewitembasedonaform.ThismethodisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelcollectionsandobjects.ClickaNewmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheNewmethod.

NewmethodasitappliestotheExternalApplicationobject.

NewmethodasitappliestotheXDocumentscollection.

ShowAll

NewMethod(XDocumentsCollection)

CreatesanewMicrosoftOfficeInfoPath2003formbasedonthespecifiedform.

expression.New(ByValvarURIAsVariant,[ByValdwBehaviorAsLong=1])AsXDocument

varURIRequiredVariant.SpecifiestheUniformResourceIdentifier(URI)ofaform.

RemarksTheNewmethodcanonlybeusedtocreateanewformbasedonanexistingform;itcannotbeusedtocreateanewformbasedonaformtemplate.Tocreateaformfromaformtemplate,usetheNewFromSolutionmethodoftheXDocumentscollection.

WhenyouusetheNewmethod,thenewformopensinInfoPathandisreadytobefilledout.

NoteIfyouusetheoptionaldwBehaviorargumentintheNewmethod,youcanonlypassthenumericalvalueoftheXdDocumentVersionModeenumeration.BecauseInfoPathusesscriptinglanguagesforworkingwiththeobjectmodel,namedvaluescannotbeused.

ExampleInthefollowingexample,theNewmethodoftheXDocumentscollectionispassedtheURIofanexistingform,andanewformiscreatedanditsassociatedXDocumentobjectreturned:

varobjXDoc;

objXDoc=Application.XDocuments.New("C:\\MyForm.xml");

ShowAll

NewADODBConnectionMethod

CreatesandreturnsareferencetoanemptyActiveXDataObjects(ADO)Connectionobject.

expression.NewADODBConnection()ADODB.Connection

returnsAreferencetoanADOConnectionobject.

RemarksIftheformisnotfullytrusted,theNewADODBConnectionmethodwillreturna"permissiondenied"error.

ExampleInthefollowingexample,theNewADODBConnectionmethodoftheApplicationobjectisusedtosetareferencetoanemptyADOConnectionobject:

varobjADOConnection;

objADOConnection=Application.NewADODBConnection();

ShowAll

NewADODBRecordsetMethod

CreatesandreturnsareferencetoanemptyActiveXDataObjects(ADO)Recordsetobject.

expression.NewADODBRecordset()ADODB.Recordset

returnsAreferencetoanADORecordsetobject.

RemarksIftheformisnotfullytrusted,theNewADODBRecordsetmethodwillreturna"permissiondenied"error.

ExampleInthefollowingexample,theNewADODBRecordsetmethodoftheApplicationobjectisusedtosetareferencetoanemptyADORecordsetobject:

varobjADORecordset;

objADORecordset=Application.NewADODBRecordset();

ShowAll

NewFromSolutionMethod(ExternalApplicationObject)

CreatesanewMicrosoftOfficeInfoPath2003formbasedonthespecifiedformtemplate.

expression.NewFromSolution(ByValbstrSolutionURIAsString)

bstrSolutionURIRequiredString.ThestringvaluethatspecifiestheUniformResourceIdentifier(URI)ofaformtemplate.

RemarksTheNewFromSolutionmethodcanbeusedonlytocreateanewformbasedonanexistingformtemplate;itcannotbeusedtocreateanewformbasedonanexistingform.Tocreateaformfromanexistingform,usetheNewmethodoftheExternalApplicationobject.

WhenyouusetheNewFromSolutionmethod,InfoPathisopenedandthenewformisreadytobefilledout.

NoteYoucannotusetheClosemethodoftheExternalApplicationobjecttocloseafromthathasbeenopenedwiththeNewFromSolutionmethod.WhentheNewFromSolutionmethodcreatesaform,thenameofthatformisnotyetknown.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theNewFromSolutionmethodoftheExternalApplicationobjectisusedtocreateanewformbasedonaspecifiedformtemplate:

PublicSubCreateFromFormTemplate()

DimobjIPAsObject

'CreateanInfoPathformfromaformtemplate.objIP.NewFromSolution("C:\MyForms\MyFormTemplate.xsn")MsgBox("TheInfoPathformhasbeencreated.")

SetobjIP=Nothing

EndSub

ShowAll

NewFromSolutionMethod(Index)

TheNewFromSolutionmethodcreatesanewitembasedonaformtemplate.ThismethodisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelcollectionsandobjects.ClickaNewFromSolutionmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheNewFromSolutionmethod.

NewFromSolutionmethodasitappliestotheExternalApplicationobject.

NewFromSolutionmethodasitappliestotheXDocumentscollection.

ShowAll

NewFromSolutionMethod(XDocumentsCollection)

CreatesanewMicrosoftOfficeInfoPath2003formbasedonthespecifiedformtemplate.

expression.NewFromSolution(ByValvarURIAsVariant)AsXDocument

RemarksTheNewFromSolutionmethodcanonlybeusedtocreateanewformbasedonanexistingformtemplate;itcannotbeusedtocreateanewformbasedonaform.Tocreateaformfromanexistingform,usetheNewmethodoftheXDocumentscollection.

WhenyouusetheNewFromSolutionmethod,thenewformopensinInfoPathandisreadytobefilledout.

ExampleInthefollowingexample,theNewFromSolutionmethodoftheXDocumentscollectionispassedtheURIofanexistingformtemplate,andanewformiscreatedanditsassociatedXDocumentobjectreturned:

varobjXDoc;

objXDoc=Application.XDocuments.NewFromSolution("C:\\MyForm.xsn");

ShowAll

NewFromSolutionWithDataMethod

CreatesanewMicrosoftOfficeInfoPath2003formusingthespecifiedXMLdataandformtemplate.

expression.NewFromSolutionWithData(ByValvarXMLDataAsVariant,ByValvarSolutionURIAsVariant,[ByValdwBehaviorAsLong=1])AsXDocument

expressionAnexpressionthatreturnsareferencetoanXDocumentscollection.

varXMLDataRequiredVariant.ProvidestheXMLdatatobeusedasatemplatefortheform.CanbeastringthatspecifiestheUniformResourceIdentifier(URI)ofanXMLdocument,oranXMLDOMNodethatcontainstheXMLtobeusedastheXMLdocument(template).

varSolutionURIRequiredVariant.StringwhichspecifiestheUniformResourceIdentifier(URI)ofaformtemplatefile(an.xsfor.xsnfile).

dwBehaviorOptionalLong.Reservedforfutureuse.Thisvalueshouldbeomittedorsetto1.

RemarksThefollowingrelatedmethodsoftheXDocumentscollectionarealsoavailable:

TheNewmethodenablescreatinganewinstanceofInfoPathbyusingaspecifiedXMLdocument.TheXMLdocumentmustcorrespondtoanInfoPathform.AnewformisopenedinInfoPath,usingthesuppliedXMLdocumentasinitialdata,anditsassociatedformtemplateasspecifiedintheprocessinginstructionsintheheaderofthedocument.

TheNewFromSolutionmethodenablescreatinganewinstanceofInfoPathusingaspecifiedformtemplate,anditsassociatedXMLform(theinitialtemplatedata).

TheNewFromSolutionWithDatamethodsupportsascenariothatisnotprovidedbytheforegoingtwomethods:specifyingboththeXMLdocumentusedasinitialdataandtheformtemplate.TheXMLdocumentdoesnotneedtohavebeencreatedbyInfoPath.ItcanbesuppliedeitherasaURIorasanXMLDOMNode.

WhenyouusetheNewFromSolutionWithDatamethod,thenewformopensinInfoPathandisreadytobefilledout.

ExampleInthefollowingexample,theNewFromSolutionWithDatamethodoftheXDocumentscollectionispassedtheURIsofanexistingXMLdocument,andanexistingformtemplate,andanewformiscreatedanditsassociatedXDocumentobjectisreturned:

varobjXDoc=Application.XDocuments.NewFromSolutionWithData

Inthefollowingexample,theNewFromSolutionWithDatamethodoftheXDocumentscollectionispassedanXMLDOMNodeasinitialdataandtheURIofanexistingform,andanewformiscreatedanditsassociatedXDocumentobjectisreturned:

varobjXMLNode=XDocument.DOM.selectSingleNode("/employees/employee");

varobjXDoc=Application.XDocuments.NewFromSolutionWithData

NowMethod

ReturnsaVariantthatrepresentsthecurrentsystemdateandtimeinISOformat(yyyy-mm-ddThh:mm:ss).

expression.Now()AsVariant

expressionRequired.AnexpressionthatreturnsareferencetoaDateobject.

returnsAVariantthatrepresentsthecurrentsystemdateandtime.

ExampleInthefollowingexample,thevariablecurrentDateTimeissettothecurrentsystemdateandtime:

varcurrentDateTime=XDocument.Util.Date.Now();

NzMethod

ReturnsaVariantthatisidenticaltothenodesetpassedtothefunction,exceptemptyvaluesinthenodelistarereplacedwithzeros(0).

expression.Nz(ByValpxmllistInputAsIXMLDOMNodeList)AsVariant

pxmllistInputRequired.Thenodesetthatwillhaveitsemptyvaluesreplacedwithzeroes.

returnsAVariantthatrepresentsanodeset.

ExampleInthefollowingexample,thevariablenoZeroissettoanodesetthatisidenticaltothemy:agesnodeset,withallblankvaluesreplacedbyzeros:

varages=XDocument.DOM.selectNodes("//my:ages");varnoZero=XDocument.Util.Math.Nz(ages);

ShowAll

OpenMethod(ExternalApplicationObject)

OpensthespecifiedMicrosoftOfficeInfoPath2003form.

expression.Open(ByValbstrDocumentURIAsString,[ByValdwBehaviorAsLong=1])

RemarksTheOpenmethodcanbeusedonlytoopenaform;itcannotbeusedtoopenaformtemplate.Tocreateaformfromaformtemplate,usetheNewFromSolutionmethodoftheExternalApplicationobject.Tocreateaformbasedonanexistingform,usetheNewmethodoftheExternalApplicationobject.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theOpenmethodoftheExternalApplicationobjectisusedtoopenaspecifiedform:

DimobjIPAsObject

SetobjIP=Nothing

EndSub

OpenMethod(Index)

TheOpenmethodopensaform.ThismethodisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelcollectionsandobjects.ClickanOpenmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheOpenmethod.

OpenmethodasitappliestotheExternalApplicationobject.

OpenmethodasitappliestotheXDocumentscollection.

ShowAll

OpenMethod(XDocumentsCollection)

OpensthespecifiedMicrosoftOfficeInfoPath2003form.

expression.Open(ByValvarURIAsVariant,[ByValdwBehaviorAsLong=1])AsXDocument

RemarksTheOpenmethodcanonlybeusedtoopenaform;itcannotbeusedtoopenaformtemplate.Tocreateaformfromaformtemplate,usetheNewFromSolutionmethodoftheXDocumentscollection.Tocreateaformbasedonanexistingform,usetheNewmethodoftheXDocumentscollection.

WhenyouusetheOpenmethod,thespecifiedformopensinInfoPathandisreadytobefilledout.

NoteIfyouusetheoptionaldwBehaviorargumentintheOpenmethod,youcanonlypassthenumericalvalueoftheXdDocumentVersionModeenumeration.BecauseInfoPathusesscriptinglanguagesforworkingwiththeobjectmodel,namedvaluescannotbeused.

ExampleInthefollowingexample,theOpenmethodoftheXDocumentscollectionispassedtheURIofanexistingform,andtheformisopenedanditsassociatedXDocumentobjectreturned:

varobjXDoc;

objXDoc=Application.XDocuments.Open("C:\\MyForm.xml");

PerformSaveOperationMethod

Performsthesaveoperationrequestedbytheuser.

expression.PerformSaveOperation()

RemarksThePerformSaveOperationmethodperformsa"save"or"saveas"operationdependingonthevalueoftheIsSaveAspropertyoftheSaveEventobject.Iftheoperationissuccessful,theIsDirtypropertyoftheXDocumentobjectissettoFalseandthePerformSaveOperationmethodreturnsTrue.

ExampleInthefollowingexample,thePerformSaveOperationmethodoftheSaveEventobjectisusedtosavetheformusingtheinternaldefinitionofsave.

eventObj.PerformSaveOperation();

PrintOutMethod

Printstheformcontentasitisrenderedinthewindowcorrespondingtotheform'sactiveview.

expression.PrintOut()

RemarksThePrintOutmethodusesthecurrentprintersettings.Returnsapermissiondeniederrorifcalledfromaformthatisnotfullytrusted.

Itisrecommendedthatyoudon'tcallthePrintOutmethodfromanOnLoadorOnSwitchVieweventprocedure.YoumayencounteroneormoreofthefollowingbehaviorswhencallingthePrintOutmethodfromanOnLoadorOnSwitchVieweventprocedure:

Theviewmayprintcorrectly.

Ablankdocumentmaybeprinted.

Theincorrectviewmaybeprinted.

Thefollowingexceptionmayoccur:

InvalidcontextfortheOMcall.

ExampleInthefollowingexample,thePrintOutmethodoftheXDocumentobjectisusedtoprintthecurrentview:

XDocument.PrintOut();

QueryMethod(ADOAdapterObject)

Readsdatafromtheassociateddataadapter.

expression.Query()

RemarksTheQuerymethodfailsiftheQueryAllowedpropertyoftheADOAdapterobjectisFalse.

ShowAll

QueryMethod(DataObjectObject)

ReadsdatafromthedataadapterthatisassociatedwiththeDataObjectobjectandrepopulatestheDataObjectobject'sassociatedXMLDocumentObjectModel(DOM).

expression.Query()

RemarksTheQuerymethodcanbeusedtorefreshthedatacontainedintheXMLDOMthatisassociatedwithaDataObjectobject.

ExampleInthefollowingexample,theQuerymethodoftheDataObjectobjectisusedtorefreshthedatacontainedintheXMLDOMassociatedwiththeDataObjectobject:

XDocument.DataObjects("CityList").Query();

AfteryouhaverefreshedthedataintheDataObjectobject,youcancalltheForceUpdatemethodoftheViewobjecttosynchronizethedatacontainedintheDataObjectobjectandtheview:

QueryMethod(DAVAdapterObject)

TheQuerymethodisavailablefortheDAVAdapterobjectbut,becausetheDAVAdapterobjectisavailableforsubmittingdataonly,themethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

expression.Query()

expressionRequired.AnexpressionthatreturnsareferencetotheDAVAdapterobject.

QueryMethod(EmailAdapterObject)

TheQuerymethodisavailablefortheEmailAdapterobjectbut,becausetheEmailAdapterobjectisavailableforsubmittingdataonly,themethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

expression.Query()

expressionRequired.AnexpressionthatreturnsareferencetotheEmailAdapterobject.

QueryMethod(HWSAdapterObject)

TheQuerymethodisavailablefortheHWSAdapterobjectbut,becausetheHWSAdapterobjectisavailableforsubmittingdataonly,themethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

expression.Query()

expressionRequired.AnexpressionthatreturnsareferencetotheHWSAdapterobject.

ShowAll

QueryMethod(Index)

TheQuerymethodretrievesdatafromtheassociateddataadapterandstoresitinanXMLDocumentObjectModel(DOM).ThismethodisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaQuerymethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheQuerymethod.

QuerymethodasitappliestotheADOAdapterobject.

QuerymethodasitappliestotheDataObjectobject.

QuerymethodasitappliestotheDAVAdapterobject.

QuerymethodasitappliestotheHWSAdapterobject.

QuerymethodasitappliestotheEmailAdapterobject.

QuerymethodasitappliestotheSharepointListAdapterobject.

QuerymethodasitappliestotheWebServiceAdapterobject.

QuerymethodasitappliestotheXDocumentobject.

QuerymethodasitappliestotheXMLFileAdapterobject.

QueryMethod(SharePointListAdapterObject)

expression.Query()

RemarksTheQuerymethodfailsiftheQueryAllowedpropertyoftheSharePointListAdapterobjectisFalse.

ShowAll

QueryMethod(WebServiceAdapterObject)

expression.Query()

RemarksTheQuerymethodfailsiftheQueryAllowedpropertyoftheWebServiceAdapterobjectisFalse.

NoteAnADO.NetDataSetcannotbeusedasaqueryparameterfortheWebServiceAdapterobjectoranyotherdataadapter.

ShowAll

QueryMethod(XDocumentObject)

Retrievesdatafromaform'sassociateddataadapterobjectandstoresthedataintheform'sunderlyingXMLDocumentObjectModel(DOM).

expression.Query()

RemarksTheQuerymethodwillreturnanerroriftheformdoesnothaveanassociateddataadapterobject.

ExampleInthefollowingexample,theQuerymethodoftheXDocumentobjectisusedtoquerytheassociateddataadapter:

XDocument.Query();

QueryMethod(XMLFileAdapterObject)

expression.Query()

RemarksTheQuerymethodfailsiftheQueryAllowedpropertyoftheXMLFileAdapterobjectisFalse.

QuitMethod(ApplicationObject)

QuitstheMicrosoftOfficeInfoPath2003application.

expression.Quit([ByValbForceAsBoolean=False])

bForceOptionalBoolean.DefaultvalueisFalse.Determineswhetheropenformswillbesavedduringthequitoperation.IfsettoFalse,allformswillbeclosedwithoutsaving,evenifthedataintheformshasbeenchanged.IfsettoTrue,theuserwillbepromptedtosavetheforms.

RemarksIftheQuitmethodisusedinaformthatisnotfullytrusted,themethodwillreturna"permissiondenied"error.

ExampleInthefollowingexample,theQuitmethodoftheApplicationobjectisusedtoquitInfoPathwithoutsavinganyofthecurrentlyopenforms:

Application.Quit(false);

ShowAll

QuitMethod(ExternalApplicationObject)

QuitstheMicrosoftOfficeInfoPath2003application.

expression.Quit

RemarksIfyouusetheClosemethodoftheExternalApplicationobjectbeforeusingtheQuitmethod,datathathasbeenchangedintheformwillnotbesaved,norwillusersbepromptedtosaveit.However,ifyoudonotusetheClosemethodbutonlyusetheQuitmethod,userswillbepromptedtosavetheformbeforequittingtheInfoPathapplication.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theQuitmethodoftheExternalApplicationobjectisusedtoquittheInfoPathapplication:

DimobjIPAsObject

SetobjIP=Nothing

EndSub

QuitMethod(Index)

TheQuitmethodquitstheapplication.ThismethodisimplementedinanumberofMicrosoftOfficeInfoPath2003objectmodelobjects.ClickaQuitmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheQuitmethod.

QuitmethodasitappliestotheApplicationobject.

QuitmethodasitappliestotheExternalApplicationobject.

ShowAll

RegisterSolutionMethod(ApplicationObject)

InstallsthespecifiedMicrosoftOfficeInfoPathformtemplate.

expression.RegisterSolution(ByValbstrSolutionURLAsString,[ByValbstrBehaviorAsString="overwrite"])

bstrSolutionURLRequiredString.ThestringthatspecifiestheUniformResourceLocator(URL)oftheformtemplate.Thisparametercanbespecifiedasaformdefinition(.xsf)fileoraformtemplate(.xsn)file.

bstrBehaviorOptionalString.Defaultvalueis"overwrite".Thestringthatspecifieshowtheformtemplateistobeinstalled.Theonlyothervalidvalueforthisparameteris"new-only".

RemarksIftheformtemplatehasalreadybeenregistered,and"new-only"isspecifiedforthebstrBehaviorparameter,theRegisterSolutionmethodwillreturnanerror.If"overwrite"isspecified,theformtemplate'sregistrationrecordwillbeoverwritten.

ExampleInthefollowingVisualBasicforApplications(VBA)example,theRegisterSolutionmethodoftheApplicationobjectisusedtoinstallaformtemplate:

PublicSubInstallForm()

DimobjIPAsObject

'CreateareferencetotheApplicationobject.SetobjIP=CreateObject("InfoPath.Application")

'RegistertheInfoPathformtemplate.objIP.RegisterSolution("C:\\MyForms\\MyFormTemplate.xsn")MsgBox"TheInfoPathformtemplatehasbeenregistered."

SetobjIP=Nothing

EndSub

ShowAll

RegisterSolutionMethod(ExternalApplicationObject)

InstallsthespecifiedMicrosoftOfficeInfoPath2003formtemplate.

expression.RegisterSolution(ByValbstrSolutionURLAsString,[ByValbstrBehaviorAsString="overwrite"])

bstrSolutionURLRequiredString.ThestringvaluethatspecifiestheUniformResourceLocator(URL)oftheformtemplate.Thisparametercanbespecifiedasaformdefinition(.xsf)fileoraformtemplate(.xsn)file.

bstrBehaviorOptionalString.Defaultvalueisoverwrite.Thestringvaluethatspecifieshowtheformtemplateistobeinstalled.Theonlyothervalidvalueforthisparameterisnew-only.

RemarksIftheformtemplatehasalreadybeenregistered,andthenew-onlyvalueisusedforthebstrBehaviorparameter,theRegisterSolutionmethodwillreturnanerror.Iftheoverwritevalueisused,theformtemplate'sregistrationrecordwillbeoverwritten.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theRegisterSolutionmethodoftheExternalApplicationobjectisusedtoinstallaformtemplate:

PublicSubInstallForm()

DimobjIPAsObject

'RegistertheInfoPathformtemplate.objIP.RegisterSolution("C:\\MyForms\MyFormTemplate.xsn")MsgBox("TheInfoPathformtemplatehasbeenregistered.")

SetobjIP=Nothing

EndSub

ShowAll

RegisterSolutionMethod(Index)

TheRegisterSolutionmethodinstallsthespecifiedMicrosoftOfficeInfoPath2003formtemplate.ThismethodisimplementedinseveralInfoPathobjectmodelcollections.ClickaRegisterSolutionmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheRegisterSolutionmethod.

RegisterSolutionmethodasitappliestotheApplicationobject.

RegisterSolutionmethodasitappliestotheExternalApplicationobject.

ShowAll

ReportErrorMethod

CreatesanErrorobjectandaddsittotheErrorscollection.

expression.ReportError(ByValvarNodeAsVariant,ByValbstrShortErrorMessageAsString,ByValfSiteIndependentAsBoolean,[ByValbstrDetailedErrorMessageAsString],[ByVallErrorCodeAsLong],[ByValbstrTypeAsString="modeless"])AsError

varNodeRequiredVariant.TheXMLDocumentObjectModel(DOM)nodethattheerrorisassociatedwith.

bstrShortErrorMessageRequiredString.Thetexttobeusedfortheshorterrormessage.

fSiteIndependentOptionalBoolean.SetstheconditionforautomaticdeletionoftheErrorobject.IfTrue,theErrorobjectwillbedeletedonchangeforanynodesthatmatchedtheXPathexpressioncorrespondingtotheErrorobject.IfFalse,theErrorobjectwillbedeletedwhenthenodereturnedbytheSitepropertyofagiveneventobjecthasbeenchanged.

bstrDetailedErrorMessageOptionalString.Thetexttobeusedforthedetailederrormessage.

lErrorCodeOptionalLong.Thenumbertobeusedastheerrorcode.

bstrTypeOptionalString.Defaultvalueis"modeless".Determineswhetherthechangeinvaluewillbeautomaticallyrejectedorwhethertheuserwillbepromptedtoacceptorrejectthechange.Theothervalueis"modal".

returnsAreferencetoanErrorobject.

RemarksWhentheReportErrormethodoftheDataDOMEventobjectiscalled,MicrosoftOfficeInfoPath2003createsanErrorobjectandaddsittotheErrorscollection.Errorsareremovedfromthecollectionwhenthevalidationconstraintisnolongerinvalid,orwhentheyareexplicitlyremovedusingtheDeleteorDeleteAllmethodsoftheErrorscollection.

ErrorscanalsobecreatedusingtheAddmethodoftheErrorscollection.

NoteSite-independenterrorsshouldbeusedwhenyouwanttheerrorstoapplytoallXMLDOMnodesofthesametype.IfyouwanttheerrortoapplytoaspecificXMLDOMnode,usesite-dependenterrors.

ExampleInthefollowingexamplefromtheDataValidationdevelopersampleform,theReportErrormethodoftheDataDOMEventobjectisusedtocreateacustomerrorandaddittotheerrorscollection:

functionmsoxd__total::OnValidate(eventObj){if(parseInt(eventObj.Site.nodeTypedValue,10)>75)eventObj.ReportError(eventObj.Site,"Thetotalistoohigh."+"Thetotalnumberofblockscannotbegreaterthan75.",false);

if(parseInt(eventObj.Site.nodeTypedValue,10)<0)eventObj.ReportError(eventObj.Site,"Thetotalistoolow."+Thetotalnumberofblockscannotbelessthan0.",false);}

ShowAll

SaveMethod

SavestheformtotheUniformResourceLocator(URL)thatitiscurrentlyassociatedwith.

expression.Save()

RemarksTheSavemethodwillreturnanerrorifcalledfromaformthatisnotfullytrusted.

ExampleInthefollowingexample,theSavemethodoftheXDocumentobjectisusedtosaveaform:

XDocument.Save();

ShowAll

SaveAsMethod

SavestheformtothespecifiedUniformResourceLocator(URL).

expression.SaveAs(ByValbstrFileUrlAsString)

bstrFileUrlRequiredString.TheURLaddressthattheformshouldbesavedto.

RemarksTheSaveAsmethodwillreturnanerrorifcalledfromaformthatisnotfullytrusted.

NoteTheURLthattheformissavedtomustbeinthesamedomainastheformthatcallstheSaveAsmethod.

ExampleInthefollowingexample,theSaveAsmethodoftheXDocumentobjectisusedtosaveaform:

XDocument.SaveAs("C:\MyForm.xml");

SaveStateMethod

DefinesamethodthatInfoPathcallswhenitneedstosavethestateofaninstanceofthecontrolinaview.

expression.SaveState()

ShowAll

SelectNodesMethod

SelectsarangeofnodesinaviewbasedonthespecifiedstartingXMLDocumentObjectModel(DOM)node,theendingXMLDOMnode,andtheviewcontext.

expression.SelectNodes(ByRefpxnStartNodeAsXMLDOMNode,[ByValvarEndNodeAsVariant],[ByValvarViewContextAsVariant])

pxnStartNodeRequiredXMLDOMNode.TheXMLDOMnodethatbeginstherange.

varEndNodeOptionalVariant.TheXMLDOMnodethatendstherange.Ifnotspecified,onlythestartingXMLDOMnodewillbeused.

varViewContextOptionalVariant.TheIDofthecontrolthatisusedforthecontext,whichisanelementwiththespecifiedviewcontextofxd:CtrlId.

RemarksIfaviewcontextisspecified,alloftheXMLDOMnodesthataretobeselectedmustbewithinthatcontext.

IfanyoftheargumentstotheSelectNodesmethodarenullorarenotexposedintheview,theSelectNodesmethodwillreturnanerror.Inaddition,iftherearemorethanonesetofviewelementswhichmaptothesamespecifiedXMLDOMnodes,withinthespecifiedviewcontext,thentheSelectNodesmethodwillalsoreturnanerror.

ExampleInthefollowingexample,theSelectNodesmethodoftheViewobjectisusedtosetselectiononasingleitemintheview,correspondingtothespecifiedXMLDOMnodeandthen,usingtheGetSelectedNodesmethodoftheViewobject,determineswhethertheselectionhasbeensuccessfulbydisplayinginformationabouttheXMLDOMnodeinamessagebox:

functionSelectEmployee(){varobjXMLNodes;varobjXMLNode;

objXMLNode=XDocument.DOM.selectSingleNode("/employees/employee");XDocument.View.SelectNodes(objXMLNode);

objXMLNodes=XDocument.View.GetSelectedNodes();if(objXMLNodes.Count>0){XDocument.UI.Alert(objXMLNodes(0).nodeName+"\n\n"+objXMLNodes(0).text);}}

ShowAll

SelectTextMethod

SelectsthetextcontainedinaneditablefieldthatisboundtothespecifiedXMLDocumentObjectModel(DOM)node.

expression.SelectText(ByRefpxnFieldAsXMLDOMNode,[ByValvarViewContextAsVariant)

pxnFieldRequiredXMLDOMNode.TheXMLDOMnode.

varViewContextOptionalVariant.TheIDofthecontrolthatisusedforthecontext,whichisanelementwiththespecifiedviewcontextofxd:CtrlId.

RemarksIfaviewcontextisspecified,thentheeditablefieldthatistobeselectedmustbewithinthatcontext.

IftherearemorethanonesetofviewelementswhichmaptothesamespecifiedXMLDOMnode,withinthegivenviewcontext,thentheSelectTextmethodwillreturnanerror.Inaddition,ifanyoftheargumentstotheSelectTextmethodarenullorarenotexposedintheview,thentheSelectTextmethodwillalsoreturnanerror.

ExampleInthefollowingexample,theSelectTextmethodoftheViewobjectisusedtoselectafieldthatisboundtoanXMLDOMnode:

varobjXMLNode;

objXMLNode=XDocument.DOM.selectSingleNode("/employees/employee/name");XDocument.View.SelectText(objXMLNode);

ShowAll

SetDataVariableMethod

Setsthevalueofapredefinedvariablestoredasaprocessinginstructionattributeintheform'sunderlyingXMLdocument.

expression.SetDataVariable(ByVallVariableNumberAsLong,ByValbstrVariableValueAsString)

lVariableNumberRequiredLong.Thenumberofthevariable.

bstrVariableValueRequiredString.Thevalueofthevariable.

RemarksIfthevariablebeingsetisnotavalidprocessinginstructionattribute,theSetDataVariablemethodwillreturnanerror.

Togetthevalueofavariable,usetheGetDataVariablemethodoftheXDocumentobject.

NoteMicrosoftOfficeInfoPath2003onlysupportsusingtheinitialViewvariable,whichisthevariableusedtospecifytheinitialviewdisplayedwhenaformisopened.Thenumberofthisvariableisalways1,anditsvaluemustbethenameofaviewwithintheform.

ExampleInthefollowingexample,theSetDataVariablemethodoftheXDocumentobjectisusedtosetthevalueofthefirstvariable:

XDocument.SetDataVariable(1,"View2");

SetDirtyMethod

SetstheIsDirtypropertyontheXDocumentobjecttoaBooleanvaluethatindicateswhetherthedatainaMicrosoftOfficeInfoPath2003formhasbeenmodifiedsinceitwaslastsaved.

expression.SetDirty(ByValvfIsDirtyAsBoolean)

vfIsDirtyRequiredBoolean.Specifieswhethertheformistobemarkedasunmodifiedornot.

RemarksTheSetDirtymethodcanbeusedfromtheOnSubmitRequesteventhandlertoforceadocumenttobemarkedasunchanged.InfoPathwillthereforenotrequesttheusertosavetheformwhenitisclosed.

TheSetDirtymethodcanalsobeusedfromtheOnSaveRequesteventhandlertoprogrammaticallymarktheformaschangedorunchangedsinceitwaslastsaved.

ExampleInthefollowingexample,theIsDirtypropertyofthecurrentformissettoFalsesothatInfoPathwillnotprompttheusertosavetheformwhenitisclosed.

XDocument.SetDirty(false);

SetNamedNodePropertyMethod

SetsthevalueofanamedpropertyforthesuppliedXMLnode,whichmustbeanonattributenodeinthemaindatasource.

expression.SetNamedNodeProperty(ByValpxmlMainDOMNodeAsIXMLDOMNode,ByValbstrPropertyNameAsString,ByValbstrValueAsString)

pxmlMainDOMNodeRequiredIXMLDOMNode.AnXMLnodecorrespondingtoanonattributenodeinthemaindatasource,forwhichanamedpropertyistobeset.

bstrPropertyNameRequiredString.Specifiesthenameofthepropertybeingset.

bstrValueRequiredString.Specifiesthevaluetowhichthepropertywillbeset.

RemarksNamedpropertiesallowuserstoassociatestringswithuser-definedpropertiesofXMLelementnodesinthemaindatasource.ThevalueofanamedpropertycanbesetbyusingtheSetNamedNodePropertymethod.UsetheGetNamedNodePropertymethodtoreadthevalueofanamedproperty.

ExampleInthefollowingexample,thevalueofanamedproperty(withthename"cost")ofanXMLnode(called"item")issetbyusingtheSetNamedNodePropertymethod:

varobjXMLNode=XDocument.DOM.selectSingleNode("/items/item");XDocument.SetNamedNodeProperty(objXMLNode,'cost','100');varstrTest=XDocument.GetNamedNodeProperty(myNode,'cost','empty');

SetSaveAsDialogFileNameMethod

SetsthedefaultfilenameforaformintheSaveAsdialogbox.

expression.SetSaveAsDialogFileName(ByValstrFileNameAsString)

expressionRequired.AnexpressionthatreturnsareferencetoaUIobject.

strFileNameRequired.ThefilenameoftheformsuppliedtotheSaveAsdialogbox.

Security2:Canbeaccessedonlybyformsrunninginthesamedomainasthecurrentlyopenform,orbyformsthathavebeengrantedcross-domainpermissions.

RemarksIfthestrFileNameargumentisnull,"Form"isusedasthefilename.TheSetSaveAsDialogFileNamemethodmaybeusedinconjunctionwiththeSetSaveAsDialogLocationmethod.

ExampleInthefollowingexample,theSetSaveAsDialogFileNamemethodoftheUIobjectisusedtosetthedefaultfilenamefortheSaveAsdialogbox:

XDocument.UI.SetSaveAsDialogFileName("StatusReport.xml");

SetSaveAsDialogLocationMethod

SetstheinitiallocationatwhichtheSaveAsdialogstartstobrowsewhenitisopened.

expression.SetSaveAsDialogLocation(ByValstrLocationUrlAsString)

strLocationUrlRequired.Thelocation,expressedasaURL,atwhichtheSaveAsdialogboxstartsbrowsing.

RemarksThelocationspecifiedmustbeanabsolutepathanditshouldnotincludeafilename.InfoPathhandlesinvalidpaths,however,andnoerrormessageisgeneratedifaninvalidpathisspecifiedforthestrLocationUrlargument.TheSetSaveAsDialogLocationmethodmaybeusedinconjunctionwiththeSetSaveAsDialogFileNamemethod.

ExampleInthefollowingexample,theSetSaveAsDialogLocationmethodoftheUIobjectisusedtosettheinitiallocationfortheSaveAsdialog:

XDocument.UI.SetSaveAsDialogLocation("\\\\MyShare\\Forms");

ShowMailItemMethod

Createsane-mailmessageinthedefaulte-maileditorandattachesthecurrentlyopenMicrosoftOfficeInfoPath2003formtothemessage.

expression.ShowMailItem(ByValbstrToAsString,ByValbstrCCAsString,ByValbstrBCCAsString,ByValbstrSubjectAsString,ByValbstrBodyAsString)

bstrToRequiredString.Thee-mailaddresstosendthee-mailmessageto.

bstrCCRequiredString.Thee-mailaddresstocopythee-mailmessageto.

bstrBCCRequiredString.Thee-mailaddresstoblindcopythee-mailmessageto.

bstrSubjectRequiredString.Thesubjectofthee-mailmessage.

bstrBodyRequiredString.Thebodytextofthee-mailmessage.

RemarksAfterthee-mailmessageiscreated,thedefaulte-maileditorwilldisplaythee-mailmessage;userscantheninspectandeditthee-mailmessagebeforesendingit.TheShowMailItemmethodwillreturnanerrorifnoe-maileditingprogramisavailable.

NoteTheShowMailItemmethoddoesnotsendthee-mailmessagesitcreates;usersmustmanuallysendthee-mailmessages.

YoucanalsousetheMailEnvelopeobject,accessedthroughtheMailEnvelopepropertyoftheWindowobject,toprogrammaticallycreatee-mailmessages.

ExampleInthefollowingexample,theShowMailItemmethodoftheUIobjectisusedtocreateacustome-mailmessage:

XDocument.UI.ShowMailItem("someone@example.com","","","UpdatedForm","Hereistheupdatedformthatyourequested.");

ShowAll

ShowModalDialogMethod

DisplaysacustommodaldialogboxinaMicrosoftOfficeInfoPath2003form.

expression.ShowModalDialog(ByValbstrNameAsString,[ByValvarArgumentsAsVariant],[ByValvarHeightAsVariant],[ByValvarWidthAsVariant],[ByValvarTopAsVariant],[ByValvarLeftAsVariant])AsVariant

bstrNameRequiredString.Thenameofthe.htmlfileusedforthemodaldialogbox.

varArgumentsOptionalVariant.Specifiestheargumentstousewhendisplayingthemodaldialogbox.Canbeanytypeofvalue,includinganarrayofvalues.

varHeightOptionalVariant.Setstheheightofthemodaldialogbox.

varWidthOptionalVariant.Setsthewidthofthemodaldialogbox.

varTopOptionalVariant.Setsthetoppositionofthemodaldialogboxrelativetotheupperleftcornerofthedesktop.

varLeftOptionalVariant.Setstheleftpositionofthemodaldialogboxrelativetotheupperleftcornerofthedesktop.

returnsVariant.

RemarksTheShowModalDialogmethodoftheUIobjectallowsyoutodisplaycustomdialogboxestousersastheyfilloutafullytrustedform.Customdialogboxesareimplementedas.htmlfilescreatedinanytypeofHTMLeditor,suchasMicrosoftFrontPage.YoucanusescriptingcodeinacustomdialogboxthatinteractswiththeInfoPathobjectmodelifyoupassobjectstothecustomdialogboxusingthevarArgumentsparameter.

TouseacustomdialogboxinanInfoPathform,youmustfirstaddthe.htmlfileofthecustomdialogboxtotheform'ssetofresourcefilesbyusingtheResourceManagerdialogbox.TheResourceManagerdialogboxisavailablefromtheToolsmenuindesignmode.Afteryouhaveaddedthecustomdialogboxfiletotheform,youcanusetheShowModalDialogmethodtodisplayit.

NoteAlthoughtheShowModalDialogmethodcanonlybeusedinfullytrustedforms,youcancreateacustomdialogboxinstandardformsusingtheshowModalDialogmethodoftheDynamicHTML(DHTML)objectmodel.

ExampleInthefollowingexample,theShowModalDialogmethodoftheUIobjectisusedtodisplayacustomdialogbox.NotethattheXDocumentobjectispassedtothecustomdialogboxusingthevarArgumentsparameter.

XDocument.UI.ShowModalDialog("SimpleDialog.htm",XDocument);

ThefollowingexampleistheHTMLcodeusedtoimplementasimplecustomdialogbox.NotetheuseofthedialogArgumentspropertyoftheDHTMLwindowobjecttogetthevaluespassedtothecustomdialogbox,whichinthiscaseistheXDocumentobjectoftheInfoPathobjectmodel,fromtheShowModalDialogmethod.WhenauserclickstheShowAlertbuttoninthecustomdialogbox,thesourceXMLoftheform'sunderlyingXMLdocumentappearsinamessagebox.

<html><head><scriptlanguage="jscript">vargobjXDocument=null;

functionInitialize(){//SaveareferencetotheXDocumentobject.if(typeofwindow.dialogArguments=="object")gobjXDocument=window.dialogArguments;}</script>

<title>ASimpleCustomDialogBox</title></head>

<bodystyle="BACKGROUND-COLOR:window"onLoad="Initialize()"><strong>Clickoneofthefollowingbuttons:</strong>

ShowSignatureDialogMethod

DisplaystheMicrosoftOfficeInfoPath2003DigitalSignaturesdialogbox.

expression.ShowSignatureDialog()

RemarksTheShowSignatureDialogmethodcanbeusedonlyinformsthathavebeenenabledfordigitalsigning.Themethodwillreturnanerrorifusedinaformthatisnotenabledfordigitalsigning.

ExampleInthefollowingexample,theShowSignatureDialogmethodoftheUIobjectisusedtodisplaytheInfoPathDigitalSignaturesdialogbox:

XDocument.UI.ShowSignatureDialog();

SignMethod(Index)

ThismethodisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickaSignmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheSignmethod.

SignmethodasitappliestotheSignatureobject.

SignmethodasitappliestotheSignedDataBlockobject.

SignMethod(SignatureObject)

WritestheXMLdigitalsignatureblockandcomputesthecryptographichashforthesigneddata.ThismethodcanonlybecalledfromtheOnSigneventhandler.CallingthismethoddisplaystheDigitalSignaturesdialogbox.

expression.Sign()

expressionRequired.AnexpressionthatreturnsareferencetoaSignatureobject.

RemarksUsetheCreatemethodoftheSignaturescollectiontocreateadigitalsignature.Then,usetheSignmethodtowritethedigitalsignature.

ShowAll

SignMethod(SignedDataBlockObject)

InvokestheDigitalSignaturesdialogboxtoaddadigitalsignaturetoasetofsigneddatainaMicrosoftOfficeInfoPath2003form.Thenewsignatureusesthedefaultsignaturetemplate,anditisappliedtotheSignedDataBlockobject.

expression.Sign()

SubmitMethod(ADOAdapterObject)

Executesthesubmitoperationontheassociatedadapter.

expression.Submit()

expressionRequired.AnexpressionthatreturnsareferencetoaADOAdapterobject.

RemarksFailsiftheSubmitAllowedpropertyoftheADOAdapterobjectisFalse.

SubmitMethod(DAVAdapterObject)

expression.Submit()

RemarksTheSubmitmethodoftheDAVAdapterobjectsubmitstheform'sentireunderlyingXMLdocument,whereastheSubmitDatamethodoftheDAVAdapterobjectcansubmitanyXMLDOMelementordocument.

SubmitMethod(EmailAdapterObject)

expression.Submit()

RemarksTheSubmitmethodoftheEmailAdapterobjectsubmitstheform'sentireunderlyingXMLdocument,whereastheSubmitDatamethodoftheEmailAdapterobjectcansubmitanyXMLDOMelementordocument.

SubmitMethod(HWSAdapterObject)

Executesthesubmitoperationfortheassociatedadapter.

expression.Submit()

expressionRequired.AnexpressionthatreturnsareferencetoanHWSAdapterobject.

ShowAll

SubmitMethod(Index)

TheSubmitmethodexecutesthesubmitoperationontheassociateddataadapter.ThismethodisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickaSubmitmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheSubmitmethod.

SubmitmethodasitappliestotheADOAdapterobject.

SubmitmethodasitappliestotheDAVAdapterobject.

SubmitmethodasitappliestotheEmailAdapterobject.

SubmitmethodasitappliestotheHWSAdapterobject.

SubmitmethodasitappliestotheSharepointListAdapterobject.

SubmitmethodasitappliestotheWebServiceAdapterobject.

SubmitmethodasitappliestotheXDocumentobject.

SubmitmethodasitappliestotheXMLFileAdapterobject.

SubmitMethod(SharePointListAdapterObject)

TheSubmitmethodisavailablefortheSharepointListAdapterobjectbut,becausetheSharePointListAdapterobjectisavailableforreceivingdataonly,themethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

expression.Submit()

SubmitMethod(WebServiceAdapterObject)

expression.Submit()

RemarksFailsiftheSubmitAllowedpropertyoftheWebServiceAdapterobjectisFalse.

ShowAll

SubmitMethod(XDocumentObject)

ExecutesthepredefinedsubmitoperationinaMicrosoftOfficeInfoPath2003form.

expression.Submit()

RemarksUsingtheSubmitmethodissimilarto,butnotexactlylike,usingthesubmitoperationfromtheInfoPathuserinterface.CallingtheSubmitmethodsimplyperformsthesubmitoperation,butthesubmitoperationmustfirstbeenabledforaformindesignmode.

NoteYoucanwriteacustomsubmitoperationusingtheOnSubmitRequestevent,andthenyoucanprogrammaticallycalltheeventusingtheSubmitmethod.

ExampleInthefollowingexample,theSubmitmethodoftheXDocumentobjectisusedtosubmittheformusingthepredefinedsubmitoperation:

XDocument.Submit();

SubmitMethod(XMLFileAdapterObject)

TheSubmitmethodisavailablefortheXMLFileAdapterobjectbut,becausetheXMLFileAdapterobjectisavailableforreceivingdataonly,themethodwillalwaysgeneratearun-timeerrorwhenitiscalledonthatobject.

expression.Submit()

expressionRequired.AnexpressionthatreturnsareferencetoaXMLFileAdapterobject.

ShowAll

SubmitDataMethod(DavAdapterObject)

SubmitsthespecifiedDOMelementorDOMdocumenttoadataadapter.

expression.SubmitData(ByValpDataAsIXMLDOMNode)

pDataRequiredIXMLDOMNode.TheXMLdatathatistobemergedintothecurrentlyopenform.

ShowAll

SubmitDataMethod(EmailAdapterObject)

SubmitsthespecifiedDOMelementorDOMdocumenttoadataadapter.

expression.SubmitData(ByValpDataAsIXMLDOMNode)

pDataRequiredIXMLDOMNode.TheXMLdatathatistobemergedintothecurrentlyopenform.

ShowAll

SubmitDataMethod(Index)

TheSubmitDatamethodexecutesthesubmitoperationfortheassociateddataadapter.ThismethodisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickaSubmitDatamethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheSubmitDatamethod.

SubmitDatamethodasitappliestotheDAVAdapterobject.

SubmitDatamethodasitappliestotheEmailAdapterobject.

SwitchViewMethod

ChangestheactiveviewofaMicrosoftOfficeInfoPath2003formtoaspecifiedview.

expression.SwitchView(ByValbstrNameAsString)

bstrNameRequiredString.Thenameoftheviewtoswitchto.Ifanemptystringisused,thedefaultviewisdisplayed.

RemarksIfanemptystringisusedasthebstrNameparameter,theviewischangedtothedefaultviewoftheform.

ExampleInthefollowingexample,theSwitchViewmethodoftheViewobjectisusedtochangethecurrentviewtothedefaultview:

XDocument.View.SwitchView("");

TodayMethod

ReturnsaVariantcontainingthecurrentsystemdateinISOformat(yyyy-mm-dd).

expression.Today()AsVariant

expressionRequired.AnexpressionthatreturnsareferencetotheDateobject.

returnsAVariantcontainingthecurrentsystemdate.

ExampleInthefollowingexample,thevariablecurrentDateissettothecurrentsystemdate.

varcurrentDate=XDocument.Util.Date.Today();

UninitMethod

Definesamethodthatmustbeprovidedbythedevelopertoperformanycleanuproutinesthatarerequiredbeforeaninstanceofthecontrolisremovedfromaview.

expression.Uninit()

RemarksInfoPathcallstheUninitmethodimmediatelybeforethecontrolisremovedfromtheviewanddestroyed.NotethatbecauseInfoPathformsmakeuseofXSLtransformstorepresentviews,anychangesinthedataorexplicitcallstotheobjectmodelcancauseInfoPathtoautomaticallysynchronizetheviewwiththedatathatiscontainedinaform'sunderlyingXMLdocument,whichdestroysandrecreatestheview.ThismeansthatActiveXcontrolsarelikelytobecreatedanddestroyedmuchmoreoftenwithinagivensessionthancontrolsinVisualBasicformsorWebforms.ActiveXcontrolswhichneedtopreservestateinformationindependentofthebounddata,suchasthestateofthescrollposition,shouldcreateroutinesintheInitmethodofthecontrolthatusetheSetNamedNodePropertymethodtosavethisinformation,andusetheGetNamedNodePropertymethodtorestorestateinformationduringtheInitmethodcall.

ShowAll

UnregisterSolutionMethod(ApplicationObject)

UninstallsthespecifiedMicrosoftOfficeInfoPath2003formtemplate.

expression.UnregisterSolution(ByValbstrSolutionURIAsString)

bstrSolutionURIRequiredString.ThestringthatspecifiestheUniformResourceIdentifier(URI)oftheformtemplate.

RemarksIftheformtemplatecannotbeunregistered,theUnregisterSolutionmethodwillreturnanerror.

ExampleInthefollowingVisualBasicforApplications(VBA)example,theUnregisterSolutionmethodoftheApplicationobjectisusedtouninstallaformtemplate:

PublicSubUninstallForm()

DimobjIPAsObject

'CreateareferencetotheExternalApplicationobject.SetobjIP=CreateObject("InfoPath.Application")

'UnregistertheInfoPathformtemplate.objIP.UnregisterSolution("C:\\MyForms\\MyFormTemplate.xsn")MsgBox("TheInfoPathformtemplatehasbeenunregistered.")

SetobjIP=Nothing

EndSub

ShowAll

UnregisterSolutionMethod(ExternalApplicationObject)

UninstallsthespecifiedMicrosoftOfficeInfoPath2003formtemplate.

expression.UnregisterSolution(ByValbstrSolutionURIAsString)

bstrSolutionURIRequiredString.ThestringvaluethatspecifiestheUniformResourceIdentifier(URI)oftheformtemplate.

RemarksIftheformtemplatecannotbeunregistered,theUnregisterSolutionmethodwillreturnanerror.

ExampleInthefollowingexample,whichiswrittenintheVisualBasicforApplications(VBA)programminglanguage,theUnregisterSolutionmethodoftheExternalApplicationobjectisusedtouninstallaformtemplate:

PublicSubUninstallForm()

DimobjIPAsObject

'UnregistertheInfoPathformtemplate.objIP.UnregisterSolution("C:\\MyForms\\MyFormTemplate.xsn")MsgBox("TheInfoPathformtemplatehasbeenunregistered.")

SetobjIP=Nothing

EndSub

ShowAll

UnregisterSolutionMethod(Index)

TheUnregisterSolutionmethoduninstallsthespecifiedMicrosoftOfficeInfoPath2003formtemplate.ThismethodisimplementedinseveralMicrosoftOfficeInfoPath2003objectmodelcollections.ClickanUnregisterSolutionmethodlinkbelowtoviewtheHelptopicforaspecificimplementationoftheUnregisterSolutionmethod.

UnregisterSolutionmethodasitappliestotheApplicationobject.

UnregisterSolutionmethodasitappliestotheExternalApplicationobject.

ShowAll

OnAfterChangeEvent

Occursafterchangestoaform'sunderlyingXMLdocumenthavebeenacceptedandaftertheOnValidateeventhasoccurred.

Functionnode::OnAfterChange(ByRefpDataDOMEventAsDataDOMEvent)

pDataDOMEventRequiredDataDOMEvent.AreferencetotheDataDOMEventobject.

RemarksThiseventhandlerdoesnotallowuserstocancelanoperation.

TheOnAfterChangeeventistypicallyusedforchangingdatainaformafterotherchangeshaveoccurred—forexample,makingcalculationsorchangingthestructureofaform'sunderlyingXMLdocument.

NoteInsomecases,eventsrelatedtochangesinaform'sunderlyingXMLdocumentmayoccurmorethanonce.Forexample,whenexistingdataischanged,aninsertanddeleteoperationoccurs.

ExampleInthefollowingexamplefromtheEventsdevelopersampleform,theOnAfterChangeeventhandlerisusedtocallacustomfunctionthatperformscalculations:

functionmsoxd__ContactDates::OnAfterChange(eventObj){if(eventObj.IsUndoRedo){//AnundoorredooperationhasoccurredandtheDOMisread-only.return;}CalculateTotalCampaignCost();}

ShowAll

OnAfterImportEvent

Occursaftertheimport(ormerge)operationhassuccessfullycompleted.

FunctionXDocument::OnAfterImport(ByRefpEventAsDocEvent)

pEventRequiredDocEvent.AreferencetotheDocEventobject.

Ifthemergeoperationincludesmergingmultipleforms,theOnAfterImporteventoccursonlyafterallformshavebeenmergedandthecompleteoperationissuccessful.

NoteTheOnAfterImporteventhandlercannotbecreatedusingMicrosoftOfficeInfoPath2003designmode;itmustbecreatedmanually.

CreatingtheOnAfterImporteventhandler

ExampleInthefollowingexample,theOnAfterImporteventhandlerisusedtodisplayamessageboxthatinformstheuserthatthemergeoperationcompletedsuccessfully:

functionXDocument::OnAfterImport(eventObj){XDocument.UI.Alert("Mergeoperationwassuccessful.")}

ShowAll

OnBeforeChangeEvent

Occursafterchangestoaform'sunderlyingXMLdocumenthavebeenmadebutbeforethechangesareaccepted.

Functionnode::OnBeforeChange(ByRefpDataDOMEventAsDataDOMEvent)

RemarksThiseventhandlerallowsuserstocancelanoperation.

DuringtheOnBeforeChangeevent,theform'sunderlyingXMLdocumentisplacedinread-onlymode.IftheReturnStatuspropertyoftheDataDOMEventobjectissettoFalse,MicrosoftOfficeInfoPath2003rejectsthechangesthatweremadeandamessageboxisdisplayedtotheuser.IfanerroroccursinthescriptingcodefortheOnBeforeChangeeventhandler,InfoPathrejectsthechangesandrestoresthedatatoitspreviousstate.

ItisbesttoavoidswitchingviewsduringtheOnBeforeChangeevent;changeshavenotyetbeenaccepted,andswitchingtoanotherviewmayresultinanerror.

Insomecases,eventsrelatedtochangesinaform'sunderlyingXMLdocumentmayoccurmorethanonce.Forexample,whenexistingdataischanged,aninsertanddeleteoperationoccurs.

IfavalidationerrorisencounteredinanyOnBeforeChangeeventhandler,thedocumentfailstoload.Atry-catchblockintheOnLoadeventcanbeusedtocatchthisvalidationfailureandtoloadthedocumentdespitetheerror.

ExampleInthefollowingexamplefromtheEventsdevelopersampleform,theOnBeforeChangeeventhandlerisusedtovalidatethedatainafield.Ifthedataisnotvalid,theReturnStatuspropertyoftheDataDOMEventobjectisusedtorejectthechanges.

functionmsoxd__RepVisitDt::OnBeforeChange(eventObj){varoNode=XDocument.DOM.selectSingleNode("/Customers/CustomerInfo/ContactDates/PhoneContactDt");

if(!oNode.text){eventObj.ReturnMessage="ThePhoneContactStartdatemustbesetpriortotheRepresentativeVisitdate.";eventObj.ReturnStatus=false;return;}

//Ifthedataisvalid,eventObj.ReturnStatus=true.eventObj.ReturnStatus=true;return;}

ShowAll

OnClickEvent

OccurswhenabuttoncontrolisclickedwithinaviewinaMicrosoftOfficeInfoPath2003form.

FunctionScriptID::OnClick(ByRefeventObjAsDocActionEvent)

eventObjRequiredDocActionEvent.AreferencetotheDocActionEventobject.

NoteTheOnClickeventfortheInfoPathbuttoncontrolistheonlycontroleventthatissupported.

ExampleInthefollowingexamplefromtheEventsdevelopersampleform,theOnClickeventhandlerisusedtoperformdatavalidationonsomeofthefieldscontainedintheNewCustomerviewwhenauserclicksabuttontoswitchtoanotherview:

functionbtnSwitchContact::OnClick(eventObj){if(XDocument.View.Name=="NewCustomer"){if(XDocument.DOM.selectSingleNode('/Customers/CustomerInfo/CustomerName').text==""&&XDocument.DOM.selectSingleNode('/Customers/CustomerInfo/CustomerID').text==""){XDocument.UI.Alert("TheCustomerNameandIDmust"+"befilledinpriortoswitchingtheview.");return;}elseif(XDocument.DOM.selectSingleNode('/Customers/CustomerInfo/CustomerName').text==""){XDocument.UI.Alert("TheCustomerNamemustbefilled"+"inpriortoswitchingtheview.");return;}elseif(XDocument.DOM.selectSingleNode('/Customers/CustomerInfo/CustomerID').text==""){XDocument.UI.Alert("TheCustomerIDmustbefilledin"+"priortoswitchingtheview.");return;

}}XDocument.View.SwitchView('ContactCustomer');}

ShowAll

OnContextChangeEvent

Occursafterthecontextnodechanges.

FunctionXDocument::OnContextChange(ByRefpEventAsDocContextChangeEvent)

pEventRequiredDocContextChangeEvent.AreferencetotheDocContextChangeEventobject.

RemarksThecontextnodeistheXMLDOMnodemappedtotheviewthatcorrespondstothecontainer(oritem)withthecurrentXMLselection.Forexample,ifthecurrentselectionintheviewisinatextbox,thecontextnodeisthenodetowhichthetextboxisbound.Ifthecurrentselectionisarepeatingsection,thecontextnodeisthenodeforthatitem.Iftworepeatingsectionsareselected,thecontextnodeistheancestorXMLDOMforbothitemsmappedtotheview.

TheOnContextChangeeventisasynchronous.Itdoesnotfireoneverychangeinthecontextnode;instead,itfiresaftertheapplicationhasstoppedprocessingotherevents.

Whenthedocumentloads,orwhenaviewchangeoccurs,theOnContextChangeeventwilloccuraftertheOnLoadandOnSwitchVieweventsoccur.

WhentheIsUndoRedopropertyoftheDocContextChangeEventobjectisTrue,thecontextchangewascausedbyauser'sundoorredooperationratherthananexplicitusercontextchange.OperationsperformedwithintheOnContextChangeeventhandlerthatmodifytheXMLDOMshouldbeavoidedinresponsetoundoorredooperations,becausetheymayinterferewiththeuser'sintentiontorevertdatatoapreviousstate.

Forrichtextboxcontrols,theOnContextChangeeventisnotraisedforcontextchangeswithintheXHTMLcontent—thatis,selectionchangestotherichtextinthecontrol.TheGetContextNodesmethodcanbeusedtodeterminetheselectionwithinrichtextboxcontrols.

ExampleInthefollowingexample,instructionsspecifictodifferentcontextnodesinaformareaddedtothebodyofacustomtaskpane:

functionXDocument::OnContextChange(eventObj){varoContextNode=eventObj.Context;

varstrText="";if(oContextNode.nodeName=="my:root")strText="";elseif(oContextNode.nodeName=="my:singleName")strText="Typeyourfullname.";elseif(oContextNode.nodeName=="my:webSite")strText="TypetheWebaddressofyourpersonalwebpage.";

varoTaskPane=XDocument.View.Window.TaskPanes.Item(0);oTaskPane.HTMLDocument.body.innerText=strText;}

ShowAll

OnLoadEvent

OccursafteraMicrosoftOfficeInfoPath2003formhasbeenloaded,butbeforeanyviewshavebeeninitialized.

FunctionXDocument::OnLoad(ByRefpEventAsDocReturnEvent)

pEventRequiredDocReturnEvent.AreferencetotheDocReturnEventobject.

IftheReturnStatuspropertyoftheDocReturnEventobjectissettoFalse,InfoPathcancelstheloadingoftheform.IfanerroroccursinthescriptingcodefortheOnLoadeventhandler,InfoPathignoresitandreliesontheReturnStatuspropertyoftheDocReturnEventobject.IftheReturnStatuspropertyisnotexplicitlyset,thedefaultvalueofTrueisused.

NoteWhentheOnLoadeventoccurs,theviewisnotinitializedandtheXSLTransformation(XSLT)usedfortheviewisnotyetloaded.TheXDocumentobjectisnotaddedtotheXDocumentscollectionuntilaftertheOnLoadeventhasoccurred.However,theXDocumentobjectisavailableduringtheOnLoadevent.

ExampleInthefollowingexamplefromtheSalesReportsampleform,theOnLoadeventhandlerisusedtodeterminewhethertheformhasbeendigitallysigned,andifithasn't,toinitializesomedatevaluesusingacombinationofscriptingfunctionsandcustomfunctions:

functionXDocument::OnLoad(objEvent){//AvoidDOMupdateswhenthedocumenthasbeendigitallysigned.if(XDocument.IsSigned)return;

vartoday=newDate();initializeNodeValue("/sls:salesReport/sls:date",getDateString(today));initializeNodeValue("/sls:salesReport/sls:year",today.getFullYear());}

ThisOnloadeventhandlerexampledependsontwocustomfunctions,whicharealsofromtheSalesReportsampleform:initializeNodeValueandsetNodeValue.

functioninitializeNodeValue(xpath,strValue){varxmlNode=getNode(xpath);

//Setthenodevalue*ONLY*ifthenodeisempty.if(xmlNode.text=="")setNodeValue(xmlNode,strValue);}

functionsetNodeValue(xpath,value){varxmlNode=getNode(xpath);

if(!xmlNode)return;

//Thexsi:nilneedstoberemovedbeforewesetthevalue.if(value!=""&&xmlNode.getAttribute("xsi:nil"))xmlNode.removeAttribute("xsi:nil");

//Settingthevaluewouldmarkthedocumentasdirty.//Let'sdothatifthevaluehasreallychanged.if(xmlNode.text!=value)xmlNode.text=value;}

ShowAll

OnMergeRequestEvent

OccurswhenthemergeoperationisinvokedeitherfromtheMicrosoftOfficeInfoPath2003userinterfaceorfromthecommandlinebyusingthe/aggregateoption.

FunctionXDocument::OnMergeRequest(ByRefpEventAsMergeEvent)

pEventRequiredMergeEvent.AreferencetotheMergeEventobject.

RemarksIftheReturnStatuspropertyoftheMergeEventobjectissettoFalse,InfoPathcancelsthemergeoperation.IfanerroroccursinthecodefortheOnMergeRequesteventhandler,InfoPathignorestheerrorandreliesontheReturnStatuspropertyoftheMergeEventobject.IftheReturnStatuspropertyisnotexplicitlyset,thedefaultvalueofFalseisused.

ForInfoPathformsstoredinaWindowsSharePointServicesformlibrary,theOnMergeRequesteventalsooccurswhentheMergeDocuments2methodoftheOpenXMLDocumentscontrolisexecuted.FormoreinformationontheOpenXMLDocumentscontrol,seetheSharePointProductsandTechnologies2003SoftwareDevelopmentKit,whichisavailableontheMicrosoftSharePointProductsandTechnologiesWebsite.

IfyoucreateaneventhandlerfortheOnMergeRequesteventofaformtemplate,youmustedittheformdefinitionfile(.xsf)tosettheuseScriptHandlerattributeto"yes"beforeitwillrun.

ExampleInthefollowingexample,theOnMergeRequesteventhandlerperformsamergeoperation,anditsetsvariablestoindicatethestatusofthemergeoperation:

varg_fMerging=false;

functionXDocument::OnMergeRequest(eventObj){//Setglobalpropertytoindicatethatformsarebeingmerged.if(eventObj.Index==0)g_fMerging=true;

XDocument.ImportDOM(eventObj.DOM);eventObj.ReturnStatus=true;if(eventObj.Index+1==eventObj.Count){g_fMerging=false;XDocument.UI.Alert("Yourrequesttomerge"+eventObj.Count+"filesisnowcomplete.");}}

OnSaveRequestEvent

OccurswhenthesaveoperationisinvokedfromtheMicrosoftOfficeInfoPath2003userinterfaceorbyusingtheSaveorSaveAsmethodoftheXDocumentobjectintheInfoPathobjectmodel.

FunctionXDocument::OnSaveRequest(ByRefpEventAsSaveEvent)

pEventRequiredSaveEvent.AreferencetotheSaveEventobject.

RemarksIftheReturnStatuspropertyoftheSaveEventobjectissettoFalse,InfoPathcancelsthesaveoperation.IfanerroroccursinthecodefortheOnSaveRequesteventhandler,InfoPathignorestheerrorandreliesontheReturnStatuspropertyoftheSaveEventobject.IftheReturnStatuspropertyisnotexplicitlyset,thedefaultvalueofFalseisused.

TheReturnStatuspropertyworksinconjunctionwiththeIsCancelledpropertywhentheInfoPathformisclosing.Ifthedocumenthaschangesthathavenotbeensavedandtheusercancelsthesaveoperation,theIsCancelledpropertycanbesettoTruetoallowInfoPathtoclose.

ExampleInthefollowingexample,theOnSaveRequesteventhandlerisusedtocreateanXMLHTTPobjectfortransportingtheform'sunderlyingXMLdocument:

functionXDocument::OnSaveRequest(eventObj){ //Writethecodetoberunbeforesavinghere.

XDocument.UI.Alert("Beginsavingform.");

eventObj.IsCancelled=eventObj.PerformSaveOperation();

//Writethecodetoberunaftersavinghere.

XDocument.UI.Alert("Formsaved.");

eventObj.ReturnStatus=true;}

OnSignEvent

Occursafterasetofsigneddatahasbeenselectedtosign.

FunctionXDocument::OnSign(ByRefpEventAsSignEvent)

pEventRequiredSignEvent.AreferencetotheSignEventobject.

RemarksYoucanusethiseventtoaddadditionaldatatothedigitalsignature.Forexample,youcanadddatafromatrustedtimestampserver,oraddaserver-sidecountersignatureofthetransaction.Youcanalsousethiseventtoblocksigningifthecurrentuserisnotamemberofaparticulargroup.

ShowAll

OnSubmitRequestEvent

OccurswhenthesubmitoperationisinvokedeitherfromtheMicrosoftOfficeInfoPath2003userinterfaceorbyusingtheSubmitmethodoftheXDocumentobjectintheInfoPathobjectmodel.

FunctionXDocument::OnSubmitRequest(ByRefpEventAsDocReturnEvent)

pEventRequiredDocReturnEvent.AreferencetotheDocReturnEventobject.

IftheReturnStatuspropertyoftheDocReturnEventobjectissettoFalse,InfoPathcancelsthesubmitoperation.IfanerroroccursinthescriptingcodefortheOnSubmitRequesteventhandler,InfoPathignoresitandreliesontheReturnStatuspropertyoftheDocReturnEventobject.IftheReturnStatuspropertyisnotexplicitlyset,thedefaultvalueofFalseisused.

ExampleInthefollowingexample,theOnSubmitRequesteventhandlerisusedtocreateanXMLHTTPobjectfortransportingtheform'sunderlyingXMLdocument:

functionXDocument::OnSubmitRequest(eventObj){//CreateanXMLHTTPobjectfordocumenttransport.try{varobjXmlHttp=newActiveXObject("MSXML2.XMLHTTP");}catch(ex){XDocument.UI.Alert("CouldnotcreateMSXML2.XMLHTTPobject.\r\n"+ex.number+"-"+ex.description);

//ReturnwitheventObj.ReturnStatus==false,//becausenochangewasmadetothisvalue.return;}

//PosttheXMLdocumenttostrUrl.objXmlHttp.open("POST",strUrl,false);try{objXmlHttp.send(XDocument.DOM.xml);}catch(ex){XDocument.UI.Alert("Couldnotpost(ASP)documentto"+

strUrl+"\r\n"+ex.number+"-"+ex.description);

//ReturnwitheventObj.ReturnStatus==false.return;}//Ifhere,thesubmitoperationishasbeensuccessful.eventObj.ReturnStatus=true;}

ShowAll

OnSwitchViewEvent

OccursafteraviewinaMicrosoftOfficeInfoPath2003formhasbeensuccessfullyswitched.

FunctionXDocument::OnSwitchView(ByRefpEventAsDocEvent)

pEventRequiredDocEvent.AreferencetotheDocEventobject.

NoteTheOnSwitchVieweventalsooccurswhenaformisfirstopened.

ExampleInthefollowingexamplefromtheEventsdevelopersampleform,theOnSwitchVieweventhandlerisusedtocheckthenameofthecurrentview.Iftheviewhasthename"ArchiveCustomer,"dataisaddedtotheform'sunderlyingXMLdocument.

functionXDocument::OnSwitchView(eventObj){varoDate=newDate();

if(XDocument.View.Name=="ArchiveCustomer"){varoNotesNode=XDocument.DOM.selectSingleNode("/Customers/CustomerInfo/Notes");varoDivNode=XDocument.DOM.createNode(1,"div","http://www.w3.org/1999/xhtml");

oDivNode.text="Noterecorded"+oDate.toString();oNotesNode.appendChild(oDivNode);}}

ShowAll

OnValidateEvent

Occursafterchangestoaform'sunderlyingXMLdocumenthavebeenacceptedbutbeforetheOnAfterChangeeventoccurs.

Functionnode::OnValidate(ByRefpDataDOMEventAsDataDOMEvent)

DuringtheOnValidateevent,theform'sunderlyingXMLdocumentisplacedinread-onlymode.

TheOnValidateeventistypicallyusedforhandlingerrorsandworkingwiththeErrorscollection—forexample,addingnewerrorsordeletingexistingones.

NoteInsomecases,eventsrelatedtochangesinaform'sunderlyingXMLdocumentmayoccurmorethanonce.Forexample,whenexistingdataischanged,aninsertanddeleteoperationoccurs.

ExampleInthefollowingpartialexamplefromtheEventsdevelopersampleform,theOnValidateeventhandlerisusedtovalidatecontactinformation.Ifthedataisinvalid,theReportErrormethodoftheDataDOMEVentobjectisusedtocreateanerror.

functionmsoxd__ContactDates::OnValidate(eventObj){variNumberOfDays=0;varobjEmailDate=XDocument.DOM.selectSingleNode('/Customers/CustomerInfo/ContactDates/EmailCampaignDt');varobjPhoneContactDate=XDocument.DOM.selectSingleNode('/Customers/CustomerInfo/ContactDates/PhoneContactDt');varobjRepVisitDate=XDocument.DOM.selectSingleNode('/Customers/CustomerInfo/ContactDates/RepVisitDt');

//Firstvalidatetheemailandphonecontactdates.if(!objEmailDate||!objPhoneContactDate)return;

varemailDate=newDate(objEmailDate.text.replace(/(.*)-(.*)-(.*)/,"$2-$3-$1"));varphoneContactDate=newDate(objPhoneContactDate.text.replace(/(.*)-(.*)-(.*)/,"$2-$3-$1"));

if(isNaN(emailDate)||isNaN(phoneContactDate))return;

//Getthenumberofdaysbetweenthetwodates.iNumberOfDays=GetElapsedDays(emailDate,phoneContactDate);

if(iNumberOfDays<REQUIRED_PHONE_EMAIL_INTERVAL)

eventObj.ReportError(objPhoneContactDate,"ThePhoneContactStartdatemustoccurafter"+REQUIRED_PHONE_EMAIL_INTERVAL+"daysfromthestartoftheEmailCampaign.",false);...}

ShowAll

OnVersionUpgradeEvent

OccurswhentheversionnumberofaMicrosoftOfficeInfoPath2003formbeingopenedisolderthantheversionnumberoftheformtemplateonwhichitisbased.

FunctionXDocument::OnVersionUpgrade(ByRefpEventAsVersionUpgradeEvent)

pEventRequiredVersionUpgradeEvent.AreferencetotheVersionUpgradeEventobject.

DuringtheOnVersionUpgradeevent,theform'sunderlyingXMLdocumentisplacedinread-onlymode,anditisnotvalidatedagainsttheform'sassociatedXMLSchema.IftheReturnStatuspropertyoftheVersionUpgradeEventobjectissettoFalse,InfoPathcancelstheopeningoftheform.IfanerroroccursinthescriptingcodefortheOnVersionUpgradeeventhandler,InfoPathignoresitandreliesontheReturnStatuspropertyoftheVersionUpgradeEventobject.IftheReturnStatuspropertyisnotexplicitlyset,thedefaultvalueofTrueisused.

ExampleInthefollowingexamplefromtheEventsdevelopersampleform,theOnVersionUpgradeeventhandlerisusedtodeterminewhethertheformwiththeincorrectolderversionnumbercontainsanEmailAddresselement.Ifitdoesnot,oneisadded.

functionXDocument::OnVersionUpgrade(eventObj){if(!XDocument.DOM.selectSingleNode("/Customers/CustomerInfo/EmailAddress")){try{//Createthenewelement.varobjItemNode=XDocument.DOM.selectSingleNode("/Customers/CustomerInfo").ownerDocument.createElement("EmailAddress");

//Addthenew<item>elementtotheXMLdocumentasa//childofthe<order>element.XDocument.DOM.selectSingleNode("/Customers/CustomerInfo").appendChild(objItemNode);eventObj.ReturnStatus=true;}catch(ex){XDocument.UI.Alert("Therewasanerrorinsertingthe"+"<EmailAddress>node.\nDescription:"+ex.description);eventObj.ReturnStatus=false;}}}

ShowAll

XdCertificateStatusEnumeration

TheXdCertificateStatusenumerationisusedtodeterminethestatusofadigitalcertificate.TheseenumeratedvaluesarereturnedbytheStatuspropertyoftheCertificateobject.

Name Value DescriptionxdCertificateStatusError 0 Thestatusofthespecifieddigital

certificatecannotbedetermined.xdCertificateStatusValid 1 Thespecifieddigitalcertificateis

valid.xdCertificateStatusExpired 2 Thespecifieddigitalcertificate

hasexpired.xdCertificateStatusNotTrusted 3 Thespecifieddigitalcertificateis

nottrusted.xdCertificateStatusRevoked 4 Thespecifieddigitalcertificate

hasbeenrevoked.

XdConfirmButtonsEnumeration

TheXdConfirmButtonsenumerationisusedtodeterminethetypeofbuttonstobedisplayedinamessagebox.TheseenumeratedvaluesareusedbytheConfirmmethodoftheUIobject.

Name Value DescriptionxdOKCancel 1 OKandCancelbuttonsaredisplayed.xdYesNoCancel 3 Yes,No,andCancelbuttonsaredisplayed.xdYesNo 4 YesandNobuttonsaredisplayed

XdConfirmChoiceEnumeration

TheXdConfirmChoiceenumerationisusedtodeterminewhichbuttonisclickedinamessagebox.TheseenumeratedvaluesareusedbytheConfirmmethodoftheUIobject.

Name Value DescriptionxdOK 1 TheOKbuttonwasclicked.xdCancel 2 TheCancelbuttonwasclicked.xdYes 6 TheYesbuttonwasclicked.xdNo 7 TheNobuttonwasclicked.

ShowAll

XdDocumentVersionModeEnumeration

TheXdDocumentVersionModeenumerationisusedtodeterminehowaMicrosoftOfficeInfoPath2003formwillbeopened.TheseenumeratedvaluesareusedasargumentstotheNewandOpenmethodsoftheExternalApplicationobject.

Name Value DescriptionxdCanOpenInReadOnlyMode 8 Theformisopenedin

read-onlymode.xdCanTransformSigned 16 Theformisopenedandits

transformapplied,eventhoughithasadigitalsignature.

xdFailOnVersionMismatch 0 Theformiscreatedoropenedonlyifitisaccessibleanditsversionnumbermatchestheversionnumberoftheformtemplate.

xdFailOnVersionOlder 1 Theformiscreatedoropenedonlyifitisaccessibleanditsversionnumberisnotolderthantheversionnumberoftheformtemplate.

xdIgnoreDataAdaptersQueryFailure 64 Theformisopenedevenifthequeryassociatedwithitsdataadapterfailstoreturndata.

xdPromptTransformSigned 32 TheformisopenedandtheDigitalSignaturesdialogboxisdisplayedbeforetheform'stransformisapplied.

xdUseExistingVersion 2 Theformiscreatedoropenedusingtheexisting

versionnumberoftheformtemplate.

XdMachineOnlineStateEnumeration

TheXdMachineOnlineStateenumerationisusedtodeterminethestateoftheconnectionfortheclientcomputer.TheseenumeratedvaluesarereturnedbytheMachineOnlineStatepropertyoftheApplicationobject.

Name Value DescriptionxdOffline 0 Theclientcomputerisnotconnectedtothe

network.xdOnline 1 Theclientcomputerisconnectedtothe

network.xdIEIsInOfflineMode 2 MicrosoftInternetExplorerisinoffline

XdSignatureRelationEnumeration

TheXdSignatureRelationenumerationisusedtodeterminehowdigitalsignaturescanbeaddedtoaSignedDataBlockobject.Theseenumeratedvaluesareread-only.

Name Value DescriptionxdSignatureRelationCoSign 2 Specifiesthatsignaturesare

independentofeachotherintheSignedDataBlockobject.

xdSignatureRelationCounterSign 3 SpecifiesthateachsignaturesignstheprecedingsignatureintheSignedDataBlockobject.

xdSignatureRelationSingle 1 SpecifiesthatonlyonesignaturecanexistintheSignedDataBlockobject.

ShowAll

XdSignatureStatusEnumeration

TheXdSignatureStatusenumerationisusedtodeterminethestatusofadigitalsignature.TheseenumeratedvaluesarereturnedbytheStatuspropertyoftheSignatureobject.

Name Value DescriptionxdSignatureStatusError 0 Thestatusofthespecified

digitalsignaturecannotbedetermined.

xdSignatureStatusValid 1 Thespecifieddigitalsignatureisvalid.

xdSignatureStatusInvalid 2 Thespecifieddigitalsignatureisinvalid.

xdSignatureStatusUnsupported 3 ThespecifieddigitalsignatureisnotsupportedbyMicrosoftOfficeInfoPath2003.

ShowAll

XdTaskPaneTypeEnumeration

TheXdTaskPaneTypeenumerationisusedtodeterminethetypeofMicrosoftOfficeInfoPath2003taskpanethatiscurrentlydisplayed.TheseenumeratedvaluesarereturnedbytheTypepropertyoftheTaskPaneobject.ThesevaluesarealsousedasthepositionalargumenttotheItempropertyoftheTaskPanescollection.

Name Value DescriptionxdTaskPaneBulletsNumbering 9 TheBulletsandNumbering

taskpane.Usedforapplyingbulletandnumberingstylestoaform.

xdTaskPaneClipArt 5 TheClipArttaskpane.Usedforinsertingclipartintoaform.

xdTaskPaneDesignerNew 2 TheDesignaFormtaskpane.Usedtodesignanewform,openaformindesignmode,orselectaformtofillout.

xdTaskPaneFillOutAForm 1 TheFillOutaFormtaskpane.Usedtoopenaformtofilloutordesign.

xdTaskPaneFind 6 TheFindtaskpane.Usedtosearchfortextinaform.

xdTaskPaneFormatting 8 TheFonttaskpane.Usedtoformattext.

xdTaskPaneHelp 4 TheHelptaskpane.UsedtodisplaytheInfoPathHelpsystem.

xdTaskPaneHTML 0 TheInfoPathcustomtaskpane.Usedbyformdeveloperstoprovideextraformfunctionality.

xdTaskPaneHWSWorkflow 12 TheMicrosoftBizTalkServer2004HumanWorkflowServices(HWS)Workflowtaskpane.

xdTaskPaneParaFormatting 11 TheParagraphtaskpane.Usedtoconfigurepropertiesofparagraphsincludingalignmentandspacing.

xdTaskPaneReplace 7 TheReplacetaskpane.Usedtofindandreplacetextinaform.

xdTaskPaneSearchResults 3 TheSearchResultstaskpane.Usedtodisplaytheresultsofasearch.

xdTaskPaneSpelling 10 TheSpellingtaskpane.Usedtocheckthespellinginaform.

XdWindowStateEnumeration

TheXdWindowStateenumerationisusedtodeterminethestateoftheMicrosoftOfficeInfoPath2003windowthatisrepresentedbytheWindowobject.TheseenumeratedvaluesarereturnedorsetbytheWindowStatepropertyoftheWindowobject.

Name Value DescriptionxdWindowStateMaximize 1 Thewindowismaximized.xdWindowStateNormal 2 Thewindowisnotmaximizedor

minimized.xdWindowStateMinimize 3 Thewindowisminimized.

ShowAll

XdWindowTypeEnumeration

TheXdWindowTypeenumerationisusedtodeterminethetypeofMicrosoftOfficeInfoPath2003windowthatiscurrentlydisplayed.TheseenumeratedvaluesarereturnedbytheTypepropertyoftheWindowobject.

Name Value DescriptionxdDesignerWindow 1 Thecurrentwindowisthewindowthatis

displayedindesignmode.xdEditorWindow 0 Thecurrentwindowisthewindowthatis

displayedwhenfillingoutaform.

InfoPathXSFDiagram

<xDocumentClass>*<applicationParameters> *

<solutionProperties>*<calculations>*<calculatedField>(s)

*<customValidation>*<errorCondition>(s)<errorMessage>

*<dataAdapters>*<davAdapter>(s)<fileName><folderURL>

*<emailAdapter>(s)*<attachmentFileName>*<bcc>*<cc>*<intro>*<subject>*<to>

*<hwsAdapter>(s)*<hwsOperation>

*<input>*<partFragment>(s)

*<webServiceAdapter>(s)<operation>*<input>*<partFragment>(s)

*<dataObjects>

Legend

*OptionalElement

(s)RepeatingElement

*<dataObject>(s)<query>*<adoAdapter>*<webServiceAdapter><operation>*<input>*<partFragment>(s)

*<sharepointListAdapter>*<field>(s)

*<xmlFileAdapter>*<documentSchemas><documentSchema>(s)

*<documentSignatures>*<signedDataBlock>(s)*<message>(s)

*<documentVersionUpgrade> *<useScriptHandler>*<useTransform>

*<domEventHandlers>*<domEventHandler>(s)*<ruleSetAction>(s)

*<extensions>*<extension>(s)

*<externalViews>*<externalView>(s)*<mainpane>

*<featureRestrictions>*<autoRecovery>*<exportToExcel>

*<exportToWeb>*<print>*<save>*<sendMail>

*<fileNew><initialXMLDocument>*<customCategory>(s)

*<hwsWorkflow><allowedActions><action>(s)

<allowedTasks><task>(s)

<location>*<importParameters>*<importSource>(s)

*<listProperties>*<fields>*<field>(s)

*<onLoad><ruleSetAction>

<package><files>*<file>(s)*<fileProperties>*<property>(s)

*<permissions><allowedControl>(s)

*<query>*<adoAdapter>

*<queryAction>*<sharepointListAdapter>

*<field>(s)*<webServiceAdapter>

<operation>*<input>*<partFragment>(s)

*<xmlFileAdapter>*<roles><role>(s)<membership>(s)<getUserNameFromData>(s)<group>(s)<username>(s)

*<ruleSets>*<ruleSet>(s)<rule>(s)*<assignmentAction>(s)*<closeDocumentAction>(s)*<dialogBoxExpressionAction>(s)*<dialogBoxMessageAction>(s)*<exitRuleSet>(s)*<openNewDocumentAction>(s)*<queryAction>(s)*<submitAction>(s)*<switchViewAction>(s)

*<save>*<useScriptHandler>

*<schemaErrorMessages>

*<override>(s)<errorMessage>

*<scripts>*<script>(s)

*<submit>*<davAdapter><fileName><folderURL>

*<emailAdapter>*<attachmentFileName>*<bcc>*<cc>*<intro>*<subject>*<to>

*<errorMessage>*<ruleSetAction>*<submitAction>*<successMessage>*<useHttpHandler>*<useScriptHandler>*<useQueryAdapter>*<webServiceAdapter><operation>*<input>*<partFragment>(s)

<taskpane><views><view>(s)

*<editing>*<xmlToEdit>(s)*<editWith>(s)*<fragmentToInsert><chooseFragment>(s)*<attributeData>

*<masterDetail><mainpane>*<menu>(s)*<button>(s)*<menu>(s)

*<menuArea>(s)*<button>(s)*<menu>(s)

*<toolbar>(s)*<button>(s)*<menu>(s)

*<unboundControls>*<button>(s)*<ruleSetAction>

ShowAll

InfoPathXSFSchema

TheMicrosoftOfficeInfoPath2003formdefinition(.xsf)fileschemaisanXMLSchema(.xsd)filethatisusedtovalidatethe.xsffilecontainedinanInfoPathformtemplate.

Thefollowingisacompletelistingofthecontentsofthe.xsfschemafile:

<?xmlversion="1.0"encoding="UTF-8"?><xsd:schemaxmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition" targetNamespace="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"elementFormDefault="qualified" attributeFormDefault="unqualified">  <xsd:simpleTypename="xdTitle"> <xsd:restrictionbase="xsd:string"> <xsd:minLengthvalue="1"/> <xsd:maxLengthvalue="255"/> <xsd:patternvalue="([^\p{Z}\p{Cc}\p{Cf}\p{Cn}])(([^\p{Zl}\p{Zp}\p{Cc}])*([^\p{Z}\p{Cc}\p{Cf}\p{Cn}]))?"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdViewName"> <xsd:restrictionbase="xsd:string"> <xsd:minLengthvalue="1"/> <xsd:maxLengthvalue="255"/> <xsd:patternvalue="([^\p{Z}\p{C}/\\#&"><])(([^\p{Zl}\p{Zp}\p{C}/\\#&"><])*([^\p{Z}\p{C}/\\#&"><]))?"/> </xsd:restriction> </xsd:simpleType>   <xsd:simpleTypename="xdRoleName"> <xsd:restrictionbase="xsf:xdViewName"></xsd:restriction> </xsd:simpleType>

<xsd:simpleTypename="xdYesNo"> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="yes"/> <xsd:enumerationvalue="no"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdEnabledDisabled"> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="enabled"/> <xsd:enumerationvalue="disabled"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdManualAuto"> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="manual"/> <xsd:enumerationvalue="automatic"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdExpressionLiteral"> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="expression"/> <xsd:enumerationvalue="literal"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdFileName"> <xsd:restrictionbase="xsd:string"> <xsd:minLengthvalue="1"/> <xsd:maxLengthvalue="64"/> </xsd:restriction>

</xsd:simpleType>  <xsd:simpleTypename="xdScriptLanguage"> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:patternvalue="(([Jj][Aa][Vv][Aa]|(([Jj])|([Vv][Bb]))([Ss][Cc][Rr][Ii][Pp][Tt]))([.][Ee][Nn][Cc][Oo][Dd][Ee]))|([Jj][Aa][Vv][Aa]|(([Jj])|([Vv][Bb]))([Ss][Cc][Rr][Ii][Pp][Tt]))|([Mm][Aa][Nn][Aa][Gg][Ee][Dd][Cc][Oo][Dd][Ee])"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdSolutionVersion"> <xsd:restrictionbase="xsd:string"> <xsd:patternvalue="(([0-9]{1,4}.){3}[0-9]{1,4})"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdEmptyString"> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="0"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdErrorMessage"> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="1023"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdDesignMode"> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="normal"/> <xsd:enumerationvalue="protected"/> </xsd:restriction> </xsd:simpleType>

<xsd:simpleTypename="xdTrustLevel"> <xsd:restrictionbase="xsd:string"> <xsd:enumerationvalue="restricted"/> <xsd:enumerationvalue="domain"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdSignedDataBlockName"> <xsd:restrictionbase="xsd:ID"> <xsd:minLengthvalue="1"/> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdSignedDataBlockMessage"> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdSignatureRelationEnum"> <xsd:restrictionbase="xsd:string"> <xsd:enumerationvalue="countersign"/> <xsd:enumerationvalue="cosign"/> <xsd:enumerationvalue="single"/> </xsd:restriction> </xsd:simpleType>  <xsd:simpleTypename="xdHWSname"> <xsd:restrictionbase="xsd:NCName"> <xsd:patternvalue="[^-^\.^\\^\[^\]^\|^\+^?^\*^@^\{^\}^$^$^>^<^=^;^,]*"/> </xsd:restriction> </xsd:simpleType>

<xsd:simpleTypename="xdHWSCaption"> <xsd:restrictionbase="xsd:string"> <xsd:minLengthvalue="1"/> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType>  <xsd:elementname="xDocumentClass"> <xsd:complexType> <xsd:all> <xsd:elementref="xsf:package"minOccurs="1"/> <xsd:elementref="xsf:permissions"minOccurs="0"/> <xsd:elementref="xsf:views"minOccurs="1"/> <xsd:elementref="xsf:hwsWorkflow"minOccurs="0"/> <xsd:elementref="xsf:externalViews"minOccurs="0"/> <xsd:elementref="xsf:scripts"minOccurs="0"/> <xsd:elementref="xsf:schemaErrorMessages"minOccurs="0"/> <xsd:elementref="xsf:documentSchemas"minOccurs="0"/> <xsd:elementref="xsf:applicationParameters"minOccurs="0"/> <xsd:elementref="xsf:featureRestrictions"minOccurs="0"/> <xsd:elementref="xsf:fileNew"minOccurs="0"/> <xsd:elementref="xsf:customValidation"minOccurs="0"/> <xsd:elementref="xsf:domEventHandlers"minOccurs="0"/> <xsd:elementref="xsf:importParameters"minOccurs="0"/> <xsd:elementref="xsf:listProperties"minOccurs="0"/> <xsd:elementref="xsf:taskpane"minOccurs="0"/> <xsd:elementref="xsf:documentSignatures"minOccurs="0"/> <xsd:elementref="xsf:dataObjects"minOccurs="0"/> <xsd:elementref="xsf:dataAdapters"minOccurs="0"/> <xsd:elementref="xsf:query"minOccurs="0"/> <xsd:elementref="xsf:submit"minOccurs="0"/> <xsd:elementref="xsf:save"minOccurs="0"/>

<xsd:elementref="xsf:roles"minOccurs="0"/> <xsd:elementref="xsf:onLoad"minOccurs="0"/> <xsd:elementref="xsf:documentVersionUpgrade"minOccurs="0"/> <xsd:elementref="xsf:extensions"minOccurs="0"/> <xsd:elementref="xsf:ruleSets"minOccurs="0"/> <xsd:elementref="xsf:calculations"minOccurs="0"/> </xsd:all> <xsd:attributename="name"type="xsd:string"use="optional"/> <xsd:attributename="author"type="xsd:string"use="optional"/> <xsd:attributename="description"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="solutionVersion"type="xsf:xdSolutionVersion"use="optional"/> <xsd:attributename="productVersion"type="xsd:string"use="optional"/> <xsd:attributename="solutionFormatVersion"type="xsf:xdSolutionVersion"use="required"/> <xsd:attributename="dataFormSolution"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="requireFullTrust"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="trustLevel"type="xsf:xdTrustLevel"use="optional"/> <xsd:attributename="trustSetting"type="xsf:xdManualAuto"use="optional"/> <xsd:attributename="publishUrl"type="xsd:string"use="optional"/> </xsd:complexType> <xsd:keyname="view_name_key"> <xsd:selectorxpath="./xsf:views/xsf:view"/> <xsd:fieldxpath="@name"/> </xsd:key> <xsd:keyname="externalView_name_key"> <xsd:selectorxpath="./xsf:externalViews/xsf:externalView"/> <xsd:fieldxpath="@name"/> </xsd:key>

<xsd:keyname="view_or_externalView_name_key"> <xsd:selectorxpath="./xsf:views/xsf:view|./xsf:externalViews/xsf:externalView"/> <xsd:fieldxpath="@name"/> </xsd:key> <xsd:keyname="ruleset_name_key"> <xsd:selectorxpath="./xsf:ruleSets/xsf:ruleSet"/> <xsd:fieldxpath="@name"/> </xsd:key> <xsd:keyname="dataObject_name_key"> <xsd:selectorxpath="./xsf:dataObjects/xsf:dataObject"/> <xsd:fieldxpath="@name"/> </xsd:key> <xsd:uniquename="adapter_name_unique"> <xsd:selectorxpath="./xsf:dataObjects/xsf:dataObject/xsf:query/*|./xsf:query/*|./xsf:dataAdapters/*|./xsf:submit/xsf:webServiceAdapter|./xsf:submit/xsf:davAdapter|./xsf:submit/xsf:emailAdapter"/> <xsd:fieldxpath="@name"/> </xsd:unique> <xsd:keyname="adapter_name_key"> <xsd:selectorxpath="./xsf:dataAdapters/*"/> <xsd:fieldxpath="@name"/> </xsd:key> <xsd:uniquename="view_external_name_unique"> <xsd:selectorxpath="./xsf:views/xsf:view|./xsf:externalViews/xsf:externalView"/> <xsd:fieldxpath="@name"/> </xsd:unique> </xsd:element>  <xsd:elementname="schemaErrorMessages"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:override"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element>

<xsd:elementname="override"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:errorMessage"/> </xsd:sequence> <xsd:attributename="match"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="applicationParameters"> <xsd:complexType> <xsd:all> <xsd:elementref="xsf:solutionProperties"minOccurs="0"/> </xsd:all> <xsd:attributename="application"use="required"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:enumerationvalue="InfoPathDesignMode"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element>  <xsd:elementname="solutionProperties"> <xsd:complexType> <xsd:attributename="allowCustomization"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="lastOpenView"use="optional"/> <xsd:attributename="scriptLanguage"type="xsf:xdScriptLanguage"use="optional"/> <xsd:attributename="automaticallyCreateNodes"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="lastVersionNeedingTransform"type="xsf:xdSolutionVersion"use="optional"/> <xsd:attributename="fullyEditableNamespace"type="xsd:anyURI"use="optional"/>

<xsd:attributename="publishSaveUrl"type="xsd:string"use="optional"/> </xsd:complexType> </xsd:element>  <xsd:elementname="featureRestrictions"> <xsd:complexType> <xsd:all> <xsd:elementname="save"minOccurs="0"> <xsd:complexType> <xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementref="xsf:exportToWeb"minOccurs="0"/> <xsd:elementref="xsf:exportToExcel"minOccurs="0"/> <xsd:elementref="xsf:print"minOccurs="0"/> <xsd:elementref="xsf:sendMail"minOccurs="0"/> <xsd:elementref="xsf:autoRecovery"minOccurs="0"/> </xsd:all> </xsd:complexType> </xsd:element>  <xsd:elementname="exportToWeb"> <xsd:complexType> <xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="exportToExcel"> <xsd:complexType> <xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"/> </xsd:complexType> </xsd:element>

<xsd:elementname="print"> <xsd:complexType> <xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="sendMail"> <xsd:complexType> <xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="autoRecovery"> <xsd:complexType> <xsd:attributename="feature"type="xsf:xdEnabledDisabled"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="query"> <xsd:complexType> <xsd:choice> <xsd:elementref="xsf:queryAction"/> <xsd:elementref="xsf:adoAdapter"/> <xsd:elementref="xsf:webServiceAdapter"/> <xsd:elementref="xsf:xmlFileAdapter"/> <xsd:elementref="xsf:sharepointListAdapter"/> </xsd:choice> </xsd:complexType> </xsd:element>  <xsd:elementname="scripts"> <xsd:complexType> <xsd:sequence>

<xsd:elementref="xsf:script"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="language"type="xsf:xdScriptLanguage"use="required"/> <xsd:attributename="enforceScriptTimeout"type="xsf:xdYesNo"use="optional"default="yes"/> </xsd:complexType> </xsd:element> <xsd:elementname="script"> <xsd:complexType> <xsd:attributename="src"type="xsf:xdFileName"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="dataObjects"> <xsd:complexType> <xsd:choiceminOccurs="0"maxOccurs="unbounded"> <xsd:elementref="xsf:dataObject"/> </xsd:choice> </xsd:complexType> <xsd:uniquename="dataObjects_name_unique"> <xsd:selectorxpath="./xsf:dataObject"/> <xsd:fieldxpath="@name"/> </xsd:unique> </xsd:element> <xsd:elementname="dataObject"> <xsd:complexType> <xsd:choice> <xsd:elementname="query"> <xsd:complexType> <xsd:choice> <xsd:elementref="xsf:adoAdapter"/> <xsd:elementref="xsf:webServiceAdapter"/> <xsd:elementref="xsf:xmlFileAdapter"/> <xsd:elementref="xsf:sharepointListAdapter"/>

</xsd:choice> </xsd:complexType> </xsd:element> </xsd:choice> <xsd:attributename="name"type="xsf:xdTitle"use="required"/> <xsd:attributename="schema"type="xsd:string"use="optional"/> <xsd:attributename="initOnLoad"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element>  <xsd:elementname="adoAdapter"> <xsd:complexType> <xsd:attributename="name"type="xsf:xdTitle"use="optional"/> <xsd:attributename="connectionString"type="xsd:string"use="required"/> <xsd:attributename="commandText"type="xsd:string"use="required"/> <xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="webServiceAdapter"> <xsd:complexType> <xsd:choice> <xsd:elementref="xsf:operation"/> </xsd:choice> <xsd:attributename="name"type="xsf:xdTitle"use="optional"/> <xsd:attributename="wsdlUrl"type="xsd:string"use="required"/> <xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="useDataSet"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="hwsAdapter"> <xsd:complexType>

<xsd:choice> <xsd:elementref="xsf:hwsOperation"/> </xsd:choice> <xsd:attributename="name"type="xsf:xdTitle"use="required"/> <xsd:attributename="wsdlUrl"type="xsd:string"use="required"/> <xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="operation"> <xsd:complexType> <xsd:choice> <xsd:elementref="xsf:input"minOccurs="0"/> </xsd:choice> <xsd:attributename="name"type="xsd:string"use="required"/> <xsd:attributename="soapAction"type="xsd:string"use="required"/> <xsd:attributename="serviceUrl"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="hwsOperation"> <xsd:complexType> <xsd:choice> <xsd:elementref="xsf:input"/> </xsd:choice> <xsd:attributename="type"type="xsd:string"use="required"/> <xsd:attributename="typeID"type="xsd:string"use="required"/> <xsd:attributename="serviceUrl"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="input"> <xsd:complexType> <xsd:choiceminOccurs="0"maxOccurs="unbounded"> <xsd:elementref="xsf:partFragment"/>

</xsd:choice> <xsd:attributename="source"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="partFragment"> <xsd:complexType> <xsd:attributename="match"type="xsd:string"use="required"/> <xsd:attributename="replaceWith"type="xsd:string"use="required"/> <xsd:attributename="sendAsString"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="dataObject"type="xsd:string"use="optional"/> <xsd:attributename="filter"type="xsd:string"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="xmlFileAdapter"> <xsd:complexType> <xsd:attributename="name"type="xsf:xdTitle"use="optional"/> <xsd:attributename="fileUrl"type="xsd:anyURI"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="sharepointListAdapter"> <xsd:complexType> <xsd:sequence> <xsd:elementname="field"minOccurs="0"maxOccurs="unbounded"> <xsd:complexType> <xsd:attributename="sharepointName"type="xsd:string"use="required"/> <xsd:attributename="infopathName"type="xsd:string"use="required"/> <xsd:attributename="isLookup"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attributename="name"type="xsf:xdTitle"use="required"/> <xsd:attributename="siteUrl"type="xsd:string"use="required"/> <xsd:attributename="sharepointGuid"type="xsd:string"use="required"/>

<xsd:attributename="infopathGroup"type="xsd:string"use="required"/> <xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="davAdapter"> <xsd:complexType> <xsd:all> <xsd:elementname="folderURL"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="fileName"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> <xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"/> </xsd:complexType> </xsd:element> </xsd:all> <xsd:attributename="name"type="xsf:xdTitle"use="required"/> <xsd:attributename="overwriteAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="emailAdapter"> <xsd:complexType> <xsd:all> <xsd:elementname="to"minOccurs="0"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> <xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"/>

</xsd:complexType> </xsd:element> <xsd:elementname="cc"minOccurs="0"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> <xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="bcc"minOccurs="0"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> <xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="subject"minOccurs="0"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> <xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="intro"minOccurs="0"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="attachmentFileName"minOccurs="0"> <xsd:complexType> <xsd:attributename="value"type="xsd:string"use="required"/> <xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"/> </xsd:complexType> </xsd:element> </xsd:all> <xsd:attributename="name"type="xsf:xdTitle"use="required"/>

<xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="dataAdapters"> <xsd:complexType> <xsd:choiceminOccurs="0"maxOccurs="unbounded"> <xsd:elementref="xsf:adoAdapter"/> <xsd:elementref="xsf:webServiceAdapter"/> <xsd:elementref="xsf:xmlFileAdapter"/> <xsd:elementref="xsf:sharepointListAdapter"/> <xsd:elementref="xsf:davAdapter"/> <xsd:elementref="xsf:emailAdapter"/> <xsd:elementref="xsf:hwsAdapter"/> </xsd:choice> </xsd:complexType> </xsd:element>  <xsd:elementname="documentSchemas"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:documentSchema"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="documentSchema"> <xsd:complexType> <xsd:attributename="location"type="xsd:string"use="required"/> <xsd:attributename="rootSchema"type="xsf:xdYesNo"/> </xsd:complexType> </xsd:element>  <xsd:elementname="customValidation">

<xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:errorCondition"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="errorCondition"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:errorMessage"/> </xsd:sequence> <xsd:attributename="match"type="xsd:string"use="required"/> <xsd:attributename="expression"type="xsd:string"use="required"/> <xsd:attributename="expressionContext"type="xsd:string"use="optional"/> <xsd:attributename="showErrorOn"type="xsd:string"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="errorMessage"> <xsd:complexType> <xsd:simpleContent> <xsd:extensionbase="xsf:xdErrorMessage"> <xsd:attributename="type"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="modal"/> <xsd:enumerationvalue="modeless"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="shortMessage"use="required"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="127"/>

</xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:extension> </xsd:simpleContent> </xsd:complexType> </xsd:element>  <xsd:elementname="domEventHandlers"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:domEventHandler"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> <xsd:uniquename="domEventHandler_handlerObject_unique"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@handlerObject"/> </xsd:unique> </xsd:element> <xsd:elementname="domEventHandler"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:ruleSetAction"minOccurs="0"maxOccurs="1"/> </xsd:sequence> <xsd:attributename="dataObject"type="xsd:string"use="optional"/> <xsd:attributename="match"type="xsd:string"use="required"/> <xsd:attributename="handlerObject"type="xsd:string"use="optional"/> </xsd:complexType> <xsd:keyrefname="domEventHandler_ruleSetAction"refer="xsf:ruleset_name_key"> <xsd:selectorxpath="./xsf:ruleSetAction"/> <xsd:fieldxpath="@ruleSet"/> </xsd:keyref> </xsd:element>

<xsd:elementname="importParameters"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:importSource"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="enabled"type="xsf:xdYesNo"use="required"/> <xsd:attributename="useScriptHandler"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="importSource"> <xsd:complexType> <xsd:attributename="name"type="xsd:string"use="required"/> <xsd:attributename="schema"type="xsf:xdFileName"use="required"/> <xsd:attributename="transform"type="xsf:xdFileName"use="required"/> <xsd:attributename="authoringOfTransform"type="xsf:xdManualAuto"use="optional"/> </xsd:complexType> </xsd:element>  <xsd:elementname="listProperties"> <xsd:complexType> <xsd:all> <xsd:elementref="xsf:fields"/> </xsd:all> </xsd:complexType> </xsd:element> <xsd:elementname="fields"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:field"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element>

<xsd:elementname="field"> <xsd:complexType> <xsd:attributename="type"type="xsd:NMTOKEN"use="required"/> <xsd:attributename="name"type="xsf:xdTitle"use="required"/> <xsd:attributename="columnName"type="xsf:xdTitle"use="required"/> <xsd:attributename="required"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="viewable"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="node"type="xsd:string"use="required"/> <xsd:attributename="maxLength"type="xsd:byte"/> <xsd:attributename="aggregation"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="sum"/> <xsd:enumerationvalue="count"/> <xsd:enumerationvalue="average"/> <xsd:enumerationvalue="min"/> <xsd:enumerationvalue="max"/> <xsd:enumerationvalue="first"/> <xsd:enumerationvalue="last"/> <xsd:enumerationvalue="merge"/> <xsd:enumerationvalue="plaintext"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element>  <xsd:elementname="submit"> <xsd:complexType> <xsd:all> <xsd:elementname="submitAction"minOccurs="0"> <xsd:complexType> <xsd:attributename="adapter"type="xsf:xdTitle"use="required"/>

</xsd:complexType> <xsd:keyrefname="submitAdapter_name_keyref"refer="xsf:adapter_name_key"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@adapter"/> </xsd:keyref> </xsd:element> <xsd:elementref="xsf:useHttpHandler"minOccurs="0"/> <xsd:elementref="xsf:useScriptHandler"minOccurs="0"/> <xsd:elementref="xsf:ruleSetAction"minOccurs="0"/> <xsd:elementref="xsf:useQueryAdapter"minOccurs="0"/> <xsd:elementref="xsf:webServiceAdapter"minOccurs="0"/> <xsd:elementref="xsf:davAdapter"minOccurs="0"/> <xsd:elementref="xsf:emailAdapter"minOccurs="0"/> <xsd:elementname="successMessage"type="xsd:string"minOccurs="0"/> <xsd:elementname="errorMessage"type="xsd:string"minOccurs="0"/> </xsd:all> <xsd:attributename="caption"type="xsd:string"use="optional"/> <xsd:attributename="onAfterSubmit"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="close"/> <xsd:enumerationvalue="keepOpen"/> <xsd:enumerationvalue="openNew"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="showStatusDialog"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="showSignatureReminder"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="disableMenuItem"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> <xsd:keyrefname="submit_ruleSetAction"refer="xsf:ruleset_name_key"> <xsd:selectorxpath="./xsf:ruleSetAction"/> <xsd:fieldxpath="@ruleSet"/>

</xsd:keyref> </xsd:element> <xsd:elementname="useHttpHandler"> <xsd:complexType> <xsd:attributename="method"use="required"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="POST"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="href"type="xsd:anyURI"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="useScriptHandler"/> <xsd:elementname="useQueryAdapter"/>  <xsd:elementname="onLoad"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:ruleSetAction"minOccurs="1"maxOccurs="1"/> </xsd:sequence> </xsd:complexType> <xsd:keyrefname="load_ruleSetAction"refer="xsf:ruleset_name_key"> <xsd:selectorxpath="./xsf:ruleSetAction"/> <xsd:fieldxpath="@ruleSet"/> </xsd:keyref> </xsd:element>  <xsd:elementname="save"> <xsd:complexType> <xsd:choiceminOccurs="0"maxOccurs="1"> <xsd:elementref="xsf:useScriptHandler"/>

</xsd:choice> </xsd:complexType> </xsd:element>  <xsd:elementname="roles"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:role"minOccurs="1"maxOccurs="unbounded"/> <xsd:elementref="xsf:membership"minOccurs="0"maxOccurs="1"/> </xsd:sequence> <xsd:attributename="default"type="xsd:string"use="required"/> <xsd:attributename="initiator"type="xsd:string"use="optional"/> <xsd:attributename="hideStatusBarDisplay"type="xsf:xdYesNo"use="optional"/> </xsd:complexType>  <xsd:uniquename="roles_name_unique"> <xsd:selectorxpath="./xsf:role"/> <xsd:fieldxpath="@name"/> </xsd:unique>  <xsd:keyname="role_name_key"> <xsd:selectorxpath="./xsf:role"/> <xsd:fieldxpath="@name"/> </xsd:key> <xsd:keyrefname="role_default"refer="xsf:role_name_key"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@default"/> </xsd:keyref> <xsd:keyrefname="role_initiator"refer="xsf:role_name_key"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@initiator"/> </xsd:keyref> <xsd:keyrefname="role_membership"refer="xsf:role_name_key">

<xsd:selectorxpath="./xsf:membership/*"/> <xsd:fieldxpath="@memberOf"/> </xsd:keyref> </xsd:element> <xsd:elementname="role"> <xsd:complexType> <xsd:attributename="name"type="xsf:xdRoleName"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="membership"> <xsd:complexType> <xsd:choiceminOccurs="1"maxOccurs="unbounded"> <xsd:elementref="xsf:getUserNameFromData"/> <xsd:elementref="xsf:userName"/> <xsd:elementref="xsf:group"/> </xsd:choice> </xsd:complexType> </xsd:element> <xsd:elementname="getUserNameFromData"> <xsd:complexType> <xsd:attributename="dataObject"type="xsd:string"use="optional"/> <xsd:attributename="select"type="xsd:string"use="required"/> <xsd:attributename="memberOf"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="userName"> <xsd:complexType> <xsd:attributename="name"type="xsd:string"use="required"/> <xsd:attributename="memberOf"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="group"> <xsd:complexType>

<xsd:attributename="name"type="xsd:string"use="required"/> <xsd:attributename="memberOf"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="hwsWorkflow"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:location"minOccurs="1"maxOccurs="1"/> <xsd:elementref="xsf:allowedActions"minOccurs="1"maxOccurs="1"/> <xsd:elementref="xsf:allowedTasks"minOccurs="0"maxOccurs="1"/> </xsd:sequence> <xsd:attributename="taskpaneVisible"type="xsf:xdYesNo"/> </xsd:complexType> <xsd:uniquename="hws_actiontask_name"> <xsd:selectorxpath="./xsf:allowedActions/xsf:action|./xsf:allowedTasks/xsf:task"/> <xsd:fieldxpath="@name"/> </xsd:unique> </xsd:element>  <xsd:elementname="location"> <xsd:complexType> <xsd:attributename="url"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="allowedActions"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:action"minOccurs="1"maxOccurs="20"/> </xsd:sequence> </xsd:complexType> <xsd:uniquename="hws_actionTypeID_unique">

<xsd:selectorxpath="./xsf:action"/> <xsd:fieldxpath="@actionTypeID"/> </xsd:unique> </xsd:element>  <xsd:elementname="action"> <xsd:complexType> <xsd:attributename="name"type="xsf:xdHWSname"use="required"/> <xsd:attributename="actionTypeID"type="xsd:string"use="required"/> <xsd:attributename="canInitiateWorkflow"type="xsf:xdYesNo"use="required"/> <xsd:attributename="caption"type="xsf:xdHWSCaption"use="optional"/> </xsd:complexType> </xsd:element>  <xsd:elementname="allowedTasks"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:task"minOccurs="1"maxOccurs="20"/> </xsd:sequence> </xsd:complexType> <xsd:uniquename="hws_taskID_unique"> <xsd:selectorxpath="./xsf:task"/> <xsd:fieldxpath="@taskTypeID"/> </xsd:unique> </xsd:element>  <xsd:elementname="task"> <xsd:complexType> <xsd:attributename="name"type="xsf:xdHWSname"use="required"/> <xsd:attributename="taskTypeID"type="xsd:string"use="required"/> <xsd:attributename="caption"type="xsf:xdHWSCaption"use="optional"/> </xsd:complexType> </xsd:element>

<xsd:elementname="fileNew"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:initialXmlDocument"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="initialXmlDocument"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:customCategory"minOccurs="0"/> </xsd:sequence> <xsd:attributename="caption"type="xsf:xdTitle"use="required"/> <xsd:attributename="href"type="xsf:xdFileName"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="customCategory"> <xsd:complexType> <xsd:attributename="name"type="xsf:xdTitle"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="package"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:files"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="files"> <xsd:complexType>

<xsd:sequence> <xsd:elementref="xsf:file"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="file"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:fileProperties"minOccurs="0"maxOccurs="1"/> </xsd:sequence> <xsd:attributename="name"type="xsf:xdFileName"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="fileProperties"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:property"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="property"> <xsd:complexType> <xsd:attributename="name"type="xsd:string"use="required"/> <xsd:attributename="value"type="xsd:string"use="required"/> <xsd:attributename="type"type="xsd:QName"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="permissions"> <xsd:complexType> <xsd:choiceminOccurs="0"maxOccurs="unbounded"> <xsd:elementref="xsf:allowedControl"/> </xsd:choice>

</xsd:complexType> </xsd:element> <xsd:elementname="allowedControl"> <xsd:complexType> <xsd:attributename="cabFile"type="xsd:string"use="optional"/> <xsd:attributename="clsid"type="xsd:string"use="required"/> <xsd:attributename="version"type="xsd:string"use="optional"/> </xsd:complexType> </xsd:element>   <xsd:elementname="externalViews"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:externalView"minOccurs="1"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="default"type="xsd:string"/> </xsd:complexType> <xsd:uniquename="externalViews_name_unique"> <xsd:selectorxpath="./xsf:externalView"/> <xsd:fieldxpath="@default"/> </xsd:unique> <xsd:keyrefname="external_views_printView"refer="xsf:externalView_name_key"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@default"/> </xsd:keyref> </xsd:element> <xsd:elementname="externalView"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:mainpane"/> </xsd:sequence> <xsd:attributename="target"type="xsd:string"/>

<xsd:attributename="name"type="xsf:xdViewName"use="required"/> <xsd:attributename="designMode"type="xsf:xdDesignMode"/> </xsd:complexType> </xsd:element>  <xsd:elementname="attributeData"> <xsd:complexType> <xsd:attributename="attribute"type="xsd:string"use="required"/> <xsd:attributename="value"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="button"> <xsd:complexType> <xsd:attributename="caption"type="xsf:xdTitle"/> <xsd:attributename="icon"type="xsd:string"/> <xsd:attributename="tooltip"type="xsf:xdTitle"/> <xsd:attributename="name"type="xsd:NMTOKEN"/> <xsd:attributename="xmlToEdit"type="xsd:NMTOKEN"/> <xsd:attributename="action"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="xCollection::insert"/> <xsd:enumerationvalue="xCollection::insertBefore"/> <xsd:enumerationvalue="xCollection::insertAfter"/> <xsd:enumerationvalue="xCollection::remove"/> <xsd:enumerationvalue="xCollection::refreshFilter"/> <xsd:enumerationvalue="xCollection::removeAll"/> <xsd:enumerationvalue="xOptional::insert"/> <xsd:enumerationvalue="xOptional::remove"/> <xsd:enumerationvalue="xReplace::replace"/> <xsd:enumerationvalue="xFileAttachment::attach"/> <xsd:enumerationvalue="xFileAttachment::open"/>

<xsd:enumerationvalue="xFileAttachment::saveAs"/> <xsd:enumerationvalue="xFileAttachment::remove"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="showIf"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="always"/> <xsd:enumerationvalue="enabled"/> <xsd:enumerationvalue="immediate"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element>  <xsd:elementname="chooseFragment"> <xsd:complexTypemixed="true"> <xsd:sequence> <xsd:anyminOccurs="0"maxOccurs="unbounded"processContents="skip"/> </xsd:sequence> <xsd:attributename="parent"type="xsd:string"/> <xsd:attributename="followingSiblings"type="xsd:string"use="optional"/> <xsd:attributename="innerFragment"type="xsd:string"use="optional"/> </xsd:complexType> </xsd:element>  <xsd:elementname="editWith"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:masterDetail"minOccurs="0"maxOccurs="1"/> <xsd:elementref="xsf:fragmentToInsert"minOccurs="0"maxOccurs="1"/>

</xsd:sequence> <xsd:attributename="component"use="required"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="xCollection"/> <xsd:enumerationvalue="xOptional"/> <xsd:enumerationvalue="xReplace"/> <xsd:enumerationvalue="xTextList"/> <xsd:enumerationvalue="xField"/> <xsd:enumerationvalue="xImage"/> <xsd:enumerationvalue="xFileAttachment"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="caption"type="xsf:xdTitle"use="optional"/> <xsd:attributename="autoComplete"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="proofing"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="type"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="plain"/> <xsd:enumerationvalue="formatted"/> <xsd:enumerationvalue="plainMultiline"/> <xsd:enumerationvalue="formattedMultiline"/> <xsd:enumerationvalue="rich"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="useFilter"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:enumerationvalue="yes"/> <xsd:enumerationvalue="no"/>

</xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="widgetIcon"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:enumerationvalue="standard"/> <xsd:enumerationvalue="filter"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="filterDependency"type="xsd:string"use="optional"/> <xsd:attributename="field"type="xsd:string"use="optional"/> <xsd:attributename="removeAncestors"type="xsd:nonNegativeInteger"use="optional"/> <xsd:attributename="maxLength"use="optional"> <xsd:simpleType> <xsd:restrictionbase="xsd:integer"> <xsd:minInclusivevalue="-1"/> <xsd:maxInclusivevalue="9999"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="allowedFileTypes"type="xsd:string"use="optional"/> <xsd:anyAttributenamespace="http://schemas.microsoft.com/office/infopath/2003"processContents="skip"/> </xsd:complexType> </xsd:element>  <xsd:elementname="unboundControls"> <xsd:complexType> <xsd:sequence>  <xsd:elementname="button"minOccurs="0"maxOccurs="unbounded"> <xsd:complexType>

<xsd:sequence> <xsd:elementref="xsf:ruleSetAction"minOccurs="0"maxOccurs="1"/> </xsd:sequence> <xsd:attributename="name"use="required"> <xsd:simpleType>  <xsd:restrictionbase="xsd:NCName"> <xsd:patternvalue="[^\.\^-]*"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> <xsd:keyrefname="button_ruleSetAction"refer="xsf:ruleset_name_key"> <xsd:selectorxpath="./xsf:ruleSetAction"/> <xsd:fieldxpath="@ruleSet"/> </xsd:keyref> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element>  <xsd:elementname="editing"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:xmlToEdit"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element>  <xsd:elementname="masterDetail"> <xsd:complexType> <xsd:attributename="master"type="xsd:string"/>

<xsd:attributename="masterViewContext"type="xsd:string"/> <xsd:attributename="masterKey"type="xsd:string"/> <xsd:attributename="detailKey"type="xsd:string"/> </xsd:complexType> </xsd:element>  <xsd:elementname="fragmentToInsert"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:chooseFragment"minOccurs="1"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element>  <xsd:elementname="mainpane"> <xsd:complexType> <xsd:attributename="transform"type="xsf:xdFileName"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="printSettings"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:header"minOccurs="0"maxOccurs="1"/> <xsd:elementref="xsf:footer"minOccurs="0"maxOccurs="1"/> </xsd:sequence> <xsd:attributename="orientation"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="portrait"/> <xsd:enumerationvalue="landscape"/> </xsd:restriction> </xsd:simpleType>

</xsd:attribute> <xsd:attributename="header"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="footer"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="marginUnitsType"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="in"/> <xsd:enumerationvalue="cm"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="rightMargin"> <xsd:simpleType> <xsd:restrictionbase="xsd:float"> <xsd:minInclusivevalue="0"/> <xsd:maxInclusivevalue="100"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="leftMargin"> <xsd:simpleType>

<xsd:restrictionbase="xsd:float"> <xsd:minInclusivevalue="0"/> <xsd:maxInclusivevalue="100"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="topMargin"> <xsd:simpleType> <xsd:restrictionbase="xsd:float"> <xsd:minInclusivevalue="0"/> <xsd:maxInclusivevalue="100"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="bottomMargin"> <xsd:simpleType> <xsd:restrictionbase="xsd:float"> <xsd:minInclusivevalue="0"/> <xsd:maxInclusivevalue="100"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="printerName"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="paperSize"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/>

</xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="paperSource"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="copies"> <xsd:simpleType> <xsd:restrictionbase="xsd:integer"> <xsd:minInclusivevalue="1"/> <xsd:maxInclusivevalue="9999"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="collate"type="xsf:xdYesNo"/> <xsd:attributename="pageRangeStart"> <xsd:simpleType> <xsd:restrictionbase="xsd:integer"> <xsd:minInclusivevalue="1"/> <xsd:maxInclusivevalue="32000"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attributename="pageRangeEnd"> <xsd:simpleType> <xsd:restrictionbase="xsd:integer"> <xsd:minInclusivevalue="1"/> <xsd:maxInclusivevalue="32000"/> </xsd:restriction>

</xsd:simpleType> </xsd:attribute> <xsd:attributename="printerSpecificSettings"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="255"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element> <xsd:elementname="header"> <xsd:complexTypemixed="true"> <xsd:sequence> <xsd:anyminOccurs="0"maxOccurs="unbounded"processContents="skip"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="footer"> <xsd:complexTypemixed="true"> <xsd:sequence> <xsd:anyminOccurs="0"maxOccurs="unbounded"processContents="skip"/> </xsd:sequence> </xsd:complexType> </xsd:element>  <xsd:elementname="toolbar"> <xsd:complexType> <xsd:sequence> <xsd:groupref="xsf:UIItem"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="name"type="xsf:xdTitle"use="required"/> <xsd:attributename="caption"type="xsf:xdTitle"use="required"/>

</xsd:complexType> </xsd:element>  <xsd:elementname="menu"> <xsd:complexType> <xsd:sequence> <xsd:groupref="xsf:UIItem"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="caption"type="xsf:xdTitle"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="menuArea"> <xsd:complexType> <xsd:sequence> <xsd:groupref="xsf:UIItem"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="name"use="required"> <xsd:simpleType> <xsd:restrictionbase="xsd:NMTOKEN"> <xsd:enumerationvalue="msoFileMenu"/> <xsd:enumerationvalue="msoEditMenu"/> <xsd:enumerationvalue="msoInsertMenu"/> <xsd:enumerationvalue="msoViewMenu"/> <xsd:enumerationvalue="msoFormatMenu"/> <xsd:enumerationvalue="msoToolsMenu"/> <xsd:enumerationvalue="msoTableMenu"/> <xsd:enumerationvalue="msoHelpMenu"/> <xsd:enumerationvalue="msoStructuralEditingContextMenu"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType>

</xsd:element>  <xsd:groupname="UIContainer"> <xsd:choice> <xsd:elementref="xsf:toolbar"/> <xsd:elementref="xsf:menu"/> <xsd:elementref="xsf:menuArea"/> </xsd:choice> </xsd:group>  <xsd:groupname="UIItem"> <xsd:choice> <xsd:elementref="xsf:button"/> <xsd:elementref="xsf:menu"/> </xsd:choice> </xsd:group>  <xsd:elementname="taskpane"> <xsd:complexType> <xsd:attributename="caption"type="xsd:string"use="required"/> <xsd:attributename="href"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element>  <xsd:elementname="views"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:view"minOccurs="1"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="default"type="xsd:string"/> </xsd:complexType> <xsd:uniquename="views_name_unique"> <xsd:selectorxpath="./xsf:view"/>

<xsd:fieldxpath="@name"/> </xsd:unique> <xsd:keyrefname="view_printView"refer="xsf:view_or_externalView_name_key"> <xsd:selectorxpath="./xsf:view"/> <xsd:fieldxpath="@printView"/> </xsd:keyref> <xsd:keyrefname="views_default"refer="xsf:view_name_key"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@default"/> </xsd:keyref> </xsd:element>  <xsd:groupname="ViewContent"> <xsd:choice> <xsd:elementref="xsf:editing"minOccurs="0"/> <xsd:elementref="xsf:mainpane"minOccurs="0"/> <xsd:elementref="xsf:printSettings"minOccurs="0"/> <xsd:groupref="xsf:UIContainer"minOccurs="0"maxOccurs="unbounded"/> <xsd:elementref="xsf:unboundControls"minOccurs="0"/> </xsd:choice> </xsd:group>  <xsd:elementname="view"> <xsd:complexType> <xsd:groupref="xsf:ViewContent"minOccurs="0"maxOccurs="unbounded"/> <xsd:attributename="caption"type="xsf:xdViewName"/> <xsd:attributename="name"type="xsf:xdViewName"use="required"/> <xsd:attributename="showMenuItem"type="xsf:xdYesNo"use="optional"/> <xsd:attributename="printView"type="xsd:string"/> <xsd:attributename="designMode"type="xsf:xdDesignMode"/> </xsd:complexType> <xsd:uniquename="toolbar_name_unique"> <xsd:selectorxpath="./xsf:toolbar"/>

<xsd:fieldxpath="@name"/> </xsd:unique> <xsd:uniquename="menuArea_name_unique"> <xsd:selectorxpath="./xsf:menuArea"/> <xsd:fieldxpath="@name"/> </xsd:unique> <xsd:uniquename="xmlToEdit_name_unique"> <xsd:selectorxpath="./xsf:editing/xsf:xmlToEdit"/> <xsd:fieldxpath="@name"/> </xsd:unique> <xsd:keyname="xmlToEdit_name_key"> <xsd:selectorxpath="./xsf:editing/xsf:xmlToEdit"/> <xsd:fieldxpath="@name"/> </xsd:key> <xsd:keyrefname="button_xmlToEdit_reference"refer="xsf:xmlToEdit_name_key"> <xsd:selectorxpath="./xsf:menuArea/xsf:button|./xsf:menu/xsf:button|./xsf:toolbar/xsf:button"/> <xsd:fieldxpath="@xmlToEdit"/> </xsd:keyref> </xsd:element>  <xsd:elementname="xmlToEdit"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:editWith"minOccurs="0"maxOccurs="1"/> </xsd:sequence> <xsd:attributename="name"type="xsd:NMTOKEN"use="required"/> <xsd:attributename="item"type="xsd:string"use="required"/> <xsd:attributename="container"type="xsd:string"/> <xsd:attributename="viewContext"> <xsd:simpleType> <xsd:restrictionbase="xsd:string"> <xsd:patternvalue="((\.|\#|[a-zA-Z0-9_])[a-zA-Z0-9_]*)(\s((\.|\#|[a-zA-Z0-9_])[a-zA-Z0-9_]*))*"/> </xsd:restriction>

</xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element>  <xsd:elementname="documentSignatures"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:signedDataBlock"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="signatureLocation"type="xsd:string"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="signedDataBlock"> <xsd:complexType> <xsd:sequence> <xsd:elementname="message"type="xsf:xdSignedDataBlockMessage"minOccurs="0"/> </xsd:sequence> <xsd:attributename="name"type="xsf:xdSignedDataBlockName"use="required"/> <xsd:attributename="data"type="xsd:string"use="required"/> <xsd:attributename="signatureLocation"type="xsd:string"use="required"/> <xsd:attributename="mode"type="xsf:xdSignatureRelationEnum"use="required"/> </xsd:complexType> <xsd:uniquename="signedDataBlock_name_unique"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@name"/> </xsd:unique> </xsd:element>  <xsd:elementname="documentVersionUpgrade"> <xsd:complexType> <xsd:choice> <xsd:elementref="xsf:useScriptHandler"/>

<xsd:elementref="xsf:useTransform"/> </xsd:choice> </xsd:complexType> </xsd:element> <xsd:elementname="useTransform"> <xsd:complexType> <xsd:attributename="transform"use="required"> <xsd:simpleType> <xsd:unionmemberTypes="xsf:xdFileNamexsf:xdEmptyString"/> </xsd:simpleType> </xsd:attribute> <xsd:attributename="minVersionToUpgrade"type="xsf:xdSolutionVersion"use="required"/> <xsd:attributename="maxVersionToUpgrade"type="xsf:xdSolutionVersion"/> </xsd:complexType> </xsd:element>  <xsd:elementname="extensions"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:extension"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:elementname="extension"> <xsd:complexTypemixed="true"> <xsd:sequence> <xsd:anyminOccurs="0"maxOccurs="unbounded"processContents="skip"/> </xsd:sequence> <xsd:attributename="name"type="xsd:NMTOKEN"use="required"/> <xsd:anyAttributeprocessContents="skip"/> </xsd:complexType> </xsd:element>

<xsd:elementname="ruleSetAction"> <xsd:complexType> <xsd:attributename="ruleSet"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="rule"> <xsd:complexType> <xsd:sequence> <xsd:choiceminOccurs="0"maxOccurs="unbounded"> <xsd:elementref="xsf:dialogBoxMessageAction"/> <xsd:elementref="xsf:dialogBoxExpressionAction"/> <xsd:elementref="xsf:switchViewAction"/> <xsd:elementref="xsf:assignmentAction"/> <xsd:elementref="xsf:queryAction"/> <xsd:elementname="submitAction"> <xsd:complexType> <xsd:attributename="adapter"type="xsf:xdTitle"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementref="xsf:openNewDocumentAction"/> <xsd:elementref="xsf:closeDocumentAction"/> </xsd:choice> <xsd:elementname="exitRuleSet"minOccurs="0"> <xsd:complexType/> </xsd:element> </xsd:sequence> <xsd:attributename="caption"type="xsd:string"use="required"/> <xsd:attributename="condition"type="xsd:string"use="optional"/> <xsd:attributename="isEnabled"type="xsf:xdYesNo"use="optional"default="yes"/> </xsd:complexType> </xsd:element> <xsd:elementname="dialogBoxMessageAction"> <xsd:simpleType>

<xsd:restrictionbase="xsd:string"> <xsd:maxLengthvalue="1024"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:elementname="dialogBoxExpressionAction"type="xsd:string"/> <xsd:elementname="switchViewAction"> <xsd:complexType> <xsd:attributename="view"type="xsf:xdViewName"use="required"/> </xsd:complexType> <xsd:keyrefname="switchViewAction_view_keyref"refer="xsf:view_name_key"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@view"/> </xsd:keyref> </xsd:element> <xsd:elementname="assignmentAction"> <xsd:complexType> <xsd:attributename="targetField"type="xsd:string"use="required"/> <xsd:attributename="expression"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="queryAction"> <xsd:complexType> <xsd:attributename="adapter"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="openNewDocumentAction"> <xsd:complexType> <xsd:attributename="solutionURI"type="xsd:anyURI"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="closeDocumentAction"> <xsd:complexType>

<xsd:attributename="promptToSaveChanges"type="xsf:xdYesNo"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="ruleSet"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:rule"minOccurs="1"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="name"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element> <xsd:elementname="ruleSets"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:ruleSet"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> <xsd:uniquename="ruleSets_name_unique"> <xsd:selectorxpath="./xsf:ruleSet"/> <xsd:fieldxpath="@name"/> </xsd:unique> </xsd:element>  <xsd:elementname="calculations"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:calculatedField"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="treatBlankValueAsZero"type="xsf:xdYesNo"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="calculatedField"> <xsd:complexType>

<xsd:attributename="target"type="xsd:string"use="required"/> <xsd:attributename="expression"type="xsd:string"use="required"/> <xsd:attributename="refresh"type="xsd:string"use="required"/> </xsd:complexType> </xsd:element></xsd:schema>

ShowAll

xsfNamespace

TheMicrosoftOfficeInfoPath2003formdefinition(.xsf)fileconformstoanXSDschemadefinition,andusesacorrespondingnamespace.

NamespaceURI

xmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"

RemarksAlloftheelementswithinthe.xsffilearenamespacequalifiedusingthexsfnamespace.

ShowAll

xdDesignModeType

Specifieswhetheraview(*.xsl)filecanbeopenedindesignmodeinMicrosoftOfficeInfoPath2003.

Typexsd:NMTOKEN

Facets

Name Descriptionenumeration normalenumeration protected

RemarksThexdDesignModetypeisusedforattributesintheformdefinitionfile(.xsf)tospecifywhetheraviewcanbeopenedindesignmode("normal"),orwhethertheviewisnotpermittedtobeopenedindesignmode("protected").

NoteThisitemisnotsupportedwhentheDisableServicePackfeaturesoptionontheAdvancedtaboftheOptionsdialogboxinInfoPathisselectedorwhenMicrosoftOffice2003EditionsServicePack1orlaterisnotinstalled.Anyformdefinedbyaformdefinitionfile(.xsf)thatincludesthisitemcannotbeopenedinInfoPathwhenservicepackfeaturesaredisabledorunavailable.

ExampleThefollowingexampleisthedeclarationofthexdDesignModetype:

<xsd:simpleTypename="xdDesignMode"><xsd:restrictionbase="xsd:NMTOKEN"><xsd:enumerationvalue="normal"/><xsd:enumerationvalue="protected"/></xsd:restriction></xsd:simpleType>

ShowAll

xdEmptyStringType

Specifiesanemptystring.

xsd:string

Facets

Name DescriptionmaxLength 0

RemarksThexdEmptyStringtypeisusedforattributesintheformdefinition(.xsf)filethatspecifyanemptystring.

ExampleThefollowingexampleisthedeclarationofthexdEmptyStringtype:

<xsd:simpleTypename="xdEmptyString"><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="0"/></xsd:restriction></xsd:simpleType>

xdEnabledDisabledType

Specifieswhetherafeatureisenabledordisabled.

Typexsd:NMTOKEN

Facets

Name Descriptionenumeration enabledenumeration disabled

RemarksNoteThisitemisnotsupportedwhentheDisableServicePackfeaturesoptionontheAdvancedtaboftheOptionsdialogboxinInfoPathisselectedorwhenMicrosoftOffice2003EditionsServicePack1orlaterisnotinstalled.Anyformdefinedbyaformdefinitionfile(.xsf)thatincludesthisitemcannotbeopenedinInfoPathwhenservicepackfeaturesaredisabledorunavailable.

ExampleThefollowingexampleisthedeclarationofthexdEnabledDisabledtype:

<xsd:simpleTypename="xdEnabledDisabled"><xsd:restrictionbase="xsd:NMTOKEN"><xsd:enumerationvalue="enabled"/><xsd:enumerationvalue="disabled"/></xsd:restriction></xsd:simpleType>

ShowAll

xdErrorMessageType

Specifiesanerrormessage.

xsd:string

Facets

Name DescriptionmaxLength 1023

RemarksThexdErrorMessagetypeisusedforattributesintheformdefinition(.xsf)filethatspecifyanerrormessagenogreaterthan1023charactersinlength.

ExampleThefollowingexampleisthedeclarationofthexdErrorMessagetype:

<xsd:simpleTypename="xdErrorMessage"><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="1023"/></xsd:restriction></xsd:simpleType>

ShowAll

xdExpressionLiteralsimpleType

SpecifiesatypeforidentifyingwhetheravalueshouldbeinterpretedasaliteralvalueoranXPathexpressionthatreturnsavalue.

Typexsd:NMTOKEN

RemarksThexdExpressionLiteraltypeisusedforthevalueTypeattributeinthedavAdapterandemailAdapterelements.

ExampleThefollowingexampleisthedeclarationofthexdExpressionLiteraltype:

<xsd:simpleTypename="xdExpressionLiteral"><xsd:restrictionbase="xsd:NMTOKEN"><xsd:enumerationvalue="expression"/><xsd:enumerationvalue="literal"/></xsd:restriction></xsd:simpleType>

ShowAll

xdFileNameType

Specifiesthenameofafile.

xsd:string

Facets

Name DescriptionminLength 1maxLength 64

RemarksThexdFileNametypeisusedforattributesintheformdefinition(.xsf)filethatspecifyafilenamethatcanbefrom1to64charactersinlength.

ExampleThefollowingexampleisthedeclarationofthexdFileNametype:

<xsd:simpleTypename="xdFileName"><xsd:restrictionbase="xsd:string"><xsd:minLengthvalue="1"/><xsd:maxLengthvalue="64"/></xsd:restriction></xsd:simpleType>

xdHWSCaptionsimpleType

SpecifiesatypeforthecaptionoftheMicrosoftBiztalkServer2004HWS(HumanWorkflowServices)actionortaskelement.

Typexsd:string

Facets

Name DescriptionmaxLength 255charactersminLength 1character

RemarksThelengthofthecaptioncannotbelessthanonecharacterorgreaterthan255characters.

ExampleThefollowingexampleisthedeclarationofthexdHWSCaptiontype:

<xsd:simpleTypename="xdHWSCaption"><xsd:restrictionbase="xsd:string"><xsd:minLengthvalue="1"/><xsd:maxLengthvalue="255"/></xsd:restriction></xsd:simpleType>

xdHWSnamesimpleType

SpecifiesatypeforauniquenameoftheMicrosoftBiztalkServer2004HWS(HumanWorkflowServices)actionortaskelementasspecifiedbytheHWSworkflowdesigner.

Typexsd:NCName

Facets

Name Descriptionpattern [^-^\.^\\^\[^\]^\|^\+^?^\*^@^\{^\}^$^$^>^<^=^;^,]*

RemarksThenamecannotcontainthefollowingcharacters:

\/"[]:<>+=;,?*@

ExampleThefollowingexampleisthedeclarationofthexdHWSnametype:

<xsd:simpleTypename="xdHWSname"><xsd:restrictionbase="xsd:NCName"><xsd:patternvalue="[^-^\.^\\^\[^\]^\|^\+^?^\*^@^\{^\}^$^$^>^<^=^;^,]*"/></xsd:restriction></xsd:simpleType>

ShowAll

xdManualAutoType

Specifiesa"manual"or"automatic"value.

Typexsd:NMTOKEN

Facets

Name Descriptionenumeration manualenumeration automatic

RemarksThexdTrustManualAutotypeisusedforattributesintheformdefinition(.xsf)filethatrequirea"manual"or"automatic"value.Thedefaultvalueis"manual".

ExampleThefollowingexampleisthedeclarationofthexdManualAutotype:

<xsd:simpleTypename="xdManualAuto"><xsd:restrictionbase="xsd:NMTOKEN"><xsd:enumerationvalue="manual"/><xsd:enumerationvalue="automatic"/></xsd:restriction></xsd:simpleType>

xdRoleNameType

Specifiestherolename.

Typexsf:xdViewName

RemarksRolenamehasrestrictionsonvaluesitcancontain.Theserestrictionsarethesameastheconstrainingfacetsofthexsf:xdViewNametype.

ExampleThefollowingexampleisthedeclarationofthexdRoleNametype:

<xsd:simpleTypename="xdRoleName"><xsd:restrictionbase="xsf:xdViewName"></xsd:restriction></xsd:simpleType>

ShowAll

xdScriptLanguageType

Specifiesthenameofascriptinglanguage.

xsd:NMTOKEN

Facets

Name Descriptionpattern ((([Jj][Aa][Vv][Aa])|([Jj])|([Vv][Bb]))([Ss][Cc][Rr][Ii][Pp][Tt]))

RemarksThexdScriptLanguagetypeisusedforattributesintheformdefinition(.xsf)filethatspecifythenameofascriptinglanguage.

ExampleThefollowingexampleisthedeclarationofthexdScriptLanguagetype:

<xsd:simpleTypename="xdScriptLanguage"><xsd:restrictionbase="xsd:NMTOKEN"><xsd:patternvalue="((([Jj][Aa][Vv][Aa])|([Jj])|([Vv][Bb]))([Ss][Cc][Rr][Ii][Pp][Tt]))"/></xsd:restriction></xsd:simpleType>

xdSignatureRelationEnumType

ContainsthesignaturerelationenumerationforthesignedDataBlockelement.

Typexsd:string

Facets

Name Descriptioncountersign Specifiesthateachsignaturesignstheprevioussignaturein

thesignedDataBlock.cosign SpecifiesthateachsignatureinthesignedDataBlockis

independent.single Specifiesthatonlyonesignatureisallowedforthe

signedDataBlock.

ExampleThefollowingexampleisthedeclarationofthexdSignatureRelationEnumtype:

<xsd:simpleTypename="xdSignatureRelationEnum"><xsd:restrictionbase="xsd:string"><xsd:enumerationvalue="countersign"/><xsd:enumerationvalue="cosign"/><xsd:enumerationvalue="single"/></xsd:restriction></xsd:simpleType>

xdSignedDataBlockMessageType

Definesthemaximumstringlengthforthesignaturesconfirmationmessageelement.

Typexsd:simpleType

Facets

Name DescriptionmaxLength 255characters

RemarksThesignatureconfirmationmessagehasamaximumlengthof255characters.

ExampleThefollowingexampleisthedeclarationofthexdSignedDataBlockMessagetype:

<xsd:simpleTypename="xdSignedDataBlockMessage"><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="255"/></xsd:restriction></xsd:simpleType>

xdSignedDataBlockNameType

DefinesthemaximumstringlengthforthenameattributeofthesignedDataBlockelement.

Typexsd:simpleType

Facets

Name DescriptionmaxLength 255charactersminLength 1character

ExampleThefollowingexampleisthedeclarationofthexdSignedDataBlockNametype:

<xsd:simpleTypename="xdSignedDataBlockName"><xsd:restrictionbase="xsd:ID"><xsd:minLengthvalue="1"/><xsd:maxLengthvalue="255"/></xsd:restriction></xsd:simpleType>

ShowAll

xdSolutionVersionType

Specifiesaversionnumber.

xsd:string

Facets

Name Descriptionpattern (([0-9]{1,4}.){3}[0-9]{1,4})

RemarksThexdSolutionVersiontypeisusedforattributesintheformdefinition(.xsf)filethatspecifyaversionnumber.

ExampleThefollowingexampleisthedeclarationofthexdSolutionVersiontype:

<xsd:simpleTypename="xdSolutionVersion"><xsd:restrictionbase="xsd:string"><xsd:patternvalue="(([0-9]{1,4}.){3}[0-9]{1,4})"/></xsd:restriction></xsd:simpleType>

ShowAll

xdTitleType

Specifiesatitlestring.

xsd:string

Facets

Name DescriptionminLength 1maxLength 255pattern ([^\p{Z}\p{Cc}\p{Cf}\p{Cn}])(([^\p{Zl}\p{Zp}\p{Cc}])*

([^\p{Z}\p{Cc}\p{Cf}\p{Cn}]))?

RemarksThexdTitletypeisusedforattributesintheformdefinition(.xsf)filethatareastringofcharactersthatcanbefrom1to255charactersinlength,andthatfollowaprescribedpattern.

ExampleThefollowingexampleisthedeclarationofthexdTitletype:

<xsd:simpleTypename="xdTitle"><xsd:restrictionbase="xsd:string"><xsd:minLengthvalue="1"/><xsd:maxLengthvalue="255"/><xsd:patternvalue="([^\p{Z}\p{Cc}\p{Cf}\p{Cn}])(([^\p{Zl}\p{Zp}\p{Cc}])*([^\p{Z}\p{Cc}\p{Cf}\p{Cn}]))?"/></xsd:restriction></xsd:simpleType>

ShowAll

xdTrustLevelType

Specifiesa"restricted"or"domain"value.

Typexsd:string

Facets

Name Descriptionenumeration restrictedenumeration domain

RemarksThexdTrustLeveltypeisusedforattributesintheformdefinition(.xsf)filethatrequirea"restricted"or"domain"value.Thedefaultvalueis"domain".

ExampleThefollowingexampleisthedeclarationofthexdTrustLeveltype:

<xsd:simpleTypename="xdTrustLevel"><xsd:restrictionbase="xsd:string"><xsd:enumerationvalue="restricted"/><xsd:enumerationvalue="domain"/></xsd:restriction></xsd:simpleType>

ShowAll

xdViewNameType

Specifiesaviewname.

xsd:string

Facets

Name DescriptionminLength 1maxLength 255pattern ([^\p{Z}\p{C}/\\#&"><])

(([^\p{Zl}\p{Zp}\p{C}/\\#&"><])*([^\p{Z}\p{C}/\\#&"><]))?

RemarksThexdViewNametypeisusedforattributesintheformdefinition(.xsf)filethatareastringofcharactersthatcanbefrom1to255charactersinlength,andthatfollowaprescribedpattern.

ExampleThefollowingexampleisthedeclarationofthexdViewNametype:

<xsd:simpleTypename="xdViewName"><xsd:restrictionbase="xsd:string"><xsd:minLengthvalue="1"/><xsd:maxLengthvalue="255"/><xsd:patternvalue="([^\p{Z}\p{C}/\\#&"><])(([^\p{Zl}\p{Zp}\p{C}/\\#&"><])*([^\p{Z}\p{C}/\\#&"><]))?"/></xsd:restriction></xsd:simpleType>

ShowAll

xdYesNoType

Specifiesayesornovalue.

xsd:NMTOKEN

Facets

Name Descriptionenumeration yesenumeration no

RemarksThexdYesNotypeisusedforattributesintheformdefinition(.xsf)filethatrequireayesornovalue.

ExampleThefollowingexampleisthedeclarationofthexdYesNotype:

<xsd:simpleTypename="xdYesNo"><xsd:restrictionbase="xsd:NMTOKEN"><xsd:enumerationvalue="yes"/><xsd:enumerationvalue="no"/></xsd:restriction></xsd:simpleType>

ShowAll

UIContainerGroup

Representsacollectionofuserinterface(UI)elements.

RemarksTheUIContainergroupisusedasanelementoftheViewContentgroup.

ExampleThefollowingexampleistheXMLSchemadeclarationoftheUIContainergroup:

<xsd:groupname="UIContainer"><xsd:choice><xsd:elementref="xsf:toolbar"/><xsd:elementref="xsf:menu"/><xsd:elementref="xsf:menuArea"/></xsd:choice></xsd:group>

ShowAll

UIItemGroup

Representsacollectionofuserinterface(UI)elements.

RemarksTheUIItemgroupisusedasanelementofthetoolbar,menu,andmenuAreaelements.

ExampleThefollowingexampleistheXMLSchemadeclarationoftheUIItemgroup:

<xsd:groupname="UIItem"><xsd:choice><xsd:elementref="xsf:button"/><xsd:elementref="xsf:menu"/></xsd:choice></xsd:group>

ShowAll

ViewContentGroup

Representsacollectionofelementsusedinaview.

RemarksTheViewContentgroupisusedasanelementoftheviewelement.

ExampleThefollowingexampleistheXMLSchemadeclarationoftheViewContentgroup:

<xsd:groupname="ViewContent"><xsd:choice><xsd:elementref="xsf:editing"minOccurs="0"/><xsd:elementref="xsf:mainpane"minOccurs="0"/><xsd:elementref="xsf:printSettings"minOccurs="0"/><xsd:groupref="xsf:UIContainer"minOccurs="0"maxOccurs="unbounded"/><xsd:elementref="xsf:unboundControls"minOccurs="0"/></xsd:choice></xsd:group>

ShowAll

actionElement

ContainstheMicrosoftBiztalkServer2004HumanWorkflowServices(HWS)actioninformationthathasbeenenabledfortheform.

Typexsd:complexType

ChildElementsNone.

Attributes

Attribute Type Required DescriptionPossibleValues

name xsf:xdHWSname Yes TheuniquenameoftheactionasspecifiedbytheHWSworkflowdesigner,andusedfortheonClickeventofthebuttonintheWorkflowtaskpane.

Cannotcontainthefollowingcharacters:

\/"[]:<>+=;,?*@

actionTypeID xsd:string Yes TheuniqueIDfortheaction.

string

canInitiateWorkflow xsf:xdYesNo Yes Indicateswhethertheactioncanbeusedtostartanactivityflow.

caption xsf:xdHWSCaption No ThelabelforthecorrespondingbuttonintheWorkflowtaskpanetostarttheaction.

minLength=1

maxLength=255

Definition

<xsd:elementname="action"><xsd:complexType><xsd:attributename="name"type="xsf:xdHWSname"use="required"></xsd:attribute><xsd:attributename="actionTypeID"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="canInitiateWorkflow"type="xsf:xdYesNo"use="required"></xsd:attribute><xsd:attributename="caption"type="xsf:xdHWSCaption"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheactionelementisanoptionalelementoftheallowedActionselement.

EachactionenabledfortheformmusthaveacorrespondingactionelementintheallowedActionssectionoftheformdefinitionfile(.xsf).

ExampleThefollowingisanexampleoftheactionelement:

<xsf:hwsWorkflowtaskpaneVisible="yes"><xsf:locationurl="http://www.contoso.com/hwsservice/hwsservice.asmx"/><xsf:allowedActions><xsf:actionname="approval"actionTypeID="123"canInitiateWorkflow="yes"caption="GetApproval"/><xsf:actionname="delegate"actionTypeID="234"canInitiateWorkflow="no"caption="Delegate"/></xsf:allowedActions><xsf:allowedTasks><xsf:taskname="getManagerApproval"taskTypeID="435"caption="SendResponse"/><xsf:taskname="getVPApproval"taskTypeID="436"caption="SendResponse"/><xsf:taskname="delegateToManager"taskTypeID="420"caption="Respond"/></xsf:allowedTasks></xsf:hwsWorkflow>

<xsf:hwsAdaptername="StartApproval"wsdlUrl="http://www.contoso.com/hwsservice/hwsservice.asmx?WSDL"submitAllowed="yes"><xsf:hwsOperationtype="addActionToNewActivityFlow"typeID="{guid}"serviceUrl="http://www.contoso.com/hwsservice/hwsservice.asmx"><xsf:inputsource="HWSMessage1.xml"><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param1"replaceWith="/my:myFields/my:param1"/><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param2"replaceWith="/a:some/b:thing"dataObject="Aux1"/>

</xsf:input></xsf:hwsOperation></xsf:hwsAdapter>

ShowAll

adoAdapterElement

DefinesanActiveXDataObjects(ADO)dataadapterthatretrievesdatafromanADOdatasourceforthespecifieddataobject.

xsd:complexType

Structure

Name DescriptioncommandText (Requiredattribute)Astringpropertythatcontains

theADOSQLcommandtexttobeusedforqueryingthedatafromthespecifieddatasource.

connectionString (Requiredattribute)AstringpropertythatcontainstheADOconnectionstringtobeusedtoconnecttothedatasource.

name (Optionalattribute)ContainsthenameoftheadoAdapterelement.

queryAllowed (Optionalattribute)SpecifieswhetherdatacanberetrievedfromthedatasourcethroughtheQuerymethodofthedataadapterobject.

submitAllowed (Optionalattribute)SpecifieswhetherdatacanbesubmittedtothedatasourcethroughtheSubmitmethodofthedataadapterobject.

RemarksTheadoAdapterelementisanoptionalelementofthequeryelement.

ExampleThefollowingisanexampleoftheadoAdapterelement:

<xsf:query><xsf:adoAdapterconnectionString="Provider=Microsoft.Jet.OLEDB.4.0;Password="";UserID=Admin;DataSource=infnwind.mdb;Mode=ShareDenyNone;ExtendedProperties="";..."commandText="select[EmployeeID],[LastName],[FirstName]from[Employees]as[Employees]"queryAllowed="yes"submitAllowed="yes"></xsf:adoAdapter></xsf:query>

ShowAll

allowedActionsElement

ContainstheMicrosoftBiztalkServer2004HumanWorkflowServices(HWS)actionsenabledfortheform.

Typexsd:complexType

ChildElements

Element Descriptionaction Containstheinformationforanindividualaction.

AttributesNone.

Definition

<xsd:elementname="allowedActions"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:action"minOccurs="1"maxOccurs="20"/></xsd:sequence></xsd:complexType><xsd:uniquename="hws_actionTypeID_unique"><xsd:selectorxpath="./xsf:action"/><xsd:fieldxpath="@actionTypeID"/></xsd:unique></xsd:element>

RemarksTheallowedActionselementisanoptionalelementofthehwsWorkflowelement.

EachactiontobeenabledfortheformmusthaveacorrespondingactionelementintheallowedActionssectionoftheformdefinitionfile(.xsf).

ExampleThefollowingisanexampleoftheallowedActionselement:

<xsf:hwsAdaptername="StartApproval"wsdlUrl="http://www.contoso.com/hwsservice/hwsservice.asmx?WSDL"submitAllowed="yes"queryAllowed="no"><xsf:hwsOperationtype="addActionToNewActivityFlow"typeID="{guid}"serviceUrl="http://www.contoso.com/hwsservice/hwsservice.asmx"><xsf:inputsource="HWSMessage1.xml"><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param1"replaceWith="/my:myFields/my:param1"/><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param2"replaceWith="/a:some/b:thing"dataObject="Aux1"/>

ShowAll

allowedControlElement

SpecifiestheActiveXcontrolsthatareallowedtobeinstantiated.

Typexsd:complexType

ChildElementsNone.

Attributes

cabFile xsd:string No SpecifiesthenameoftheCABfile.

string

clsid xsd:string Yes SpecifiestheCLSID(COMclassID)oftheActiveXcontrol.

string

version xsd:string No SpecifiestheActiveXcontrolversionnumber.

string

Definition

<xsd:elementname="allowedControl"><xsd:complexType><xsd:attributename="cabFile"type="xsd:string"use="optional"></xsd:attribute><xsd:attributename="clsid"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="version"type="xsd:string"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksWhentheviewcontainsanOBJECTtag,thecontrolwillbeinstantiatedonlyiftheCLSIDislistedasanallowedControlelementinthepermissionselement.ControlsotherthanthosecorrespondingtotheCLSIDslistedinthepermissionselementarenotallowedtobeinstantiatedintheview.

IfanActiveXcontrollistedinthepermissionselementisnotinstalled(thatis,ifaCLSIDofacontrolisnotregistered),orifanearlierversionofthecontrolthanthatversionspecifiedinthepermissionselementistheonlyversioninstalled,thentherequiredCABfileswillbeinstalled.IftheCABfilesarenotincluded,oriftheinstallationisstopped,theformwillnotopen.

ExampleThefollowingisanexampleoftheallowedControlelement:

<xsf:permissions><xsf:allowedControlcabFile="{84F32C01-78D8-4B93-8ED4-106DA70224C2}.cab”clsid="{84F32C01-78D8-4B93-8ED4-106DA70224C2}"version=”1,0,0,1”/><xsf:allowedControlclsid="{F08DF954-8592-11D1-B16A-00C0F0283630}"/></xsf:permissions>

ShowAll

allowedTasksElement

ContainstheMicrosoftBiztalkServer2004HumanWorkflowServices(HWS)tasksenabledfortheform.

Typexsd:complexType

ChildElements

Element Descriptiontask Containstheinformationforanindividualtask.

AttributesNone.

Definition

<xsd:elementname="allowedTasks"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:task"minOccurs="1"maxOccurs="20"/></xsd:sequence></xsd:complexType><xsd:uniquename="hws_taskID_unique"><xsd:selectorxpath="./xsf:task"/><xsd:fieldxpath="@taskTypeID"/></xsd:unique></xsd:element>

RemarksTheallowedTaskselementisanoptionalelementofthehwsWorkflowelement.

EachtasktobeenabledfortheformmusthaveacorrespondingtaskelementintheallowedTaskssectionoftheformdefinitionfile(.xsf).

ExampleThefollowingisanexampleoftheallowedTaskselement:

<xsf:hwsAdaptername="StartApproval"wsdlUrl="http://www.contoso.com/hwsservice/hwsservice.asmx?WSDL"submitAllowed="yes"queryAllowed="no"><xsf:hwsOperationtype="addActionToNewActivityFlow"typeID="{guid}"serviceUrl="http://www.contoso.com/hwsservice/hwsservice.asmx"><xsf:inputsource="HWSMessage1.xml"><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param1"replaceWith="/my:myFields/my:param1"/><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param2"replaceWith="/a:some/b:thing"dataObject="Aux1"/>

ShowAll

applicationParametersElement

Containsform-specificpropertiesthatdescribehowaformshouldbeusedinMicrosoftOfficeInfoPath2003designmode.

xsd:complexType

Structure

Name Descriptionapplication (Requiredattribute)Identifiesthenameofthe

applicationusedtodesigntheInfoPathform.solutionProperties (Optionalelement)Containsdesign-timeinformation

abouttheInfoPathform.

RemarksTheapplicationParameterselementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleoftheapplicationParameterselement:

<xsf:applicationParametersapplication="InfoPathDesignMode"><xsf:solutionPropertiesallowCustomization="no"lastOpenView="view1"scriptLanguage="JScript"automaticallyCreateNodes="no"lastVersionNeedingTransform="1.1.0.10"fullyEditableNamespace="urn:names?pace1:mynames"/></xsf:applicationParameters>

ShowAll

assignmentActionElement

Definesanactiontosetthevalueofafield.

Typexsd:complexType

ChildElementsNone.

Attributes

targetField xsd:string Yes ContainsanXPathexpressionforthetargetnode.

string

expression xsd:string Yes ContainsanXPathexpressiontopopulatethevalueofthetargetField.

string

Definition

<xsd:elementname="assignmentAction"><xsd:complexType><xsd:attributename="targetField"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="expression"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheassignmentActionelementisachildelementoftheruleelement.

ExampleThefollowingisanexampleoftheassignmentActionelement:

<xsf:rulecaption="Receipts"condition="my:expense>75"><xsf:dialogBoxMessageAction>Don'tforgetyourreceipts!</xsf:dialogBoxMessageAction><xsf:switchViewActionview="ApprovalView"/><xsf:assignmentActiontargetField="my:group8/my:group9/my:target"expression="sum(my:expenses/my:expense)*my:taxRate"/><xsf:queryActionadapter="ExchangeRates"/><xsf:submitActionadapter="ExchangeRates"/><xsf:openNewDocumentActionsolutionURI="uri:microsoft-ExpenseReport"/><xsf:closeDocumentActionpromptToSaveChanges="yes"/><xsf:dialogBoxExpressionAction>my:group/my:field1</xsf:dialogBoxExpressionAction><xsf:exitRuleSet/></xsf:rule>

ShowAll

attachmentFileNameElement

Containsthefilenameofthefileattachmenttobeincludedwiththee-mailmessagewhentheformissubmittedbyusingtheemailAdapterelement.

Typexsd:complexType

ParentElements

Element DescriptionemailAdapter Parentelementthatcontainstheinformationtosubmita

MicrosoftOfficeInfoPathfileasanattachmenttoane-mailmessage,withaspecifiedsetofrecipients,asubject,andanintroduction.

ChildElementsNone.

Attributes

value xsd:string Yes ContainsthevalueoftheattachmentFileNameelement.

string

valueType xsf:xdExpressionLiteralNo SpecifieswhetherthevalueattributeisinterpretedasanXPathexpressionoraliteralstring.

expression

literal

Definition

<xsd:elementname="attachmentFileName"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheattachmentFileNameelementisachildelementoftheemailAdapterelement.

ExampleThefollowingisanexampleoftheattachmentFileNameelement:

<xsf:emailAdaptername="Submit"submitAllowed="yes"><xsf:tovalue="prst@foo.com"valueType="literal"/><xsf:ccvalue="my:ccNames"valueType="expression"/><xsf:bccvalue="john@bar.com"valueType="literal"/><xsf:subjectvalue="Myreport"valueType="literal"/><xsf:introvalue="Seebelow"/><xsf:attachmentFileNamevalue="StatusReport"valueType="literal"/></xsf:emailAdapter>

attributeDataElement

Specifiesthename,andassociatedvalue,ofanattributethatwillbeinserted,ormodifiedifitalreadyexists,bytheinsertactionofthexCollectionorxOptionaleditingcomponents.

xsd:complexType

Structure

Name Descriptionattribute (Requiredattribute)Specifiesthenameoftheattributetobe

inserted.value (Requiredattribute)Specifiesthevalueoftheattributetobe

inserted.

RemarksTheattributeDataelementisanoptionalelementofthechooseFragmentelement.

ExampleThefollowingisanexampleoftheattributeDataelement:

<xsf:editWithcomponent="xOptional"><xsf:fragmentToInsert><xsf:chooseFragmentparent="report"><xsf:attributeDataattribute="author"value="authorname"/></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith>

autoRecoveryElement

SpecifieswhethertheformwillsaveAutoRecoverinformationandwhethertheAutoRecoversettingcanbechangedbytheuser.

Typexsd:complexType

ChildElementsNone.

Attributes

feature xsf:xdEnabledDisabled required SetswhethertheAutoRecoverfeatureisenabled.

enabled

disabled

Definition

<xsd:elementname="autoRecovery"><xsd:complexType><xsd:attributename="feature"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheautoRecoveryelementisanoptionalelementofthefeatureRestrictionselement.

ExampleThefollowingisanexampleoftheautoRecoveryelement:

<xsf:featureRestrictions><xsf:saveui="disabled"/><xsf:sendMailui="disabled"/><xsf:exportToWebui="disabled"/><xsf:exportToExcelui="disabled"/><xsf:printui="enabled"/><xsf:autoRecoveryfeature="disabled"/></xsf:featureRestrictions>

ShowAll

bccElement

ContainsinformationrelatedtotheBCCrecipientsofthee-mailmessagewhentheformissubmittedusingtheemailAdapterelement.

Typexsd:complexType

ParentElements

Element DescriptionemailAdapter Parentelementthatcontainstheinformationneededto

submitaMicrosoftOfficeInfoPath2003SP1fileasanattachmenttoane-mail,withaspecifiedsetofrecipients,asubject,andanintroduction.

ChildElementsNone.

Attributes

value xsd:string Yes Containsthevalueofthebccelement.

string

valueType xsf:xdExpressionLiteralNo SpecifieswhetherthevalueattributeisinterpretedasanXPathexpressionorasaliteralstring.

expression

literal

Definition

<xsd:elementname="bcc"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksIfmultipleaddressesarespecifedforthevalueofthebccelement,theaddressesmustbeseparatedbysemicolons.

ExampleThefollowingisanexampleofthebccelement:

<xsf:emailAdaptername="Submit"submitAllowed="yes"><xsf:tovalue="someone@example.com""valueType="literal"/><xsf:ccvalue="my:ccNames"valueType="expression"/><xsf:bccvalue="someoneelse@example.com"valueType="literal"/><xsf:subjectvalue="Myreport"valueType="literal"/><xsf:introvalue="Seebelow"/><xsf:attachmentFileNamevalue="StatusReport"valueType="literal"/></xsf:emailAdapter>

ShowAll

buttonElement

Definesabuttonthathasanassociatedaction.

xsd:complexType

Structure

Name Descriptionaction (Optionalattribute)Specifiesanactionofanediting

component,usingthesyntax"NameOfEditingComponent::NameOfAction".

caption (Optionalattribute)Providesthecaptiondisplayedonthebutton.

icon (Optionalattribute)ProvidesaUniformResourceLocator(URL)toabitmap(.bmp)orgraphicsinterchangeformat(.gif)file,whichisusedforthebuttonormenuitem.

name (Optionalattribute)UsedtoassociatetheOnClickeventhandlerofthebuttonwithascriptingfunction.

showIf (Optionalattribute)Specifiestheeditingcontextofthebutton.tooltip (Optionalattribute)ProvidestheScreenTiptexttobeusedfor

thebutton.xmlToEdit (Optionalattribute)SpecifiesthenameofanxmlToEdit

element,forwhichthebuttonisused.

RemarksThebuttonelementisanoptionalelementofthetoolbar,menu,andmenuAreaelements.Eachbuttonelementdeclarationcorrespondstoabuttononatoolbar,menu,ormenuareaitem,andeachbuttonhasanaction(orcommand)associatedwithit.

ExampleThefollowingisanexampleofthebuttonelement:

<xsf:menuAreaname="msoInsertMenu"><xsf:menucaption="&Section"><xsf:buttonaction="xCollection::insert"xmlToEdit="CD_10"caption="CD"showIf="always"></xsf:button><xsf:buttonaction="xCollection::insert"xmlToEdit="Track_14"caption="Track"showIf="always"></xsf:button><xsf:buttonaction="xOptional::insert"xmlToEdit="Label_16"caption="Label"></xsf:button></xsf:menu></xsf:menuArea>

ShowAll

calculatedFieldElement

Definesanindividualcalculation,includingtheformula,whenthecalculationistobeperformed,andwheretheresultwillbestored.

Typexsd:complexType

ChildElementsNone.

Attributes

target xsd:string Yes ContainstheXPathlocationwheretheresultoftheexpressionwillbestored.

string

expression xsd:string Yes Containstheformula,intheformofanXPathexpression,tobeevaluated.Theresultisstoredinthetargetlocation.

string

refresh xsd:string Yes Specifieswhentheexpressionwillbeevaluated.

onInit

onChange

Definition

<xsd:elementname="calculatedField"><xsd:complexType><xsd:attributename="target"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="expression"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="refresh"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleofthecalculatedFieldelement:

<xsf:calculations><xsf:calculatedFieldtarget="/my:myFields/my:average"expression="xdMath:Avg(../my:expenses/my:expense/my:amount)"refresh="onChange"/></xsf:calculations>

ShowAll

calculationsElement

Containsdefinitionsforcalculationsperformedintheformandspecifieshowblankvaluesarehandled.

Typexsd:complexType

ChildElements

Element DescriptioncalculatedField Definesanindividualcalculation,includingtheformula,

whenthecalculationistobeperformed,andwheretheresultwillbestored.

Attributes

treatBlankValueAsZero xsf:xdYesNo No Specifieswhetherablankfieldshouldbecalculatedwithavalueofzero.Defaultisyes.

Definition

<xsd:elementname="calculations"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:calculatedField"minOccurs="0"maxOccurs="unbounded"/></xsd:sequence><xsd:attributename="treatBlankValueAsZero"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksEverycalculationintheformwillhaveacalculatedFieldelement.

ExampleThefollowingisanexampleofthecalculationselement:

ShowAll

ccElement

ContainsinformationrelatedtotheCCrecipientsofthee-mailmessagewhentheformissubmittedusingtheemailAdapterelement.

Typexsd:complexType

ParentElements

submitaMicrosoftOfficeInfoPath2003SP1fileasanattachmenttoane-mail,withaspecifiedsetofrecipients,asubject,andanintroduction.

ChildElementsNone.

Attributes

value xsd:string Yes Containsthevalueoftheccelement.

string

valueType xdExpressionLiteral No SpecifieswhetherthevalueattributeisinterpretedasanXPathexpressionoraliteralstring.

expression

literal

Definition

<xsd:elementname="cc"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksIfmultipleaddressesarespecifedforthevalueoftheccelement,theaddressesmustbeseparatedbysemicolons.

ExampleThefollowingisanexampleoftheccelement:

<xsf:emailAdaptername="Submit"submitAllowed="yes"><xsf:tovalue="someone@example.com"valueType="literal"/><xsf:ccvalue="my:ccNames"valueType="expression"/><xsf:bccvalue="someoneelse@example.com"valueType="literal"/><xsf:subjectvalue="Myreport"valueType="literal"/><xsf:introvalue="Seebelow"/><xsf:attachmentFileNamevalue="StatusReport"valueType="literal"/></xsf:emailAdapter>

ShowAll

chooseFragmentElement

SpecifiesanXMLfragment.

xsd:complexType

Structure

Name DescriptionattributeData (Optionalelement)Specifiesthename,and

associatedvalue,ofanattributethatwillbeinserted,ormodifiedifitalreadyexists,bytheinsertactionofthexCollectionorxOptionaleditingcomponents.

followingSiblings (Optionalattribute)SpecifiesarelativeXPathexpressionfromtheparentnodethatspecifiestheXMLDocumentObjectModel(DOM)nodespriortowhichtheinsertionoftheXMLfragmentshouldoccur.

NoteThisisnotnecessaryinMicrosoftOfficeInfoPath2003ServicePack1andwillnotbeautomaticallygeneratedbyInfoPath.

parent (Optionalattribute)SpecifiesarelativeXPathexpressionfromthecontainernodethatspecifiestheXMLDOMnodeunderwhichtheXMLfragmentisinserted.

innerFragment (Optionalattribute)SpecifiesarelativeXPathexpressionfromtheparentnodetothesmallestfragmenttobeinserted.

NoteUseofthisattributerequiresMicrosoftOfficeInfoPath2003ServicePack1.

RemarksThechooseFragmentelementisarequiredelementofthefragmentToInsertelement.

ThechooseFragmentelementhasanopencontentmodel.Itmaycontaintext,oroneormoreelementnodes,ormixedcontent(bothelementnodesandtextnodes).InadditiontoorinsteadofXMLdatatobeinserteddirectlyasafragment,itcancontainoneormoreattributeDataelements.InthiscasetheattributeDataelementsarenotincludedasinsertedcontent,butareeachusedtospecifysettinganattributevalue.

ThechooseFragmentelementsaretypicallyorderedinincreasingsize.ThefirstwillbethedatafragmenttobeinsertedbytheinsertBeforeandinsertAfteractions,whenthereisalreadyatleastoneiteminthecollection.Theinsertaction,ontheotherhand,canbeinvokedwhenthereiscurrentlyanodeintheXMLtreecorrespondingtoacontainer,butnonodecorrespondingtoanitem(inotherwords,itcanbeusedtoinsertthefirstitem).

NoteMicrosoftOfficeInfoPath2003ServicePack1willgenerateonlyonechooseFragmentnode.Formoreinformation,seetheinnerFragmentattribute.

NoteAnyelementcontentwithintheXMLfragment,otherthanattributedata,correspondstonewcontenttobeinsertedintotheform'sunderlyingXMLdocument,andshouldbeintheappropriatenamespace.

ExampleThefollowingisanexampleofthechooseFragmentelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample"><xsf:editWithcaption="CD"xd:autogeneration="template"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentparent="CDCollection"><CD><Title></Title><Artist></Artist><Tracks><Track></Track><Track></Track></Tracks></CD></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit></xsf:editing>

ShowAll

closeDocumentActionElement

Definesaformcloseaction.

Typexsd:complexType

ChildElementsNone.

Attributes

promptToSaveChanges xdYesNo Yes Specifieswhethertheuserispromptedtosavechangestotheformbeforetheactioncompletes.Defaultis"yes".

Definition

<xsd:elementname="closeDocumentAction"><xsd:complexType><xsd:attributename="promptToSaveChanges"type="xsf:xdYesNo"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksThecloseDocumentActionelementisachildelementoftheruleelement.

ExampleThefollowingisanexampleofthecloseDocumentActionelement:

ShowAll

customCategoryElement

SpecifiesthecategorythattheformtemplateappearsunderintheFillOutaFormtaskpane.

Typexsd:complexType

ChildElementsNone.

Attributes

Attribute Type Required Description PossibleValuesname xsf:xdTitle required Specifies

thenameofthecustomcategory.

minLength=1

maxLength=255

pattern=([^\p{Z}\p{Cc}\p{Cf}\p{Cn}])(([^\p{Zl}\p{Zp}\p{Cc}])*([^\p{Z}\p{Cc}\p{Cf}\p{Cn}]))?

Definition

<xsd:elementname="customCategory"><xsd:complexType><xsd:attributename="name"type="xsf:xdTitle"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksThecustomCategoryelementisanoptionalelementoftheinitialXmlDocumentelement.

ExampleThefollowingisanexampleofthecustomCategoryelement:

<xsf:fileNew><xsf:initialXmlDocumentcaption="TravelReport"href="TravelReportTemplate.xml"><xsf:customCategoryname="Reports"/></xsf:initialXmlDocument></xsf:fileNew>

ShowAll

customValidationElement

Definesrule-basedcustomvalidationontopofallvalidationenforcedthroughtheXMLSchema.

xsd:complexType

Structure

Name DescriptionerrorCondition (Optionalelement)Definesacustomvalidation(orerror

condition)foraspecificXMLDocumentObjectModel(DOM)nodeinaform'sunderlyingXMLdocument.

RemarksThecustomValidationelementisanoptionalelementofthexDocumentClasselement.

NoteItispossibletocreatemultipleerrorconditionsonafieldinaformusingmultipleerrorConditionelements,buttheywillnotappearintheDataValidationdialogboxwhileindesignmode.

ExampleThefollowingisanexampleofthecustomValidationelement:

<xsf:customValidation><xsf:errorConditionmatch="/exp:expenseReport"expressionContext="exp:reportDate"expression="msxsl:string-compare(.,../exp:startDate)<0and../exp:startDate!="""showErrorOn="."><xsf:errorMessagetype="modeless"shortMessage="Thereportdateoccursbeforetheendoftheexpenseperiod.">Thereportdateoccursbeforetheendoftheexpenseperiod.Verifythatthisiscorrect.</xsf:errorMessage></xsf:errorCondition></xsf:customValidation>

ShowAll

dataAdaptersElement

Containsinformationaboutsubmitadaptersthatareusedasthemainsubmitadaptersfortheformandthatthereforearenotdeclaredinlinewithinthesubmitelement.

Typexsd:complexType

ChildElements

Element DescriptionwebServiceAdapter ContainsinformationtoenableInfoPathformsto

besubmittedtoanXMLWebservice.davAdapter ContainsinformationtoenableInfoPathformsto

besubmittedtoaserverrunningMicrosoftWindowsSharePointServicesortoaWeb-basedDistributedAuthoringandVersioning(WebDAV)server.

emailAdapter ContainsinformationtoenablesubmissionofanInfopathformasanattachmenttoane-mail,withaspecifiedsetofrecipients,asubject,andanintroduction.

hwsAdapter DefinestheMicrosoftBiztalk2004HumanWorkflowServices(HWS)dataadapterthatisusedtostartorextendanactivityflowandrespondtoatask.

AttributesNone.

Definition

<xsd:elementname="dataAdapters"><xsd:complexType><xsd:choiceminOccurs="0"maxOccurs="unbounded"><xsd:elementref="xsf:webServiceAdapter"/><xsd:elementref="xsf:davAdapter"/><xsd:elementref="xsf:emailAdapter"/><xsd:elementref="xsf:hwsAdapter"/></xsd:choice></xsd:complexType></xsd:element>

RemarksThedataAdapterselementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleofthedataAdapterselement:

<xsf:dataAdapters><xsf:webServiceAdaptername="submit2"...submitAllowed="yes">...</xsf:webServiceAdapter><xsf:emailAdaptername="submit4"…submitAllowed="yes"/></xsf:dataAdapters>

ShowAll

dataObjectElement

DefinesasecondarydataobjectthatisusedinaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name DescriptioninitOnLoad (Optionalattribute)Specifieswhetherthedataobjectshould

beinitializedondocumentload.name (Requiredattribute)Theuniquenameforthedataobject.schema (Optionalattribute)ThenameofanXMLSchemafile.query (Requiredelement)Associatesthedataadapterwiththe

dataobjectoraform'sunderlyingXMLdocument.

RemarksThedataObjectelementisanoptionalelementofthedataObjectselement.

MultipledataObjectelementsareallowedwithinaform.EachdataobjectisanXMLDocumentObjectModel(DOM)populatedfromanexternaldatasourcethatcanbeaccesseddirectly(byname)fromtheXSLTransformation(XSLT)–basedviewcodeandanyscript-basedbusinesslogiccodeintheform.

ExampleThefollowingisanexampleofthedataObjectelement:

<xsf:dataObjects><xsf:dataObjectname="EmployeeNames"schema="EmployeeNames.xsd"initOnLoad="yes"><xsf:query><xsf:adoAdapterconnectionString="Provider=Microsoft.Jet.OLEDB.4.0;Password="";UserID=Admin;DataSource=infnwind.mdb;Mode=ShareDenyNone;ExtendedProperties="";..."commandText="select[EmployeeID],[LastName],[FirstName]from[Employees]as[Employees]"queryAllowed="yes"submitAllowed="yes"></xsf:adoAdapter> </xsf:query> </xsf:dataObject> </xsf:dataObjects>

ShowAll

dataObjectsElement

DefinesallsecondarydataobjectsusedinaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name DescriptiondataObject (Optionalelement)Definesasecondarydataobjectthatis

usedinanInfoPathform.

RemarksThedataObjectselementisanoptionalelementofthexDocumentClasselement.

ThedataObjectselementcontainsacollectionofdataobjectsthatareusedtopopulatevariousXMLDocumentObjectModels(DOMs)fromexternaldatasources.Thesedataobjectscanbeaccesseddirectly(byname)fromtheXSLTransformation(XSLT)–basedviewcodeandanyscript-basedbusinesslogiccodeintheform.

ExampleThefollowingisanexampleofthedataObjectselement:

ShowAll

davAdapterElement

ContainsinformationtoenableInfoPathformstobesubmittedtoaserverrunningMicrosoftWindowsSharePointServicesortoaWeb-basedDistributedAuthoringandVersioning(WebDAV)server.

Typexsd:complexType

ChildElements

Element DescriptionfolderURL ContainstheUniformResourceLocator(URL)oftheserver

towhichthefileissubmitted.fileName ContainsthenameofthefileasaliteralstringorXPath

expression.

Attributes

Attribute Type Required Description PossibleValuesname xdTitle Yes Thenameof

theadapter.UsedwheninvokingthedavAdapterfromcode.

minLength=1

maxLength=255

overwriteAllowed xdYesNo No Specifieswhethertheadaptercanoverwriteanexistingfile.

queryAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforqueryingthedatasource.OmittedforthedavAdapter,correspondingtoadefaultvalueof"no".

submitAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforsubmittingtothedatasource.Alwayssetto

"yes"forthedavAdapter.

Definition

<xsd:elementname="davAdapter"><xsd:complexType><xsd:all><xsd:elementname="folderURL"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementname="fileName"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element></xsd:all><xsd:attributename="name"type="xsf:xdTitle"use="required"></xsd:attribute><xsd:attributename="overwriteAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute><xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute><xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleofthedavAdapterelement:

<xsf:davAdaptername="SubmitToSharePoint"overwriteAllowed="yes"submitAllowed="yes"><xsf:fileNamevalue="my:myFields/my:fileName"valueType="expression"/><xsf:folderURLvalue="http://some_server/some_doc_lib"/></xsf:davAdapter>

ShowAll

dialogBoxExpressionActionElement

DefinesanXPathexpressiontobedisplayedinadialogbox.

Typexsd:string

ChildElementsNone.

AttributesNone.

Definition

<xsd:elementname="dialogBoxExpressionAction"type="xsd:string"></xsd:element>

RemarksThedialogBoxExpressionActionelementisachildelementoftheruleelement.

ExampleThefollowingisanexampleofthedialogBoxExpressionActionelement:

dialogBoxMessageActionElement

Definesaliteralmessagetobedisplayedinadialogbox.

Typexsd:simpleType

ChildElementsNone.

AttributesNone.

Definition

<xsd:elementname="dialogBoxMessageAction"><xsd:simpleType><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="1024"/></xsd:restriction></xsd:simpleType></xsd:element>

RemarksThedialogBoxMessageActionelementisachildelementoftheruleelement.

Themaximumlengthofthemessageis1,024characters.

ExampleThefollowingisanexampleofthedialogBoxMessageActionelement:

<<xsf:rulecaption="Receipts"condition="my:expense>75"><xsf:dialogBoxMessageAction>Don'tforgetyourreceipts!</xsf:dialogBoxMessageAction><xsf:switchViewActionview="ApprovalView"/><xsf:assignmentActiontargetField="my:group8/my:group9/my:target"expression="sum(my:expenses/my:expense)*my:taxRate"/><xsf:queryActionadapter="ExchangeRates"/><xsf:submitActionadapter="ExchangeRates"/><xsf:openNewDocumentActionsolutionURI="uri:microsoft-ExpenseReport"/><xsf:closeDocumentActionpromptToSaveChanges="yes"/><xsf:dialogBoxExpressionAction>my:group/my:field1</xsf:dialogBoxExpressionAction><xsf:exitRuleSet/></xsf:rule>

ShowAll

documentSchemaElement

DefinesanXMLSchemaforaform.

xsd:complexType

Structure

Name Descriptionlocation (Requiredattribute)ContainsthenamespaceUniform

ResourceIdentifier(URI)andlocation(aUniformResourceLocator(URL),relativetotheformdefinition(.xsf)file),anddelimitedbyawhitespace,ofthe.xsdfiledefiningtheXMLSchema.

rootSchema (Optionalattribute)IdentifiesanXMLSchemaasthetop-levelschemaoftheformbeingfilledout.

RemarksThedocumentSchemaelementisarequiredelementofthedocumentSchemaselement.OnedocumentSchemaelementispresentforeachdeclaredXMLSchemaintheform.

MicrosoftOfficeInfoPath2003includesallXMLSchemasintheformtemplateandmodifiestheschemareferencesinthe.xsdfilestoberelativepathnames.Ifaform'sunderlyingXMLdocumentcontainsreferencestomultipleXMLSchemas,theyarelistedwithseparatedocumentSchemaelementsandthetop-levelXMLSchemahasitsrootSchemaattributesetto"yes".

IfanXMLSchemafilecontainsreferencestootherXMLSchemafilesusingtheincludeorimportsettings,thosereferencedfilesdonothavetobelistedinthedocumentSchemaselement.However,theymustbeincludedintheformtemplatewiththeirreferenceschangedtorelativefilenames.

ExampleThefollowingisanexampleofthedocumentSchemaelement:

<xsf:documentSchemas><xsf:documentSchemalocation="urn:schema:custom:NamespacecustomFilename.xsd"rootSchema="yes"/></xsf:documentSchemas>

ShowAll

documentSchemasElement

DefinestheXMLSchemasthattheMicrosoftOfficeInfoPath2003formisdesignedtohandle.

xsd:complexType

Structure

Name DescriptiondocumentSchema (Requiredelement)DefinesanXMLSchemafora

form.OnedocumentSchemaelementispresentforeachdeclaredXMLSchemaintheform.

RemarksThedocumentSchemaselementisanoptionalelementofthexDocumentClasselement.ItdefinesallofthetargetXMLSchemasthatareusedintheform.

ExampleThefollowingisanexampleofthedocumentSchemaselement:

ShowAll

documentSignaturesElement

ContainsthesignedDataBlockelement,whichdefineshowdigitalsignaturesareappliedtoaformorsectionofaform.

xsd:complexType

Structure

Name DescriptionsignatureLocation (Optionalattribute)ContainsanXPathexpression

thatpointstotheXMLDOMnodewithintheform'sunderlyingXMLdocumentthatisusedforstoringthedigitalsignature.

ChildElements

Element DescriptionsignedDataBlock Definesanodesetintheform'sunderlyingXML

documenttowhichadigitalsignaturecanbeapplied.

Definition

<xsd:elementname="documentSignatures"> <xsd:complexType> <xsd:sequence> <xsd:elementref="xsf:signedDataBlock"minOccurs="0"maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributename="signatureLocation"type="xsd:string"use="optional"/> </xsd:complexType> </xsd:element> <xsd:elementname="signedDataBlock"> <xsd:complexType> <xsd:sequence> <xsd:elementname="message"type="xsf:xdSignedDataBlockMessage"minOccurs="0"/> </xsd:sequence> <xsd:attributename="name"type="xsf:xdSignedDataBlockName"use="required"/> <xsd:attributename="data"type="xsd:string"use="required"/> <xsd:attributename="signatureLocation"type="xsd:string"use="required"/> <xsd:attributename="mode"type="xsf:xdSignatureRelationEnum"use="required"/> </xsd:complexType> <xsd:uniquename="signedDataBlock_name_unique"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@name"/> </xsd:unique> </xsd:element>

RemarksThesignedDataBlockelementisanewXSFelementadditioninMicrosoftOfficeInfoPath2003ServicePack1.Seebelowforbackwardcompatibilityinformationwith1.0formsolutions.

Forbackwardcompatibility,thedocumentsignatureselementdefinesthelocationofthedigitalsignatureXMLDocumentObjectModel(DOM)nodewithintheform'sunderlyingXMLdocument.

ThedocumentSignatureselementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleofthedocumentSignatureselement:

<xsf:documentSignaturessignatureLocation=”my:myfields/my:subtree1|my:myfields/my:subtree2”/>

ThefollowingisanexampleofthedocumentSignatureselementusedinMicrosoftOfficeInfoPath2003ServicePack1:

<xsf:documentSignatures><xsf:signedDataBlockname="main"data="my:myfields/my:subtree1|my:myfields/my:subtree2"signatureLocation="my:mifields/sig:signatures/main"mode="countersign"><xsf:message>Bypressingthe"Sign"buttonbelow,Iagreetobeboundtothetermsofthisdocument.</xsf:message></xsf:signedDataBlock></xsf:documentSignatures>

ShowAll

documentVersionUpgradeElement

Defineshowformscreatedwithanolderversionoftheformtemplatecanbeupgradedtothelatestversionoftheformtemplate.

xsd:complexType

Structure

Name DescriptionuseScriptHandler (Optionalelement)Specifiesthattheupgradewillbe

handledusingscriptingcode.useTransform (Optionalelement)Specifiesthattheupgradewillbe

handledbyanXSLTransformation(XSLT)suppliedbythenewerversionoftheformtemplate.

RemarksThedocumentVersionUpgradeelementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleofthedocumentVersionUpgradeelement:

<xsf:documentVersionUpgrade><xsf:useTransformtransform="upgrade.xsl"minVersionToUpgrade="0.0.0.0"maxVersionToUpgrade="1.0.0.5"/></xsf:documentVersionUpgrade>

ShowAll

domEventHandlerElement

DefinesaneventhandlerforoneormorespecificXMLDocumentObjectModel(DOM)nodes.

xsd:complexType

Structure

Name DescriptionhandlerObject (Requiredattribute)Identifiestheuniquenameofthe

eventhandlerinthescriptingcode.match (Requiredattribute)IdentifiestheXMLDOMnodefor

whichtheeventhandlerisdeclared.ValuemustbeavalidXPathexpressionthatidentifiestheXMLnode.

dataObject (Optionalattribute)ContainsthenameofthedataObjecttobeusedintheeventhandler.

NoteUseofthisattributerequiresMicrosoftOfficeInfoPath2003ServicePack1.

RemarksThedomEventHandlerelementisanoptionalelementofthedomEventHandlerselement.

ExampleThefollowingisanexampleofthedomEventHandlerelement:

<xsf:domEventHandlers><xsf:domEventHandlermatch="TravelReport/Expenses"handlerObject="TravelExpenses"/></xsf:domEventHandlers>

ShowAll

domEventHandlersElement

Containspointerstovariousscript-basedeventhandlersthatreacttochangesinXMLDocumentObjectModel(DOM)nodesofaform'sunderlyingXMLdocumentwhentheformisbeingfilledout.

xsd:complexType

Structure

Name DescriptiondomEventHandler (Optionalelement)Definesaneventhandlerobject

foroneormorespecificXMLDOMnodes.

RemarksThedomEventHandlerselementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleofthedomEventHandlerselement:

ShowAll

editingElement

Containsinformationabouttheeditingcomponentsusedintheview.

xsd:complexType

Structure

Name DescriptionxmlToEdit (Optionalelement)Specifiesaninstanceofanediting

component.

RemarksTheeditingelementisanoptionalelementoftheviewelement.

TheeditingcomponentssectionoftheMicrosoftOfficeInfoPath2003formdefinition(.xsf)filedefineshowandwhenusersareabletoeditspecifiedXMLDocumentObjectModel(DOM)nodesofaform'sunderlyingXMLdocument.Onlyoneeditingelementisallowedperview.EacheditingelementcancontainzeroormorexmlToEditelements.

ExampleThefollowingisanexampleoftheeditingelement:

ShowAll

editWithElement

Specifiesaninstanceofaneditingcomponent,andprovidesthecorrespondingparameterstodetermineitsexactbehavior.

xsd:complexType

Structure

Name DescriptionallowedFileTypes (Optionalattribute)Specifiesthefileextensionsof

filesthatcanbeattachedtotheform.autoComplete (Optionalattribute)Switchestheauto-completionof

fieldsonoroff.caption (Optionalattribute)Specifiesanidentifierfor

alternateformsofXMLdatatobeusedintheeditingcomponent.

component (Requiredattribute)Specifiesthenameoftheeditingcomponentthatwillbereferencedwithintheactionattributeofabuttonelement.

field (Optionalattribute)SpecifiesarelativeXPathexpressionfromtheXMLDocumentObjectModel(DOM)nodespecifiedbytheitemattributeofthexmlToEditelement.

fragmentToInsert (Optionalelement)ContainsalternateversionsofXMLdata(fragments).

proofing (Optionalattribute)Switchestheproofingfeatures,suchasthespellingchecker,onoroff.

removeAncestors (Optionalattribute)Specifiesthenumberofancestor(parent)elementstoberemovedwhenthelastitemisremoved.

type (Optionalattribute)SpecifiesthetypeofeditingforthefieldsthatmatchtheXPathexpressionspecifiedbytheitemattributeofthexmlToEditelement.

widgetIcon (Optionalattribute)Specifieswhetherornotamodifiedwidgeticonwillbeshownforfiltereditems.

useFilter (Optionalattribute)Indicatestheuserwantsafilterwidget.

filterDependency (Optionalattribute)Specifiesautomaticreapplicationofthefilterwhenfilterfieldschange.

maxLength (Optionalattribute)Specifiesthemaximumnumberofcharactersallowedfortextboxes.

RemarksTheeditWithelementisanoptionalelementofthexmlToEditelement.

IftheviewContextattributeofthexmlToEditelementisdefined,theparametersoftheeditWithelementareassociatedwiththespecifiedviewcontext.

ExampleThefollowingisanexampleoftheeditWithelement:

emailAdapterElement

ContainstheinformationneededtosubmitanInfoPathformasanattachmenttoane-mail,withaspecifiedsetofrecipients,asubject,andanintroduction.

Typexsd:complexType

ChildElements

Element Descriptionto Containsalistofaddresses,separatedby

semicolons,tobeaddedtothetolineofthesubmittede-mail.

cc Containsalistofaddresses,separatedbysemicolons,tobeaddedtothecclineofthesubmittede-mail.

bcc Containsalistofaddresses,separatedbysemicolons,tobeaddedtothebcclineofthesubmittede-mail.

subject Containsthesubjectofthesubmittede-mail.intro Containstheintroductionofthesubmittede-mail.attachmentFileName Containsthefilenameoftheattachmenttobe

submittedwiththee-mail.

Attributes

Attribute Type Required Description PossibleValuesname xdTitle Yes Containsthe

nameoftheemailAdapter.

minLength=1

maxLength=255

queryAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforqueryingthedatasource.OmittedfortheemailAdapter,correspondingtoadefaultvalueof"no".

submitAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforsubmittingtothedatasource.Alwayssetto"yes"fortheemailAdapter.

Definition

<xsd:elementname="emailAdapter"><xsd:complexType><xsd:all><xsd:elementname="to"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementname="cc"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementname="bcc"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementname="subject"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementname="intro"minOccurs="0"><xsd:complexType>

<xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementname="attachmentFileName"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element></xsd:all><xsd:attributename="name"type="xsf:xdTitle"use="required"></xsd:attribute><xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute><xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleoftheemailAdapterelement:

ShowAll

errorConditionElement

Definesacustomvalidation(orerrorcondition)foraspecificXMLDocumentObjectModel(DOM)nodeinaform'sunderlyingXMLdocument.

xsd:complexType

Structure

Name Descriptionexpression (Requiredattribute)AnXPathexpression(relative

totheexpressionContextattribute,ifspecified)thatmustbeevaluatedtovalidatetheXMLDOMnodespecifiedinthematchattribute.

expressionContext (Optionalattribute)SpecifiestheXMLDOMnodeonwhichtheexpressionspecifiedintheexpressionattributeisrooted.

match (Requiredattribute)IdentifiestheXMLDOMnodesonwhichthecustomvalidationisdeclared.

showErrorOn (Optionalattribute)IdentifiesXMLDOMnodes(withinthecontextoftheexpressioncontextXMLDOMnode)onwhichtheerrorshouldbedisplayedwhentheformisfilledout.

errorMessage (Requiredelement)SpecifiestheerrormessagetobereturnedifthevalueofthespecifiedXMLDOMnodeisconsideredtobeinvalid.

RemarksTheerrorConditionelementisanoptionalelementofthecustomValidationelement.

ExampleThefollowingisanexampleoftheerrorConditionelement:

ShowAll

errorMessageElement

SpecifiestheerrormessagethatshouldbereturnedifthevalueofthespecifiedXMLDocumentObjectModel(DOM)nodeisconsideredtobeinvalid.

xsf:xdErrorMessage

Structure

Name DescriptionshortMessage (Requiredattribute)Identifiestheshorterrormessageto

returnincaseofinvaliddata.type (Optionalattribute)Identifiesthetypeoferrormessage

toreturn.

RemarksTheerrorMessageelementisarequiredelementoftheerrorCondition,override,andsubmitelements.

YoucansupplyadetailederrormessageasthevalueoftheerrorMessageelement.Thedetailederrormessageisdisplayedbyclickingtheshortcutmenu'sFullerrordescriptionbuttonwhenerrorinformationisdisplayedandwhentheerrormessagetypeattributeissetto"modal".

ExampleThefollowingisanexampleoftheerrorMessageelement:

ShowAll

exitRuleSetElement

AnelementthatstopsfurtherruleprocessingoftheentireruleSet.

Typexsd:complexType

ParentElements

Element Descriptionrule Definesanactioninvokedafteraneventhasoccurredinthe

ChildElementsNone.

AttributesNone.

Definition

<xsd:elementname="exitRuleSet"minOccurs="0"><xsd:complexType/></xsd:element>

RemarksTheexitRuleSetelementmustbethelastchildelementoftheruleelement.TheruleSetelementprocessingwillbehaltedonlyiftheruleelementisexecuted.

ExampleThefollowingisanexampleoftheexitRuleSetelement:

ShowAll

exportToExcelElement

Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstoexporttheformtoaMicrosoftOfficeExcel2003workbook.

Typexsd:complexType

ChildElementsNone.

Attributes

ui xsf:xdEnabledDisabled required SetswhethertheusercanexportthecontentsoftheformtoanExcelworkbook.

enabled

disabled

Definition

<xsd:elementname="exportToExcel"><xsd:complexType><xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheexportToExcelelementisanoptionalelementofthefeatureRestrictionselement.Ifthiselementisnotincludedintheformdefinitionfile(.xsf),theusercanusetheform'smenus,toolbars,orkeyboardshortcutstoexporttheformtoanExcelworkbook.

ExampleThefollowingisanexampleoftheexportToExcelelement:

ShowAll

exportToWebElement

Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstoexporttheformtoaWebpage.

Typexsd:complexType

ChildElementsNone.

Attributes

ui xsf:xdEnabledDisabled required SetswhethertheusercanexportthecontentsoftheformtoaWebpage.

enabled

disabled

Definition

<xsd:elementname="exportToWeb"><xsd:complexType><xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheexportToWebelementisanoptionalelementofthefeatureRestrictionselement.Ifthiselementisnotincludedintheformdefinitionfile(.xsf),theusercanusetheform'smenus,toolbars,orkeyboardshortcutstoexporttheformtoaWebpage.

ExampleThefollowingisanexampleoftheexportToWebelement:

ShowAll

extensionElement

Containsopencontentmodelinformation.

xsd:complexType

Structure

Name Descriptionname (Requiredattribute)Auniquenameidentifyingtheextension

beingspecified.

RemarksTheextensionelementisanoptionalelementoftheextensionselement.

NoteUseoftheextensionelementisreserved.MicrosoftOfficeInfoPath2003ignoresanycontentwithintheextensionelement.

ExampleThefollowingisanexampleoftheextensionelement:

<xsf:extensions><xsf:extensionname="someValue"anyAttributesHere="someValue">...opencontentmodelhere...</xsf:extension><xsf:extensions>

ShowAll

extensionsElement

IncludesminorupgradestotheMicrosoftOfficeInfoPath2003formdefinition(.xsf)filethatcanbeusedbyspecificfutureversionsofInfoPathorbyspecificforms.

xsd:complexType

Structure

Name Descriptionextension (Optionalelement)Containsopencontentmodelinformation.

RemarksTheextensionselementisanoptionalelementofthexDocumentClasselement.

Theextensionselementcontainszeroormoreextensionelements,eachofwhichhasanopencontentmodel.

ExampleThefollowingisanexampleoftheextensionselement:

ShowAll

externalViewElement

DefinesaviewthatcannotbeeditedinMicrosoftOfficeInfoPath.

Typexsd:complexType

ChildElements

Element Descriptionmainpane SpecifiestheXSLTransformation(XSLT)tobeappliedtothe

Attributes

Attribute Type Required Description PossibleValuesname xsf:xdViewName Yes Containsthe

nameoftheexternalViewelement.

minlength=1

maxlength=255

pattern=([^\p{Z}\p{C}/\\#&"><])(([^\p{Zl}\p{Zp}\p{C}/\\#&"><])*([^\p{Z}\p{C}/\\#&"><]))?

Definition

<xsd:elementname="externalView"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:mainpane"/></xsd:sequence><xsd:attributename="name"type="xsf:xdViewName"use="required"/></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleoftheexternalViewelement:

<xsf:externalViews><xsf:externalViewname="SalesDoc"><xsf:mainpanetransform="myWordView.xsl"/></xsf:externalView><xsf:externalViews>

ShowAll

externalViewsElement

ContainsoneormoreexternalViewelements.

Typexsd:complexType

ChildElements

Element DescriptionexternalViewDefinesaviewthatcannotbeeditedinMicrosoftOffice

InfoPath.

AttributesNone.

Definition

<xsd:elementname="externalViews"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:externalView"minOccurs="1"maxOccurs="unbounded"/></xsd:sequence></xsd:complexType><xsd:uniquename="externalViews_name_unique"><xsd:selectorxpath="./xsf:externalView"/><xsd:fieldxpath="@default"/></xsd:unique><xsd:keyrefname="external_views_printView"refer="xsf:externalView_name_key"><xsd:selectorxpath="."/><xsd:fieldxpath="@default"/></xsd:keyref></xsd:element>

ExampleThefollowingisanexampleoftheexternalViewselement:

ShowAll

featureRestrictionsElement

Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstosavetheform,exporttheform,printtheform,orsendtheformasane-mailattachment.

Typexsd:complexType

ChildElements

Element Descriptionsave (Optionalelement)Specifieswhethertheusercanuse

theform'smenus,toolbars,orkeyboardshortcutstosavetheform.

exportToWeb (Optionalelement)Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstoexporttheformtoaWebpage.

exportToExcel (Optionalelement)Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstoexporttheformtoanMicrosoftOfficeExcel2003workbook.

print (Optionalelement)Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstoprinttheform.

sendMail (Optionalelement)Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstosendtheformasane-mailattachment.

autoRecovery (Optionalelement)SpecifieswhethertheformwillsaveAutoRecoverinformationandwhethertheAutoRecoversettingcanbechangedbytheuser.

AttributesNone.

Definition

<xsd:elementname="featureRestrictions"><xsd:complexType><xsd:all><xsd:elementname="save"minOccurs="0"><xsd:complexType><xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementref="xsf:exportToWeb"minOccurs="0"/><xsd:elementref="xsf:exportToExcel"minOccurs="0"/><xsd:elementref="xsf:print"minOccurs="0"/><xsd:elementref="xsf:sendMail"minOccurs="0"/><xsd:elementref="xsf:autoRecovery"minOccurs="0"/></xsd:all></xsd:complexType></xsd:element>

RemarksDisablinganyofthefeatureRestrictionselement'schildelementsdoesnotdisabletheuseofformcodetosavetheform,exporttheform,printtheform,orsendtheformasanemailattachment.

ExampleThefollowingisanexampleofthefeatureRestrictionselement:

ShowAll

fieldElement

Definesonefieldforformlibrarycolumns.

xsd:complexType

Structure

Name Descriptionaggregation (Optionalattribute)SpecifieshowtheXMLDocument

ObjectModel(DOM)nodesreturnedfromanXPathexpressioninthenodeattributeshouldbeaggregatedtoobtainasinglevalueforthedocument.Caneitherbeanaggregationactionoranindicationoftheparticularelementinthecollection.

columnName (Requiredattribute)IdentifiesthecolumnnameintheSQLtable(underlyingtheformlistview).

maxLength (Optionalattribute)Definesthelengthofthefieldinnumberofbytes.

name (Requiredattribute)Identifiesthefriendlynameofthefieldtobeusedontheformlistview.

node (Requiredattribute)DefinestheXPathexpressionneededtoextractthevalueofthespecifiedpropertyfromtheform'sunderlyingXMLdocument.

required (Optionalattribute)Specifieswhetherthisfieldacceptsnullvalues.

type (Requiredattribute)IdentifiesthestandardXMLSchemadatatype.

viewable (Optionalattribute)Specifieswhetherthisfieldshouldbeaddedtothedefaultview.Possiblevalues"yes"and"no".Thedefaultvalueis"no".

RemarksThefieldelementisanoptionalelementofthefieldselement.

ExampleThefollowingisanexampleofthefieldelement:

<xsf:listProperties><xsf:fields><xsf:fieldtype="xsd:date"name="TravelDate"columnName="TravelDate"required="yes"viewable="yes"node="TravelReport/Header/travelDate"aggregation="first"/></xsf:fields></xsf:listProperties>

fieldElement(sharepointListAdapterElement)

ContainsfieldmappinginformationforeachfieldinaSharePointlistandthecorrespondingnameusedinInfoPath.

Typexsd:ComplexType

ParentElements

Element DescriptionsharepointListAdapter Containsthedataadapterinformationtoquery

aSharePointlistorlibrary.

ChildElementsNone.

Attributes

sharepointName xsd:string Yes ContainsthenameofafieldinaSharePointlist.

string

infopathName xsd:string Yes ContainsthecorrespondingInfoPathfieldnameforthesharepointName.

string

isLookup xdYesNo No SpecifieswhetherafieldinaSharePointlistisalookupfield.Thedefaultis"no".

Definition

<xsd:elementname="field"minOccurs="0"maxOccurs="unbounded"><xsd:complexType><xsd:attributename="sharepointName"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="infopathName"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="isLookup"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksEachfieldreturnedfromaSharePointlistorlibrarybythesharepointListAdapterdataadapterwillhaveafieldelement.

ExampleThefollowingisanexampleofthefieldelement:

<xsf:fieldsharepointName="xd__x007b_D00F1DBD_..."infopathName="Title_1"isLookup="no"></xsf:field>

fieldsElement

Definesasetofoneormorefieldelements.

xsd:complexType

Structure

Name Descriptionfield (Optionalelement)Definesonefieldforformlibrarycolumns.

RemarksThefieldselementisanoptionalelementofthelistPropertieselement.

ExampleThefollowingisanexampleofthefieldselement:

fileElement

IdentifiesafileaspartofaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name Descriptionname (Requiredattribute)Specifiesthenameofthefile.fileProperties (Optionalelement)Definesthepropertiesofafile.

RemarksThefileelementisanoptionalelementofthefileselement.

ExampleThefollowingisanexampleofthefileelement:

<xsf:package><xsf:files><xsf:filename="view_1.xsl"><xsf:fileProperties><xsf:propertyname="lang"type="string"value="1033"/></xsf:fileProperties></xsf:file></xsf:files></xsf:package>

ShowAll

fileNameElement

SpecifiesthefilenameoranexpressionthatreturnsafilenamewhentheformissubmittedusingthedavAdapter.

Typexsd:complexType

ParentElements

Element DescriptiondavAdapter Theparentelementthatcontainsalltheinformation

necessarytosubmitfilestoaserverthatisrunningMicrosoftWindowsSharePointServicesoraWebbasedDistributedAuthoringandVersioning(WebDAV)server.

ChildElementsNone.

Attributes

value xsd:string Yes Containsthenameofthefile,oncesubmittedtotheserver.

string

valueType xsf:xdExpressionLiteralNo SpecifieswhetherthenameofthefileshouldbeinterpretedasanXPathexpressionorasaliteralstring.

expression

literal

Definition

<xsd:elementname="fileName"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheextension".xml"isappendedtothefilenameifafilenameextensionisnotspecified.

Thefollowingsystemreservedcharacterswillbereplacedbyanunderscore("_")characterwhenaformissubmitted:

\/:*?"<>|

ExampleThefollowingisanexampleofthefileNameelement:

<xsf:fileNamevalue="my:myFields/my:fileName"valueType="expression"/>

ShowAll

fileNewElement

Providesareferencetoan.xmlfilecontainingsampledatatobeloadedwhenauserchoosestocreateanewformbasedontheformtemplate.

xsd:complexType

Structure

Name DescriptioninitialXmlDocument (Requiredelement)Containsareferencetothe

XMLtemplatefilethatisusedforthecreationofanewformbasedontheformtemplate.

RemarksThefileNewelementisanoptionalelementofthexDocumentClasselement.

ThefileNewelementoftheMicrosoftOfficeInfoPath2003formdefinition(.xsf)filedefinesthenameandlocationofanXMLtemplatefilethatisusedwhenauserclicksFillOutaFormontheFilemenu.TheXMLtemplatefilecontainsthesampledatathatisloadedwhentheuserchoosestocreateanewformbasedontheformtemplate.

ExampleThefollowingisanexampleofthefileNewelement:

<xsf:fileNew><xsf:initialXmlDocumentcaption="TravelReport"href="TravelReportTemplate.xml"/></xsf:fileNew>

filePropertiesElement

Definesthepropertiesofafile.

xsd:complexType

Structure

Name Descriptionproperty (Optionalelement)Definesonespecificpropertyforthe

specifiedfile.

RemarksThefilePropertieselementisanoptionalelementofthefileelement.

ExampleThefollowingisanexampleofthefilePropertieselement:

filesElement

IdentifiesalistoffilesthatareusedbyaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name Descriptionfile (Optionalelement)IdentifiesafileaspartofanInfoPathform.

RemarksThefileselementisarequiredelementofthepackageelement.

Thefileselementmayincludespecificpropertynamesandvaluesforeachfile.

ExampleThefollowingisanexampleofthefileselement:

ShowAll

folderURLElement

SpecifiestheUniformResourceLocator(URL)ofaWeb-basedDistributedAuthoringandVersioning(WebDAV)serveroraserverthatisrunningMicrosoftWindowsSharePointServices.

Typexsd:complexType

ParentElements

Element DescriptiondavAdapter Theparentelement,whichcontainsallinformation

necessarytosubmitInfopathformstoaWeb-basedDistributedAuthoringandVersioning(WebDAV)serveroraserverthatisrunningSharePointServices.

ChildElementsNone.

Attributes

value xsd:string Yes TheURLoftheWeb-basedDistributedAuthoringandVersioning(WebDAV)serverortheserverthatisrunningSharePointServices.

string

Definition

<xsd:elementname="folderURL"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheURLmustbeginwith"http://"or"https://".Othercommonprotocolswillcauseanerror.

ExampleThefollowingisanexampleofthefolderURLelement:

<folderURLvalue="http://some_server/some_doc_lib"/>

footerElement

Specifiesthefootertext.

Typexsd:simpleType

ChildElementsNone.

AttributesNone.

Definition

<xsd:elementname="footer"><xsd:complexTypemixed="true"><xsd:sequence><xsd:anyminOccurs="0"maxOccurs="unbounded"processContents="skip"/></xsd:sequence></xsd:complexType></xsd:element>

RemarksThefooterelementisachildelementoftheprintSettingselement.Thefootertextshouldnotexceed255characters.

ExampleThefollowingisanexampleofthefooterelement:

<xsf:printSettingsorientation="landscape"header="&Pqsdf"footer="&D"printerName="\\printserver\printer"paperSource="AutoSelect"paperSize="EnvelopeDL"topMargin="0.8"leftMargin="0.8"bottomMargin="0.8"rightMargin="0.8"marginUnitsType="in"copies="2"collate="no"pageRangeStart="1"pageRangeEnd="1"><xsf:header><font><div>&Pqsdf</div></font></xsf:header><xsf:footer><font><div>&D</div></font></xsf:footer></xsf:printSettings>

fragmentToInsertElement

ContainsalternateversionsofXMLdata(fragments).

xsd:complexType

Structure

Name DescriptionchooseFragment (Requiredelement)SpecifiesanXMLfragment.

RemarksThefragmentToInsertelementisanoptionalelementoftheeditWithelement.

XMLfragmentsaresourcesofXMLdatathatcanbeusedwithinanassociatededitingcomponent.MorethanonechooseFragmentelementcanbedefinedwithinafragmentToInsertelement.

ThefragmentToInsertelementisusedbythexCollection,xOptional,andxReplaceeditingcomponents.

ExampleThefollowingisanexampleofthefragmentToInsertelement:

ShowAll

getUserNameFromDataElement

AllowsusernamestobedeterminedbyanXPathqueryintothedatainthemaindatasourceorasecondarydatasourceandtobeassociatedwitharole.

Typexsd:complexType

ChildElementsNone.

Attributes

dataObject xsd:string No Thenameofthesecondarydatasourcewheretheusernamecanbefound.

string

select xsd:string Yes AnXPathqueryexpressionreturningoneormoredatanodescontainingtheusernames.

string

memberOf xsd:string Yes SpecifiestheroletobeassociatedwithauserwhoseusernameisreturnedbytheXPathquery.

string

Definition

<xsd:elementname="getUserNameFromData"><xsd:complexType><xsd:attributename="dataObject"type="xsd:string"use="optional"></xsd:attribute><xsd:attributename="select"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="memberOf"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleofthegetUserNameFromDataelement:

<xsf:rolesinitiator="A"default="C"hideStatusBarDisplay="yes"><xsf:rolename="A"/><xsf:rolename="B"/><xsf:rolename="C"/>

<xsf:membership><xsf:getUserNameFromDatadataObject="catalog"select="/dfs:myFields/dfs:dataFields/d:UserA"memberOf="B"/><xsf:userNamename="Domain\username1"memberOf="A"/><xsf:userNamename="Domain\username2"memberOf="B"/><xsf:groupname="Domain\username3"memberOf="C"/></xsf:membership></xsf:roles>

groupElement

Associatesagroupwithaparticularrole.

Typexsd:complexType

ChildElementsNone.

Attributes

name xsd:string Yes Specifiesusersintheformof"domain\groupname"or"groupname".

string

memberOf xsd:string Yes Specifiestheroletobeassociatedwiththegroup.

string

Definition

<xsd:elementname="group"><xsd:complexType><xsd:attributename="name"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="memberOf"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksUserscanbeassignedrolesthroughgroupingthatcanbemanagedexternally,withoutrequiringaformupdate.GroupscanbesetupthroughtheActiveDirectorydirectoryservice.Permissionsspecifyingwhocanaccessthemembershipinformationcanbesetforgroups.

ExampleThefollowingisanexampleofthegroupelement:

headerElement

Specifiestheheadertext.

Typexsd:simpleType

ChildElementsNone.

AttributesNone.

Definition

<xsd:elementname="header"><xsd:complexTypemixed="true"><xsd:sequence><xsd:anyminOccurs="0"maxOccurs="unbounded"processContents="skip"/></xsd:sequence></xsd:complexType></xsd:element>

RemarksTheheaderelementisachildelementoftheprintSettingselement.Theheadertextshouldnotexceed255characters.

ExampleThefollowingisanexampleoftheheaderelement:

ShowAll

hwsAdapterElement

DefinestheMicrosoftBizTalk2004HumanWorkflowServices(HWS)dataadapter,whichcanbeusedtostartorextendanactivityflowandrespondtoatask.

Typexsd:complexType

ChildElements

Element DescriptionhwsOperation DefinestheHWSoperationtype,suchasaddingan

actiontoanewactivityflow,addinganactiontoanexistingactivityflow,andrespondingtoatask.

Attributes

Attribute Type Required Description PossibleValuesname xdTitle Yes Containsthe

nameofthedataadapter.

minLength=1

maxLength=255

wsdlUrl xsd:string Yes ContainstheUniformResourceLocator(URL)oftheHWSWebservice.

string

queryAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforqueryingthedatasource.CanbeomittedforthehwsAdapter,correspondingtoadefaultvalueof"no".

submitAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforsubmittingtothedata

source.Alwayssetto"yes"forthehwsAdapter.

Definition

<xsd:elementname="hwsAdapter"><xsd:complexType><xsd:choice><xsd:elementref="xsf:hwsOperation"/></xsd:choice><xsd:attributename="name"type="xsf:xdTitle"use="required"></xsd:attribute><xsd:attributename="wsdlUrl"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute><xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksUponsubmit,thehwsAdapterautomaticallycreatesagloballyuniqueidentifier(GUID),asrequiredbytheHWSWebservice;encodestheXMLfile;andupdatestheprocessinginstructionsoftheXMLinstancefile.

ExampleThefollowingisanexampleofthehwsAdapterelement:

ShowAll

hwsOperationElement

DefinestheMicrosoftBizTalk2004HumanWorkflowServices(HWS)operationtype,suchasaddinganactiontoanewactivityflow,addinganactiontoanexistingactivityflow,andrespondingtoatask.

Typexsd:complexType

ChildElements

Element Descriptioninput SpecifiestheXMLformfile,whichisencodedandsubmitted

withtheHWSoperation.

Attributes

Attribute Type Required Description PossibleValuestype xsd:string Yes Specifies

theHWSoperationtype.

addActionToNewActivityFlow

addActionToActivityFlow

sendTaskResponse

typeID xsd:string Yes Containsthegloballyuniqueidentifier(GUID)fortheoperation.

string

serviceUrl xsd:string Yes SpecifiestheUniformResourceLocator(URL)locationoftheHWSWebservice.

string

Definition

<xsd:elementname="hwsOperation"><xsd:complexType><xsd:choice><xsd:elementref="xsf:input"/></xsd:choice><xsd:attributename="type"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="typeID"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="serviceUrl"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksUponsubmit,thehwsAdapterelementautomaticallycreatesagloballyuniqueidentifier(GUID),asrequiredbytheHWSWebservice;encodestheXMLfile;andupdatestheprocessinginstructionsoftheXMLinstancefilewiththenewGUID.

ExampleThefollowingisanexampleofthehwsOperationelement:

ShowAll

hwsWorkflowElement

ContainstheinformationtoenabletheWorkflowtaskpaneandtoenableindividualactionsandtasksassociatedwithaMicrosoftBizTalk2004HumanWorkflowServices(HWS)server.

Typexsd:complexType

ChildElements

Element Descriptionlocation (Required)ContainstheUniformResourceLocator

(URL)oftheHWSWebservice.allowedActions ContainstheHWSactionsenabledfortheform.allowedTasks ContainstheHWStasksenabledfortheform.

Attributes

taskpaneVisible xdYesNo No SpecifieswhethertheWorkflowtaskpaneisvisible.Defaultvalueis"yes".

Definition

<xsd:elementname="hwsWorkflow"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:location"minOccurs="1"maxOccurs="1"/><xsd:elementref="xsf:allowedActions"minOccurs="1"maxOccurs="1"/><xsd:elementref="xsf:allowedTasks"minOccurs="0"maxOccurs="1"/></xsd:sequence><xsd:attributename="taskpaneVisible"type="xsf:xdYesNo"></xsd:attribute></xsd:complexType><xsd:uniquename="hws_actiontask_name"><xsd:selectorxpath="./xsf:allowedActions/xsf:action|./xsf:allowedTasks/xsf:task"/><xsd:fieldxpath="@name"/></xsd:unique></xsd:element>

RemarksForeveryactionandtaskincludedinthehwsWorkflowelement,abuttonisenabledontheWorkflowtaskpane;however,thebuttoneventmustbescriptedmanuallyforeachactionandtask.

InfoPathdoesnotsupportmultipleactionsinaformanddoesnotsupportHWSactivitymodels(predefinedsetsofactions).

ExampleThefollowingisanexampleofthehwsWorkflowelement:

ShowAll

importParametersElement

Containsalltheparametersthatdefinehowtheimport(merge)formsfeatureworksfortheform.

xsd:complexType

Structure

Name Descriptionenabled (Requiredattribute)Specifieswhetherformmerging

isenabledfortheform.importSource (Optionalelement)Specifiesallparameterstobe

usedwhenmergingaformofaspecificXMLSchemaintoadestinationform.

useScriptHandler (Optionalattribute)SpecifieswhethertousetheeventhandlerdefinedfortheOnMergeRequesteventwhenimporting(merging)forms.

RemarksTheimportParameterselementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleoftheimportParameterselement:

<xsf:importParametersenabled="yes"useScriptHandler="yes"><xsf:importSourcename="MySource"schema="MySchema.xsd"transform="schematransform.xslt"/></xsf:importParameters>

ShowAll

importSourceElement

SpecifiesallparameterstobeusedwhenmergingaformofaspecificXMLSchemaintoadestinationform.

xsd:complexType

Structure

Name Descriptionname (Requiredattribute)Identifiesthenameofthesourceformas

definedintheprocessinginstructionofthatform’sunderlyingXMLdocument.

schema (Requiredattribute)IdentifiestheXMLSchemafilethatshouldbeusedduringthemergeoperationtovalidatetheformbeingmerged.

transform (Requiredattribute)Identifiesthe.xsltfilethatshouldbeusedduringthemergeoperationwhenthesourceform(theonethatisbeingmergedin)matchestheXMLSchemaspecifiedinthecorrespondingschemaattribute.

RemarksTheimportSourceelementisanoptionalelementoftheimportParameterselement.

IftheimportSourceelementisnotdefined,thedefault.xsltfileisusedforalltransformationsduringamergeoperation.

ExampleThefollowingisanexampleoftheimportSourceelement:

<xsf:importParametersenabled="yes"<xsf:importSourcename=""schema="MySchema.xsd"transform="schematransform.xslt"/></xsf:importParameters>

ShowAll

initialXmlDocumentElement

ContainsareferencetotheXMLtemplatefilethatisusedforthecreationofanewformbasedontheformtemplate.

xsd:complexType

Structure

Name Descriptioncaption (Requiredattribute)Definesthetextstringtobeused

asthenameoftheformintheTemplateGalleryandinthemostrecentlyusedlist.

customCategory (Optionalelement)SpecifiesthecategorythattheformtemplateappearsunderintheFillOutaFormtaskpane.

href (Requiredattribute)SpecifiestheUniformResourceLocator(URL)oftheXMLtemplatefiletobeusedwhenauserclicksFillOutaFormontheFilemenu.

RemarksTheinitialXmlDocumentelementisarequiredelementofthefileNewelement.

ExampleThefollowingisanexampleoftheinitialXmlDocumentelement:

ShowAll

inputElement

ContainsthesubstitutioninformationforpartsoftheinputSimpleObjectAccessProtocol(SOAP)messagetotheWebservice.

xsd:complexType

Structure

Name Descriptionsource (Requiredattribute)Containsthenameoftheresource

fileintheformtemplatethatcontainstheXMLSchemafortheinputSOAPmessageoftheselectedoperationoftheWebservice.

partFragment (Optionalelement)DefinesonesubstitutiongroupforaspecificpartoftheinputSOAPmessage.

RemarksTheinputelementisanoptionalelementoftheoperationelement.

SpecifiedpartsintheSOAPmessagearereplacedwhentheformtemplateisfilledoutwithdatafromwithintheform.ItisusedwhenasecondarydatasourceispopulatedfromaWebservicecallandMicrosoftOfficeInfoPath2003needssomeinputargumentstomaketheWebservicecalls.

ExampleThefollowingisanexampleoftheinputelement:

introElement

Containstheintroductionforthee-mailmessagewhentheformissubmittedbyusingtheemailAdapterelement.

Typexsd:complexType

ParentElements

submitanInfoPathformasanattachmenttoane-mailmessage,withaspecifiedsetofrecipients,asubject,andanintroduction.

ChildElementsNone.

Attributes

value xsd:string Yes Containsthevalueoftheintroelement.

string

Definition

<xsd:elementname="intro"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleoftheintroelement:

ShowAll

listPropertiesElement

Identifiesthepropertiesthatshouldbeonalistviewofallformsbelongingtotheformtemplate.

xsd:complexType

Structure

Name Descriptionfields (Optionalelement)Definesasetofoneormorefieldelements.

RemarksThelistPropertieselementisanoptionalelementofthexDocumentClasselement.

XMLdocumentsbelongingtoaformcanbeplacedinasinglefolderorformlibrary.Dependingontheunderlyingsupportinthefilesystemorserver,thisinformationcanbeusedtocreatemeaningfullistviewsonasetofforms.Forexample,whenMicrosoftOfficeInfoPath2003formsaresavedtoaWindowsSharePointServicesformlibrarythatisbasedonanInfoPathformtemplate,formpropertiesspecifiedinthissectionareautomaticallypromotedandmadeavailabletothedefaultviewoftheformlibrary.

ExampleThefollowingisanexampleofthelistPropertieselement:

ShowAll

locationElement

ContainstheUniformResourceLocator(URL)oftheMicrosoftBizTalk2004HumanWorkflowServices(HWS)Webservice.

Typexsd:complexType

ChildElementsNone.

Attributes

url xsd:string Yes ThelocationoftheHWSWebservice.

string

Definition

<xsd:elementname="location"><xsd:complexType><xsd:attributename="url"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksThelocationelementisachildelementofthehwsWorkflowelement.

ExampleThefollowingisanexampleofthelocationelement:

ShowAll

mainpaneElement

Determineswhatisdisplayedinthemainpane.

xsd:complexType

Structure

Name Descriptiontransform (Requiredattribute)SpecifiestherelativeURLtotheXSL

Transformation(XSLT)thatisusedfortheview.

RemarksThemainpaneelementisarequiredelementoftheviewelement.

ThemainpaneelementisanoptionalelementoftheexternalViewelement.

Themainpaneisthemainformarea,asopposedtosecondaryuserinterfaceareassuchasthetaskpane.

ExampleThefollowingisanexampleofthemainpaneelement:

<xsf:viewsdefault="View"><xsf:viewname="View"caption="View"><xsf:mainpanetransform="view1.xsl"></xsf:mainpane>...</xsf:view></xsf:views>

ThefollowingisanexampleofthemainpaneelementusedwithintheexternalViewelement:

ShowAll

masterDetailElement

DefinestheXMLfragmentsthatformamasteranddetailrelationshipinaview'srepeatingtablesorrepeatingsections.

Typexsd:complexType

ChildElementsNone.

Attributes

master xsd:string No ContainstheXPathoftheXMLfragmentthatisboundtoamastertableorsection.

string

masterViewContext xsd:string No SpecifiesastringthatidentifiesanHTMLelementintheview.

string

masterKey xsd:string No ContainstheXPathofthefieldinthemasterXMLfragmentthatformstherelationshiptothedetailXMLfragment.

string

detailKey xsd:string No ContainstheXPathofthefieldinthedetailXMLfragmentthatformstherelationshiptothemasterXMLfragment.

string

Definition

<xsd:elementname="masterDetail"><xsd:complexType><xsd:attributename="master"type="xsd:string"></xsd:attribute><xsd:attributename="masterViewContext"type="xsd:string"></xsd:attribute><xsd:attributename="masterKey"type="xsd:string"></xsd:attribute><xsd:attributename="detailKey"type="xsd:string"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleofthemasterDetailelement:

<xsf:editWithcaption="group2"xd:autogeneration="template"component="xCollection"><xsf:masterDetailmasterViewContext="CTRL1_5"master="my:group2"masterKey="my:field1"detailKey="my:field3"></xsf:masterDetail></xsf:editWith>

ShowAll

membershipElement

Associatesauserorgroupofuserswitharole.

Typexsd:complexType

ChildElements

Element DescriptiongetUserNameFromData Allowsusernamestobedeterminedbyan

XPathqueryintothedatainthemaindatasourceorasecondarydatasourceandtobeassociatedwitharole.

userName Definesausertoaparticularrole.group Defineswhichgroupauserbelongsto.

AttributesNone.

Definition

<xsd:elementname="membership"><xsd:complexType><xsd:choiceminOccurs="1"maxOccurs="unbounded"><xsd:elementref="xsf:getUserNameFromData"/><xsd:elementref="xsf:userName"/><xsd:elementref="xsf:group"/></xsd:choice></xsd:complexType></xsd:element>

RemarksInfoPathassociatesarolewiththecurrentuserbasedonthemembershiporderintheformdefinitionfile(.xsf).Developerscanmodifythisorderbyhandintheformdefinitionfile.Themembershipelementmustbeachildoftheroleselement.

ExampleThefollowingisanexampleofthemembershipelement:

menuElement

Containsinformationaboutthecustommenususedintheview.

xsd:complexType

Structure

Name Descriptionbutton (Optionalelement)Definesabuttonthathasanassociated

action.caption (Requiredattribute)Usedasthecaptionforamenu.menu (Optionalelement)Containsinformationaboutthemenusused

withinamenu(cascadingmenus).

RemarksThemenuelementisanoptionalelementoftheview,toolbar,andmenuAreaelements.Multiplemenuscanbedeclaredforaform,andeachmenucancontainmultiplemenuorbuttonelements.

NoteTocreatecascadingmenus,amenuelementcanbenestedinsideanothermenuelement.

ExampleThefollowingisanexampleofthemenuelement:

menuAreaElement

ContainsinformationabouttheMicrosoftOfficeInfoPath2003built-inmenususedintheview.

xsd:complexType

Structure

action.name (Requiredattribute)Correspondstooneofthebuilt-inInfoPath

top-levelmenus.menu (Optionalelement)Containsinformationaboutthemenusused

withinthemenuarea.

RemarksThemenuAreaelementisanoptionalelementoftheviewelement.

ThemenuAreaelementisanalogoustothetop-levelmenusfoundinInfoPathwhenfillingoutaform.MultiplebuttonsormenuscanbedeclaredwithinamenuAreaelement.Eachbuttonelementcreatesanadditionalmenuitemwithinthecorrespondingbuilt-inmenu,specifiedbythenameattributeofthemenuAreaelement,andhasanaction(orcommand)associatedwithit.IfamenuelementisnestedwithinamenuAreaelement,thiscreatesacascadingmenuoffofthebuilt-inmenu.

ExampleThefollowingisanexampleofthemenuAreaelement:

messageElement

Containsthesignatureconfirmationmessagethatisshownwhenasignatureisappliedtotheformorsectionoftheform.

Typexsf:xdSignedDataBlockMessage

ParentElements

document,towhichadigitalsignaturecanbeapplied.

ChildElementsNone.

AttributesNone.

Definition

<xsd:elementname="message"type="xsf:xdSignedDataBlockMessage"minOccurs="0"></xsd:element>

RemarksTheconfirmationmessageislimitedto255characters.

ExampleThefollowingisanexampleofthemessageelement:

<xsf:documentSignatures><xsf:signedDataBlockname=”main”data=”my:myfields/my:subtree1|my:myfields/my:subtree2”signatureLocation=”my:mifields/sig:signatures/main”mode=”countersign”><xsf:message>Bypressingthe"Sign"buttonbelow,Iagreetobeboundtothetermsofthisdocument.</xsf:message></xsf:signedDataBlock></xsf:documentSignatures>

ShowAll

onLoadElement

ContainsoneruleSetelementthatisinvokedwhentheformisopened.

Typexsd:complexType

ChildElements

Element DescriptionruleSetActionDefinestheruleSetactionelementtobeinvoked.

AttributesNone.

Definition

<xsd:elementname="onLoad"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:ruleSetAction"minOccurs="1"maxOccurs="1"/></xsd:sequence></xsd:complexType><xsd:keyrefname="load_ruleSetAction"refer="xsf:ruleset_name_key"><xsd:selectorxpath="./xsf:ruleSetAction"/><xsd:fieldxpath="@ruleSet"/></xsd:keyref></xsd:element>

ExampleThefollowingisanexampleoftheonLoadelement:

<xsf:onLoad><xsf:ruleSetActionruleSet="RuleSet4"/></xsf:onLoad>

ShowAll

openNewDocumentActionElement

Definesaformcreateaction.

Typexsd:complexType

ChildElementsNone.

Attributes

solutionURI xsd:anyURI Yes TheUniformResourceIdentifier(URI)ofthesolutiononwhichthenewformwillbebased.

anyURI

Definition

<xsd:elementname="openNewDocumentAction"><xsd:complexType><xsd:attributename="solutionURI"type="xsd:anyURI"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheopenNewDocumentActionelementisachildelementoftheruleelement.

ExampleThefollowingisanexampleoftheopenNewDocumentActionelement:

ShowAll

operationElement

Definestheoperation(method)oftheWebservicetobeusedforretrievingandsubmittingdata.

xsd:complexType

Structure

Name Descriptionname (Requiredattribute)ContainstheuniquenameoftheWeb

servicemethod.serviceUrl (Requiredattribute)ContainstheWebserviceUniform

ResourceLocator(URL)towhichtherequestshouldbesent.

soapAction (Requiredattribute)ContainsthevalueoftheSOAPActionattributeintheSimpleObjectAccessProtocol(SOAP)requestmessage.

input (Optionalelement)ContainsthesubstitutioninformationforpartsoftheinputSOAPmessagetotheWebservice.

RemarksTheoperationelementisarequiredelementofthewebServiceAdapterelement.

ExampleThefollowingisanexampleoftheoperationelement:

<xsf:query><xsf:webServiceAdapterwsdlUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx?WSDL"queryAllowed="yes"submitAllowed="no"><xsf:operationname="getOrders"soapAction="http://tempuri.org/getOrders"serviceUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx"><xsf:inputsource="Submit.xml"></xsf:input></xsf:operation></xsf:webServiceAdapter></xsf:query>

ShowAll

overrideElement

DefinesoneoverridingerrormessageforXMLSchemadatatypeerrorsforanindividualXMLDocumentObjectModel(DOM)node.

xsd:complexType

Structure

Name DescriptionerrorMessage (Requiredelement)Specifiestheerrormessagethat

shouldbereturnedifthevalueofthespecifiedXMLDOMnodeisconsideredtobeinvalid.

match (Requiredattribute)IdentifiestheXMLDOMnodeforwhichtheerrormessageoverrideisdefined.

RemarksTheoverrideelementisanoptionalelementoftheschemaErrorMessageselement.

ExampleThefollowingisanexampleoftheoverrideelement:

<xsf:schemaErrorMessages><xsf:overridematch="/sampleData/number"><xsf:errorMessageshortMessage="InvalidNumber.">Thevalueenteredmustbeavalidnumber.</xsf:errorMessage></xsf:override></xsf:schemaErrorMessages>

packageElement

ContainsinformationaboutallofthefilesusedinaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name Descriptionfiles (Requiredelement)Identifiesalistoffilesthatareusedbyan

InfoPathform.

RemarksThepackageelementisarequiredelementofthexDocumentClasselement.

ExampleThefollowingisanexampleofthepackageelement:

ShowAll

partFragmentElement

DefinesonesubstitutiongroupforaspecificpartoftheinputSimpleObjectAccessProtocol(SOAP)message.

xsd:complexType

Structure

Name Descriptionmatch (Requiredattribute)ContainsanXPathexpressionthat

identifiestheelementsandattributesinsidetheinputSOAPmessagethataretobereplacedatruntime.

replaceWith (Requiredattribute)ContainsanXPathexpressionthatidentifiesthevaluesinthesourcedocumentthatshouldbeusedtoreplacepartsoftheinputSOAPmessage.

sendAsString (Optionalattribute)SpecifiesthatthedataissubmittedasastringthroughthewebServiceAdapterdataadapter.

dataObject (Optionalattribute)SpecifiesthenameofthedataobjecttousewhensubmittingapartFragmentelementtoaMicrosoftBiztalk2004HumanWorkflowServices(HWS)server.

filter (Optionalattribute)SpecifiestheXPathexpressionofthestructuredXMLsubtreewhensubmittingasubsetoftheXMLdata.

RemarksThepartFragmentelementisanoptionalelementoftheinputelement.

MultiplepartFragmentelementsareallowed.

ExampleThefollowingisanexampleofthepartFragmentelement:

<xsf:query><xsf:webServiceAdapterwsdlUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx?WSDL"queryAllowed="yes"submitAllowed="no"><xsf:operationname="getOrders"soapAction="http://tempuri.org/getOrders"serviceUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx"><xsf:inputsource="Submit.xml"><xsf:partFragmentmatch="/dfs:myFields/dfs:dataFields/s0:IsPrime/s0:inValue"replaceWith="/dfs:myFields/dfs:dataFields/s0:IsPrime"/></xsf:input></xsf:operation></xsf:webServiceAdapter></xsf:query>

permissionsElement

AssertsthepermissionstheInfoPathformrequiresfortheActiveXcontrolsintheview.

Typexsd:complexType

ChildElements

Element DescriptionallowedControl SpecifiestheActiveXcontrolsthatareallowedtobe

instantiated.

AttributesNone.

Definition

<xsd:elementname="permissions"><xsd:complexType><xsd:choiceminOccurs="0"maxOccurs="unbounded"><xsd:elementref="xsf:allowedControl"/></xsd:choice></xsd:complexType></xsd:element>

RemarksThepermissionselementalsoprovidesinstallationinformationforActiveXcontrolsthatarenotalreadyinstalledontheuser'scomputer.

ExampleThefollowingisanexampleofthepermissionselement:

<xsf:permissions><xsf:allowedControlcabFile="{84F32C01-78D8-4B93-8ED4-106DA70224C2}.cab”clsid="{84F32C01-78D8-4B93-8ED4-106DA70224C2}"version="1,0,0,1"/><xsf:allowedControlclsid="{F08DF954-8592-11D1-B16A-00C0F0283630}"/></xsf:permissions>

ShowAll

printElement

Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstoprinttheform.

Typexsd:complexType

ChildElementsNone.

Attributes

ui xsf:xdEnabledDisabled Yes Setswhethertheusercanprinttheform.

enabled

disabled

Definition

<xsd:elementname="print"><xsd:complexType><xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheprintelementisanoptionalelementofthefeatureRestrictionselement.Ifthiselementisnotincludedintheformdefinitionfile(.xsf),theusercanusetheform'smenus,toolbars,orkeyboardshortcutstoprinttheform.

ExampleThefollowingisanexampleoftheprintelement:

printSettingsElement

Specifiestheprintersettingsusedwhenprintingtheview.

xsd:complexType

Structure

Name DescriptionbottomMargin (Optionalattribute)Specifiesthebottom

margin.collate (Optionalattribute)Specifieswhetherthepaper

iscollated.copies (Optionalattribute)Specifiesthenumberof

copies.footer (Optionalattribute)Specifiesthefootertext.header (Optionalattribute)Specifiestheheadertext.leftMargin (Optionalattribute)Specifiestheleftmargin.marginUnitsType (Optionalattribute)Specifiesthemarginunit

size.orientation (Optionalattribute)Specifiestheorientation.pageRangeEnd (Optionalattribute)Specifiesthelastpageto

beprinted.pageRangeStart (Optionalattribute)Specifiesthefirstpageto

beprinted.paperSize (Optionalattribute)Specifiesthesizeofthe

paper.paperSource (Optionalattribute)Specifiesthesourceofthe

paper.printerName (Optionalattribute)Specifiesthenameofthe

printer.printerSpecificSettings (Optionalattribute)Specifiesprinterspecific

settings.rightMargin (Optionalattribute)Specifiestherightmargin.topMargin (Optionalattribute)Specifiesthetopmargin.

RemarksTheprintSettingselementisanoptionalelementoftheviewelement.

ExampleThefollowingisanexampleoftheprintSettingselement:

ShowAll

propertyElement

Definesonespecificpropertyforthespecifiedfile.

xsd:complexType

Structure

Name Descriptionname (Requiredattribute)Definesthenameoftheproperty.type (Requiredattribute)Definesthetypeoftheproperty.value (Requiredattribute)Forsimpleproperties,specifiesavaluefor

theproperty.Forcomplexandmulti-valuedproperties,thespecifiedvalueisdefinedasacontainerXMLtreeusinganopencontentmodel.

RemarksThepropertyelementisanoptionalelementofthefilePropertieselement.

ExampleThefollowingisanexampleofthepropertyelement:

ShowAll

queryElement

Associatesadataadapterwithadataobjectoraform'sunderlyingXMLdocument.

xsd:complexType

Structure

Name DescriptionadoAdapter (Optionalelement)DefinesanActiveXData

Objects(ADO)dataadapterthatretrievesdatafromanADOdatasourceforthespecifieddataobject.

webServiceAdapter (Optionalelement)DefinesaWebservicedataadapterthatretrievesdatafromaWebserviceforthespecifieddataobject.

xmlFileAdapter (Optionalelement)Definesan.xmlfiledataadapterthatretrievesdatafroman.xmlfileforthespecifieddataobject.

queryAction (Optionalelement)Definesadataconnectionqueryaction.

sharepointListAdapter (Optionalelement)ContainsthedataadapterinformationtoqueryaSharePointlistorlibrary.

RemarksThequeryelementisanoptionalelementofthexDocumentClasselementandthedataObjectelement.

Onlyonedataadaptercanbespecifiedinthequeryelement.

ExampleThefollowingisanexampleofthequeryelement:

ShowAll

queryElement(dataObjectElement)

Associatesadataadapterwithadataobject.

Typexsd:complexType

ParentElements

Element DescriptiondataObject DefinesasecondarydataobjectthatisusedinaMicrosoft

OfficeInfoPathform.

ChildElements

Element DescriptionadoAdapter (Optionalelement)DefinesanActiveXData

Objects(ADO)dataadapterthatretrievesdatafromanADOdatasourceforthespecifieddataobject.

webServiceAdapter (Optionalelement)DefinesaWebservicedataadapterthatretrievesdatafromaWebserviceforthespecifieddataobject.

xmlFileAdapter (Optionalelement)Definesan.xmlfiledataadapterthatretrievesdatafroman.xmlfileforthespecifieddataobject.

sharepointListAdapter (Optionalelement)ContainsthedataadapterinformationtoqueryaSharePointlistorlibrary.

AttributesNone.

Definition

<xsd:elementname="query"><xsd:complexType><xsd:choice><xsd:elementref="xsf:adoAdapter"/><xsd:elementref="xsf:webServiceAdapter"/><xsd:elementref="xsf:xmlFileAdapter"/><xsd:elementref="xsf:sharepointListAdapter"/></xsd:choice></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleofthequeryelement:

<xsf:dataObjects><xsf:dataObjectname="EmployeeNames"schema="EmployeeNames.xsd"initOnLoad="yes"><xsf:query><xsf:adoAdapterconnectionString="Provider=Microsoft.Jet.OLEDB.4.0;Password="";UserID=Admin;DataSource=infnwind.mdb;Mode=ShareDenyNone;ExtendedProperties="";..."commandText="select[EmployeeID],[LastName],[FirstName]from[Employees]as[Employees]"queryAllowed="yes"submitAllowed="yes"></xsf:adoAdapter></xsf:query></xsf:dataObject></xsf:dataObjects>

queryActionElement

Definesadataconnectionqueryaction.

Typexsd:complexType

ChildElementsNone.

Attributes

adapter xsd:string Yes Containsthenameofthedataadaptertoquery.

string

Definition

<xsd:elementname="queryAction"><xsd:complexType><xsd:attributename="adapter"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksThequeryActionelementisachildelementoftheruleelement.

ExampleThefollowingisanexampleofthequeryActionelement:

ShowAll

roleElement

Definesrole.

Typexsd:complexType

ChildElementsNone.

Attributes

Attribute Type Required Description PossibleValuesname xdRoleName Yes Usedto

identifytherole.

SamerestrictionasxdViewName.

Definition

<xsd:elementname="role"><xsd:complexType><xsd:attributename="name"type="xsf:xdRoleName"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksEachtimearoleiscreatedforaform,acorrespondingroleelementiscreatedintheformdefinitionfile(.xsf).Youcanassignuserstorolesbyusingusernames,groups,andXPathusernames.Userscanbeselectedforrolesinoneoffourways:

Initiator—rolefornewdocuments.

Username—NTdomainusers(intranetortrustedonly).

XPathusername—usernamesstoredinXMLdata(intranetortrustedonly).

Group—ActiveDirectorydirectoryservicegroups(intranetortrustedonly).

InfoPathmakestheuserassignmentbyfollowingthemembershiporderintheformdefinitionfile.

ExampleThefollowingisanexampleoftheroleelement:

<rolesinitiator=”xsd:string”default=”xsd:string”hideStatusBarDisplay="xsf:xdYesNo"><rolename=”xsf:xdRoleName”/><membership><getUserNameFromDatadataObject=”xsd:string”select=”xsd:string”memberOf=”xsd:string”/><userNamename=”xsd:string”memberOf=”xsd:string”/><userNamename=”xsd:string”memberOf=”xsd:string”/><groupname=”xsd:string”memberOf=”xsd:string”/></membership></roles>

rolesElement

Definesroles.

Typexsd:complexType

ChildElements

Element Descriptionrole Definesrole.membershipMapsauserorgroupofuserstoarole.

Attributes

default xsd:string Yes Specifiesthenameidentifieroftherolethatisthedefaultrole.

string

initiator xsd:string No Specifiesthenameidentifieroftherolechosentobetheinitiatorrole.

string

hideStatusBarDisplay xdYesNo No Specifieswhetherthecurrentroleshouldbedisplayedinthestatusbar.

Definition

<xsd:elementname="roles"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:role"minOccurs="1"maxOccurs="unbounded"/><xsd:elementref="xsf:membership"minOccurs="0"maxOccurs="1"/></xsd:sequence><xsd:attributename="default"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="initiator"type="xsd:string"use="optional"></xsd:attribute><xsd:attributename="hideStatusBarDisplay"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType><xsd:uniquename="roles_name_unique"><xsd:selectorxpath="./xsf:role"/><xsd:fieldxpath="@name"/></xsd:unique><xsd:keyname="role_name_key"><xsd:selectorxpath="./xsf:role"/><xsd:fieldxpath="@name"/></xsd:key><xsd:keyrefname="role_default"refer="xsf:role_name_key"><xsd:selectorxpath="."/><xsd:fieldxpath="@default"/></xsd:keyref><xsd:keyrefname="role_initiator"refer="xsf:role_name_key"><xsd:selectorxpath="."/><xsd:fieldxpath="@initiator"/></xsd:keyref><xsd:keyrefname="role_membership"refer="xsf:role_name_key">

<xsd:selectorxpath="./xsf:membership/*"/><xsd:fieldxpath="@memberOf"/></xsd:keyref></xsd:element>

ExampleThefollowingisanexampleoftheroleselement:

ShowAll

ruleElement

Definesanactioninvokedafteraneventhasoccurredintheform.

Typexsd:complexType

ChildElements

Element DescriptionassignmentAction Definesanactiontosetthevalueofa

field.closeDocumentAction Definesaformcloseaction.dialogBoxExpressionAction DefinesanXPathexpressiontobe

displayedinadialogbox.dialogBoxMessageAction Definesaliteralmessagetobedisplayed

inadialogbox.exitRuleSet Anelementwhich,ifpresentattheendof

therule,stopsfurtherruleprocessingoftheentireruleSetwhentheruleisexecuted.

openNewDocumentAction Definesaformcreateaction.queryAction Definesadataconnectionqueryaction.submitAction Definesaformsubmitaction.switchViewAction Definesaviewswitchaction.

Attributes

caption xsd:string Yes Containsthenameoftheruleasitappearsintheuserinterface.

string

condition xsd:string No DefinestheXPathexpression,evaluatedasaBooleanvalue,thatdetermineswhethertheassociatedactionwillbeinvoked.

string

isEnabled xdYesNo No Specifieswhethertheruleisenabledfortheform.Thedefaultvalueis"yes".

Definition

<xsd:elementname="rule"><xsd:complexType><xsd:sequence><xsd:choiceminOccurs="0"maxOccurs="unbounded"><xsd:elementref="xsf:dialogBoxMessageAction"/><xsd:elementref="xsf:dialogBoxExpressionAction"/><xsd:elementref="xsf:switchViewAction"/><xsd:elementref="xsf:assignmentAction"/><xsd:elementref="xsf:queryAction"/><xsd:elementname="submitAction"><xsd:complexType><xsd:attributename="adapter"type="xsf:xdTitle"use="required"></xsd:attribute></xsd:complexType></xsd:element><xsd:elementref="xsf:openNewDocumentAction"/><xsd:elementref="xsf:closeDocumentAction"/></xsd:choice><xsd:elementname="exitRuleSet"minOccurs="0"><xsd:complexType/></xsd:element></xsd:sequence><xsd:attributename="caption"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="condition"type="xsd:string"use="optional"></xsd:attribute><xsd:attributename="isEnabled"type="xsf:xdYesNo"use="optional"default="yes"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleoftheruleelement:

<xsf:ruleSets><xsf:ruleSetname="RuleSet1"><xsf:rulecaption="Receipts"condition="my:expense>75"><xsf:dialogBoxMessageAction>Don'tforgetreceipts!</xsf:dialogBoxMessageAction><xsf:openNewDocumentActionsolution="urn:approvalForm"/><xsf:exitRuleSet/></xsf:rule><xsf:rulecaption="AlwaysSubmit"isEnabled="no"><xsf:submitActionadapter="ExpenseDatabase"/></xsf:rule></xsf:ruleSet>

<xsf:ruleSetname="RuleSet2"><xsf:rulecaption="Lookupcontact"><xsf:queryActionadapter="Contacts"/></xsf:rule></xsf:ruleSet></xsf:ruleSets>

ShowAll

ruleSetElement

Containsoneormoreruleelements.

Typexsd:complexType

ChildElements

Attributes

name xsd:string Yes ContainsthenameoftheruleSetelement.

string

Definition

<xsd:elementname="ruleSet"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:rule"minOccurs="1"maxOccurs="unbounded"/></xsd:sequence><xsd:attributename="name"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleoftheruleSetelement:

ruleSetActionElement

DefinestheruleSetactionelementtobeinvoked.

Typexsd:complexType

ChildElementsNone.

Attributes

ruleSet xsd:string Yes ContainsthenameoftheruleSettobeinvoked.

string

Definition

<xsd:elementname="ruleSetAction"><xsd:complexType><xsd:attributename="ruleSet"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksTheruleSetActionelementisachildofthesubmit,domEventHandler,onLoad,andbuttonelements.

ExampleThefollowingisanexampleoftheruleSetActionelement:

ruleSetsElement

ContainsoneormoreruleSetelements.

Typexsd:complexType

ChildElements

Element DescriptionruleSet Containsoneormoreruleelements.

AttributesNone.

Definition

<xsd:elementname="ruleSets"><xsd:complexType><xsd:sequence><xsd:elementref="xsf:ruleSet"minOccurs="0"maxOccurs="unbounded"/></xsd:sequence></xsd:complexType><xsd:uniquename="ruleSets_name_unique"><xsd:selectorxpath="./xsf:ruleSet"/><xsd:fieldxpath="@name"/></xsd:unique></xsd:element>

RemarksTheruleSetselementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleoftheruleSetselement:

ShowAll

saveElement

ShowswhethertheSaveusingcustomcodecheckboxoptionisenabled.

Typexsd:complexType

ChildElements

Element DescriptionuseScriptHandler Specifiesthatthesubmit,save,orversionupgrade

operationwillbehandledusingformcode.

AttributesNone.

Definition

<xsd:elementname="save"><xsd:complexType><xsd:choiceminOccurs="0"maxOccurs="1"><xsd:elementref="xsf:useScriptHandler"/></xsd:choice></xsd:complexType></xsd:element>

RemarksIftheSaveusingcustomcodecheckboxoptionisenabled,the<xsf:save><xsf:useScriptHandler/></xsf:save>elementswillbeaddedtotheformdefinitionfile(.xsf)asachildofthexDocumentClasselement.

ExampleThefollowingisanexampleofthesaveelement:

<xsf:save><xsf:useScriptHandler/></xsf:save>

ShowAll

saveElement(featureRestrictionsElement)

Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstosavetheform.

Typexsd:complexType

ParentElements

Element DescriptionfeatureRestrictions Specifieswhethertheusercanusetheform's

menus,toolbars,orkeyboardshortcutstosavetheform,exporttheform,printtheform,orsendtheformasane-mailattachment.

ChildElementsNone.

Attributes

ui xsf:xdEnabledDisabled Yes Setswhethertheusercansavetheform.

enabled

disabled

Definition

<xsd:elementname="save"minOccurs="0"><xsd:complexType><xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksThesaveelementisanoptionalelementofthefeatureRestrictionselement.Ifthiselementisnotincludedintheformdefinitionfile(.xsf),thentheusercanusetheform'smenus,toolbars,orkeyboardshortcutstosavetheform.

ExampleThefollowingisanexampleofthesaveelement:

ShowAll

schemaErrorMessagesElement

ContainscustomerrormessagesusedtooverrideXMLSchemadatatypeerrors.

xsd:complexType

Structure

Name Descriptionoverride (Optionalelement)Definesoneoverridingerrormessagefor

XMLSchemadatatypeerrorsforanindividualXMLDocumentObjectModel(DOM)node.

RemarksTheschemaErrorMessageselementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleoftheschemaErrorMessageselement:

ShowAll

scriptElement

Definesthesourcescriptingfilecontainingallthedata-levelscriptcontentreferencedintheform.

xsd:complexType

Structure

Name Descriptionsrc (Requiredattribute)ProvidesarelativeURLwithintheform

templatetothespecifiedscriptsourcefile.

RemarksThescriptelementisanoptionalelementofthescriptselement.

ExampleThefollowingisanexampleofthescriptelement:

<xsf:scriptslanguage="jscript"><xsf:scriptsrc="myscripts.js"/></xsf:scripts>

ShowAll

scriptsElement

Definesthesourceofallbusinesslogicscriptsusedatthedocumentlevelintheform.

xsd:complexType

Structure

Name Descriptionlanguage (Requiredattribute)Definesthescriptlanguage

usedinthebusinesslogicsourcefiles.script (Optionalelement)Definesthesourcescripting

filecontainingallthedata-levelscriptcontentreferencedintheform.

enforceScriptTimeout (Optionalelement)Specifieswhethertoenableordisableatime-outperiodforscripts.

RemarksThescriptselementisanoptionalelementofthexDocumentClasselement.

Therecanpotentiallybemorethanonescriptelementinthescriptselement;however,theyshouldallbewritteninthesamescriptinglanguage.Alldefinedscriptsourcesareconcatenatedandloadedintoasinglescriptengineenvironmentwhentheformisbeingfilledout.Thismeansthatduplicatefunctionsandpropertynamesareresolvedbydefaultbythescriptengine,andthelastdeclarationistheonethatisused.Formdevelopersmustensureuniquenamesacrossscriptingsourcefilesthatareusedinaform.

Inordertoaddencodedjscriptfilestoaform,youneedtoedittheformdefinitionfile(.xsf)tochangethelanguagepropertyinthescriptselement.Afterthepropertyhasbeenupdated,thescriptssectioninthe.xsffilewilllooklikethefollowing:

<xsf:scriptslanguage="jscript.encode"> <xsf:scriptsrc="scriptenc.js"></xsf:script></xsf:scripts>

Thescriptselementisnotpresentinthe.xsffileiftheformusesmanagedcode.

ExampleThefollowingisanexampleofthescriptselement:

<xsf:scriptslanguage="jscript"enforceScriptTimeout="no"><xsf:scriptsrc="internal.js"/><xsf:scriptsrc="script.js"/></xsf:scripts>

ShowAll

sendMailElement

Specifieswhethertheusercanusetheform'smenus,toolbars,orkeyboardshortcutstosendtheformasanemailattachment.

Typexsd:complexType

ChildElementsNone.

Attributes

ui xdEnabledDisabled required Setswhethertheusercansendtheformasanemailattachment.

enabled

disabled

Definition

<xsd:elementname="sendMail"><xsd:complexType><xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksThesendMailelementisanoptionalelementofthefeatureRestrictionselement.

ExampleThefollowingisanexampleofthesendMailelement:

ShowAll

sharepointListAdapterElement

ContainsthedataadapterinformationtoqueryaSharePointlistorlibrary.

Typexsd:complexType

ChildElements

Element Descriptionfield Containsfieldmappinginformationforeachfieldina

SharePointlistandthecorrespondingnameusedinMicrosoftOfficeInfoPath2003ServicePack1.

Attributes

Attribute Type Required Description PossibleValuesname xdTitle Yes Containsthenameof

thesharepointListAdapterandisusedasthesecondarydatasourcename.

minLength=1

maxLength=255

siteUrl xsd:string Yes ContainstheUniformResourceLocator(URL)oftheSharePointsite.

string

sharepointGuid xsd:string Yes ContainstheGUIDoftheSharePointlist.

string

infopathGroup xsd:string Yes ContainsthenameofthegroupunderwhichallfieldsintheSharePointlistwillbestored.

string

queryAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforqueryingthedatasource.Alwayssetto"yes"forthesharepointListAdapter.

submitAllowed xdYesNo No Specifieswhethertheadaptercanbeusedforsubmittingtothedatasource.OmittedforthesharepointListAdapter,correspondingtoadefaultvalueof"no".

Definition

<xsd:elementname="sharepointListAdapter"><xsd:complexType><xsd:sequence><xsd:elementname="field"minOccurs="0"maxOccurs="unbounded"><xsd:complexType><xsd:attributename="sharepointName"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="infopathName"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="isLookup"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType></xsd:element></xsd:sequence><xsd:attributename="name"type="xsf:xdTitle"use="required"></xsd:attribute><xsd:attributename="siteUrl"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="sharepointGuid"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="infopathGroup"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute><xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksEachfieldintheSharePointlistthatisreturnedbythedataadapterwillhaveafieldelement.ThesharepointListAdaptercanonlybeusedasasecondarydatasourceanddoesnotsupportasubmitaction.

ExampleThefollowingisanexampleofthesharepointListAdapterelement:

<xsf:sharepointListAdaptername="StatusReportlibrary"siteUrl=”http://xyzco/reports/”sharepointGuid="{ABD2E239-0EE7-48F4-B506-C38A1728E195}"infopathGroup="XyzReportsLibrary"queryAllowed="yes><xsf:fieldsharepointName="File_x0020_Type"infopathName="Type"></xsf:field><xsf:fieldsharepointName="xd__x007b_D00F1DBD_..."infopathName="Title_1"></xsf:field></xsf:sharepointListAdapter>

ShowAll

signedDataBlockElement

Definesanodesetintheform'sunderlyingXMLdocumenttowhichadigitalsignaturecanbeapplied.

Typexsd:complexType

ChildElements

Element Descriptionmessage Thesignatureconfirmationmessageshownwhenadigital

signatureisappliedtotheformortoasectionoftheform.

Attributes

Attribute Type Required Descriptionname xdSignedDataBlockName Yes Containsthe

nameofthesignedDataBlockelement.

data xsd:string Yes ContainsanXPathmatchexpressionthatdefinesthenodesettowhichthesignaturewillbeapplied.

signatureLocation xsd:string Yes ContainsanXPathexpressionthatpointstotheXMLDocumentObjectModel(DOM)nodewithintheform'sunderlyingXMLdocumentthatisusedforstoringthedigitalsignature.

mode xdSignatureRelationEnum Yes SpecifiesthesignaturerelationshipforthesignedDatablockelement.Thedefaultis"single".

Definition

<xsd:elementname="signedDataBlock"><xsd:complexType><xsd:sequence><xsd:elementname="message"type="xsf:xdSignedDataBlockMessage"minOccurs="0"></xsd:element></xsd:sequence><xsd:attributename="name"type="xsf:xdSignedDataBlockName"use="required"></xsd:attribute><xsd:attributename="data"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="signatureLocation"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="mode"type="xsf:xdSignatureRelationEnum"use="required"></xsd:attribute></xsd:complexType><xsd:uniquename="signedDataBlock_name_unique"><xsd:selectorxpath="."/><xsd:fieldxpath="@name"/></xsd:unique></xsd:element>

RemarksThenodesetmustbetheunionofconnectedsubtrees.IfanonleafnodeisincludedinasignedDataBlock,thenallchildrenmustbeincluded.

ExampleThefollowingisanexampleofthesignedDataBlockelement:

ShowAll

solutionPropertiesElement

Containsdesign-timeinformationaboutaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name DescriptionallowCustomization (Optionalattribute)Indicateswhether

theformcanbemodifiedorcustomized.automaticallyCreateNodes (Optionalattribute)Indicateswhether

XMLDocumentObjectModel(DOM)nodeswillbeautomaticallygeneratedwhencontrolsareinsertedintheviewindesignmode.

fullyEditableNamespace (Optionalattribute)IdentifiesthenamespaceofanXMLSchemaintheformtemplatethatcanbeentirelymodifiedinInfoPathdesignmode.

lastOpenView (Optionalattribute)IdentifiesthenameoftheviewthatwaslastopeninInfoPathwhendesigningaform.

lastVersionNeedingTransform (Optionalattribute)Identifies,temporarily,thevalueofthemaxToVersionUpgradeattributeinthedocumentVersionUpgradeelementforupgradewithan.xsltfileifscriptingcodeisbeingusedfortheupgrade.

scriptLanguage (Optionalattribute)Identifiesthenameofthescriptinglanguageusedtoimplementthebusinesslogicoftheform.

publishSaveUrl (Optionalattribute)ContainsthelocationofthesavedformtemplateifdifferentfromthevalueofthepublishUrlattribute.

RemarksThesolutionPropertieselementisanoptionalelementoftheapplicationParameterselement.

ExampleThefollowingisanexampleofthesolutionPropertieselement:

<xsf:applicationParametersapplication="InfoPathDesignMode"><xsf:solutionPropertiesallowCustomization="no"lastOpenView="view1"scriptLanguage="JScript"automaticallyCreateNodes="no"lastVersionNeedingTransform="1.1.0.10"fullyEditableNamespace="urn:names?pace1:mynames"/></xsf:applicationParameters>

ShowAll

subjectElement

Containsthesubjectlineofthee-mailmessagewhentheformissubmittedusingtheemailAdapterelement.

Typexsd:complexType

ParentElements

ChildElementsNone.

Attributes

value xsd:string Yes Containsthevalueofthesubjectelement.

string

valueType xdExpressionLiteral No SpecifieswhetherthevalueattributeisinterpretedasanXPathexpressionoraliteralstring.

expression

literal

Definition

<xsd:elementname="subject"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleofthesubjectelement:

ShowAll

submitElement

Containsinformationaboutthesubmissionfunctionalityofaform.

xsd:complexType

Structure

Name Descriptioncaption (Optionalattribute)Definesthenameofthe

submitbuttonandcorrespondingmenuitemthatwillappearontheFilemenuwhenauserisfillingouttheform.

disableMenuItem (Optionalattribute)Specifieswhetherthemenuitemforthesubmitoperationshouldbedisabled.

errorMessage (Optionalelement)Specifiesthetexttobeusedintheerrormessage.IftheshowStatusDialogattributeofthesubmitelementissetto"no",thiselementwillbeignored.

onAfterSubmit (Optionalattribute)Specifieswhethertheformshouldbeclosed,keptopen,orifanewformshouldbecreatedafterasuccessfulsubmission.

showSignatureReminder (Optionalattribute)Specifieswhetheradialogboxshouldbedisplayedtoprompttheusertodigitallysigntheformbeforesubmittingit.

showStatusDialog (Optionalattribute)Specifieswhetherthestatusdialogboxshouldbeshownafterthesubmitoperation.Valuesinclude"yes"and"no".Thedefaultvaluesis"yes".

successMessage (Optionalelement)Specifiesthetexttobeusedtonotifytheuserthatthesubmissionwassuccessful.

useHttpHandler (Optionalelement)SpecifiesthattheformistobesubmittedtothespecifiedUniformResourceLocator(URL)usingthespecifiedHTTPmethod.

useScriptHandler (Optionalelement)Specifiesthattheformis

tobesubmittedbyscriptingcodeintheassociatedscriptfile.SubmitcodemustbewrittenintheOnSubmitRequesteventhandlerintheform'sprimaryscriptingfile.

useQueryAdapter (Optionalelement)Specifiesthattheformistobesubmittedtothesamedataadapterasspecifiedinthequeryelement.

webServiceAdapter (Optionalelement)SpecifiesthattheformistobesubmittedtoaWebserviceadapter.

submitAction (Optionalelement)Specifiesthedataadapterusedtosubmittheform.

RemarksThesubmitelementisanoptionalelementofthexDocumentClasselement.

ExampleThefollowingisanexampleofthesubmitelement:

<xsf:submitcaption="Su&bmit"disableMenuItem="no"onAfterSubmit="KeepOpen"showStatusDialog="yes"showSignatureReminder="yes"><xsf:useScriptHandler/><xsf:successMessage>Submitwassuccessful.</xsf:successMessage><xsf:errorMessage>Submitwasnotsuccessful.</xsf:errorMessage></xsf:submit>

ShowAll

submitActionElement(ruleElement)

Definesaformsubmitaction.

Typexsd:complexType

ParentElements

ChildElementsNone.

Attributes

Attribute Type Required Description PossibleValuesadapter xsf:xdTitle Yes Contains

thenameofthedataadaptertosubmit.

minLength=1

maxLength=255

Definition

<xsd:elementname="submitAction"><xsd:complexType><xsd:attributename="adapter"type="xsf:xdTitle"use="required"></xsd:attribute></xsd:complexType></xsd:element>

ExampleThefollowingisanexampleofthesubmitActionelement:

ShowAll

submitActionElement(submitElement)

Specifiesthedataadapterusedtosubmittheform.

Typexsd:complexType

ParentElements

Element Descriptionsubmit Containsinformationaboutthesubmissionfunctionalityofa

ChildElementsNone.

Attributes

Attribute Type Required Description PossibleValuesadapter xsf:xdTitle Yes Thename

ofthedataadapterusedforsubmittingtheform.

minLength=1

maxLength=255

Definition

<xsd:elementname="submitAction"minOccurs="0"><xsd:complexType><xsd:attributename="adapter"type="xsf:xdTitle"use="required"></xsd:attribute></xsd:complexType><xsd:keyrefname="submitAdapter_name_keyref"refer="xsf:adapter_name_key"><xsd:selectorxpath="."/><xsd:fieldxpath="@adapter"/></xsd:keyref></xsd:element>

ExampleThefollowingisanexampleofthesubmitActionelement:

<xsf:submitcaption="Su&bmit"disableMenuItem="no"onAfterSubmit="keepOpen"showStatusDialog="yes"><xsf:submitActionadapter="dav"/></xsf:submit>

<xsf:dataAdapters><xsf:davAdaptername="dav"folderUrl="http://some_server/some_doc_lib"getFileNameFromData="/my:myFields/my:field1"overwriteAllowed="no"></xsf:davAdapter></xsf:dataAdapters>

successMessageElement

Specifiesthetexttobeusedtonotifytheuserthatthesubmissionwassuccessful.

xsd:string

RemarksThesuccessMessageelementisanoptionalelementofthesubmitelement.

ThesuccessMessageelementdoesnotcontainanyattributesorchildelements.

ThesuccessMessageelementisignorediftheshowStatusDialogattributeofthesubmitelementissetto"no".

ExampleThefollowingisanexampleofthesuccessMessageelement:

<xsf:submitcaption="Su&bmit"disableMenuItem="no"onAfterSubmit="KeepOpen"showStatusDialog="yes"showSignatureReminder="yes"><xsf:useScriptHandler/><xsf:successMessage>Submitwassuccessful.</xsf:successMessage<xsf:errorMessage>Submitwasnotsuccessful.</xsf:errorMessage></xsf:submit>

ShowAll

switchViewActionElement

Definesaviewswitchaction.

Typexsd:complexType

ParentElements

ChildElementsNone.

Attributes

Attribute Type Required Description PossibleValuesview xsf:xdViewName Yes Contains

thenameoftheview.

minLength=1

maxLength=255

pattern=([^\p{Z}\p{C}/\\#&"><])(([^\p{Zl}\p{Zp}\p{C}/\\#&"><])*([^\p{Z}\p{C}/\\#&"><]))?

Definition

<xsd:elementname="switchViewAction"><xsd:complexType> <xsd:attributename="view"type="xsf:xdViewName"use="required"/></xsd:complexType><xsd:keyrefname="switchViewAction_view_keyref"refer="xsf:view_name_key"> <xsd:selectorxpath="."/> <xsd:fieldxpath="@view"/></xsd:keyref></xsd:element>

ExampleThefollowingisanexampleoftheswitchViewActionelement:

ShowAll

taskElement

ContainstheMicrosoftBizTalkServer2004HumanWorkflowServices(HWS)taskinformationenabledfortheform.

Typexsd:complexType

ChildElementsNone.

Attributes

name xsf:xdHWSname Yes Theuniquenameofthetask,asspecifiedintheHWSWorkflowdesigner;usedfortheonClickeventofthebuttonintheHWSWorkflowtaskpane.

Cannotcontainthefollowingcharacters:

\/"[]:<>+=;,?*@

taskTypeID xsd:string Yes TheuniqueIDforthetask.

string

caption xsf:xdHWSCaption No ThelabelforthecorrespondingbuttonintheHWSWorkflowtaskpanetostartorrespondtoatask.

minLength=1

maxLength=255

Definition

<xsd:elementname="task"> <xsd:complexType> <xsd:attributename="name"type="xsf:xdHWSname"use="required"/> <xsd:attributename="taskTypeID"type="xsd:string"use="required"/> <xsd:attributename="caption"type="xsf:xdHWSCaption"use="optional"/> </xsd:complexType> </xsd:element>

RemarksThetaskelementisanoptionalelementoftheallowedTaskselement.

EachtaskenabledfortheformmusthaveacorrespondingtaskelementintheallowedTaskssectionoftheformdefinitionfile(.xsf).

ExampleThefollowingisanexampleofthetaskelement:

ShowAll

taskpaneElement

DefinesacustomtaskpanetobeusedinaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name Descriptioncaption (Requiredattribute)Definesthecaptionusedinthetaskpane

drop-downlistbox.href (Requiredattribute)SpecifiestherelativeorabsoluteUniform

ResourceLocator(URL)toan.htmlfile.

RemarksThetaskpaneelementisanoptionalelementofthexDocumentClasselement.

Thetaskpaneisamodelesspanelthatappearstotherightofthemainformarea.Taskpanescontaincommandsspecifictocompletingtasksthatarerelatedtoasingleform.InfoPathsupportstheuseofasinglecustomtaskpane.

Togetmultipletaskpanebehavior,youcanincludemultiple.htmfilesintheformtemplateandusetheNavigatemethodoftheHTMLTaskPaneobjectintheMicrosoftOfficeInfoPath2003objectmodeltonavigatetodifferent.htmfiles.

ExampleThefollowingisanexampleofthetaskpaneelement:

<xsf:xDocumentClass>...<xsf:taskpanecaption="DesignIssuesHelp"href="DesignIssuesHelp.htm"/>...</xsf:xDocumentClass>

ShowAll

toElement

Containstherecipientinformationforthetolineofthee-mailmessagewhentheformissubmittedusingtheemailAdapterelement.

Typexsd:complexType

ParentElements

ChildElementsNone.

Attributes

value xsd:string Yes Containsthevalueofthetoelement.

string

valueType xsf:xdExpressionLiteralNo SpecifieswhetherthevalueattributeisinterpretedasanXPathexpressionorasaliteralstring.

expression

literal

Definition

<xsd:elementname="to"minOccurs="0"><xsd:complexType><xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute></xsd:complexType></xsd:element>

RemarksMultipleaddressesonthetolinemustbeseparatedbysemicolons.

ExampleThefollowingisanexampleofthetoelement:

toolbarElement

Containsinformationaboutthetoolbarsusedintheview.

xsd:complexType

Structure

action.caption (Requiredattribute)Usedasthetitleofthetoolbar,whenthe

toolbarisnotdockedtotheuserinterface.name (Requiredattribute)Identifiesthecorrespondingtoolbarwithin

differentviews.Mustbeuniquewithinagivenview.menu (Optionalelement)Containsinformationaboutthemenusused

withinthetoolbar.

RemarksThetoolbarelementisanoptionalelementoftheviewelement.Therecanbemultipletoolbarsdeclaredforaview,andeachtoolbarcanhavemultiplemenuorbuttonelements.

ExampleThefollowingisanexampleofthetoolbarelement:

<xsf:toolbarcaption="CDCollectionToolbar"name="CDCollectionToolbar"><xsf:buttonaction="xCollection::insert"xmlToEdit="CD_10"caption="NewCD"showIf="always"></xsf:button><xsf:buttonaction="xCollection::insert"xmlToEdit="Track_14"caption="NewTrack"showIf="always"></xsf:button><xsf:buttonaction="xOptional::insert"xmlToEdit="Label_16"caption="NewLabel"showIf="always"></xsf:button><xsf:menucaption="Remove"><xsf:buttonaction="xCollection::remove"xmlToEdit="CD_10"caption="CD"showIf="always"></xsf:button><xsf:buttonaction="xCollection::remove"xmlToEdit="Track_14"caption="Track"showIf="always"></xsf:button><xsf:buttonaction="xOptional::remove"xmlToEdit="Label_16"caption="Label"showIf="always"></xsf:button></xsf:menu></xsf:toolbar>

ShowAll

unboundControlsElement

Definestheunboundbuttoncontrolsthatareusedintheview.

xsd:complexType

Structure

action.

RemarksTheunboundControlselementisanoptionalelementoftheviewelement.

UnboundcontrolsinMicrosoftOfficeInfoPath2003arethebuttonsthataredraggedfromtheControlstaskpaneontotheviewindesignmode.Thenameassignedtothebuttoncontrolisusedinthenameattributeofthebuttonelement,andwhenauserclicksonthebutton,thescriptingcodeassociatedwiththebuttonwillbecalled.

ExampleThefollowingisanexampleoftheunboundControlselement:

<xsf:view><xsf:unboundControls><xsf:buttonname="MyButton"></xsf:button></xsf:unboundControls>...</xsf:view>

Thefollowingscripthandler,includedinthescriptfile,willbecalledwhenthebuttonisclicked:

functionMyButton::OnClick(){//Writeyourcodehere.}

ShowAll

useHttpHandlerElement

SpecifiesthattheformistobesubmittedtothespecifiedUniformResourceLocator(URL)usingthespecifiedHTTPmethod.

xsd:complexType

Structure

Name Descriptionhref (Requiredattribute)SpecifiestheURLtowhichtheformshould

besubmitted.method (Requiredattribute)SpecifiestheHTTPmethodtouseforthe

submitoperation.

RemarksTheuseHttpHandlerelementisanoptionalelementofthesubmitelement.

ExampleThefollowingisanexampleoftheuseHttpHandlerelement:

<xsf:submitcaption="Su&bmit"disableMenuItem="no"onAfterSubmit="KeepOpen"showStatusDialog="yes"showSignatureReminder="yes"><xsf:useHttpHandler>href="http://MyServer/InfoPathScripts/MyScript.asp"method="POST"</xsf:useHttpHandler><xsf:successMessage>Submitwassuccessful.</xsf:successMessage><xsf:errorMessage>Submitwasnotsuccessful.</xsf:errorMessage></xsf:submit>

ShowAll

useQueryAdapterElement

Specifiesthattheformistobesubmittedtothesamedataadapterasspecifiedinthequeryelement.

xsd:complexType

RemarksTheuseQueryAdapterelementisanoptionalelementofthesubmitelement.

ThequeryelementusedistheonethatisthechildelementofthexDocumentClasselement,notthequeryelementthatisachildofthedataObjectelement.

TheuseQueryAdapterelementdoesnotcontainanyattributesorchildelements.

ExampleThefollowingisanexampleoftheuseQueryAdapterelement:

<xsf:submitcaption="Su&bmit"disableMenuItem="no"onAfterSubmit="KeepOpen"showStatusDialog="yes"showSignatureReminder="yes"><xsf:useQueryAdapter/><xsf:successMessage>Submitwassuccessful.</xsf:successMessage><xsf:errorMessage>Submitwasnotsuccessful.</xsf:errorMessage></xsf:submit>

userNameElement

Associatesauserwithaparticularrole.

Typexsd:complexType

ChildElementsNone.

Attributes

name xsd:string Yes Specifiesthenameofauserforinclusioninthemembershiplistofarole.

string

memberOf xsd:string Yes Specifiestheroletobeassociatedwiththeuser.

string

Definition

<xsd:elementname="userName"><xsd:complexType><xsd:attributename="name"type="xsd:string"use="required"></xsd:attribute><xsd:attributename="memberOf"type="xsd:string"use="required"></xsd:attribute></xsd:complexType></xsd:element>

RemarksInfoPathrequiresthatauserbeassociatedwithonlyoneroleatatime.

IfausercreatesanewInfoPathdocumentfromaformtemplate,thatuserisassignedtotherolespecifiedintheoptionalinitiatorattributeoftheroleselement.Ifnorolehasbeendesignatedastheinitiatorrole,InfoPathassignstheusertotherolespecifiedinthememberOfattributeofthefirstentrythatcorrespondstotheuserinthemembershiplistoftheroleselement.Anentryinthemembershiplistcorrespondstoauserifanyoneofthefollowingconditionsistrue:

ThenameoftheusermatchesthevalueofthenameattributeofauserNameelementinthemembershiplist.

Theuserisincludedinagroupidentifiedbyagroupelementinthemembershiplist.

ThenameoftheusermatchesanamereturnedbyagetUserNameFromDataelementinthemembershiplist.

Ifnoentryfortheuserisfoundinthemembershiplist,InfoPathassociatestheuserwiththerolespecifiedinthedefaultattributeoftheroleselement.

ExampleThefollowingisanexampleoftheuserNameelement:

ShowAll

useScriptHandlerElement

Specifiesthatthesubmit,save,orversionupgradeoperationwillbehandledusingformcode.

xsd:element

RemarksTheuseScriptHandlerelementisanoptionalelementofthesubmitelement,thesaveelementandthedocumentVersionUpgradeelement.TheuseScriptHandlerelementcontainsnoattributesorchildelements.

Whenusedwiththesubmitelement,itdeclaresthattheformdatawillbeprocessedbyscriptcodeintheassociatedformfile.ThesubmitformcodemustbewrittenintheOnSubmitRequesteventhandlerintheform'sprimaryscriptfile.

Whenusedwiththesaveelement,itdeclaresthatthesaveoperationoftheformdatawillbeprocessedbyformcodeintheassociatedformcodefile.ThecodemustbewrittenintheOnSaveRequesteventhandlerintheform'sprimaryscriptingfile.

WhenusedwiththedocumentVersionUpgradeelement,itdeclaresthattheupgradeofolderforms(createdwithanolderversionoftheformtemplate)willbeprocessedbyformcodeintheassociatedscriptingfile.TheformupgradecodemustbewrittenintheOnVersionUpgradeeventhandlerintheform'sprimaryscriptfile.

ExampleThefollowingisanexampleoftheuseScriptHandlerelement:

<xsf:documentVersionUpgrade><xsf:useScriptHandler/></xsf:documentVersionUpgrade>

ShowAll

useTransformElement

SpecifiesthattheupgradewillbehandledbyanXSLTransformation(XSLT)suppliedbythenewerversionoftheformtemplate.

xsd:complexType

Structure

Name DescriptionmaxToVersionUpgrade (Optionalattribute)Inclusivevalueforthelatest

formthatneedstobeupgraded.minVersionToUpgrade (Requiredattribute)Inclusivevalueforthe

oldestformthatcanbeupgraded.transform (Requiredattribute)SpecifiestheXSLTfile

namerelativetotheformtemplate.

RemarksTheuseTransformelementisanoptionalelementofthedocumentVersionUpgradeelement.

Whenauserfillsoutaform,MicrosoftOfficeInfoPath2003automaticallyrunsthespecifiedXSLTontheform'sunderlyingXMLdocumentandusestheoutputastheXMLdatatobeedited,iftheversionoftheformisgreaterthanorequaltotheminVersionToUpgradeattributeandtheversionislessthanorequaltothemaxVersionToUpgradeattribute.

ExampleThefollowingisanexampleoftheuseTransformelement:

ShowAll

viewElement

ContainsinformationaboutaMicrosoftOfficeInfoPath2003view.

xsd:complexType

Structure

Name Descriptioncaption (Optionalattribute)Providesthedisplaycaptionfor

theviewwithintheviewlist.designMode (Optionalattribute)Determineswhethertheviewcan

beopenedindesignmode.editing (Optionalelement)Containsinformationaboutthe

editingcomponentsusedintheview.mainpane (Requiredelement)Determineswhatisdisplayedin

themainpane(formarea).menu (Optionalelement)Containsinformationaboutthe

custommenususedintheview.menuArea (Optionalelement)Containsinformationaboutthe

custommenuitemsthatcanbeaddedtotheInfoPathbuilt-inmenus.

name (Requiredattribute)Identifiestheviewforobjectmodelcallswhenswitchingviews,andforspecifyingthedefaultview.

printSettings (Optionalelement)Specifiestheprintersettingsusedwhenprintingtheview.

printView (Optionalattribute)Specifiesthenameofanotherviewtouseforprintingthisview.

toolbar (Optionalelement)Containsinformationaboutthetoolbarsusedintheview.

unboundControls (Optionalelement)Definestheunboundbuttoncontrolsthatareusedintheview.

showMenuItem (Optionalelement)ProvidesthedisplayofthemenuitemintheViewmenuwithacheckmarkwhenenabled.

RemarksTheviewelementisarequiredelementoftheviewselement.

ExampleThefollowingisanexampleoftheviewelement:

viewsElement

DefinesalloftheviewsthathavebeenimplementedinaMicrosoftOfficeInfoPath2003form.

xsd:complexType

Structure

Name Descriptiondefault (Optionalattribute)Specifiesthenameoftheviewchosentobe

thedefaultview.view (Requiredelement)ContainsinformationaboutanInfoPathview.

RemarksTheviewselementisarequiredelementofthexDocumentClasselement.

ExampleThefollowingisanexampleoftheviewselement:

ShowAll

webServiceAdapterElement

DefinesaWebservicedataadapterthatretrievesdatafromaWebserviceforthespecifieddataobject.

xsd:complexType

Structure

Name DescriptionqueryAllowed (Optionalattribute)Specifieswhetherdatacanbe

retrievedfromthedatasourcethroughthequerymethodoftheadapterobject.

submitAllowed (Optionalattribute)Specifieswhetherdatacanbesubmittedtothedatasourcethroughthesubmitmethodoftheadapterobject.

wsdUrl (Requiredattribute)ContainstheUniformResourceLocator(URL)oftheWebServicesDescriptionLanguage(WSDL)filethatdescribestheWebservicespecification.

operation (Requiredelement)Definestheoperation(method)oftheWebservicetobeusedforretrievingandsubmittingdata.

useDataSet (Optionalattribute)SpecifieswhethertheadapterwillsupportanADO.NetDataSet.Defaultis"no".

RemarksThewebServiceAdapterelementisanoptionalelementofthequeryelement.

ThewebServiceAdapterelementcanalsobeusedtodefineaWebserviceadapterusedtosubmitthemainorsecondaryformdata.

ExampleThefollowingisanexampleofthewebServiceAdapterelement:

<xsf:query><xsf:webServiceAdapterwsdlUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx?WSDL"queryAllowed="yes"submitAllowed="no"useDataSet="no"><xsf:operationname="getOrders"soapAction="http://tempuri.org/getOrders"serviceUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx"><xsf:inputsource="Submit.xml"></xsf:input></xsf:operation></xsf:webServiceAdapter></xsf:query>

ShowAll

xDocumentClassElement

Therootelementoftheformdefinition(.xsf)filefile.Containsallotherelementsandattributesofthe.xsffile.

xsd:complexType

Structure

Name Descriptionauthor (Optionalattribute)Identifiestheauthorof

theform.dataFormSolution (Optionalattribute)Identifiestheformasa

databaseform.description (Optionalattribute)Abriefdescriptionofthe

form.name (Optionalattribute)Providesaunique,

UniformResourceName(URN)–basednamefortheformthatthe.xsffiledefines.

productVersion (Optionalattribute)IdentifiestheversionnumberofInfoPathwithwhichtheformhasbeencreatedorforwhichaparticularformisintended.

publishUrl (Optionalattribute)Identifieswheretheformwaspublishedandwheretheformtemplateshoulddownloadupdatesfrom.

requireFullTrust (Optionalattribute)Allowstheformtorunasafullytrustedformwhenaformtemplateisregisteredorsignedwithacertificate.

solutionFormatVersion (Requiredattribute)Identifiestheversionnumberthatrepresentstheformatofthe.xsffile.

solutionVersion (Optionalattribute)Identifiestheversionnumberoftheform.

xmlns (Requiredattribute)Definesthexsfnamespace.

applicationParameters (Optionalelement)Containsform-specificpropertiesthatdescribehowaformshouldbeusedinInfoPathdesignmode.

customValidation (Optionalelement)Definesrule-basedcustomvalidationontopofallvalidation

enforcedthroughtheXMLSchema.dataObjects (Optionalelement)Definesallsecondary

dataobjectsusedinanInfoPathform.documentSchemas (Optionalelement)DefinestheXML

SchemasthattheInfoPathformisdesignedtohandle.

documentSignatures (Optionalelement)DefinesthelocationofthedigitalsignatureXMLDocumentObjectModel(DOM)nodewithintheform'sunderlyingXMLdocument.

documentVersionUpgrade (Optionalelement)Defineshowformscreatedwithanolderversionoftheformtemplatecanbeupgradedtothelatestversionoftheformtemplate.

domEventHandlers (Optionalelement)Containspointerstovariousscript-basedeventhandlersthatreacttochangesinXMLDOMnodesofaform'sunderlyingXMLdocumentwhiletheformisbeingfilledout.

extensions (Optionalelement)IncludesminorupgradestotheInfoPath.xsffilethatcanbeusedbyfuturereleasesofInfoPathorbyspecificforms.

fileNew (Optionalelement)Providesareferencetoan.xmlfilecontainingsampledata,tobeloadedwhenauserchoosestocreateanewformbasedontheformtemplate.

importParameters (Optionalelement)Containsalltheparametersthatdefinehowtheimport(merge)formsfeatureworksfortheform.

listProperties (Optionalelement)Identifiesthepropertiesthatshouldbeonalistviewofallformsbelongingtoaformtemplate.

package (Requiredelement)ContainsinformationaboutallofthefilesusedinanInfoPathform.

query (Optionalelement)Associatesadataadapterwiththeform'sunderlyingXMLdocument.

schemaErrorMessages (Optionalelement)ContainscustomerrormessagesusedtooverrideXMLSchemadatatypeerrors.

scripts (Optionalelement)Definesthesourceofallbusinesslogicscriptsusedatthedocumentlevelintheform.

submit (Optionalelement)Containsinformationaboutthesubmissionfunctionalityofaform.

taskpane (Optionalelement)DefinesacustomtaskpanetobeusedinanInfoPathform.

views (Requiredelement)DefinesalloftheviewsthathavebeenimplementedinanInfoPathform.

trustLevel (Optionalattribute)Specifiesthetrustlevelofaform.

trustSetting (Optionalattribute)Specifiesthetrustsettingofaform.

RemarksThexDocumentClasselementisarequiredelementandmustbepresentintheInfoPath.xsffile.

TheattributesthatarecontainedwithinthexDocumentClasselementarecollectivelycalledtheglobalmetadatasection.Theglobalmetadatasectionofthe.xsffileisarequiredsectionthatcontainsglobalinformationabouttheInfoPathform.

ExampleThefollowingisanexampleofthexDocumentClasselement:

xsf:xDocumentClassxmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"name="urn:schemas-microsoft-com:myTravelReport"author="FrankMiller"description="TravelReportformforenteringtravelreports,issues,expenses,etc."dataFormSolution="yes"solutionVersion="1.0.0.1"productVersion="11.0.5106"solutionFormatVersion="1.0.0.0">dataFormSolution="yes"requireFullTrust="yes"trustLevel="restricted"trustSetting="manual"publishUrl="http://www.contoso.com/InfoPathTemplates/MyTemplate.xsn">...</xsf:xDocumentClass

ShowAll

xmlFileAdapterElement

Definesan.xmlfiledataadapterthatretrievesdatafroman.xmlfileforthespecifieddataobject.

xsd:complexType

Structure

Name DescriptionfileUrl (Requiredattribute)ContainstheUniformResourceLocator

(URL)ofthe.xmlfile.name (Optionalattribute)ContainsthenameofthexmlFileAdapter

element.

RemarksThexmlFileAdapterelementisanoptionalelementofthequeryelement.

ExampleThefollowingisanexampleofthexmlFileAdapterelement:

<xsf:query><xsf:xmlFileAdapterfileUrl="currencies.xml"/></xsf:query>

ShowAll

xmlToEditElement

Specifiesaninstanceofaneditingcomponent.

xsd:complexType

Structure

Name Descriptioncontainer (Optionalattribute)SpecifiesanXPathexpressionthat

determinesthecontextinwhichthecontrolwillbeselectableanditsactionsenabled.

editWith (Optionalelement)Definesaninstanceofaneditingcomponent,andprovidesthecorrespondingparameterstodetermineitsexactbehavior.

item (Requiredattribute)SpecifiesanXPathexpressionthatdeterminestheXMLDocumentObjectModel(DOM)nodestobeeditedusingtheeditingcomponentdefinedintheeditWithelement.

name (Requiredattribute)UsedinthexmlToEditattributeofthebuttonelementtoassociateactionsoftheassociatededitingcomponentwithbuttonsdefinedinmenusandtoolbars.

viewContext (Optionalattribute)SpecifiesastringthatidentifiesanHTMLelementintheview.

RemarksThexmlToEditelementisanoptionalelementoftheeditingelement.

xmlToEditelementsareusedtodefinetheeditingcomponentsthatcanbeusedinaform.ThexmlToEditelementscancontainmultipleeditWithelementsthatspecifytheeditingcomponentsthatwillbeusedtoeditvarioustypesofXMLDOMnodes.

ExampleThefollowingisanexampleofthexmlToEditelement:

actionAttribute

Specifiesanactionofaneditingcomponent,usingthesyntax"NameOfEditingComponent::NameOfAction".

xsd:NMTOKEN

RemarksTheactionattributeisanoptionalattributeofthebuttonelement,butisrequiredforbuttonsusedwitheditingcomponents.

Thefollowingaretheeditingactionsthatmaybeusedasthevalueoftheactionattribute.

Name DescriptionxCollection::insert Insertsanitem.xCollection::insertBefore Insertsanitembeforethecurrentselection.xCollection::insertAfter Insertsanitemafterthecurrentselection.xCollection::remove Removesanitem.xCollection::removeAll Removesallitems.xOptional::insert Insertsanoptionalitem.xOptional::remove Removesanoptionalitem.xReplace::replace Replacesanexistingitem.xFileAttachment::attach Opensadialogboxtobrowseforfilestoattach

toaform.xFileAttachment::open Opensafileattachedtoaform.xFileAttachment::saveAs Openstheadialogboxtobrowseforalocation

whereafileistobesaved.xFileAttachment::remove Removesthefilefromtheform.

ExampleThefollowingisanexampleoftheactionattributeasitisusedinthebuttonelement:

ShowAll

actionTypeIDAttribute

ContainsauniqueIDfortheactionelement.

Typexsd:string

ParentElements

Element Descriptionaction Containstheinformationforanaction.

Definition

<xsd:attributename="actionTypeID"type="xsd:string"use="required"></xsd:attribute>

RemarksTheactionTypeIDattributeisanattributeoftheactionelement.

ThevalueoftheactionTypeIDattributemustbeuniqueintheform.

ExampleThefollowingisanexampleoftheactionTypeIDattributeasitisusedintheactionelement:

<xsf:hwsAdaptername="StartApproval"wsdlUrl="http://www.contoso.com/hwsservice/hwsservice.asmx?WSDL"submitAllowed="yes"queryAllowed="no"><xsf:hwsOperationtype="addActionToNewActivityFlow"typeID="{guid}"serviceUrl="http://www.contoso.com/hwsservice/hwsservice.asmx"><xsf:inputsource="HWSMessage1.xml"><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param1"replaceWith="/my:myFields/my:param1"/><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param2"

replaceWith="/a:some/b:thing"dataObject="Aux1"/></xsf:input></xsf:hwsOperation></xsf:hwsAdapter>

adapterAttribute(queryActionElement)

ContainstheadapternameforthedataconnectionusedforthequeryActionelement.

Typexsd:string

ParentElements

Element DescriptionqueryAction Definesadataconnectionqueryaction.

Definition

<xsd:attributename="adapter"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheadapterattributeasitisusedinthequeryActionelement:

ShowAll

adapterAttribute(submitActionElement)

Containsthenameofthedataadaptertosubmit.

Typexsf:xdTitle

ParentElements

Element DescriptionsubmitActionDefinesasubmitactionforaform.

Definition

<xsd:attributename="adapter"type="xsf:xdTitle"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheadapterattributeasitisusedinthesubmitActionelement:

ShowAll

adapterAttribute(submitActionElement)

Containsthenameofthedataadapterusedforsubmittingtheform.

Typexsd:complexType

ParentElements

Element DescriptionsubmitAction Specifiesthedataadapterusedtosubmittheform.

Definition

<xsd:elementname="submitAction"minOccurs="0"><xsd:complexType><xsd:attributename="adapter"type="xsf:xdTitle"use="required"></xsd:attribute></xsd:complexType><xsd:keyrefname="submitAdapter_name_keyref"refer="xsf:adapter_name_key"><xsd:selectorxpath="."/><xsd:fieldxpath="@adapter"/></xsd:keyref></xsd:element>

ExampleThefollowingisanexampleoftheadapterattributeasitisusedinthesubmitActionelement:

<xsf:submitcaption="Su&bmit"disableMenuItem="no"onAfterSubmit="keepOpen"showStatusDialog="yes"><xsf:submitActionadapter="dav"/></xsf:submit><xsf:dataAdapters><xsf:davAdaptername="dav"folderUrl="http://some_server/some_doc_lib"getFileNameFromData="/my:myFields/my:field1"overwriteAllowed="no"></xsf:davAdapter></xsf:dataAdapters>

ShowAll

aggregationAttribute

SpecifieshowthenodesreturnedfromanXPathexpressioninthenodeattributeshouldbeaggregatedtoobtainasinglevalueforthedocument.

xsd:simpleType

RemarksTheaggregationattributeisanoptionalattributeofthefieldelement.

Theaggregationattributecaneitherbeanaggregationactionoranindicationoftheparticularelementinthecollection.Itusesthefollowingaggregationactions:sum,count,average,min,max,first,last,merge,andplaintext.

ExampleThefollowingisanexampleoftheaggregationattributeasitisusedinthefieldelement:

ShowAll

allowCustomizationAttribute

IdentifieswhethertheMicrosoftOfficeInfoPath2003formcanbemodifiedorcustomized.

xsf:xdYesNo

RemarksTheallowCustomizationattributeisanoptionalattributeofthesolutionPropertieselement.

IftheallowCustomizationattributeissetto"no",anerrorisgeneratedwhenausertriestomodifytheformtemplateafteropeningitinInfoPath.Allowedvaluesare"yes"and"no".Thedefaultvalueis"yes".

ExampleThefollowingisanexampleoftheallowCustomizationattributeasitisusedinthesolutionPropertieselement:

<xsf:applicationParametersapplication="InfoPathDesignMode"><xsf:solutionPropertiesallowCustomization="no"lastOpenView="view1"scriptLanguage="JScript"automaticallyCreateNodes="no"lastVersionNeedingTransform="1.1.0.10"fullyEditableNamespace="urn:namespace1:mynames"/></xsf:applicationParameters>

ShowAll

allowedFileTypesattribute

Specifiesthefilenameextensionsoffilesthatcanbeattachedtotheform.

Typexsd:string

ParentElements

Element DescriptioneditWith Specifiesaninstanceofaneditingcomponent,andprovides

thecorrespondingparameterstodetermineitsexactbehavior.

Definition

<xsd:attributename="allowedFileTypes"type="xsd:string"use="optional"></xsd:attribute>

RemarksThefileextensionslistedintheallowedFileTypesattributevalueareseparatedbycommas.

Example

<xsf:xmlToEditname="some_name"item="/my:myFields/my:field1"><xsf:editWithallowedFileTypes="doc,xls"component="xFileAttachment"/></xsf:xmlToEdit><menuAreaname="msoStructuralEditingContextMenu"><buttonaction="xFileAttachment::attach"xmlToEdit="some_name"caption="Attach..."showIf="immediate"/><buttonaction="xFileAttachment::open"xmlToEdit="some_name"caption="Open"showIf="immediate"/><buttonaction="xFileAttachment::saveAs"xmlToEdit="some_name"caption="SaveAs..."showIf="immediate"/><buttonaction="xFileAttachment::remove"xmlToEdit="some_name"caption="Deletefile"showIf="immediate"/></menuArea>

applicationAttribute

IdentifiesthenameoftheapplicationusedtodesigntheMicrosoftOfficeInfoPath2003form.

xsd:string

RemarksTheapplicationattributeisarequiredattributeoftheapplicationParameterselement.

Theonlyvaluesupportedis"InfoPathDesignMode".

ExampleThefollowingisanexampleoftheapplicationattributeasitisusedintheapplicationParameterselement:

attributeAttribute

Specifiesthenameoftheattributetobeinserted.

xsd:string

RemarksTheattributeattributeisarequiredattributeoftheattributeDataelement.

ExampleThefollowingisanexampleoftheattributeattributeasitisusedintheattributeDataelement:

authorAttribute

Identifiestheauthoroftheform.

xsd:string

RemarksTheauthorattributeisanoptionalattributeofthexDocumentClasselement.

ExampleThefollowingisanexampleoftheauthorattributeasitisusedinthexDocumentClasselement:

<xsf:xDocumentClassxmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"name="urn:microsoft-com:myTravelReport"author="AuthorName"description="TravelReportformforenteringtravelreports,issues,expenses,etc."dataFormSolution="yes"solutionVersion="1.0.0.1"productVersion="11.0.5106"solutionFormatVersion="1.0.0.0">...</xsf:xDocumentClass>

autoCompleteAttribute

Switchestheauto-completionoffieldsonoroff.

xsf:xdYesNo

RemarksTheautoCompleteattributeisanoptionalattributeoftheeditWithelement.

Valuesinclude"yes"and"no".Thedefaultvalueis"yes".

ExampleThefollowingisanexampleoftheautoCompleteattributeasitisusedintheeditWithelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample"><xsf:editWithcaption="CD"autoComplete="yes"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentparent="CDCollection"><CD><Title></Title><Artist></Artist><Tracks><Track></Track><Track></Track></Tracks></CD></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit></xsf:editing>

ShowAll

automaticallyCreateNodesAttribute

IdentifieswhetherXMLDocumentObjectModel(DOM)nodeswillbeautomaticallygeneratedwhencontrolsareinsertedintheviewindesignmode.

xsf:xdYesNo

RemarksTheautomaticallyCreateNodesattributeisanoptionalattributeofthesolutionPropertieselement.

TheautomaticallyCreateNodesattributecorrespondstotheAutomaticallycreatedatasourcecheckboxatthebottomoftheControlstaskpane.

ExampleThefollowingisanexampleoftheautomaticallyCreateNodesattributeasitisusedinthesolutionPropertieselement:

bottomMarginAttribute

Specifiesthebottommarginwhenprintingaview.

xsd:string

RemarksThebottomMarginattributeisanoptionalattributeoftheprintSettingselement.

ThebottomMarginattributemustbegreaterthanorequaltozero.

ExampleThefollowingisanexampleofthebottomMarginattributeasitisusedintheprintSettingselement:

<xsf:viewname="View"caption="View"><xsf:printSettingsheader="Headertextgoeshere."footer="Footertextgoeshere."orientation="portrait"marginUnitsType="in"topMargin="1"leftMargin="2"rightMargin="2"bottomMargin="1"</xsf:printSettings>...</xsf:view>

cabFileAttribute

SpecifiesthenameoftheCABfile.

Typexsd:string

ParentElements

instantiated.

Definition

<xsd:attributename="cabFile"type="xsd:string"use="optional"></xsd:attribute>

RemarksThecabFileattributemustrefertoafilewithintheInfoPathpackage.IfthecabFileattributeisnotspecified,thecontrolmustalreadyberegisteredonthelocalcomputerortheformwillnotopen.

ExampleThefollowingisanexampleofthecabFileattributeasitisusedintheallowedControlelement:

canInitiateWorkflowAttribute

Specifieswhethertheactionelementcanbeusedtoinitiateorextendanactivityflow.

Typexsf:xdYesNo

ParentElements

Definition

<xsd:attributename="canInitiateWorkflow"type="xsf:xdYesNo"use="required"></xsd:attribute>

RemarksThecanInitiateWorkflowattributeisarequiredattributeoftheactionelement.

ExampleThefollowingisanexampleofthecanInitiateWorkflowattributeasitisusedintheactionelement:

captionAttribute(actionElement)

SpecifiesalabelforthebuttonintheWorkflowtaskpanecorrespondingtotheactionelement.

Typexsf:xdHWSCaption

ParentElements

Definition

<xsd:attributename="caption"type="xsf:xdHWSCaption"use="optional"></xsd:attribute>

RemarksThecaptionattributeisanoptionalattributeoftheactionelement.

Ifacaptionisnotspecified,thevalueofthenameattributewillbeusedasthecaptionforthebuttonintheWorkflowtaskpane.

Thecaptionattributeisalsousedtoextendanactivityflow.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedintheactionelement:

captionAttribute(buttonElement)

Providesthecaptiondisplayedonthebutton.

xsf:xdTitle

RemarksThecaptionattributeisanoptionalattributeofthebuttonelement.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedinthebuttonelement:

captionAttribute(editWithElement)

SpecifiesanidentifierforalternateformsofXMLdatatobeusedintheeditingcomponent.

xsf:xdTitle

RemarksThecaptionattributeisanoptionalattributeoftheeditWithelement.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedintheeditWithelement:

captionAttribute(initialXmlDocumentElement)

DefinesthetextstringtobeusedasthenameoftheformintheTemplateGalleryandinthemostrecentlyusedlist.

xsf:xdTitle

RemarksThecaptionattributeisarequiredattributeoftheinitialXmlDocumentelement.

Ifthisattributeisnotspecified,thenameoftheformisusedasthecaption.Themaximumsizeforthecaptiontextstringis255characters.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedintheinitialXmlDocumentelement:

captionAttribute(menuElement)

Usedasthecaptionforamenu.

xsf:xdTitle

RemarksThecaptionattributeisarequiredattributeofthemenuelement.

Whenusedforamenuthatisnestedwithinaview,thecaptionisthetop-levelmenucaption;whenusedforamenuthatisnestedwithinatoolbar,thecaptionisforthebuttononadrop-downmenu;andwhenusedforamenuthatisnestedinsideanothermenu(cascadingmenu),thecaptionisthesub-menucaption.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedinthemenuelement:

ShowAll

captionAttribute(ruleElement)

ContainsthenameofaruleasitappearsinMicrosoftOfficeInfoPath.

Typexsd:string

ParentElements

Element Descriptionrule Definesanactioninvokedafteraneventhasoccuredinthe

Definition

<xsd:attributename="caption"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthecaptionattributeasitisusedintheruleelement:

captionAttribute(submitElement)

DefinesthenameofthesubmitbuttonandcorrespondingmenuitemthatwillappearontheFilemenuwhenauserisfillingoutaform.

xsd:string

RemarksThecaptionattributeisanoptionalattributeofthesubmitelement.

Thedefaultvalueis"Submit",butanytextstringcanbeused.Ifthecaptionattributeismissingorissettoanemptystring,thedefaultvalueisused.The"&"characterscanbeusedtocreateakeyboardshortcutforthesubmitmenuitem.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedinthesubmitelement:

ShowAll

captionAttribute(taskElement)

SpecifiesalabelforthebuttonintheWorkflowtaskpanecorrespondingtothetaskelement.

Typexsf:xdHWSCaption

ParentElements

Element Descriptiontask TheHumanWorkflowServices(HWS)taskinformation

enabledfortheform.

Definition

<xsd:attributename="caption"type="xsf:xdHWSCaption"use="optional"></xsd:attribute>

RemarksThecaptionattributeisanoptionalattributeofthetaskelement.

Ifacaptionisnotspecified,thevalueofthenameattributewillbeusedasthecaptionforthebuttonintheWorkflowtaskpane.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedinthetaskelement:

captionAttribute(taskpaneElement)

Definesthecaptionusedinthetaskpanedrop-downlistbox.

xsd:string

RemarksThecaptionattributeisarequiredattributeofthetaskpaneelement.

Ifthecaptionattibuteiscontainsanemptyvalue,thenthedefaultcaptionof"FormTasks"isused.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedinthetaskpaneelement:

<xsf:xDocumentClass>...<xsf:taskpanecaption="MyCustomTaskPane"href="MyCustomTaskPane.htm"/>...</xsf:xDocumentClass>

captionAttribute(toolbarElement)

Usedasthetitleofthetoolbar,whenthetoolbarisnotdockedtotheuserinterface.

xsf:xdTitle

RemarksThecaptionattributeisarequiredattributeofthetoolbarelement.

NoteThecaptionattributeisalsousedforthenameofthetoolbarintheCustomizeCommandsdialogboxforacontrol.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedinthetoolbarelement:

captionAttribute(viewElement)

Providesthedisplaycaptionfortheviewwithintheviewlist.

xsf:xdViewName

RemarksThecaptionattributeisanoptionalattributeoftheviewelement.

Ifnotspecified,thecaptionoftheviewdefaultstothevalueofthenameattribute.

ExampleThefollowingisanexampleofthecaptionattributeasitisusedintheviewelement:

clsidAttribute

SpecifiestheCOMclassID(CLSID)ofanActiveXcontrol.

Typexsd:string

ParentElements

instantiated.

Definition

<xsd:attributename="clsid"type="xsd:string"use="required"></xsd:attribute>

WhentheviewcontainsanOBJECTtag,thecontrolwillbeinstantiatedonlyiftheCLSIDislistedasanallowedControlelementinthepermissionselement.IfanActiveXcontrolwiththisCLSIDisnotpresentonthesystemandcan'tbeinstalled,theformwillnotopen.

ExampleThefollowingisanexampleoftheclsidattributeasitisusedintheallowedControlelement:

collateattribute

Specifieswhetherthepaperiscollated.

Typexsf:xdYesNo

ParentElements

Element DescriptionprintSettings Specifiestheprintersettingsusedwhenprintingaview.

Definition

<xsd:attributename="collate"type="xsf:xdYesNo"></xsd:attribute>

ExampleThefollowingisanexampleofthecollateattributeasitisusedintheprintSettingselement:

columnNameAttribute

IdentifiesthecolumnnameintheSQLtable(underlyingtheformlistview).

xsf:xdTitle

RemarksThecolumnNameattributeisarequiredattributeofthefieldelement.

ExampleThefollowingisanexampleofthecolumnNameattributeasitisusedinthefieldelement:

ShowAll

commandTextAttribute

AstringpropertythatcontainstheActiveXDataObjects(ADO)SQLcommandtexttobeusedforqueryingthedatafromthespecifieddatasource.

xsd:string

RemarksThecommandTextattributeisarequiredattributeoftheadoAdapterelement.

ExampleThefollowingisanexampleofthecommandTextattributeasitisusedintheadoAdapterelement:

componentAttribute

Specifiesthenameoftheeditingcomponentthatwillbereferencedwithintheactionattributeofabuttonelement.

xsd:enumeration

RemarksThecomponentattributeisarequiredattributeoftheeditWithelement.

ValidcomponentnamesincludexCollection,xOptional,xReplace,xTextList,xField,xImage,xFileAttachment.

ExampleThefollowingisanexampleofthecomponentattributeasitisusedintheeditWithelement:

ThefollowingisanexampleofthecomponentattributeasitisusedintheeditWithelement,wherethevalueofthecomponentattributeis"xFileAttachment":

<xsf:xmlToEditname="some_name"item="/my:myFields/my:field1">

<xsf:editWithallowedFileTypes="doc,xls"component="xFileAttachment"/></xsf:xmlToEdit><menuAreaname="msoStructuralEditingContextMenu"><buttonaction="xFileAttachment::attach"xmlToEdit="some_name"caption="Attach..."showIf="immediate"/><buttonaction="xFileAttachment::open"xmlToEdit="some_name"caption="Open"showIf="immediate"/><buttonaction="xFileAttachment::saveAs"xmlToEdit="some_name"caption="SaveAs..."showIf="immediate"/><buttonaction="xFileAttachment::remove"xmlToEdit="some_name"caption="Deletefile"showIf="immediate"/></menuArea>

ShowAll

conditionAttribute

DefinesanXPathexpressionevaluatedasaBooleanvaluetodeterminewhethertheassociatedactionwillbeinvoked.

Typexsd:string

ParentElements

Definition

<xsd:attributename="condition"type="xsd:string"use="optional"></xsd:attribute>

ExampleThefollowingisanexampleoftheconditionattributeasitisusedintheruleelement:

ShowAll

connectionStringAttribute

AstringpropertythatcontainstheActiveXDataObjects(ADO)connectionstringtobeusedtoconnecttothedatasource.

xsd:string

RemarksTheconnectionStringattributeisarequiredattributeoftheadoAdapterelement.

ExampleThefollowingisanexampleoftheconnectionStringattributeasitisusedintheadoAdapterelement:

ShowAll

containerAttribute

SpecifiesanXPathexpressionthatdeterminesthecontextinwhichthecontrolwillbeselectableanditsactionsenabled.

xsd:string

RemarksThecontainerattributeisanoptionalattributeofthexmlToEditelement.

Ifthecurrentcontext(viewselectionorinsertionpoint)iswithinsomeHTMLelementthatmapsbacktoanXMLDocumentObjectModel(DOM)nodethatsatisfiesthecontainerXPathexpression,thecontrolisenabled.Otherwise,allactionsaredisabled.

ItdoesnotsufficeforthecontainerXMLDOMnodetoexist.ActionswillbeenabledonlywhenthecurrentselectioniswithinanHTMLelementthatmapstothecontainerXMLDOMnode.

NoteInMicrosoftOfficeInfoPath2003designmode,generatedXPathexpressionsfortheitemandcontainerattributeswillalwaysbeintheformitem="/a/b/c",whichprovidesthefullpathfromtherootelementoftheform'sunderlyingXMLdocument.Butpatternssuchasitem="b/c",orwithpredicatesasinitem="b[@p='23']/c[q]"areallowediftheformdefinition(.xsf)fileiseditedmanually.

ExampleThefollowingisanexampleofthecontainerattributeasitisusedinthexmlToEditelement:

copiesattributeSpecifiesthenumberofcopiestobeprinted.

Typexsd:Integer

ParentElements

Element DescriptionprintSettings Specifiestheprintersettingsusedwhenprintingtheview.

Definition

<xsd:attributename="copies"><xsd:simpleType><xsd:restrictionbase="xsd:integer"><xsd:minInclusivevalue="1"/><xsd:maxInclusivevalue="9999"/></xsd:restriction></xsd:simpleType></xsd:attribute>

ShowAll

dataAttribute

ContainsanXPathmatchexpressionthatdefinesthenodesettowhichthesignaturewillbeapplied.

Typexsd:string

ParentElements

documenttowhichadigitalsignaturecanbeapplied

Definition

<xsd:attributename="data"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthedataattributeasitisusedinthesignedDataBlockelement:

<xsf:documentSignatures><xsf:signedDataBlockname=”main”data="my:myfields/my:subtree1|my:myfields/my:subtree2"signatureLocation="my:mifields/sig:signatures/main"mode="countersign"><xsf:message>Bypressingthe"Sign"buttonbelow,Iagreetobeboundtothetermsofthisdocument.</xsf:message></xsf:signedDataBlock></xsf:documentSignatures>

ShowAll

dataFormSolutionAttribute

Identifiestheformasadatabaseform.

xsf:xdYesNo

RemarksThedataFormSolutionattributeisanoptionalattributeofthexDocumentClasselement.

Allowedvaluesare"yes"and"no".Thedefaultvalueis"no".FormsbasedonActiveXDataObjects(ADO)orWebservicesandthathaveaspecialqueryviewshouldhavethisattributesetto"yes"toworkproperlyinMicrosoftOfficeInfoPath2003.

ExampleThefollowingisanexampleofthedataFormSolutionattributeasitisusedinthexDocumentClasselement:

ShowAll

dataObjectAttribute(domEventHandlerElement)

ContainsthenameofthedataObjectelementtobeusedintheeventhandler.

Typexsd:string

ParentElements

Element DescriptiondomEventHandlerDefinesaneventhandlerforoneormorespecific

XMLDocumentObjectModel(DOM)nodes.

Definition

<xsd:attributename="dataObject"type="xsd:string"use="optional"></xsd:attribute>

RemarksThedataObjectattributeisanoptionalattributeofthedomEventHandlerelement.

ExampleThefollowingisanexampleofthedataObjectattributeasitisusedinthedomEventHandlerelement:

<xsf:domEventHandlers><xsf:domEventHandlermatch="TravelReport/Expenses"handlerObject="TravelExpenses"dataObject="dataObject1"/></xsf:domEventHandlers>

dataObjectAttribute(getUserNameFromDataElement)

Thenameofthesecondarydatasourcewheretheusernamenamecanbefound.

Typexsd:string

ParentElements

Element DescriptiongetUserNameFromData RetrievesausernamebyusinganXPath

queryofthedatainthemaindatasourceorinasecondarydatasource.

Definition

RemarksForthemaindatasource,thisattributeshouldnotbepresent.Anemptystringisinvalid.

ExampleThefollowingisanexampleofthedataObjectattributeasitisusedinthegetUserNameFromDataelement:

<xsf:membership><xsf:getUserNameFromDatadataObject="catalog"select="/dfs:myFields/dfs:dataFields/d:UserA"memberOf="B"/><xsf:userNamename="domain\username1"memberOf="A"/><xsf:userNamename="domain\username2"memberOf="B"/><xsf:groupname="domain\groupname1"memberOf="C"/></xsf:membership></xsf:roles>

dataObjectAttribute(partFragmentElement)

SpecifiesthenameofthedataobjecttousewhensubmittingapartFragmentelementtoaMicrosoftBiztalk2004HumanWorkflowServices(HWS)server.

Typexsd:string

ParentElements

Element DescriptionpartFragmentDefinesonesubstitutiongroupforaspecificpartofthe

inputSimpleObjectAccessProtocol(SOAP)message.

Definition

ExampleThefollowingisanexampleofthedataObjectattributeasitisusedinthepartFragmentelement:

<xsf:partFragmentmatch="ActionSection/Target"replaceWith="/my:myFields/my:Target"dataObject="hwsDataObject3"/>

ShowAll

defaultAttribute

Specifiesthenameidentifieroftheviewchosentobethedefaultview.

xsd:string

RemarksThedefaultattributeisanoptionalattributeoftheviewselement.

Ifnotspecified,thedefaultviewisthefirstviewelementfoundwithintheviewselement.ThisviewisloadedwhenanMicrosoftOfficeInfoPath2003isinitiallyopened.

NoteInthecaseofformsthatuseActiveXDataObjects(ADO)oraWebserviceastheirprimarydatasource,thedefaultviewissetbytheinitialViewattributeintheprocessinginstructionoftheform'sXMLtemplatefile.Thisattributecannotbechangedwhileindesignmode.

ExampleThefollowingisanexampleofthedefaultattributeasitisusedintheviewselement:

defaultAttribute(rolesElement)

Designatesaparticularroleasthedefaultrole.

Typexsd:string

ParentElements

Element Descriptionroles Definesroles.

Definition

<xsd:attributename="default"type="xsd:string"use="required"></xsd:attribute>

RemarksIfauserofaformisnotdefinedinthemembershipelementoftheroleselementoriftheroleofausercannotbedetermined,thatuserisimplicitlyassignedtotherolespecifiedbythedefaultattribute.Thedefaultattributeisrequiredfortheroleselement.

ExampleThefollowingisanexampleofthedefaultattributeasitisusedintheroleselement:

descriptionAttribute

Abriefdescriptionoftheform.

xsd:string

RemarksThedescriptionattributeisanoptionalattributeofthexDocumentClasselement.

Thevalueofthedescriptionattributecancontainupto255characters.

ExampleThefollowingisanexampleofthedescriptionattributeasitisusedinthexDocumentClasselement:

ShowAll

designModeAttribute(viewElement)

Determineswhethertheview(*.xsl)filespecifiedinaviewelementcanbeopenedindesignmodeinMicrosoftOfficeInfoPath2003.

Typexsf:xdDesignMode

ParentElements

Element Descriptionview ContainsinformationaboutaMicrosoftOfficeInfoPath2003

Definition

<xsd:attributename="designMode"type="xsf:xdDesignMode"></xsd:attribute>

RemarksYoucancreateacustomviewforaformtemplatebycreatinganXSLTransformation(XSLT)(*.xsl)filethatcontainsconstructsthatarenotsupportedindesignmodeinInfoPath.Toensurethataviewcan'tbeopenedindesignmode(andtopreventdataloss),setthedesignModeattributeintheformdefinitionfile(.xsf)to"protected".Protectedviewsareshowninallviewslistsanduserscanbefillthemoutlikeallforms,buttheycannotbeopenedindesignmode.IfthedesignModeattributeisspecifiedas"normal"orisnotspecified,theviewcanbeopenedindesignmode.

ExampleThefollowingisanexampleofthedesignModeattributeasitisusedintheviewelement:

<xsf:viewname="View"caption="View"designMode="protected"><xsf:mainpanetransform="view1.xsl"/>...</xsf:view>

ShowAll

detailKeyAttribute

ContainstheXPathofthefieldinthedetailXMLfragmentthatformstherelationshiptothemasterXMLfragment.

Typexsd:string

ParentElements

Element DescriptionmasterDetailDefinestheXMLfragmentsthatformamasteranddetail

relationshipinaview'srepeatingtablesorrepeatingsections.

Definition

<xsd:attributename="detailKey"type="xsd:string"></xsd:attribute>

RemarksUsearelativeXPathforthedetailKeyattribute.

ExampleThefollowingisanexampleofthedetailKeyattributeasitisusedinthemasterDetailelement:

disableMenuItemAttribute

Specifieswhetherthemenuitemforthesubmitoperationshouldbedisabled.

xsf:xdYesNo

RemarksThedisableMenuItemattributeisanoptionalattributeofthesubmitelement.

Allowedvaluesare"yes"and"no".Thedefaultvalueis"no".

ExampleThefollowingisanexampleofthedisableMenuItemattributeasitisusedinthesubmitelement:

enabledAttribute

Specifieswhetherformmergingisenabledfortheform.

xsf:xdYesNo

RemarksTheenabledattributeisarequiredattributeoftheimportParameterselement.

Valuesinclude"yes"or"no".Thedefaultvalueis"yes".

ExampleThefollowingisanexampleoftheenabledattributeasitisusedintheimportParameterselement:

<xsf:importParametersenabled="yes"<xsf:importSourcename=""schema="MySchema.xsd"transform="schematransform.xslt"/></xsf:importParameters>

ShowAll

enforceScriptTimeoutAttribute

Specifieswhethertoenableordisableatime-outperiodforscriptsinaform.

Typexsf:xdYesNo

ParentElements

Element Descriptionscripts Definesthesourceofallbusinesslogicscriptsusedatthe

documentlevelintheform.

Definition

<xsd:attributename="enforceScriptTimeout"type="xsf:xdYesNo"use="optional"default="yes"></xsd:attribute>

RemarksSettingtheenforceScriptTimeoutattributeto"no"intheformdefinitionfile(.xsf)disablesthetime-outperiodforscriptsrunningintheform.Thedefaultvalueis"yes".

Forcoderunninginataskpane,thereisaseparatetime-outperiodprovidedbyMicrosoftInternetExplorer.Thistime-outperiodisnotaffectedbythevalueoftheenforceScriptTimeoutattribute.

Atime-outperiodcannotbespecifiedformanagedcodeinInfoPathforms.

ExampleThefollowingisanexampleoftheenforceScriptTimeoutattributeasitisusedinthescriptselement:

ShowAll

expressionAttribute

AnXPathexpression(relativetotheexpressionContextattribute,ifspecified)thatmustbeevaluatedtovalidatetheXMLDocumentObjectModel(DOM)nodespecifiedinthematchattribute.

xsd:string

RemarksTheexpressionattributeisarequiredattributeoftheerrorConditionelement.

IfthespecifiedexpressionevaluatestoTrue,itisconsideredtobeanerrorconditionandthespecifiederrormessageisdisplayed.

ExampleThefollowingisanexampleoftheexpressionattributeasitisusedintheerrorConditionelement:

ShowAll

expressionAttribute(assignmentActionElement)

ContainsanXPathexpressiontopopulatethevalueofthetargetFieldattribute.

Typexsd:string

ParentElements

Element DescriptionassignmentAction Definesanactiontosetthevalueofafield.

Definition

<xsd:attributename="expression"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheexpressionattributeasitisusedintheassignmentActionelement:

ShowAll

expressionAttribute(calculatedFieldElement)

Containstheformula,intheformofanXPathexpression,tobeevaluated.Theresultisstoredinthetargetlocation.

Typexsd:string

ParentElements

Definition

<xsd:attributename="expression"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheexpressionattributeasitisusedinthecalculatedFieldelement:

ShowAll

expressionContextAttribute

SpecifiestheXMLDocumentObjectModel(DOM)nodeonwhichtheexpressionspecifiedintheexpressionattributeisrooted.

xsd:string

RemarksTheexpressionContextattributeisanoptionalattributeoftheerrorConditionelement.

ItcontainsarelativeXPathexpressionthatidentifiestheXMLDOMnode(withinthecontextofthematchedXMLDOMnode)onwhichtheexpressionisrootedandthereforeshouldbeevaluated.Thedefaultvalueis"."ThisisthesameasthematchedXMLDOMnode.

ExampleThefollowingisanexampleoftheexpressionContextattributeasitisusedintheerrorConditionelement:

featureAttribute

SetswhethertheAutoRecoverfeatureisenabled.

Typexsf:xdEnabledDisabled

ParentElements

Element DescriptionautoRecovery SpecifieswhethertheformwillsaveAutoRecover

informationandwhethertheAutoRecoversettingcanbechangedbytheuser.

Definition

<xsd:attributename="feature"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute>

RemarksSettingthisattributetoavalueotherthan"enabled"or"disabled"willresultinanerrormessagewhenyouattempttoopentheform.

ExampleThefollowingisanexampleofthefeatureattributeasitisusedintheautoRecoveryelement:

<xsf:autoRecovery feature="disabled"/>

ShowAll

fieldAttribute

SpecifiesarelativeXPathexpressionfromtheXMLDocumentObjectModel(DOM)nodespecifiedbytheitemattributeofthexmlToEditelement.

xsd:string

RemarksThefieldattributeisanoptionalattributeoftheeditWithelement.

ThefieldattributereferstotheXMLDOMnodeintheform'sunderlyingXMLdocument,whichistobedisplayedasaneditablefieldforanxTextlisteditingcomponent.Thedefaultvalueis'.',whichcorrespondstoeditingthetextcontentoftheXMLDOMnodespecifiedbytheitemattributeofthexmlToEditelement.

ExampleThefollowingisanexampleofthefieldattributeasitisusedintheeditWithelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample"><xsf:editWithautoComplete="no"field="@artist"component="xTextList"></xsf:editWith></xsf:xmlToEdit></xsf:editing>

ShowAll

fileUrlAttribute

ContainstheUniformResourceLocator(URL)ofthe.xmlfile.

xsd:anyURI

RemarksThefileUrlattributeisarequiredattributeofthexmlFileAdapterelement.

ExampleThefollowingisanexampleofthefileUrlattributeasitisusedinthexmlFileAdapterelement:

<xsf:query><xsf:xmlFileAdapterfileUrl="currencies.xml"/></xsf:query>

ShowAll

filterAttribute

SpecifiestheXPathexpressionofthestructuredXMLsubtreewhensubmittingasubsetoftheXMLdata.

Typexsd:string

ParentElements

Definition

<xsd:attributename="filter"type="xsd:string"use="optional"></xsd:attribute>

RemarksUsethefilterattributewhensubmittingtheselectedfieldorgroupasastructuredXMLsubtree,includingthetags.Canbeomittedwhensubmittingthecontentofthefieldorgroup.

ExampleThefollowingisanexampleofthefilterattributeasitisusedinthepartFragmentelement:

<xsf:partFragmentmatch="/dfs:myFields/dfs:dataFields/s0:IsPrime/s0:inValue"replaceWith=/dfs:myFields/dfs:dataFields/s0:IsPrime"filter="."sendAsString="yes"/>

ShowAll

filterDependencyAttribute

Specifiesautomaticreapplicationofafilterwhenfilterfieldschange.

Typexsd:string

ParentElements

Definition

<xsd:attributename="filterDependency"type="xsd:string"use="optional"></xsd:attribute>

RemarksThefilterDependencyattributeintheformdefinitionfile(.xsf)isalwayspresentforfiltersthatarespecifiedonrepeatingtablesandrepeatingsectionscreatedinthedesigner.EventhoughthereisnowaytotogglefilterDependencyonandoffindesignmodeinInfoPath,youcanturnoffautomaticrefreshingoffiltersbyremovingthefilterDependencyattributefromtheeditWithelementintheformdefinitionfile.

WhenthefilterDependencyattributeispresent,thefilterisreappliedwhentheonAfterChangeeventofanodeisraised.

ExampleThefollowingisanexampleofthefilterDependencyattributeasitisusedintheeditWithelement:

<editWithcomponent="xCollection"widgetIcon="filter|standard"useFilter="yes|no"filterDependency="xpath1|xpath2|xpath3>

ShowAll

followingSiblingsAttribute

SpecifiesarelativeXPathexpressionfromtheparentnodethatspecifiestheXMLDocumentObjectModel(DOM)nodespriortowhichtheinsertionoftheXMLfragmentshouldoccur.

xsd:string

RemarksThefollowingSiblingsattributeisanoptionalattributeofthechooseFragmentelement.

Theinsertionwillbeasachildoftheparentnode,butitwillbepriortoanynodesfoundthatsatisfytheXPathexpressionspecifiedbythefollowingSiblingsattribute.Ifnonodesarefound,theinsertionactsasanappend.

ThefollowingSiblingsattributeisonlyusedduringaninsertwhenthecurrentcontextisnotinanitem.Thebehavioristoappendtothecontentoftheparentnode,unlessthefollowingSiblingsattributeisspecified,inwhichcasetheinsertionisstillwithinthecontentoftheparent,butpriortoanyfollowingSiblingsnodes.

ExampleThefollowingisanexampleofthefollowingSiblingsattributeasitisusedinthechooseFragmentelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample"><xsf:editWithcaption="CD"xd:autogeneration="template"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentparent="CDCollection"followingSiblings="."><CD><Title></Title><Artist></Artist><Tracks><Track></Track><Track></Track></Tracks></CD></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit></xsf:editing>

ShowAll

footerAttribute

Specifiesthefootertextwhenprintingaview.

xsd:string

RemarksThefooterattributeisanoptionalattributeoftheprintSettingselement.TheprintSettingselementalsoprovidesaheaderattribute.

Thefooterattributecannotbegreaterthan255charactersinlength.

Whenusingaheaderorfooterinaform,thereareanumberofvariablesthatcanbeusedtodisplayinformationsuchaspagenumbers,dates,andtimes;ortoalignthetextthattheheaderorfootercontains.

Headerandfootervariables

ExampleThefollowingisanexampleofthefooterattributeasitisusedintheprintSettingselement:

ShowAll

fullyEditableNamespaceAttribute

IdentifiesthenamespaceofanXMLSchemaintheformtemplatethatcanbeentirelymodifiedinMicrosoftOfficeInfoPath2003designmode.

xsd:anyURI

RemarksThefullyEditableNamespaceattributeisanoptionalattributeofthesolutionPropertieselement.

ExampleThefollowingisanexampleofthefullyEditableNamespaceattributeasitisusedinthesolutionPropertieselement:

ShowAll

handlerObjectAttribute

Identifiestheuniquenameoftheeventhandlerinthescriptingcode.

xsd:string

RemarksThehandlerObjectattributeisarequiredattributeofthedomEventHandlerelement.

ThereferencedscriptmustusethisnametodefineeventhandlersforthespecifiedXMLDocumentObjectModel(DOM)node.Forexample,scriptmaycontainfunctionssuchasTravelExpenses::OnValidateandTravelExpenses::OnAfterChangethatarecalledwheneverthespecifiedeventsoccuratthematchingXMLDOMnode.

ExampleThefollowingisanexampleofthehandlerObjectasitisusedinthedomEventHandlerelement:

ShowAll

headerAttribute

Specifiestheheadertextwhenprintingaview.

xsd:string

RemarksTheheaderattributeisanoptionalattributeoftheprintSettingselement.TheprintSettingselementalsoprovidesafooterattribute.

Theheaderattributecannotbegreaterthan255charactersinlength.

Whenusingaheaderorfooterinaform,thereareanumberofvariablesthatcanbeusedtodisplayinformationsuchaspagenumbers,dates,andtimes;ortoalignthetextthattheheaderorfootercontains.

Headerandfootervariables

ExampleThefollowingisanexampleoftheheaderattributeasitisusedintheprintSettingselement:

ShowAll

hideStatusBarDisplayattribute

Specifieswhetherthecurrentroleisdisplayedinthestatusbar.

Typexsf:xdYesNo

ParentElements

Definition

<xsd:attributename="hideStatusBarDisplay"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksThenameoftheroleforthecurrentuserisdisplayedinthestatusbar.Iftheroleofauserischangedprogrammatically,thestatusbarisupdated.

ThevalueofthehideStatusBarDisplayattributeis"no"bydefault.Iftheattributeisnotincludedintheroleselement,therefore,theroleofthecurrentuserisdisplayedinthestatusbar.ThehideStatusBarDisplayattributemustbeincludedintheroleselementanditsvaluemustbesetto"yes"topreventtheroleforthecurrentuserfrombeingdisplayedinthestatusbar.

ThereisnomechanismintheuserinterfaceofInfoPathforchangingthehideStatusBarDisplayattribute.Toaddthisattributetotheroleselementortochangeitsvalue,theformdefinitionfile(.xsf)ofaformmustbeeditedmanually.

ExampleThefollowingisanexampleofthehideStatusBarDisplayattributeasitisusedintheroleselement:

ShowAll

hrefAttribute(initialXmlDocumentElement)

SpecifiesthenameoftheXMLtemplatefiletobeusedwhenauserclicksFillOutaFormontheFilemenu.

xsf:xdFileName

RemarksThehrefattributeisarequiredattributeoftheinitialXmlDocumentelement.

ExampleThefollowingisanexampleofthehrefattributeasitisusedintheinitialXmlDocumentelement:

ShowAll

hrefAttribute(taskpaneElement)

SpecifiestherelativeorabsoluteUniformResourceLocator(URL)toan.htmlfile.

xsd:string

RemarksThehrefattributeisarequiredattributeofthetaskpaneelement.

The.htmlfileisloadedintoaninstanceofthetaskpanewhenaformisopened.The.htmlfilecanincludebusinesslogicscriptingcodeandcanaccessappropriateMicrosoftOfficeInfoPath2003objectmodelmembers.

ExampleThefollowingisanexampleofthehrefattributeasitisusedinthetaskpaneelement:

<xsf:xDocumentClass>...<xsf:taskpanecaption="MyCustomTaskPane"href="MyCustomTaskPane.htm"/>...</xsf:xDocumentClass>

ShowAll

hrefAttribute(useHttpHandlerElement)

SpecifiestheUniformResourceLocator(URL)towhichtheformshouldbesubmitted.

xsd:anyURI

RemarksThehrefattributeisarequiredattributeoftheuseHttpHandlerelement.

ExampleThefollowingisanexampleofthehrefattributeasitisusedbytheuseHttpHandlerelement:

ShowAll

iconAttribute

ProvidesaUniformResourceLocator(URL)toabitmap(.bmp)orgraphicsinterchangeformat(.gif)file,whichisusedforthebuttonormenuitem.

xsd:string

RemarksTheiconattributeisanoptionalattributeofthebuttonelement.

Ifaniconisnotspecified,thecaptionalonewillbeused.Ifbothcaptionandiconarespecified,bothwillbedisplayed.Alternatively,thevaluecanalsobeanID,allowingaccesstointernalsystemicons.Ifthevalueisaninteger,itwillbeinterpretedasanID.

ExampleThefollowingisanexampleoftheiconattributeasitisusedinthebuttonelement:

<xsf:menuAreaname="msoInsertMenu"><xsf:menucaption="&Section"><xsf:buttonaction="xCollection::insert"xmlToEdit="CD_10"caption="CD"icon="cd.bmp"showIf="always"></xsf:button><xsf:buttonaction="xCollection::insert"xmlToEdit="Track_14"caption="Track"icon="track.bmp"showIf="always"></xsf:button><xsf:buttonaction="xOptional::insert"xmlToEdit="Label_16"caption="Label"icon="label.bmp"></xsf:button></xsf:menu></xsf:menuArea>

ShowAll

infopathGroupAttribute

ContainsthenameofthegroupunderwhichallfieldsinaSharePointlistorlibrarywillbestored.

Typexsd:string

ParentElements

Definition

<xsd:attributename="infopathGroup"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheinfopathGroupattributeasitisusedinthesharepointListAdapterelement:

infopathNameAttribute

Anattributeofthefieldelement.ContainsthecorrespondingInfoPathfieldnameforthesharepointNameattribute.

Typexsd:string

ParentElements

SharePointlistorlibraryandthecorrespondingnameusedinMicrosoftOfficeInfoPath.

Definition

<xsd:attributename="infopathName"type="xsd:string"use="required"></xsd:attribute>

RemarksTheinfopathNameappearsasthefieldnamesinMicrosoftOfficeInfoPath2003SP1forthefieldsreturnedfromtheSharePointlistorlibrary.

ExampleThefollowingisanexampleoftheinfopathNameattributeasitisusedinthefieldelement:

initiatorAttribute

Designatesaparticularroleastheinitiatorrole.

Typexsd:string

ParentElements

Definition

<xsd:attributename="initiator"type="xsd:string"use="optional"></xsd:attribute>

RemarksIfausercreatesanewInfoPathdocumentfromaformtemplate,thatuserisassignedtotherolethathasbeendesignatedastheinitiatorrole.Ifnoroleisdesignatedastheinitiatorroleintheformdefinitionfileofaform(thatis,iftheinitiatorattributeisnotincludedfortheroleselement),userswhocreateformsfromtheaccompanyingformtemplateretaintherolestowhichtheyareassignedinthemembershipelementoftheroleselement.Afteraformhasbeensaved,closed,andreopened,InfoPathnolongerchecksfortheinitiatorattribute.

ExampleThefollowingisanexampleoftheinitiatorattributeasitisusedintheroleselement:

initOnLoadAttribute

Specifieswhetherthedataobjectshouldbeinitializedondocumentload.

xsf:xdYesNo

RemarksTheinitOnLoadattributeisanoptionalattributeofthedataObjectelement.

ExampleThefollowingisanexampleoftheinitOnLoadattributeasitisusedinthedataObjectelement:

ShowAll

innerFragmentAttribute

SpecifiesarelativeXPathexpressionfromtheparentnodetothesmallestfragmenttobeinserted.

Typexsd:string

ParentElements

Element DescriptionchooseFragment SpecifiesanXMLfragment.

Definition

<xsd:attributename="innerFragment"type="xsd:string"use="optional"></xsd:attribute>

RemarksTheinnerFragmentattributeisusedtoidentifythepositionofthecurrentdatacontextwithinthefragment,andtochoosetherightsubtreetoinsert.Thisreducestheneedtodefinemultiplefragmentsintheformdefinitionfile(.xsf)fordifferentdatacontexts.

ExampleThefollowingisanexampleoftheinnerFragmentattributeasitisusedinthechooseFragmentelement:

<xsf:xmlToEditname="expense_1"item="/my:myFields/my:expenses/my:expense"container="/my:myFields"><xsf:editWithcaption="expense"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentinnerFragment="my:expenses/my:expense"><my:expenses><my:expense/></my:expenses></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit>

ShowAll

isEnabledAttribute

Specifieswhethertheruleisenabledfortheform.

Typexsf:xdYesNo

ParentElements

Definition

<xsd:attributename="isEnabled"type="xsf:xdYesNo"use="optional"default="yes"></xsd:attribute>

RemarksThedefaultvaluefortheisEnabledattributeis"yes".

ExampleThefollowingisanexampleoftheisEnabledattributeasitisusedintheruleelement:

isLookupAttribute

SpecifieswhetherafieldinaSharePointlistisalookupfield.

Typexsf:xdYesNo

ParentElements

Element Descriptionfield ContainsfieldmappinginformationforeachSharePointfield

andthecorrespondingnameusedinMicrosoftOfficeInfoPath2003SP1.

Definition

<xsd:attributename="isLookup"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksThedefaultvaluefortheisLookupattributeis"no".

ExampleThefollowingisanexampleoftheisLookupattributeasitisusedinthefieldelement:

ShowAll

itemAttribute

SpecifiesanXPathexpressionthatdeterminestheXMLDocumentObjectModel(DOM)nodestobeeditedusingtheeditingcomponentdefinedintheeditWithelement.

xsd:string

RemarksTheitemattributeisarequiredattributeofthexmlToEditelement.

ExampleThefollowingisanexampleoftheitemattributeasitisusedinthexmlToEditelement:

languageAttribute

Definesthescriptlanguageusedinthebusinesslogicsourcefiles.

xsf:xdScriptLanguage

RemarksThelanguageattributeisarequiredattributeofthescriptselement.

Allowedvaluesinclude"vbscript","jscript",and"javascript".Thedefaultvalueis"jscript".

ExampleThefollowingisanexampleofthelanguageattributeasitisusedinthescriptselement:

ShowAll

lastOpenViewAttribute

IdentifiesthenameoftheviewthatwaslastopeninMicrosoftOfficeInfoPath2003designmode.

xsd:string

RemarksThelastOpenViewattributeisanoptionalattributeofthesolutionPropertieselement.

ThenexttimetheformisopenedinInfoPathdesignmode,thisviewisautomaticallydisplayed.Thevalueforthisattributeshouldbeanexistingviewnameintheformtemplate.

ExampleThefollowingisanexampleofthelastOpenViewattributeasitisusedinthesolutionPropertieselement:

ShowAll

lastVersionNeedingTransformAttribute

Identifies,temporarily,thevalueofthemaxToVersionUpgradeattributeinthedocumentVersionUpgradeelementforupgradewithan.xsltfileifscriptingcodeisbeingusedfortheupgrade.

xsf:xdSolutionVersion

RemarksThelastVersionNeedingTransformattributeisanoptionalattributeofthesolutionPropertieselement.

ExampleThefollowingisanexampleofthelastVersionNeedingTransformattributeasitisusedinthesolutionPropertieselement:

leftMarginAttribute

Specifiestheleftmarginwhenprintingaview.

xsd:string

RemarksTheleftMarginattributeisanoptionalattributeoftheprintSettingselement.

TheleftMarginattributemustbegreaterthanorequaltozero.

ExampleThefollowingisanexampleoftheleftMarginattributeasitisusedintheprintSettingselement:

ShowAll

locationAttribute

ContainsthenamespaceUniformResourceIdentifier(URI)andlocation(aUniformResourceLocator(URL),relativetotheformdefinition(.xsf)file),anddelimitedbyaspace,ofthe.xsdfiledefiningtheXMLSchema.

xsd:string

RemarksThelocationattributeisarequiredattributeofthedocumentSchemaelement.

Non-namespace-basedXMLSchemasarelistedwithjustthe.xsdfile,omittingthenamespacedeclarationandthewhitespacedelimiter.

ExampleThefollowingisanexampleofthelocationattributeasitisusedinthedocumentSchemaelement:

marginUnitsTypeAttribute

Specifiesthemarginunitsizewhenprintingaview.

xsd:NMTOKEN

RemarksThemarginUnitsTypeattributeisanoptionalattributeoftheprintSettingselement.

Valuesinclude"in"(inch)and"cm"(centimeter).

ExampleThefollowingisanexampleofthemarginUnitsTypeattributeasitisusedintheprintSettingselement:

ShowAll

masterAttribute

ContainstheXPathoftheXMLfragmentthatisboundtoamastertableorsection.

Typexsd:string

ParentElements

Definition

<xsd:attributename="master"type="xsd:string"></xsd:attribute>

RemarksUsearelativeXPathforthemasterattribute.

ExampleThefollowingisanexampleofthemasterattributeasitisusedinthemasterDetailelement:

ShowAll

masterKeyAttribute

ContainstheXPathofthefieldinthemasterXMLfragmentthatformstherelationshiptothedetailXMLfragment.

Typexsd:string

ParentElements

Definition

<xsd:attributename="masterKey"type="xsd:string"></xsd:attribute>

RemarksUsearelativeXPathforthemasterKeyattribute.

ExampleThefollowingisanexampleofthemasterKeyattributeasitisusedinthemasterDetailelement:

ShowAll

masterViewContextAttribute

ContainsastringthatidentifiesanHTMLelementintheview.

Typexsd:string

ParentElements

Definition

<xsd:attributename="masterViewContext"type="xsd:string"></xsd:attribute>

RemarksThevalueofthemasterViewContextattributespecifiesanelementthathasanxd:CtrLIdattributewithamatchingvalueintheHTMLthatrepresentsaviewoftheform.Forexample,amasterViewContextattributewithavalueof"myID"correspondstotheelementthathasavalueof"myID"foritsxd:CtrlIdattribute.

ExampleThefollowingisanexampleofthemasterViewContextattributeasitisusedinthemasterDetailelement:

ShowAll

matchAttribute(domEventHandlerElement)

IdentifiestheXMLDocumentObjectModel(DOM)nodeforwhichtheeventhandlerisdeclared.

xsd:string

RemarksThematchattributeisarequiredattributeofthedomEventHandlerelement.

ThevaluemustbeavalidXPathexpressionthatidentifiestheXMLDOMnode.

NoteTheXPathexpressioncannotcontainpredicates.

ExampleThefollowingisanexampleofthematchattributeasitisusedinthedomEventHandlerelement:

ShowAll

matchAttribute(errorConditionElement)

IdentifiestheXMLDocumentObjectModel(DOM)nodesonwhichthecustomvalidationisdeclared.

xsd:string

RemarksThematchattributeisarequiredattributeoftheerrorConditionelement.

ExampleThefollowingisanexampleofthematchattributeasitisusedintheerrorConditionelement:

ShowAll

matchAttribute(overrideElement)

IdentifiestheXMLDocumentObjectModel(DOM)nodeforwhichtheerrormessageoverrideisdefined.

xsd:string

RemarksThematchattributeisarequiredattributeoftheoverrideelement.

ThevalueofthematchattributemustbeavalidXPathexpressionthatidentifiestheXMLDOMnode.

ExampleThefollowingisanexampleofthematchattributeasitisusedintheoverrideelement:

ShowAll

matchAttribute(partFragmentElement)

ContainsanXPathexpressionthatidentifiestheelementsandattributesinsidetheinputSimpleObjectAccessProtocol(SOAP)messagethataretobereplacedatruntime.

xsd:string

RemarksThematchattributeisarequiredattributeofthepartFragmentelement.

ExampleThefollowingisanexampleofthematchattributeasitisusedinthepartFragmentelement:

maxLengthAttribute

Definesthelengthofthefieldinnumberofbytes.

xsd:byte

RemarksThemaxLengthattributeisanoptionalattributeofthefieldelement.

ExampleThefollowingisanexampleofthemaxLengthattributeasitisusedinthefieldelement:

<xsf:listProperties><xsf:fields><xsf:fieldtype="xsd:date"maxLength="10"name="TravelDate"columnName="TravelDate"required="yes"viewable="yes"node="TravelReport/Header/travelDate"aggregation="first"/></xsf:fields></xsf:listProperties>

maxLengthAttribute(editWithElement)

Specifiesthemaximumnumberofcharactersallowedforplainsinglelinetextboxes.

Typexsd:simpleType

ParentElements

Definition

<xsd:attributename="maxLength"use="optional"><xsd:simpleType><xsd:restrictionbase="xsd:integer"><xsd:minInclusivevalue="-1"/><xsd:maxInclusivevalue="9999"/></xsd:restriction></xsd:simpleType></xsd:attribute>

RemarksThemaxLengthattributeisonlyvalidforplain-texteditcontrolsthatdonotallowparagraphbreaks.SuchcontrolscorrespondtoeditWithelementswithacomponentattributesetto"xField"andatypeattributesetto"plain"(orwithoutatypeattributespecified).

ExampleThefollowingisanexampleofthemaxLengthattributeasitisusedintheeditWithelement:

<editWithcomponent="xField"maxLength="100">

maxVersionToUpgradeAttribute

Inclusivevalueforthelatestformthatneedstobeupgraded.

RemarksThemaxVersionToUpgradeattributeisanoptionalattributeoftheuseTransformelement.

ExampleThefollowingexampleshowsthemaxVersionToUpgradeattributeasitisusedintheuseTransformelement:

ShowAll

memberOfAttribute(getUserNameFromDataElement)

SpecifiestheroletobeassociatedwithauserwhoseusernameisreturnedbyanXPathqueryofadatasource.

Typexsd:string

ParentElements

Definition

<xsd:attributename="memberOf"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthememberOfattributeasitisusedinthegetUserNameFromDataelement:

<xsf:membership><xsf:getUserNameFromDatadataObject="catalog"select="/dfs:myFields/dfs:dataFields/d:UserA"<xsf:userNamename="domain\username1"memberOf="A"/><xsf:userNamename="domain\username2"memberOf="B"/><xsf:groupname="domain\groupname1"memberOf="C"/></xsf:membership></xsf:roles>

memberOfAttribute(groupElement)

Specifiestheroletowhichagroupisassigned.

Typexsd:string

ParentElements

Element Descriptiongroup Associatesagroupwithaparticularrole.

Definition

ExampleThefollowingisanexampleofthememberOfattributeasitisusedinthegroupelement:

memberOfAttribute(userNameElement)

Specifiestheroletowhichauserisassigned.

Typexsd:string

ParentElements

Element DescriptionuserName Associatesauserwithaparticularrole.

Definition

ExampleThefollowingisanexampleofthememberOfattributeasitisusedintheuserNameelement:

methodAttribute

SpecifiestheHTTPmethodtouseforthesubmitoperation.

xsd:NMTOKEN

RemarksThemethodattributeisarequiredattributeoftheuseHttpHandlerelement.

Theonlysupportedvalueis"POST".

ExampleThefollowingisanexampleofthemethodattributeasitisusedbytheuseHttpHandlerelement:

ShowAll

minVersionToUpgradeAttribute

Inclusivevaluefortheoldestformthatcanbeupgraded.

RemarksTheminVersionToUpgradeattributeisarequiredattributeoftheuseTransformelement.

TheminVersionToUpgradeattributeisusedtopreventrunningtheXSLTransformation(XSLT)onformssodifferentfromthecurrentonethattheXSLTcausesriskofdataloss.

ExampleThefollowingexampleshowstheminVersionToUpgradeattributeasitisusedintheuseTransformelement:

modeAttribute

SpecifiesthesignaturerelationshipforthesignedDataBlockelement.

Typexsf:xdSignatureRelationEnum

ParentElements

documenttowhichadigitalsignaturecanbeapplied

Definition

<xsd:attributename="mode"type="xsf:xdSignatureRelationEnum"use="required"></xsd:attribute>

RemarksThedefaultmodeofasignedDataBlockelementissingle.

ExampleThefollowingisanexampleofthemodeattributeasitisusedinthesignedDataBlockelement:

<xsf:documentSignatures><xsf:signedDataBlockname="main"data="my:myfields/my:subtree1|my:myfields/my:subtree2"signatureLocation="my:mifields/sig:signatures/main"mode="countersign"><xsf:message>Bypressingthe"Sign"buttonbelow,Iagreetobeboundtothetermsofthisdocument.</xsf:message></xsf:signedDataBlock></xsf:documentSignatures>

nameAttribute(actionElement)

TheuniquenameoftheactionasspecifiedbytheMicrosoftBizTalk2003HumanWorkflowServices(HWS)workflowdesigner.

Typexsf:xdHWSname

ParentElements

Element Descriptionaction Containstheinformationforanindividualaction.

Definition

<xsd:attributename="name"type="xsf:xdHWSname"use="required"></xsd:attribute>

RemarksThenameattributeisarequiredattributeoftheactionelement.

ThenameisusedfortheonClickeventofthecorrespondingbuttonintheWorkflowtaskpane.

ExampleThefollowingisanexampleofthenameattributeasitisusedintheactionelement:

ShowAll

nameattribute(adoAdapterelement)

ContainsthenameoftheadoAdapterelement.

Typexsf:xdTitle

ParentElements

Element DescriptionadoAdapter DefinesanActiveXDataObjects(ADO)dataadapterthat

retrievesdatafromanADOdatasourceforthespecifieddataobject.

Definition

<xsd:attributename="name"type="xsf:xdTitle"use="optional"></xsd:attribute>

RemarksThenameattributeisanoptionalattributeoftheadoAdapterelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedintheadoAdapterelement:

<xsf:query><xsf:adoAdaptername="EmpInformation"connectionString="Provider=Microsoft.Jet.OLEDB.4.0;Password="";UserID=Admin;DataSource=infnwind.mdb;Mode=ShareDenyNone;ExtendedProperties="";..."commandText="select[EmployeeID],[LastName],[FirstName]from[Employees]as[Employees]"queryAllowed="yes"submitAllowed="yes"></xsf:adoAdapter></xsf:query>

ShowAll

nameAttribute(buttonElement)

UsedtoassociatetheOnClickeventhandlerofthebuttonwithascriptingfunction.

xsd:NMTOKEN

RemarksThenameattributeisanoptionalattributeofthebuttonelement,butisrequiredforbuttonsthatusescriptingcodefortheiractions.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthebuttonelement:

<xsf:menuAreaname="msoViewMenu"><xsf:buttoncaption="CDCollection"name="SwitchToView0"></xsf:button><xsf:buttoncaption="AllTracks"name="SwitchToView1"></xsf:button></xsf:menuArea>

Intheform'sinternalscriptingfile,thefollowingeventhandlersareusedforthebuttonactions:

functionSwitchToView0::OnClick(){XDocument.View.SwitchView("CDCollection");}

functionSwitchToView1::OnClick(){XDocument.View.SwitchView("AllTracks");}

ShowAll

nameAttribute(customCategoryElement)

Specifiesthenameofthecustomcategory.

Typexsf:xdTitle

ParentElements

Element DescriptioncustomCategory Specifiesthecategorythattheformtemplateappears

underintheFillOutaFormtaskpane.

Definition

<xsd:attributename="name"type="xsf:xdTitle"use="required"></xsd:attribute>

RemarksThenameattributeisarequiredattributeofthecustomCategoryelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthecustomCategoryelement:

<xsf:customCategoryname="Reports"/>

nameAttribute(dataObjectElement)

Theuniquenameforthedataobject.

xsf:xdTitle

RemarksThenameattributeisarequiredattributeofthedataObjectelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthedataObjectelement:

ShowAll

nameAttribute(davAdapterElement)

ThenameofadavAdapter,usedtoinvoketheadapterfromformcode.

Typexsf:xdTitle

ParentElements

Element DescriptiondavAdapterContainsinformationtoenableInfoPathfilestobe

submittedtoaserverthatisrunningMicrosoftWindowsSharePointServicesoraWeb-basedDistributedAuthoringandVersioning(WebDAV)server.

Definition

ExampleThefollowingisanexampleofthenameattributeasitisusedinthedavAdapterelement:

nameAttribute(emailAdapterElement)

ContainsthenameoftheemailAdapterelement.

Typexsf:xdTitle

ParentElements

Element DescriptionemailAdapter ContainstheinformationtosubmitanInfoPathfileasan

attachmenttoane-mailmessage,withaspecifiedsetofrecipients,asubject,andanintroduction.

Definition

ExampleThefollowingisanexampleofthenameattributeasitisusedintheemailAdapterelement:

<xsf:emailAdaptername="Submit"submitAllowed="yes"><xsf:tovalue="someone@example.com"valueType="literal"/><xsf:ccvalue="my:ccNames"valueType="expression"/><xsf:bccvalue="my:bccNames"valueType="expression"/><xsf:subjectvalue="Myreport"valueType="literal"/><xsf:introvalue="Seebelow"/><xsf:attachmentFileNamevalue="StatusReport"valueType="literal"/></xsf:emailAdapter>

nameAttribute(extensionElement)

Auniquenameidentifyingtheextensionbeingspecified.

xsd:NMTOKEN

RemarksThenameattributeisarequiredattributeoftheextensionelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedintheextensionelement:

ShowAll

nameAttribute(externalViewElement)

ContainsthenameofanexternalViewelement.

Typexsf:xdViewName

ParentElements

Element DescriptionexternalViewDefinesaviewthatcannotbeeditedinInfoPath.

Definition

<xsd:attributename="name"type="xsf:xdViewName"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthenameattributeasitisusedintheexternalViewelement:

nameAttribute(fieldElement)

Identifiesthefriendlynameofthefieldtobeusedontheformlistview.

xsf:xdTitle

RemarksThenameattributeisarequiredattributeofthefieldelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthefieldelement:

ShowAll

nameAttribute(fileElement)

Specifiesthenameofthefile.

xsf:xdFileName

RemarksThenameattributeisarequiredattributeofthefileelement.

ThismustbearelativeURLfromtheURLoftheformdefinition(.xsf)file.Allfilesspecifiedhereareinsidetheformtemplate,soabsoluteURLsarenotsupported.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthefileelement:

nameAttribute(groupElement)

Specifiesthenameofagroupofuserstobeassignedtoaparticularrole.

Typexsd:string

ParentElements

Element Descriptiongroup Associatesagroupwithaparticularrole.

Definition

<xsd:attributename="name"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthenameattributeasitisusedinthegroupelement:

nameAttribute(hwsAdapterElement)

Containsthenameofthedataadapter.

Typexsf:xdTitle

ParentElements

Element DescriptionhwsAdapter DefinestheMicrosoftBiztalk2004HWS(HumanWorkflow

Services)dataadaptertostartorextendanactivityflow,andrespondtoatask.

Definition

ExampleThefollowingisanexampleofthenameattributeasitisusedinthehwsAdapterelement:

ShowAll

nameAttribute(importSourceElement)

Identifiesthenameofthesourceformasdefinedintheprocessinginstructionofthatform’sunderlyingXMLdocument.

xsd:string

RemarksThenameattributeisarequiredattributeoftheimportSourceelement.

ExampleThefollowingisanexampleofthenameattributeasitusedintheimportSourceelement:

<xsf:importParametersenabled="yes"<xsf:importSourcename="MyForm"schema="MySchema.xsd"transform="schematransform.xslt"/></xsf:importParameters>

nameAttribute(menuAreaElement)

Correspondstooneofthebuilt-inMicrosoftOfficeInfoPath2003top-levelmenus.

xsd:NMTOKEN

RemarksThenameattributeisarequiredattributeofthemenuAreaelement.

Therecannotbemorethanonemenuareawiththesamenamewithinagivenview.

InfoPathhasthefollowingnamedmenuareasthatcorrespondtothebuilt-inmenuelementsthatcanbecustomizedusingthemenuAreaelement:

Name DescriptionmsoFileMenu MenuitemsthatareaddedtotheFile

menu.msoEditMenu Menuitemsthatareaddedtothe

Editmenu.msoInsertMenu Menuitemsthatareaddedtothe

Insertmenu.msoViewMenu Menuitemsthatareaddedtothe

Viewmenu.msoFormatMenu Menuitemsthatareaddedtothe

Formatmenu.msoToolsMenu Menuitemsthatareaddedtothe

Toolsmenu.msoTableMenu Menuitemsthatareaddedtothe

Tablemenu.msoHelpMenu Menuitemsthatareaddedtothe

Helpmenu.msoStructuralEditingContextMenu Menuitemsthatareaddedtothe

right-clickshortcutmenu.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthemenuAreaelement:

nameAttribute(operationElement)

ContainstheuniquenameoftheWebservicemethod.

xsd:string

RemarksThenameattributeisarequiredattributeoftheoperationelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedintheoperationelement:

nameAttribute(propertyElement)

Definesthenameoftheproperty.

xsd:string

RemarksThenameattributeisarequiredattributeofthepropertyelement.AfileTypevalueof"ActiveX-CAB"identifiesthatthefileisa.cabfileaddedbythedesignerandindicatesthatthefileshouldbemanagedbytheActiveXsupportfeaturesofthedesigner.Thetimestamppropertyidentifiesthelatestversionofthe.cabfile.TheversioninformationisusedforautomaticallyupdatingthefilewhenthedeveloperhasamorerecentversionintheActiveXICT/CABdirectory.

ExampleThefollowingareexamplesofthenameattributeasitisusedinthepropertyelement:

<xsf:files><xsf:filename="example.cab"><xsf:fileProperties><xsf:propertyname="fileType"type="string"value="ActiveX-CAB"/><xsf:propertyname="timestamp"type="string"value="xyz"/></xsf:fileProperties></xsf:file></xsf:files></xsf:package>

nameAttribute(roleElement)

Specifiesastringthatcanbeusedtoidentifyaparticularrole.

Typexsf:xdRoleName

ParentElements

Element Descriptionrole Definesrole.

Definition

<xsd:attributename="name"type="xsf:xdRoleName"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthenameattributeasitisusedintheroleelement:

nameAttribute(ruleSetElement)

ContainsthenameoftheruleSetelement.

Typexsd:string

ParentElements

Element DescriptionruleSet Containsoneormoreruleelements.

Definition

ExampleThefollowingisanexampleofthenameattributeasitisusedintheruleSetelement:

ShowAll

nameAttribute(sharepointListAdapterElement)

ContainsthenameofthesharepointListAdapterelement;alsousedasthesecondarydatasourcename.

Typexsf:xdTitle

ParentElements

Definition

ExampleThefollowingisanexampleofthenameattributeasitisusedinthesharepointListAdapterelement:

<xsf:sharepointListAdaptername="StatusReportlibrary"siteUrl="http://www.contoso.com/reports/"sharepointGuid="{ABD2E239-0EE7-48F4-B506-C38A1728E195}"infopathGroup="ContosoReportsLibrary"queryAllowed="yes><xsf:fieldsharepointName="File_x0020_Type"infopathName="Type"></xsf:field><xsf:fieldsharepointName="xd__x007b_D00F1DBD_..."infopathName="Title_1"></xsf:field></xsf:sharepointListAdapter>

nameAttribute(signedDataBlockElement)

ContainsthenameofthesignedDataBlockelement.

Typexsf:xdSignedDataBlockName

ParentElements

Definition

<xsd:attributename="name"type="xsf:xdSignedDataBlockName"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthenameattributeasitisusedinthesignedDataBlockelement:

<xsf:documentSignatures><xsf:signedDataBlockname="main"data="my:myfields/my:subtree1|my:myfields/my:subtree2"signatureLocation="my:mifields/sig:signatures/main"mode="countersign"><xsf:message>Byclickingthe"Sign"buttonbelow,Iagreetobeboundtothetermsofthisdocument.</xsf:message></xsf:signedDataBlock></xsf:documentSignatures>

ShowAll

nameAttribute(taskElement)

TheuniquenameofthetaskasspecifiedbytheMicrosoftBiztalkServer2004HWS(HumanWorkflowServices)workflowdesigner.

Typexsf:xdHWSname

ParentElements

Element Descriptiontask TheHWStaskinformationenabledfortheform

Definition

<xsd:attributename="name"type="xsf:xdHWSname"use="required"></xsd:attribute>

RemarksThenameattributeisusedfortheonClickeventofthebuttonintheWorkflowtaskpane.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthetaskelement:

nameAttribute(toolbarElement)

Identifiesthecorrespondingtoolbarwithindifferentviews.

xsf:xdTitle

RemarksThenameattributeisarequiredattributeofthetoolbarelement.

Mustbeuniquewithinagivensolution.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthetoolbarelement:

nameAttribute(userNameElement)

Specifiesthenameofausertobeassignedtoaparticularrole.

Typexsd:string

ParentElements

Element DescriptionuserName Associatesauserwithaparticularrole.

Definition

ExampleThefollowingisanexampleofthenameattributeasitisusedintheuserNameelement:

<xsf:membership><xsf:getUserNameFromDatadataObject="catalog"select="/dfs:myFields/dfs:dataFields/d:UserA"memberOf="B"/><xsf:userNamename="domain\username1"memberOf="A"/><xsf:userNamename="domain\username2"memberOf="B"/><xsf:groupname="domain\username3"memberOf="C"/></xsf:membership></xsf:roles>

nameAttribute(viewElement)

Identifiestheviewforobjectmodelcallswhenswitchingviews,andforspecifyingthedefaultview.

xsf:xdViewName

RemarksThenameattributeisarequiredattributeoftheviewelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedintheviewelement:

ShowAll

nameAttribute(webServiceAdapterElement)

ContainsthenameofthewebServiceAdapterelement.

Typexsf:xdTitle

ParentElements

Element DescriptionwebServiceAdapter DefinesaWebservicedataadapterthatretrieves

datafromaWebserviceforthespecifieddataobject.

Definition

RemarksThenameattributeisanoptionalattributeofthewebServiceAdapterelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthewebServiceAdapterelement:

<xsf:query><xsf:webServiceAdapterwsdlUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx?WSDL"queryAllowed="yes"submitAllowed="no"useDataSet="no"><xsf:operationname="getOrders"soapAction="http://www.contoso.com/getOrders"serviceUrl="http://localhost/infopathwebservicesample/infopathwebservicesample.asmx"><xsf:inputsource="Submit.xml"></xsf:input></xsf:operation></xsf:webServiceAdapter></xsf:query>

ShowAll

nameAttribute(xDocumentClassElement)

Providesaunique,UniformResourceName(URN)–basednamefortheformthattheformdefinition(.xsf)filedefines.

xsd:string

RemarksThenameattributeisanoptionalattributeofthexDocumentClasselement.

Ifthisattributeismissing,theformisnamedfromtheUniformResourceLocator(URL)orformdefinitionfilename,whichcanbeobtainedfromtheprocessinginstructionsoftheform'sunderlyingXMLdocument.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthexDocumentClasselement:

nameAttribute(xmlFileAdapterElement)

ContainsthenameofthexmlFileAdapterelement.

Typexsf:xdTitle

ParentElements

Element DescriptionxmlFileAdapter Definesan.xmlfiledataadapterthatretrievesdata

froman.xmlfileforthespecifieddataobject.

Definition

RemarksThenameattributeisanoptionalattributeofthexmlFileAdapterelement.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthexmlFileAdapterelement:

<xsf:query><xsf:xmlFileAdaptername="CurrencyInfo"fileUrl="currencies.xml"/></xsf:query>

nameAttribute(xmlToEditElement)

UsedinthexmlToEditattributeofthebuttonelementtoassociateactionsoftheassociatededitingcomponenttobuttonsdefinedinmenusandtoolbars.

xsd:NMTOKEN

RemarksThenameattributeisarequiredattributeofthexmlToEditelement.

ThereshouldbenomorethanonexmlToEditelementwiththesamenameinagivenview.

ExampleThefollowingisanexampleofthenameattributeasitisusedinthexmlToEditelement:

ShowAll

nodeAttribute

DefinestheXPathexpressionneededtoextractthevalueofthespecifiedpropertyfromtheform'sunderlyingXMLdocument.

xsd:string

RemarksThenodeattributeisarequiredattributeofthefieldelement.

ExampleThefollowingisanexampleofthenodeattributeasitisusedinthefieldelement:

onAfterSubmitAttribute

Specifieswhethertheformshouldbeclosed,keptopen,orifanewformshouldbecreatedafterasuccessfulsubmission.

xsd:NMTOKEN

RemarksTheonAfterSubmitattributeisanoptionalattributeofthesubmitelement.

Valuesinclude"Close","KeepOpen",and"OpenNew".Thedefaultvalueis"KeepOpen".

Ifthesubmitoperationisnotsuccessful,thentheonAfterSubmitattributeisignoredandtheformiskeptopen.

ExampleThefollowingisanexampleoftheonAfterSubmitattributeasitisusedinthesubmitelement:

orientationAttribute

Specifiestheorientationwhenprintingaview.

xsd:NMTOKEN

RemarksTheorientationattributeisanoptionalattributeoftheprintSettingselement.

Valuesinclude"portrait"and"landscape".

ExampleThefollowingisanexampleoftheorientationattributeasitisusedintheprintSettingselement:

ShowAll

overwriteAllowedAttributeSpecifieswhethertheadaptercanoverwriteanexistingfile.

Typexsf:xdYesNo

ParentElements

submittedtoaMicrosoftWindowsSharePointServicesserveroraWeb-basedDistributedAuthoringandVersioning(WebDAV)server.

Definition

<xsd:attributename="overwriteAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute>

ExampleThefollowingisanexampleoftheoverwriteAllowedattributeasitisusedinthedavAdapterelement:

pageRangeEndAttribute

Specifiesthelastpagetobeprinted.

Typexsd:Integer

ParentElements

Definition

<xsd:attributename="pageRangeEnd"><xsd:simpleType><xsd:restrictionbase="xsd:integer"><xsd:minInclusivevalue="1"/><xsd:maxInclusivevalue="32000"/></xsd:restriction></xsd:simpleType></xsd:attribute>

ExampleThefollowingisanexampleofthepageRangeEndattributeasitisusedintheprintSettingselement:

pageRangeStartAttribute

Specifiesthefirstpagetobeprinted.

Typexsd:Integer

ParentElements

Definition

<xsd:attributename="pageRangeStart"><xsd:simpleType><xsd:restrictionbase="xsd:integer"><xsd:minInclusivevalue="1"/><xsd:maxInclusivevalue="32000"/></xsd:restriction></xsd:simpleType></xsd:attribute>

ExampleThefollowingisanexampleofthepageRangeStartattributeasitisusedintheprintSettingselement:

paperSizeattribute

Specifiesthesizeofthepaper.

Typexsd:String

ParentElements

Definition

<xsd:attributename="paperSize"><xsd:simpleType><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="255"/></xsd:restriction></xsd:simpleType></xsd:attribute>

ExampleThefollowingisanexampleofthepaperSizeattributeasitisusedintheprintSettingselement:

paperSourceAttribute

Specifiesthesourceofthepaper.

Typexsd:String

ParentElements

Definition

<xsd:attributename="paperSource"><xsd:simpleType><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="255"/></xsd:restriction></xsd:simpleType></xsd:attribute>

ExampleThefollowingisanexampleofthepaperSourceattributeasitisusedintheprintSettingselement:

ShowAll

parentAttribute

SpecifiesarelativeXPathexpressionfromthecontainernode.

xsd:string

RemarksTheparentattributeisanoptionalattributeofthechooseFragmentelement.

ReferstotheXMLDocumentObjectModel(DOM)nodeunderwhichthisfragmentshouldbeinserted.Thedefaultvalueis".",whichcorrespondstoinsertingdirectlyunderthecontainerparentnode.

ExampleThefollowingisanexampleoftheparentattributeasitisusedinthechooseFragmentelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample"><xsf:editWithcaption="CD"xd:autogeneration="template"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentparent="CDCollection"followingSiblings="."><CD><Title></Title><Artist></Artist><Tracks><Track></Track><Track></Track></Tracks></CD></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit></xsf:editing>

printerNameAttribute

Specifiestheprintername.

Typexsd:String

ParentElements

Definition

<xsd:attributename="printerName"><xsd:simpleType><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="255"/></xsd:restriction></xsd:simpleType></xsd:attribute>

ExampleThefollowingisanexampleoftheprinterNameattributeasitisusedintheprintSettingselement:

printerSpecificSettingsAttribute

Specifiessettingsforaparticularprinter.

Typexsd:String

ParentElements

Definition

<xsd:attributename="printerSpecificSettings"><xsd:simpleType><xsd:restrictionbase="xsd:string"><xsd:maxLengthvalue="255"/></xsd:restriction></xsd:simpleType></xsd:attribute>

ExampleThefollowingisanexampleoftheprinterSpecificSettingsattributeasitisusedintheprintSettingselement:

<xsf:printSettingsorientation="landscape"header="&Pqsdf"footer="&D"printerName="\\printserver\printer"paperSource="AutoSelect"paperSize="EnvelopeDL"topMargin="0.8"leftMargin="0.8"bottomMargin="0.8"rightMargin="0.8"marginUnitsType="in"copies="2"collate="no"pageRangeStart="1"pageRangeEnd="1"printerSpecificSettings="nameoffilethatcontainsprinter-specificsettings"><xsf:header><font><div>&Pqsdf</div></font></xsf:header><xsf:footer><font><div>&D</div></font></xsf:footer>

</xsf:printSettings>

printViewAttribute

Specifiesthenameofanotherviewtouseforprintingthisview.

xsd:string

RemarksTheprintViewattributeisanoptionalattributeoftheviewelement.

ExampleThefollowingisanexampleoftheprintViewattributeasitisusedintheviewelement:

<xsf:viewsdefault="View"><xsf:viewname="View"caption="View"printView="PrintView"><xsf:mainpanetransform="view1.xsl"></xsf:mainpane>...</xsf:view></xsf:views>

ShowAll

productVersionAttribute

IdentifiestheversionnumberofMicrosoftOfficeInfoPath2003formtemplatewithwhichtheformwascreatedorforwhichaparticularformisintended.

xsd:string

RemarksTheproductVersionattributeisanoptionalattributeofthexDocumentClasselement.

Itsformatis####.####.####(major.minor.build).

ExampleThefollowingisanexampleoftheproductVersionattributeasitisusedinthexDocumentClasselement:

ShowAll

promptToSaveChangesAttribute

Specifieswhethertheuserispromptedtosavechangestotheformbeforetheactioncompletes.

Typexsf:xdYesNo

ParentElements

Element DescriptioncloseDocumentActionDefinesaformcloseaction.

Definition

<xsd:attributename="promptToSaveChanges"type="xsf:xdYesNo"use="required"></xsd:attribute>

RemarksThedefaultvalueis"yes".

ExampleThefollowingisanexampleofthepromptToSaveChangesattributeasitisusedinthecloseDocumentActionelement:

proofingAttribute

Switchestheproofingfeatures,suchasthespellingchecker,onoroff.

xsf:xdYesNo

RemarksTheproofingattributeisanoptionalattributeoftheeditWithelement.

Valuesinclude"yes"and"no".Thedefaultvalueis"yes".

ExampleThefollowingisanexampleoftheproofingattributeasitisusedintheeditWithelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample"><xsf:editWithcaption="CD"proofing="yes"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentparent="CDCollection"><CD><Title></Title><Artist></Artist><Tracks><Track></Track><Track></Track></Tracks></CD></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit></xsf:editing>

ShowAll

publishSaveUrlAttribute

ContainsthelocationofthesavedformtemplateifdifferentfromthevalueofthepublishUrlattribute.

Typexsd:string

ParentElements

Element DescriptionsolutionProperties Containsdesign-timeinformationaboutanInfoPath

Definition

<xsd:attributename="publishSaveUrl"type="xsd:string"use="optional"></xsd:attribute>

ExampleThefollowingisanexampleofthepublishSaveUrlattributeasitisusedinthesolutionPropertieselement:

<xsf:applicationParametersapplication="InfoPathDesignMode"><xsf:solutionPropertiesallowCustomization="no"lastOpenView="view1"scriptLanguage="JScript"automaticallyCreateNodes="no"lastVersionNeedingTransform="1.1.0.10"fullyEditableNamespace="urn:names?pace1:mynames"/publishSaveUrl="C:\DocumentsandSettings\username\Desktop\Template1.xsn"></xsf:applicationParameters>

ShowAll

publishUrlAttribute

Identifieswheretheformwaspublishedandwheretheformtemplateshoulddownloadupdatesfrom.

xsd:string

RemarksThepublishUrlattributeisanoptionalattributeofthexDocumentClasselement.

ThepublishUrlattributeissetautomaticallywhenaformispublishedordeployedthroughtheInfoPathdesignmode.Whenaformisopened,itwillattempttoretrievethelatestupdatesfromthepublishedlocation.

ExampleThefollowingisanexampleofthepublishUrlattributeasitisusedinthexDocumentClasselement:

<xsf:xDocumentClassxmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"name="urn:microsoft-com:myTravelReport"author="AuthorName"description="TravelReportformforenteringtravelreports,issues,expenses,etc."dataFormSolution="yes"solutionVersion="1.0.0.1"productVersion="11.0.5106"solutionFormatVersion="0.9.0.0"publishUrl="http://MyServer/InfoPathTemplates/MyTemplate.xsn">...</xsf:xDocumentClass>

queryAllowedAttribute(adoAdapterElement)

Specifieswhetherdatacanberetrievedfromthedatasourcethroughthequerymethodofthedataadapterobject.

xsf:xdYesNo

RemarksThequeryAllowedattributeisanoptionalattributeoftheadoAdapterelement.

Allowedvaluesare"yes"and"no".Thedefaultvalueis"yes".

ExampleThefollowingisanexampleofthequeryAllowedattributeasitisusedintheadoAdapterelement:

ShowAll

queryAllowedAttribute(davAdapterElement)

Specifieswhethertheadaptercanbeusedforqueryingthedatasource.

Typexsf:xdYesNo

ParentElements

submittedtoaserverthatisrunningMicrosoftWindowsSharepointServicesoraWeb-basedDistributedAuthoringandVersioning(WebDAV)server.

Definition

<xsd:attributename="queryAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksThequeryAllowedattributeisgenerallyomittedforthedavAdapterelement,correspondingtoadefaultvalueof"no".Avalueof"yes"forthisattributecausesanerror.

ExampleThefollowingisanexampleofthequeryAllowedattributeasitisusedinthedavAdapterelement:

<xsf:davAdaptername="SubmitToSharePoint"overwriteAllowed="yes"submitAllowed="yes"queryAllowed="no"><xsf:fileNamevalue="my:myFields/my:fileName"valueType="expression"/><xsf:folderURLvalue="http://contoso/some_doc_lib"/></xsf:davAdapter>

queryAllowedAttribute(emailAdapterElement)

Typexsf:xdYesNo

ParentElements

Element DescriptionemailAdapter ContainstheinformationtosubmitanInfoPathfileasan

attachmenttoane-mailmessage,withaspecifiedsetofrecipients,asubject,andanintroduction.

Definition

RemarksThequeryAllowedattributeisgenerallyomittedfortheemailAdapterelement,correspondingtoadefaultvalueof"no".

ExampleThefollowingisanexampleofthequeryAllowedattributeasitisusedintheemailAdapterelement:

<xsf:emailAdaptername="Submit"submitAllowed="yes"queryAllowed<xsf:tovalue="someone@example.com"valueType="literal"/><xsf:ccvalue="my:ccNames"valueType="expression"/><xsf:bccvalue="someoneelse@example.com"valueType="literal"/><xsf:subjectvalue="Myreport"valueType="literal"/><xsf:introvalue="Seebelow"/><xsf:attachmentFileNamevalue="StatusReport"valueType="literal"/></xsf:emailAdapter>

queryAllowedAttribute(hwsAdapterElement)

Typexsf:xdYesNo

ParentElements

Element DescriptionhwsAdapter DefinestheMicrosoftBiztalk2004HWS(HumanWorkflow

Services)dataadaptertostartorextendanactivityflow,andrespondtoatask.

Definition

RemarksThequeryAllowedattributecanbeomittedfromthehwsAdapterelement,correspondingtoadefaultvalueof"no".

ExampleThefollowingisanexampleofthequeryAllowedattributeasitisusedinthehwsAdapterelement:

<xsf:hwsAdaptername="StartApproval"wsdlUrl="http://www.contoso.com/hwsservice/hwsservice.asmx?WSDL"submitAllowed="yes"><xsf:hwsOperationtype="addActionToNewActivityFlow"typeID="{guid}"serviceUrl="http://www.contoso.com/hwsservice/hwsservice.asmx"><xsf:inputsource="HWSMessage1.xml"><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param1"replaceWith="/my:myFields/my:param1"/><xsf:partFragmentmatch="/ns1:HWSMessage/ActionSection/param2"

queryAllowedAttribute(sharepointListAdapterElement)

Typexsf:xdYesNo

ParentElements

Definition

RemarksThequeryAllowedvalueisalwayssetto"yes"forthesharepointListdapter.

ExampleThefollowingisanexampleofthequeryAllowedattributeasitisusedinthesharepointListAdapterelement:

<xsf:sharepointListAdaptername="StatusReportlibrary"siteUrl="http://www.contoso.com/reports/"sharepointGuid="{ABD2E239-0EE7-48F4-B506-C38A1728E195}"infopathGroup="ContosoReportsLibrary"queryAllowed="yes><xsf:fieldsharepointName="File_x0020_Type"infopathName="Type"></xsf:field><xsf:fieldsharepointName="xd__x007b_D00F1DBD_..."infopathName="Title_1"></xsf:field></xsf:sharepointListAdapter>

queryAllowedAttribute(webServiceAdapterElement)

Specifieswhetherdatacanberetrievedfromthedatasourcethroughthequerymethodofthedataadapterobject.

xsf:xdYesNo

RemarksThequeryAllowedattributeisanoptionalattributeofthewebServiceAdapterelement.

Allowedvaluesare"yes"and"no".Thedefaultvalueis"yes".

ExampleThefollowingisanexampleofthequeryAllowedattributeasitisusedinthewebServiceAdapterelement:

ShowAll

refreshAttribute

Specifieswhentheexpressionwillbeevaluated.

Typexsd:string

ParentElements

Definition

<xsd:attributename="refresh"type="xsd:string"use="required"></xsd:attribute>

RemarksTheexpressionspecifiedbytheexpressionattributeisevaluatedaccordingtotherefreshattributeofthecalculatedFieldelement.Avalueof"onInit"causestheexpressiontobeevaluatedwhenthenodeisinitialized.Avalueof"onChange"causestheexpressiontobeevaluatedwhenoneormoreparametersoftheexpressionchange.

ExampleThefollowingisanexampleoftherefreshattributeasitisusedinthecalculatedFieldelement:

removeAncestorsAttribute

Specifiesthenumberofancestor(parent)elementstoberemovedwhenthelastitemisremoved.

xsd:nonNegativeInteger

RemarksTheremoveAncestorsattributeisanoptionalattributeoftheeditWithelement.

Default=0.Mustbeanon-negativeinteger.

ExampleThefollowingisanexampleoftheremoveAncestorsattributeasitisusedintheeditWithelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample"><xsf:editWithcaption="CD"removeAncestors="0"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentparent="CDCollection"><CD><Title></Title><Artist></Artist><Tracks><Track></Track><Track></Track></Tracks></CD></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit></xsf:editing>

ShowAll

replaceWithAttribute

ContainsanXPathexpressionthatidentifiesthevaluesinthesourcedocumentthatshouldbeusedtoreplacepartsoftheinputSimpleObjectAccessProtocol(SOAP)message.

xsd:string

RemarksThereplaceWithattributeisarequiredattributeofthepartFragmentelement.

ExampleThefollowingisanexampleofthereplaceWithattributeasitisusedinthepartFragmentelement:

requiredAttribute

IdentifieswhetherthisfieldacceptsNullvalues.

xsf:xdYesNo

RemarksTherequiredattributeisanoptionalattributeofthefieldelement.

Valuesinclude"yes"and"no".Thedefaultvalueis"no".

ExampleThefollowingisanexampleoftherequiredattributeasitisusedinthefieldelement:

requireFullTrustAttribute

Allowstheformtorunasafullytrustedformwhenaformtemplateisregisteredorsignedwithacertificate.

xsf:xdYesNo

RemarksTherequireFullTrustattributeisanoptionalattributeofthexDocumentClasselement.

FormsthathavetherequireFullTrustattributesetto"yes"getfulltrustsecurityprivilegesinMicrosoftOfficeInfoPath2003.Allowedattributevaluesare"yes"and"no".Thedefaultvalueis"no".

NoteFullytrustedformsneedtoberegistered,otherwisetheycannotbeopenedinInfoPath.

ExampleThefollowingisanexampleoftherequireFullTrustattributeasitisusedinthexDocumentClasselement:

<xsf:xDocumentClassxmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"name="urn:microsoft-com:myTravelReport"author="AuthorName"description="TravelReportformforenteringtravelreports,issues,expenses,etc."dataFormSolution="yes"solutionVersion="1.0.0.1"productVersion="11.0.5106"solutionFormatVersion="1.0.0.0"requireFullTrust="yes">...</xsf:xDocumentClass>

rightMarginAttribute

Specifiestherightmarginwhenprintingaview.

xsd:string

RemarksTherightMarginattributeisanoptionalattributeoftheprintSettingselement.

TherightMarginattributemustbegreaterthanorequaltozero.

ExampleThefollowingisanexampleoftherightMarginattributeasitisusedintheprintSettingselement:

ShowAll

rootSchemaAttribute

IdentifiesanXMLSchemaasthetop-levelschemaoftheformbeingfilledout.

xsf:xdYesNo

RemarksTherootSchemaattributeisanoptionalattributeofthedocumentSchemaelement.

OnlyoneoftheXMLSchemasdefinedforaformcanbemarkedastherootschema.Allowedvaluesare"yes"and"no".Thedefaultvalueis"no".

ExampleThefollowingisanexampleoftherootSchemaattributeasitisusedinthedocumentSchemaelement:

ruleSetAttribute

ContainsthenameoftheruleSetactionelementtobeinvoked.

Typexsd:string

ParentElements

Element DescriptionruleSetActionDefinestheruleSetactionelementtobeinvoked.

Definition

<xsd:attributename="ruleSet"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheruleSetattributeasitisusedintheruleSetActionelement:

ShowAll

schemaAttribute(dataObjectElement)

ThenameofanXMLSchemafile.

xsd:string

RemarksTheschemaattributeisanoptionalattributeofthedataObjectelement.

MicrosoftOfficeInfoPath2003automaticallypackagestheXMLSchemaforeachsecondarydataobjectaspartoftheformtemplate.Anentryismadeintheformdefinition(.xsf)filefortheXMLSchemafileusingthefileselement,anditisthefilenamethatisreferencedfromtheschemaattributeofthedataObjectelement.

ExampleThefollowingisanexampleoftheschemaattributeasitisusedinthedataObjectelement:

ShowAll

schemaAttribute(importSourceElement)

IdentifiestheXMLSchemafilethatshouldbeusedduringthemergeoperationtovalidatetheformbeingmerged.

xsf:xdFileName

RemarksTheschemaattributeisarequiredattributeoftheimportSourceelement.

Ifthesourcedocumenttobemergedbelongstothespecifiedschema,thespecifiedparametersareusedformegingintothecurrentform.Iftheschemaattributeisnotspecified,a"SchemaXSDnotfound"errorisreturned.

ExampleThefollowingisanexampleoftheschemaattributeasitusedintheimportSourceelement:

scriptLanguageAttribute

IdentifiesthenameofthescriptinglanguageusedtoimplementthebusinesslogicoftheMicrosoftOfficeInfoPath2003form.

xsf:xdScriptLanguage

RemarksThescriptLanguageattributeisanoptionalattributeofthesolutionPropertieselement.

InfoPathsupportsthefollowingvaluesforthisattribute:"JavaScript","JScript",and"VBScript".

ExampleThefollowingisanexampleofthescriptLanguageattributeasitisusedinthesolutionPropertieselement:

ShowAll

selectAttribute

AnXPathqueryexpressionthatreturnsoneormoredatanodesthatcontainusernames.

Typexsd:string

ParentElements

Definition

<xsd:attributename="select"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheselectattributeasitisusedinthegetUserNameFromDataelement:

sendAsStringAttribute

SpecifiesthatthedataissubmittedasastringthroughthewebServiceAdapterdataadapter.

Typexsf:xdYesNo

ParentElements

Definition

<xsd:attributename="sendAsString"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksItmaybenecessarytosetthesendAsStringattributeto"yes"fordigitallysigneddata,becausethissettingpreservesnon-printingcharactersinthedata.

ExampleThefollowingisanexampleofthesendAsStringattributeasitisusedinthepartFragmentelement:

<xsf:partFragmentmatch="/dfs:myFields/dfs:dataFields/s0:IsPrime/s0:inValue"replaceWith=/dfs:myFields/dfs:dataFields/s0:IsPrime"filter="."sendAsString="yes"/>

ShowAll

serviceUrlAttribute

ContainstheWebserviceUniformResourceLocator(URL)towhichtherequestshouldbesent.

xsd:string

RemarksTheserviceUrlattributeisarequiredattributeoftheoperationelement.

ExampleThefollowingisanexampleoftheserviceUrlattributeasitisusedintheoperationelement:

ShowAll

serviceUrlAttribute(hwsOperationElement)

SpecifiestheUniformResourceLocator(URL)oftheMicrosoftBizTalk2004HumanWorkflowServices(HWS)Webservice.

Typexsd:string

ParentElements

actiontoanewactivityflow,addinganactiontoanexistingactivityflow,orrespondingtoatask.

Definition

<xsd:attributename="serviceUrl"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheserviceUrlattributeasitisusedinthehwsOperationelement:

sharepointGuidAttribute

ContainstheGUIDoftheSharePointlist.

Typexsd:string

ParentElements

Element DescriptionsharepointListAdapter Containsthedataadapterinformationneeded

toqueryaSharePointlistorlibrary.

Definition

<xsd:attributename="sharepointGuid"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthesharepointGuidattributeasitisusedinthesharepointListAdapterelement:

ShowAll

sharepointNameAttribute

ContainsthenameofafieldinaSharePointlist.

Typexsd:string

ParentElements

SharePointlistandthecorrespondingnameusedinMicrosoftOfficeInfoPath2003ServicePack1.

Definition

<xsd:attributename="sharepointName"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthesharepointNameattributeasitisusedinthefieldelement:

shortMessageAttribute

Identifiestheshorterrormessagetoreturnincaseofinvaliddata.

xsd:string

RemarksTheshortMessageattributeisarequiredattributeoftheerrorMessageelement.

ThisisdisplayedinaScreenTipinthedefaulterroruserinterface.Formodalerrors,thisattributeisignoredandthedetailedmessageisusedinstead.Maximumlengthoftheerrormessageis127characters.

ExampleThefollowingisanexampleoftheshortMessageattributeasitisusedintheerrorMessageelement:

ShowAll

showErrorOnAttribute

IdentifiesXMLDocumentObjectModel(DOM)nodes(withinthecontextoftheexpressioncontextXMLDOMnode)onwhichtheerrorshouldbedisplayedwhentheformisfilledout.

xsd:string

RemarksTheshowErrorOnattributeisanoptionalattributeoftheerrorConditionelement.

Contains(relativetoexpressioncontextXMLDOMnode)anXPathexpression.Defaultis"."Thisisthesameastheexpressioncontext.

ExampleThefollowingisanexampleoftheshowErrorOnattributeasitisusedintheerrorConditionelement:

showIfAttribute

Specifiestheeditingcontextofthebutton.

xsd:NMTOKEN

RemarksTheshowIfattributeisanoptionalattributeofthebuttonelement.

Allowedvaluesinclude"always","enabled",and"immediate".Defaultvalueis"always".Onlyappliestobuttonsusedwitheditingcomponents.IftheshowIfattributeissetto"enabled",thenthebuttonisvisibleonlyiftheactioniscontextuallyenabled.IftheshowIfattributeissetto"immediate",thenthebuttonisvisibleonlyiftheactioniscontextuallyimmediate.

ExampleThefollowingisanexampleoftheshowIfattributeasitisusedinthebuttonelement:

<xsf:menuAreaname="msoInsertMenu"><xsf:menucaption="&Section"><xsf:buttonaction="xCollection::insert"xmlToEdit="CD_10"caption="CD"showIf="immediate"></xsf:button><xsf:buttonaction="xCollection::insert"xmlToEdit="Track_14"caption="Track"showIf="immediate"></xsf:button><xsf:buttonaction="xOptional::insert"xmlToEdit="Label_16"caption="Label"></xsf:button></xsf:menu></xsf:menuArea>

ShowAll

showMenuItemAttribute

DisplaysamenuitemintheInfoPathViewmenuandaddsacheckmarknexttotheitemwhenitisinuse.

Typexsf:xdYesNo

ParentElements

Element Descriptionview ContainsinformationaboutanInfoPathview.

Definition

<xsd:attributename="showMenuItem"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksTheshowMenuItemattributeisanoptionalattributeoftheviewelement.Thedefaultvalueis"yes".

IftheshowMenuItemattributeforamenuitemintheViewmenuissetto"yes",theitemappearsintheViewmenuandhasacheckmarknexttoitwhenitisinuse.Themenuitemappearswiththecaptionthathasbeendefinedforitandintheorderspecifiedintheformdefinitionfile(.xsf).IftheshowMenuItemattributeisnotpresentorissetto"no",themenuitemdoesnotappearintheViewmenu.UserscanstilladditemstotheViewmenubycustomizingit,butsuchitemswillnotdisplayacheckmarkwhentheyareinuse.

ExampleThefollowingisanexampleoftheshowMenuItemattributeasitisusedintheviewelement:

<xsf:viewname="View1"caption="Firstview"showMenuItem="yes"><xsf:mainpanetransform="view1.xsl"></xsf:mainpane></xsf:view>

showSignatureReminderAttribute

Specifieswhetheradialogboxshouldbedisplayedtoprompttheusertodigitallysignthedocumentbeforesubmittingit.

xsf:xdYesNo

RemarksTheshowSignatureReminderattributeisanoptionalattributeofthesubmitelement.

Valuesinclude"yes"and"no".Thedefaultvalueis"no".Ifsetto"yes"andtheformisnotdigitallysignedwhenausertriestosubmitit,thedialogboxisdisplayed.

ExampleThefollowingisanexampleoftheshowSignatureReminderattributeasitisusedinthesubmitelement:

showStatusDialogAttribute

Specifieswhetherthestatusdialogboxshouldbeshownafterthesubmitoperation.

xsf:xdYesNo

RemarksTheshowStatusDialogattributeisanoptionalattributeofthesubmitelement.

Valuesinclude"yes"and"no".Thedefaultvaluesis"yes".

IftheshowStatusDialogattributeissetto"yes"andnocustommessagesaredefined(usingtheerrorMessageorsuccessMessageelements),thentheMicrosoftOfficeInfoPath2003defaultsubmitmessagesaredisplayed.

ExampleThefollowingisanexampleoftheshowStatusDialogattributeasitisusedinthesubmitelement:

ShowAll

signatureLocationAttribute

ContainsanXPathexpressionthatpointstotheXMLDocumentObjectModel(DOM)nodewithintheform'sunderlyingXMLdocumentthatisusedforstoringthedigitalsignature.

xsd:string

RemarksThesignatureLocationattributeisarequiredattributeofthedocumentSignatureselement.

ExampleThefollowingisanexampleofthesignatureLocationattributeasitisusedinthedocumentSignatureselement:

<xsf:documentSignaturessignatureLocation="/employees/my:signatures1"></xsf:documentSignatures>

ShowAll

signatureLocationAttribute(signedDataBlockElement)

ContainsanXPathexpressionthatpointstotheXMLDocumentObjectModel(DOM)nodeintheform'sunderlyingXMLdocumentthatisusedforstoringthedigitalsignature.

Typexsd:string

ParentElements

Definition

<xsd:attributename="signatureLocation"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthesignatureLocationattributeasitisusedinthesignedDataBlockelement:

ShowAll

siteUrlAttribute

ContainstheUniformResourceLocator(URL)ofaSharePointsite.

Typexsd:string

ParentElements

Definition

<xsd:attributename="siteUrl"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthesiteUrlattributeasitisusedinthesharepointListAdapterelement:

soapActionAttribute

ContainsthevalueoftheSOAPActionattributeintheSimpleObjectAccessProtocol(SOAP)requestmessage.

xsd:string

RemarksThesoapActionattributeisarequiredattributeoftheoperationelement.

ExampleThefollowingisanexampleofthesoapActionattributeasitisusedintheoperationelement:

ShowAll

solutionFormatVersionAttribute

Identifiestheversionnumberthatrepresentstheformatoftheformdefinitionfile(.xsf).

RemarksThesolutionFormatVersionattributeisarequiredattributeofthexDocumentClasselement.

Itsformatis####.####.####.####(major.minor.revision.build).Theversionnumberofthe.xsffileallowsMicrosoftOfficeInfoPath2003todeterminewhetherthecurrentformiscompatiblewiththeproductversioninwhichitisbeingopened.

ExampleThefollowingisanexampleofthesolutionFormatVersionattributeasitisusedinthexDocumentClasselement:

ShowAll

solutionURIAttribute

TheUniformResourceIdentifier(URI)ofthesolutiononwhichthenewformwillbebased.

Typexsd:anyURI

ParentElements

Element DescriptionopenNewDocumentActionDefinesaformcreateaction.

Definition

<xsd:attributename="solutionURI"type="xsd:anyURI"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthesolutionURIattributeasitisusedintheopenNewDocumentActionelement:

solutionVersionAttribute

Identifiestheversionnumberoftheform.

RemarksThesolutionVersionattributeisanoptionalattributeofthexDocumentClasselement.

Itsformatis####.####.####.####(major.minor.revision.build).

ExampleThefollowingisanexampleofthesolutionVersionattributeasitisusedinthexDocumentClasselement:

ShowAll

sourceAttribute

ContainsthenameoftheresourcefileintheformtemplatethatcontainstheXMLSchemafortheinputSimpleObjectAccessProtocol(SOAP)messageoftheselectedoperationoftheWebservice.

xsd:string

RemarksThesourceattributeisarequiredattributeoftheinputelement.

ExampleThefollowingisanexampleofthesourceattributeasitisusedintheinputelement:

ShowAll

srcAttribute

ProvidesarelativeURLwithintheformtemplatetothespecifiedscriptsourcefile.

xsf:xdFileName

RemarksThesrcattributeisarequiredattributeofthescriptelement.

ExampleThefollowingisanexampleofthesrcattributeasitisusedinthescriptelement:

<xsf:scriptslanguage="jscript"><xsf:scriptsrc="myscripts.js"/></xsf:scripts>

submitAllowedAttribute(adoAdapterElement)

Specifieswhetherdatacanbesubmittedtothedatasourcethroughthesubmitmethodofthedataadapterobject.

xsf:xdYesNo

RemarksThesubmitAllowedattributeisanoptionalattributeoftheadoAdapterelement.

ExampleThefollowingisanexampleofthesubmitAllowedattributeasitisusedintheadoAdapterelement:

ShowAll

submitAllowedAttribute(davAdapterElement)

Specifieswhethertheadaptercanbeusedforsubmittingtothedatasource.

Typexsf:xdYesNo

ParentElements

Element DescriptiondavAdapterContainsinformationneededtosubmitInfoPathformstoa

serverrunningMicrosoftWindowsSharePointServicesortoaWeb-basedDistributedAuthoringandVersioning(WebDAV)server.

Definition

<xsd:attributename="submitAllowed"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksThevalueofthesubmitAllowedattributeisalwayssetto"yes"forthedavAdapterelement.

ExampleThefollowingisanexampleofthesubmitAllowedattributeasitisusedinthedavAdapterelement:

<xsf:davAdaptername="SubmitToSharePoint"overwriteAllowed="yes"<xsf:fileNamevalue="my:myFields/my:fileName"valueType="expression"/><xsf:folderURLvalue="http://some_server/some_doc_lib"/></xsf:davAdapter>

submitAllowedAttribute(emailAdapterElement)

Typexsf:xdYesNo

ParentElements

Element DescriptionemailAdapter ContainstheinformationneededtosubmitanInfoPath

formasanattachmenttoane-mailmessage,withaspecifiedsetofrecipients,asubject,andanintroduction.

Definition

RemarksThevalueofthesubmitAllowedattributeisalwayssetto"yes"fortheemailAdapterelement.

ExampleThefollowingisanexampleofthesubmitAllowedattributeasitisusedintheemailAdapterelement:

submitAllowedAttribute(hwsAdapterElement)

Typexsf:xdYesNo

ParentElements

Element DescriptionhwsAdapter DefinestheMicrosoftBizTalk2004HumanWorkflow

Services(HWS)dataadapter,whichcanbeusedtostartorextendanactivityfloworrespondtoatask.

Definition

RemarksThevalueofthesubmitAllowedattributeisalwayssetto"yes"forthehwsAdapterelement.

ExampleThefollowingisanexampleofthesubmitAllowedattributeasitisusedinthehwsAdapterelement:

submitAllowedAttribute(sharepointListAdapterElement)

Typexsf:xdYesNo

ParentElements

Definition

RemarksThesubmitAllowedattributeisomittedforthesharepointListAdapterelement,correspondingtoadefaultvalueof"no".

ExampleThefollowingisanexampleofthesubmitAllowedattributeasitisusedinthesharepointListAdapterelement:

submitAllowedAttribute(webServiceAdapterElement)

Specifieswhetherdatacanbesubmittedtothedatasourcethroughthesubmitmethodofthedataadapterobject.

xsf:xdYesNo

RemarksThesubmitAllowedattributeisanoptionalattributeofthewebServiceAdapterelement.

ExampleThefollowingisanexampleofthesubmitAllowedattributeasitisusedinthewebServiceAdapterelement:

ShowAll

targetAttribute(calculatedFieldElement)

ContainstheXPathlocationwheretheresultoftheexpressionattributewillbestored.

Typexsd:string

ParentElements

Definition

<xsd:attributename="target"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthetargetattributeasitisusedinthecalculatedFieldelement:

ShowAll

targetFieldAttribute

ContainsanXPathexpressionforthetargetnode.

Typexsd:string

ParentElements

Element DescriptionassignmentAction Definesanactiontosetthevalueofafield.

Definition

<xsd:attributename="targetField"type="xsd:string"use="required"></xsd:attribute>

RemarksThetargetFieldattributeidentifiesthenodethatwillreceivethevaluefromtheexpressionattribute.

ExampleThefollowingisanexampleofthetargetFieldattributeasitisusedintheassignmentActionelement:

taskpaneVisibleAttribute

SpecifieswhethertheWorkflowtaskpaneisvisible.

Typexsf:xdYesNo

ParentElements

Element DescriptionhwsWorkflow ContainstheinformationtoenabletheWorkflowtask

paneandtoenableindividualactionsandtasksassociatedwithaMicrosoftBiztalk2004HumanWorkflowServices(HWS)server.

Definition

<xsd:attributename="taskpaneVisible"type="xsf:xdYesNo"></xsd:attribute>

RemarksThedefaultvalueforthetaskpaneVisibleattributeis"yes".ThetaskpaneVisibleattributeisanoptionalattributeofthehwsWorkflowelement.

ExampleThefollowingisanexampleofthetaskpaneVisibleattributeasitisusedinthehwsWorkflowelement:

ShowAll

taskTypeIDAttribute

TheuniqueIDoftheMicrosoftBizTalkServer2004HumanWorkflowServices(HWS)workflowtask.

Typexsd:string

ParentElements

Element Descriptiontask TheHWStaskinformationenabledfortheform.

Definition

<xsd:attributename="taskTypeID"type="xsd:string"use="required"></xsd:attribute>

RemarksThetaskTypeIDattributeusesanamespacetouniquelyidentifyataskbutdoesnotrepresentthecurrentinstanceofthetaskbeingperformed.ThecurrentinstanceofthetaskisstoredintheXMLinstancefile.

ExampleThefollowingisanexampleofthetaskTypeIDattributeasitisusedinthetaskelement:

tooltipAttribute

ProvidestheScreenTiptexttobeusedforthebutton.

xsf:xdTitle

RemarksThetooltipattributeisanoptionalattributeofthebuttonelement.

Thisattributeappliesonlytobuttonsusedonatoolbar.

ExampleThefollowingisanexampleofthetooltipattributeasitisusedinthebuttonelement:

<xsf:toolbarcaption="CDCollectionToolbar"name="CDCollectionToolbar"><xsf:buttonaction="xCollection::insert"xmlToEdit="CD_10"caption="NewCD"showIf="always"tooltip="InsertaCD."></xsf:button>...</xsf:toolbar>

topMarginAttribute

Specifiesthetopmarginwhenprintingaview.

xsd:string

RemarksThetopMarginattributeisanoptionalattributeoftheprintSettingselement.

ThetopMarginattributemustbegreaterthanorequaltozero.

ExampleThefollowingisanexampleofthetopMarginattributeasitisusedintheprintSettingselement:

ShowAll

transformAttribute(importSourceElement)

Identifiesthe.xsltfilethatshouldbeusedduringthemergeoperationwhenthesourceform(theonethatisbeingmergedin)matchestheXMLSchemaspecifiedinthecorrespondingschemaattribute.

xsf:xdFileName

RemarksThetransformattributeisarequiredattributeoftheimportSourceelement.

ExampleThefollowingisanexampleofthetransformattributeasitisusedintheimportSourceelement:

ShowAll

transformAttribute(mainpaneElement)

SpecifiestherelativeURLtotheXSLTransformation(XSLT)thatisusedfortheview.

xsf:xdFileName

RemarksThetransformattributeisarequiredattributeofthemainpaneelement.

ExampleThefollowingisanexampleofthetransformattributeasitisusedinthemainpaneelement:

ShowAll

transformAttribute(useTransformElement)

Specifiesthe.xsltfilenamerelativetotheformtemplate.

xsf:xdFileNamexsf:xdEmptyString

RemarksThetransformattributeisarequiredattributeoftheuseTransformelement.Itsmaximumlengthis64characters.

ExampleThefollowingexampleshowsthetransformattributeasitisusedintheuseTransformelement:

ShowAll

treatBlankValueAsZeroAttribute

Specifieswhetherablankfieldshouldbecalculatedwithavalueofzero.

Typexsf:xdYesNo

ParentElements

Element Descriptioncalculations Containsdefinitionsforcalculationsperformedintheform,

andspecifieshowblankvaluesarehandled.

Definition

<xsd:attributename="treatBlankValueAsZero"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksDefaultis"yes".

ExampleThefollowingisanexampleofthetreatBlankValueAsZeroattributeasitisusedinthecalculationselement:

<xsf:calculations><xsf:calculatedFieldtarget="/my:myFields/my:average"expression="xdMath:Avg(../my:expenses/my:expense/my:amount)"refresh="onChange"/>treatBlankValueAsZero=”yes”/></xsf:calculations>

ShowAll

trustLevelAttribute

Specifiesthetrustlevelofaformtemplate.

Typexsf:xdTrustLevel

ParentElements

Element DescriptionxDocumentClass Therootelementoftheformdefinitionfile(.xsf).

Containsallotherelementsandattributesoftheformdefinitionfile.

Definition

<xsd:attributename="trustLevel"type="xsf:xdTrustLevel"use="optional"></xsd:attribute>

RemarksIfthetrustLevelattributeispresentalongwiththerequireFullTrustattributeintheformdefinitionfile,andtherequireFullTrustattributeissetto"yes",thentherequireFullTrustattributetakesprecedence.Aformtemplatethatisnotpermittedfulltrust(becauseitlackspropercertificate,installation,orregistration)willfailtoloadineditmode,andawarningwillbedisplayed.Iftheformtemplateispermittedfulltrust,itwillloadandrunproperlyinthefulltrustsecurityzone.

Thedefaultvalueis"domain".IfthetrustLevelattributeisnotpresent,thedefaultvalueisalso"domain".

ExampleThefollowingisanexampleofthetrustLevelattributeasitisusedinthexDocumentClasselement:

<xsf:xDocumentClassxmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"name="urn:schemas-microsoft-com:myTravelReport"author="AuthorName"description="TravelReportformforenteringtravelreports,issues,expenses,etc."dataFormSolution="yes"solutionVersion="1.0.0.1"productVersion="11.0.5106"solutionFormatVersion="1.0.0.0">dataFormSolution="yes"requireFullTrust="yes"trustLevel="restricted"trustSetting="manual"publishUrl="http://MyServer/InfoPathTemplates/MyTemplate.xsn">...</xsf:xDocumentClass>

ShowAll

trustSettingAttribute

Specifiesthetrustsettingofaformtemplate.

Typexsf:xdManualAuto

ParentElements

Element DescriptionxDocumentClass Therootelementoftheformdefinitionfile(.xsf).

Containsallotherelementsandattributesoftheformdefinitionfile.

Definition

<xsd:attributename="trustSetting"type="xsf:xdManualAuto"use="optional"></xsd:attribute>

RemarksThedefaultvalueis"manual".IfthetrustSettingattributeisnotpresent,thedefaultvalueisalso"manual".

ExampleThefollowingisanexampleofthetrustSettingattributeasitisusedinthexDocumentClasselement:

<xsf:xDocumentClassxmlns:xsf="http://schemas.microsoft.com/office/infopath/2003/solutionDefinition"name="urn:schemas-microsoft-com:myTravelReport"author="AuthorName"description="TravelReportformforenteringtravelreports,issues,expenses,etc."dataFormSolution="yes"solutionVersion="1.0.0.1"productVersion="11.0.5106"solutionFormatVersion="1.0.0.0">dataFormSolution="yes"requireFullTrust="yes"trustLevel="restricted"trustSetting="manual"publishUrl="http://MyServer/InfoPathTemplates/MyTemplate.xsn">...</xsf:xDocumentClass>

ShowAll

typeAttribute(editWithElement)

SpecifiesthetypeofeditingforthefieldsthatmatchtheXPathexpressionspecifiedbytheitemattributeofthexmlToEditelement.

xsd:enumeration

RemarksThetypeattributeisanoptionalattributeoftheeditWithelement.

ThetypeattributeisusedwiththexFieldeditingcomponent,anditsupportsthefollowingvalues:"plain","plainMultiline","formatted","formattedMultiline",and"rich".Thedefaultvalueis"plain".

NotethatifthematchedXMLDocumentObjectModel(DOM)nodedoesnotsupportthefulleditingservicesspecified,theeffectivetypeisdowngradedappropriately(thismeansdowngradingto"plain").Forexample,anattributenodewillbehaveasplainevenifsettorich.OnlydatathatisinaCDATAsection,orthatcorrespondstoXHTML,cansupportvaluesotherthan"plain".

ExampleThefollowingisanexampleofthetypeattributeasitisusedintheeditWithelement:

<xsf:xmlToEditname="Label_4"item="/CustomUISample/CDCollection/CD/Label"><xsf:editWithtype="rich"autoComplete="no"component="xField"></xsf:editWith></xsf:xmlToEdit>

typeAttribute(errorMessageElement)

Identifiesthetypeoferrormessagetoreturn.

xsd:NMTOKEN

RemarksThetypeattributeisanoptionalattributeoftheerrorMessageelement.

Allowedvaluesare"modeless"and"modal".Defaultvalueis"modeless".

Adialogboxwiththelongmessageisreturnedfor"modal"errors.Whenthedialogboxisclosed,thefieldismarkedwithadashedredbordertoindicatethatthevalueisinvalid.Ausercanreadtheerrormessagebyright-clickingthefield.

For"modeless"errors,nodialogboxisdisplayed.Thefieldismarkedwithadashedredbordertoindicatethatthevalueisinvalid.Ausercanreadtheerrormessagebyright-clickingthefield.

NoteIfthefieldisinvalidasaresultofscriptingcodeorbecauseitwasinvalidtobeginwith,buthasnotbeenedited,thenitwillbemarkedwitharedunderline.

ExampleThefollowingisanexampleofthetypeattributeasitisusedintheerrorMessageelement:

ShowAll

typeAttribute(fieldElement)

IdentifiesthestandardXMLSchemadatatype.

xsd:NMTOKEN

RemarksThetypeattributeisarequiredattributeofthefieldelement.

ExampleThefollowingisanexampleofthetypeattributeasitisusedinthefieldelement:

typeAttribute(hwsOperationElement)

SpecifiestheMicrosoftBizTalkServer2004HumanWorkflowServices(HWS)operationtype.

Typexsd:string

ParentElements

Definition

<xsd:attributename="type"type="xsd:string"use="required"></xsd:attribute>

RemarksTheallowedHWSoperationtypesare:

addActionToNewActivityFlowStartsanewworkflow.

addActionToActivityFlowStartsanewworkflow,orifoneexists,extendstheworkflow.

sendTaskResponseRespondstoatask.

ExampleThefollowingisanexampleofthetypeattributeasitisusedinthehwsOperationelement:

ShowAll

typeAttribute(propertyElement)

Definesthetypeoftheproperty.

xsd:QName

RemarksThetypeattributeisarequiredattributeofthepropertyelement.

AllsimpleXMLSchemadatatypesareallowed.

ExampleThefollowingisanexampleofthetypeattributeasitisusedinthepropertyelement:

ShowAll

typeIDAttribute

Containsthegloballyuniqueidentifier(GUID)fortheMicrosoftBizTalkServer2004HumanWorkflowServices(HWS)operation.

Typexsd:string

ParentElements

Definition

<xsd:attributename="typeID"type="xsd:string"use="required"></xsd:attribute>

RemarksTheGUIDisautomaticallygenerateduponsubmitofthehwsAdapterelement,anditupdatestheprocessinginstructionsoftheXMLinstancefile.

ExampleThefollowingisanexampleofthetypeIDattributeasitisusedinthehwsOperationelement:

ShowAll

uiAttribute(exportToExcelElement)

SetswhethertheusercanexportthecontentsoftheformtoaMicrosoftOfficeExcel2003workbook.

ParentElements

Element DescriptionexportToExcel Specifieswhethertheusercanusetheform'smenus,

toolbars,orkeyboardshortcutstoexporttheformtoanMicrosoftOfficeExcel2003workbook.

Definition

<xsd:attributename="ui"type="xsf:xdEnabledDisabled"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheuiattributeasitisusedintheexportToExcelelement:

<xsf:exportToExcel ui="disabled"/>

ShowAll

uiAttribute(exportToWebElement)

SetswhethertheusercanexportthecontentsoftheformtoaWebpage.

ParentElements

Element DescriptionexportToWeb Specifieswhethertheusercanusetheform'smenus,

toolbars,orkeyboardshortcutstoexporttheformtoaWebpage.

Definition

ExampleThefollowingisanexampleoftheuiattributeasitisusedintheexportToWebelement:

<xsf:exportToWeb ui="disabled"/>

ShowAll

uiAttribute(printElement)

Setswhethertheusercanprinttheform.

ParentElements

Element Descriptionprint Specifieswhethertheusercanusetheform'smenus,toolbars,

orkeyboardshortcutstoprinttheform

Definition

ExampleThefollowingisanexampleoftheuiattributeasitisusedintheprintelement:

<xsf:printui="disabled"/>

ShowAll

uiAttribute(saveElement)

Setswhethertheusercansavetheform.

ParentElements

Element Descriptionsave Specifieswhethertheusercanusetheform'smenus,toolbars,

orkeyboardshortcutstosavetheform.

Definition

ExampleThefollowingisanexampleoftheuiattributeasitisusedinthesaveelement:

<xsf:saveui="disabled"/>

ShowAll

uiAttribute(sendMailElement)

Setswhethertheusercansendtheformasane-mailattachment.

ParentElements

Element DescriptionsendMail Specifieswhethertheusercanusetheform'smenus,

toolbars,orkeyboardshortcutstosendtheformasane-mailattachment.

Definition

ExampleThefollowingisanexampleoftheuiattributeasitisusedinthesendMailelement:

<xsf:sendMailui="disabled"/>

ShowAll

urlAttribute

ContainstheUniformResourceLocator(URL)foraMicrosoftBizTalk2004HumanWorkflowServices(HWS)Webservice.

Typexsd:string

ParentElements

Element Descriptionlocation ThelocationoftheHWSWebservice.

Definition

<xsd:attributename="url"type="xsd:string"use="required"></xsd:attribute>

RemarksTheurlattributeisarequiredattributeofthelocationelement.

ExampleThefollowingisanexampleoftheurlattributeasitisusedinthelocationelement:

useDataSetAttribute

SpecifieswhetheranadapterwillsupportanADO.NETDataSet.

Typexsf:xdYesNo

ParentElements

Element DescriptionwebServiceAdapter DefinesaWebservicedataadapterthatretrieves

datafromaWebserviceorsubmitsdatatoaWebservice.

Definition

<xsd:attributename="useDataSet"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksDefaultis"no".

UseoftheuseDataSetattributerequiresMicrosoftOfficeInfoPath2003ServicePack1.

AnADO.NETDataSetcannotbeusedasaqueryparameterforthewebServiceAdapterelementoranyotherdataadapter.

ExampleThefollowingisanexampleoftheuseDataSetattributeasitisusedinthewebServiceAdapterelement:

<xsf:webServiceAdapterwsdlUrl="http://www.contoso.com/DataSet.asmx?WSDL"queryAllowed="yes"useDataSet="yes">...</xsf:webServiceAdapter>

ShowAll

useFilterAttribute

Indicatestheuserwantsafilterwidget.

Typexsd:simpleType

ParentElements

Element DescriptioneditWith (Optionalelement)Specifiesaninstanceofanediting

component,andprovidesthecorrespondingparameterstodetermineitsexactbehavior.

Definition

<xsd:attributename="useFilter"use="optional"><xsd:simpleType><xsd:restrictionbase="xsd:string"><xsd:enumerationvalue="yes"/><xsd:enumerationvalue="no"/></xsd:restriction></xsd:simpleType></xsd:attribute>

RemarksTheuseFilterattributeisanoptionalattributeoftheeditWithelement.Itsdefaultvalueis"no".Iftheuserselectsthefilterwidgetcheckboxinthepropertydialogofarepeatingsectionorrepeatingtable,andtheuseFilterattributeissetto"yes",thewidgetIconattributeissetto"Filter".TheuseFilterattributeisonlyapplicableforrepeatingsectionsandtables.

ExampleThefollowingisanexampleoftheuseFilterattributeasitisusedintheeditWithelement:

useScriptHandlerAttribute

SpecifieswhethertousetheeventhandlerdefinedfortheOnMergeRequesteventwhenimporting(merging)forms.

Typexsf:xdYesNo

ParentElements

Element DescriptionimportParameters Containsalltheparametersthatdefinehowthe

import(merge)formsfeatureworksfortheform.

Definition

<xsd:attributename="useScriptHandler"type="xsf:xdYesNo"use="optional"></xsd:attribute>

RemarksIfyoucreateaneventhandlerfortheOnMergeRequesteventofaformtemplate,youmustsettheuseScriptHandlerattributeto"yes"beforeitwillrun.

ExampleThefollowingisanexampleoftheuseScriptHandlerattributeasitisusedintheimportParameterselement:

<xsf:importParametersenabled="yes"useScriptHandler="yes"><xsf:importSourcename="MySource"schema="MySchema.xsd"transform="schematransform.xslt"/></xsf:importParameters>

valueAttribute(attachmentFileNameElement)

ContainsthevalueoftheattachmentFileNameelement.

Typexsd:string

ParentElements

Element DescriptionattachmentFileName Containsthefilenameofthefileattachmenttobe

includedwithane-mailmessagewhentheformissubmittedusingtheemailAdapterelement.

Definition

<xsd:attributename="value"type="xsd:string"use="required"></xsd:attribute>

RemarksIfthevalueattributeisanemptystring,thee-mailmessagewillnotincludeafileattachment.

ExampleThefollowingisanexampleofthevalueattributeasitisusedintheattachmentFileNameelement:

<xsf:attachmentFileNamevalue="StatusReport"valueType="literal"/>

valueAttribute(attributeDataElement)

Specifiesthevalueoftheattributetobeinserted.

xsd:string

RemarksThevalueattributeisarequiredattributeoftheattributeDataelement.

ExampleThefollowingisanexampleofthevalueattributeasitisusedintheattributeDataelement:

valueAttribute(bccElement)

Specifiesthevalueofthebccelement,asaliteralstringorasanexpressionbasedonthevalueTypeattribute.

Typexsd:string

ParentElements

Element Descriptionbcc Containstherecipientinformationforthebcclineofane-mail

messagewhentheformissubmittedusingtheemailAdapterelement.

Definition

RemarksMultipleaddressesonthebcclineofane-mailmessagemustbeseparatedbysemicolons.

ExampleThefollowingisanexampleofthevalueattributeasitisusedinthebccelement:

<xsf:bccvalue="someone@example.com"valueType="literal"/>

valueAttribute(ccElement)

Specifiesthevalueoftheccelement,asaliteralstringorasanexpressionbasedonthevalueTypeattribute.

Typexsd:string

ParentElements

Element Descriptioncc Containstherecipientinformationforthecclineofthee-mail

Definition

RemarksMultipleaddressesonthecclineofane-mailmessagemustbeseparatedbysemicolons.

ExampleThefollowingisanexampleofthevalueattributeasitisusedintheccelement:

<xsf:ccvalue="my:ccNames"valueType="expression"/>

ShowAll

valueAttribute(fileNameElement)

SpecifiesthevalueofthefileNameelement,asaliteralstringorasanexpressionbasedonthevalueTypeattribute.

Typexsd:string

ParentElements

Element DescriptionfileName ContainsthenameofthefileasaliteralstringorXPath

expression.

Definition

ExampleThefollowingisanexampleofthevalueattributeasitisusedinthefileNameelement:

ShowAll

valueAttribute(folderURLElement)

SpecifiestheUniformResourceLocator(URL)oftheWeb-basedDistributedAuthoringandVersioning(WebDAV)serverorserverthatisrunningMicrosoftWindowsSharePointServicestowhichthefileissubmitted.

Typexsd:string

ParentElements

Element DescriptionfolderURL ContainstheURLoftheservertowhichthefileissubmitted.

Definition

RemarksTheURLmustbeginwith"http://"or"https://".Othercommonprotocolswillcauseanerror.

ExampleThefollowingisanexampleofthevalueattributeasitisusedinthefolderURLelement:

<folderURLvalue="http://some_server/some_doc_lib"/>

valueAttribute(introElement)

Containsthevalueoftheintroelement.

Typexsd:string

ParentElements

Element Descriptionintro Containstheintroductionforthee-mailmessagewhentheform

issubmittedusingtheemailAdapterelement.

Definition

ExampleThefollowingisanexampleofthevalueattributeasitisusedintheintroelement:

<xsf:introvalue="Seebelow"/>

ShowAll

valueAttribute(propertyElement)

Forsimpleproperties,specifiesavaluefortheproperty.Forcomplexandmulti-valuedproperties,thespecifiedvalueisdefinedasacontainerXMLtreeusinganopencontentmodel.

xsd:string

RemarksThevalueattributeisarequiredattributeofthepropertyelement.The.cabfilesthatareincludedinanInfoPathformpackagearelistedinthepackageandfileselementsofan.xsffile.AfileTypevalueof"ActiveX-CAB"identifiesthatthefileisa.cabfileaddedbythedesignerandindicatesthatthefileshouldbemanagedbytheActiveXsupportfeaturesofthedesigner.

ExampleThefollowingareexamplesofthevalueattributeasitisusedinthepropertyelement:

<xsf:files><xsf:filename="example.cab"><xsf:fileProperties><xsf:propertyname="fileType"type="string"value="ActiveX-CAB"/><xsf:propertyname="timestamp"type="string"value="xyz"/></xsf:fileProperties></xsf:file></xsf:files></xsf:package>

valueAttribute(subjectElement)

Containsthevalueofthesubjectelement,eitherasanexpressionorasaliteralstring.

Typexsd:string

ParentElements

Element Descriptionsubject Containsthesubjectlineofthee-mailmessagewhentheform

Definition

ExampleThefollowingisanexampleofthevalueattributeasitisusedinthesubjectelement:

<xsf:subjectvalue="Myreport"valueType="literal"/>

valueAttribute(toElement)

Specifiesthevalueofthetoelement,asaliteralstringorasanexpressionbasedonthevalueTypeattribute.

Typexsd:string

ParentElements

Element Descriptionto Parentelementthatcontainsthe"to"lineinformationofthe

emailAdapterelement.

Definition

RemarksMultipleaddressesonthe"to"lineofane-mailmessagemustbeseparatedbysemicolons.

ExampleThefollowingisanexampleofthevalueattributeasitisusedinthetoelement:

<xsf:tovalue="someone@example.com"valueType="literal"/>

ShowAll

valueTypeAttribute(attachmentFileNameElement)

SpecifieswhetherthevalueattributeoftheattachmentFileNameelementshouldbeinterpretedasaliteralvalueoranXPathexpressionwhichreturnsavalue.

Typexsf:xdExpressionLiteral

ParentElements

Element DescriptionattachmentFileName Containsthefilenameofthefileattachmenttobe

includedwithane-mailmessagewhentheformissubmittedusingtheemailAdapterelement.

Definition

<xsd:attributename="valueType"type="xsf:xdExpressionLiteral"use="optional"></xsd:attribute>

ExampleThefollowingisanexampleofthevalueTypeattributeasitisusedintheattachmentFileNameelement:

<xsf:attachmentFileNamevalue="StatusReport"valueType="literal"/>

ShowAll

valueTypeAttribute(bccElement)

SpecifieswhetherthevalueattributeofthebccelementshouldbeinterpretedasaliteralvalueorasanXPathexpressionthatreturnsavalue.

ParentElements

Element Descriptionbcc Containstherecipientinformationforthebcclineofane-mail

Definition

ExampleThefollowingisanexampleofthevalueTypeattributeasitisusedinthebccelement:

<xsf:bccvalue="someone@example.com"valueType="literal"/>

ShowAll

valueTypeAttribute(ccElement)

SpecifieswhetherthevalueattributeoftheccelementshouldbeinterpretedasaliteralvalueorasanXPathexpressionthatreturnsavalue.

ParentElements

Element Descriptioncc Specifiesthevalueoftheccelement,asaliteralstringorasan

expressionbasedonthevalueTypeattribute.

Definition

ExampleThefollowingisanexampleofthevalueTypeattributeasitisusedintheccelement:

<xsf:ccvalue="my:ccNames"valueType="expression"/>

ShowAll

valueTypeAttribute(fileNameElement)

SpecifieswhetherthevalueofthefileNameelementshouldbeinterpretedasaliteralvalueorasanXPathexpressionthatreturnsavalue.

ParentElements

Element DescriptionfileName ContainsthenameofthefileasaliteralstringorasanXPath

expression.

Definition

ExampleThefollowingisanexampleofthevalueTypeattributeasitisusedinthefileNameelement:

ShowAll

valueTypeAttribute(subjectElement)

SpecifieswhetherthevalueattributeofthesubjectelementshouldbeinterpretedasaliteralvalueorasanXPathexpressionthatreturnsavalue.

ParentElements

Element Descriptionsubject Containsthesubjectlineofane-mailmessagewhentheform

Definition

ExampleThefollowingisanexampleofthevalueTypeattributeasitisusedinthesubjectelement:

<xsf:subjectvalue="Myreport"valueType="literal"/>

ShowAll

valueTypeAttribute(toElement)

SpecifieswhetherthevalueattributeofthetoelementshouldbeinterpretedasaliteralvalueorasanXPathexpressionthatreturnsavalue.

ParentElements

Element Descriptionto Parentelementthatcontainsthe"to"lineinformationofthe

emailAdapterelement.

Definition

ExampleThefollowingisanexampleofthevalueTypeattributeasitisusedinthetoelement:

<xsf:tovalue="someone@example.com"valueType="literal"/>

ShowAll

versionAttribute

SpecifiestheActiveXcontrolversionnumber.

Typexsd:string

ParentElements

instantiated.

Definition

<xsd:attributename="version"type="xsd:string"use="optional"></xsd:attribute>

RemarksIftheclsidattributeforanActiveXcontrolisincludedintheallowedControlelementinaformdefinitionfile(.xsf),butthecontrolisnotinstalledontheuser'scomputer,thecontrolwillbeinstalledautomaticallyifthecabFileattributeforthecontrolispresentandtheCABfileispresentintheformtemplatefile(.xsn)orinthesamedirectoryastheformdefinitionfile.Ifthecontrolisalreadyinstalledontheuser'scomputerbutisanearlierversionthantheonelistedintheversionattribute,theinstallprocessstillwillinitiateiftheCABfileforthecontrolispresent.IftheCABfileisnotpresentforsomereasonortheinstallationfailsorisstopped,theformwillnotopen.

ExampleThefollowingisanexampleoftheversionattributeasitisusedintheallowedControlelement:

<xsf:permissions><xsf:allowedControlcabFile="{84F32C01-78D8-4B93-8ED4-106DA70224C2}.cab”clsid="{84F32C01-78D8-4B93-8ED4-106DA70224C2}"version=”1,0,0,1”/><xsf:allowedControlclsid="{F08DF954-8592-11D1-B16A-00C0F0283630}"/></xsf:permissions>

ShowAll

viewAttribute

Containsthenameoftheviewthatisswitchedtoasaresultoftheruleelementaction.

Typexsf:xdViewName

ParentElements

Element DescriptionswitchViewAction Definesaviewswitchaction.

Definition

<xsd:attributename="view"type="xsf:xdViewName"use="required"></xsd:attribute>

ExampleThefollowingisanexampleoftheviewattributeasitisusedintheswitchViewActionelement:

viewableAttribute

Identifieswhetherthefieldshouldbeaddedtothedefaultview.

xsf:xdYesNo

RemarksTheviewableattributeisanoptionalattributeofthefieldelement.

Valuesinclude"yes"and"no".Thedefaultvalueis"no".

ExampleThefollowingisanexampleoftheviewableattributeasitisusedinthefieldelement:

ShowAll

viewContextAttribute

SpecifiesastringthatidentifiesanHTMLelementintheview.

xsd:string

RemarksTheviewContextattributeisanoptionalattributeofthexmlToEditelement.

TheviewContextattributenamesanHTMLelementthathasthexd:CtrlIdattribute.Forexample,viewContext="myID"intheformdefinition(.xsf)filecorrespondstoxd:CtrlId="myID"intheXSLT/HTMLcodefortheview.

NoteIfthexd:CtrlIdattributeisnotusedintheXSLT/HTMLcodefortheview,thentheviewContextattributeisignored.

TheviewContextattributecanbeusedtodisambiguatecontrolswhentwoinstancesofthesamecontrolhavethesameXMLcontext(sothattheXMLcontextisidentical).Anexampleisatableofcontentswithchaptertitles,andbelow,thesamechaptersrepeatedwithfullcontent.TwoeditWithelementsforitem="chapter"butdifferentviewcontextscanspecifydistinctbehavior.

ExampleThefollowingisanexampleoftheviewContextattributeasitisusedinthexmlToEditelement:

<xsf:editing><xsf:xmlToEditname="CD_10"item="/CustomUISample/CDCollection/CD"container="/CustomUISample">viewContext="cdID"<xsf:editWithcaption="CD"xd:autogeneration="template"component="xCollection"><xsf:fragmentToInsert><xsf:chooseFragmentparent="CDCollection"><CD><Title></Title><Artist></Artist><Tracks><Track></Track><Track></Track></Tracks></CD></xsf:chooseFragment></xsf:fragmentToInsert></xsf:editWith></xsf:xmlToEdit></xsf:editing>

ShowAll

widgetIconAttribute

Specifieswhetheramodifiediconwillbeshownforfiltereditems.

Typexsd:simpleType

ParentElements

Element DescriptioneditWith (Optionalelement)Specifiesaninstanceofanediting

component,andprovidesthecorrespondingparameterstodetermineitsexactbehavior.

Definition

<xsd:attributename="widgetIcon"use="optional"><xsd:simpleType><xsd:restrictionbase="xsd:string"><xsd:enumerationvalue="standard"/><xsd:enumerationvalue="filter"/></xsd:restriction></xsd:simpleType></xsd:attribute>

RemarksThewidgetIconattributeisanoptionalattributeoftheeditWithelement.Itsdefaultvalueis"standard".

ThepropertiesdialogboxesforrepeatingsectionsandtableshaveaFilterDatabuttonontheDisplaytab.BelowtheFilterDatabuttonisacheckboxthatallowstheusertoselectwhetheramodifiediconwillbeshowntoindicatefiltereditems.Iftheuserappliesafilterandselectsthischeckbox,thewidgetIconattributeintheformdefinitionfile(.xsf)issetto"filter".ThewidgetIconattributeisonlyapplicableforrepeatingsectionsandtables.

ExampleThefollowingisanexampleofthewidgetIconattributeasitisusedintheeditWithelement:

ShowAll

wsdlUrlAttribute

ContainstheUniformResourceLocator(URL)oftheWebServicesDescriptionLanguage(WSDL)filethatdescribestheWebservicespecification.

xsd:string

RemarksThewsdlUrlattributeisarequiredattributeofthewebServiceAdapterelement.

ExampleThefollowingisanexampleofthewsdlUrlattributeasitisusedinthewebServiceAdapterelement:

ShowAll

wsdlUrlAttribute(hwsAdapterElement)

ContainstheUniformResourceLocator(URL)oftheMicrosoftBizTalk2004HumanWorkflowServices(HWS)Webservice.

Typexsd:string

ParentElements

Element DescriptionhwsAdapter DefinestheHWSdataadaptertostartorextendanactivity

floworrespondtoatask.

Definition

<xsd:attributename="wsdlUrl"type="xsd:string"use="required"></xsd:attribute>

ExampleThefollowingisanexampleofthewsdlUrlattributeasitisusedinthehwsAdapterelement:

xmlnsAttribute

Definesthexsfnamespace.

xsd:string

RemarksThexmlnsattributeisarequiredattributeofthexDocumentClasselement,andisthestandardmechanismfordeclaringXMLnamespaces.

ExampleThefollowingisanexampleofthexmlnsattributeasitisusedinthexDocumentClasselement:

xmlToEditAttribute

SpecifiesthenameofanxmlToEditelement,forwhichthebuttonisused.

xsd:NMTOKEN

RemarksThexmlToEditattributeisanoptionalattributeofthebuttonelement,butisrequiredforbuttonsusedwitheditingcomponents.

ExampleThefollowingisanexampleofthexmlToEditattributeasitisusedinthebuttonelement:

XDocumentProperty(SaveEventObject)

Aread-onlypropertythatreturnsareferencetotheXDocumentobjectthatisassociatedwiththeSaveEventobjectinanOnSaveRequestevent.

expressionRequired.ReturnsareferencetoaSaveEventobject.

Microsoft Office InfoPath 2003 Developer's ReferenceSchema.xsd The XML Schema files that are used to...

Documents

Transcript of Microsoft Office InfoPath 2003 Developer's ReferenceSchema.xsd The XML Schema files that are used to...

InfoPath alternatives and the PowerApps potential

Infopath replacement sharepoint alternative

Understanding InfoPath Forms Services

Ms Infopath

SharePoint 2010 - InfoPath, Workflow

InfoPath 2010 Enhanced Integration with SharePoint Server ... · InfoPath forms that take advantage of the powerful ... behavior using InfoPath validation, conditional formatting

InfoPath Foundations Peter Williams, Ibitec AB. Agenda What are Forms? Form Scenarios Fundamentals Enter InfoPath Alternatives Use Forms InfoPath Enterprise.

Print prt3127695056226453950.tif (8 pages) - USCIS...Platform: .Net, Visual Studio 2008, MOSS, SharePoint Services, InfoPath, C#, XML, OOD, ... and a description of the training received

The Future Of Forms (InfoPath)

InfoPath 2010

SPSOrlando - InfoPath 2010 Jumpstarter

Working With Infopath 2007

Rapid Storyboarding with Microsoft InfoPath

InfoPath 2010 - First Look #SPSTCDC

Infopath Help[1]

Introduction to InfoPath 2010

Infopath 2010 Data Connections and Rules

Microsoft Office Overview Open XML Formats, Extensible UI, InfoPath and Forms Services, Workflow and Sharepoint Dave Glover .

Microsoft InfoPath 2010 Product Guide.pdf

Advanced SharePoint 2010 InfoPath Development