Export (0) Print
Expand All
Cut
Run
Expand Minimize
This topic has not yet been rated - Rate this topic

Common Environment Object Model Methods

Visual Studio .NET 2003

This section of the table of contents contains all of the methods that are common to all Visual Studio .NET programming languages.

Method Description
Activate Method (General Extensibility) Moves the focus to the current item and makes it active.
Add Method (AddIns Collection) Adds an Add-in to the collection of Add-ins loaded when a particular solution loads, fails if the collection is the DTE.AddIns collection.
Add Method (ContextAttributes Collection) Adds an attribute name/value pair to the collection.
Add Method (LinkedWindows Collection) Adds a window to the collection of currently linked windows.
Add Method (OutputWindowPanes Collection) Creates a new Output Window pane and adds it to the collection.
Add Method (SolutionConfigurations Collection) Creates a new solution configuration based on an existing one.
Add Method (TaskItems Collection) Creates a new solution configuration based on an existing one.
Add Method (ToolBoxItems Collection) Creates a new item and adds it to the ToolBox tab.
Add Method (ToolBoxTabs Collection) Creates a new tab in the ToolBox and adds it to the ToolBoxTabs.collection
Add Method (WindowConfigurations Collection) Creates a new named window configuration based on the current arrangement of windows, adds it to the WindowConfigurations, collection and retains it for future recall.
AddAttribute Method [Variation 1] (General Extensibility) Creates a new attribute code construct and inserts the code in the correct location.
AddAttribute Method [Variation 2] (General Extensibility) Creates a new attribute code construct and inserts the code in the correct location.
AddBase Method (General Extensibility) Adds an item to the list of inherited objects.
AddClass Method [Variant 1] (General Extensibility) Creates a new class code construct and inserts the code in the correct location.
AddClass Method [Variant 2] (General Extensibility) Creates a new class code construct and inserts the code in the correct location.
AddCommandBar Method Creates a command bar that is saved and available the next time the environment is started.
AddConfigurationRow Method Creates a new project or project item configuration row based on the Configuration objects of an existing project or project item configuration row.
AddControl Method Creates a persistent command bar control for the command.
AddDelegate Method [Variation 1] (General Extensibility) Creates a new delegate code construct and inserts the code in the correct location.
AddDelegate Method [Variation 2] (General Extensibility} Creates a new delegate code construct and inserts the code in the correct location.
AddEnum Method (Variation 1] (General Extensibility) Creates a new enumeration code construct and inserts the code in the correct location.
AddEnum Method [Variation 2] (General Extensibility) Creates a new enumeration code construct and inserts the code in the correct location.
AddExistingItem Method Adds an existing item to the current project.
AddFolder Method Creates a new folder in Project Explorer.
AddFromDirectory Method Adds one or more ProjectItem objects from a directory to the ProjectItems collection.
AddFromFile Method (ProjectItems Collection) Adds a project item from a file that is installed in a project directory structure.
AddFromFile Method (Solution Object) Adds a project to the solution, based on a project file already stored in the system.
AddFromFileCopy Method Copies a source file and adds it to the project.
AddFromTemplate Method (ProjectItems Object) Creates a new project item from an existing item template file and adds it to the project.
AddFromTemplate Method (Solution Object) Copies an existing project file, and any items or subdirectories it contains, to the specified location and adds it to the solution.
AddFunction Method [Variation 1] (General Extensibility) Creates a new function code construct and inserts the code in the correct location.
AddFunction Method [Variation 2] (General Extensibility) Creates a new function code construct and inserts the code in the correct location.
AddImplementedInterface Method (General Extensibility) Adds an interface to the list of inherited objects.
AddInterface Method [Variation 1] (General Extensibility) Creates a new interface code construct and inserts the code in the correct location.
AddInterface Method [Variation 2] (General Extensibility) Creates a new interface code construct and inserts the code in the correct location.
AddMember Method (General Extensibility) Creates a new member code construct and inserts the code in the correct location.
AddNamedCommand Method Creates a named command that is saved by the environment and made available the next time the environment starts, even if the Add-in is not loaded on environment startup.
AddNameSpace Method [Variation 1] (General Extensibility) Creates a new namespace code construct and inserts the code in the correct location.
AddNameSpace Method [Variation 2] (General Extensibility) Creates a new namespace code construct and inserts the code in the correct location.
AddNewItem Method Adds a new item to the current project.
AddParameter Method (General Extensibility) Creates a new parameter code construct and inserts the code in the correct location.
AddPlatform Method Creates build settings for a new operating system platform based on the Configuration Objects of an existing platform.
AddProject Method (General Reference) Adds a project to the list of projects that must be built first.
AddProperty Method (General Extensibility) Creates a new property code construct and inserts the code in the correct location.
AddStruct Method [Variation 1] (General Extensibility) Creates a new structure code construct and inserts the code in the correct location.
AddStruct Method [Variation 2] (General Extensibility) Creates a new structure code construct and inserts the code in the correct location.
AddVariable Method [Variation 1] (General Extensibility) Creates a new variable code construct and inserts the code in the correct location.
AddVariable Method [Variation 2] (General Extensibility) Creates a new variable code construct and inserts the code in the correct location.
Animate Method Displays an animated picture in the Status Bar.
Apply Method Invokes a previously saved named window configuration.
Build Method (SolutionBuild Object) Causes the active solution configuration to begin building.
BuildProject Method Builds the specified project and its dependencies in the context of the specified solution configuration.
CanExtend Method (IExtenderProvider Interface) Returns whether or not the Provider can provide an Extender for the given object in the specified category.
CanExtend Method (IExtenderProviderUnk Interface) Returns whether or not the Provider can provide an Extender for the given object in the specified category.
ChangeCase Method Changes the case of the selected text.
ChangeCase Method (TextSelection Object) Changes the case of the selected text.
CharLeft Method Moves the edit point the specified number of characters to the left.
CharLeft Method (TextSelection Object) Moves the TextSelection object the specified number of characters to the left.
CharRight Method Moves the object the specified number of characters to the right.
CharRight Method (TextSelection Object) Moves the object the specified number of characters to the right.
Clean Method Deletes all compiler-generated support files for marked projects.
Clear Method (General Extensibility) Deletes all compiler-generated support files for marked projects.
ClearBookmark Method (General Extensibility) Clears any unnamed bookmarks in the current text buffer line.
ClearBookmarks Method Removes all unnamed bookmarks in the text document.
Close Method (General Extensibility) Closes the open document and optionally saves it, or closes and destroys the window.
Close Method (Solution Object) Closes the current solution.
Close Method (UndoContext Object) Ends an undo operation.
CloseAll Method Closes all open documents in the environment and optionally saves them.
CodeElementFromPoint Method (General Extensibility) Returns a code element at a specific location in a source file.
CodeTypeFromFullname Method (General Extensibility) Returns a code element based on a fully qualified name.
Collapse Method Collapses the selected text to the active point.
CommandInfo Method Returns the command GUID and ID associated with the given CommandBar control.
ConfigurationRow Method Returns a collection of items representing build configurations for one configuration name, such as "Debug" or "Retail."
Copy Method Copies the specified range of text to the clipboard.
Copy Method (TextSelection Object) Copies the selected text to the clipboard.
Create Method Creates an empty solution in the specified directory with the specified name.
CreateArrayType Method Creates an array of specified type, and inserts it into the code in the correct location.
CreateCodeTypeRef Method (General Extensibility) Returns a CodeTypeRef object based on the data type indicator passed.
CreateEditPoint Method (General Extensibility) Creates and returns an EditPoint object at a specified location or, if no location is given, at the beginning of the document.
CreateEditPoint Method (TextDocument Object) Creates an EditPoint object at the specified location and returns it. The default location is the beginning of the document.
CreateLinkedWindowFrame Method Creates a Window object and places two windows in it.
CreateToolWindow Method Creates a new tool window containing the specified Document object or ActiveX control.
CreateUniqueID Method (General Extensibility) Creates a programmatic identifier that does not collide with other identifiers in the scope, and follows the current language naming rules.
Cut Method Copies the specified range of text to the clipboard and deletes it from the document.
Cut Method (TextSelection Object) Copies the selected text to the clipboard and deletes it from its original location.
Debug Method Starts debugging the solution.
Delete Method (EditPoint Object) Starts debugging the solution.
Delete Method (General Extensibility) Deletes items as follows:
  • For the Breakpoint object, deletes the breakpoint.
  • For the CodeAttribute, ToolBoxItem and ToolBoxTab objects, removes an object from a collection.
  • For the Command object, removes a named command that was created with Commands.AddNamedCommand.
  • For the Project object, removes the project from storage.
  • For the ProjectItem object, removes the item from the project and its storage.
  • For the SolutionConfiguration object, removes the SolutionConfiguration object from use.
  • For the TaskItem object, removes the task item from the collection.
  • For the WindowConfiguration object, removes the window configuration from the collection.
