Download pdf - ActiveX Properties and Methods for LabVIEWActiveX Properties and Methods for LabVIEW This book describes the LabVIEW properties and methods that third-party software can access through

ActiveXPropertiesandMethodsforLabVIEWThisbookdescribestheLabVIEWpropertiesandmethodsthatthird-partysoftwarecanaccessthroughtheActiveXprotocol.

(Windows)Toviewrelatedtopics,clicktheLocatebutton,shownatleft,onthetoolbaratthetopofthiswindow.TheLabVIEWHelphighlightsthistopicintheContentstabsoyoucannavigatetherelatedtopics.

ApplicationPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheApplicationclass.

ApplicationMethods(ActiveX)InstalledWith:BasePackageAnApplicationobjectexportsmethodsthataffectLabVIEW.

NoteMethodparametersdenotedby[]areoptionalforthatmethod.

RefertotheActiveXEnumerationsformoreinformationabouttheenumerationsusedinvariousmethods.

Method DescriptionBringToFront OnWindowsandMacOS,bringsthe

applicationwindowstothefront.DetailsBrowseDataSocket LaunchestheNationalInstruments

DataSocketBrowserdialogboxtoestablishaconnectiontoaDataSocketitem.Details

CreateLibrary CreatesanewLabVIEWprojectlibrary.DetailsGetVIReference PlacesaVIinmemoryandreturnsthe

IDispatchpointerfortheVI.DetailsGetVIVersion ReturnstheversionofLabVIEWinwhichthe

VIwaslastsaved.LabVIEWdoesnotopentheVIwhenretrievingtheversioninformation.IfyouspecifyapathtoafilethatisnotaVI,LabVIEWreturnserror6559.Details

LibraryGetFileLVVersion ReturnstheversionofLabVIEWinwhichtheLabVIEWprojectlibrarywascreated.Details

MassCompile LoadsandcompilesalltheVIsinadirectory,includinganyVIsinsubdirectories,forthespecifiedapplicationinstance.Details

NewProject Createsanew,emptyLabVIEWproject.YoualsocanusetheLabVIEWProjectExplorerwindowtocreateanewproject.Details

OpenLibrary OpenstheLabVIEWprojectlibrary.DetailsOpenProject LoadsaLabVIEWprojectfromdisk.Ifthe

projectisalreadyinmemory,thismethodreturnsareferencetotheexistingproject.You

canusethisreferencewiththeProjectproperties.InLabVIEW,youalsocanselectFile»OpenProjecttonavigatetoandopenaproject.Details

Quit Quitstheapplication.Details

axprop.chm::/ProjectAX_p.html

BringToFrontMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)OnWindowsandMacOS,bringstheapplicationwindowstothefront.

Syntaxobject.BringToFront()

ReturnValuenone

BrowseDataSocketMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)LaunchestheNationalInstrumentsDataSocketBrowserdialogboxtoestablishaconnectiontoaDataSocketitem.

Syntaxobject.BrowseDataSocket([prompt],[selectedURL])

ParametersName Type Descriptionprompt String SpecifiesthetitleoftheDataSocketBrowser

dialogbox.selectedURL String ReturnstheURLoftheconnectionspecifiedbythe

userintheDataSocketBrowserdialogbox.

ReturnValuenone

CreateLibraryMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)CreatesanewLabVIEWprojectlibrary.

Syntaxobject.CreateLibrary([createPalette])

ParametersName Type DescriptioncreatePalette Boolean Specifieswhetheryouwanttosetadefault

paletteforallVIstheprojectlibraryowns.ThedefaultisFALSE,whichdoesnotsetadefaultpalette.

ReturnValueLibrary*

GetVIReferenceMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)PlacesaVIinmemoryandreturnstheIDispatchpointerfortheVI.

Syntaxobject.GetVIReference(viPath,[password],[resvForCall],[options])

ParametersName Type DescriptionviPath String AbsolutepathtotheVIplacedinmemory.password String IftheVIispassword-protected,youmustenter

thepasswordtomakeanyedits.resvForCall Boolean IfTRUE,theVIissettoanexecutionstatecalled

reserved.YoucannoteditareservedVIbecausetheVIcanbecalledasasubVIatanytimewhileitsparentVIruns.SettingtheVItoreservedatthetimeofthereferencespeedsupcallstotheVI.However,thisstatedoesnotsupportanyoftheeditmodepropertiesormethods.TobringtheVIoutofthereservedexecutionstate,closethisreferenceandopenanewreferencebysettingresvForCalltoFALSE.

IfyouareworkingwithareentrantVI,itisimportanttosetthisparametertoTRUEsothatLabVIEWcancalltheVIefficiently.

options unsignedlong

AbitsetthatspecifieshowtheVIreferenceistreated.optionscanbeacombinationofthefollowingvalues.Thedefaultis0x10.0x01 Recordmodifications.Anasterisk(*)

appearsbytheVItitletoindicatethatchangeshavebeenmadeusingVIServer.TheVImustbeineditmodeforLabVIEWtorecordthemodifications.

0x02 Opentemplatesforediting.Thisoptionopenstheoriginal.vitfile.Ifyoudonotselectthisoption,LabVIEWopensanewinstanceofthetemplateVI.Editsmadetoaninstancedonotaffecttheoriginal.vitfile.Thisoptionhasnoeffectonnon-templatefiles.

0x04 PromptusertosavechangeswhenthisVIreferenceclosesifallthefollowing

conditionsaretrue:ThereferencedVIoritssubVIscontainunsavedchanges.TherearenootheropenreferencestothereferencedVI.ThereferencedVIisabletoleavememory.AVIisabletoleavememory,forexample,ifnootherVIscalltheVI,thefrontpaneloftheVIisclosed,andtheVIisnotamemberofanopenprojectlibrary,andsoon.

0x08 Prepareforreentrantrun.ReservesthetargetVIsoitcannotbeeditedandifthetargetVIisreentrant,allocatesadedicatedparalleldataspaceforthisVIreference.IfthetargetVIisnotreentrant,thismethodreturnsanerror.WhenyoureleasetheVIreference,LabVIEWunreservesthereentranttargetVIanddeallocatesaparalleldataspace.UsethisoptionwiththeRunmethodtorunmultipleinstancesofareentrantVIsimultaneously.IfyoutargetareentrantVIanddonotusethisoption,thismethodreturnsareferencetotheVIwithoutallocatingaparalleldataspacefortheVIreference.Whenyoudonotusethisoption,multiplecallstothismethodforareentrantVIreturnreferencestothesameVIwiththesamedataspace,andthismethoddoesnotclonetheVI.

0x10 PromptusertofindmissingsubVIsofthereferencedVI.

0x20 DonotdisplaytheloadingdialogboxwhensearchingformissingsubVIsofthereferencedVI.

axprop.chm::/Run.html

NoteThisoptiondoesnotaffectwhetherLabVIEWpromptsyoutofindthemissingVIsornot.

ReturnValueVirtualInstrument*

GetVIVersionMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)ReturnstheversionofLabVIEWinwhichtheVIwaslastsaved.LabVIEWdoesnotopentheVIwhenretrievingtheversioninformation.IfyouspecifyapathtoafilethatisnotaVI,LabVIEWreturnserror6559.

Syntaxobject.GetVIVersion(viPath,versNum)

ParametersName Type DescriptionviPath String PathtotheVIwhoseversionyouwanttoget.versNum unsigned

longReturnstheversionnumberoftheVIspecifiedinviPath.

ReturnValueString

LibraryGetFileLVVersionMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)ReturnstheversionofLabVIEWinwhichtheLabVIEWprojectlibrarywascreated.

Syntaxobject.LibraryGetFileLVVersion(libPath,[versNum])

ParametersName Type DescriptionlibPath path Specifiesthepathtothelibrary.versNum Long* Returnstheversionnumber.

ReturnValueString

MassCompileMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)LoadsandcompilesalltheVIsinadirectory,includinganyVIsinsubdirectories,forthespecifiedapplicationinstance.ThismethodissimilartotheMassCompileoptionontheMassCompiledialogbox.

Syntaxobject.MassCompile(directory,[logFile],[appendLog],[viCacheSize],[reloadLVSBs],[UserStopped])

ParametersName Type Descriptiondirectory String Directorywherethemasscompilebegins.logFile String Filepathwheretheresultsofthemasscompile

areplaced.Thedefaultisnologfile.appendLog Boolean Indicateswhetherresultsareappendedtothe

logfile.ThedefaultisFALSE.viCacheSize Long NumberofVIsallowedtobeinmemoryduring

themasscompile.Thedefaultisnone.reloadLVSBs Boolean IfTRUE,ignoresCINsinVIsandtheapplication

searchesforthem.UsethisparameterwhenalargenumberofCINshavebeenrecompiledandneedtobereloaded.ThedefaultisFALSE.

UserStopped

Booleanindicator

Indicateswhethertheuserstoppedthemasscompileoperation.

ReturnValuenone

NewProjectMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)Createsanew,emptyLabVIEWproject.YoualsocanusetheLabVIEWProjectExplorerwindowtocreateanewproject.

Syntaxobject.NewProject()

ReturnValueProject*

OpenLibraryMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)OpenstheLabVIEWprojectlibrary.

Syntaxobject.OpenLibrary(path)

ParametersName Type Descriptionpath String Specifiesthepathtotheprojectlibrarytoopen.

ReturnValueLibrary*

OpenProjectMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)LoadsaLabVIEWprojectfromdisk.Iftheprojectisalreadyinmemory,thismethodreturnsareferencetotheexistingproject.YoucanusethisreferencewiththeProjectproperties.InLabVIEW,youalsocanselectFile»OpenProjecttonavigatetoandopenaproject.


Syntaxobject.OpenProject(path)

ParametersName Type Descriptionpath String Pathtotheproject.

ReturnValueProject*

QuitMethodInstalledWith:BasePackageClass:ApplicationMethods(ActiveX)Quitstheapplication.

Syntaxobject.Quit()

ReturnValue

ApplicationProperties(ActiveX)InstalledWith:BasePackageAnApplicationobjectexportspropertiesthataffectLabVIEW.

NotePropertyparametersdenotedby[]areoptionalforthatpropertyormethod.

RefertotheActiveXEnumerationsformoreinformationabouttheenumerationsusedinvariousproperties.

Property DescriptionAllProjects Returnsanarrayofreferences

toeachLabVIEWprojectinmemory.YoucanusethesereferenceswiththeProjectproperties.Details

AllVIsInMemory ReturnsalistofVIsinmemoryforthecallingVIapplicationinstance.ThispropertyreturnsanerrorifyouuseittoreturnalistofremoteVIs.UsetheExportedVIspropertytoreturnalistofexportedVIs.Thispropertyisreadonly.ThispropertyisavailableonlyinthelocalversionsofLabVIEW.Details

AppKind IndicatestheLabVIEWinstancetheVIisrunningin,includinginvalidapplicationtypes.Details

ApplicationDirectory Absolutepathtothedirectorywheretheapplicationislocated.Thispropertyisreadonly.Details

AppName Filenameoftheapplication.Thispropertyisreadonly.Details

AppTargetCPU IndicatesthetargetCPUofan


axprop.chm::/ExportedVIs.html

application.Thispropertyisreadonly.Details

AppTargetOS Indicatestheoperatingsystemforwhichtheapplicationwasbuilt.Thispropertyisreadonly.Details

AutomaticClose Specifieswhethertheapplicationcloseswhenallthereferencestoitarereleased.ThedefaultisTRUE.Details

CmdArgs Returnsanarrayofuser-definedcommand-lineargumentspassedwhenLabVIEWlaunched.Details

DefaultDataLocation PathtotheLabVIEWDatadirectory.Details

ExportedVIs ReturnsalistofexportedVIsinmemory.Thispropertyisreadonly.Details

Language IndicatesthelanguageoftheLabVIEWenvironmentorstand-aloneapplicationasastringaccordingtoISO639.Valuesincludeen,de,fr,ja,ko,andzh-cn.Details

OSName Nameoftheoperatingsystemwheretheapplicationisactuallyrunning.ThisstringvalueisthesameasAppTargetOS,exceptamongversionsofWindows—specifically,AppTargetOShasoneenumerationonWindows2000/XPwhileOSNamereturnstheexactversionofWindowsyourapplicationisrunningon.Thispropertyisreadonly.Details

axprop.chm::/AppTargetOS.html

OSVersion Versionnumberoftheactualoperatingsystem.Thispropertyisreadonly.Details

PrintDefaultPrinter GetsorsetsthenameofthedefaultprinterinLabVIEW.Details

PrintersAvailable Returnsanalphabetizedarrayofprinternamesavailableonthecomputer.Details

PrintingColorDepth IfTRUE,LabVIEWsendscolor/grayscaleoutputtotheprinter.IfFALSE,LabVIEWsendsmonochromeoutputtotheprinter.Details

PrintMethod GetsorsetshowLabVIEWprints.Details

PrintSetupCustomConnector SpecifieswhethertoprinttheconnectorpaneandiconofVIswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomControlDesc SpecifieswhethertoprintdescriptionsoffrontpanelcontrolswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomControls SpecifieswhethertoprintLabVIEWfrontpanelcontrolinformationwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Thispropertydoesnotaffecttheimageofthefrontpanel,justthelistofcontrolsandindicatorsin

axprop.chm::/VI_Class_Method.html



thegenerateddocumentation.Details

PrintSetupCustomControlTypes SpecifieswhethertoprintdatatypeinformationforLabVIEWfrontpanelcontrolswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomDescription SpecifieswhethertoprintVIdescriptionswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomDiagram SpecifieswhethertoprintLabVIEWblockdiagramswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomDiagramHidden SpecifieswhethertoprintthehiddenframesinLabVIEWCaseandStackedSequencestructuresthatmightbepresentontheblockdiagramwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomDiagramRepeat SpecifieswhethertoprintvisiblesubdiagramsofeachCase,Event,andStackedSequencestructureinsequencewiththenon-visiblesubdiagramswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Ifyouprintthevisibleframesinsequence,thoseframeswillprinttwice.Details






PrintSetupCustomExpressVIConfigInfo SpecifieswhethertoprinttheconfigurationinformationforanyLabVIEWExpressVIsontheblockdiagramwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomHierarchy SpecifieswhethertoprintthehierarchyoftheVIinmemorywhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomHistory SpecifieswhethertoprinttheVIrevisionhistoryinformationwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomLabel Specifieswhethertoprintthelabeland/orcaptionforeachcontrolwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomPanel SpecifieswhethertoprinttheLabVIEWfrontpanelwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details

PrintSetupCustomPanelBorder SpecifieswhethertoprinttheLabVIEWfrontpanelwithaborderwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Details







PrintSetupCustomSubVIs SpecifieswhethertoprintalistoftheLabVIEWsubVIsandExpressVIsincludingtheicon,name,andpathwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.IfapolymorphicVIisasubVI,LabVIEWprintstheinstanceusedinthetop-levelVIincludingtheicon,name,andpath.Ifthetop-levelVIispolymorphic,LabVIEWprintsalistofalltheinstancesofthepolymorphicVIincludingtheicon,name,andpathofeachinstance.Details

PrintSetupFileWrapText Maximumnumberofcharactersonasinglelineinafile.AffectsthePrintVIToHTML,PrintVIToRTF,andPrintVIToTextmethods.Setthispropertyto0toprintallthecharactersononelinesothetextdoesnotwrap.Details

PrintSetupJPEGQuality Percentagevaluefrom0to100specifyingthelevelofqualityyouwantfortheJPEGgraphicinVIsprintedeitherinteractivelyorwiththePrintVIToHTMLmethod.Thescalebalancesimagequalityandfilesize.Avalueinthe75-95rangeproducesacompressedfilewithahigh-qualityimage,andavaluebelow50producesasmallerfilesizewithalow-qualityimage.Thedefaultis80.Details

PrintSetupPNGCompressLevel Numberbetween–1and9that


axprop.chm::/PrintVIToHTML.html

axprop.chm::/PrintVIToRTF.html

axprop.chm::/PrintVIToText.html


specifiesthelevelofcompressionyouwantforthePNGfileforgraphicsinVIsprintedeitherinteractivelyorwiththePrintVIToHTMLmethod.Thequalityofthegraphicisnotaffectedbythecompression,butthegraphicfilesizeandspeedofcompressionareaffectedbythisvalue.Validvaluesrangefrom–1to9andbalancefilecompressionwithspeed.0designatesnocompression.1designatesthebestspeedwithsomecompression.9designatesthebestcompression,butslowerspeed.–1(thedefaultvalue)designatesthebestcombinationofgoodcompressionandspeed.Details

RTHostConnected Ifyouarenottargetedtoareal-time(RT)platform,thispropertyisalwaysTRUE.IfyouaretargetedtoanRT-platformandthehostisconnected,thispropertyisTRUE.WhenthispropertyisFALSE,thehostisnotconnected,requiringthattheRTModuleapplicationmustbeabletohandlealloperationsindependentofthehost.Usethispropertytodeterminewhenitissafetodisplayadialogboxthatrequiresuserinteraction.Details

SaveVersions AnarrayoftheLabVIEWversionstowhichthisversionof


LabVIEWcansave.Thearrayisinreversechronologicalorder,withtheelementatpositionzerointhearraybeingthecurrentversionofLabVIEW.EachelementofthearrayisavalidversiontopasstoVIserverfunctionswhichsavetopreviousversions.Details

ShowFPTipStrips Writingtheproperty:SettingthispropertytoTRUEenablesthedisplayoftipstripsonLabVIEWfrontpanelcontrols.SettingthepropertytoFALSEpreventsthemfrombeingdisplayed.Readingtheproperty:Specifieswhethertipstripsdisplaywhenidlingovercontrolsonthefrontpanel.Details

UserName Usernameusedtoopentheapplication.Thispropertyisreadonly.Details

Version Versionnumberoftheapplication.Thispropertyisreadonly.Details

VIServerPort GetsorsetstheLabVIEWVIserverport.LabVIEWreturnsanerrorifyouattempttoaccessthispropertyonaremoteapplication.Details

AllProjectsPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)ReturnsanarrayofreferencestoeachLabVIEWprojectinmemory.YoucanusethesereferenceswiththeProjectproperties.


Syntaxobject.AllProjects

DataTypeArrayofprojects

AllVIsInMemoryPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)ReturnsalistofVIsinmemoryforthecallingVIapplicationinstance.ThispropertyreturnsanerrorifyouuseittoreturnalistofremoteVIs.UsetheExportedVIspropertytoreturnalistofexportedVIs.Thispropertyisreadonly.ThispropertyisavailableonlyinthelocalversionsofLabVIEW.

NoteIfyouhavemultipleapplicationinstancesopensimultaneously,besuretowireanapplicationreferencetothereferenceinput.Forexample,LabVIEWopensanewapplicationinstanceeachtimeyoucreateaLabVIEWprojectoratargetforaLabVIEWproject.

axprop.chm::/ExportedVIs.html

Syntaxobject.AllVIsInMemory

DataTypeArrayofstrings

AppKindPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)IndicatestheLabVIEWinstancetheVIisrunningin,includinginvalidapplicationtypes.

1. DevelopmentSystem,includingtheBasePackage,FullDevelopmentSystem,orProfessionalDevelopmentSystem

2. Run-TimeSystem3. StudentEdition4. EmbeddedLabVIEW,includingLabVIEWReal-Time5. Evaluation6. Custom

