Microsoft.VisualStudio.Package.LanguageService

Encapsulates information about the source as obtained from a parsing operation.

Initializes an instance of the class.

Returns a string to be used for a tool tip based on the specified location.

If successful, returns a string containing the text for the tool tip; otherwise, returns a null value. A that describes the area over which the cursor can hover before the tool tip is dismissed from view. [in] An offset within the line to look at for a tool tip. [in] The line in the source to look at for a tool tip.

Returns a list of declarations based on the specified reason for parsing.

If successful returns a object; otherwise, returns a null value. [in] An object that can be used to access the source. [in] The offset into the line where the parse operation started. [in] The line number where the parse operation started. [in] The value describing what kind of parse operation was completed. [in] A structure containing information about the token at the specified position.

Returns a list of overloaded method signatures for a specified method name.

If successful, returns a object; otherwise, returns a null value. [in] The name of the method for which to get permutations. [in] The offset into the line where the parse for method signatures started. [in] The line number where the parse for method signatures started.

Returns a URI (Universal Resource Identifier) based on the current location in the source and the specified command.

If successful, returns a string containing the URI; otherwise, returns a null value. [out] A object marking the selected text area for which the URI is determined. [in] A value from the enumeration that determines what kind of destination URI must be returned. This is the command the user entered, typically from a context menu. [in] The offset into the line containing the text under the cursor. [in] The line number containing the text under the cursor. [in] The object containing the text under the cursor.

This class is used by the parser to gather information about the source being parsed.

Initializes the class.

[in] The maximum number of errors that are to be returned from the parser. [in] The line number the parse started on. [in] The offset into the line the parse started on. [in] The reason for the parse given as a value from the enumeration.

Adds an error in parsing message for later reporting.

[in] A indicating what triggered the error (this is used to mark the bad code). [in] The severity of the error: a value from the enumeration. [in] The source file's path. [in] The error message to report.

Adds the specified object to the internal hidden regions list.

[in] A object to add to the list.

Adds a new hidden region to the internal list based on the given object.

[in] A object describing the span of code to be hidden.

Adds the span of an expression to an internal list.

[in] A object indicating the expression to add.

This adds a span of executable code to an internal list.

[in] A object indicating the section of code to add to the list.

Called to indicate the end of a method's parameter list.

[in] A object indicating the span of character or characters that denote the end of the parameter list.

Called to add the spans of the two paired elements in an internal list.

[in] The object describing the starting paired element. [in] A priority value used to sort overlapping pairs. [in] The object describing the ending paired element.

Called to add a matching set of three elements to an internal list.

[in] A object indicating the starting element. [in] A object indicating the middle element. [in] A Span object indicating the ending element. [in] A priority value used to sort overlapping triples.

Called when parsing a method parameter list and the parameter separator character has just been parsed.

[in] A object indicating the parameter separator character.

Called to note the location of a member reference.

[in] A object indicating the member name. [in] The member name as indicated by nameContext. [in] A object indicating the selector (for example, "." or "->").

Called when an identifier is parsed.

[in] A object indicating the location of the identifier. [in] The name of the identifier.

Called at the start of a method's parameter list.

[in] A object indicating the character or characters that start the parameter list.

Indicates if brace matching should be done for a parse operation.

Returns true if brace matching is to be done; otherwise, returns false (no brace matching allowed).

Gets the column the parsing started on.

Returns the offset into the line as passed to the constructor.

Indicates whether identifiers are to be looked for.

Returns true if searching of names is to be done; otherwise, returns false (name searching is not allowed).

Tracks if a matching pair of braces was added to the internal list.

Returns true if at least one pair of matching braces was added to the internal list; otherwise, returns false, if no matching braces have been added.

Indicates whether hidden regions should be processed during the parse operation.

Returns true if hidden regions should be processed; otherwise, returns false (ignore hidden regions).

Returns the line the parsing operation started on.

Returns the line the parse started on as passed to the constructor.

Indicates whether to process method parameters during the parse operation.

Returns true if method parameters should be processed; otherwise, returns false (ignore method parameters).

Indicates whether to update hidden regions.

Returns true if any hidden regions have been added to the list; otherwise, returns false.

Returns the reason the parse operation was started.

Returns a value from the enumeration.

Wraps an object for use in a language service.

Initializes the class.

[in] The object representing the language service. [in] The object associated with the source file to be shown in the code window. [in] The object supplied by Visual Studio that is to be managed by the class.

Called to add adornments or additional user interface (UI) elements to the text view.

If successful, returns ; otherwise, returns an error code.

Close down the object.

The destructor for the class.

Returns the object associated with the specified text view.

If successful, returns a object; otherwise, returns a null value (the specified text view does not have a view filter in this language service). [in] The object for which to retrieve the associated object.

Called when the specified text view loses focus.

[in] The representing the text view that is losing focus.

Called when a new text view is created.

If successful, returns ; otherwise, returns an error code. [in] The object representing the new text view.

Called when the specified text view receives the focus.

[in] The object representing the view that received the focus.

Called to remove any adornments on a text view that is being closed.

If successful, this method returns ; otherwise, this method returns an error code.

Returns the this is managing.

Always returns the supplied to the constructor.

Returns the drop-down helper class.

Returns a object or returns a null value if there are no drop-down bars.

Returns the language service that owns this code window manager.

Returns the object given to the constructor.

Allows retrieving and updating the document properties.

Returns a object obtained in the constructor through a call to the method.

Returns the Source object associated with the view managed by this code window manager class.

Returns the object that was passed to the constructor.

Provides a default implementation of the VSIP interface .

Initializes the class and accepts all the information needed to describe a colorable item.

[in] The text's foreground color as specified by a value from the enumeration. [in] The name of the colorable item that is displayed in the Fonts and Colors list of colors. This is the localized name. [in] The text's background color as specified by a value from the enumeration. [in] A structure describing the background color in terms of red, green, blue components. This value can be Empty if high colors are not used. [in] The name of the colorable item. This can be used in the properties listing if you support customizing your own custom colors. [in] A structure describing the foreground color in terms of red, green, blue components. This value can be Empty if high colors are not used. [in] A set of flags from the enumeration describing how the text is to be rendered.

Gets the canonical name of a colorable item.

If successful, returns ; otherwise, returns an error code. [out] A string containing the canonical name of this colorable item.

Get the specified high color foreground or background element.

If successful, returns ; otherwise, returns an error code. [in] A value from the enumeration specifying which color element to retrieve. [out] Returns a COLORREF object that contains the RGB values for the specified color element.

Returns the foreground and background color for this colorable item.

If successful, returns ; otherwise, returns an error code. [in, out] If not null, this is where the value for the text's foreground color is returned. [in, out] If not null, this is where the value for the text's background color is returned.

Returns the font attributes for this colorable item.

If successful, returns ; otherwise, returns an error code. [out] The set of flags from the enumeration.

Returns a description for this colorable item.

If successful, returns ; otherwise, returns an error code. [out] A string containing a description.

Returns the name of this colorable item.

If successful, returns ; otherwise, returns an error code. [out] The name of the colorable item.

Returns the priority this colorable item has when compared to other colorable items of the same name.

If successful, returns ; otherwise, returns an error code. [out] A priority value, the higher it is, the more preferred this colorable item.

This class implements the interface and is used to support syntax highlighting in an editor.

Initializes the class.

[in] The object that serves as the buffer for the colorizer. [in] The language service. [in] The object that handles all parsing operations associated with syntax highlighting.

Called when the colorizer is disposed of.

Obtains color and font attribute information for each character in the specified line of text.

Returns the updated state value. [in, out] An array that is filled in with indices into the list as maintained by the class. [in] The current state as maintained by the parser. [in] An unmarshaled pointer to a line of text. [in] The line number from which the line of text came from. [in] The number of characters in the given text.

Disposes the object.

Called when the object is about to be destroyed.

Returns the parsing state at the end of the line without returning any colorization information.

Returns the parsing state at the end of the line. [in] The initial parsing state of the line. [in] The text of the line. [in] The length of the line.

Returns color information about the specified line.

If successful, returns an array of objects describing each token on the line; otherwise, returns a null value. [in] An object from which cached state information can be obtained for a line. [in] An object containing the entire source file. [in] The index of the line for which to get color information.

Returns the initial parsing state.

If successful, returns ; otherwise, returns an error code. [out] Returns the initial parsing state.

Returns the parsing state at the end of the specified line.

Returns the parsing state at the end of the line. [in] The parsing state at the beginning of the line. [in] An unmarshaled pointer to the text. The example in shows how to marshal this pointer to a string. [in] The line number from where the text came from. [in] The length of the text to examine.

Called to determine if the colorizer requires per line state management.

If successful, returns ; otherwise, returns an error code. [out] Returns nonzero if the colorizer requires parsing state to be tracked per line; otherwise, returns zero.

Called to resume use of the colorizer.

Called to suspend use of the colorizer.

Returns the scanner being used.

Returns an object.

Provides the characters that define comments for a language service.

Specifies the string of characters that define the end of a block comment.

Returns the string of characters that define the end of a block comment.

Specifies the string of characters that define the start of a block comment.

Returns the string of characters that define the start of a block comment.

Specifies the string of characters that define the start of a line comment.

Returns the string of characters that define the start of a line comment.

Specifies whether line comments are supported.

Returns true if line comments are support; otherwise, returns false.

Represents an IntelliSense completion list that is displayed in the current text view.

Initializes a new instance of the class.

[in] An object containing the images to be used in the completion list display. This cannot be null. It can however, be an empty list.. [in] A object representing the source file to be affected by the completion list. This cannot be null.

Closes the completion list display.

Compares two strings for the specified number of characters.

If the method is successful, returns ; otherwise, returns an error code (in which case the default comparison is used). [out] The result of the comparison. The second string to compare. The first string to compare. The number of characters to compare.

Changes the level of the internal filter list and updates it, showing common items.

If the method succeeds, it returns . If it fails, it returns an error code. The index of the item that is currently selected.

Called when the completion list is no longer needed.

Deallocates any resources just before the object is destroyed.

Determines which item in the list is the best match for the text typed so far by the user.

If successful, returns ; otherwise, returns an error code. [out] Returns a set of flags from the enumeration. [in] The text that has been typed by the user. [in] The length of the text typed by the user. [out] Returns the index of the item in the object that best matches the typed text.

Gets the foreground and background colors for a selected item.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns the foreground color. [out] Returns the background color. The index of the item for which to get the colors.

Gets the number of items that can be displayed in the completion list.

The number of items to be displayed.

Gets a description for the specified item in the completion list.

If successful, returns ; otherwise, returns an error. [out] Returns the description, or null if there is no description. [in] The index of the item for which to get a description.

Gets the text and image index to display in the completion list for the specified item.

If successful, returns ; otherwise, returns an error code. [in, out] Returns the index of the image to display, or -1 if no image is to be displayed. This parameter can be null, indicating the caller does not want the image index. [in] The index of the item for which to get the display text and image. [out] Returns the display text, or null if there is no display text.

Gets the current filter level.

If successful, returns . If there is no filter, returns ; otherwise, returns an error code. [out] Returns the filter level.

Gets a set of flags specifying the behavior of the completion list.

A set of flags from the enumeration; specifically, from the CSF_* group.

Returns the image list to use for the glyphs in the completion list.

If successful, returns ; otherwise, returns an error code. [out] Returns the handle to an image list.

Gets the initial extent of the text to be completed.

If successful, returns ; otherwise, returns an error code. [out] Returns the line number the text is on. [out] Returns the character offset of the first character of the text. [out] Returns the character offset of the last character of the text.

Show in the completion list the members of the specified type.

If the method succeeds, it returns . If it fails, it returns an error code. The index of the selected item.

Initializes the completion set object.

[in] true if part of a word is to be completed, otherwise false (the user selected Complete Word from the IntelliSense menu with the caret not positioned immediately after any text. This displays all possible completions). [in] A object that manages the list of declarations to show in the completion list. [in] An object representing the view that displays the source file.

Called after completion text has been committed to the source file.

A character to be inserted after the committed text, or 0 if no character is to be inserted.

Gets the text to be inserted into the source file if the specified character is a commit character.