Delete Method (TextSelection Object) Deletes the selected text.
DeleteConfigurationRow Method Deletes a row of build configurations, such as for "Debug" or "Retail."
DeleteLeft Method Deletes a specified number of characters to the left of the active point.
DeletePlatform Method Removes a column of platform configurations, such as "WinCE PalmSize."
DeleteWhitespace Method (General Extensibility) Deletes the empty characters (white space) horizontally or vertically around the current location in the text buffer.
Deploy Method Causes each project in the active solution configuration that is marked for deployment to deploy.
DestructiveInsert Method Inserts text, overwriting the existing text.
DoDefaultAction Method Inserts text, overwriting the existing text.
EmitMacroCode Method Writes the line of code to the macro being recorded. (Should not be used from within a macro.)
EndOfDocument Method Moves the edit point to the end of the document.
EndOfDocument Method (TextSelection Object) Moves the object to the end of the document.
EndOfLine Method Moves the object to the end of the document.
EndOfLine Method (TextSelection Object) Moves the object to the end of the current line.
EqualTo Method (General Extensibility) Returns whether the value of the called object's AbsoluteCharOffset property is equal to that of the given object.
Exec Method Executes the specified named command.
Execute Method Performs a search based on the options set for the Find object.
Execute Method (IDTWizard Interface) Occurs when a wizard is launched from either the Add Item or the New Project Dialog Box.
ExecuteCommand Method (DTE Object) Executes the specified command.
ExpandView Method Expands the view of Project Explorer to show project items.
FindPattern Method Finds a given matching pattern in the selected text.
FindPattern Method (TextSelection Object) Searches for the given pattern from the active point to the end of the document.
FindProjectItem Method Locates an item in a project.
FindReplace Method Performs a Find or Replacement operation based on the arguments to the method, without affecting the options set for the Find Object.
FindText Method (TextSelection Object) Inserts text, overwriting the existing text.
ForceItemsToTaskList Method (General Extensibility) Sends all task items not yet added to the task list.
GetContextualExtenderCATIDs Method Lists all CATIDs for the current selection.
GetEndPoint Method (General Extensibility) Lists all CATIDs for the current selection.
GetExtender Method (IExtenderProvider Interface) Returns an Extender for the given object under the specified category.
GetExtender Method (IExtenderProviderUnk Interface) Returns an Extender for the given object under the specified category.
GetExtender Method (ObjectExtenders Object) Returns an Extender for the given object under the specified category.
GetExtenderNames Method List all Extenders for the given object under the specified category.
GetItem Method Returns the item designated by given path.
GetLines Method Returns a string representing the text between two given lines.
GetObject Method (General Extensibility) Returns an interface or object that is late-bound to the DTE object and can be accessed by name at run time.
GetProperties Method Returns an object containing all of the properties contained on the specified custom Tools Options page.
GetStartPoint Method (General Extensibility) Returns a TextPoint object that defines the beginning of the code item.
GetText Method Returns the text between the edit point and the specified location.
GoToLine Method Moves to the beginning of the indicated line and selects the line if requested.
GreaterThan Method (General Extensibility) Returns whether the value of the called object's AbsoluteCharOffset property is greater than that of the given object.
Highlight Method Toggles highlighting of text within the Status Bar.
Indent Method Indents the selected lines by the given number of indentation levels.
Indent Method (TextSelection Object) Indents the selected lines by the given number of indentation levels.
Insert Method Inserts the given string at the edit point's current position in the buffer.
Insert Method (TextSelection Object) Moves the object to the end of the current line.
InsertFromFile Method (General Extensibility) Inserts the contents of the specified file at the current location in the buffer.
IsFileOpen Method Returns True if the given file is open in the specified view.
IsValidID Method (General Extensibility) Returns whether a specified name is a valid programmatic identifier for the current language.
IsVisible Method Returns whether the character or specified characters are visible in the text pane.
Item Method (Commands Collection) Returns an indexed member of a collection.
Item Method (ConfigurationManager Collection) Returns an indexed member of a collection.
Item Method (General Extensibility) Returns an indexed member of a collection.
LaunchWizard Method (DTE Object) Runs a wizard with the supplied parameters.
LessThan Method (General Extensibility) Returns whether the value of the called object's AbsoluteCharOffset property is less than that of the given object.
LineDown Method Moves the edit point down the specified number of lines.
LineDown Method (TextSelection Object) Moves the selected line down a specified number of lines.
LineUp Method Moves the edit point up the specified number of lines.
LineUp Method (TextSelection Object) Moves the selected line up a specified number of lines.
MarkText Method Returns whether the indicated text was found in the text document and creates unnamed bookmarks wherever matching text is found.
MoveToAbsoluteOffset Method (EditPoint Object) Moves the active point to the given 1-based absolute character offset.
MoveToAbsoluteOffset Method (TextSelection Object) Moves the active point to the given 1-based absolute character offset.
MoveToDisplayColumn Method Moves the active point to the indicated display column.
MoveToLineAndOffset Method (EditPoint Object) Moves the document to the specified line and character offset position in that line.
MoveToLineAndOffset Method (TextSelection Object) Moves the active point to the given position.
MoveToPoint Method (EditPoint Object) Moves the active point to the given position.
MoveToPoint Method (TextSelection Object) Moves the active point to the given position.
Navigate Method (ItemOperations Object) Navigates to the given URL.
Navigate Method (TaskList Object) Sets the focus to the line in the source code that is associated with a particular task item in the Task List.
NewFile Method Sets the focus to the line in the source code that is associated with a particular task item in the Task List.
NewLine Method Inserts a line break character at the active point.
NewWindow Method Creates a new window in which to view the document.
NextBookmark Method (General Extensibility) Moves to the location of the next bookmark in the document.
NotifyDelete Method A method that an Automation Extender is expected to call back upon to notify its site when it is being destroyed.
Object Method Returns an interface or object that can be accessed at run time by name.
OnAddInsUpdate Method Occurs when an Add-in is loaded or unloaded in the environment.
OnAfterCreated Method Occurs immediately after a custom Tools Options page is created for the first time.
OnBeginShutdown Method Occurs immediately after a custom Tools Options page is created for the first time.
OnCancel Method Occurs if the user clicks the Cancel button in the Tools Options dialog box.
OnConnection Method Occurs when an Add-in is loaded into the environment.
OnDisconnection Method Occurs when an Add-in is unloaded from the environment.
OnHelp Method Occurs when a user clicks the Help button in a custom Tools Options page.
OnOK Method Occurs when a user clicks the OK button in a custom Tools Options page.
OnStartupComplete Method Occurs when the environment has completed starting.
Open Method (General Extensibility) Opens the solution or project item in the specified view.
Open Method (UndoContext Object) Starts a new undo operation.
OpenFile Method Opens a file as though you invoked an Open File command in the IDE.
OutlineSection Method (EditPoint Object) Creates an outlining section based on an EditPoint and the given TextPoint or numeric value.
OutlineSection Method (TextSelection Object) Creates an outlining section based on the current selection.
OutputString Method (General Extensibility) Sends a text string to the Command or Output window.
OutputTaskItemString Method Displays a string in the Output window and adds a corresponding item to the Task List.
PadToColumn Method (General Extensibility) Fills the current line in the buffer with empty characters (white space) to the given column.
PageDown Method Moves the active point a specified number of pages down in the document, scrolling the view.
PageUp Method Moves the active point a specified number of pages up in the document, scrolling the view.
Paste Method (General Extensibility) Inserts the clipboard contents at the current location.
Pause Method Pauses the macro recorder so that no code is written to the macro currently being recorded. (Should not be used from within a macro.)
Platform Method Returns the Configurations collection for this configuration.
PreviousBookmark Method (General Extensibility) Moves the EditPoint or TextSelection to the location of the previous bookmark in the document.
Progress Method Creates, modifies, and clears the meter control inside the Status Bar.
ProjectItemsTemplatePath Method Returns the location of project item templates for the specified project type.
QueryStatus Method Returns the current status of the specified named command, whether it is enabled, disabled, hidden, and so forth.
Quit Method Closes the environment.
Raise Method Executes the specified command.
ReadOnly Method Returns whether any of the specified range of contains read-only text.
Redo Method Re-executes the last action that was undone by the Undo method or the user.
Refresh Method Refresh the contents of this attribute collection.
RegisterExtenderProvider Method Registers an Extender Provider for a specific Extender category.
Remove Method (LinkedWindows Collection) Removes a window from the collection of currently linked windows.
Remove Method (Solution Object) Removes the specified project from the solution.
Remove Method [Variation 1] (General Extensibility)
  • For the AddIn object, removes the Add-in from the collection of Add-ins and makes it unavailable.
  • For the ContextAttribute object, removes the attribute from its parent collection.
  • For the ProjectItem object, removes the project item from the collection.
Remove Method [Variation 2] (General Extensibility) Removes the specified code element from the source file.
RemoveAllProjects Method Removes all projects from the list of projects that must be built first.
RemoveBase Method (General Extensibility) Removes an object from the list of bases.
RemoveCommandBar Method Removes a command bar that was created with the AddCommandBar method.
RemoveInterface Method (General Extensibility) Removes an interface from the list of implemented interfaces.
RemoveMember Method (General Extensibility) Removes a member code construct.
RemoveParameter Method (General Extensibility) Removes a parameter from the argument list.
RemoveProject Method (General Extensibility) Removes a project from the list that specifies the order in which projects are built.
ReplacePattern Method (EditPoint Object) Finds a pattern in the specified range of text and replaces it with the specified text.
ReplacePattern Method (General Extensibility) Replaces matching text throughout an entire text document.
ReplaceText Method Replaces the selected text with the given text.
Resume Method Resumes macro recording if it has been paused. (Should not be used from within a macro.)
Run Method Causes the active solution configuration to execute.
SatelliteDLLPath Method Returns the computed path to the satellite DLL when given the installation directory for an Add-in or wizard and the file name of the DLL containing localized resources.
Save Method (Document Object) Saves the document.
Save Method (General Extensibility) Saves the project or project item.
SaveAll Method Saves all documents currently open in the environment.
SaveAs Method (General Extensibility) Saves the solution, project, or project item.
Select Method (General Extensibility) Causes this item to become active in the interactive development environment (IDE).
Select Method (UIHierarchyItem Object) Causes the specified item to become active in the user interface.
SelectAll Method Selects the entire document.
SelectDown Method Selects the node immediately below the currently selected node with respect to the tree's current expansion state.
SelectLine Method Selects the line containing the active point.
SelectUp Method Selects the node immediately above the currently selected node with respect to the tree's current expansion state.
SendInput Method Sends a line of input to the Command window which is processed as if you typed it in.
SetAborted Method Discards all changes to participating open documents since opening the UndoContext object.
SetBookmark Method (General Extensibility) Sets an unnamed bookmark on the current line in the buffer.
SetLineColumnCharacter Method Sets the text column and character indicators in the Status Bar.
SetSelectionContainer Method Allows setting objects to be active in the Properties window when this window is active.
SetTabPicture Method Sets the picture to display in a tool window.
SetXYWidthHeight Method Sets the x, y, width, and height coordinate indicators in the Status Bar.
ShowTextUpdates Method Determines whether the Status Bar shows text updates.
SmartFormat Method (EditPoint Object) Formats the specified range of text based on the current language.
SmartFormat Method (TextSelection Object) Formats the selected lines of text based on the current language.
StartOfDocument Method Moves the object to the beginning of the document.
StartOfDocument Method (TextSelection Object) Moves the object to the beginning of the document.
StartOfLine Method Moves the EditPoint to the beginning of the current line in the buffer.
StartOfLine Method (TextSelection Object) Moves the object to the beginning of the current line.
SwapAnchor Method Exchanges the position of the active and the anchor points.
Tabify Method Converts spaces to tabs in the selection according to your tab settings.
TryToShow Method (General Extensibility) Attempts to display the text point's location.
TryToShow Method (TextPane Object) Adjusts the location of the view in the text buffer so that the indicated range of text is shown in the text pane, if possible. You can control where in the pane the text displays.
Undo Method Reverses the action last performed by the user in the document.
Unindent Method (EditPoint Object) Reverses the action last performed by the user in the document.
UnIndent Method (TextSelection Object) Removes indents from the selected text by the number of indentation levels given.
UnregisterExtenderProvider Method Unregister a previously registered Extender Provider.
Untabify Method Converts tabs to spaces in the selection according to the user's tab settings.
Update Method (General Extensibility) Updates the collection as if the user opened the Add-in Manager dialog box, or sets the object's window layout to the current window layout.
WordLeft Method Moves the object the specified number of words to the left.
WordLeft Method (TextSelection Object) Moves the selected text left the specified number of words.
WordRight Method Moves the object the specified number of words to the right.
WordRight Method (TextSelection Object) Moves the selected text right the specified number of words.

See Also

Common Environment Object Model | Automation Object Model Chart

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.