Syntaxobject.AppKind

DataTypeAppKindEnum

ApplicationDirectoryPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Absolutepathtothedirectorywheretheapplicationislocated.Thispropertyisreadonly.

Syntaxobject.ApplicationDirectory

DataTypeString

AppNamePropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Filenameoftheapplication.Thispropertyisreadonly.

Syntaxobject.AppName

DataTypeString

AppTargetCPUPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)IndicatesthetargetCPUofanapplication.Thispropertyisreadonly.

Syntaxobject.AppTargetCPU

DataTypeAppTargCPUEnum

AppTargetOSPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Indicatestheoperatingsystemforwhichtheapplicationwasbuilt.Thispropertyisreadonly.

Syntaxobject.AppTargetOS

DataTypeAppTargOSEnum

AutomaticClosePropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Specifieswhethertheapplicationcloseswhenallthereferencestoitarereleased.ThedefaultisTRUE.

Syntaxobject.AutomaticClose

DataTypeBoolean

CmdArgsPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Returnsanarrayofuser-definedcommand-lineargumentspassedwhenLabVIEWlaunched.User-definedargumentsstartaftertwohyphens(--)surroundedbyspacesinthecommandline.Thefirststringinthearrayisthenameoftheexecutablelaunched.ThispropertydoesnotreturnthenameoftheVIlaunchedortheLLBthatcontainstheVI.Ifauser-definedcommand-lineargumentcontainsdoublequotationmarks("),thispropertyreturnstheargumentwithoutthequotationmarks.Ifyouusethispropertyinastand-aloneapplication,youcanpassallargumentsasuser-definedargumentssoyoudonotneedtoenterthetwohyphensbeforeuser-definedargumentsinthecommandline.ThispropertyissimilartothePassallcommandlineargumentstoapplicationoptionontheAdvancedpageoftheLabVIEWApplicationPropertiesdialogbox.

Syntaxobject.CmdArgs


DefaultDataLocationPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)PathtotheLabVIEWDatadirectory.YoucanusethisdirectorytostorethedatafilesLabVIEWgenerates,suchas.lvmor.txtfiles.WhenyouinstallLabVIEW,theinstallercreatesaLabVIEWDatasubdirectoryinthedefaultfiledirectoryfortheoperatingsystemtohelpyouorganizeandlocatethedatafilesLabVIEWgenerates.

Syntaxobject.DefaultDataLocation

DataTypeString

ExportedVIsPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)ReturnsalistofexportedVIsinmemory.Thispropertyisreadonly.

Syntaxobject.ExportedVIs


LanguagePropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)IndicatesthelanguageoftheLabVIEWenvironmentorstand-aloneapplicationasastringaccordingtoISO639.Valuesincludeen,de,fr,ja,ko,andzh-cn.

Syntaxobject.Language

DataTypeString

OSNamePropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Nameoftheoperatingsystemwheretheapplicationisactuallyrunning.ThisstringvalueisthesameasAppTargetOS,exceptamongversionsofWindows—specifically,AppTargetOShasoneenumerationonWindows2000/XPwhileOSNamereturnstheexactversionofWindowsyourapplicationisrunningon.Thispropertyisreadonly.

axprop.chm::/AppTargetOS.html

Syntaxobject.OSName

DataTypestring

OSVersionPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Versionnumberoftheactualoperatingsystem.Thispropertyisreadonly.

Syntaxobject.OSVersion

DataTypestring

PrintDefaultPrinterPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)GetsorsetsthenameofthedefaultprinterinLabVIEW.Tosetthedefaultprinter,enterthefullpathtotheprinter,suchas\\myprinter\ab01.

Syntaxobject.PrintDefaultPrinter

DataTypeString

PrintersAvailablePropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Returnsanalphabetizedarrayofprinternamesavailableonthecomputer.

Syntaxobject.PrintersAvailable


PrintingColorDepthPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)IfTRUE,LabVIEWsendscolor/grayscaleoutputtotheprinter.IfFALSE,LabVIEWsendsmonochromeoutputtotheprinter.

Syntaxobject.PrintingColorDepth

DataTypeBoolean

PrintMethodPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)GetsorsetshowLabVIEWprints.

Syntaxobject.PrintMethod

DataTypePrintMethodsEnum

PrintSetupCustomConnectorPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprinttheconnectorpaneandiconofVIswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomConnector

DataTypeBoolean

PrintSetupCustomControlDescPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintdescriptionsoffrontpanelcontrolswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomControlDesc

DataTypeBoolean

PrintSetupCustomControlsPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintLabVIEWfrontpanelcontrolinformationwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Thispropertydoesnotaffecttheimageofthefrontpanel,justthelistofcontrolsandindicatorsinthegenerateddocumentation.


Syntaxobject.PrintSetupCustomControls

DataTypeBoolean

PrintSetupCustomControlTypesPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintdatatypeinformationforLabVIEWfrontpanelcontrolswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomControlTypes

DataTypeBoolean

PrintSetupCustomDescriptionPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintVIdescriptionswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomDescription

DataTypeBoolean

PrintSetupCustomDiagramPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintLabVIEWblockdiagramswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomDiagram

DataTypeBoolean

PrintSetupCustomDiagramHiddenPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintthehiddenframesinLabVIEWCaseandStackedSequencestructuresthatmightbepresentontheblockdiagramwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomDiagramHidden

DataTypeBoolean

PrintSetupCustomDiagramRepeatPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintvisiblesubdiagramsofeachCase,Event,andStackedSequencestructureinsequencewiththenon-visiblesubdiagramswhenusingthecustomformatwithoneoftheprintdocumentationVImethods.Ifyouprintthevisibleframesinsequence,thoseframeswillprinttwice.


Syntaxobject.PrintSetupCustomDiagramRepeat

DataTypeBoolean

PrintSetupCustomExpressVIConfigInfoPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprinttheconfigurationinformationforanyLabVIEWExpressVIsontheblockdiagramwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomExpressVIConfigInfo

DataTypeBoolean

PrintSetupCustomHierarchyPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintthehierarchyoftheVIinmemorywhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomHierarchy

DataTypeBoolean

PrintSetupCustomHistoryPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprinttheVIrevisionhistoryinformationwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomHistory

DataTypeBoolean

PrintSetupCustomLabelPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Specifieswhethertoprintthelabeland/orcaptionforeachcontrolwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomLabel

DataTypePrintSetupCustomLabelEnum

PrintSetupCustomPanelPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprinttheLabVIEWfrontpanelwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomPanel

DataTypeBoolean

PrintSetupCustomPanelBorderPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprinttheLabVIEWfrontpanelwithaborderwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.


Syntaxobject.PrintSetupCustomPanelBorder

DataTypeBoolean

PrintSetupCustomSubVIsPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)SpecifieswhethertoprintalistoftheLabVIEWsubVIsandExpressVIsincludingtheicon,name,andpathwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.IfapolymorphicVIisasubVI,LabVIEWprintstheinstanceusedinthetop-levelVIincludingtheicon,name,andpath.Ifthetop-levelVIispolymorphic,LabVIEWprintsalistofalltheinstancesofthepolymorphicVIincludingtheicon,name,andpathofeachinstance.


Syntaxobject.PrintSetupCustomSubVIs

DataTypeBoolean

PrintSetupFileWrapTextPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Maximumnumberofcharactersonasinglelineinafile.AffectsthePrintVIToHTML,PrintVIToRTF,andPrintVIToTextmethods.Setthispropertyto0toprintallthecharactersononelinesothetextdoesnotwrap.


axprop.chm::/PrintVIToRTF.html

axprop.chm::/PrintVIToText.html

Syntaxobject.PrintSetupFileWrapText

DataTypelong

PrintSetupJPEGQualityPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Percentagevaluefrom0to100specifyingthelevelofqualityyouwantfortheJPEGgraphicinVIsprintedeitherinteractivelyorwiththePrintVIToHTMLmethod.Thescalebalancesimagequalityandfilesize.Avalueinthe75-95rangeproducesacompressedfilewithahigh-qualityimage,andavaluebelow50producesasmallerfilesizewithalow-qualityimage.Thedefaultis80.


Syntaxobject.PrintSetupJPEGQuality

DataTypelong

PrintSetupPNGCompressLevelPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Numberbetween–1and9thatspecifiesthelevelofcompressionyouwantforthePNGfileforgraphicsinVIsprintedeitherinteractivelyorwiththePrintVIToHTMLmethod.Thequalityofthegraphicisnotaffectedbythecompression,butthegraphicfilesizeandspeedofcompressionareaffectedbythisvalue.Validvaluesrangefrom–1to9andbalancefilecompressionwithspeed.0designatesnocompression.1designatesthebestspeedwithsomecompression.9designatesthebestcompression,butslowerspeed.–1(thedefaultvalue)designatesthebestcombinationofgoodcompressionandspeed.


Syntaxobject.PrintSetupPNGCompressLevel

DataTypelong

RTHostConnectedPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Ifyouarenottargetedtoareal-time(RT)platform,thispropertyisalwaysTRUE.IfyouaretargetedtoanRT-platformandthehostisconnected,thispropertyisTRUE.WhenthispropertyisFALSE,thehostisnotconnected,requiringthattheRTModuleapplicationmustbeabletohandlealloperationsindependentofthehost.Usethispropertytodeterminewhenitissafetodisplayadialogboxthatrequiresuserinteraction.

Syntaxobject.RTHostConnected

DataTypeBoolean

SaveVersionsPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)AnarrayoftheLabVIEWversionstowhichthisversionofLabVIEWcansave.Thearrayisinreversechronologicalorder,withtheelementatpositionzerointhearraybeingthecurrentversionofLabVIEW.EachelementofthearrayisavalidversiontopasstoVIserverfunctionswhichsavetopreviousversions.

Syntaxobject.SaveVersions

DataTypevariant

ShowFPTipStripsPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Writingtheproperty:SettingthispropertytoTRUEenablesthedisplayoftipstripsonLabVIEWfrontpanelcontrols.SettingthepropertytoFALSEpreventsthemfrombeingdisplayed.Readingtheproperty:Specifieswhethertipstripsdisplaywhenidlingovercontrolsonthefrontpanel.

Syntaxobject.ShowFPTipStrips

DataTypeBoolean

UserNamePropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Usernameusedtoopentheapplication.Thispropertyisreadonly.

Syntaxobject.UserName

DataTypestring

VersionPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)Versionnumberoftheapplication.Thispropertyisreadonly.

Syntaxobject.Version

DataTypestring

VIServerPortPropertyInstalledWith:BasePackageClass:ApplicationProperties(ActiveX)GetsorsetstheLabVIEWVIserverport.LabVIEWreturnsanerrorifyouattempttoaccessthispropertyonaremoteapplication.

Syntaxobject.VIServerPort

DataTypeunsignedlong

ActiveXEnumerationsThefollowingenumerationsareusedinthevariouspropertiesandmethods.AppKindEnumAppTargCPUEnumAppTargOSEnumExecStateEnumFPRunTimePosEnumFPStateEnumHTMLImageFormatEnumLibraryItemScopeEnumPageOrientationEnumPrintFormatEnumPrintMarginsEnumPrintMethodsEnumVIExecSysEnumVIFPBehaviorEnumVILockStateEnumVIPriorityEnumVITypeEnum

AppKindEnumIndicatesthetypeofapplication.

Name Value DescriptioneInvalidAppKind 0 InvalidapplicationkindeDevSysKind 1 LabVIEWDevelopmentSystem,includingthe

BasePackage,FullDevelopmentSystem,orProfessionalDevelopmentSystem

eRunTimeSysKind 2 Run-TimeSystemeStudEdKind 3 LabVIEWStudentEditioneEmbeddedKind 4 EmbeddedSystem,includingLabVIEWReal-

TimeeEvaluation 5 Evaluationversion

AppTargCPUEnumIndicatesthecentralprocessingunit(CPU)ofthemachineonwhichtheapplicationisrunning.

Name Value DescriptioneInvalidTargCPU 0 InvalidtargetCPUeMotorola68kCPU 1 Motorola68KePowerPCCPU 2 VxWorksPowerPCeIntelx86CPU 3 Intelx86eSPARCCPU 4 SPARCePARISCCPU 5 PA-RISCeMIPSCPU 6 MIPSeAlphaCPU 7 Alpha

AppTargOSEnumIndicatesthetypeofoperatingsystem(OS)onwhichtheapplicationisrunning.MacOSreferstoMacOSversions8and9.CarbonreferstoMacOSX.

Name Value DescriptioneInvalidTargOS 0 InvalidTargetOSeMacOS 1 MacOSeWin31OS 2 Windows3.1eWin95NTOS 3 Windows95/NTeSolaris1OS 4 Solaris1eSolaris2OS 5 Solaris2eHPUXOS 6 HP-UXePowerMaxOS 7 PowerMaxeLinuxOS 8 LinuxeIrixOS 9 IrixeRhapsodyOS 10 RhapsodyeBeOS 11 BeOSeAIXOS 12 AIXeOSF1OS 13 OSF1eVxWorksOS 14 VxWorksePharlapOS 15 PharLapeCarbonOS 16 CarboneRTXOS 17 RTXeWin64OS 18 Windowsx64eLinux64OS 19 Linuxx64

ExecStateEnumIndicatestheexecutionstateofaVI.

Name Value DescriptioneBad 0 VIhaserrors;itcannotrun.eIdle 1 VIisnotrunning,buttheVIisinmemory.eRunTopLevel 2 VIisrunningasatop-levelVI.eRunning 3 VIisrunningasasubVI.

FPRunTimePosEnumIndicatestherun-timeLabVIEWfrontpanelposition.

Name Value DescriptioneRTPUnchanged 0 UnchangedeRTPCentered 1 CenteredeRTPMaximized 2 MaximizedeRTPMinimized 3 MinimizedeRTPCustom 4 Custom

FPStateEnumIndicateshowLabVIEWdisplaysthefrontpanelwindow.

Name Value DescriptionInvalid 0 Ifyoureadthispropertyandanerroroccurs,the

propertyreturnsthisvalue.Ifyousetthepropertytothisvalue,thepropertyreturnsanerror.

Standard 1 Thefrontpanelwindowisopenbutisnotminimized,maximized,orhidden.

Closed 2 Thefrontpanelwindowisnotopen.Ifyousetthepropertytothisvalue,thepropertyreturnsanerror.

Hidden 3 ThefrontpanelwindowisfloatingbutisnotvisiblebecauseLabVIEWisnottheactiveapplication.Ifyousetthepropertytothisvalueandcloseallreferencestothefrontpanel,thewindowremainsopenbuthidden.BecausetheVIisopen,theGettingStartedwindowdoesnotappear.Tosolvethisproblem,opentheVIfromtheoperatingsystem.Forexample,double-clicktheVIinWindowsExplorertoopentheVI.

Minimized 4 Thefrontpanelwindowisminimized.Maximized 5 Thefrontpanelwindowismaximized.

HTMLImageFormatEnumIndicatestheHTMLimageformattouseforprintingtoanHTMLfile.

Name Value DescriptionePNG 0 PNGformateJPEG 1 JPEGformateGIF 2 GIFformat

LibraryItemScopeEnumIndicatestheLibraryItemscope.

Name Value DescriptioneLibScopeInvalid 0 InvalidScopeeLibScopePublic 1 PubliceLibScopePrivate 2 PrivateeProtected 3 Protected

PrintFormatEnumIndicatestheimageformattouseforprinting.

Name Value DescriptioneCustom 0 UsetheApplicationpropertiestospecifytheformat.eStandard 1 PrintstheVIdescription,iconandconnectorpane,

frontpanel,andblockdiagram.eUsingPanel 2 PrintstheVIdescription,frontpanel,andcontrols

andindicators,includingdatatypes,names,anddescriptions.LabVIEWprintsthecontrolsandindicatorsintabbingorder.

eUsingSubVI 3 PrintstheVIdescription,iconandconnectorpane,andconnectedcontrolsandindicators,includingdatatypes,names,anddescriptions.LabVIEWprintsthecontrolsandindicatorsintabbingorder.

eComplete 4 PrintstheVIdescription;iconandconnectorpane;frontpanel;controlsandindicators,includingdatatypes,names,anddescriptions;blockdiagram;alistofsubVIs,includingicons,names,andpaths;revisionhistoryinformation;andtheVIhierarchy.

PrintMarginsEnumArrayofvariantsthatincludethefollowingelements:

Element Type Descriptionelement1 (float) topelement2 (float) leftelement3 (float) bottomelement4 (float) rightelement5 (byte) measurementsystem(0=Inches,1=cm)

PrintSetupCustomLabelEnumIndicateswhethertoprintthelabeland/orcaptionforeachcontrolwhenusingthecustomformatwithoneoftheprintdocumentationVImethods.

Name Value DescriptionLabel 0 Printsonlythelabelofthefrontpanelcontrol.Caption 1 Printsonlythecaptionofthefrontpanelcontrol.Caption[Label] 2 Printsthecaptionandthelabelinsquarebrackets

ofthefrontpanelcontrol.

VIExecSysEnumIndicatestheexecutionsysteminwhichaVIruns.

Name Value DescriptioneESysInvalid 0 InvalidexecutionsystemeESysUserInterface 1 UserinterfaceeESysNormal 2 StandardeESysInstrIO 3 InstrumentI/OeESysDAQ 4 Dataacquisition(DAQ)eESysOther1 5 Other1eESysOther2 6 Other2eESysSameAsCaller 7 Sameascaller

VILockStateEnumIndicatesthelockstateofaVI.

Name Value DescriptioneInvalidLockState 0 InvalidVIlockstateeUnlockedState 1 UnlockedeLockedNoPwdState 2 Locked,nopasswordePwdProtectedState 3 Password-protected

VIPriorityEnumIndicatestheexecutionpriorityofaVI.

Name Value DescriptionePriInvalid 0 InvalidpriorityePriBackground 1 BackgroundePriNormal 2 NormalePriAboveNormal 3 AbovenormalePriHigh 4 HighePriCritical 5 CriticalePriSubroutine 6 Subroutine

VITypeEnumIndicatesthetypeofaVI.

Name Value DescriptioneInvalidVIType 0 InvalidVItypeeStandardVIType 1 StandardVIeControlVIType 2 ControlVIeGlobalVIType 3 GlobalVIePolymorphicVIType 4 PolymorphicVIeConfigurationVIType 5 ConfigurationVIeSubSystemVIType 6 SubSystemeFacadeVIType 7 FacadeVIeMethodVIType 8 MethodVI

ProjectPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheProjectclass.

ProjectMethods(ActiveX)InstalledWith:BasePackage

Method DescriptionClose ClosesaLabVIEWprojectandallreferencestoall

itemsintheproject.ThismethodalsoclosestheLabVIEWProjectExplorerwindowifitisopenandclosesanyVIsthatareopeninanyapplicationinstanceownedbytheproject.InLabVIEW,youalsocanselectFile»CloseAlltoclosetheprojectandtheProjectExplorerwindow.Details

CloseWindow ClosesonlytheLabVIEWProjectExplorerwindow.ThismethoddoesnotcloseVIwindows.Details

DeployItems DeploysanarrayofitemsintheLabVIEWproject.Details

OpenWindow DisplaystheLabVIEWProjectExplorerwindow.Details

Save SavestheLabVIEWprojecttothepaththattheprojectwaspreviouslysavedtoorloadedfromortoaspecifiedpath.Details

