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)

[GuidAttribute("E11C343A-7B4C-4C6A-9372-74C3C326FB11")]
public interface VCWizCtl : IVCWizCtlUI

NameDescription
System_CAPS_pubpropertyActiveXControls

Gets the ActiveX controls registered in the system.(Inherited from IVCWizCtlUI.)

System_CAPS_pubpropertydte

Gets the top-level extensibility object.(Inherited from IVCWizCtlUI.)

System_CAPS_pubpropertyFileTypeLibs[String]

Gets the type libraries in the specified file.(Inherited from IVCWizCtlUI.)

System_CAPS_pubpropertyParentKind

Gets the kind of context object.(Inherited from IVCWizCtlUI.)

System_CAPS_pubpropertyParentObject

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.(Inherited from IVCWizCtlUI.)

System_CAPS_pubpropertyProjectObject

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.(Inherited from IVCWizCtlUI.)

System_CAPS_pubpropertyResourceHelper

Gets the VCResourceHelper object.(Inherited from IVCWizCtlUI.)

System_CAPS_pubpropertyTypeLibs

Gets the type libraries registered in the system.(Inherited from IVCWizCtlUI.)

NameDescription
System_CAPS_pubmethodAddBuiltOutput(Object, Object)

Adds an item to the deployed project.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodAddDebugSymbols(Object, Object)

Adds debugging symbols to the deployed project.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodAddDeploymentContent(Object, Object)

Adds an item to the deployed project.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodAddSymbol(String, Object, Boolean)

Adds the specified symbol to the symbol table.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodCanCreateNewProjectAtLocation(Boolean, String, Boolean)

Indicates whether the new project can be created at the specified location.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodCommandHandlerExists(Object, Object)

Indicates whether the specified handler has been implemented.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodConvertAnsiToOEM(String)

Converts special extended ANSI characters to OEM characters.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodCppParseTypeString(String)