If successful, returns . If the commitChar parameter is not a commit character, returns (do not commit the text to the source file); otherwise, returns an error code. [in] The typed character that triggered the completion list. [out] Returns the string to insert in the source. [in] Nonzero if an item is selected in the completion list (the index of the selected item is in the index parameter). If this parameter is zero, the index parameter is to be ignored. [in] A string containing the text that has been typed so far by the user. [in] The index of the item in the completion list that is currently selected.

Called after the text has been committed.

.

Gets or sets the object this completion set uses.

.

Gets whether any text has been committed to the source file.

true if text has been committed to the source file, otherwise false.

Gets whether the completion list is currently displayed.

Set to true if the completion list is displayed, otherwise false.

Gets the text that is to be committed to the source file.

The text if there is anything to commit, otherwise null.

Wraps and applies multiple changes to a text view as a single operation.

Initializes a new instance of the class.

[in] An representing the view currently being edited. [in] A string used to describe the pending edit operation. [in] A object.

Applies all changes made through the object.

Cleans up any allocations made just before the object is destroyed.

Obtains the current line of text from the object.

Performs the specified number of backspaces on the line being edited and updates the internal caret position.

[in] The number of backspaces to perform.

Inserts the specified character and updates the internal caret position.

[in] The character to insert.

Inserts the specified string of characters and updates internal caret position.

[in] A string containing the characters to insert.

Performs the specified number of delete operations on the line being edited.

[in] The number of delete operations to perform.

Moves the internal caret position the specified number of positions to the left.

[in] The number of positions to move to the left.

Moves the internal caret position the specified number of positions to the right.

[in] The number of positions to move to the right.

Determines if the internal caret position is at the end of the current line.

If the internal caret position is at the end of the line, returns true; otherwise, returns false.

Determines if a code snippet is being edited.

If a code snippet is being edited, returns true; otherwise, returns false.

Manages a group of edit operations that are treated as a single operation.

Initializes a new instance of the class.

[in] The object that represents the source file to be edited. [in] A string containing a description to label the undo action.

Terminates the current compound action, throwing away all edits.

Closes the compound action and commits all edits to the source file.

Deallocates any resources just before the object is destroyed.

Flushes any pending edit actions from the current compound action.

Manages multiple edit actions that are treated as a single operation, optimized for a text view.

Initializes a new instance of the class.

[in] An object representing the view that is to receive the edit events. [in] A string containing a description to label the undo action.

Terminates the current compound action, throwing away all edits.

Closes the compound action and commits all edits to the source file.

Deallocates any resources just before the object is destroyed.

Flushes any pending edit actions from the current compound action.

Manages a list of declarations to be shown in an IntelliSense drop-down list.

Initializes a new instance of the class.

Frees any resources allocated by the class just before the class object is destroyed.

Determines the best completion match for the specified value.

[in] The text to match against. This typically represents the text typed by the user. [out] Returns true if the best match is the only match and it matches the value exactly; otherwise, returns false. [out] Returns the index of the item that best matches the value.

When implemented in a derived class, gets the number of items in the list of declarations.

The count of items represented by this class.

When implemented in a derived class, gets a description of the specified item.

If successful, returns the description; otherwise, returns null. [in] The index of the item for which to get the description.

When implemented in a derived class, gets the text to be displayed in the completion list for the specified item.

The text to be displayed, otherwise null. [in] The index of the item for which to get the display text.

When implemented in a derived class, gets the image to show next to the specified item.

The index of the image from an image list, otherwise -1. [in] The index of the item for which to get the image index.

Returns the initial extent of the text to be completed.

If the initial extent was determined, returns true; otherwise, returns false. [out] The line number the caret is currently on. [out] The character offset on the line to the first character of the text that is to trigger the commit. [in] An object representing the view that displays the source file. [out] The character offset to the last character of the text that is to trigger the commit.

When implemented in a derived class, gets the name or text to be inserted for the specified item.

If successful, returns the name of the item; otherwise, returns null. [in] The index of the item for which to get the name.

Determines whether the specified character can be used to complete the specified text.

If the character is a commit character, returns true; otherwise, returns false. [in] The number of characters that are currently selected or -1 if nothing is selected. [in] A string containing the text typed by the user. [in] The character to determine is a completion character.

Determines whether the specified text matches some or all of the specified item.

Returns true if the specified text is at the beginning of the specified item; otherwise, returns false. [in] A string containing the text typed by the user and to be matched. [in] The index of the item to compare against.

Called after the declaration has been committed to the source file. When implemented in a derived class, it provides a completion character which may itself be a trigger for another round of IntelliSense.

Returns a character to be inserted after the committed text. If nothing is to be inserted, returns 0. [in] The index of the item that was committed to the source file. [in] A string containing the text that was inserted as part of the completion process. [in] An object representing the view that displays the source file. [in] The character that was used to commit the text to the source file.

Called to commit the specified item to the source file.

If successful, returns a string containing the text to commit to the source file; otherwise, returns null. [in] The index of the item to commit to the source file. [in, out] A object specifying the text typed so far. Returns the span of the committed text. [in] A string containing the text that has been typed by the user. [in] An object representing the view that displays the source file. [in] The character used to commit the text.

Gets or sets the name of the item that best matches what has been typed so far.

If a best match has been set, returns a string containing the name of the item; otherwise, returns an empty string.

Associates a default value with a field name as defined in a code snippet template for a language service.

Initializes a new instance of the class.

[in] A string containing the value of the field. [in] A string containing the name of the field.

Returns the name of the field.

Returns the name that was passed to the class constructor.

Returns the value of the field.

Returns the value that was passed to the class constructor.

Provides support for document-specific properties associated with a language service.

Initializes a new instance of the class.

[in] The object that uses this object.

Closes down the object so that its properties are no longer visible in the Properties window.

Returns the number of objects managed by this object.

If successful, returns ; otherwise, returns an error code. [in] This is either to count all objects, or to count only the selected objects. [out] Returns the number of objects.

Cleans up the object.

Cleans up the object and its resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Does final cleanup of the object.

Retrieves the code window manager associated with this object.

Returns a object.

Returns a list of objects managed by this object.

If successful, returns ; otherwise, returns an error code. [in] This is either to get all objects, or to get only the selected objects. [in] The maximum number of objects to return. [in, out] An array that is filled in with the objects to return.

Returns a object associated with this object.

Returns a object that is obtained from the object that was passed to the class constructor.

Updates the Properties window with the latest property values.

Called to manage the selection of multiple objects in the Properties window.

If successful, returns ; otherwise, returns an error code. [in] This is to select the objects in the array; otherwise, the objects are de-selected. [in] The number of objects in the selobj array. [in] An array of objects returned from the method.

Determines if the object is visible in the Properties window.

If the object is visible, returns true; otherwise, returns false.

Represents an item for a language service in the Error List Options window.

Initializes a new instance of for the specified text buffer, text span, and file name.

The text buffer. The . The of the buffer. The name of the file in which the text is found. The of the marker.

Recovers resources just before the object is destroyed.

Recovers resources just before the object is destroyed.

true if disposing the object just before destruction; otherwise, false.

Executes a command on a specific marker within the text buffer.

When implemented in derived classes, if the method succeeds, it returns . If it fails, it returns an error code. The ID of the command to execute. The values should be taken from . The marker on which to execute the command.

Recovers resources just before the object is destroyed.

Queries the marker for the command information.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code. The ID of the command to execute. The values should be taken from . The marker to query. [out] the command flags. The text of the marker command in the context menu.

Gets the tip text for the text marker that is displayed when the mouse hovers over the marker.

The text of this task. The marker for which to get the text. The text to display.

Called when the text associated with a marker is deleted by a user action.

Signals that the marker position has changed.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code. The marker that has changed.

Signals that the text under the marker has been altered but the marker has not been deleted.

Sends notification that the text buffer is about to close.

Called when the buffer has been saved.

The name of the file that was saved.

Loads the document associated with the error and jumps to the location of the error.

[in] An object (which in this case does not contain any information and used only as a placeholder in a delegate object).

Called when this object is removed from the Error List Options window.

[in] An object (which in this case does not contain any information and used only as a placeholder in a delegate object).

Gets whether or not the marker has been set to invalid.

Set to true if the marker has not been set to invalid, otherwise false.

Gets the service provider.

The object that was passed to the class constructor.

Gets the span where the error occurred.

A object from the object that was passed to the class constructor, if it is non-null. Otherwise, the object that was passed to the class constructor.

Returns the text line marker object describing the location of the error.

The object that was passed to the class constructor.

Represents a single entry in a combo box on a drop-down bar.

Initializes a new instance of the class.

[in] An index into an image list to a glyph that is shown with this entry in the combo box. [in] A object that specifies the location in the source this entry represents. [in] A collection flags from the enumeration describing how to render the label in the combo box. [in] A string representing the text to be shown in the combo box.

Compares this object to the specified object.

1 if this object is greater than the specified object, 0 if this object equals the specified object, -1 if this object is less than the specified object. [in] The object to compare to.

Compares one to another with the given string comparison.

If obj is a , the return value of a string comparison of the two; otherwise -1. The object to which to do the comparison. .

Determines whether this object equals the specified object.

Returns true if this object equals the specified object; otherwise, returns false. [in] The object to compare to.

Returns a hash code value for this object.

Returns a value that can be used as a hash code to represent this object.

Determines if two objects are equal.

true if the two objects are equal, otherwise false. [in] The second object to compare. [in] The first object to compare.

Determines whether the first is greater than the second .

true if the first object is greater than the second object, otherwise false. [in] The second object to compare. [in] The first object to compare.

Determines if two objects are not equal.

true if the two objects are not equal, otherwise false. [in] The second object to compare. [in] The first object to compare.

Determines whether the first object is less than the second object.

true if the first object is less than the second object, otherwise false. [in] The second object to compare. [in] The first object to compare.

Gets or sets the font attributes to use for rendering the entry's text.

Flags from the enumeration.

Gets or sets the image index to associate with the entry's text.

The image index.

Gets or sets the text to be displayed.

The text to be displayed.

Gets or sets the text span in the source file that corresponds to the entry's text.

.

Merges multiple edit operations to create a single operation.

Initializes a new instance of the class using a object and an object.

[in] true if the edits are to be merged where possible, otherwise false. [in] An object representing the view that displays the source. [in] The description of the edit operations. [in] A object representing the source to be changed.

Adds the specified object to the array of edit operations.

[in] An object describing an edit operation.

Applies all edit operations that have been accumulated.

Disposes the object and its resources.

Tears down the object.

Gets a default enumerator for the edit operations.

.

Converts the array of edit operations to a formatted string.

The formatted string to which the edit operations have been converted.

Gets the number of edit operations represented in the object.

The number of edit operations that can be applied.

Gets the object associated with this object.

A object.

Gets the object associated with this object.

An object.

Handles the editor window.

Initializes a new instance of with the supplied buffer and control and the main service provider.

The associated . The buffer. The main .

Closes the window and disposes the resources.

if the method succeeded, otherwise an error code.

Commits any changes made to the file.

if the method succeeded, otherwise an error code. [out] Returns true if the changes could not be committed.

Creates the window.

. x ordinate relative to x. [out] Returns a pointer to the new window pane. The parent window. y ordinate relative to y. Absolute x ordinate. Absolute y ordinate.

Gives the component a chance to do idle time tasks.

true if more time is needed to perform the idle time tasks, false otherwise. Flags from the enumeration.

Called when the component manager wishes to know whether the component is in a state in which it can terminate.

true if the component can terminate, otherwise false. true if the component should prompt the user if it needs to terminate, false if it should not prompt the user.

Gets a window associated with the component.

The of the control. A value from . Reserved for future use; should be 0.

Notifies the component whenever the host application is activated or deactivated.

If true, the host application is being activated, otherwise it is being deactivated. If the host application is being activated, the ID of the thread that owns the window being deactivated. If the host application is being deactivated, the ID of the thread owning the window being activated.

Notifies the active component that it has lost its active status because the host or another component has become active.

Gets or sets the control that represents the editor window.

.

This class provides a default editor factory implementation that hosts the Visual Studio core editor.

Initializes a new instance of .

Creates an instance of the class.

The package object.