SaveForPrevious SavesacopyoftheLabVIEWprojectthatisreadablebyLabVIEWversion8.0andlater.Details

CloseMethodInstalledWith:BasePackageClass:ProjectMethods(ActiveX)ClosesaLabVIEWprojectandallreferencestoallitemsintheproject.ThismethodalsoclosestheLabVIEWProjectExplorerwindowifitisopenandclosesanyVIsthatareopeninanyapplicationinstanceownedbytheproject.InLabVIEW,youalsocanselectFile»CloseAlltoclosetheprojectandtheProjectExplorerwindow.

Syntaxobject.Close()

ReturnValuenone

CloseWindowMethodInstalledWith:BasePackageClass:ProjectMethods(ActiveX)ClosesonlytheLabVIEWProjectExplorerwindow.ThismethoddoesnotcloseVIwindows.InLabVIEW,youalsocanselectFile»ExittoclosetheProjectExplorerwindowandanyVIsthatareopen.

Syntaxobject.CloseWindow()

ReturnValuenone

DeployItemsMethodInstalledWith:BasePackageClass:ProjectMethods(ActiveX)DeploysanarrayofitemsintheLabVIEWproject.

Syntaxobject.DeployItems(items,silent)

ParametersName Type Descriptionitems ProjectItem* Specifiesanarrayofreferencestoitemsinthe

project.silent Boolean IfTRUE,LabVIEWdoesnotdisplayanydialog

boxesduringthedeployoperation.

ReturnValuenone

OpenWindowMethodInstalledWith:BasePackageClass:ProjectMethods(ActiveX)DisplaystheLabVIEWProjectExplorerwindow.

Syntaxobject.OpenWindow()

ReturnValuenone

SaveMethodInstalledWith:BasePackageClass:ProjectMethods(ActiveX)SavestheLabVIEWprojecttothepaththattheprojectwaspreviouslysavedtoorloadedfromortoaspecifiedpath.Iftheprojecthasnotbeensavedandthevalueofthepathparameteris<NotAPath>orpathisnotspecified,thismethodreturnsanerror.

Syntaxobject.Save(path)

ParametersName Type Descriptionpath String Pathtotheproject.

ReturnValuenone

SaveForPreviousMethodInstalledWith:BasePackageClass:ProjectMethods(ActiveX)SavesacopyoftheLabVIEWprojectthatisreadablebyLabVIEWversion8.0andlater.

Syntaxobject.SaveForPrevious(Path)

ParametersName Type DescriptionPath Path

controlPathtowhereyouwanttosaveacopyoftheproject.

ReturnValuenone

ProjectProperties(ActiveX)InstalledWith:BasePackageInthefollowingtopics,anasterisk(*)attheendofadatatypenameindicatesthatthepropertyisapointer.

Property DescriptionActiveItemsInTree IftheLabVIEWProjectExplorerwindowhas

focus,returnsanarrayofreferencestotheselectedprojectitemsintheProjectExplorerwindow.IftheProjectExplorerwindowdoesnothavefocus,returnsareferencetotheprojectitemassociatedwiththeVIwindowthathasfocus.YoucanusethesereferenceswiththeProjectItemproperties.Details

Application ReturnstheapplicationreferencefortheLabVIEWproject.YoucanusethisreferencewiththeApplicationproperties.Details

Description GetsorsetsthedescriptionoftheLabVIEWproject.Details

MyComputer ReturnsareferencetoMyComputerintheProjectExplorerwindowfortheLabVIEWproject.YoucanusethisreferencewiththeTargetItemproperties.Details

Name GetsthenameoftheLabVIEWproject.Iftheprojecthasbeensaved,thispropertyreturnsthefilenamewiththefileextension.Iftheprojecthasnotbeensaved,thispropertyreturnsuntitledprojectx.Details

Path GetsthepathtothesavedLabVIEWprojectondisk.Thispathincludesthefilenameoftheproject.Details

Root ReturnsareferencetotheprojectrootintheLabVIEWProjectExplorerwindow.TheprojectrootisthetopitemthatrepresentstheLabVIEWprojectintheProjectExplorerwindow.YoucanusethisreferencewiththeProjectItemproperties.

axprop.chm::/ProjectItemAX_p.html

axprop.chm::/Application_Class.html

axprop.chm::/TargetItemAX_p.html


DetailsSelectedItemsInTree Returnsanarrayofreferencestotheprojectitems

currentlyselectedintheLabVIEWProjectExplorerwindow.YoucanusethesereferenceswiththeProjectItemproperties.Details

Targets ReturnsanarrayofreferencestoalltargetsinthecurrentLabVIEWproject.YoucanusethesereferenceswiththeTargetItemproperties.Details

WindowState ReturnsthestateoftheLabVIEWProjectExplorerwindow.Details



ActiveItemsInTreePropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)IftheLabVIEWProjectExplorerwindowhasfocus,returnsanarrayofreferencestotheselectedprojectitemsintheProjectExplorerwindow.IftheProjectExplorerwindowdoesnothavefocus,returnsareferencetotheprojectitemassociatedwiththeVIwindowthathasfocus.YoucanusethesereferenceswiththeProjectItemproperties.


Syntaxobject.ActiveItemsInTree

DataType1DarrayofProjectItems

ApplicationPropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)ReturnstheapplicationreferencefortheLabVIEWproject.YoucanusethisreferencewiththeApplicationproperties.Iftheprojecthasmultipletargets,eachtargetisassociatedwithasingleapplicationinstance.

axprop.chm::/Application_Class.html

Syntaxobject.Application

DataTypeApplication*

DescriptionPropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)GetsorsetsthedescriptionoftheLabVIEWproject.

Syntaxobject.Description

DataTypeString

MyComputerPropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)ReturnsareferencetoMyComputerintheProjectExplorerwindowfortheLabVIEWproject.YoucanusethisreferencewiththeTargetItemproperties.


Syntaxobject.MyComputer

DataTypeTargetItem*

NamePropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)GetsthenameoftheLabVIEWproject.Iftheprojecthasbeensaved,thispropertyreturnsthefilenamewiththefileextension.Iftheprojecthasnotbeensaved,thispropertyreturnsuntitledprojectx.

Syntaxobject.Name

DataTypestring

PathPropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)GetsthepathtothesavedLabVIEWprojectondisk.Thispathincludesthefilenameoftheproject.

Syntaxobject.Path

DataTypestring

RootPropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)ReturnsareferencetotheprojectrootintheLabVIEWProjectExplorerwindow.TheprojectrootisthetopitemthatrepresentstheLabVIEWprojectintheProjectExplorerwindow.YoucanusethisreferencewiththeProjectItemproperties.


Syntaxobject.Root

DataTypeProjectItem*

SelectedItemsInTreePropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)ReturnsanarrayofreferencestotheprojectitemscurrentlyselectedintheLabVIEWProjectExplorerwindow.YoucanusethesereferenceswiththeProjectItemproperties.


Syntaxobject.SelectedItemsInTree


TargetsPropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)ReturnsanarrayofreferencestoalltargetsinthecurrentLabVIEWproject.YoucanusethesereferenceswiththeTargetItemproperties.


Syntaxobject.Targets

DataType1DarrayofTargetItems

WindowStatePropertyInstalledWith:BasePackageClass:ProjectProperties(ActiveX)ReturnsthestateoftheLabVIEWProjectExplorerwindow.

Values0 eInvalidFPState—Ifyoureadthispropertyandanerroroccurs,thepropertyreturnsthisvalue.

1 eVisible—TheProjectExplorerwindowisopenbutisnotminimized,maximized,orhidden.

2 eClosed—TheProjectExplorerwindowisnotopen.3 eHidden—TheProjectExplorerwindowisfloatingbutisnotvisiblebecauseLabVIEWisnottheactiveapplication.

4 eMinimized—TheProjectExplorerwindowisminimized.5 eMaximized—TheProjectExplorerwindowismaximized.

Syntaxobject.WindowState

DataTypeFPStateEnum

ProjectItemPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheProjectItemclass.

ProjectItemMethods(ActiveX)InstalledWith:BasePackage

Method DescriptionAddFile AddsafileatthespecifiedpathtotheLabVIEW

projectwiththereferencedprojectitemastheparent.Details

AddItem AddsanewprojectitemofthespecifiedtypetotheLabVIEWprojectwiththereferenceditemastheparent.Details

AddItemFromMemory AddsanitemthatexistsinmemorytotheLabVIEWprojectwiththereferencedprojectitemastheparent.Details

Delete RemovesthereferencedprojectitemfromtheLabVIEWproject.Iftheitemhaschildren,thechildrenalsoaredeleted.Details

DeleteTag RemovesthenamedtagfromtheLabVIEWprojectitem.Details

GetAllDescendents ReturnsLabVIEWprojectitemsthataredescendentsofthereferenceditem.Ifyouspecifyavaluefortype,thismethodonlyreturnsprojectitemsofthespecifiedtype.Details

GetTag ReturnsatagvalueassociatedwiththeLabVIEWprojectitem.Details

GetTagNames ReturnsanarrayoftagnamesofalltagsonthereferencedLabVIEWprojectitem.Details

GetXMLTag ReturnsthevalueinanXMLtag.DetailsSetTag SetsatagvalueassociatedwiththeLabVIEW

project.DetailsSetXMLTag SetthevalueofanXMLtagassociatedwiththe

LabVIEWproject.Details

AddFileMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)AddsafileatthespecifiedpathtotheLabVIEWprojectwiththereferencedprojectitemastheparent.

Syntaxobject.AddFile(path)

ParametersName Type Descriptionpath String Pathtothefileyouwanttoadd.

ReturnValueProjectItem*

AddItemMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)AddsanewprojectitemofthespecifiedtypetotheLabVIEWprojectwiththereferenceditemastheparent.Thismethodreturnsanerrorifthespecifiedtypecannotbecreatedunderthecurrentitem.Themethodalsoreturnsanerrorwhenyoutrytoaddasharedvariabletoalibrarythatisnotopenedinaproject.

Syntaxobject.AddItem(name,path,type)

ParametersName Type Descriptionname String Nameoftheprojectitemyouwanttoadd.path String Pathtotheprojectitemyouwanttoadd.type String Specifiestheprojectitemtype.Thefollowingvaluesare

themostcommontypevalues:VIFolderLibraryXControlEXEDLLSourceDistributionInstallerZipFileHyperlink

SomeofthevalueslistedabovearesupportedonlyoncertainLabVIEWDevelopmentSystems.Refertoni.com/labviewformoreinformationaboutLabVIEWDevelopmentSystems.

Todeterminethevalueoftypeforaprojectitemthatisnotlistedabove,usetheTypeStringpropertytoprogrammaticallyreturnthetypeoftheitem.Forcross-languagereasons,thisstringisalwaysinEnglish.

axprop.chm::/ProjectItem_TypeString.html


AddItemFromMemoryMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)AddsanitemthatexistsinmemorytotheLabVIEWprojectwiththereferencedprojectitemastheparent.

Syntaxobject.AddItemFromMemory(name)

ParametersName Type Descriptionname String Namethatexistsinmemory,suchasfoo.vi,oftheproject

itemyouwanttoadd.


DeleteMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)RemovesthereferencedprojectitemfromtheLabVIEWproject.Iftheitemhaschildren,thechildrenalsoaredeleted.

Syntaxobject.Delete()

ReturnValuenone

DeleteTagMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)RemovesthenamedtagfromtheLabVIEWprojectitem.

Syntaxobject.DeleteTag(tagName)

ParametersName Type DescriptiontagName String Nameofthetag.UsetheGetTagNamesmethodto

retrievethetagnames.

axprop.chm::/Lib_Get_Lib_Tag_NamesAX.html

ReturnValueBoolean

GetAllDescendentsMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)ReturnsLabVIEWprojectitemsthataredescendentsofthereferenceditem.Ifyouspecifyavaluefortype,thismethodonlyreturnsprojectitemsofthespecifiedtype.Thismethodreturnsaflatlistthatincludesalldescendentsunlessyouusethetype,excludeDependencies,excludeBuilds,andexcludeTargetsparameterstolimitwhatthemethodreturns.

Syntaxobject.GetAllDescendents(type,[excludeDependencies],[excludeBuilds],[excludeTargets])

ParametersName Type Descriptiontype String Specifiestheprojectitemtype.The

followingvaluesarethemostcommontypevalues:

VIFolderLibraryXControlEXEDLLSourceDistributionInstallerZipFileHyperlink

SomeofthevalueslistedabovearesupportedonlyoncertainLabVIEWDevelopmentSystems.Refertoni.com/labviewformoreinformationaboutLabVIEWDevelopmentSystems.

Todeterminethevalueoftypeforaprojectitemthatisnotlistedabove,usetheTypeStringpropertytoprogrammaticallyreturnthetypeoftheitem.Forcross-languagereasons,thisstringisalwaysinEnglish.

excludeDependencies Boolean IfTRUE,doesnotreturnDependenciesoranyitemsunderDependencies.ThedefaultisFALSE.

excludeBuilds Boolean IfTRUE,doesnotreturnBuildSpecificationsoranyitemsunderBuildSpecifications.ThedefaultisFALSE.


excludeTargets Boolean IfTRUE,doesnotreturnanytargetsoranyitemsundertargets.ThedefaultisFALSE.

ReturnValue1DarrayofProjectItems

GetTagMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)ReturnsatagvalueassociatedwiththeLabVIEWprojectitem.

Syntaxobject.GetTag(tagName,value,[isPersistent])

ParametersName Type DescriptiontagName String Nameofthetag.UsetheGetTagNamesmethod

toretrievethetagnames.value variant Specifiesthetagvalueasavariant.isPersistent Boolean* ReturnsTRUEifLabVIEWsavesthetag

informationwhenyousavetheLabVIEWproject.ReturnsFALSEotherwise.


ReturnValueBoolean

GetTagNamesMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)ReturnsanarrayoftagnamesofalltagsonthereferencedLabVIEWprojectitem.

Syntaxobject.GetTagNames()

ReturnValueArrayofstrings

GetXMLTagMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)ReturnsthevalueinanXMLtag.UsetheSetXMLTagmethodtosetthevalueinanXMLtag.

axprop.chm::/ProjectItem_Set_XML_TagAX.html

Syntaxobject.GetXMLTag(tagName,[value],[isPersistent])


toretrievethetagnames.value String* ReturnsthevalueoftheXMLtagasastring.isPersistent Boolean* ReturnsTRUEifLabVIEWsavesthetag



ReturnValueBoolean

SetTagMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)SetsatagvalueassociatedwiththeLabVIEWproject.

Syntaxobject.SetTag(tagName,value,[isPersistent])


toretrievethetagnames.value variant Specifiesthetagvalueasavariant.isPersistent Boolean IfTRUE,LabVIEWsavesthetaginformation

whenyousavetheLabVIEWproject.ThedefaultisFALSE.


ReturnValuenone

SetXMLTagMethodInstalledWith:BasePackageClass:ProjectItemMethods(ActiveX)SetthevalueofanXMLtagassociatedwiththeLabVIEWproject.

Syntaxobject.SetXMLTag(tagName,value,[isPersistent])


toretrievethetagnames.value variant Specifiesthetagvalueasavariant.isPersistent Boolean IfTRUE,LabVIEWsavesthetaginformation

whenyousavetheLabVIEWproject.ThedefaultisFALSE.


ReturnValuenone

ProjectItemProperties(ActiveX)InstalledWith:BasePackageInthefollowingtopics,anasterisk(*)attheendofadatatypenameindicatesthatthepropertyisapointer.

Property DescriptionChildren Returnsanarrayofreferencestoallchildrenof

thereferencedLabVIEWprojectitem.YoucanusethesereferenceswiththeProjectItemproperties.Details

ContainsConflicts ReturnsTRUEifthisitemoritemsbeneaththisitemintheprojecttreeareinconflict.Details

DisplayName Gets,asastring,thenameoftheLabVIEWprojectitemasthenameappearsintheLabVIEWProjectExplorerwindow.Details

FindCallers Returnsanarrayofreferencestoallprojectitemsthatreferencetheprojectitemyouselect.Details

FindConflicts Returnsanarrayofreferencestoallprojectitemsthatareinconflictwiththeprojectitemyouselect.Details

FindItemsWithNoCallers Returnsanarrayofreferencestoalltop-levelprojectitemsthatcallnootherprojectitems.Details

FindSubVIs ReturnsanarrayofreferencestoallprojectitemsthataresubVIsoftheitemyouselect.Details

Icon GetstheiconoftheprojectitemintheLabVIEWProjectExplorerwindowusingtheIconcluster,whichlimitssizeandcolordepth.Details

InConflict ReturnsTRUEifthereferencedLabVIEWprojectitemconflictswithanotheritemwithadifferentpathunderthesametarget.Details

ItemID GetstheitemIDofthereferencedLabVIEW


projectitemasastring.YoucanusethisitemIDtouniquelyidentifythereferenceditemevenifthepath,name,orlocationintheLabVIEWProjectExplorerwindowchanges.Details

LibraryItemType GetsthetypeoftheLabVIEWprojectitemasitexistsintheprojectlibraryasaGUIDstring.UsetheLibraryItemTypeStringpropertytoreturnthetypeasahuman-readablestring.Details

LibraryItemTypeString ReturnsthetypeoftheLabVIEWprojectitemasitexistsintheprojectlibraryasastring.UsetheLibraryItemTypepropertytoreturnthetypeasaGUID.Details

Name GetsthenameofthereferencedLabVIEWprojectitemasitissavedinthefile.Details

Parent ReturnsareferencetotheparentofthereferencedLabVIEWprojectitem.YoucanusethisreferencewiththeProjectItemproperties.Details

Path GetsthepathofthereferencedLabVIEWprojectitem.Details

Project ReturnsareferencetotheLabVIEWprojecttowhichthereferencedprojectitembelongs.YoucanusethisreferencewiththeProjectproperties.Details

Target ReturnsareferencetothetargetthatcontainsthereferencedLabVIEWprojectitem.YoucanusethisreferencewiththeTargetItemproperties.Details

TypeGUID GetsthetypeoftheLabVIEWprojectitemasaGUIDstring.UsetheTypeStringpropertytoreturnthetypeasastring.Details

TypeString GetsthetypeoftheLabVIEWprojectitemasastring.UsetheTypeGUIDpropertytoreturnthetypeasaGUID.Details

axprop.chm::/ProjectItem_LibraryItemTypeString.html

axprop.chm::/ProjectItem_LibraryItemType.html





axprop.chm::/ProjectItem_TypeGUID.html

VI IftheLabVIEWprojectitemreferstoaVI,thispropertyreturnsareferencetotheVI.Otherwise,thispropertyreturnsNULL.Details

VINoLoad IftheprojectitemreferstoaVIinmemory,thispropertyreturnsareferencetotheVI.IftheprojectitemreferstoaVInotinmemoryortosomethingthatisnotaVI,thispropertyreturnsNotaRefnum.YoucanusethisreferencewiththeVIproperties.Details

VisibleInTree IfTRUE,indicatesthattheLabVIEWProjectExplorerwindowisvisibleandancestorsoftheLabVIEWprojectitemareexpandedintheProjectExplorerwindowuptotherootoftheprojectitem.Details

axprop.chm::/VirtualInstrument_Class.html

ChildrenPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsanarrayofreferencestoallchildrenofthereferencedLabVIEWprojectitem.YoucanusethesereferenceswiththeProjectItemproperties.


