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