VCWizCtl Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains properties and methods used to programmatically manipulate custom wizards created for Visual C++ projects. Refer to IVCWizCtlUI for documentation.
public interface class VCWizCtl : Microsoft::VisualStudio::VsWizard::IVCWizCtlUIpublic interface class VCWizCtl : Microsoft::VisualStudio::VsWizard::IVCWizCtlUI__interface VCWizCtl : Microsoft::VisualStudio::VsWizard::IVCWizCtlUI[System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.VsWizard.VCWizCtlClass))]
[System.Runtime.InteropServices.Guid("ACCC8AC8-1D95-4E53-8F26-BFE3A21494D6")]
public interface VCWizCtl : Microsoft.VisualStudio.VsWizard.IVCWizCtlUI[<System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.VsWizard.VCWizCtlClass))>]
[<System.Runtime.InteropServices.Guid("ACCC8AC8-1D95-4E53-8F26-BFE3A21494D6")>]
type VCWizCtl = interface
interface IVCWizCtlUIPublic Interface VCWizCtl
Implements IVCWizCtlUI- Derived
- Attributes
- Implements
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.
Properties
| ActiveXControls |
Gets the ActiveX controls registered in the system. (Inherited from IVCWizCtlUI) |
| dte |
Gets the top-level extensibility object. (Inherited from IVCWizCtlUI) |
| FileTypeLibs[String] |
Gets the type libraries in the specified file. (Inherited from IVCWizCtlUI) |
| ParentKind |
Gets the kind of context object. (Inherited from IVCWizCtlUI) |
| ParentObject |
Microsoft Internal Use Only. (Inherited from IVCWizCtlUI) |
| ProjectObject |
Microsoft Internal Use Only. (Inherited from IVCWizCtlUI) |
| ResourceHelper |
Gets the |
| TypeLibs |
Gets the type libraries registered in the system. (Inherited from IVCWizCtlUI) |
Methods
| AddBuiltOutput(Object, Object) |
Adds an item to the deployed project. (Inherited from IVCWizCtlUI) |
| AddDebugSymbols(Object, Object) |
Adds debugging symbols to the deployed project. (Inherited from IVCWizCtlUI) |
| AddDeploymentContent(Object, Object) |
Adds an item to the deployed project. (Inherited from IVCWizCtlUI) |
| AddSymbol(String, Object, Boolean) |
Adds the specified symbol to the symbol table. (Inherited from IVCWizCtlUI) |
| CanCreateNewProjectAtLocation(Boolean, String, Boolean) |
Indicates whether the new project can be created at the specified location. (Inherited from IVCWizCtlUI) |
| CommandHandlerExists(Object, Object) |
Indicates whether the specified handler has been implemented. (Inherited from IVCWizCtlUI) |
| ConvertAnsiToOEM(String) |
Converts special extended ANSI characters to OEM characters. (Inherited from IVCWizCtlUI) |
| CppParseTypeString(String) |
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(Object) |
Microsoft Internal Use Only. (Inherited from IVCWizCtlUI) |
| DoesFileExist(String) |
Determines whether the specified file name exists. (Inherited from IVCWizCtlUI) |
| DoesFileOrDirectoryExist(String) |
Determines whether the specified file or directory exists. (Inherited from IVCWizCtlUI) |
| FindSymbol(String) |
Finds the specified symbol in the symbol table. (Inherited from IVCWizCtlUI) |
| Finish(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) |
| FormatGuid(String, eFormat) |
Formats the specified globally unique identifier (GUID). (Inherited from IVCWizCtlUI) |
| GenerateNextDefaultProjectName(String, String) |
Generates a project name based on the specified base name. (Inherited from IVCWizCtlUI) |
| GetActiveXControlTypeLib(String) |
Gets a string containing the type library for the ActiveX control. (Inherited from IVCWizCtlUI) |
| GetAppID() |
Returns the application ID. (Inherited from IVCWizCtlUI) |
| GetClassCommandHandlerDesc(Object, String, String) |
Gets the command handler object for the specified class and command name. (Inherited from IVCWizCtlUI) |
| GetCodePageFromLCID(UInt32) |
Gets the appropriate code page based on the supplied language locale ID. (Inherited from IVCWizCtlUI) |
| GetCommandCount(Object) |
Gets the number of commands in the specified list. (Inherited from IVCWizCtlUI) |
| GetCommandDocumentation(Object, Object) |
Gets the description of the specified command or other text entry in the specified list box. (Inherited from IVCWizCtlUI) |
| GetCommandHandlerString(Object, Object) |
Gets a command handler as a string. (Inherited from IVCWizCtlUI) |
| GetCommandName(Object, Object) |
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(Boolean) |
Gets the information the database application requires to connect to a data source. (Inherited from IVCWizCtlUI) |
| GetConsumerClass(String, Boolean, Boolean, Boolean, Boolean, Boolean) |
Returns a string containing the consumer class. (Inherited from IVCWizCtlUI) |
| GetDefaultWebTargetFolder(Object) |
Returns the default target folder for the Web project. (Inherited from IVCWizCtlUI) |
| GetDialogControlsAndTypes(String) |
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(String, String) |
Gets the specified directory by using the Browse dialog box. (Inherited from IVCWizCtlUI) |
| GetExistingFileNameViaDlg(String, String, String, String) | (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(UInt32) |
Gets the language abbreviation specified by the language locale ID. (Inherited from IVCWizCtlUI) |
| GetLangFromLCID(UInt32) |
Gets the language based on the specified language locale ID. (Inherited from IVCWizCtlUI) |
| GetODBCConsumerClassDecl(Boolean, Boolean, String) |
Gets the ODBC consumer class declaration. (Inherited from IVCWizCtlUI) |
| GetODBCConsumerClassImpl() |
Gets the ODBC consumer class implementation. (Inherited from IVCWizCtlUI) |
| GetOpenFileNameViaDlg(String, String, String, String) |
Gets the name of a file to open using a dialog box. (Inherited from IVCWizCtlUI) |
| GetPrimaryLangIdFromLCID(UInt32) |
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(Object, String) |
For the specified deployment project, returns the name of a remote machine for the specified configuration. (Inherited from IVCWizCtlUI) |
| GetSubFolderByName(Object, String) |
Gets a sub folder for web service deployment. (Inherited from IVCWizCtlUI) |
| GetSubLangIdFromLCID(UInt32) |
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(String, String) |
Get a URL using a dialog box. (Inherited from IVCWizCtlUI) |
| IsSymbolDisabled(String) |
Returns whether a symbol is disabled. (Inherited from IVCWizCtlUI) |
| IsValidNumericValue(Object) |
Determines whether a variant is a valid numeric value. (Inherited from IVCWizCtlUI) |
| IsValidProgID(Object) |
Indicates whether the specified object's program identifier is valid. (Inherited from IVCWizCtlUI) |
| IsWebTierProject(Object) |
Checks if the specified project is a Visual Studio Deployment of a Web Setup Project. (Inherited from IVCWizCtlUI) |
| Load(Object) |
Initializes the specified document. (Inherited from IVCWizCtlUI) |
| Navigate(String, String) |
Navigates to a page and frame. (Inherited from IVCWizCtlUI) |
| NavigateToCommandHandler(Object, Object, String) |
Opens the text editor and places the cursor at the specified handler. (Inherited from IVCWizCtlUI) |
| Next(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) |
| OkCancelAlert(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) |
| OnHelp(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) |
| PreShowWizard() |
For future use. (Inherited from IVCWizCtlUI) |
| RemoveSymbol(String) |
Removes the specified symbol from the symbol table. (Inherited from IVCWizCtlUI) |
| RenderTemplate(String, String, Boolean, Boolean) |
Renders the template file for the wizard project. (Inherited from IVCWizCtlUI) |
| RenderTemplateToString(String) |
Renders the wizard template file as a string. (Inherited from IVCWizCtlUI) |
| ReportError(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) |
| 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(Object) |
Sets the initial defaults for the wizard symbols. (Inherited from IVCWizCtlUI) |
| SetDeploymentAppMappings(Object, Object, String, String) |
Registers an application with a web service. (Inherited from IVCWizCtlUI) |
| SetErrorInfo(String, UInt32, UInt32, String, String) |
Sets error text for the specified item. (Inherited from IVCWizCtlUI) |
| SetRemoteMachine(Object, String) |
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(String, Boolean) |
Returns whether a name is a valid CLR identifier. (Inherited from IVCWizCtlUI) |
| ValidateCSharpClass(String, String) |
Not implemented. (Inherited from IVCWizCtlUI) |
| ValidateCSharpFile(String) |
Not Implemented. (Inherited from IVCWizCtlUI) |
| ValidateCSharpIdentifier(String, Boolean) |
Not implemented. (Inherited from IVCWizCtlUI) |
| ValidateCSharpNamespace(String) |
Not implemented. (Inherited from IVCWizCtlUI) |
| WriteToTextFile(String, String, Boolean) | (Inherited from IVCWizCtlUI) |
| YesNoAlert(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) |