Syntaxobject.Children


ContainsConflictsPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsTRUEifthisitemoritemsbeneaththisitemintheprojecttreeareinconflict.

Syntaxobject.ContainsConflicts

DataTypeBoolean

DisplayNamePropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)Gets,asastring,thenameoftheLabVIEWprojectitemasthenameappearsintheLabVIEWProjectExplorerwindow.

Syntaxobject.DisplayName

DataTypestring

FindCallersPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)Returnsanarrayofreferencestoallprojectitemsthatreferencetheprojectitemyouselect.

Syntaxobject.FindCallers

DataType

FindConflictsPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)Returnsanarrayofreferencestoallprojectitemsthatareinconflictwiththeprojectitemyouselect.

Syntaxobject.FindConflicts


FindItemsWithNoCallersPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)Returnsanarrayofreferencestoalltop-levelprojectitemsthatcallnootherprojectitems.

Syntaxobject.FindItemsWithNoCallers


FindSubVIsPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsanarrayofreferencestoallprojectitemsthataresubVIsoftheitemyouselect.

Syntaxobject.FindSubVIs


IconPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)GetstheiconoftheprojectitemintheLabVIEWProjectExplorerwindowusingtheIconcluster,whichlimitssizeandcolordepth.

Syntaxobject.Icon

DataTypeImageData

InConflictPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsTRUEifthereferencedLabVIEWprojectitemconflictswithanotheritemwithadifferentpathunderthesametarget.

Syntaxobject.InConflict

DataTypeBoolean

ItemIDPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)GetstheitemIDofthereferencedLabVIEWprojectitemasastring.YoucanusethisitemIDtouniquelyidentifythereferenceditemevenifthepath,name,orlocationintheLabVIEWProjectExplorerwindowchanges.

Syntaxobject.ItemID

DataTypestring

LibraryItemTypePropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)GetsthetypeoftheLabVIEWprojectitemasitexistsintheprojectlibraryasaGUIDstring.UsetheLibraryItemTypeStringpropertytoreturnthetypeasahuman-readablestring.Iftheitemisnotpartofalibrary,thispropertyreturnsanerror.

axprop.chm::/ProjectItem_LibraryItemTypeString.html

Syntaxobject.LibraryItemType

DataTypestring

LibraryItemTypeStringPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsthetypeoftheLabVIEWprojectitemasitexistsintheprojectlibraryasastring.UsetheLibraryItemTypepropertytoreturnthetypeasaGUID.ThispropertyisvalidonlyiftheLabVIEWprojectitemexistsinaprojectlibrary.

axprop.chm::/ProjectItem_LibraryItemType.html

Syntaxobject.LibraryItemTypeString

DataTypestring

NamePropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)GetsthenameofthereferencedLabVIEWprojectitemasitissavedinthefile.UsetheDisplayNamepropertytogetthenameasitappearsintheLabVIEWProjectExplorerwindow.

axprop.chm::/ProjItem_Display_NameAX.html

Syntaxobject.Name

DataTypestring

ParentPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsareferencetotheparentofthereferencedLabVIEWprojectitem.YoucanusethisreferencewiththeProjectItemproperties.


Syntaxobject.Parent


PathPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)GetsthepathofthereferencedLabVIEWprojectitem.

Syntaxobject.Path

DataTypestring

ProjectPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsareferencetotheLabVIEWprojecttowhichthereferencedprojectitembelongs.YoucanusethisreferencewiththeProjectproperties.


Syntaxobject.Project

DataTypeProject*

TargetPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)ReturnsareferencetothetargetthatcontainsthereferencedLabVIEWprojectitem.YoucanusethisreferencewiththeTargetItemproperties.


Syntaxobject.Target

DataTypeTargetItem*

TypeGUIDPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)GetsthetypeoftheLabVIEWprojectitemasaGUIDstring.UsetheTypeStringpropertytoreturnthetypeasastring.


Syntaxobject.TypeGUID

DataTypestring

TypeStringPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)GetsthetypeoftheLabVIEWprojectitemasastring.UsetheTypeGUIDpropertytoreturnthetypeasaGUID.

axprop.chm::/ProjectItem_TypeGUID.html

Syntaxobject.TypeString

DataTypestring

VIPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)IftheLabVIEWprojectitemreferstoaVI,thispropertyreturnsareferencetotheVI.Otherwise,thispropertyreturnsNULL.

NoteThispropertydoesnotrecordchangestotheVI.IfyouusethisreferenceforeditingtheVIyouwillnotbepromptedtosavewhenthereferencecloses.

Syntaxobject.VI

DataTypeVirtualInstrument*

VINoLoadPropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)IftheprojectitemreferstoaVIinmemory,thispropertyreturnsareferencetotheVI.IftheprojectitemreferstoaVInotinmemoryortosomethingthatisnotaVI,thispropertyreturnsNotaRefnum.YoucanusethisreferencewiththeVIproperties.

axprop.chm::/VirtualInstrument_Class.html

Syntaxobject.VINoLoad

DataTypeVIObjRef

VisibleInTreePropertyInstalledWith:BasePackageClass:ProjectItemProperties(ActiveX)IfTRUE,indicatesthattheLabVIEWProjectExplorerwindowisvisibleandancestorsoftheLabVIEWprojectitemareexpandedintheProjectExplorerwindowuptotherootoftheprojectitem.

Syntaxobject.VisibleInTree

DataTypeBoolean

LibraryPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheLibraryclass.

LibraryMethods(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem.UsethesemethodstoconfigureLabVIEWprojectlibraries.

Method DescriptionDeleteLibTag DeletesatagfromtheLabVIEWprojectlibrary.

DetailsDisconnectFromLibrary DisconnectsaLabVIEWprojectlibrarythatisa

sublibraryofanotherprojectlibraryfromtheowningprojectlibrary.Details

GetLibTag RetrievesatagsetontheLabVIEWprojectlibrary.Details

GetLockState ReturnsthelockstateoftheLabVIEWprojectlibraryandindicateswhetherthepasswordfortheprojectlibraryisinthepasswordcache.Details

GetSourceScope RetrievestheaccessscopeforanitemthattheLabVIEWprojectlibraryowns,suchaspublicorprivateaccess.Details

GetTagNames RetrievesalistofnamesforalltagssetontheLabVIEWprojectlibrary.Details

HiliteInProjectWindow DisplaysthislibraryinaProjectExplorerwindow.IfthelibraryisalreadyinaProjectExplorerwindow,thismethoddisplaystheProjectExplorerwindowandsetsfocustothelibraryiteminthewindow.Ifthelibraryisalreadyinastand-aloneprojectlibrarywindowforwhichthelibraryistherootitem,thismethoddisplaysthestand-aloneprojectlibrarywindow.Ifthelibraryisnotinanywindow,thismethodopensastand-aloneprojectlibrarywindowcontainingthelibrary.Details

Save SavestheLabVIEWprojectlibraryfile.Youalsocanright-clicktheprojectlibraryintheLabVIEW

ProjectExplorerwindowandselectSaveAsfromtheshortcutmenutosavetheprojectlibraryfile.Details

SaveCopy SavesacopyoftheLabVIEWprojectlibraryfile.Details

SaveForPrevious SavesacopyoftheLabVIEWprojectlibrarythatisreadablebyLabVIEWversion8.0andlater.Details

SetLibTag SetsatagontheLabVIEWprojectlibrary.Details

SetLockState SetsthelevelofeditingpermissionforaLabVIEWprojectlibrary,includingthepassword.Details

SetSourceScope SetstheaccessscopeofanitemthattheLabVIEWprojectlibraryowns,suchaspublicorprivateaccess.Details

DeleteLibTagMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)DeletesatagfromtheLabVIEWprojectlibrary.

Syntaxobject.DeleteLibTag(tagName,[itemRef])


toretrievethetagnames.itemRef ProjectItem* ReferencetotheProjectLibraryItem.


ReturnValueBoolean

DisconnectFromLibraryMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)DisconnectsaLabVIEWprojectlibrarythatisasublibraryofanotherprojectlibraryfromtheowningprojectlibrary.

Syntaxobject.DisconnectFromLibrary()

ReturnValuenone

GetLibTagMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)RetrievesatagsetontheLabVIEWprojectlibrary.

Syntaxobject.GetLibTag(tagName,[value],[isPersistent],[itemRef])

ParametersName Type DescriptiontagName String Nameofthetag.UsetheGetTagNames

methodtoretrievethetagnames.value variant Returnsthevalueofthetag.isPersistent Boolean* ReturnsTRUEifLabVIEWsavesthetag


itemRef ProjectItem* ReferencetotheProjectLibraryItem.


ReturnValueBoolean

GetLockStateMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)ReturnsthelockstateoftheLabVIEWprojectlibraryandindicateswhetherthepasswordfortheprojectlibraryisinthepasswordcache.ThismethodissimilartotheProtectionboxontheGeneralSettingspageoftheProjectLibraryPropertiesdialogbox.

Syntaxobject.GetLockState([pwdInCache])

ParametersName Type DescriptionpwdInCache Boolean

byrefIndicateswhetherthepasswordiscurrentlyinthepasswordcache.

ReturnValueVILockStateEnum

GetSourceScopeMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)RetrievestheaccessscopeforanitemthattheLabVIEWprojectlibraryowns,suchaspublicorprivateaccess.

Syntaxobject.GetSourceScope(sourceRef,[inherited])

ParametersName Type DescriptionsourceRef ProjectItem* Referencetotheitemintheprojectlibraryfor

whichyouwanttoretrievescope.inherited Boolean Indicateswhetherthespecifieditemis

inherited.

ReturnValueLibraryItemScopeEnum

GetTagNamesMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)RetrievesalistofnamesforalltagssetontheLabVIEWprojectlibrary.

Syntaxobject.GetTagNames([itemRef])

ParametersName Type DescriptionitemRef ProjectItem* ReferencetotheProjectLibraryItem.

ReturnValueArrayofstrings

HiliteInProjectWindowMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)DisplaysthislibraryinaProjectExplorerwindow.IfthelibraryisalreadyinaProjectExplorerwindow,thismethoddisplaystheProjectExplorerwindowandsetsfocustothelibraryiteminthewindow.Ifthelibraryisalreadyinastand-aloneprojectlibrarywindowforwhichthelibraryistherootitem,thismethoddisplaysthestand-aloneprojectlibrarywindow.Ifthelibraryisnotinanywindow,thismethodopensastand-aloneprojectlibrarywindowcontainingthelibrary.

Syntaxobject.HiliteInProjectWindow()

ReturnValuenone

SaveMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)SavestheLabVIEWprojectlibraryfile.Youalsocanright-clicktheprojectlibraryintheLabVIEWProjectExplorerwindowandselectSaveAsfromtheshortcutmenutosavetheprojectlibraryfile.

Syntaxobject.Save([path])

ParametersName Type Descriptionpath String PathtotheLabVIEWprojectlibraryfile.

ReturnValuenone

SaveCopyMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)SavesacopyoftheLabVIEWprojectlibraryfile.

Syntaxobject.SaveCopy(destDir,[newName],[newLibPath])

ParametersName Type DescriptiondestDir String Specifiesthedestinationdirectoryforthecopyof

theprojectlibrary.newName String Specifiesthenameofthecopyoftheprojectlibrary.newLibPath String Returnsthepathtothecopyoftheprojectlibrary.

ReturnValuenone

SaveForPreviousMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)SavesacopyoftheLabVIEWprojectlibrarythatisreadablebyLabVIEWversion8.0andlater.

Syntaxobject.SaveForPrevious(Path)

ParametersName Type DescriptionPath Path

controlPathtothedirectorywhereyouwanttosavetheLabVIEWprojectlibrary.

ReturnValuenone

SetLibTagMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)SetsatagontheLabVIEWprojectlibrary.

Syntaxobject.SetLibTag(tagName,[value],[isPersistent],[itemRef])

ParametersName Type DescriptiontagName String Nameofthetag.UsetheGetTagNames

methodtoretrievethetagnames.value variant Specifiesthevalueofthetag.isPersistent Boolean* ReturnsTRUEifLabVIEWsavesthetag


itemRef ProjectItem* ReferencetotheProjectLibraryItem.


ReturnValuenone

SetLockStateMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)SetsthelevelofeditingpermissionforaLabVIEWprojectlibrary,includingthepassword.ThismethodissimilartotheProtectionboxontheGeneralSettingspageoftheLabVIEWProjectLibraryPropertiesdialogbox.

Syntaxobject.SetLockState(lockState,[Interactive],[Password],[putInCache])

ParametersName Type DescriptionlockState VILockStateEnum Lockstate.Interactive Boolean Specifieswhethertodisplayadialog

boxthatpromptsyoutochangethelockstate.ThedefaultisFALSE.

Password String IflockStateisPassword-protected,Passwordisthenewpassword.IfyouarechanginglockStatefromPassword-protected,Passwordistheoldpassword.Thedefaultisanemptystring.

putInCache Boolean IflockStateisPassword-protected,putinCachespecifieswhethertoplacethenewpasswordinthecache.ThedefaultisFALSE.

ReturnValuenone

SetSourceScopeMethodInstalledWith:BasePackageClass:LibraryMethods(ActiveX)SetstheaccessscopeofanitemthattheLabVIEWprojectlibraryowns,suchaspublicorprivateaccess.ThismethodissimilartotheAccessScopeboxontheItemSettingspageoftheLabVIEWProjectLibraryPropertiesdialogbox.

Syntaxobject.SetSourceScope(sourceRef,[scope])

ParametersName Type DescriptionsourceRef ProjectItem* Referencetotheitemintheproject

libraryforwhichyouwanttosetscope.

scope LibraryItemScopeEnum Specifiestheaccesssettingfortheitem.

Public—Theitemisvisiblewhenusersviewtheprojectlibrary.OtherVIsandapplicationscancallpublicVIs.Private—Theitemdoesnotappearvisiblewhenusersviewtheprojectlibraryorpalettesifyoulocktheprojectlibrary.OtherVIsandapplicationsthattheprojectlibrarydoesnotowncannotcallaprivateVI.

ReturnValuenone

LibraryProperties(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem.UsethesepropertiestoconfigureLabVIEWprojectlibraries.

Property DescriptionAlarmsEventsDBComputer Specifiesthenameofthecomputer

wherethealarmsandeventsdatabaseresides.Details

AlarmsEventsDBName SpecifiesthenameofthedatabasewheretheLabVIEWSharedVariableEnginelogsalarmsandevents.Details

AlarmsEventsDBPath SpecifiesthefilepathtothedatabasewheretheLabVIEWSharedVariableEnginelogsalarmsandevents.Details

AlarmsEventsEnable EnablesalarmsandeventsloggingcapabilityifsettoTRUE.Details

AlarmsEventsUseDataLoggingDB Setsthealarmsandeventsdatabasetobethesameasthedatabasethatlogsdata.IfsettoTRUE,LabVIEWignorespropertiessetontheAlarmsEventsdatabase.Details

DataLoggingDBComputer Specifiesthenameofthecomputerwherethedatabaseresides.Details

DataLoggingDBName SpecifiesthenameofthedatabasewheretheLabVIEWSharedVariableEnginelogsdata.Details

DataLoggingDBPath SpecifiesthefilepathtothedatabasewheretheLabVIEWSharedVariableEnginelogsdata.Details

DataLoggingEnable EnablesdataloggingcapabilityifsettoTRUE.Details

DataLoggingLifespan Setsthelifespan(indays)oftheloggeddatainthedatabase.Ifvalueis0,thendataisalwaysavailable,otherwisethedatabasecandestroydataafterthenumberofspecifieddays.Details

Description SpecifiesthedescriptionoftheLabVIEWprojectlibraryfortheContextHelpwindow.Details

HelpDocumentPath PathorsymbolicpathtoanHTMLfile(.htmor.html)orcompiledhelpfile(.chmor.hlp)towhichtheLabVIEWprojectlibraryislinked.Details

HelpDocumentTag IndexkeywordorHTMLfilenameforatopicinthecompiledhelpfiletowhichtheLabVIEWprojectlibraryislinked.TolinktoabookmarkwithinanHTMLfile,add#followedbythenameofthebookmarktotheendofthefilename.Details

LocalName Thelocalizednameoftheitem.Details

Version TheversionnumberoftheLabVIEWprojectlibrary.Details

AlarmsEventsDBComputerPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)Specifiesthenameofthecomputerwherethealarmsandeventsdatabaseresides.

Syntaxobject.AlarmsEventsDBComputer

DataTypestring

AlarmsEventsDBNamePropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)SpecifiesthenameofthedatabasewheretheLabVIEWSharedVariableEnginelogsalarmsandevents.

Syntaxobject.AlarmsEventsDBName

DataTypestring

AlarmsEventsDBPathPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)SpecifiesthefilepathtothedatabasewheretheLabVIEWSharedVariableEnginelogsalarmsandevents.

Syntaxobject.AlarmsEventsDBPath

DataTypestring

AlarmsEventsEnablePropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)EnablesalarmsandeventsloggingcapabilityifsettoTRUE.

Syntaxobject.AlarmsEventsEnable

DataTypeBoolean

AlarmsEventsUseDataLoggingDBPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)Setsthealarmsandeventsdatabasetobethesameasthedatabasethatlogsdata.IfsettoTRUE,LabVIEWignorespropertiessetontheAlarmsEventsdatabase.

Syntaxobject.AlarmsEventsUseDataLoggingDB

DataTypeBoolean

DataLoggingDBComputerPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)Specifiesthenameofthecomputerwherethedatabaseresides.

Syntaxobject.DataLoggingDBComputer

DataTypestring

DataLoggingDBNamePropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)SpecifiesthenameofthedatabasewheretheLabVIEWSharedVariableEnginelogsdata.

Syntaxobject.DataLoggingDBName

DataTypestring

DataLoggingDBPathPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)SpecifiesthefilepathtothedatabasewheretheLabVIEWSharedVariableEnginelogsdata.

Syntaxobject.DataLoggingDBPath

DataTypestring

DataLoggingEnablePropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)EnablesdataloggingcapabilityifsettoTRUE.

Syntaxobject.DataLoggingEnable

DataTypeBoolean

DataLoggingLifespanPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)Setsthelifespan(indays)oftheloggeddatainthedatabase.Ifvalueis0,thendataisalwaysavailable,otherwisethedatabasecandestroydataafterthenumberofspecifieddays.Thedatabaseonlydiscardsdataifnewdataislogged.ThispropertyaffectsalldatafromtheLabVIEWprojectlibrarystoredinthedatabase,notjustthemostrecentdata.Forexample,ifyousetthispropertytofourdaysandyouhavethreedaysofdata,thedatabasedoesnotdestroyanydata.However,ifyousetthissamepropertytotwodaysfromfourdaysandyouhavethreedaysofdata,thedatabasecandestroyanydatacollectedmorethantwodaysago.

Syntaxobject.DataLoggingLifespan

DataTypeLong

DescriptionPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)SpecifiesthedescriptionoftheLabVIEWprojectlibraryfortheContextHelpwindow.IfyouwanttodisplayacarriagereturnintheLabVIEWContextHelpwindow,youmustseparateparagraphswithtwocarriagereturns.


DataTypestring

HelpDocumentPathPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)PathorsymbolicpathtoanHTMLfile(.htmor.html)orcompiledhelpfile(.chmor.hlp)towhichtheLabVIEWprojectlibraryislinked.Ifthepathistoacompiledhelpfile,usetheHelpDocumentTagpropertytodeterminethespecifictopicinthathelpfile.ThispropertyissimilartotheHelppathtextboxontheDocumentationpageoftheLabVIEWProjectLibraryPropertiesdialogbox.

axprop.chm::/Library_Help_Document_TagAX.html

Syntaxobject.HelpDocumentPath

DataTypestring

HelpDocumentTagPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)IndexkeywordorHTMLfilenameforatopicinthecompiledhelpfiletowhichtheLabVIEWprojectlibraryislinked.TolinktoabookmarkwithinanHTMLfile,add#followedbythenameofthebookmarktotheendofthefilename.UsethispropertyonlywhenHelpDocumentPathisapathtoacompiledhelpfile(.chmor.hlp).For.chmfiles,thispropertycanbeanHTMLfilenameorindexkeyword.For.hlpfiles,thispropertycanbeanindexkeyword.ThispropertyissimilartotheHelptagtextboxontheDocumentationpageoftheLabVIEWProjectLibraryPropertiesdialogbox.

axprop.chm::/Library_Help_Document_PathAX.html

Syntaxobject.HelpDocumentTag

DataTypestring

LocalNamePropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)Thelocalizednameoftheitem.ThispropertyissimilartotheLocalizedNametextboxontheDocumentationpageoftheLabVIEWProjectLibraryPropertiesdialogbox.

Syntaxobject.LocalName

DataTypestring

VersionPropertyInstalledWith:BasePackageClass:LibraryProperties(ActiveX)TheversionnumberoftheLabVIEWprojectlibrary.ThispropertyissimilartotheVersionNumbercomponentontheGeneralSettingspageoftheLabVIEWProjectLibraryPropertiesdialogbox.

Syntaxobject.Version

DataTypeLVLibraryVersion

XInterfaceLibraryPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheXInterfaceLibraryclass.

XInterfaceLibraryMethods(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem»Library.

Method DescriptionAddAbility Createsanewabilityofthespecifiedtype.DetailsAddMethod Createsanewmethod.DetailsNewProperty Createsanewpropertyfolderandreturnsareferenceto

it.Details

AddAbilityMethodInstalledWith:BasePackageClass:XInterfaceLibraryMethods(ActiveX)Createsanewabilityofthespecifiedtype.

Syntaxobject.AddAbility(name,[viPath],[folder])

ParametersName Type Descriptionname String Namefortheabilityyouwanttocreate.viPath path IfyouspecifyviPath,LabVIEWusesanexistingVI

fortheability.IfyoudonotspecifyviPath,LabVIEWcreatesanewVIfortheability.

folder ProjectItem* Createstheabilityinthespecifiedfolder.


AddMethodMethodInstalledWith:BasePackageClass:XInterfaceLibraryMethods(ActiveX)Createsanewmethod.

Syntaxobject.AddMethod([viPath],[folder])

ParametersName Type DescriptionviPath path IfyouspecifyviPath,LabVIEWusesanexistingVI

forthemethod.IfyoudonotspecifyviPath,LabVIEWcreatesanewVIforthemethod.

folder ProjectItem* Createsthemethodinthespecifiedfolder.


NewPropertyMethodInstalledWith:BasePackageClass:XInterfaceLibraryMethods(ActiveX)Createsanewpropertyfolderandreturnsareferencetoit.

Syntaxobject.NewProperty(name,folder)

ParametersName Type Descriptionname String Nameofthenewpropertyfoldertocreate.folder ProjectItem* Folderinwhichtocreatethenewpropertyfolder.

ReturnValuePropertyFolder*

XInterfaceLibraryProperties(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem»Library.Nopropertiesarespecifictothisclass.

PropertyFolderPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationforthePropertyFolderclass.

PropertyFolderMethods(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem.

Method DescriptionAddPropertyVI CreatesanewreadorwritepropertyVIifyoudonotset

viPath.IfyousetviPath,LabVIEWusesanexistingVIasapropertyVI.Details

AddPropertyVIMethodInstalledWith:BasePackageClass:PropertyFolderMethods(ActiveX)CreatesanewreadorwritepropertyVIifyoudonotsetviPath.IfyousetviPath,LabVIEWusesanexistingVIasapropertyVI.

Syntaxobject.AddPropertyVI([read],[viPath])

ParametersName Type Descriptionread Boolean IfTRUE,createsareadpropertyVI.IfFALSE,creates

awritepropertyVI.ThedefaultisTRUE.viPath path PathtothepropertyVI.Thisparameterisoptional.If

youspecifyapath,LabVIEWusesanexistingVIasapropertyVI.


XPropertyFolderPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheXPropertyFolderclass.

XPropertyFolderProperties(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem»PropertyFolder.

Property DescriptionDescription Setsorgetsthedescriptionofthepropertyfolder.DetailsHelpTag Setsorgetsthehelptagofthepropertyfolder.DetailsIdentifier Setsorgetsthepropertyidentifierofthepropertyfolder.

DetailsLongName Setsorgetsthelongnameofthepropertyfolder.Details

DescriptionPropertyInstalledWith:BasePackageClass:XPropertyFolderProperties(ActiveX)Setsorgetsthedescriptionofthepropertyfolder.


DataTypestring

HelpTagPropertyInstalledWith:BasePackageClass:XPropertyFolderProperties(ActiveX)Setsorgetsthehelptagofthepropertyfolder.

Syntaxobject.HelpTag

DataTypestring

IdentifierPropertyInstalledWith:BasePackageClass:XPropertyFolderProperties(ActiveX)Setsorgetsthepropertyidentifierofthepropertyfolder.

Syntaxobject.Identifier

DataTypestring

LongNamePropertyInstalledWith:BasePackageClass:XPropertyFolderProperties(ActiveX)Setsorgetsthelongnameofthepropertyfolder.

Syntaxobject.LongName

DataTypestring

XPropertyFolderMethods(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem»PropertyFolder.Nomethodsarespecifictothisclass.

TargetItemPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheTargetItemclass.

TargetItemMethods(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem.

Method DescriptionRefreshDependencies RefreshesDependenciesunderthistargetinthe

LabVIEWProjectExplorerwindow.YoualsocanusetheProjectExplorerwindowtorefreshdependencies.Details

RefreshDependenciesMethodInstalledWith:BasePackageClass:TargetItemMethods(ActiveX)RefreshesDependenciesunderthistargetintheLabVIEWProjectExplorerwindow.YoualsocanusetheProjectExplorerwindowtorefreshdependencies.

Syntaxobject.RefreshDependencies()

ReturnValuenone

TargetItemProperties(ActiveX)InstalledWith:BasePackageInheritsfromProjectItem.Inthefollowingtopics,anasterisk(*)attheendofadatatypenameindicatesthatthepropertyisapointer.

Property DescriptionBuildSpecifications ReturnsareferencetoBuildSpecificationsunder

thecurrenttargetintheLabVIEWProjectExplorerwindow.YoucanusethisreferencewiththeProjectItemproperties.Details

Dependencies ReturnsareferencetoDependenciesunderthecurrenttargetintheLabVIEWProjectExplorerwindow.YoucanusethisreferencewiththeProjectItemproperties.Details



BuildSpecificationsPropertyInstalledWith:BasePackageClass:TargetItemProperties(ActiveX)ReturnsareferencetoBuildSpecificationsunderthecurrenttargetintheLabVIEWProjectExplorerwindow.YoucanusethisreferencewiththeProjectItemproperties.


Syntaxobject.BuildSpecifications


DependenciesPropertyInstalledWith:BasePackageClass:TargetItemProperties(ActiveX)ReturnsareferencetoDependenciesunderthecurrenttargetintheLabVIEWProjectExplorerwindow.YoucanusethisreferencewiththeProjectItemproperties.


Syntaxobject.Dependencies


VIPropertiesandMethodsThisbookcontainsthepropertyandmethodreferenceinformationfortheVIclass.

VIMethods(ActiveX)InstalledWith:BasePackageAVirtualInstrumentobjectexportsmethodsthataffectagivenVI.AVirtualInstrumentobjectisinstantiatedbyinvokingtheGetVIReferencemethodontheApplicationobject.

NoteMethodsparametersdenotedby[]areoptionalforthatmethod.

RefertoActiveXEnumerationsformoreinformationaboutenumerationsusedinvariousproperties.

Method DescriptionAbort AbortstheVIexecution.DetailsCall CallstheVIasasubVI.DetailsCall2 CallstheVIasasubVI.Optionally,you

canopenthefrontpaneloftheVIandcloseitafterthecallisover.YoualsocansuspendtheVIwhencalled.Details

CenterFrontPanel SpecifieswhethertoautomaticallycentertheLabVIEWfrontpanelwindowonthecomputerscreen.Details

CloseFrontPanel ClosestheLabVIEWfrontpanelwindow.Details

DisconnectFromLibrary DisconnectstheVIfromtheowningLabVIEWprojectlibrary.Details

ExportVIStrings ExportsthefollowingstringsaboutVIandLabVIEWfrontpanelobjectstoataggedtextfile:VInameanddescription,objectcaptionlabels,objectfreelabels,defaultdata(string,table,path,andarraydefaultdata),privatedata(listboxitemnames,tablerowandcolumnheaders,graphplotnames,graphcursornames,graphannotationnames,andtabcontrolpagecaptions),andpolymorphicVIdata(instance

axprop.chm::/GetVIReference.html

namesinthepolymorphicVIandselectorshortcutmenus).Details

FPGetRuntimePos ReturnsthepositionoftheLabVIEWwindowatruntime.Details

FPRunTimePosRunCentered SetsaVItocenteritsfrontpaneleverytimetheVIruns.Details

FPRunTimePosRunCustom SetsacustompositionfortheVItomoveitsfrontpaneltoeverytimetheVIruns.Details

FPRunTimePosRunMax SetsaVItomaximizeitsfrontpaneleverytimetheVIruns.Details

FPRunTimePosRunMin SetsaVItominimizeitsfrontpaneleverytimetheVIruns.Details

FPRunTimePosRunUnchanged SetstheVItonotmoveitsfrontpanelwhentheVIruns.Details

GenerateCCodeVariant Containsthecodegenerationattributes(name,valuepairs)thatdeterminehowtheLabVIEWCCodeGeneratorgeneratestheCcodefromtheblockdiagram.Anyattributesyoudonotsetusethedefaultbehavior.Details

GetControlValue GetsthevalueofthenamedLabVIEWcontrolorindicatorasvariantdata.UsetheLabVIEWVarianttoDatafunctiontoconvertthedatatoanotherLabVIEWdatatype.Details

GetLockState ReturnsthelockstateoftheVIandindicateswhetherthepasswordfortheVIisinthepasswordcache.Details

ImportVIStrings ImportsthefollowingstringsaboutVIandLabVIEWfrontpanelobjectsfromataggedtextfile:VInameanddescription,objectcaptionlabels,objectfreelabels,defaultdata(string,table,path,andarraydefaultdata),privatedata(listboxitemnames,tablerowand

columnheaders,graphplotnames,graphcursornames,graphannotationnames,andtabcontrolpagecaptions),andpolymorphicVIdata(instancenamesinthepolymorphicVIandselectorshortcutmenus).Details

MakeCurValueDefault ChangesthedefaultsofallcontrolsontheLabVIEWfrontpaneltobethecurrentvalues.Thismethodisavailableonlyineditmode.Details

OpenFrontPanel OpenstheLabVIEWfrontpanelwindow.Ifthefrontpanelisalreadyopen,thismethodchangesthestateofthefrontpanelwindowtothestateyouwiretothismethod.UsetheCloseFrontPanelmethodtoclosethefrontpanelwindow.YoualsocanusetheFPStatepropertytosetthestateofafrontpanelwindowthatisalreadyopen.Details

PrintPanel PrintsjusttheLabVIEWfrontpaneltothecurrentprinter.Youcannotusethismethodtoprintablockdiagram,listofcontrols,orpolymorphicVIfrontpanel.Details

PrintVIToHTML SavestheVIinformationtoanHTMLfileandsavesthegraphicsinexternalfiles.Details

PrintVIToPrinter PrintstheVIinformationtoaprinter.Ifyouusethismethodinastand-aloneapplicationorDLL,LabVIEWprintsonlythefrontpanel.Details

PrintVIToRTF SavestheVIinformationtoanRTFfile.Details

PrintVIToText SavestheVIinformationtoatextfile.Youcannotsavetheicon,connector

axprop.chm::/VI_Close_Front_PanelAX.html

axprop.chm::/VI_FP_WinStateAX.html

pane,frontpanel,blockdiagram,subVIicons,andVIhierarchytotext.Details

ReinitializeAllToDefault ChangesthecurrentvaluesofallcontrolsontheLabVIEWfrontpaneltotheirdefaults.Details

Revert DiscardschangesandreloadsaVIfromdisk.Details

Run StartstheVIexecution,similartotheRunbuttoninLabVIEW.ThismethodisdifferentthancallingaVIbecauseitusesthecurrentvaluesofallfrontpanelcontrolsforexecutionratherthanusingdatapassedinthroughparameters.ThismethodalsoignorestheShowFPOnCallpropertyofaVIandtheCloseFPAfterCallproperty.YoucannotusethismethodtorunaVIthatisalreadyreservedforexecutionbyanotherVI.Details

SaveForPrevious SavesacopyoftheVIthatisreadablebyLabVIEWversion8.0andlater.Details

SaveInstrument SavesaVIandsynchronizestheVIwiththeeditedversioninotherapplicationinstancesbeforesaving.Details

SaveRunTimeMenu SavestheLabVIEWrun-timemenutoafilespecifiedbyfilePath.ThismethodworksonlywhentheVIisrunning.Itsavesonlymenuitemswithvalidtags.Details

SetControlValue SetsthevalueofanamedLabVIEWcontrolorindicator.Details

SetLockState SetsthelockstateofaVI.IfInteractiveisFALSE(default),youcanusePasswordtounlockapassword-

axprop.chm::/ShowFPOnCall.html

axprop.chm::/CloseFPAfterCall.html

protectedVIorsetthepasswordofanunprotectedVI.IfInteractiveisTRUE,LabVIEWignoresPasswordanddisplaysadialogboxthatpromptsyoutochangethelockstate.Details

SetVIIcon SetstheimageofaVIiconfromafile.Details

AbortMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)AbortstheVIexecution.ThismethodissimilartotheAbortExecutionbuttonontheLabVIEWtoolbar.

Syntaxobject.Abort()

ReturnValueBoolean

CallMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)CallstheVIasasubVI.

Syntaxobject.Call([paramNames],[paramVals])

ParametersName Type DescriptionparamNames arrayof

stringsbyref

NamesoftheLabVIEWfrontpanelobjectsthatactasinputandoutputparameterstothecall.

paramVals arrayofvariantsbyref

InputvaluesfortheinputparametersandreturnvaluesfromtheoutputparametersintheorderinwhichthenameswerespecifiedinparamNames.Designatesthefrontpanelobjectvaluesfortheinputparameters.Thevaluesofparameterscanbenumeric,Boolean,string,orarray.AclusterinLabVIEWisrepresentedasanarrayofvariantsinActiveX.

ReturnValuenone

Call2MethodInstalledWith:BasePackageClass:VIMethods(ActiveX)CallstheVIasasubVI.Optionally,youcanopenthefrontpaneloftheVIandcloseitafterthecallisover.YoualsocansuspendtheVIwhencalled.

Syntaxobject.Call2([paramNames],[paramVals],[openFP],[closeFPAfterCall],[suspendOnCall])

ParametersName Type DescriptionparamNames arrayof

stringsbyref

NamesoftheLabVIEWfrontpanelobjectsthatactasinputandoutputparameterstothecall.

paramVals arrayofvariantsbyref

InputvaluesfortheinputparametersandreturnvaluesfromtheoutputparametersintheorderinwhichthenameswerespecifiedinparamNames.Designatesthefrontpanelobjectvaluesfortheinputparameters.Thevaluesofparameterscanbenumeric,Boolean,string,orarray.AclusterinLabVIEWisrepresentedasanarrayofvariantsinActiveX.

openFP Boolean OpenfrontpaneloftheVIcloseFPAfterCall Boolean ClosefrontpaneloftheVIafterthecallifit

wasnotalreadyopen.suspendOnCall Boolean SuspendtheVI(Pausetheexecution)on

call.

ReturnValuenone

CenterFrontPanelMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SpecifieswhethertoautomaticallycentertheLabVIEWfrontpanelwindowonthecomputerscreen.

Syntaxobject.CenterFrontPanel()

ReturnValuenone

CloseFrontPanelMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)ClosestheLabVIEWfrontpanelwindow.UsetheOpenFrontPanelmethodtoopenafrontpanelwindow.

axprop.chm::/VI_Open_Front_PanelAX.html

Syntaxobject.CloseFrontPanel()

ReturnValuenone

DisconnectFromLibraryMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)DisconnectstheVIfromtheowningLabVIEWprojectlibrary.

Syntaxobject.DisconnectFromLibrary()

ReturnValuenone

ExportVIStringsMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)ExportsthefollowingstringsaboutVIandLabVIEWfrontpanelobjectstoataggedtextfile:VInameanddescription,objectcaptionlabels,objectfreelabels,defaultdata(string,table,path,andarraydefaultdata),privatedata(listboxitemnames,tablerowandcolumnheaders,graphplotnames,graphcursornames,graphannotationnames,andtabcontrolpagecaptions),andpolymorphicVIdata(instancenamesinthepolymorphicVIandselectorshortcutmenus).

Syntaxobject.ExportVIStrings(stringFile,[interactive],[logFile],[captions],[diagram])

ParametersName Type DescriptionstringFile String PathoftheVIstringsfileincludingthefilename.If

youdonotenterafilename,setinteractivetoTRUEsotheusercansettheVIstringsfilename.

interactive Boolean SpecifieswhethertodisplaythefiledialogboxtoselectthenameoftheVIstringsfile.ThedefaultvalueisFALSE.

logFile String PathofthelogfilecreatedtolisterrorsthatoccurredwhileexportingVIstringstoataggedtextfile.Thedefaultisnologging.

captions Boolean Specifieswhethercontrolcaptionsshouldbeautomaticallycreated.ThedefaultvalueisFALSE.

diagram Boolean Specifieswhethertoexportblockdiagramstrings.ThedefaultvalueisFALSE.

ReturnValuenone

FPGetRuntimePosMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)ReturnsthepositionoftheLabVIEWwindowatruntime.Forsingle-panefrontpanels,minimumsizereferstothecontentareaofthatpane,notincludingthescrollbars.Formulti-panefrontpanels,minimumsizereferstotheentirefrontpanel,includinganyvisiblescrollbars.

Syntaxobject.FPGetRuntimePos([type],[position],[size],[monitor],[useCurPos],[useCurSize])

ParametersName Type Descriptiontype FPRuntimePos Returnswhetherthefrontpanelis

unchanged,centered,maximized,minimized,orhasacustomsetting.

position 16-bitinteger Aclusteroftopandleftpairsthatindicatethefrontpanelwindowposition.

size 16-bitinteger Aclusterofheightandwidthpairsthatindicatethesizeinpixelsofthefrontpanel.

