Export (0) Print
Expand All

VCWizCtl Interface

Contains properties and methods used to programmatically manipulate custom wizards created for Visual C++ projects. Refer to IVCWizCtlUI for documentation.

Namespace:  Microsoft.VisualStudio.VsWizard
Assembly:  Microsoft.VisualStudio.VsWizard (in Microsoft.VisualStudio.VsWizard.dll)

'Declaration
<GuidAttribute("E11C343A-7B4C-4C6A-9372-74C3C326FB11")> _
Public Interface VCWizCtl _
	Inherits IVCWizCtlUI

The VCWizCtl type exposes the following members.

  NameDescription
Public propertyActiveXControlsGets the ActiveX controls registered in the system. (Inherited from IVCWizCtlUI.)
Public propertydteGets the top-level extensibility object. (Inherited from IVCWizCtlUI.)
Public propertyFileTypeLibsGets the type libraries in the specified file. (Inherited from IVCWizCtlUI.)
Public propertyParentKindGets the kind of context object. (Inherited from IVCWizCtlUI.)
Public propertyParentObjectInfrastructure. Microsoft Internal Use Only. (Inherited from IVCWizCtlUI.)
Public propertyProjectObjectInfrastructure. Microsoft Internal Use Only. (Inherited from IVCWizCtlUI.)
Public propertyResourceHelperGets the VCResourceHelper object. (Inherited from IVCWizCtlUI.)
Public propertyTypeLibsGets the type libraries registered in the system. (Inherited from IVCWizCtlUI.)
Top

  NameDescription
Public methodAddBuiltOutputAdds an item to the deployed project. (Inherited from IVCWizCtlUI.)
Public methodAddDebugSymbolsAdds debugging symbols to the deployed project. (Inherited from IVCWizCtlUI.)
Public methodAddDeploymentContentAdds an item to the deployed project. (Inherited from IVCWizCtlUI.)
Public methodAddSymbolAdds the specified symbol to the symbol table. (Inherited from IVCWizCtlUI.)
Public methodCanCreateNewProjectAtLocationIndicates whether the new project can be created at the specified location. (Inherited from IVCWizCtlUI.)
Public methodCommandHandlerExistsIndicates whether the specified handler has been implemented. (Inherited from IVCWizCtlUI.)
Public methodConvertAnsiToOEMConverts special extended ANSI characters to OEM characters. (Inherited from IVCWizCtlUI.)
Public methodCppParseTypeStringParses a string containing the C++ variable declaration into its parts (type, name, and initial value). (Inherited from IVCWizCtlUI.)
Public methodCreateGuidCreates a globally unique identifier (GUID) for the specified object. (Inherited from IVCWizCtlUI.)
Public methodCreateWebTargetFolderCreates a target folder for a Web project. (Inherited from IVCWizCtlUI.)
Public methodDatabaseConnectionInfrastructure. Microsoft Internal Use Only. (Inherited from IVCWizCtlUI.)
Public methodDoesFileExistDetermines whether the specified file name exists. (Inherited from IVCWizCtlUI.)
Public methodDoesFileOrDirectoryExistDetermines whether the specified file or directory exists. (Inherited from IVCWizCtlUI.)
Public methodFindSymbolFinds the specified symbol in the symbol table. (Inherited from IVCWizCtlUI.)
Public methodFinishCalled when the user clicks the OK or Cancel button in the wizard HTML to indicate that the user is finished with the wizard. (Inherited from IVCWizCtlUI.)
Public methodFormatGuidFormats the specified globally unique identifier (GUID). (Inherited from IVCWizCtlUI.)
Public methodGenerateNextDefaultProjectNameGenerates a project name based on the specified base name. (Inherited from IVCWizCtlUI.)
Public methodGetActiveXControlTypeLibGets a string containing the type library for the ActiveX control. (Inherited from IVCWizCtlUI.)
Public methodGetAppIDReturns the application ID. (Inherited from IVCWizCtlUI.)
Public methodGetClassCommandHandlerDescGets the command handler object for the specified class and command name. (Inherited from IVCWizCtlUI.)
Public methodGetCodePageFromLCIDGets the appropriate code page based on the supplied language locale ID. (Inherited from IVCWizCtlUI.)
Public methodGetCommandCountGets the number of commands in the specified list. (Inherited from IVCWizCtlUI.)
Public methodGetCommandDocumentationGets the description of the specified command or other text entry in the specified list box. (Inherited from IVCWizCtlUI.)
Public methodGetCommandHandlerStringGets a command handler as a string. (Inherited from IVCWizCtlUI.)
Public methodGetCommandNameGets the name of a command as a string. (Inherited from IVCWizCtlUI.)
Public methodGetComputerNameReturns the name of the computer as a string. (Inherited from IVCWizCtlUI.)
Public methodGetConnectionStringGets the information the database application requires to connect to a data source. (Inherited from IVCWizCtlUI.)
Public methodGetConsumerClassReturns a string containing the consumer class. (Inherited from IVCWizCtlUI.)
Public methodGetDefaultWebTargetFolderReturns the default target folder for the Web project. (Inherited from IVCWizCtlUI.)
Public methodGetDialogControlsAndTypesGets the controls and types from the specified dialog box. (Inherited from IVCWizCtlUI.)
Public methodGetDialogIdsGets the IDs of the project's dialog boxes. (Inherited from IVCWizCtlUI.)
Public methodGetDirectoryViaBrowseDlgGets the specified directory by using the Browse dialog box. (Inherited from IVCWizCtlUI.)
Public methodGetExistingFileNameViaDlg (Inherited from IVCWizCtlUI.)
Public methodGetHostLocaleGets the locale of the wizard's user interface. (Inherited from IVCWizCtlUI.)
Public methodGetInstalledLangsGets the language locale IDs from the wizard's templates directory, indicating which language resources are available. (Inherited from IVCWizCtlUI.)
Public methodGetLangAbbrevFromLCIDGets the language abbreviation specified by the language locale ID. (Inherited from IVCWizCtlUI.)
Public methodGetLangFromLCIDGets the language based on the specified language locale ID. (Inherited from IVCWizCtlUI.)
Public methodGetODBCConsumerClassDeclGets the ODBC consumer class declaration. (Inherited from IVCWizCtlUI.)
Public methodGetODBCConsumerClassImplGets the ODBC consumer class implementation. (Inherited from IVCWizCtlUI.)
Public methodGetOpenFileNameViaDlgGets the name of a file to open using a dialog box. (Inherited from IVCWizCtlUI.)
Public methodGetPrimaryLangIdFromLCIDGets the default language from the language locale ID. (Inherited from IVCWizCtlUI.)
Public methodGetProcessNameGets the file name of the current process (devenv.exe). (Inherited from IVCWizCtlUI.)
Public methodGetRemoteMachineFor the specified deployment project, returns the name of a remote machine for the specified configuration. (Inherited from IVCWizCtlUI.)
Public methodGetSubFolderByNameGets a sub folder for web service deployment. (Inherited from IVCWizCtlUI.)
Public methodGetSubLangIdFromLCIDGets a string containing the language identified as the sub language from its language locale ID. (Inherited from IVCWizCtlUI.)
Public methodGetSystemLCIDGets the default language locale ID from the system. (Inherited from IVCWizCtlUI.)
Public methodGetURLViaDlgGet a URL using a dialog box. (Inherited from IVCWizCtlUI.)
Public methodIsSymbolDisabledReturns whether a symbol is disabled. (Inherited from IVCWizCtlUI.)
Public methodIsValidNumericValueDetermines whether a variant is a valid numeric value. (Inherited from IVCWizCtlUI.)
Public methodIsValidProgIDIndicates whether the specified object's program identifier is valid. (Inherited from IVCWizCtlUI.)
Public methodIsWebTierProjectChecks if the specified project is a Visual Studio Deployment of a Web Setup Project. (Inherited from IVCWizCtlUI.)
Public methodLoadInitializes the specified document. (Inherited from IVCWizCtlUI.)
Public methodNavigateNavigates to a page and frame. (Inherited from IVCWizCtlUI.)
Public methodNavigateToCommandHandlerOpens the text editor and places the cursor at the specified handler. (Inherited from IVCWizCtlUI.)
Public methodNextOptionally updates the symbols on the current page, and then navigates the user to the specified wizard page. (Inherited from IVCWizCtlUI.)
Public methodOkCancelAlertDisplays an alert message to the wizard user, requiring the user to click OK to confirm a selected wizard option or Cancel to cancel that option. (Inherited from IVCWizCtlUI.)
Public methodOnHelpCalled by the wizard when the user clicks the Help button to display any HTML Help topics associated with the wizard HTML page. (Inherited from IVCWizCtlUI.)
Public methodPreShowWizardFor future use. (Inherited from IVCWizCtlUI.)
Public methodRemoveSymbolRemoves the specified symbol from the symbol table. (Inherited from IVCWizCtlUI.)
Public methodRenderTemplateRenders the template file for the wizard project. (Inherited from IVCWizCtlUI.)
Public methodRenderTemplateToStringRenders the wizard template file as a string. (Inherited from IVCWizCtlUI.)
Public methodReportErrorDisplays an error to the user and gives the user the option to correct the error and continue using the wizard. (Inherited from IVCWizCtlUI.)
Public methodResumeParsingResumes parsing after a call to SuspendParsing (Inherited from IVCWizCtlUI.)
Public methodSelectDataSourceDisplays a dialog box that allows the user to select the data source to use in a consumer database application. (Inherited from IVCWizCtlUI.)
Public methodSelectODBCDatabaseDisplays a dialog box that allows the user to select the ODBC database for an ODBC consumer application. (Inherited from IVCWizCtlUI.)
Public methodSetDefaultsSets the initial defaults for the wizard symbols. (Inherited from IVCWizCtlUI.)
Public methodSetDeploymentAppMappingsRegisters an application with a web service. (Inherited from IVCWizCtlUI.)
Public methodSetErrorInfoSets error text for the specified item. (Inherited from IVCWizCtlUI.)
Public methodSetRemoteMachineSpecifies the name of a computer (other than your computer) on which you want to debug an application. (Inherited from IVCWizCtlUI.)
Public methodShowWizDisplays the wizard if it has a UI. (Inherited from IVCWizCtlUI.)
Public methodSuspendParsingSuspends parsing in a wizard. (Inherited from IVCWizCtlUI.)
Public methodValidateCLRIdentifierReturns whether a name is a valid CLR identifier. (Inherited from IVCWizCtlUI.)
Public methodValidateCSharpClassNot implemented. (Inherited from IVCWizCtlUI.)
Public methodValidateCSharpFileNot Implemented. (Inherited from IVCWizCtlUI.)
Public methodValidateCSharpIdentifierNot implemented. (Inherited from IVCWizCtlUI.)
Public methodValidateCSharpNamespaceNot implemented. (Inherited from IVCWizCtlUI.)
Public methodWriteToTextFile (Inherited from IVCWizCtlUI.)
Public methodYesNoAlertThis method displays an alert message to the wizard user, requiring the user to click Yes to confirm a selected wizard option or No to cancel that option. (Inherited from IVCWizCtlUI.)
Top

VCWizCtl contains properties and methods used to programmatically manipulate Visual C++ wizard controls within the Visual C++ wizard architecture. You can call these properties and methods by using JScript or VBScript. The JScript File and HTML Files are the necessary parts of a Custom Wizard project.

However, the VCWizCtl object is not designed to be called from high-end programming languages such as Visual Basic, Visual C#, and Visual C++.

NoteNote

To access the VCWizCtl object from script, use wizard. To access the VCWizCtl object from HTML, use window.external.

Show:
© 2014 Microsoft