Gets a GUID value in that, when set to false, will stop the core editor for searching for a different language service.

The GUID corresponding to the value that, when set to false, will stop the core editor for searching for a different language service.

Releases all service provides and sets the package object to null.

If the method succeeds, it returns . If it fails, it returns an error code.

Used by the EditorFactory class to create the Visual Studio core editor, an editor that supports data/view separation.

If the method succeeds, it returns . If it fails, it returns an error code. An object. Item identifier of the core editor instance. Must be the docData object that is registered in the Running Document Table (RDT). This parameter is used to determine if a document buffer (Document Data object) has already been created. When an editor factory is asked to create a secondary view, then this parameter will be non-NULL indicating that there is no document buffer. Flags that define the conditions under which to create the core editor. Document Data object. Returns the buffer for the document. Initial caption defined by the document editor for the document window. This is typically a string enclosed in square brackets, such as "[Form]". This value is passed as an input parameter to the method. If the file is [ReadOnly] the caption will be set during load of the file. String form of the moniker identifier of the document in the project system. In the case of documents that are files, this is always the path to the file. This parameter can also be used to specify documents that are not files. For example, in a database-oriented project, this parameter could contain a string that refers to records in a table. Name of the physical view. Enumeration of type . These flags are passed to Method. This value is set to 0 in EditorFactory implementation. Document View object. Returns NULL if an external editor exists, otherwise returns the view of the document. Returns the Command UI GUID. This GUID is active when this editor is activated. Any UI element that is visible in the editor has to use this GUID. This GUID is used in the .ctc file in the satellite DLL where it indicates which menus and toolbars should be displayed when the document is active.

Creates a code window with the Visual Studio core editor.

If the method succeeds, it returns . If it fails, it returns an error code. The buffer used to set the text buffer for all views in the code window. Initial caption defined by the document editor for the document window. This is typically a string enclosed in square brackets, such as "[Form]". This value is passed as an input parameter to the method. If the file is [ReadOnly] the caption will be set during load of the file. String form of the moniker identifier of the document in the project system. In the case of documents that are files, this is always the path to the file. Name of the physical view.

Destructor for the EditorFactory class.

Returns a list of file extensions registered for this editor factory.

An array of strings containing the editor extensions.

Gets the GUID of the language service registered for this file extension under the registry key HKLM\Software\Microsoft\Visual Studio\8.0\Language Services\Extensions.

The GUID of the language service. The file extension for the desired language service.

gETs the language service GUID.

This method returns the language service GUID. The base method returns an empty GUID.

Gets the object.

A object.

Gets the GUID of the highest-priority editor registered for this extension. This will also pick up user-defined associations between file extensions and editors

The GUID of the editor. The extension for which to get the editor.

Gets the for the specified extension.

The registered for the given extension. The extension for which to get the editor information

Gets the main service provider.

.

Gets the GUID of the editor that the user has defined for this file extension.

The GUID of the editor, or an empty GUID if none is found The extension for which to get the editor.

Checks whether there is an editor that can handle this extension.

By default returns true. Implementations should override this method to handle their own file formats. The extension for which an editor is desired.

Determines if a file extension is registered with this editor factory.

Returns true if the file extension is registered with this editor factory, false otherwise. A string containing the file extension.

Maps a logical view to a physical view.

If the method succeeds, it returns . If it fails, it returns an error code. Unique identifier of the logical view. The name of the physical view to which the logical view is to be mapped.

Sets the service provider.

If the method succeeds, it returns . If it fails, it returns an error code. The object of the editor being initialized.

Gets and sets flags to prompt user for an encoding on an open with specified codepage.

A enumeration value.

Contains data about a specific editor.

Initializes a new instance of .

Gets or sets the GUID of the editor.

The GUID of the editor.

Gets or sets the name of the editor.

The name of the editor.

Gets or sets the next in the series.

.

Gets or sets the priority of the editor.

The relative priority of the editor.

Describes an edit operation.

Initializes a new instance of the class.

[in] The text to insert/replace. [in] A object describing the span to affect.

Returns the length of the last line in the replacement text.

Returns the number of characters on the last line of the replacement text.

Returns the number of lines in the replacement text.

Returns the number of lines in the replacement text.

Determines the span to be replaced.

Returns a object describing the span to be replaced.

Determines the replacement text.

Returns a string containing the text to replace with.

Provides support for expansion functions in code snippets for a language service.

Initializes a new instance of the class.

[in] The object

Called when a field has changed its value.

If successful, returns ; otherwise, returns an error code. [in] The name of the field that was changed. [out] Returns nonzero if the expansion function depends on the value of the specified field and needs to be re-queried; otherwise, returns zero.

Gets the specified argument.

The specified argument if it exists, otherwise null. [in] The position in the arguments array to get.

Gets the current value of the expansion function as a string.

The current value of the expansion function, otherwise null.

Gets the current value of the expansion function.

. [out] Returns true if bstrValue is not null. [out] Returns the value, if it exists, otherwise an empty string.

Gets the default value of the expansion function.

The default value, if it exists, otherwise null.

Gets the default value of the expansion function.

. [out] Returns true if bstrValue is not null. [out] Returns the default value if it exists, otherwise returns an empty string.

Gets the value of the specified field.

If the value was obtained, returns true; otherwise, returns false. [in] The name of the field for which to get a value. [out] Returns the requested value or null if the value could not be obtained.

Gets the type of the function; that is, what type of value the function returns.

If successful, returns ; otherwise, returns an error code. [out] A value from the enumeration specifying the type of the expansion function.

Gets a list of all values the expansion function can return.

If the type of the expansion function is a list, returns a list of values; otherwise, returns null.

Gets the number of items in the list of values for the expansion function.

If successful, returns ; otherwise, returns an error code. [out] Returns the number of items in the list.

Gets the value of the specified list item.

If successful, returns ; otherwise, returns an error code. [out] Returns the value of the requested list item. [in] The index of the item for which to get the value.

Gets the span of the selected text in the current view.

A object containing the span of the selected text.

Frees any allocations your class may have made.

If successful, returns ; otherwise, returns an error code.

Gets or sets the arguments to the function.

An array of arguments of the expansion function.

Gets the expansion provider that owns this expansion function.

.

Gets or sets the name of the field with which this expansion function is associated.

The name of the field with which this expansion function is associated.

Provides support for inserting code snippets into source code.

Initializes a new instance of the class.

[in] A object describing the source that this expansion provider supports.

Inserts the previously prepared code snippet and starts the snippet editing mode.

[in] The line number where the insertion is to take place. [in] The character offset on the line where the insertion is to take place.

Displays a list of expansion templates of the specified type and kind.

If successful, returns true; otherwise, returns false, the browser box was not displayed. [in] An array of strings containing the types of expansions to show. If this array is empty or a null value, then all types are shown in the browser box. [in] This is true to allow "empty" types through the filter even if the types array is specified. [in] An object that represents the view the source file is in and the view that is the parent of the browser box. [in] This is true to allow "empty" kinds through the filter even if the kinds array is specified. [in] A string containing the prompt in the browser box. [in] An array of strings containing the kinds of expansions to show. If this array is empty or a null value, then all kinds are shown in the browser box.

Cleans up allocated resource just before the object is destroyed.

Called when an expansion session has ended.

If successful, returns ; otherwise, returns an error code.

Ends the current snippet editing mode.

[in] This is true if the caret is to be left where it was before the snippet was inserted; otherwise, this is false if the caret is positioned where the snippet indicates.

Cleans up all resources just before the object is destroyed.

Obtains the path and title of a code snippet given the snippet's shortcut name.

If an expansion template was found, returns ; otherwise, returns an error code from the enumeration. [in] An object representing the view in which the snippet is to be inserted. [out] Returns the path to the snippet template file. [in] This is true if a user interface can be shown to resolve duplicate names; otherwise, false means to select the first expansion found that matches the shortcut name. [in] A object describing the position or selection in the current source. [in] A string containing the shortcut name of the snippet. [out] Returns the title of the snippet found.

Formats the specified text span.

if the method succeeded, otherwise . An array of objects. The buffer.

Returns an object representing the expansion function described in the given XML template node.

If successful, returns an object; otherwise, returns a null value indicating no expansion function was found in the specified XML node. [in] An object representing the expansion function definition. [in] The name of the variable or field this expansion function represents.

Returns a object representing the expansion function described in the given XML template node (COM implementation).

If successful, returns ; otherwise, returns an error code. [in] A IXMLDOMNode object representing the expansion function description. [in] The name of the variable or field this expansion function represents. [out] Returns an object representing the implementation of the expansion function.

Returns the span occupied by the snippet currently being edited.

Returns a object representing the snippet's span in the source file.

Gets the field span of the specified field

true if is not null, otherwise false. [out] Returns the , which may be empty if there is no . The field for which to get the text span.

Returns the value of the specified field.

If there is an expansion session in progress and the specified field exists and contains a value, returns true; otherwise, returns false. [out] A string containing the value of the field. [in] A string containing the name of the field for which to get a value.

Called after a command has been executed.

If the command was handled, returns true; otherwise, returns false to let the caller handle the command. [in, out] An unmarshaled pointer to a to hold the result of the command, if any. [in] The specific ID of the command from the command group. This identifies the command to execute. [in] This is true if the code snippet has been committed to the source file. [in] An unmarshaled pointer to a holding any parameters required by the command. This can be a null value indicating there are no additional parameters. [in] The GUID of the command group. [in] Additional parameters for the command (packed into a 32-bit value).

Called before a command is executed.

If the command was handled, returns true; otherwise, returns false to let the caller handle the command. [in, out] An unmarshaled pointer to a to hold the result of the command, if any. [in] The specific ID of the command from the command group. This identifies the command to execute. [in] An unmarshaled pointer to a holding any parameters required by the command. This can be a null value indicating there are no additional parameters. [in] The GUID of the command group. [in] Additional parameters for the command (packed into a 32-bit value).

Determines if the specified command is handled by the class.

If the command is supported by the class, returns true; otherwise, returns false. [in] The specific ID of the command from the command group. This identifies the command to execute. [out] Returns a combination of values from the enumeration indicating support for the specified command. [in] The GUID of the command group.

Inserts the specified snippet into the source at the given position.

If a snippet was inserted, returns true; otherwise, returns false. [in] An object representing the view showing the source. [in] A string containing the path to the snippet template file. [in] This is true if there is more than one snippet with the given title and a dialog box must be shown so the user can select which snippet to insert; otherwise, this is false (accept the first snippet with the given title). [in] A object specifying the position where the snippet is to be inserted. [in] A string containing the name or title of the snippet.

Inserts the specific snippet into the source at the specified position.

If the snippet was inserted, returns true; otherwise, returns false. [in] An object containing the snippet to insert. [in] An object representing the view showing the source. [in] A relative path to the snippet template file from which this snippet was taken. [in] A object specifying the position where the snippet is to be inserted.

Determines whether this is valid text for expansion. This method should be overridden if you want to specify where in the source document the expansion can take place.

When overridden in derived classes, if the method succeeds, otherwise an error code. An array of objects. The buffer. The kind of expansion to perform. [out] Returns true if it is a valid expansion kind, otherwise false.

Determines whether or not a given type is valid for expansion purposes. This method should be overridden if you want to specify where in the source document the expansion can take place.

When overridden in derived classes, if the method succeeds, otherwise an error code. An array of objects. The buffer. The number of expansion types in the rgTypes array. An array of expansion types. [out] Returns true if the type is valid, otherwise false.

Called after a snippet has been inserted into the source.

If successful, returns ; otherwise, returns an error code. [in] An object representing the expansion session that is currently active.

Called just before the snippet has been inserted into the source.

If successful, returns ; otherwise, returns an error code. [in] An object representing the expansion session that is currently active.

Called when an item is chosen in a snippet browser.

If successful, returns ; otherwise, returns an error code. [in] A string containing the name of the snippet that was selected. [in] A string containing the path to the snippet template file.

Puts the caret in a position suitable for editing.

When overridden in derived classes, if the method succeeds, otherwise an error code. An array of objects. The buffer.

Prepares for insertion of the specified snippet.

[in] A string containing the path to the snippet template file. [in] A string containing the name of the snippet to insert.

Returns the object used for inserting snippets into a buffer.

Returns the object that was obtained from the object in the class constructor ().

Returns the expansion session created to manage editing the code snippet.

Returns the object that was passed to the method.

Indicates whether the code snippet is currently being edited.

Returns true if the code snippet is currently being edited; otherwise, returns false.

Returns the object associated with this expansion provider.

Returns the object that was passed to the class constructor ().

Returns the text view containing the source file being manipulated by the expansion provider.

Returns the object that was passed to the , , , and methods.

Static utilities for getting and setting file paths.

Initializes a new instance of .

Gets the file extension from a given file path.

The extension (lower case, preceded by "."). The file path.

Get file path for an object that implements .

The file path. A pointer to the IUnknown interface of the file path.

Gets the file path from an buffer.

The file path. The buffer.

Represents the different indenting styles supported by language services.

Pressing Enter inserts a new line and causes the caret to move to the same position as the first non-whitespace character on the previous line.

Pressing Enter inserts a new line and causes the caret to always move to the beginning of the new line.

Pressing Enter inserts a new line and causes the caret to either move to the same position as the first non-whitespace character on the previous line or to indent or outdent automatically depending on the character at the end of the previous line. For example, in C#, pressing Enter after a "{" causes a new line to be inserted and cursor to be indented properly. In addition, the "{" may be moved to its own line. If Enter is pressed after a "}", however, a new line is entered and the caret is moved out one level of indentation.

Used as the interface for a language parser in a language service.

Parses the next language token from the current line and returns information about it.

Returns true if a token was parsed from the current line and information returned; otherwise, returns false indicating no more tokens on the current line. [in, out] The scanner's current state value. [in, out] The structure to be filled in.

Sets the line to be parsed.

[in] The character offset into the line to start parsing. You must pay attention to this value. [in] The line to be tokenized.

Provides support for language service-specific preferences.

Initializes a new instance of the class (default initialization only).

Initializes a new instance of the class (this is the preferred method).

[in] The name of the language service. [in] An object supplying the service provider. This value cannot be null. [in] The GUID of the language service these preferences are associated with.

Applies all changes made to the preferences.

Cleans up any allocated resources before the object is destroyed.

Obtains a boolean value from the specified registry entry.

rue if the registry entry exists and contains a non-zero value or the word "True" (case-insensitive comparison), false if the registry entry exists and contains a zero value or the word "False" (case-insensitive comparison). Otherwise, returns the default value specified in def. Note: if the registry entry is a string, then any string other than "True" or "False" throws a . [in] The default value to use if the registry entry is not found. [in] The name of the registry entry for which to get the value. [in] The object representing the desired registry subkey.

Gets an integer value from the specified registry entry.

The integer value stored in the registry entry if the registry entry exists, otherwise def if the registry entry does not exist. If the registry entry is a string, then the string is evaluated as a number. [in] The default value to use if the registry entry is not found. [in] The name of the registry entry for which to get the value. [in] The object representing the desired registry subkey.

Gets the modifiable user language settings from Visual Studio.

Gets the service provider.

The object that was passed to the constructor.

Initializes .

Gets language service-specific settings from the registry.

[in] The name of the registry subkey containing the desired registry entries. [in] The object representing the desired base registry subkey.

Gets user-modifiable settings.

[in] The name of the registry subkey containing the user settings. [in] A object representing the desired base registry subkey.

Called when a new marker type is registered with Visual Studio.

[in] The ID of the marker type.

Called when a view is registered.

[in] An interface representing the view that has been registered.

Called when the Replace All in Files operation has begun.

if the method succeeded, otherwise an error code.

Called when the Replace All In Files operation has ended.

if the method succeeded, otherwise an error code.

Called when a view is closed.

[in] An interface representing the view that has been closed.

Called when a user preference has been changed.

[in] A structure describing user view preferences. [in] A structure describing user frame-oriented preferences. [in] A structure describing user font and color preferences. [in] A structure describing user language service-specific preferences.

Gets or sets whether members are automatically listed as part of IntelliSense support.

true if a members list should be shown for auto-completion, otherwise false = the list is not to be shown).

Gets or sets whether or not auto-outlining is supported outlining (this requires parser support for hidden regions).

true if auto-outlining is supported, otherwise false.

Gets or sets the number of milliseconds the user must hold the cursor over an identifier before initiating any IntelliSense operation.

The number of milliseconds of delay.

Gets or sets whether to include spaces on blank lines when cutting and copying.

true if blanks are to be preserved while cutting and copying, otherwise false, i.e., all spaces on a blank line are lost when cutting or copying.

Gets or sets if background parsing is supported.

true if background parsing is supported, otherwise false.

Gets or sets whether or not IntelliSense is supported.

true if at least one IntelliSense operation is supported, otherwise false = no IntelliSense operation is supported.

Gets or sets whether or not blocks of code can be commented and uncommented.

true if blocks of code can be commented and uncommented with a single operation, otherwise false = commenting blocks in a single operation is not supported.

Gets or sets whether or not code can be formatted.

true if the code can be formatted, otherwise false = no automatic formatting.

Gets or sets whether or not URLs in the code can be navigated to by a simple click.

true if URLs can be navigated with a single click, otherwise false = either URLs cannot be clicked on or the control key must be held down while clicking.

Gets or sets whether or not matching braces are supported.

true if matching braces are supported, otherwise false.

Gets or sets whether or not matching braces can be shown while typing a matching brace.

true if matching braces can be shown, otherwise false.

Gets or sets whether or not the IntelliSense Quick Info operation is supported.

true if Quick Info is supported, otherwise false.

Gets or sets whether or not the text included in the span of the matching pair is shown in the status bar.

true if the text included in the matching pair span can be shown, otherwise false.

Gets or sets whether or not advanced members are hidden in the IntelliSense members list.

true if advanced members are hidden, otherwise false = show all members.

Gets or sets the flags for highlighting matching braces.

One of the values.

Gets or sets the number of spaces to indent when formatting source.

The number of spaces to use for tab positions while formatting.

Gets or sets the style used for formatting sections of text.

A value from the enumeration.

Gets or sets whether or not to insert tabs instead of spaces when formatting sections of text.

true if tabs should be inserted, otherwise false = spaces should be inserted.

Gets or sets the name the language service is registered under.

The name of the language or null if the name was not set.

Gets or sets whether or not line numbers are to be shown.

true if line numbers are to be shown, otherwise false.

Gets or sets the maximum number of error messages that can be shown at any one time.

The maximum number of error messages that can be shown.

Gets or sets the maximum region time.

The maximum region time.

Gets or sets whether or not the IntelliSense method tip operation is supported.

true if the method tip operation is supported, otherwise false.

Gets or sets whether or not drop-down bars are to be shown.

true if drop-down bars can be shown, otherwise false.

Gets or sets the service provider.

An object or null if the service provider was not set.

Gets or sets the number of spaces a single tab covers.

The number of spaces in a tab character.

Gets or sets whether or not the editor should assume spaces at the end of all lines.

true if each line is considered to have virtual spaces at the end, otherwise false.

Gets or sets whether or not word wrapping is enabled.

true if word wrapping is enabled, otherwise false.

Gets or sets whether or not a glyph should be shown for a line that is word-wrapped.

true if the glyph should be shown, otherwise false.

This is the base class for a language service that supplies language features including syntax highlighting, brace matching, auto-completion, IntelliSense support, and code snippet expansion.

Initializes a new instance of the class.

Adds a code window manager to the language service.

[in] An instance of the object to add.

Invokes a method on another thread.

If successful, returns an object; otherwise, returns a null value if the invoke operation failed. [in] The possible arguments to the method being invoked. [in] The method to invoke.

Starts a parse operation on a background thread.

[in] The object containing the parameters of the parse operation. [in] The that is called when the parsing is complete.

Instantiates a class.

If successful, returns an instance of a class; otherwise, returns a null value. [in] A object, representing the source file. [in] An object representing a code window.

Instantiates a class.

If successful, returns a object; otherwise, returns a null value. [in] A object that the document properties can refer to.

Instantiates a class.

If successful, returns a object; otherwise, returns a null value. [in] an representing the text view receiving the Navigation bar.

Instantiates an class.

If successful, returns an object; otherwise, returns a null value. [in] The name of the function the represents. [in] The that is to use the .

Instantiates an class.

If successful, returns an object; otherwise, returns a null value. [in] The representing the source file.

Creates a request to satisfy the given reason for parsing that is then passed on to the parser.

If successful, returns a object; otherwise, returns a null value. [in] The text to be parsed. This contains the entire source file's text. [in] The describing why the parse operation is being invoked. [in] The object containing the text buffer from which the source was obtained. [in] The object containing the source file. [in] The line number to start parsing on. [in] A structure that is to be filled in by the parsing operation for each token. [in] The character index in the line where parsing starts. [in] The file name of the source file. Can be null or empty.

Instantiates a class.

If successful, returns a object; otherwise, returns a null value. [in] The buffer that the object represents.

Instantiates a class.

If successful, returns a object; otherwise, returns a null value. [in] The object to associate with this view filter. [in] The object that is to receive the new view filter.

Returns the index into the file extension list that matches the extension of the specified file name.

If successful, returns a zero-based index into the file extension list that is returned from ; otherwise, returns -1 to indicate the extension is not in the file extension list. [in] The file name from which to get the extension to look for.

Called to execute the specified command.

If successful, returns ; otherwise, returns an error code. [out] A pointer to a place to return the results of the command. [in] The ID of the command to execute. [in] The GUID of the command to execute. [in] A pointer to possible parameters for the command.

Called when the language service object is being destroyed.

Retrieves the result of an asynchronous call started by .

Returns an object representing the return value from the method called by . [in] The object returned by .

Instantiates a class.

If successful, returns ; otherwise, returns an error code. [out] The new object. [in] The with which to associate a new object.

Returns the object associated with the specified object.

If successful, returns a object; otherwise, returns a null value indicating the specified source is not associated with a particular object managed by this language service. [in] The object for which to get the associated object.

Returns the associated with the specified object.

If successful, returns a object; otherwise, returns a null value indicating there is no associated object for the given object. [in] The object for which to get the associated object.

Returns the requested object.

If successful, returns ; otherwise, returns an error code. [out] Returns the object. [in] A zero-based index into the list of colorable items maintained by the language service.

Iinstantiates a class.

If successful, returns a object; otherwise, returns a null value. [in] An object representing the buffer of text to colorize.

Returns the colorizer associated with a object that contains the given object.

If successful, returns ; otherwise, returns an error code. [in] An object representing the buffer of text to colorize. [out] An object representing the colorizer.

Returns a string containing the file extensions associated with this language.

If successful, returns ; otherwise, returns an error code. [out] Returns the extensions for this language.

Returns a list of file extension filters suitable for a Save As dialog box.

If successful, returns a string containing the file extension filters; otherwise, returns an empty string.

Returns an image list containing glyphs associated with the language service.

If successful, returns an object; otherwise, returns a null value.

Returns the number of custom colorable items supported by the language service.

If successful, returns ; otherwise, returns an error code. [out] The number of custom colorable items available.

Returns an object representing the currently available debugger in order to listen for debugger events.

If successful, returns an object; otherwise, returns a null value.

Returns an object if macro recording is turned on.

If successful, returns an object; otherwise, returns a null value.

Returns the language GUID of the language service.

If successful, returns ; otherwise, returns an error code. [in] The containing the source for which to get the language id. [out] Returns the GUID of the language for the associated source. [in] The line index into the buffer to the source for which to get the language. [in] The character position in the line.

Returns the name of the language this language service handles.

If successful, returns ; otherwise, returns an error code. [out] Returns the name of the language.

Returns a object for this language service.

If successful, returns a object; otherwise, returns a null value.

Returns the GUID of the language service.

Always returns the GUID of the language service.

Obsolete method that always returns .

Always returns . OBSOLETE OBSOLETE OBSOLETE

Returns the name of the enclosing element that contains the given position.

If successful, returns ; otherwise, returns if the location is not within a named entity or returns an error code. [in] The holding the source file. [out] The name of the enclosing element. [in] The desired line in the buffer. [out] The offset from the start of the enclosing element to the given line. [in] The desired offset on the line in the buffer.

Gets the result of the parse operation.

.

Returns a list of expressions to be evaluated and shown in the Autos window, for a given span of lines.

If successful, returns , returns if there are no expressions; otherwise, returns an error code. [out] An object that contains the list of expressions to examine. Return a null value to indicate no expressions. [in] The holding the source file. [in] The first line of the span to examine for expressions. [in] The number of lines to examine. [in] The offset on the first line to start looking for expressions.

Returns a single instantiation of a parser.

If successful, returns an object; otherwise, returns a null value. [in] An representing the lines of source to parse.

Returns a service object that can be cast to a specific interface.

If successful, returns an object that can be cast to a desired interface; otherwise, returns a null value (the service does not exist or is not available). [in] The GUID of the service to get.

Returns an unmarshaled pointer to a requested interface.

[out] Returns an unmarshaled interface pointer or a null value if the interface is not available. [in] The GUID of the desired interface.

Returns an existing object that contains the specified buffer of source.

If successful, returns a object; otherwise, returns a null value (there is no object in this language service that controls that set of source lines). [in] An object containing the lines of source.

Returns an existing object that contains the source file shown in the specified text view.

If successful, returns a object; otherwise, returns a null value (there is no object in this language service that controls the set of source lines shown in the specified view). [in] An object that displays the source file for which to get the object.

Returns an existing object given a file name.

If successful, returns a object; otherwise, returns a null value (there is no object in this language service that represents the specified file name). [in] The file name for which to find the object.

Returns a collection of objects maintained by the language service.

Always returns an object.

Called to initialize the language service.

Called to invoke a task specified by the given delegate.

Returns an object or null if the invoke operation failed. [in] An array of possible arguments for the method. [in] The method to invoke as represented by a object.

Called to determine if macro recording is turned on.

Returns true if macro recording is on; otherwise, returns false.

Called to determine if the specified location in the given source file references code in another file.

If the position in the source file is mapped to another file, return ; otherwise, returns . [in] The containing the source file. [in] The line in the buffer to locate. [in] The offset into the line to locate.

Determines whether or not the source file is open.

true if the file is a member of the sources owned by this service; otherwise false.  The source file.

Returns the index into the file extension list that matches the extension of the specified file name.

If successful, returns ; otherwise, returns an error code. [out] Returns the index into the extension list that references the extension on the given file name. Returns 0 if the extension is not in the list (0 represents "All files"). [in] The file name from which to get the extension to look for.

Returns a list of file extension filters suitable for a Save As dialog box.

If successful, returns ; otherwise, returns an error code. [out] A string containing pairs of descriptions and extensions.

Determines if the specified source format is valid or not.

If the format is not supported, returns ; otherwise, return (the format is supported). [in] The format to test. This is a value from enumeration. [out] An error string describing why or how the format is invalid. Could be as simple as "The XX format is not supported."

Updates the current user help context given a selected region of the given source.

If successful, returns ; otherwise, returns an error code. [in] An object that is to be updated. [in] A set of flags from the enumeration. [in] The object holding the source. [in] A single object describing the selected range of text (or the current caret position).

Called when the current view has changed to a different view.

[in] The object representing the new current view.

Called when the caret has moved.

[in] The new line the caret is on. [in] The object controlling the code window that the caret moved in. [in] The object that holds the view of the source file. [in] the new column the caret is on.

Called when changes generated by an auto-complete or code snippet expansion operation is committed to the buffer.

[in] A single describing the range of lines that was changed. [in] A collection of flags from the enumeration describing the change.

Called to close the specified object.

[in] The object to be closed.

Called when no other events need to be handled.

[in] true if this call is one of a periodic series of idle calls, typically triggered by a timer.

Called whenever the debug mode has changed while debugging.

If successful, returns ; otherwise, returns an error code. [in] The new debug mode as specified by a value from the enumeration.

Called when a background parse has been completed.

[in] The containing the parse request information for the just completed parse operation.

Opens the specified file.

[in] The specified file to open.

Parses the source based on the specified object.

If successful, returns an object; otherwise, returns a null value. [in] The describing how to parse the source file.

Determines if the specified source format is valid or not.

Returns true if the format is not supported by the language service; otherwise, returns false (the format is supported). [in] The format to test. This is a value from enumeration. [out] An error string describing why or how the format is invalid. Could be as simple as "The XX format is not supported."

Returns the request interface from the specified service.

If successful, returns ; otherwise, returns an error code. [out] An unmarshaled pointer to the interface. [in] The GUID of the desired interface. [in] The GUID of the service to query.

Called when the view associated with the specified is closed.

[in] The object that is being closed.

Returns a list of method names that match the given name modified by the specified flags.

If successful, returns ; otherwise, returns an error code. [in] The name to match. [in] A collection of flags from the enumeration. [out] Returns an object containing the list of name or a null value.

Updates the specified view to show the end of the source file.

[in] The view to update.

Updates the view in the specified window frame to show the end of the source file.

[in] The containing the view to update.

Called to set or site the service provider for this language service.

[in] The object that is to be the parent service provider for this language service. This cannot be a null value!

Marks the user context as dirty in the specified source buffer.

[in] The file name of the source buffer for which to mark the user context dirty.

Called to update a drop-down bar based on the current caret position.

Updates the current user help context in a selected region of the given source.

[in] A set of flags from the enumeration. [in] The object holding the source. [in] An object that is to be updated. [in] A single object describing the selected range of text (or the current caret position).

Called to determine if the given location can have a breakpoint applied to it.

If successful, returns ; otherwise returns if there is no code at the given position or returns an error code (the validation is deferred until the debug engine is loaded). [in] The object containing the source file. [out] Returns the giving the extent of the code affected by the breakpoint if the breakpoint can be set. [in] The line number where the breakpoint is to be set. [in] The offset into the line where the breakpoint is to be set.

Determines if a method must be invoked across a thread boundary.

Returns true if a method must be invoked across thread boundaries; otherwise, returns false.

Determines whether the language service is connected to the current view and therefore is active.

Returns true if the currently active view belongs to this language service; otherwise, returns false, the language service is not currently active.

Determines if the debugger is active.

This property returns true if the debugger is active; otherwise, returns false.

Determines if a background parse is in progress.

Returns true if a background parsing operation is running; otherwise, returns false.

Returns the last active text view associated with this language service.

Returns the last active text view as represented by an interface; otherwise, returns a null value.

Returns the id of the thread this language service is running on.

Returns a thread id.

Returns the name of the language (for example, "C++" or "HTML").

Returns a string containing the name of the language. This must return the same name the language service was registered with in Visual Studio.

Provides access to the language service preferences.

Always returns a object.

Returns the service provider given to this language service.

Returns an object or a null value if was not called with a valid service provider.

Provides support for the IntelliSense method tip operation.

Initializes a new instance of the class.

[in] An object that is to be used as the service provider.

Update the current parameter, either forward or backward, by the specified amount.

[in] A value to add to the current parameter index. This is negative if the parameter index is to be decremented.

Closes the method tip and clears the object.

Dismisses the method tip from view.

Frees any allocations made just before the object is destroyed.

Converts the current context span to a file position and length.

If successful, returns ; otherwise, returns an error code. [out] Returns the position in the source file that corresponds to the start of the context span. [out] Returns the length of the span.

Returns the currently visible method signature.

Returns a number representing the currently visible method signature in the object.

Returns the current parameter being edited in the specified method signature.

Returns the current index into the parameter list for the specified method signature. [in] An index in the object to the specified method signature.

Returns the specified text for the specified method signature.

If successful, returns a marshaled pointer to the requested string; otherwise, returns a null value. [in] A value from the enumeration specifying what type of text to return. [in] An index in the object to the specified method signature.

Returns the number of method signatures that can be shown.

If there is at least one method signature, returns the number of method signatures available; otherwise, returns 0.

Returns the number of parameters available for the specified method signature.

If successful, returns the number of parameters; otherwise, returns 0. [in] An index in the object to the specified method signature.

Returns the specified parameter text for the specified method signature.

If successful, returns a marshaled pointer to the requested string; otherwise, returns a null value. [in] A value from the enumeration specifying what type of text to return. [in] An index to the specified parameter. [in] An index in the object to the specified method signature.

Moves to the next method signature and returns the index of the current method signature.

Returns a number representing the current method signature.

Called after the method tip is removed from view.

Moves to the previous method signature and returns the index of the current method signature.

Returns a number representing the current method signature.

Displays the method tip with the given method signatures.

[in] The parameter to be highlighted initially. Set this to -1 to start before the first parameter. This value is typically determined by parsing what the user has typed so far since the start of the parameter list. [in] A object representing the method signatures to be displayed. [in] A object specifying the initial span containing the method name that has already been typed. [in] An object representing the view that displays the method tip.

Updates the method tip display.

Determines if the method tip is visible.

If the method tip is displayed, returns true; otherwise, returns false.

Determines the list of method signatures that can be displayed in the method tip.

Returns the object that was passed to the method.

Determines the method tip window as represented by an interface.

Returns the object that was created in the class constructor.

Determines the service provider.

Returns the object that was passed to the class constructor.

Determines the view the method tip is displayed on.

Returns the object that was passed to the method.

Represents a collection of method signatures obtained from a parsing operation in a language service.

When implemented in a derived class, initializes a new instance of the class.

When implemented in a derived class, gets the number of overloaded method signatures represented in this collection.

The number of signatures in the collection.

When implemented in a derived class, gets the description of the specified method signature.

The description of the specified method signature, or null if the method signature does not exist. [in] An index into the internal list to the desired method signature.

When implemented in a derived class, gets the name of the specified method signature.

The name of the specified method, or null. [in] The index of the method whose name is to be returned.

When implemented in a derived class, gets the number of parameters on the specified method signature.

The number of parameters on the specified method signature, or -1. [in] An index into the list of method signatures.

When implemented in a derived class, gets information about the specified parameter on the specified method signature.

[out] Returns a string containing a description of the parameter. [out] Returns the parameter name and type formatted for display. [in] An index into the parameter list of the specified method signature. [out] Returns the name of the parameter. [in] An index into the list of method signatures.

When implemented in a derived class, gets the return type of the specified method signature.

The return type of the specified method signature, or null. [in] An index into the list of method signatures.

Gets the character to use at the end of a method parameter list.

The character to use at the end of a parameter list.

Gets the index of the initial method signature to show.

The index of the first method signature to show the user when the IntelliSense method tip is displayed.

Gets the character that separates parameters in a method's parameter list.

The parameter list separator.

Gets the character to use at the start of a method's parameter list.

The character to use at the start of a parameter list.

Gets the string to place after the return type of a method.

The string to use after a method's type.

Gets the string to place before the return type of a method.

The string to place before a method's return type.

Gets whether a method's return type comes before or after the method signature.

true if the type precedes the method's signature, false if the type follows the method's signature.

Provides reasons for a parsing operation in a language service.

Parse the code block at the given location to obtain any expressions that might be of interest in the Autos debugging window (an expression is the name of variable or parameter that can be evaluated to produce a value).

Parse the entire source file, checking for errors. This pass should also create lists of matching language pairs, triplets, members, and methods.

Parse the section of code containing the specified location to find the extent of the statement. Used in validating breakpoints.

Parse to get the partially completed word before the current position in order to show a list of possible completions (members, arguments, methods).

Parse the separator and the possible name before it, to obtain a list of members to be shown in a member completion list.

Parse the identifier or expression at the specified location to obtain a possible URI of a file where the identifier is defined, declared, or referenced.

Parse to find the matching language pairs (such as "{" and "}" or "<" and ">") that enclose the given location so they and their contents can be highlighted.

Parse the language pair at the given location to finds its match.

Parse the separator character before the current location to obtain a list of members for the class.

Parse the character at the current location to complete a member selection and to highlight the matching pair to the parsed character (such as a ")" after a method name).

Parse the method name before the current position to produce a list of all overloaded method signatures that match the method name.

A placeholder value indicating that no parsing should be done.

Parse the identifier or selection at the given location to obtain type information to be shown in an IntelliSense quick info tool tip.

Provides information to execute a parsing operation in a language service.

Initializes a new instance of the class in order to terminate the thread used for background parsing operations.

[in] Set to true if the parsing operation is to be terminated. For this constructor, this argument is must always true.

Initializes a new instance of the class.

The reason the parsing operation was started. The view that contains the source file that is being parsed. The name of the source file to be parsed. The object used to contain information from the parsing operation. true if the request is synchronous, false if it is asynchronous. The line on which to start the parsing operation. The text to be parsed. The object that is to be filled with the results of the parsing operation. The character offset on the first line to begin the parsing operation.

Specifies the callback delegate to be called when the parsing operation has completed.

Returns a delegate.

Specifies the character offset on the first line to begin the parsing operation.

Returns a number specifying the character offset that was passed as an argument to the class constructor.

Specifies a span of source that has changed.

Returns a object specifying a span of source.

Specifies the name of the source file being parsed.

Returns the string containing the file name that was passed to the class constructor.

Gets or sets whether or not the request is synchronous.

true if the request is synchronous; false if it is asynchronous.

Specifies the line on which to start the parsing operation.

Returns a number specifying the line number that was passed to the class constructor.

Specifies the reason the parsing operation was started.

Returns the value passed to the class constructor.

Specifies the object that is used to return extended information from the parsing operation.

Returns an object.

Specifies an object used to contain information from the parsing operation.

Returns an object that was created in the class constructor.

Specifies whether the worker thread handling background parsing operations should exit.

Returns true if the worker thread should exit.

Specifies the source text to be parsed.

Returns a string containing the source to be parsed as passed to the class constructor.

Specifies a time stamp for the parse request.

Returns a number that represents a point in time.

Specifies a structure that is filled in with the results of the parsing operation.

Returns the object that was passed to the class constructor.

Specifies the object representing the view that contains the source that is being parsed.

Returns the object that was passed to the class constructor.

Used to define a delegate for a parsing operation completion handler in a language service.

Specifies the severity of a parser error in a language service.

Indicates an error in parsing, however, parsing may have been able to continue.

Indicates a fatal error in parsing that prevented any further parsing.

Indicates a comment returned by the parser.

Indicates a warning returned by the parser.

The abstract class that represents a generalized simple editor view.

Initializes a new instance of for the supplied text buffer.

The buffer.

Closes the window and unregisters the component.

true if successful, otherwise false.

Commits any changes made to the file.

if the method succeeded, otherwise an error code. [out] Returns true if the changes could not be committed.

Creates the window.

If the method succeeds, it returns . If it fails, it returns an error code. The absolute y ordinate. A pointer to the parent window. [out] A pointer to the new window pane. The height of the window. The width of the window. The absolute x ordinate.

Executes the specified command.

if the command is supported and it succeeded; if the command is not supported; or an error code if the command failed. Pointer to a VARIANTARG structure containing command output. Can be null. Pointer to a VARIANTARG structure containing input arguments. Can be null. An enumeration giving command options. The GUID of the command group. The ID of the command.

Executes specific commands.

if the command is supported and it succeeded, if the command is not supported, or an error code if the command failed. Pointer to a VARIANTARG structure containing command output. Can be null. The ID of the command. An enumeration giving command options. Pointer to a VARIANTARG structure containing input arguments. Can be null. The GUID of the command group.

Called during each iteration of the message loop.

true if the message loop should continue, false otherwise. An array of structures. May be null. A pointer to private data. An enumeration of type .

Called to do idle time tasks.

true if more time is needed to perform the idle time tasks, false otherwise. Flags from the enumeration.

Called to process or modify the message before it is translated and dispatched.

true if the message is consumed, false otherwise. An array of structures.

Called when the component manager wishes to know whether the view is in a state in which it can terminate.

true if the component can terminate, otherwise false. true if the user should be prompted if it is necessary to terminate, false if the user should not be prompted.

Reserved method.

Always true. Reserved. Do not use. Reserved. Do not use. Reserved. Do not use. Reserved. Do not use.

Gets the default size of the window.

. An array of structures.

Gets a window associated with the component.

A pointer to the desired window or null if no such window exists. Reserved for future use; should be 0. A value from .

Determines whether the toolbox user supports the referenced data object.

If the method succeeds, it returns , otherwise it returns . .

Sends notification that an item in the toolbox has been selected (by clicking the mouse or by pressing ENTER).

If the method succeeds, it returns . If it fails, it returns an error code. The that has been selected.

When implemented in a derived class, loads the view state of the window pane.

When implemented in a derived class, if the method succeeds, otherwise an error code. The from which to load the state of the view.

Called when a new object is being activated.

Reserved for future use. true if it the host that is being activated, otherwise false. if it is the view itself that is being activated, otherwise null. true if pic is the same component as the callee of this method, otherwise false. An array of structures, which represent registry information for pic. An array of structures, which represent host information.

Notifies the component whenever the host application is activated or deactivated.

If true, the host application is being activated, otherwise it is being deactivated. If the host application is being activated, the ID of the thread that owns the window being deactivated. If the host application is being deactivated, the ID of the thread owning the window being activated.

Notifies the view when the application enters or exits a given state.

true if the application is entering the specified state, false if it is exiting the state. The state being entered or exited, specified by the enumeration.

Notifies the active view that it has lost its active status because the host or another component has become active.

Gets the status of the specified command.

By default this finds the menu commands and returns their status, otherwise returns .When overridden by derived classes to provide custom command status, it should return or . The ID of the command. The GUID of the command group to which the command belongs.

Gets the parameters for a command.

Usually returns if the command succeeded, or . Pointer to a VARIANTARG structure containing output data. This should be pre-allocated as an empty Object ready to receive the result string. Pointer to a VARIANTARG structure containing input arguments. Can be null. Values taken from the enumeration, which describe how the object should execute the command. The GUID of the command group to which the command belongs. The ID of the command.

Gets the status of the specified commands.

if all commands are enabled, or an error code. Pointer to a structure for command text. An array of command IDs to query. The GUID of the command group to which the commands belong. The number of commands to query.

Saves the loaded view state.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code. The to which to save the view state.

Sets the information in the status bar to reflect this view.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code.

Initializes this view.

. The main .

Called by the component manager when it wishes to terminate the view's registration.

Handles the translation of special navigation keys.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code. An array of structures holding the keyboard character or character combination to be handled.

Gets or sets the text buffer.

.

Gets or sets the component ID of the editor view.

The component ID of the editor view.

Gets or sets the component manager for this view.

.

Gets or sets the for this view.

.

Represents a source file in the language service and controls parsing operations on that source.

Initializes a new instance of the class.

The object representing the language service that controls this instance. This is required and cannot be null. The object representing the source file. This is required and cannot be null. The object to use for syntax highlighting. This is required and cannot be null.

Begins a full parsing operation either in the foreground or the background.

Determines whether the source file can be closed.

true if the source file can be closed; otherwise, returns false.

Gets the screen column position corresponding to the specified character offset, taking into account tab size.

The screen column position that corresponds to the specified col parameter. The line of source to look at. The offset into the line of source.

Comments out a span of source using block comments.

A object encompassing the entire commented block, including the added comment start and end strings. A object describing the span of source to put into a block comment. A string that specifies the block comment end character or characters. A string that specifies the block comment start character or characters.

Comments out a span of source using line comments.

Returns a object encompassing the entire commented block, including the added line comment start string. A object describing the span to put into line comments. The string that specifies the line comment character or characters.

Comments out the specified span of source.

A new object encompassing the entire commented out span, including any comment start and end strings. A object describing the span of source to comment out.

Starts an IntelliSense member completion operation.

A value from the enumeration specifying how this completion operation was triggered. The object representing the view the completion list is shown in. The object representing the token that triggered the completion operation.

Creates an instance of an object for use in parsing operations.

Returns an object. A value from the ParseReason enumeration describing the reason for the parse operation. The line index where the parsing is to start. The column index where the parsing is to start.

Creates a new instance of a class.

A object.

Creates a new error task item for the Error List, for the supplied text, marker type, and file name.

A new instance of . A structure, which defines a block of text. A member of the enumeration. The name of the file.

Creates a new error task item for the Error List, for the supplied text, file name, message, priority, category, marker type, and error type.

A new instance of . A structure, which defines a block of text. A member of the enumeration. The error message. A member of the enumeration. A member of the enumeration, which defines the level of error. A member of the enumeration. The name of the file.

Creates a new instance of a object that handles the IntelliSense method tip mode.

A object.

Removes the IntelliSense method tip or completion list from view, whichever was active.

Called in preparation of destroying this object.

Executes the specified command on the specified region.

If successful, returns ; otherwise, returns an error code. If support for commands on a hidden region is not needed, returns . An object representing the hidden region to apply the command to. A value from the enumeration specifying the command to execute.

The class destructor, called just before the object is destroyed.

Gets the colorizer associated with this object.

The object that was passed to the class constructor.

Gets information on what defines a comment in the language.

A structure containing the strings that define a comment.

Gets the span occupied by the entire source file.

A object that encompasses the entire source file.

Gets an expansion provider in support of code snippets.

If successful, returns an object; otherwise, returns null (code snippet expansion is not supported).

Gets the file name of the source file.

The file name of the source file.

Gets the hidden region manager if available.

If successful, returns an object representing the hidden region manager; otherwise returns null.

Gets the text on the specified line.

The text at the specified line number. This could be an empty string. The line number for which to get the text.

Gets the number of lines in the source file.

A number representing the number of lines in the source file. This value can be 0.

Gets the line and column for the specified position.

The position or character offset into the source file. [out] Returns the line number corresponding to the position. [out] Returns the column number (offset on the line) corresponding to the position.

Gets the length of the specified line.

A number representing the number of characters on the line. The line number for which to get the length.

Determines which marker commands can be shown on a context menu for the specified hidden region.

If successful, returns ; otherwise, returns an error code. If support for commands on a hidden region is not needed, return . An object describing the hidden region. A value from the enumeration specifying the command to examine. [out] Returns the string to show on the context menu if the specified command is supported. [out] Returns a set of flags from the enumeration indicating whether the command is supported.

Gets the newline character used at the end of the specified line.

The newline character from the end of the line. The line number from which to get the new line character.

Returns the span that encompasses a matching pair of language elements between which is the given location.

The line number in the source. [out] A object containing the span of the enclosing paired elements. An object that represents the view containing the source to examine. The offset on the line.

Gets the position corresponding to the given line and character offset location.

The position or character offset from the start of the source file. The line number of the location. The offset on the line of the location.

Gets the task provider that manages the error tasks.

A object.

Gets all of the text of the source file.

The entire source file.

Gets the text included in the text span.

The text included in the text span. A structure, which defines a block of text.

Gets the text between the specified locations.

The desired text. This can be an empty string. The first line of text to obtain. The last line of text to obtain. The offset on the last line to the last character to obtain. The offset on the first line to the first character to obtain.

Gets the object associated with this object.

The object passed to the class constructor.

Gets the text from the source up to and including the given line number.

All the text up to and including the given line. The line number of the last line of text to obtain. Specify 0 to obtain all the text in the source.

Gets the text in the given hidden region to be used in a tool tip.

If successful, returns ; otherwise, returns an error code. The object from which to obtain the text to display. [out] Returns the text from the hidden region.

Gets information about the token at the specified position.

A object containing information about the current token. The number of the line containing the token to examine. The character offset in the line to the token to examine.

Gets the index of the object that includes the supplied column number.

The index of the object which includes the specified column number, or -1 if it is not found. The array of objects to search. [ref] A object. The column number to find.

Gets the user data associated with the specified GUID.

If successful, returns an object representing the requested data; otherwise, returns an error code. The GUID specifying what user data to retrieve.

Gets the span occupied by the word at the specified location.

true if the word was found; otherwise, false, meaning that there is no word at that position. [out] Returns the offset of the first character of the word. The line on which the word to examine is located. A combination of flags from the enumeration. The offset into the line to somewhere in the word (does not have to be at the beginning of the word). [out] Returns the offset of the character one past the last character of the word.

Ensures that the given span in the given hidden region is visible.

If successful, returns ; otherwise, returns an error code. If this method is not implemented, return the field. An object representing the hidden region to make visible. A object describing the region to be made visible.