monitor short Specifiesthemonitoronwhichthefrontpanelwindowappears,ifyouhavemultiplemonitors.Thevalue0istheprimarymonitorandisthedefaultvalue.Ifyouspecifyavalueotherthan0,theVIrunsonthatmonitor.Ifyouspecifyamonitornumbergreaterthanthenumberofmonitorsonthesystem,orifyouspecifyanegativenumber,LabVIEWreturnsanerror.Themonitornumbercorrespondstothevideocardyouplugthemonitorinto.

useCurPos Boolean ReturnsthevalueoftheUseCurrentPositioncheckboxintheWindowRun-TimePositiondialogboxinLabVIEW.

useCurSize Boolean ReturnsthevalueoftheUseCurrentSizecheckboxintheWindowRun-TimePositiondialogboxinLabVIEW.

ReturnValueFPRunTimePosEnum

FPRunTimePosRunCenteredMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetsaVItocenteritsfrontpaneleverytimetheVIruns.Forsingle-panefrontpanels,minimumsizereferstothecontentareaofthatpane,notincludingthescrollbars.Formulti-panefrontpanels,minimumsizereferstotheentirefrontpanel,includinganyvisiblescrollbars.

Syntaxobject.FPRunTimePosRunCentered([monitor],[size])

ParametersName Type Descriptionmonitor short Specifiesthemonitoronwhichthefrontpanelwindow

appears,ifyouhavemultiplemonitors.Thevalue0istheprimarymonitorandisthedefaultvalue.Ifyouspecifyavalueotherthan0,theVIrunsonthatmonitor.Ifyouspecifyamonitornumbergreaterthanthenumberofmonitorsonthesystem,orifyouspecifyanegativenumber,LabVIEWreturnsanerror.Themonitornumbercorrespondstothevideocardyouplugthemonitorinto.

size 16-bitinteger

Aclusterofheightandwidthpairsthatindicatethesizeinpixelsofthefrontpanel.

ReturnValuenone

FPRunTimePosRunCustomMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetsacustompositionfortheVItomoveitsfrontpaneltoeverytimetheVIruns.Forsingle-panefrontpanels,minimumsizereferstothecontentareaofthatpane,notincludingthescrollbars.Formulti-panefrontpanels,minimumsizereferstotheentirefrontpanel,includinganyvisiblescrollbars.

Syntaxobject.FPRunTimePosRunCustom([position],[size])

ParametersName Type Descriptionposition 16-bit

integerAclusteroftopandleftpairsthatindicatethefrontpanelwindowposition.

size 16-bitinteger

Aclusterofheightandwidthpairsthatindicatethesizeinpixelsofthefrontpanel.

ReturnValuenone

FPRunTimePosRunMaxMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetsaVItomaximizeitsfrontpaneleverytimetheVIruns.

Syntaxobject.FPRunTimePosRunMax([monitor])



ReturnValuenone

FPRunTimePosRunMinMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetsaVItominimizeitsfrontpaneleverytimetheVIruns.

Syntaxobject.FPRunTimePosRunMin([monitor])



ReturnValuenone

FPRunTimePosRunUnchangedMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetstheVItonotmoveitsfrontpanelwhentheVIruns.

Syntaxobject.FPRunTimePosRunUnchanged()

ReturnValuenone

GenerateCCodeVariantMethodInstalledWith:MicroprocessorSDKClass:VIMethods(ActiveX)Containsthecodegenerationattributes(name,valuepairs)thatdeterminehowtheLabVIEWCCodeGeneratorgeneratestheCcodefromtheblockdiagram.Anyattributesyoudonotsetusethedefaultbehavior.

Syntaxobject.GenerateCCodeVariant()

ReturnValuenone

GetControlValueMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)GetsthevalueofthenamedLabVIEWcontrolorindicatorasvariantdata.UsetheLabVIEWVarianttoDatafunctiontoconvertthedatatoanotherLabVIEWdatatype.ThefirsttimeyoucallthismethodonaVIwhosefrontpanelisnotopen,thismethodreturnsthedefaultvaluesofthecontrolorindicatorratherthantheactualvalues.Thereafter,itreturnstheactualvalue.Foroptimizationpurposes,LabVIEWdoesnotkeeptrackofdatavaluesoncontrolsandindicatorsuntilLabVIEWdeterminesyouwantthem,thatis,untilyoucallthismethodordisplaythefrontpanel.Whenyoudisplaythefrontpanel,LabVIEWbeginskeepingtrackofthevalues.

Syntaxobject.GetControlValue(controlName)

ParametersName Type DescriptioncontrolName String Nameofthecontrolorindicatorwhosevalueyou

want.

ReturnValuevariant

GetLockStateMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)ReturnsthelockstateoftheVIandindicateswhetherthepasswordfortheVIisinthepasswordcache.

Syntaxobject.GetLockState([pwdInCache])

ParametersName Type DescriptionpwdInCache Boolean

byrefIndicateswhetherthepasswordiscurrentlyinthepasswordcache.

ReturnValueVILockStateEnum

GetPanelImageMethodInstalledWith:BasePackageClass:VIMethodsReturnsanimageoftheLabVIEWfrontpanel.Ifafrontpanelisnotvisible,LabVIEWdoesnotupdatethevaluesintheobjectsonthefrontpanel.IfyoucallaVIwhosefrontpanelisnotvisibleandyouusetheGetPanelImagemethodtocreateanimageofthefrontpanel,theimagedoesnotreflectanyvaluechangesthatoccurredwhenyourantheVI.Ifyouwanttheimagetoreflectvaluechanges,makesurethefrontpanelisopenbeforeanyvalueschange.

Syntaxobject.GetPanelImage([visibleonly],[imgdepth],[img],[colors],[bounds])

ParametersName Type Descriptionvisibleonly Boolean Setswhetherthepanelimageincludesjust

theobjectsinthevisibleareaofthefrontpanelorallthefrontpanelobjects.ThedefaultisTRUE.

imgdepth Long Colordepth(numberofsupportedcolors)forthegraphics.Thevaluesare2(blackandwhite),16,256and224(truecolor).

img 1Darrayofbytesbyref

Returnstheimagebitmapasanarrayofbytes.

colors 1Darrayofunsignedlongbyref

Returnsthecolortableasanarrayoflongs.

bounds 1Darrayofshorts(fourelements)byref

Returnstheboundingrectangleoftheimageastop,left,bottom,andrightvalues.

ReturnValuenone

ImportVIStringsMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)ImportsthefollowingstringsaboutVIandLabVIEWfrontpanelobjectsfromataggedtextfile:VInameanddescription,objectcaptionlabels,objectfreelabels,defaultdata(string,table,path,andarraydefaultdata),privatedata(listboxitemnames,tablerowandcolumnheaders,graphplotnames,graphcursornames,graphannotationnames,andtabcontrolpagecaptions),andpolymorphicVIdata(instancenamesinthepolymorphicVIandselectorshortcutmenus).

Syntaxobject.ImportVIStrings(stringFile,[interactive],[logFile])

ParametersName Type DescriptionstringFile String PathoftheVIstringsfileincludingthefilename.If

youdonotenterafilename,setinteractivetoTRUEsotheusercansettheVIstringsfilename.

interactive Boolean IfTRUE,theusercanseethefiledialogboxtoselectthenameoftheVIstringsfile.ThedefaultisFALSE.

logFile String PathofthelogfilecreatedtolisterrorsthatoccurredwhileimportingVIstringsfromataggedtextfile.Thedefaultisnologging.

ReturnValuenone

MakeCurValueDefaultMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)ChangesthedefaultsofallcontrolsontheLabVIEWfrontpaneltobethecurrentvalues.Thismethodisavailableonlyineditmode.

Syntaxobject.MakeCurValueDefault()

ReturnValuenone

OpenFrontPanelMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)OpenstheLabVIEWfrontpanelwindow.Ifthefrontpanelisalreadyopen,thismethodchangesthestateofthefrontpanelwindowtothestateyouwiretothismethod.UsetheCloseFrontPanelmethodtoclosethefrontpanelwindow.YoualsocanusetheFPStatepropertytosetthestateofafrontpanelwindowthatisalreadyopen.

axprop.chm::/VI_Close_Front_PanelAX.html


Syntaxobject.OpenFrontPanel([activate],[state])

ParametersName Type Descriptionactivate Boolean IfTRUE(default),thefrontpanelwindowopens

astheactivewindow.state FPStateEnum Setsthestateinwhichtoopenthefrontpanel

window.

ReturnValuenone

PrintPanelMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)PrintsjusttheLabVIEWfrontpaneltothecurrentprinter.Youcannotusethismethodtoprintablockdiagram,listofcontrols,orpolymorphicVIfrontpanel.

Syntaxobject.PrintPanel([entirePanel])

ParametersName Type DescriptionentirePanel Boolean Indicateswhethertheentirefrontpanelisprinted.

IfFALSE(default),onlythecurrentlyvisibleportionofthefrontpanelisprinted.

ReturnValuenone

PrintVIToHTMLMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SavestheVIinformationtoanHTMLfileandsavesthegraphicsinexternalfiles.

Syntaxobject.PrintVIToHTML(htmlFilePath,[append],[format],[imageFormat],[imageDepth],[imageDirectory])

ParametersName Type DescriptionhtmlFilePath String PathtotheHTMLfilein

whichyouwanttosavetheVIinformation.Thedirectoryinwhichyouwanttosavethefilemustalreadyexist,andyoumustwireafullpathincludingtheHTMLfilename.

append Boolean Specifieswhetherthenewinformationwillbeappendedtoanexistingfile.ThedefaultisFALSE.

format PrintFormatEnum SpecifieswhichVIinformationtoprintandtheformatoftheprintout.YoucanselectfromeCustom,eStandard,eUsingPanel,eUsingSubVI,oreComplete.

imageFormat HTMLImageFormatEnum Formatofthegraphicfiles.SelectfromePNGoreJPEG.

imageDepth Long Setsthecolordepth,ornumberofsupportedcolors,oftheimage:1(1-bit,blackandwhite),4(4-bit,16colors),8(8-bit,256colors),or24(24-bit,truecolor).Thedefaultis8.

imageDirectory String Pathtothedirectoryinwhichyouwanttosavethegraphicfiles.Thedirectoryinwhichyouwanttosavethefilesmustalreadyexist.Ifnotspecified,LabVIEW

savestheimagefilesinthesamedirectoryastheHTMLorRTFfile.

ReturnValuenone

PrintVIToPrinterMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)PrintstheVIinformationtoaprinter.Ifyouusethismethodinastand-aloneapplicationorDLL,LabVIEWprintsonlythefrontpanel.

Syntaxobject.PrintVIToPrinter([format],[scalePanel],[scaleDiagram],[pageHeaders],[pageBreaks],[sectionHeaders])

ParametersName Type Descriptionformat PrintFormatEnum SpecifieswhichVIinformationto

printandtheformatoftheprintout.YoucanselectfromeCustom,eStandard,eUsingPanel,eUsingSubVI,oreComplete.

scalePanel Boolean Specifieswhetherthefrontpanelwillbescaledtofitthepage.ThedefaultisTRUE.

scaleDiagram Boolean Specifieswhethertheblockdiagramwillbescaledtofitthepage.ThedefaultisTRUE.

pageHeaders Boolean Specifieswhetherpageheaders(whichincludethepagenumber,VIname,andlastmodificationdata)willbeprinted.ThedefaultisTRUE.

pageBreaks Boolean Specifieswhetherpagebreakswillbeinsertedbetweenthefollowingsections:connectoriconanddescription,frontpanel,listoffrontpanelcontroldetails,blockdiagram,blockdiagramdetails,VIhierarchy,andlistofsubVIs.ThedefaultisFALSE.

sectionHeaders Boolean Specifieswhethertoprintheadersforeachsectionlistedabove.IfformatiseCustom,eStandard,oreComplete,thedefaultisTRUE.Otherwise,thedefaultisFALSE.

ReturnValuenone

PrintVIToRTFMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SavestheVIinformationtoanRTFfile.

Syntaxobject.PrintVIToRTF(rtfFilePath,[append],[format],[imageFormat],[imageDepth],[imageDirectory],[helpFormat])

ParametersName Type DescriptionrtfFilePath String PathtotheRTFfileinwhichyou

wanttosavetheVIinformation.Thedirectoryinwhichyouwanttosavethefilemustalreadyexist,andyoumustspecifyafullpathincludingtheRTFfilename.



imageFormat Long Formatofthegraphicsfile.Thedefaultis0,whichcorrespondstotheBMPformat.BMPistheonlyformatsupported.

imageDepth Long Setsthecolordepth,ornumberofsupportedcolors,oftheimage:1(1-bit,blackandwhite),4(4-bit,16colors),8(8-bit,256colors),or24(24-bit,truecolor).Thedefaultis8.

imageDirectory String Pathtothedirectoryinwhichyouwanttosavethegraphicfiles.Thedirectoryinwhichyouwanttosavethefilesmustalreadyexist.Ifnotspecified,LabVIEWsavestheimagefilesinthesamedirectoryastheHTMLorRTFfile.

helpFormat Boolean SpecifieswhethertosavethegraphicsexternallyandplacereferencesintheRTFfile.Setthis

parametertoTRUEifyouarecreatingahelpfile.ThedefaultisFALSE.

ReturnValuenone

PrintVIToTextMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SavestheVIinformationtoatextfile.Youcannotsavetheicon,connectorpane,frontpanel,blockdiagram,subVIicons,andVIhierarchytotext.

Syntaxobject.PrintVIToText(textFilePath,[append],[format])

ParametersName Type DescriptiontextFilePath String Pathtothetextfileinwhichyouwantto

savetheVIinformation.Thedirectoryinwhichyouwanttosavethefilemustalreadyexist,andyoumustspecifyafullpathincludingthetextfilename.



NoteTheeCustom,eStandard,eUsingPanel,andeUsingSubVIparametersprintonlyconnectorpanecontrols.

ReturnValuenone

ReinitializeAllToDefaultMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)ChangesthecurrentvaluesofallcontrolsontheLabVIEWfrontpaneltotheirdefaults.

Syntaxobject.ReinitializeAllToDefault()

ReturnValuenone

RevertMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)DiscardschangesandreloadsaVIfromdisk.

Syntaxobject.Revert()

ReturnValuenone

RunMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)StartstheVIexecution,similartotheRunbuttoninLabVIEW.ThismethodisdifferentthancallingaVIbecauseitusesthecurrentvaluesofallfrontpanelcontrolsforexecutionratherthanusingdatapassedinthroughparameters.ThismethodalsoignorestheShowFPOnCallpropertyofaVIandtheCloseFPAfterCallproperty.YoucannotusethismethodtorunaVIthatisalreadyreservedforexecutionbyanotherVI.

axprop.chm::/ShowFPOnCall.html

axprop.chm::/CloseFPAfterCall.html

Syntaxobject.Run([async])

ParametersName Type Descriptionasync Boolean IfTRUE,youdonotneedtowaitfortheVItofinish

running.ThedefaultisFALSE.

ReturnValuenone

SaveForPreviousMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SavesacopyoftheVIthatisreadablebyLabVIEWversion8.0andlater.

Syntaxobject.SaveForPrevious(viPath,[warnings])

ParametersName Type DescriptionviPath String PathtowhereyouwanttosavetheVI.warnings String Returnsanywarningsthatoccurredwhilesavingthe

VI.

ReturnValuenone

SaveInstrumentMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SavesaVIandsynchronizestheVIwiththeeditedversioninotherapplicationinstancesbeforesaving.

Syntaxobject.SaveInstrument([viPath],[saveACopy],[withoutDiagram])

ParametersName Type DescriptionviPath String PathoftheVIfile.Thedefaultisthecurrent

location.saveACopy Boolean IndicateswhethertosaveacopyoftheVIto

anotherfile.withoutDiagram Boolean IndicateswhethertosavetheVIwithoutthe

blockdiagram.

ReturnValuenone

SaveRunTimeMenuMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SavestheLabVIEWrun-timemenutoafilespecifiedbyfilePath.ThismethodworksonlywhentheVIisrunning.Itsavesonlymenuitemswithvalidtags.

Syntaxobject.SaveRunTimeMenu(filePath)

ParametersName Type DescriptionfilePath String Pathtowhereyouwanttosavetherun-timemenu.

ReturnValuenone

SetControlValueMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetsthevalueofanamedLabVIEWcontrolorindicator.

Syntaxobject.SetControlValue(controlName,value)

ParametersName Type DescriptioncontrolName String Nameofthefrontpanelcontrol.value variant Newvalueofthefrontpanelcontrol.Thisvalue

canbenumeric,Boolean,string,orarray.AclusterinLabVIEWisrepresentedasanarrayofvariantsinActiveX.

ReturnValuenone

SetLockStateMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetsthelockstateofaVI.IfInteractiveisFALSE(default),youcanusePasswordtounlockapassword-protectedVIorsetthepasswordofanunprotectedVI.IfInteractiveisTRUE,LabVIEWignoresPasswordanddisplaysadialogboxthatpromptsyoutochangethelockstate.

Syntaxobject.SetLockState(lockState,[Interactive],[Password],[putInCache])

ParametersName Type DescriptionlockState VILockStateEnum Lockstate.Interactive Boolean Specifieswhethertodisplayadialog

boxthatpromptsyoutochangethelockstate.ThedefaultisFALSE.

Password String IflockStateisPassword-protected,Passwordisthenewpassword.IfyouarechanginglockStatefromPassword-protected,Passwordistheoldpassword.Thedefaultisanemptystring.

putInCache Boolean IflockStateisPassword-protected,putinCachespecifieswhethertoplacethenewpasswordinthecache.ThedefaultisFALSE.

ReturnValuenone

SetVIIconMethodInstalledWith:BasePackageClass:VIMethods(ActiveX)SetstheimageofaVIiconfromafile.

Syntaxobject.SetVIIcon(imageFile)

ParametersName Type DescriptionimageFile String PathtotheimageyouwanttousefortheVIicon.

ReturnValuenone

VIProperties(ActiveX)InstalledWith:BasePackageAVirtualInstrumentobjectexportspropertiesthataffectagivenVI.AVirtualInstrumentobjectisinstantiatedbyinvokingtheGetVIReferencemethodontheApplicationobject.Inthefollowingtopics,anasterisk(*)attheendofadatatypenameindicatesthatthepropertyisapointer.Propertyparametersdenotedby[]areoptionalforthatproperty.RefertoActiveXEnumerationsformoreinformationaboutenumerationsusedinvariousproperties.

Property DescriptionAllowDebugging IfTRUE,youcanusedebuggingtools

ontheVI.SetthispropertytoFALSEtoreducememoryrequirementsandtoimproveperformanceslightlyfortheVI.Details

BDModificationBitSet IndicateswhetherchangesweremadetotheblockdiagramsincetheVIwassavedoropened,dependingonwhichwaslast.Ifthevalueiszero,nochangesweremade.Ifthevalueisnonzero,changesweremade.Thispropertyisreadonly.Details

BDSize SizeoftheLabVIEWblockdiagraminbytes.Thispropertyisreadonly.Details

Callees ReturnsalistofallthesubVIsorcalleesinaVI.ThispropertyexcludesanysubVIsorcalleesfromthecalleeslistiftheyarelocatedinanunusedcaseofacasestructure.Thispropertyisreadonly.Details

Callers ReturnsalistofalltheloadedVIsthatcallthereferencedVI.Thispropertyisreadonly.Details

axprop.chm::/GetVIReference.html

CloneName NameofthecloneVI.ReturnsanerroriftheVIisnotaclone.Details

CloseFPAfterCall IndicateswhethertoclosetheLabVIEWfrontpanelaftertheVIruns.Details

CodeSize AmountofmemoryusedforVIcodeinbytes.Thispropertyisreadonly.Details

DataSize Amountofmemoryallocatedfordatainbytes.YoucannotreadthispropertyiftheVIisrunning.Thispropertyisreadonly.Details

Description DescriptionoftheVIthatappearsintheLabVIEWContextHelpwindowwhenyoumovethecursorovertheVIiconandinVIdocumentationyougenerate.Details

EditMode IfTRUE,theVIopensineditmode.IfFALSE,theVIopensinrunmode,andthetitlebar,menubar,andtoolbardonotappear.Details

ExecPriority IndicatesthepriorityoftheVIwhenitrunsinparallelwithothertasks.Details

ExecState IndicatestheexecutionstateoftheVI.Details

ExpandWhenDroppedAsSubVI ExpandstoshowterminalswhendroppedasasubVI.Details

FPAllowRTPopup IndicateswhethertodisplayshortcutmenusforLabVIEWfrontpanelobjectswhiletheVIruns.Ifyoudonotdisplaydefaultrun-timeshortcutmenus,youcancontinuetoincludecustomizedshortcutmenus.Details

FPBehavior SetsthebehavioroftheLabVIEW

frontpanelwindow.Validvaluesinclude0(Invalid),1(Default),2(Floating),3(Floating/Auto-Hide),and4(Modal).Details

FPHiliteReturnButton IndicateswhethertohighlightBooleancontrolsthathaveashortcutkeyof<Enter>.Details

FPKeepWinProps IndicateswhethertheLabVIEWfrontpanelwindowadjustsitssizeinproportionwithachangeinmonitorresolution.Thewindowchangessizesoitcoversthesamepercentageofthescreenthatitcoveredatitsoriginalresolution.Details

FPMinimizable IndicateswhethertheusercanminimizetheLabVIEWfrontpanelwindowwhiletheVIruns.Details

FPModificationBitSet IndicateswhetherchangesweremadetotheLabVIEWfrontpanelsincetheVIwassaved.Ifthevalueiszero,nochangeswheremade.Ifthevalueisnonzero,changesweremade.Details

FPMonitor ThemonitoronwhichtheLabVIEWfrontpanelwindowappears,ifyouhavemultiplemonitors.Thevalue0istheprimarymonitor.Details

FPResizable IndicateswhethertheusercanresizetheLabVIEWfrontpanelwindowwhiletheVIruns.Details

FPRunTransparently SetstheVItoruntransparently.Details

FPShowMenuBar IndicateswhethertodisplaythemenubarontheLabVIEWfrontpanelwhiletheVIruns.Details

FPSize SizeoftheLabVIEWfrontpanelinbytes.Thispropertyisreadonly.

DetailsFPState CurrentstateoftheLabVIEWfront

panelwindow.Validvaluesinclude0(Invalid),1(Standard),2(Closed),3(Hidden),4(Minimized),and5(Maximized).AstateofStandardorMaximizedindicatesthatthefrontpanelwindowisvisibletotheuser.Ifyouattempttosetthispropertyforafrontpanelwindowthatisnotopen,thepropertyreturnsanerror.Details

FPTitleBarVisible IndicateswhethertodisplayatitlebarontheLabVIEWfrontpanelwhiletheVIruns.Details

FPTransparency SetsthewindowtransparencyleveloftheVI.Theleveloftransparencyisapercentagewhere0isopaqueand100isinvisible.Thispropertyreturnsanerrorifyouspecifyavalueoutsidetherangeof0to100.IfyousetFPRunTransparentlytoFalse,changingthispropertyhasnoeffect.Details

FPWinBounds Thefourelementsintheclusterarethetop,left,bottom,andrightvaluesoftheLabVIEWfrontpanelwindow,whichincludestheinteriorregion,scrollbars,titlebar,menubar,andtoolbar.Theyareinglobalscreencoordinates,thatis,thenumbersrefertocoordinateswithinacomputermonitor'sscreen(ratherthananopenwindow).YoucansetthispropertyonlyforVIswithopenfrontpanels.IfyoudonotwanttheVIforwhichyouwanttosetthispropertytoappeartousers,usetheHiddenvalueofthe

axprop.chm::/VI_FPRunTransparently.html

FPStateEnumdatatypefortheFPStatepropertytohidethefrontpaneloftheVI.Details

FPWinClosable IndicateswhethertheclosebuttonintheLabVIEWtitlebarisdisabledandtheCloseitemintheLabVIEWFilemenuisdisabled.Details

FPWinCustomTitle IndicateswhethertheVIhasacustomtitlestring.WriteFALSEtoremovethecustomtitlestring.Details

FPWinIsFrontMost WritingTRUEtothisvaluebringsthefrontpaneltothefront.ThispropertyappliesonlyintheapplicationinstanceofthecallingVI.WritingFALSEtothisvaluehasnoeffect.Ifyoureadthisproperty,itindicateswhetherthefrontpanelwindowisthefrontwindow(ignoringfloatingwindows).Details

FPWinOpen NationalInstrumentsrecommendsyouusetheOpenFrontPanelmethodinsteadofthisproperty.Details

FPWinPanelBounds Thefourelementsintheclusterarethetop,left,bottom,andrightvaluesoftheinteriorportionoftheLabVIEWfrontpanel,notincludingthescrollbars,titlebar,menubar,andtoolbar.Theclusterelementsareinglobalscreencoordinates,thatis,thenumbersrefertocoordinateswithinacomputermonitor'sscreen(ratherthananopenwindow).YoucansetthispropertyonlyforVIswithopenfrontpanels.IfyoudonotwanttheVIforwhichyouwanttosetthispropertytoappeartousers,usetheHiddenvalueoftheFPStateEnumdatatypefortheFPStatepropertytohidethefront



paneloftheVI.Details

FPWinTitle StringthatappearsintheLabVIEWtitlebar.ThisstringdoesnothavetomatchtheVIfilename.Details

HelpDocumentPath PathtoanHTMLfile(.htmor.html)orcompiledhelpfile(.chmor.hlp)towhichtheVIislinked.Ifthepathistoacompiledhelpfile,usetheHelpDocumentTagpropertytodeterminethespecifictopicinthathelpfile.Details

HelpDocumentTag IndexkeywordorHTMLfilenameforatopicinthecompiledhelpfiletowhichtheVIislinked.TolinktoabookmarkwithinanHTMLfile,add#followedbythenameofthebookmarktotheendofthefilename.UsethispropertyonlywhenHelpDocumentPathisapathtoacompiledhelpfile(.chmor.hlp).For.chmfiles,thispropertycanbeanHTMLfilenameorindexkeyword.For.hlpfiles,thispropertycanbeanindexkeyword.Details

HistAddCommentsAtSave IndicateswhethertoaddacommenttotheVIrevisionhistoryeverytimetheVIissaved.Details

HistoryText ReturnsallthetextthatwasaddedtotheVIrevisionhistory.Thispropertyisreadonly.Details

HistPromptAtClose IndicateswhethertopromptforaVIrevisionhistorycommentwhentheVIcloses.Details

HistPromptForCommentsAtSave IndicateswhethertopromptforaVIrevisionhistorycommentwhentheVIissaved.Details

axprop.chm::/HelpDocumentTag.html

axprop.chm::/HelpDocumentPath.html

HistRecordAppComments IndicateswhethertoaddcommentstotheVIrevisionhistorywhencertaineventsoccur,suchasconversiontoanewversionofLabVIEW,subVIchanges,andchangestothenameorpathoftheVI.Details

HistUseDefaults Indicateswhethertousetheglobaldefaulthistoryortousethevaluesenteredinotherhistoryproperties.Details

IsCloneVI ReturnsTRUEiftheVIisacloneVI.Details

IsProbe ReturnsTRUEiftheVIisrunningasaprobeandtheprobeVIisopen.Details

IsReentrant IndicateswhetheraVIcanbereentrant.Details

Library ReturnsthenameoftheLabVIEWprojectlibrary,XControl,orLabVIEWclassthatownstheVI.Ifnolibrary,XControl,orclassownstheVI,thepropertyreturnsNULL.Details

LogAtFinish IndicateswhethertowriteLabVIEWfrontpanelvaluestoadatalogfileaftertheVIruns.Details

LogFilePath PathofthedatalogfileinwhichLabVIEWfrontpaneldataandatimestamparewritten.Details

Name NameoftheVIfile.YoucanwritethispropertyonlyiftheVIhasnotbeensavedtodisk.IfaLabVIEWprojectlibraryownstheVI,thispropertyreturnsthequalifiednameoftheVI,whichincludestheprojectlibraryfilename.Details

OwningApp ReturnsareferencetotheApplication

thatownsthisVI.Closethisreferencewhenyouarefinishedusingit.Details

Path PathtotheVIfile.Thispropertyisreadonly.Details

PreferredExecSystem IndicatestheexecutionsysteminwhichtheVIruns.Details

PrintHeaderDatePrint IfTRUE,LabVIEWincludesthedateprintedintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.Details

PrintHeaderModifyDate IfTRUE,LabVIEWincludesthelastmodifieddateintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.Details

PrintHeaderPageNumber IfTRUE,LabVIEWincludesthepagenumberintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.Details

PrintHeaderVIIcon IfTRUE,LabVIEWincludestheVIiconintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.Details

PrintHeaderVIName IfTRUE,LabVIEWincludestheVInameintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.Details

PrintingBDScaling IfTRUE,LabVIEWscalestheblockdiagramtofitontheprintedpage.Details

PrintingFPScaling IfTRUE,LabVIEWscalesthefront

axprop.chm::/VI_PrintPage_HeadersAX.html





paneltofitontheprintedpage.DetailsPrintingHeaders IfTRUE,LabVIEWprintsheadersfor

theVI.UsethePrintHeaderpropertiesinthisclasstocustomizethecontentsoftheheaders.Details

PrintingHeaderVIPath IfTRUE,LabVIEWincludestheVIpathintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.Details

PrintingOrientation GetsorsetsthepageorientationtousewhenprintingtheVI.Details

PrintLogFileAtFinish IndicateswhethertoprinttheLabVIEWfrontpanelaftertheVIruns.Details

PrintMargins GetsorsetsthepagemarginstousewhenprintingtheVIininchesorcentimeters.Details

ReentrancyType IndicatesthetypeofreentrancyLabVIEWusesforareentrantVI.ThispropertyissimilartooptionsontheExecutionPropertiespageoftheVIPropertiesdialogbox.Details

RevisionNumber CurrentrevisionnumberoftheVI.Details

RunOnOpen IndicateswhethertoruntheVIwhenitopens.Details

RunTimeMenuPath Whenread,thispropertyreturnstherun-timemenupathoftheVI.Whenwritten,thispropertyupdatestherun-timemenupathoftheVI.IftheVIisrunningwhenyouwritethisproperty,itupdatesthemenuwithdatafromthenewpath.Details

ShowFPOnCall Indicateswhethertoshowthe


LabVIEWfrontpanelwhentheVIiscalled.Details

ShowFPOnLoad IndicateswhethertoshowtheLabVIEWfrontpanelwhentheVIisloaded.Details

SuspendOnCall IndicateswhethertheVIshouldbesuspendedwhenitiscalledasasubVI.UsethispropertycarefullywithreentrantVIs.Details

TBShowAbortButton IndicateswhethertodisplaytheAbortExecutionbuttonontheLabVIEWtoolbarwhiletheVIruns.Details

TBShowFreeRunButton IndicateswhethertodisplaytheRunContinuouslybuttonontheLabVIEWtoolbarwhiletheVIruns.Details

TBShowRunButton IndicateswhethertodisplaytheRunbuttonontheLabVIEWtoolbarwhiletheVIruns.Details

TBVisible IndicateswhethertodisplaytheLabVIEWtoolbarwhiletheVIruns.Details

VIModificationBitSet2 IndicateswhetherchangesweremadetotheVIsincetheVIwaslastsaved.Ifthevalueiszero,nochangeshavebeenmade.Ifthevalueisnonzero,changeshavebeenmade.Thispropertyisreadonly.Details

VIType IndicatesthetypeoftheVI.Details

AllowDebuggingPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,youcanusedebuggingtoolsontheVI.SetthispropertytoFALSEtoreducememoryrequirementsandtoimproveperformanceslightlyfortheVI.YoucannotdebugareentrantVI.

NoteWritingthispropertycausestheVItoberecompiled.WritingTRUEcausesextracodeanddatatobegeneratedfortheVI.ThiscodeanddataenablesLabVIEWtosetbreakpointsandsingle-stepthroughtheVI.WritingFALSEremovesthiscodeanddata,reducingthetotalsizeoftheVI.

Syntaxobject.AllowDebugging

DataTypeBoolean

BDModificationBitSetPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhetherchangesweremadetotheblockdiagramsincetheVIwassavedoropened,dependingonwhichwaslast.Ifthevalueiszero,nochangesweremade.Ifthevalueisnonzero,changesweremade.Thispropertyisreadonly.

Syntaxobject.BDModificationBitSet

DataTypelong

BDSizePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)SizeoftheLabVIEWblockdiagraminbytes.Thispropertyisreadonly.

Syntaxobject.BDSize

DataTypelong

CalleesPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ReturnsalistofallthesubVIsorcalleesinaVI.ThispropertyexcludesanysubVIsorcalleesfromthecalleeslistiftheyarelocatedinanunusedcaseofacasestructure.Thispropertyisreadonly.

Syntaxobject.Callees


CallersPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ReturnsalistofalltheloadedVIsthatcallthereferencedVI.Thispropertyisreadonly.

Syntaxobject.Callers


CloneNamePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)NameofthecloneVI.ReturnsanerroriftheVIisnotaclone.

Syntaxobject.CloneName

DataTypestring

CloseFPAfterCallPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertoclosetheLabVIEWfrontpanelaftertheVIruns.

Syntaxobject.CloseFPAfterCall

DataTypeBoolean

CodeSizePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)AmountofmemoryusedforVIcodeinbytes.Thispropertyisreadonly.

Syntaxobject.CodeSize

DataTypelong

DataSizePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)Amountofmemoryallocatedfordatainbytes.YoucannotreadthispropertyiftheVIisrunning.Thispropertyisreadonly.

Syntaxobject.DataSize

DataTypelong

DescriptionPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)DescriptionoftheVIthatappearsintheLabVIEWContextHelpwindowwhenyoumovethecursorovertheVIiconandinVIdocumentationyougenerate.YoucanformatthetextinthedescriptiontoappearboldintheContextHelpwindow.


DataTypeString

EditModePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,theVIopensineditmode.IfFALSE,theVIopensinrunmode,andthetitlebar,menubar,andtoolbardonotappear.Towritethisproperty,youmustcallitbeforeyouopenthefrontpaneloftheVI.

Syntaxobject.EditMode

DataTypeBoolean

ExecPriorityPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicatesthepriorityoftheVIwhenitrunsinparallelwithothertasks.

Syntaxobject.ExecPriority

DataTypeVIPriorityEnum

ExecStatePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicatestheexecutionstateoftheVI.

Syntaxobject.ExecState

DataTypeExecStateEnum

ExpandWhenDroppedAsSubVIPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ExpandstoshowterminalswhendroppedasasubVI.

Syntaxobject.ExpandWhenDroppedAsSubVI

DataTypeBoolean

FPAllowRTPopupPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertodisplayshortcutmenusforLabVIEWfrontpanelobjectswhiletheVIruns.Ifyoudonotdisplaydefaultrun-timeshortcutmenus,youcancontinuetoincludecustomizedshortcutmenus.

Syntaxobject.FPAllowRTPopup

DataTypeBoolean

FPBehaviorPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)SetsthebehavioroftheLabVIEWfrontpanelwindow.Validvaluesinclude0(Invalid),1(Default),2(Floating),3(Floating/Auto-Hide),and4(Modal).

Syntaxobject.FPBehavior

DataTypeVIFPBehaviorEnum

FPHiliteReturnButtonPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertohighlightBooleancontrolsthathaveashortcutkeyof<Enter>.

Syntaxobject.FPHiliteReturnButton

DataTypeBoolean

FPKeepWinPropsPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertheLabVIEWfrontpanelwindowadjustsitssizeinproportionwithachangeinmonitorresolution.Thewindowchangessizesoitcoversthesamepercentageofthescreenthatitcoveredatitsoriginalresolution.

Syntaxobject.FPKeepWinProps

DataTypeBoolean

FPMinimizablePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertheusercanminimizetheLabVIEWfrontpanelwindowwhiletheVIruns.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonlyandalwaysreturnsavalueofFALSE.ThispropertyissimilartotheAllowusertominimizewindowcheckboxintheLabVIEWCustomizeWindowAppearancedialogbox.

Syntaxobject.FPMinimizable

DataTypeBoolean

FPModificationBitSetPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhetherchangesweremadetotheLabVIEWfrontpanelsincetheVIwassaved.Ifthevalueiszero,nochangeswheremade.Ifthevalueisnonzero,changesweremade.

Syntaxobject.FPModificationBitSet

DataTypelong

FPMonitorPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ThemonitoronwhichtheLabVIEWfrontpanelwindowappears,ifyouhavemultiplemonitors.Thevalue0istheprimarymonitor.

Syntaxobject.FPMonitor

DataTypeshort

FPResizablePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertheusercanresizetheLabVIEWfrontpanelwindowwhiletheVIruns.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonlyandalwaysreturnsavalueofFALSE.ThispropertyissimilartotheAllowusertoresizewindowcheckboxintheLabVIEWCustomizeWindowAppearancedialogbox.

Syntaxobject.FPResizable

DataTypeBoolean

FPRunTransparentlyPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)SetstheVItoruntransparently.

Syntaxobject.FPRunTransparently

DataTypeBoolean

FPShowMenuBarPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertodisplaythemenubarontheLabVIEWfrontpanelwhiletheVIruns.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonlyandalwaysreturnsavalueofFALSE.

Syntaxobject.FPShowMenuBar

DataTypeBoolean

FPSizePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)SizeoftheLabVIEWfrontpanelinbytes.Thispropertyisreadonly.ThispropertyissimilartotheFrontPanelObjectsoptionontheMemoryUsagepageoftheLabVIEWVIPropertiesdialogbox.

Syntaxobject.FPSize

DataTypelong

FPStatePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)CurrentstateoftheLabVIEWfrontpanelwindow.Validvaluesinclude0(Invalid),1(Standard),2(Closed),3(Hidden),4(Minimized),and5(Maximized).AstateofStandardorMaximizedindicatesthatthefrontpanelwindowisvisibletotheuser.Ifyouattempttosetthispropertyforafrontpanelwindowthatisnotopen,thepropertyreturnsanerror.

Syntaxobject.FPState

DataTypeFPStateEnum

FPTitleBarVisiblePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertodisplayatitlebarontheLabVIEWfrontpanelwhiletheVIruns.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonlyandalwaysreturnsavalueofFALSE.ThispropertyissimilartotheWindowhastitlebaroptionontheLabVIEWCustomizeWindowAppearancedialogbox.

Syntaxobject.FPTitleBarVisible

DataTypeBoolean

FPTransparencyPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)SetsthewindowtransparencyleveloftheVI.Theleveloftransparencyisapercentagewhere0isopaqueand100isinvisible.Thispropertyreturnsanerrorifyouspecifyavalueoutsidetherangeof0to100.IfyousetFPRunTransparentlytoFalse,changingthispropertyhasnoeffect.