Parses a string containing the C++ variable declaration into its parts (type, name, and initial value).(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodCreateGuid()

Creates a globally unique identifier (GUID) for the specified object.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodCreateWebTargetFolder()

Creates a target folder for a Web project. (Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodDatabaseConnection(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodDoesFileExist(String)

Determines whether the specified file name exists.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodDoesFileOrDirectoryExist(String)

Determines whether the specified file or directory exists.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodFindSymbol(String)

Finds the specified symbol in the symbol table.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodFinish(Object, Object)

Called 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.)

System_CAPS_pubmethodFormatGuid(String, eFormat)

Formats the specified globally unique identifier (GUID).(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGenerateNextDefaultProjectName(String, String)

Generates a project name based on the specified base name.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetActiveXControlTypeLib(String)

Gets a string containing the type library for the ActiveX control.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetAppID()

Returns the application ID.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetClassCommandHandlerDesc(Object, String, String)

Gets the command handler object for the specified class and command name.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetCodePageFromLCID(UInt32)

Gets the appropriate code page based on the supplied language locale ID.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetCommandCount(Object)

Gets the number of commands in the specified list.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetCommandDocumentation(Object, Object)

Gets the description of the specified command or other text entry in the specified list box.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetCommandHandlerString(Object, Object)

Gets a command handler as a string.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetCommandName(Object, Object)

Gets the name of a command as a string.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetComputerName()

Returns the name of the computer as a string.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetConnectionString(Boolean)

Gets the information the database application requires to connect to a data source.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetConsumerClass(String, Boolean, Boolean, Boolean, Boolean, Boolean)

Returns a string containing the consumer class.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetDefaultWebTargetFolder(Object)

Returns the default target folder for the Web project.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetDialogControlsAndTypes(String)

Gets the controls and types from the specified dialog box.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetDialogIds()

Gets the IDs of the project's dialog boxes.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetDirectoryViaBrowseDlg(String, String)

Gets the specified directory by using the .(Inherited from IVCWizCtlUI.)5035B5BA-E0E7-4198-92EF-003109202A8E

System_CAPS_pubmethodGetExistingFileNameViaDlg(String, String, String, String)

(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetHostLocale()

Gets the locale of the wizard's user interface.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetInstalledLangs()

Gets the language locale IDs from the wizard's templates directory, indicating which language resources are available.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetLangAbbrevFromLCID(UInt32)

Gets the language abbreviation specified by the language locale ID.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetLangFromLCID(UInt32)

Gets the language based on the specified language locale ID.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetODBCConsumerClassDecl(Boolean, Boolean, String)

Gets the ODBC consumer class declaration.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetODBCConsumerClassImpl()

Gets the ODBC consumer class implementation.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetOpenFileNameViaDlg(String, String, String, String)

Gets the name of a file to open using a dialog box.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetPrimaryLangIdFromLCID(UInt32)

Gets the default language from the language locale ID.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetProcessName()

Gets the file name of the current process (devenv.exe).(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetRemoteMachine(Object, String)

For the specified deployment project, returns the name of a remote machine for the specified configuration.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetSubFolderByName(Object, String)

Gets a sub folder for web service deployment.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetSubLangIdFromLCID(UInt32)

Gets a string containing the language identified as the sub language from its language locale ID.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetSystemLCID()

Gets the default language locale ID from the system.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodGetURLViaDlg(String, String)

Get a URL using a dialog box.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodIsSymbolDisabled(String)

Returns whether a symbol is disabled.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodIsValidNumericValue(Object)

Determines whether a variant is a valid numeric value.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodIsValidProgID(Object)

Indicates whether the specified object's program identifier is valid.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodIsWebTierProject(Object)

Checks if the specified project is a Visual Studio .(Inherited from IVCWizCtlUI.)729e67d7-e91b-49e0-b1c1-186642ab6507

System_CAPS_pubmethodLoad(Object)

Initializes the specified document.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodNavigate(String, String)

Navigates to a page and frame.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodNavigateToCommandHandler(Object, Object, String)

Opens the text editor and places the cursor at the specified handler.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodNext(Object, Object, String, Boolean)

Optionally updates the symbols on the current page, and then navigates the user to the specified wizard page.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodOkCancelAlert(String)

Displays 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.)

System_CAPS_pubmethodOnHelp(String)

Called 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.)

System_CAPS_pubmethodPreShowWizard()

For future use.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodRemoveSymbol(String)

Removes the specified symbol from the symbol table.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodRenderTemplate(String, String, Boolean, Boolean)

Renders the template file for the wizard project.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodRenderTemplateToString(String)

Renders the wizard template file as a string.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodReportError(String, Boolean)

Displays an error to the user and gives the user the option to correct the error and continue using the wizard.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodResumeParsing()

Resumes parsing after a call to SuspendParsing(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodSelectDataSource()

Displays a dialog box that allows the user to select the data source to use in a consumer database application.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodSelectODBCDatabase()

Displays a dialog box that allows the user to select the ODBC database for an ODBC consumer application.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodSetDefaults(Object)

Sets the initial defaults for the wizard symbols.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodSetDeploymentAppMappings(Object, Object, String, String)

Registers an application with a web service.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodSetErrorInfo(String, UInt32, UInt32, String, String)

Sets error text for the specified item.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodSetRemoteMachine(Object, String)

Specifies the name of a computer (other than your computer) on which you want to debug an application.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodShowWiz()

Displays the wizard if it has a UI.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodSuspendParsing()

Suspends parsing in a wizard.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodValidateCLRIdentifier(String, Boolean)

Returns whether a name is a valid CLR identifier.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodValidateCSharpClass(String, String)

Not implemented.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodValidateCSharpFile(String)

Not Implemented.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodValidateCSharpIdentifier(String, Boolean)

Not implemented.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodValidateCSharpNamespace(String)

Not implemented.(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodWriteToTextFile(String, String, Boolean)

(Inherited from IVCWizCtlUI.)

System_CAPS_pubmethodYesNoAlert(String)

This 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.)

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++.

System_CAPS_noteNote

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

Return to top
Show: