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)

Syntax

'Declaration
<GuidAttribute("E11C343A-7B4C-4C6A-9372-74C3C326FB11")> _
Public Interface VCWizCtl _
    Inherits IVCWizCtlUI
[GuidAttribute("E11C343A-7B4C-4C6A-9372-74C3C326FB11")]
public interface VCWizCtl : IVCWizCtlUI
[GuidAttribute(L"E11C343A-7B4C-4C6A-9372-74C3C326FB11")]
public interface class VCWizCtl : IVCWizCtlUI
[<GuidAttribute("E11C343A-7B4C-4C6A-9372-74C3C326FB11")>]
type VCWizCtl =  
    interface 
        interface IVCWizCtlUI 
    end
public interface VCWizCtl extends IVCWizCtlUI

The VCWizCtl type exposes the following members.

Properties

  Name Description
Public property ActiveXControls Gets the ActiveX controls registered in the system. (Inherited from IVCWizCtlUI.)
Public property dte Gets the top-level extensibility object. (Inherited from IVCWizCtlUI.)
Public property FileTypeLibs Gets the type libraries in the specified file. (Inherited from IVCWizCtlUI.)
Public property ParentKind Gets the kind of context object. (Inherited from IVCWizCtlUI.)
Public property ParentObject Infrastructure. Microsoft Internal Use Only. (Inherited from IVCWizCtlUI.)
Public property ProjectObject Infrastructure. Microsoft Internal Use Only. (Inherited from IVCWizCtlUI.)
Public property ResourceHelper Gets the VCResourceHelper object. (Inherited from IVCWizCtlUI.)
Public property TypeLibs Gets the type libraries registered in the system. (Inherited from IVCWizCtlUI.)

Top

Methods

  Name Description