axprop.chm::/VI_FPRunTransparently.html

Syntaxobject.FPTransparency

DataTypechar

FPWinBoundsPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)Thefourelementsintheclusterarethetop,left,bottom,andrightvaluesoftheLabVIEWfrontpanelwindow,whichincludestheinteriorregion,scrollbars,titlebar,menubar,andtoolbar.Theyareinglobalscreencoordinates,thatis,thenumbersrefertocoordinateswithinacomputermonitor'sscreen(ratherthananopenwindow).YoucansetthispropertyonlyforVIswithopenfrontpanels.IfyoudonotwanttheVIforwhichyouwanttosetthispropertytoappeartousers,usetheHiddenvalueoftheFPStateEnumdatatypefortheFPStatepropertytohidethefrontpaneloftheVI.Whenyoureadthisproperty,LabVIEWreturnsthewindowboundsoftheVI.IfthefrontpaneloftheVIisnotopen,LabVIEWreturnsthewindowboundsoftheVIinthepositionitwaslastsaved.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonly.


Syntaxobject.FPWinBounds

DataTypeArrayofshortvariants(fourelements)

FPWinClosablePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertheclosebuttonintheLabVIEWtitlebarisdisabledandtheCloseitemintheLabVIEWFilemenuisdisabled.ThispropertypreventsusersfromclosingaVIduringexecution.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonlyandalwaysreturnsavalueofFALSE.

Syntaxobject.FPWinClosable

DataTypeBoolean

FPWinCustomTitlePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertheVIhasacustomtitlestring.WriteFALSEtoremovethecustomtitlestring.

Syntaxobject.FPWinCustomTitle

DataTypeBoolean

FPWinIsFrontMostPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)WritingTRUEtothisvaluebringsthefrontpaneltothefront.ThispropertyappliesonlyintheapplicationinstanceofthecallingVI.WritingFALSEtothisvaluehasnoeffect.Ifyoureadthisproperty,itindicateswhetherthefrontpanelwindowisthefrontwindow(ignoringfloatingwindows).

Syntaxobject.FPWinIsFrontMost

DataTypeBoolean

FPWinOpenPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)NationalInstrumentsrecommendsyouusetheOpenFrontPanelmethodinsteadofthisproperty.Readingthispropertyindicateswhetherthewindowcurrentlyisopen.Incertainsituations,thevaluereturnedbythispropertymightnotbeaccurate.Forexample,ifthewindowishiddenandyoureadthisproperty,thepropertyreturnsavalueofTRUE.However,thewindowisnotvisibletotheuser.UsetheOpenFrontPanelmethodtosetthestateofthewindowwhenyoudisplayit.UsetheFPStatepropertyformoreaccurateinformationaboutthecurrentstateofthewindow.UsetheCloseFrontPanelmethodtoclosethewindow.IfyousetthispropertytoTRUE,LabVIEWdisplaysthefrontpanelwindow.IfFALSE,LabVIEWclosesthewindow.IfnootherreferencestotheVIareopen,LabVIEWremovestheVIfrommemory.IfyousetthispropertytoFALSEinastand-aloneapplication,theapplicationstops.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonlyandalwaysreturnsavalueofTRUE.Ifyousettheboundariesofafrontpaneltobeoutsidetheboundariesofthescreen,LabVIEWignoresthosesettingswhenyouopenthefrontpanel.LabVIEWdisplaysaportionofthewindowtitlebarsoyoucandragthewindowtoanotherlocationonthescreen.UsetheFPWinPanelBoundspropertytosettheboundsofthefrontpanelwindow.

Syntaxobject.FPWinOpen

DataTypenone

FPWinPanelBoundsPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)Thefourelementsintheclusterarethetop,left,bottom,andrightvaluesoftheinteriorportionoftheLabVIEWfrontpanel,notincludingthescrollbars,titlebar,menubar,andtoolbar.Theclusterelementsareinglobalscreencoordinates,thatis,thenumbersrefertocoordinateswithinacomputermonitor'sscreen(ratherthananopenwindow).YoucansetthispropertyonlyforVIswithopenfrontpanels.IfyoudonotwanttheVIforwhichyouwanttosetthispropertytoappeartousers,usetheHiddenvalueoftheFPStateEnumdatatypefortheFPStatepropertytohidethefrontpaneloftheVI.Whenyoureadthisproperty,LabVIEWreturnsthefrontpanelboundsoftheVI.IfthefrontpaneloftheVIisnotopen,LabVIEWreturnsthefrontpanelboundsoftheVIinthepositionitwaslastsaved.IfyouloadtheVIinasubpanelcontrol,thispropertyisreadonly.


Syntaxobject.FPWinPanelBounds

DataType1Darrayofshorts(fourelements)byref

FPWinTitlePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)StringthatappearsintheLabVIEWtitlebar.ThisstringdoesnothavetomatchtheVIfilename.ThispropertyissimilartotheWindowtitleoptionontheWindowAppearancepageoftheLabVIEWVIPropertiesdialogbox.

Syntaxobject.FPWinTitle

DataTypeString

HelpDocumentPathPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)PathtoanHTMLfile(.htmor.html)orcompiledhelpfile(.chmor.hlp)towhichtheVIislinked.Ifthepathistoacompiledhelpfile,usetheHelpDocumentTagpropertytodeterminethespecifictopicinthathelpfile.ThispropertyissimilartotheHelpPathtextboxontheDocumentationpageoftheLabVIEWVIPropertiesdialogbox.

axprop.chm::/HelpDocumentTag.html

Syntaxobject.HelpDocumentPath

DataTypestring

HelpDocumentTagPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndexkeywordorHTMLfilenameforatopicinthecompiledhelpfiletowhichtheVIislinked.TolinktoabookmarkwithinanHTMLfile,add#followedbythenameofthebookmarktotheendofthefilename.UsethispropertyonlywhenHelpDocumentPathisapathtoacompiledhelpfile(.chmor.hlp).For.chmfiles,thispropertycanbeanHTMLfilenameorindexkeyword.For.hlpfiles,thispropertycanbeanindexkeyword.ThispropertyissimilartotheHelpTagtextboxontheDocumentationpageoftheLabVIEWVIPropertiesdialogbox.

axprop.chm::/HelpDocumentPath.html

Syntaxobject.HelpDocumentTag

DataTypestring

HistAddCommentsAtSavePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertoaddacommenttotheVIrevisionhistoryeverytimetheVIissaved.ThispropertyissimilartotheoptionsavailableintheLabVIEWHistorywindow.

Syntaxobject.HistAddCommentsAtSave

DataTypeBoolean

HistoryTextPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ReturnsallthetextthatwasaddedtotheVIrevisionhistory.Thispropertyisreadonly.

Syntaxobject.HistoryText

DataTypestring

HistPromptAtClosePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertopromptforaVIrevisionhistorycommentwhentheVIcloses.ThispropertyissimilartotheoptionsavailableintheLabVIEWHistorywindow.

Syntaxobject.HistPromptAtClose

DataTypeBoolean

HistPromptForCommentsAtSavePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertopromptforaVIrevisionhistorycommentwhentheVIissaved.ThispropertyissimilartotheoptionsavailableintheLabVIEWHistorywindow.

Syntaxobject.HistPromptForCommentsAtSave

DataTypeBoolean

HistRecordAppCommentsPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertoaddcommentstotheVIrevisionhistorywhencertaineventsoccur,suchasconversiontoanewversionofLabVIEW,subVIchanges,andchangestothenameorpathoftheVI.ThispropertyissimilartotheoptionsavailableintheLabVIEWRevisionHistoryPropertiespageoftheVIPropertiesdialogboxortheRevisionHistoryOptionspageoftheOptionsdialogbox.

Syntaxobject.HistRecordAppComments

DataTypeBoolean

HistUseDefaultsPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)Indicateswhethertousetheglobaldefaulthistoryortousethevaluesenteredinotherhistoryproperties.ThispropertyissimilartotheoptionsavailableintheRevisionHistorypageoftheLabVIEWVIPropertiesdialogbox.YoucanspecifytheglobaldefaulthistoryintheLabVIEWVIPropertiesdialogbox.

Syntaxobject.HistUseDefaults

DataTypeBoolean

IsCloneVIPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ReturnsTRUEiftheVIisacloneVI.

Syntaxobject.IsCloneVI

DataTypeBoolean

IsProbePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ReturnsTRUEiftheVIisrunningasaprobeandtheprobeVIisopen.

Syntaxobject.IsProbe

DataTypeBoolean

IsReentrantPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhetheraVIcanbereentrant.

Syntaxobject.IsReentrant

DataTypeBoolean

LibraryPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ReturnsthenameoftheLabVIEWprojectlibrary,XControl,orLabVIEWclassthatownstheVI.Ifnolibrary,XControl,orclassownstheVI,thepropertyreturnsNULL.

Syntaxobject.Library

DataTypeLibrary*

LogAtFinishPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertowriteLabVIEWfrontpanelvaluestoadatalogfileaftertheVIruns.

NoteIfyousetLogAtFinishwithouthavingsettheLogFilePathproperty,thenexttimethisVIfinishesexecuting,adialogboxappearspromptingyoutospecifythefilepath.

Syntaxobject.LogAtFinish

DataTypeBoolean

LogFilePathPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)PathofthedatalogfileinwhichLabVIEWfrontpaneldataandatimestamparewritten.

NoteUsethispropertyinconjunctionwiththeLogAtFinishproperty,whichspecifieswhethertologthedata.IfyousettheLogAtFinishpropertywithoutalsosettingthisproperty,adialogboxappearsatruntime,promptingyoutospecifyafilepath.

axprop.chm::/LogAtFinish.html

Syntaxobject.LogFilePath

DataTypestring

NamePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)NameoftheVIfile.YoucanwritethispropertyonlyiftheVIhasnotbeensavedtodisk.IfaLabVIEWprojectlibraryownstheVI,thispropertyreturnsthequalifiednameoftheVI,whichincludestheprojectlibraryfilename.

Syntaxobject.Name

DataTypestring

OwningAppPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)ReturnsareferencetotheApplicationthatownsthisVI.Closethisreferencewhenyouarefinishedusingit.

Syntaxobject.OwningApp

DataTypeApplication*

PathPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)PathtotheVIfile.Thispropertyisreadonly.

Syntaxobject.Path

DataTypestring

PreferredExecSystemPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicatestheexecutionsysteminwhichtheVIruns.

Syntaxobject.PreferredExecSystem

DataTypeVIExecSysEnum

PrintHeaderDatePrintPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWincludesthedateprintedintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.


Syntaxobject.PrintHeaderDatePrint

DataTypeBoolean

PrintHeaderModifyDatePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWincludesthelastmodifieddateintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.


Syntaxobject.PrintHeaderModifyDate

DataTypeBoolean

PrintHeaderPageNumberPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWincludesthepagenumberintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.


Syntaxobject.PrintHeaderPageNumber

DataTypeBoolean

PrintHeaderVIIconPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWincludestheVIiconintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.


Syntaxobject.PrintHeaderVIIcon

DataTypeBoolean

PrintHeaderVINamePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWincludestheVInameintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.


Syntaxobject.PrintHeaderVIName

DataTypeBoolean

PrintingBDScalingPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWscalestheblockdiagramtofitontheprintedpage.ThispropertyissimilartotheScaleprintedblockdiagramtofitpagecheckboxonthePrintOptionspageoftheLabVIEWVIPropertiesdialogbox.

Syntaxobject.PrintingBDScaling

DataTypeBoolean

PrintingFPScalingPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWscalesthefrontpaneltofitontheprintedpage.ThispropertyissimilartotheScaleprintedfrontpaneltofitpagecheckboxonthePrintOptionspageoftheLabVIEWVIPropertiesdialogbox.

Syntaxobject.PrintingFPScaling

DataTypeBoolean

PrintingHeadersPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWprintsheadersfortheVI.UsethePrintHeaderpropertiesinthisclasstocustomizethecontentsoftheheaders.ThispropertyissimilartothePrintheader(name,date,pagenumber)checkboxonthePrintOptionspageoftheLabVIEWVIPropertiesdialogbox.

Syntaxobject.PrintingHeaders

DataTypeBoolean

PrintingHeaderVIPathPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IfTRUE,LabVIEWincludestheVIpathintheheadersfortheVI.UsethePrintingHeaderspropertytosetwhetherLabVIEWprintstheheadersfortheVI.


Syntaxobject.PrintingHeaderVIPath

DataTypeBoolean

PrintingOrientationPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)GetsorsetsthepageorientationtousewhenprintingtheVI.

Syntaxobject.PrintingOrientation

DataTypePageOrientationEnum

PrintLogFileAtFinishPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertoprinttheLabVIEWfrontpanelaftertheVIruns.

Syntaxobject.PrintLogFileAtFinish

DataTypeBoolean

PrintMarginsPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)GetsorsetsthepagemarginstousewhenprintingtheVIininchesorcentimeters.ThispropertyissimilartotheUsecustompagemarginscheckboxonthePrintOptionspageoftheLabVIEWVIPropertiesdialogbox.

Syntaxobject.PrintMargins

DataTypePrintMarginsEnum

ReentrancyTypePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicatesthetypeofreentrancyLabVIEWusesforareentrantVI.ThispropertyissimilartooptionsontheExecutionPropertiespageoftheVIPropertiesdialogbox.Youcanselectfromthefollowingoptions:

Shareclonesbetweeninstances—AllocatesclonesofthereentrantVIon-demandforeachcalltothereentrantVI.DonotselectthisoptionifacloneVImustpreservestateinformationacrosscallsoriftheVIispartofanapplicationthatneedstominimizejitter.Preallocatecloneforeachinstance—AllocatesclonesofthereentrantVIforeachcalltothereentrantVI.ThisoptionisrecommendedforVIsthataretorunwithlowjitteronLabVIEWReal-Time.

Syntaxobject.ReentrancyType

DataTypekReentrancyTypeTD

RevisionNumberPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)CurrentrevisionnumberoftheVI.Whenwritingthisproperty,youcanwriteonlyavaluegreaterthanthecurrentrevisionnumber.Ifyouattempttowritearevisionnumberwhosevalueislessthanthecurrentrevisionnumber,thepropertyreturnsanerror.ThispropertyissimilartotheoptionsavailableintheRevisionHistorypageoftheLabVIEWVIPropertiesdialogbox.

Syntaxobject.RevisionNumber

DataTypelong

RunOnOpenPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertoruntheVIwhenitopens.

Syntaxobject.RunOnOpen

DataTypeBoolean

RunTimeMenuPathPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)Whenread,thispropertyreturnstherun-timemenupathoftheVI.Whenwritten,thispropertyupdatestherun-timemenupathoftheVI.IftheVIisrunningwhenyouwritethisproperty,itupdatesthemenuwithdatafromthenewpath.Usethispropertytoprogrammaticallyspecifythepathforarun-timemenu(.rtm)file.Thisisusefulifyouaredevelopingmultilingualapplicationsandyouwanttoswitchmenusforeachlanguageprogrammatically.

Syntaxobject.RunTimeMenuPath

DataTypestring

ShowFPOnCallPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertoshowtheLabVIEWfrontpanelwhentheVIiscalled.

Syntaxobject.ShowFPOnCall

DataTypeBoolean

ShowFPOnLoadPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertoshowtheLabVIEWfrontpanelwhentheVIisloaded.

Syntaxobject.ShowFPOnLoad

DataTypeBoolean

SuspendOnCallPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertheVIshouldbesuspendedwhenitiscalledasasubVI.UsethispropertycarefullywithreentrantVIs.

Syntaxobject.SuspendOnCall

DataTypeBoolean

TBShowAbortButtonPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertodisplaytheAbortExecutionbuttonontheLabVIEWtoolbarwhiletheVIruns.ThispropertyissimilartotheShowAbortbuttonoptionontheLabVIEWCustomizeWindowAppearancedialogbox.

Syntaxobject.TBShowAbortButton

DataTypeBoolean

TBShowFreeRunButtonPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertodisplaytheRunContinuouslybuttonontheLabVIEWtoolbarwhiletheVIruns.

Syntaxobject.TBShowFreeRunButton

DataTypeBoolean

TBShowRunButtonPropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertodisplaytheRunbuttonontheLabVIEWtoolbarwhiletheVIruns.

Syntaxobject.TBShowRunButton

DataTypeBoolean

TBVisiblePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhethertodisplaytheLabVIEWtoolbarwhiletheVIruns.

Syntaxobject.TBVisible

DataTypeBoolean

VIModificationBitSet2PropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicateswhetherchangesweremadetotheVIsincetheVIwaslastsaved.Ifthevalueiszero,nochangeshavebeenmade.Ifthevalueisnonzero,changeshavebeenmade.Thispropertyisreadonly.

Syntaxobject.VIModificationBitSet2

DataTypehyper

VITypePropertyInstalledWith:BasePackageClass:VIProperties(ActiveX)IndicatesthetypeoftheVI.

Syntaxobject.VIType

DataTypeVITypeEnum

PageOrientationEnumIndicatesthepageorientationwhenLabVIEWprintstheVI.

Name Value DescriptionPortrait 0 Printsthereportsotheshortedgeofthepaperisthe

topofthepage.Landscape 1 Printsthereportsothelongedgeofthepaperisthe

topofthepage.RotatedPortrait

2 Rotatesthepaper90degreescounterclockwiseandprintsthereportusingaportraitorientation.

RotatedLandscape

3 Rotatesthepaper90degreescounterclockwiseandprintsthereportusingalandscapeorientation.

PrintMethodsEnumIndicateshowLabVIEWprintsthedata.

Name Value DescriptionStandard 0 TranslatestheVIprintdata(frontpanel,block

diagram,icon,andsoon)andsendsittotheprinterusingthestandardoperatingsystemdrawingcommands.YoumustusethisoptioniftheprinterdoesnothavePostScriptsupportorifyouwanttheprinterdrivertohandlethePostScripttranslationinsteadofLabVIEW.

PostScript 1 TranslatestheVIprintdatainPostScript(.ps)formatandsendsittotheprinterasPostScriptcommands.DonotusethisoptioniftheprinterorprinterdriverdoesnotsupportPostScriptprinting.PostScriptprintoutsreproducetheimageofthescreen,includingpatterns,linestyles,andfonts,moreaccurately.

Bitmap 2 Createsabitmap,drawsalldataforthatpageintothebitmap,andsendsthebitmaptotheprinter.

VIFPBehaviorEnumIndicateshowLabVIEWdisplaysthefrontpanelwindow.

Name Value DescriptionInvalid 0 Ifyoureadthispropertyandanerroroccurs,the

propertyreturnsthisvalue.Ifyousetthepropertytothisvalue,thepropertyreturnsanerror.

Default 1 Thefrontpanelwindowisnotfloatingormodal.Floating 2 Thefrontpanelwindowstaysontopofallother

non-modalLabVIEWwindows.TheJust-In-TimeAdvicewindowisanexampleofafloatingwindow.

Floating/Auto-Hide

3 ThefrontpanelwindowisfloatingandwhenyouswitchfromLabVIEWtoanotherapplication,thewindowdoesnotappear.

Modal 4 ThefrontpanelwindowstaysontopofallotherLabVIEWwindowsuntilyouclosethewindoworopenanothermodalwindow.