Highlights the spans of a pair of language elements, given the position of one of the elements.

The line number of the language element for which to find a match. An object representing the view on the source file. A object containing the information about the token (that is, the language element for which to find a match) under the given location. The offset on the line of the location.

Displays an IntelliSense method tip showing a method's signature as it is entered.

The line number where the user is entering text. An object representing the view containing the source file. A object representing the token that triggered the method tip (typically, this is the parameter list start character, end character, or parameter separator character). The offset into the line where the user is entering text.

Converts the newlines in the specified text to the specified newline.

Returns a string containing the converted text. The text in which to convert the newlines. The newline to which to convert.

Called just before a hidden region session is closed.

Called when one or more lines' attributes (font, color) have changed.

The last line that was changed. The first line that was changed.

Called when a line's text has changed.

The object that describes the line that was changed. Nonzero if the last line of the source is included in the change; otherwise, this is zero.

Called when a code snippet is committed to the source file.

A value from the enumeration describing why the change was committed. A object describing the total area that was changed.

Handles IntelliSense-oriented commands.

The character that was typed. An object representing the view containing the source where the command was entered. A value from the enumeration specifying the command that was entered.

Called when a hidden region has changed.

An object representing the hidden region that has changed. Nonzero if it is safe to change the source buffer as a result of the change; otherwise, the source buffer must remain untouched. A value from the enumeration describing how the region has changed.

Called when no other events are being handled.

true if this call is a result of a periodic timer; otherwise, this is a truly idle call.

Called when user data has been changed in a text buffer.

The GUID representing the value that was changed. A containing the new value.

Marks the object as being open.

Updates all hidden regions based on the given list of hidden regions.

An of objects describing new hidden regions to add.

Updates the syntax highlighting on the specified range of lines.

The first line to update. The last line to update.

Format the specified span of source.

A object describing the range of lines to be reformatted. An object that contains the source to be reformatted.

Removes all hidden regions from the current view.

Removes the specified error task from the error Task window.

A object representing the error task to remove.

Returns the offset of the first non-whitespace character on the given line.

A character offset to the first non-whitespace character. The line number to examine.

Replaces the source contents with the given text.

The new text.

Replaces the specified span of source with the given text.

A string holding the new text. A object describing the span to replace.

Replaces the specified section of source with the given text.

The new text. The first line of source to replace. The last line of source to replace. The last character offset on the last line to replace. The beginning offset of the first character on the first line to replace.

Sets the given user data property to the given value.

An object representing the value to set. The GUID of the user data property to set the value for.

Adjusts the given span to skip leading and trailing whitespace.

[in, out] A object representing the span to modify. Returns the adjusted span.

Removes comment characters from around the specified span.

A new object describing the span after the comment characters have been removed. A object describing the span to uncomment. A string holding the characters that end a block comment. A string holding the characters that start a block comment.

Removes line comment characters from the beginning of each line in the given span.

A new object describing the span after the line comment characters have been removed. A object describing the range of lines to examine. The characters that start a line comment.

Removes any comment characters from the beginning and end of the given span.

A new object describing the span after the comment characters have been removed. A object describing the range of lines to examine.

Gets the character offset on the given line corresponding to the specified screen column position.

The character offset into the line. If the visible position is off the end of the line, then return the length of the line. The screen column to convert. The number of the line to examine.

Gets the number of changes made to the source file since it was opened.

The number of times the source file was changed.

Gets or sets the object that is used in various parsing tasks.

The interface that is obtained from the object passed to the constructor.

Gets whether the parser has completed at least once.

true if the parser has completed at least once, otherwise false.

Gets the collection used for this instance of the class.

The object created in the constructor.

Gets a range that identifies the changed lines in the source.

A object containing the range of lines that have been changed in the source file.

Gets the current state of the source file.

true if the source file is closed; otherwise false.

Gets whether the IntelliSense member completion or method tip modes are active.

rue if the completion or method tip modes are active; otherwise, returns false.

Gets or sets whether any of the lines of source have changed.

true if at least one line of source has changed; otherwise, returns false.

Gets the language service associated with the source file.

The object passed to the constructor.

Gets the duration of the last parse operation.

The duration of the last parse.

Gets or sets whether outlining is currently enabled.

true if outlining is enabled, otherwise false.

A utility class that provides useful methods for manipulating and comparing instances of the class as well as validating positions.

Sets the members of the specified span to an empty state.

[in] The object to clear.

Determines if the given position is contained within the given span, not including the start and end points.

Returns true if the given position is greater than the start of the span and less than the end of the span. Returns false if the position is exactly equal to the start or end of the span or the position is outside the span. [in] The object that is being tested against. [in] The line index of the position to test. [in] The column index of the position to test.

Determines if the given position is inside the span, including the start and end points.

Returns true if the given position is greater than or equal to the start of the span and less than or equal to the end of the span. Returns false if the given position is entirely outside the span. [in] The object that is being tested against. [in] The line index of the position to test. [in] The column index of the position to test.

Determines if the first span ends after the end of the second span.

Returns true if the end of span1 is greater than the end of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the first span ends after the start of the second span.

Returns true if the end of span1 is greater than the start of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the first span ends before the end of the second span.

Returns true if the end of span1 is less than or equal to the end of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the first span ends before the start of the second span.

Returns true if the end of span1 is less than or equal to the start of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the first span intersects the second span.

Returns true if the start of span1 is less than the end of span2 and the end of span1 is greater than the start of span2; otherwise, returns false. Notice that the spans do not intersect if one span ends exactly where the other begins. [in] The second object. [in] The first object.

Determines if the given position occurs after the end of the given span.

Returns true if the given position is greater than the end of the given span; otherwise returns false. [in] The object that is being tested against. [in] The line index of the position to test. [in] The column index of the position to test.

Determines if the given position occurs before the start of the given span.

Returns true if the given position is less than the start of the given span; otherwise, returns false. [in] The object that is being tested against. [in] The line index of the position to test. [in] The column index of the position to test.

Determines if the first span is wholly contained within the second span.

Returns true if the two spans are different and the start of span1 is equal to or greater than the start of span2 and the end of span1 is less than or equal to the end of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the given span is empty.

Returns true if the given span is empty; otherwise, returns false. [in] The object that is being tested.

Determines if the start of the given span occurs before the end of the span.

Returns true if the start of the span is less than or equal to the end of the span; otherwise, returns false. [in] The object that is being tested.

Determines if two spans are the same.

Returns true if the start of span1 equals the start of span2 and the end of span1 equals the end of span2; otherwise, returns false. [in] The second object. [in] The first object.

Makes the given span positive.

[in] The object to be modified.

Merges the two given spans to create a new span.

Returns a object that is the result of merging span1 and span2. [in] The second object to be merged. [in] The first object to be merged.

Pins the ends of the given span to the actual line lengths in the given text buffer.

[in] The object to be modified. This object can be null. [in] An object to normalize against.

Determines if the first span starts after the end of the second span.

Returns true if the start of span1 is greater than or equal to the end of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the first span starts after the start of the second span.

Returns true if the start of span1 is greater than or equal to the start of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the first span starts before the end of the second span.

Returns true if the start of span1 is less than the end of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the first span starts before the start of the second span.

Returns true if the start of span1 is less than the start of span2; otherwise, returns false. [in] The second object. [in] The first object.

Determines if the given position is valid for the given source buffer.

Returns true if the given position lies within the given source buffer; otherwise, returns false. [in] The column index of the position to test. [in] The line index of the position to test. [in] A object to validate against. This can be a null value. See Remarks.

Determines if the given span lies within the given source buffer.

Returns true if the span lies entirely within the source buffer and is positive; otherwise, returns false. [in] The object representing the span to test. [in] A object to validate against.

Provides a default implementation of for use in the for displaying tool tips.

This constructor sets a service provider.

A service provider.

Dismisses the tool tip based on mouse proximity to something that has a tool tip.

The view the text tip floats over.

Dismisses and releases the tool tip.

The view associated with the tool tip.

Retrieves the position and length of the tool tip.

. The length of the tool tip. The position of the tool tip.

Returns the font of the tool tip window.

Returns . Number of characters to consider. Pointer to a structure that describes font.

Populates pbstrText with the tip text.

If pbstrText is NULL or has a length of zero, returns , otherwise returns . Font information about the provided data. The populated text tip data.

Tests if the tool tip window is currently visible.

Returns TRUE if the tool tip window is currently visible.

Sets the tool tip window to inactive.

Adds the supplied data to this text tip.

The position of the tip. The that should be updated. The length of the tip. The text of the tool tip.

A virtual method that your subclass of TextTipData can implement to provide extra functionality on update.

Provides initial values for color indices as reported by an scanner.

= 2. Represents the color for a comment.

= 3. Represents the color for an identifier or name (for example, a class, method, or variable name).

= 1. Represents the color for a language keyword (for example, "for", "if", or "else").

= 5. Represents the color for a number (a string of decimal or hexadecimal digits).

= 4. Represents the color for a string, typically bounded by single or double quotes.

= 0. The default. This represents the color corresponding to the user's default text colors (the language service's list is ignored in this one case).

Provides information about a particular token encountered by a language service's language parser.

Initializes a new instance of the class to the default values.

Initializes a new instance of the class to the specified values.

[in] A value from the enumeration identifying the token's type. [in] The last character of the token. [in] The first character of the token.

Determines the color index to use for the token.

Returns a color index cast to a enumeration.

Determines the index of the last character of the token.

Returns an integer specifying the last character of the token.

Determines the index of the first character of the token.

Returns an integer specifying the first character of the token.

Determines the token ID as represented by the object.

Returns an integer specifying the token ID.

Determines the various triggers that can be set for the token.

Returns a combination of flags from the enumeration.

Determines the type of the token.

Returns a value from the enumeration.

Specifies a set of triggers that can be fired from an language parser.

The opening or closing part of a language pair has been parsed. For example, in C#, a { or } has been parsed. In XML, a < or > has been parsed.

A character that indicates that the start of a member selection has been parsed. In C#, this could be a period following a class name. In XML, this could be a < (the member select is a list of possible tags).

This is a mask for the flags used to govern the IntelliSense Method Tip operation. This mask is used to isolate the values , , , and .

Used when no triggers are set. This is the default.

A parameter in a method's parameter list has been parsed.

A character that marks the end of a parameter list has been parsed. For example, in C#, this could be a close parenthesis, ")".

A character that separates parameters in a list has been parsed. For example, in C#, this could be a comma, ",".

A character that marks the start of a parameter list has been parsed. For example, in C#, this could be an open parenthesis, "(".

Specifies the different types of tokens that can be identified and returned from a language service scanner.

A block comment. For example, in C# or C++, a comment is bounded by /* and */. In XML, the comment is bounded by <!-- and -->.

A token that operates as a separator between two language elements. For example, in C#, the period "." between class name and member name. In XML, the angle brackets surrounding a tag, < and >.

An identifier or name. For example, the name of a variable, method, or class. In XML, this could be the name of a tag or attribute.

A language keyword, an identifier that is reserved by the language. For example, in C#, do, while, foreach, if, and else, are all keywords.

A line comment (comment is terminated at the end of the line). For example, in C# or C++, a comment is preceded by a //. In Visual Basic, this is a single tick '.

A literal value (a character or number). For example, in C# or C++, this is a character bounded by single quotes, or a decimal or hexadecimal number.

A punctuation character that has a specific meaning in a language. For example, in C#, arithmetic operators +, -, *, and /. In C++, pointer dereference operator ->, insertion operator >>, and extraction operation <<. In XML, assignment operator =.

A string. Typically defined as zero or more characters bounded by double quotes.

General text; any text not identified as a specified token type.

The token is an unknown type. This is typically used for any token not recognized by the parser and should be considered an error in the code being parsed.

A space, tab, or newline. Typically, a contiguous run of any whitespace is considered a single whitespace token. For example, the three spaces in "name this" would be treated as one whitespace token.

Provides support for the combo boxes showing type and member information as offered by a language service.

Initializes a new instance of the class.

[in] A object representing the language service that uses the combo boxes.

Cleans up any allocated resources just before the object is destroyed.

Returns information about the specified combo box.