Public method AddBuiltOutput Adds an item to the deployed project. (Inherited from IVCWizCtlUI.)
Public method AddDebugSymbols Adds debugging symbols to the deployed project. (Inherited from IVCWizCtlUI.)
Public method AddDeploymentContent Adds an item to the deployed project. (Inherited from IVCWizCtlUI.)
Public method AddSymbol Adds the specified symbol to the symbol table. (Inherited from IVCWizCtlUI.)
Public method CanCreateNewProjectAtLocation Indicates whether the new project can be created at the specified location. (Inherited from IVCWizCtlUI.)
Public method CommandHandlerExists Indicates whether the specified handler has been implemented. (Inherited from IVCWizCtlUI.)
Public method ConvertAnsiToOEM Converts special extended ANSI characters to OEM characters. (Inherited from IVCWizCtlUI.)
Public method CppParseTypeString Parses a string containing the C++ variable declaration into its parts (type, name, and initial value). (Inherited from IVCWizCtlUI.)
Public method CreateGuid Creates a globally unique identifier (GUID) for the specified object. (Inherited from IVCWizCtlUI.)
Public method CreateWebTargetFolder Creates a target folder for a Web project. (Inherited from IVCWizCtlUI.)
Public method DatabaseConnection Infrastructure. Microsoft Internal Use Only. (Inherited from IVCWizCtlUI.)
Public method DoesFileExist Determines whether the specified file name exists. (Inherited from IVCWizCtlUI.)
Public method DoesFileOrDirectoryExist Determines whether the specified file or directory exists. (Inherited from IVCWizCtlUI.)
Public method FindSymbol Finds the specified symbol in the symbol table. (Inherited from IVCWizCtlUI.)
Public method Finish 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.)
Public method FormatGuid Formats the specified globally unique identifier (GUID). (Inherited from IVCWizCtlUI.)
Public method GenerateNextDefaultProjectName Generates a project name based on the specified base name. (Inherited from IVCWizCtlUI.)
Public method GetActiveXControlTypeLib Gets a string containing the type library for the ActiveX control. (Inherited from IVCWizCtlUI.)
Public method GetAppID Returns the application ID. (Inherited from IVCWizCtlUI.)
Public method GetClassCommandHandlerDesc Gets the command handler object for the specified class and command name. (Inherited from IVCWizCtlUI.)
Public method GetCodePageFromLCID Gets the appropriate code page based on the supplied language locale ID. (Inherited from IVCWizCtlUI.)
Public method GetCommandCount Gets the number of commands in the specified list. (Inherited from IVCWizCtlUI.)
Public method GetCommandDocumentation Gets the description of the specified command or other text entry in the specified list box. (Inherited from IVCWizCtlUI.)
Public method GetCommandHandlerString Gets a command handler as a string. (Inherited from IVCWizCtlUI.)
Public method GetCommandName Gets the name of a command as a string. (Inherited from IVCWizCtlUI.)
Public method GetComputerName Returns the name of the computer as a string. (Inherited from IVCWizCtlUI.)
Public method GetConnectionString Gets the information the database application requires to connect to a data source. (Inherited from IVCWizCtlUI.)
Public method GetConsumerClass Returns a string containing the consumer class. (Inherited from IVCWizCtlUI.)
Public method GetDefaultWebTargetFolder Returns the default target folder for the Web project. (Inherited from IVCWizCtlUI.)
Public method GetDialogControlsAndTypes Gets the controls and types from the specified dialog box. (Inherited from IVCWizCtlUI.)
Public method GetDialogIds Gets the IDs of the project's dialog boxes. (Inherited from IVCWizCtlUI.)
Public method GetDirectoryViaBrowseDlg Gets the specified directory by using the Browse dialog box. (Inherited from IVCWizCtlUI.)
Public method GetExistingFileNameViaDlg (Inherited from IVCWizCtlUI.)
Public method GetHostLocale Gets the locale of the wizard's user interface. (Inherited from IVCWizCtlUI.)
Public method GetInstalledLangs Gets the language locale IDs from the wizard's templates directory, indicating which language resources are available. (Inherited from IVCWizCtlUI.)
Public method GetLangAbbrevFromLCID Gets the language abbreviation specified by the language locale ID. (Inherited from IVCWizCtlUI.)
Public method GetLangFromLCID Gets the language based on the specified language locale ID. (Inherited from IVCWizCtlUI.)
Public method GetODBCConsumerClassDecl Gets the ODBC consumer class declaration. (Inherited from IVCWizCtlUI.)
Public method GetODBCConsumerClassImpl Gets the ODBC consumer class implementation. (Inherited from IVCWizCtlUI.)
Public method GetOpenFileNameViaDlg Gets the name of a file to open using a dialog box. (Inherited from IVCWizCtlUI.)
Public method GetPrimaryLangIdFromLCID Gets the default language from the language locale ID. (Inherited from IVCWizCtlUI.)
Public method GetProcessName Gets the file name of the current process (devenv.exe). (Inherited from IVCWizCtlUI.)
Public method GetRemoteMachine For the specified deployment project, returns the name of a remote machine for the specified configuration. (Inherited from IVCWizCtlUI.)
Public method GetSubFolderByName Gets a sub folder for web service deployment. (Inherited from IVCWizCtlUI.)
Public method GetSubLangIdFromLCID Gets a string containing the language identified as the sub language from its language locale ID. (Inherited from IVCWizCtlUI.)
Public method GetSystemLCID Gets the default language locale ID from the system. (Inherited from IVCWizCtlUI.)
Public method GetURLViaDlg Get a URL using a dialog box. (Inherited from IVCWizCtlUI.)
Public method IsSymbolDisabled Returns whether a symbol is disabled. (Inherited from IVCWizCtlUI.)
Public method IsValidNumericValue Determines whether a variant is a valid numeric value. (Inherited from IVCWizCtlUI.)
Public method IsValidProgID Indicates whether the specified object's program identifier is valid. (Inherited from IVCWizCtlUI.)
Public method IsWebTierProject Checks if the specified project is a Visual Studio Deployment of a Web Setup Project. (Inherited from IVCWizCtlUI.)
Public method Load Initializes the specified document. (Inherited from IVCWizCtlUI.)
Public method Navigate Navigates to a page and frame. (Inherited from IVCWizCtlUI.)
Public method NavigateToCommandHandler Opens the text editor and places the cursor at the specified handler. (Inherited from IVCWizCtlUI.)
Public method Next Optionally updates the symbols on the current page, and then navigates the user to the specified wizard page. (Inherited from IVCWizCtlUI.)
Public method OkCancelAlert 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.)
Public method OnHelp 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.)
Public method PreShowWizard For future use. (Inherited from IVCWizCtlUI.)
Public method RemoveSymbol Removes the specified symbol from the symbol table. (Inherited from IVCWizCtlUI.)
Public method RenderTemplate Renders the template file for the wizard project. (Inherited from IVCWizCtlUI.)
Public method RenderTemplateToString Renders the wizard template file as a string. (Inherited from IVCWizCtlUI.)
Public method ReportError Displays an error to the user and gives the user the option to correct the error and continue using the wizard. (Inherited from IVCWizCtlUI.)
Public method ResumeParsing Resumes parsing after a call to SuspendParsing (Inherited from IVCWizCtlUI.)
Public method SelectDataSource Displays a dialog box that allows the user to select the data source to use in a consumer database application. (Inherited from IVCWizCtlUI.)
Public method SelectODBCDatabase Displays a dialog box that allows the user to select the ODBC database for an ODBC consumer application. (Inherited from IVCWizCtlUI.)
Public method SetDefaults Sets the initial defaults for the wizard symbols. (Inherited from IVCWizCtlUI.)
Public method SetDeploymentAppMappings Registers an application with a web service. (Inherited from IVCWizCtlUI.)
Public method SetErrorInfo Sets error text for the specified item. (Inherited from IVCWizCtlUI.)
Public method SetRemoteMachine Specifies the name of a computer (other than your computer) on which you want to debug an application. (Inherited from IVCWizCtlUI.)
Public method ShowWiz Displays the wizard if it has a UI. (Inherited from IVCWizCtlUI.)
Public method SuspendParsing Suspends parsing in a wizard. (Inherited from IVCWizCtlUI.)
Public method ValidateCLRIdentifier Returns whether a name is a valid CLR identifier. (Inherited from IVCWizCtlUI.)
Public method ValidateCSharpClass Not implemented. (Inherited from IVCWizCtlUI.)
Public method ValidateCSharpFile Not Implemented. (Inherited from IVCWizCtlUI.)
Public method ValidateCSharpIdentifier Not implemented. (Inherited from IVCWizCtlUI.)
Public method ValidateCSharpNamespace Not implemented. (Inherited from IVCWizCtlUI.)
Public method WriteToTextFile (Inherited from IVCWizCtlUI.)
Public method YesNoAlert 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.)

Top

Remarks

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

Note

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

See Also

Reference

Microsoft.VisualStudio.VsWizard Namespace