EditorControl Class

Article
04/29/2015

Handles the editor window.

This API is not CLS-compliant.

Inheritance Hierarchy

Object
Microsoft.VisualStudio.Package.SimpleEditorView
Microsoft.VisualStudio.Package.EditorControl

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
<ComVisibleAttribute(True)> _
Public Class EditorControl _
    Inherits SimpleEditorView

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public class EditorControl : SimpleEditorView

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public ref class EditorControl : public SimpleEditorView

[<CLSCompliantAttribute(false)>]
[<ComVisibleAttribute(true)>]
type EditorControl =  
    class 
        inherit SimpleEditorView 
    end

public class EditorControl extends SimpleEditorView

The EditorControl type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Buffer	Gets or sets the text buffer. (Inherited from SimpleEditorView.)
	ComponentId	Gets or sets the component ID of the editor view. (Inherited from SimpleEditorView.)
	ComponentManager	Gets or sets the component manager for this view. (Inherited from SimpleEditorView.)
	Control	Gets or sets the control that represents the editor window.
	MenuCommandService	(Inherited from SimpleEditorView.)
	Site	Gets or sets the IServiceProvider for this view. (Inherited from SimpleEditorView.)

Top

Methods

	Name	Description
	ClosePane	Closes the window and disposes the resources. (Overrides SimpleEditorView.ClosePane().)
	CommitPendingEdit	Commits any changes made to the file. (Overrides SimpleEditorView.CommitPendingEdit(Int32%).)
	CreatePaneWindow	Creates the window. (Overrides SimpleEditorView.CreatePaneWindow(IntPtr, Int32, Int32, Int32, Int32, IntPtr%).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Exec	Executes the specified command. (Inherited from SimpleEditorView.)
	ExecCommand	Executes specific commands. (Inherited from SimpleEditorView.)
	FContinueMessageLoop	Called during each iteration of the message loop. (Inherited from SimpleEditorView.)
	FDoIdle	Gives the component a chance to do idle time tasks. (Overrides SimpleEditorView.FDoIdle(UInt32).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FPreTranslateMessage	Called to process or modify the message before it is translated and dispatched. (Inherited from SimpleEditorView.)
	FQueryTerminate	Called when the component manager wishes to know whether the component is in a state in which it can terminate. (Overrides SimpleEditorView.FQueryTerminate(Int32).)
	FReserved1	Reserved method. (Inherited from SimpleEditorView.)
	GetDefaultSize	Gets the default size of the window. (Inherited from SimpleEditorView.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HwndGetWindow	Gets a window associated with the component. (Overrides SimpleEditorView.HwndGetWindow(UInt32, UInt32).)
	IsSupported	Determines whether the toolbox user supports the referenced data object. (Inherited from SimpleEditorView.)
	ItemPicked	Sends notification that an item in the toolbox has been selected (by clicking the mouse or by pressing ENTER). (Inherited from SimpleEditorView.)
	LoadViewState	When implemented in a derived class, loads the view state of the window pane. (Inherited from SimpleEditorView.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnActivationChange	Called when a new object is being activated. (Inherited from SimpleEditorView.)
	OnAppActivate	Notifies the component whenever the host application is activated or deactivated. (Overrides SimpleEditorView.OnAppActivate(Int32, UInt32).)
	OnEnterState	Notifies the view when the application enters or exits a given state. (Inherited from SimpleEditorView.)
	OnLoseActivation	Notifies the active component that it has lost its active status because the host or another component has become active. (Overrides SimpleEditorView.OnLoseActivation().)
	QueryCommandStatus	Gets the status of the specified command. (Inherited from SimpleEditorView.)
	QueryParameterList	Gets the parameters for a command. (Inherited from SimpleEditorView.)
	QueryStatus	Gets the status of the specified commands. (Inherited from SimpleEditorView.)
	SaveViewState	Saves the loaded view state. (Inherited from SimpleEditorView.)
	SetInfo	Sets the information in the status bar to reflect this view. (Inherited from SimpleEditorView.)
	SetSite	Initializes this view. (Inherited from SimpleEditorView.)
	Terminate	Called by the component manager when it wishes to terminate the view's registration. (Inherited from SimpleEditorView.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TranslateAccelerator	Handles the translation of special navigation keys. (Inherited from SimpleEditorView.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via