If successful, returns ; otherwise, returns an error code. [out] A combination of flags from the enumeration describing the type of entries to appear on the combo box. [out] An unmarshaled handle to an object used for glyphs. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box). [out] The number of entries to be shown on the combo box.

Returns text to be shown in a tool tip when the cursor is held over the combo box.

If successful, returns ; otherwise, returns an error code. [in] The ID of the combo box to get the tool tip text for (0 for the types combo box, 1 for the members combo box). [out] The text to be shown in a tool tip.

Returns the font attributes for the specified entry on the specified combo box.

If successful, returns ; otherwise, returns an error code. [in] The index of the entry for which to get the attributes. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box). [out] Returns the collection of flags from the enumeration for the requested entry.

Returns the glyph index for the specified entry on the specified combo box.

If successful, returns ; otherwise, returns an error code. [in] The index of the entry for which to get the image index. [out] Returns the index in the image list to the glyph for the specified entry. Returns -1 if there is no glyph or the entry does not exist. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box).

Returns the text to be displayed for the specified entry in the specified combo box.

If successful, returns ; otherwise, returns an error code. [in] The index of the entry for which to get the text. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box). [out] Returns a string containing the text to be displayed in the combo box for the specified entry. Returns null if the entry does not exist.

Returns the specified entry for the specified combo box.

If successful, returns a object describing the request entry; otherwise, returns null. [in] The index of the entry to get. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box).

Called when a combo box gets the focus.

If successful, returns ; otherwise, returns an error code. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box).

Called when an item is chosen from the specified combo box.

If successful, returns ; otherwise, returns an error code. [in] The index of the entry that was chosen. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box).

Called when an entry is highlighted in one of the combo boxes.

If successful, returns ; otherwise, returns an error code. [in] The ID of the combo box (0 for the types combo box, 1 for the members combo box). [in] The index of the entry that was highlighted.

Called to fill and synchronize all combo boxes.

If successful, returns true if the combo boxes have been changed; otherwise returns false. [in] The line number the caret is currently on. [in, out] An of s representing the members combo box. [in, out] An of s representing the types combo box. [in] A object representing the language service that uses the combo boxes. [in] An object representing the view the combo boxes are placed in and the view that shows the source file. [in, out] The index of the entry to be selected in the types combo box. This can also be set if the current selection is invalid. [in, out] The index of the entry to be selected in the members combo box. This can also be set if the current selection is invalid. [in] The character offset the caret is currently on.

Called to specify the object that controls the two combo boxes.

If successful, returns ; otherwise, returns an error code. [in] The object that controls the two combo boxes.

Represents an object that can be interpreted as more than one type.

Interprets the object's value as a Unicode character if the variant type is .

If the variant type is , returns the value interpreted as a character; otherwise, returns 0.

Converts the given variant object to a class object.

If successful, returns a object containing the value of the marshaled variant object; otherwise, returns an empty object. [in] An to be marshaled as a variant object.

Determines the value of this object.

Returns a number that is a literal interpretation of the object's pointer.

Determines the type of the object.

Returns a value from the enumeration, specifying the type of the variant.

Specifies the type of a variant object as used by a managed package framework (MPF) language service class.

An array of variants.

An arbitrary block of memory.

An arbitrary block of memory representing an object.

A value representing true (-1) or false (0).

A string.

A reference to an object.

A C-style array (an array of pointers).

A value specifying a clipboard format.

A GUID for a class (a CLSID).

A Currency value (fixed decimal point value stored in 64-bits).

A DATE object.

A decimal number stored as a string.

An object that implements the interface.

An empty variant.

An error code (typically returned from a Win32 function).

A value.

An HRESULT or COM return value.

A 1 byte (8-bit) signed integer.

A 2 byte (16-bit) signed integer.

A 4 byte (32-bit) signed integer.

An 8 byte (64-bit) signed integer.

Represents an illegal variant type.

A bit mask to isolate valid variant types.

A generic integer (typically a 32-bit value).

A pointer to a null-terminated ANSI string.

A pointer to a null-terminated wide character (Unicode) string.

A null value.

A generic pointer.

A 4 byte real number, also known as a float.

An 8 byte real number, also known as a double.

Reserved for future use.

An array that is guaranteed to be at least empty (that is, it is never a null value).

Name of the storage.

A storage object.

A stream of bytes.

A stream that contains an object.

A bit mask to isolate valid variant types.

A 1 byte (8-bit) unsigned integer.

A 2 byte (16-bit) unsigned integer.

A 4 byte (32-bit) unsigned integer.

An 8 byte (64-bit) unsigned integer.

A generic unsigned integer (typically 32-bits).

An object implementing the interface.

A user-defined blob.

A reference to a variant object.

An array with a leading count value.

A C-style void type.

This class handles various editing and IntelliSense commands for a language service.

Initializes a new instance of the class.

[in] An object this class is to work with. This is required and cannot be a null value. [in] A object that owns this view. This is required and cannot be a null value.

Determines whether the source can be reformatted by the language service.

true if the source can be reformatted, otherwise false: either the debugger is active or the language service does not support reformatting.

Closes down the view filter, releasing any allocated resources.

Handles the command to comment out the current selection in the view.

Creates a new instance of the class.

Returns a new object.

Frees up any resources allocated when the class was created.

Executes the specified command.

If successful, returns ; otherwise, returns an error code. [in, out] An unmarshaled pointer to a object to hold the result of the command, if any. [in] The specific ID of the command from the command group. This identifies the command to execute. [in] An unmarshaled pointer to a object holding any parameters required by the command. This can be a null value indicating there are no additional parameters. [in] The GUID of the command group. [in] Additional parameters for the command (packed into a 32-bit value).

Performs final clean up just before the object is destroyed.

Returns text about the given span that can be shown in a tool tip.

If successful, returns ; otherwise, returns an error code. Since this method can begin a background parse operation, a typical error code that can be returned is if the background parse has not yet finished. [out] Returns a string to be displayed in a tool tip. This string is valid only if a success code is returned. [in, out] A object specifying the location in the code to get information about and returns the span indicating the extent of the identifier or expression the text represents. This returned span indicates the area a mouse cursor can be in before the tool tip is dismissed.

Returns an object.

If there is an expansion provider, returns an object; otherwise, returns null.

Returns a string that can be used in a tool tip, taking into account additional sources of text such as a debugger.

If successful, returns ; otherwise, returns an error code. Other possible success codes are (only the value returned from the debugger is used) and (show the tool tip only if no parsing errors have occurred in the same location). [in] A object specifying the span of source to examine. [out] Returns a string to be used as a tool tip. [in] The string to use as the default.

Returns the extent of the innermost matching pair of language elements that contains the given location.

If successful, returns ; otherwise, returns an error code. [out] A object specifying the extent of the enclosing matching pair of language elements. [in] The line number of the location to examine. [in] The character offset on the line to examine.

Returns the extent of the currently selected text.

Returns a object specifying the selected span of text.

Returns the extent of the word or expression that contains the given location.

If successful, returns . Returns if there is no identifier or expression at the specified location; otherwise, returns an error code. [out] Returns a object that contains the requested span. [in] The line number to examine. [in] A combination of flags from the enumeration. [in] The character offset on the line to examine.

Processes the specified "go to" command.

[in] A value from the enumeration specifying the type of "go to" command to execute. Expected values are , , and .

Handles post-processing after a command has been executed.

[in, out] A pointer to a object to hold the result of the command, if any. [in] The specific ID of the command from the command group. This identifies the command to execute. [in] A pointer to a object holding any parameters required by the command. This can be a null value indicating there are no additional parameters. [in] The GUID of the command group. [in] The GUID of the command group. [in] Additional parameters for the command (packed into a 32-bit value).

Handles pre-processing before a command is executed.

Returns true if the command was actually handled in the pre-processing; otherwise, returns false. [in, out] An unmarshaled pointer to a object to hold the result of the command, if any. [in] The specific ID of the command from the command group. This identifies the command to execute. [in] An unmarshaled pointer to a object holding any parameters required by the command. This can be a null value indicating there are no additional parameters. [in] The GUID of the command group. [in] Additional parameters for the command (packed into a 32-bit value).

Handles the command to show tool tip information about the selected identifier or expression.

Handles smart indentation.

Returns true if the caret position has changed as a result of smart indentation. Returns false if no changes have been made to the source.

Executes an command.

if the method succeeded, otherwise an error code. A pointer to a VARIANTARG structure to receive command output. Can be null. The command ID. A pointer to a VARIANTARG structure containing input arguments. Can be null. The GUID of the command group to which the command belongs. Values from the enumeration, which specify how to execute the command.

Handles execution of a supported command.

If successful, returns ; otherwise, returns an error code. If a particular command is not supported, returns . [in, out] An unmarshaled pointer to a object to hold the result of the command, if any. [in] The specific ID of the command from the command group. This identifies the command to execute. [in] An unmarshaled pointer to a object holding any parameters required by the command. This can be a null value indicating there are no additional parameters. [in] The GUID of the command group. [in] Additional parameters for the command (packed into a 32-bit value).

Determines if the specified commands in the given command group are supported.

If successful, returns ; otherwise, returns an error code. A typical error code that can be returned is , indicating the command group is not supported. [in, out] An umarshaled pointer to an structure that receives the name for each command that is supported. [in, out] An array of structures that specify the command IDs being queried about. On return, the enable status of each command is stored in each structure. [in] The number of command IDs listed in the prgCmds array. [in] The GUID of the command group.

Called after there has been a change in the key binding for the Invoke Snippet From Shortcut command.

if the method succeeded, otherwise an error code. The GUID of the command group to which the command belongs. true if a key binding was added, false if it was removed. The command ID.

Called whenever a folder that contains snippets has been updated and the snippets from that folder have been read in.

If the method succeeds, it returns . If it fails, it returns an error code.

Called when the command is received.

Called when the caret moves to another line.

[in] An object representing the view in which the caret was moved. [in] The line number to which the caret was moved. [in] The character offset on the line to which the caret was moved.

Called when the scroll information for the specified scroll bar has changed.

[in] The new minimum value for the scroll bar (typically in lines). [in] An object representing the view that owns the scroll bar. [in] The new value for the first visible line in the scroll bar (affects the position of the scroll thumb). [in] The new maximum value for the scroll bar (typically in lines). [in] The new value representing the number of visible lines in the scroll bar (affects the size of the scroll thumb). [in] The scroll bar ID: SB_VERT for the vertical bar and SB_HORZ for the horizontal bar.

Called when the specified view loses focus.

[in] An object representing the view that is losing focus.

Called when the buffer of lines is being set or changed in the given view.

[in] An object representing the view whose buffer is being changed. [in] An object representing the new buffer.

Called when the specified view gains focus.

[in] An object representing the view that has received the focus.

Determines if the specified command is supported.

If the command is supported, returns (typically with the flag added to indicate the command should be shown enabled); otherwise, returns if the command is not supported or if the entire command group is not supported. [in] The ID of the command to examine. [in] The GUID of the command group.

Called to obtain the parameter for the specified command.

If successful, returns ; otherwise, returns an error code. A typical error code is if parameters on methods are not supported. [in, out] An unmarshaled pointer to a object to hold the parameter of the command expressed as a string. [in] The ID of the command for which to get the parameter. [in] Always null. [in] The GUID of the command group. [in] Additional parameters for the command (packed into a 32-bit value).

Handles the command to reformat the entire document.

Handles the command to reformat a selection.

Handles the command to show a context menu.

[in] The object that is to handle the commands in the context menu. [in] The GUID of the menu group from which the menu ID is taken. [in] The ID of the menu to show.

Executes a on the current command target chain.

If successful, returns ; otherwise, returns an error code. [in] The character command that is to be executed. This can only be a character that can be typed.

Handles the command to uncomment the current selection in the current view.

Gets the that owns this .

.

Determines if the code snippet expansion user interface (UI) is active.

If the expansion UI is active, returns true; otherwise, returns false.

Gets or sets whether or not a key has been bound to the Invoke Snippet From Shortcut command.

true if a shortcut key exists, otherwise false.

Gets the associated with this .

.

Gets or sets the associated with this view.

The existing object, or if none exists creates a new one.

Gets the object associated with this object.

.