Delen via


SchemaModelViewerControllerBase Class

Abstract base class for model visualizer controllers.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Schema.Package.Project.SchemaModelViewer.SchemaModelViewerControllerBase
    Microsoft.VisualStudio.Data.Schema.Package.Project.SchemaModelViewer.SchemaModelViewerControllerBaseInternal

Namespace:  Microsoft.VisualStudio.Data.Schema.Package.Project.SchemaModelViewer
Assembly:  Microsoft.VisualStudio.Data.Schema.Package (in Microsoft.VisualStudio.Data.Schema.Package.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class SchemaModelViewerControllerBase _
    Implements ISchemaModelViewerController, IDisposable, IDatabaseSchemaViewExtenderContributor
[CLSCompliantAttribute(false)]
public abstract class SchemaModelViewerControllerBase : ISchemaModelViewerController, 
    IDisposable, IDatabaseSchemaViewExtenderContributor
[CLSCompliantAttribute(false)]
public ref class SchemaModelViewerControllerBase abstract : ISchemaModelViewerController, 
    IDisposable, IDatabaseSchemaViewExtenderContributor
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type SchemaModelViewerControllerBase =  
    class
        interface ISchemaModelViewerController
        interface IDisposable
        interface IDatabaseSchemaViewExtenderContributor
    end
public abstract class SchemaModelViewerControllerBase implements ISchemaModelViewerController, IDisposable, IDatabaseSchemaViewExtenderContributor

The SchemaModelViewerControllerBase type exposes the following members.

Constructors

  Name Description
Protected method SchemaModelViewerControllerBase Initializes a new instance of the SchemaModelViewerControllerBase class.

Top

Properties

  Name Description
Protected property EventsReceivedWhileToolWindowWasClosed Gets or sets the number of events handled while the tool window was closed.
Public property ProjectNode Returns the associated database project node.
Protected property RefreshWhenToolWindowIsShown Gets or sets a value that indicates whether to refresh the tool window the next time that it is shown.
Protected property RootNode Gets or sets the root node.
Protected property SchemaView Gets or sets the Schema View reference.
Protected property ToolWindowIsShowing Gets a value that indicates whether the tool window to which this controller is attached (Schema View or dependency view) is shown.
Protected property ToolWindowService Gets or sets the tool window service.

Top

Methods

  Name Description
Protected method CacheToolWindowService Gets and caches the SchemaModelViewerService service.
Public method CanBeDisplayed Indicates whether the specified model element can be displayed in Schema View.
Public method CanDeleteObjects Determines whether the list of model element nodes can be deleted.
Public method CanExtend Returns true if this contributor can extend the extendee under the extender name that was specified.
Public method DeleteObjects
Protected method DisconnectFromDataSchemaModelEvents Disconnects from schema model (store) events.
Protected method DisconnectFromProjectEvents Disconnects from project events.
Protected method DisconnectFromSchemaViewEvents Disconnect from Schema View events. Set cached Schema View property to null.
Protected method DisconnectFromSolutionEvents Disconnects from solution events.
Protected method DisconnectFromToolWindowEvents Disconnects from SchemaModelViewerService events and sets the cached tool window property to null.
Public method Dispose() Releases resources.
Protected method Dispose(Boolean) Releases resources.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAdditionalObjectsToDelete Called by DeleteObjects to get additional elements to delete.
Public method GetCaption Gets the caption for the specified element node.
Public method GetChildren Returns the list of child nodes for the specified parent node.
Public method GetExtender Returns an extender for the extendee.
Public method GetExtenderNames Returns the names for any available extenders for the extendee.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPathsToElement Returns the path of a specified element in the hierarchy.
Public method GetSelectionPathToElement Returns the path for the specified element that is used when you navigate to the element in Schema View.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Initialize Caches the project node.
Public method InitializeRootNode Called before OnAfterLoadProject and OnAfterOpenProject.
Protected method ListenToDataSchemaModelEvents Listens to data schema model events.
Protected method ListenToProjectEvents Listens to project events.
Protected method ListenToSchemaViewEvents Listens to Schema View events.
Protected method ListenToSolutionEvents Creates a solution listener and listens to solution events.
Protected method ListenToToolWindowEvents Listens to events from the SchemaModelViewerService.
Protected method LoadState Loads state information.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method ModelChanged
Protected method ModelElementAdded Called when a model element was added to the store.
Protected method ModelElementDeleted Called when a model element was deleted from the store.
Protected method ModelElementUpdated Called when a model element was updated by the store.
Public method NodeInUse Called from Schema View to notify the controller that the node is displayed.
Protected method OnAfterOpenProject After the project has been opened, adds the root node to Schema View.
Protected method OnBeforeCloseProject Before the project closed, called to provide an opportunity to remove the project (root) node from Schema View.
Protected method OnDatabaseSchemaViewInitialized Initializes the controller with Schema View.
Protected method OnDatabaseSchemaViewShown Handles the Schema View shown event.
Protected method OnDataSchemaModelRecycled Handles a DataSchemaModel recycled event.
Protected method OnDataSchemaModelRecycling Handles a DataSchemaModel recycling event.
Protected method OnProjectClosed Handles the close of the project by disconnecting from events.
Protected method OnProjectClosing Calls SaveState() and calls the following virtual methods, in order: DisconnectFromSchemaViewEvents; DisconnectFromStoreEvents; DisconnectFromProjectEvents; DisconnectFromSolutionEvents; and DisconnectFromToolWindowEvents.
Protected method OnProjectLoaded Event is raised when the model has finished deserialization.
Protected method OnProjectRenamed Project node was renamed.
Public method Refresh Refreshes the hierarchy.
Protected method SaveState Save state. By default, does nothing.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method UninitializeRootNode Called when the project closes, in order to remove the root node from Schema View by using the RemoveNode method and to set RootNode property to null.

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.

See Also

Reference

Microsoft.VisualStudio.Data.Schema.Package.Project.SchemaModelViewer Namespace