DatabaseSchemaViewControllerBase Class

Article
11/05/2012

Abstract base class for Schema View 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
      Microsoft.VisualStudio.Data.Schema.Package.Project.SchemaModelViewer.SchemaView.DatabaseSchemaViewControllerBase

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class DatabaseSchemaViewControllerBase _
    Inherits SchemaModelViewerControllerBaseInternal _
    Implements IDatabaseSchemaViewController, IExtension

[CLSCompliantAttribute(false)]
public abstract class DatabaseSchemaViewControllerBase : SchemaModelViewerControllerBaseInternal, 
    IDatabaseSchemaViewController, IExtension

[CLSCompliantAttribute(false)]
public ref class DatabaseSchemaViewControllerBase abstract : public SchemaModelViewerControllerBaseInternal, 
    IDatabaseSchemaViewController, IExtension

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type DatabaseSchemaViewControllerBase =  
    class
        inherit SchemaModelViewerControllerBaseInternal
        interface IDatabaseSchemaViewController
        interface IExtension
    end

public abstract class DatabaseSchemaViewControllerBase extends SchemaModelViewerControllerBaseInternal implements IDatabaseSchemaViewController, IExtension

The DatabaseSchemaViewControllerBase type exposes the following members.

Constructors

	Name	Description
	DatabaseSchemaViewControllerBase	Initializes a new instance of the DatabaseSchemaViewControllerBase class.

Top

Properties

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

Top

Methods

	Name	Description
	CacheToolWindowService	Gets and caches the SchemaModelViewerService service. (Inherited from SchemaModelViewerControllerBase.)
	CanBeDisplayed	Returns whether the specified model element can be displayed in the Schema View. (Inherited from SchemaModelViewerControllerBaseInternal.)
	CanDeleteObjects	Determines whether the list of model element nodes can be deleted. (Inherited from SchemaModelViewerControllerBase.)
	CanExtend	Returns true if this contributor can extend the extendee under the extender name that was specified. (Inherited from SchemaModelViewerControllerBase.)
	CreateGenerator	Abstract method that returns the Schema View generator for this controller. (Inherited from SchemaModelViewerControllerBaseInternal.)
	CreateRootNode	Creates the root node in Schema View (the database project node). (Inherited from SchemaModelViewerControllerBaseInternal.)
	DeleteObjects	(Overrides SchemaModelViewerControllerBase.DeleteObjects(IList<ISchemaModelViewerElementNode>, IList<Tuple<String, String>>%).)
	DisconnectFromDataSchemaModelEvents	Disconnects from schema model (store) events. (Inherited from SchemaModelViewerControllerBase.)
	DisconnectFromProjectEvents	Disconnects from project events. (Inherited from SchemaModelViewerControllerBase.)
	DisconnectFromSchemaViewEvents	Disconnect from Schema View events. Set cached Schema View property to null. (Inherited from SchemaModelViewerControllerBase.)
	DisconnectFromSolutionEvents	Disconnects from solution events. (Inherited from SchemaModelViewerControllerBase.)
	DisconnectFromToolWindowEvents	Disconnects from SchemaModelViewerService events and sets the cached tool window property to null. (Inherited from SchemaModelViewerControllerBase.)
	Dispose()	Releases resources. (Inherited from SchemaModelViewerControllerBase.)
	Dispose(Boolean)	Releases resources associated with the Schema Model Viewer Controller. (Inherited from SchemaModelViewerControllerBaseInternal.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAdditionalObjectsToDelete	Called by DeleteObjects to get additional elements to delete. (Inherited from SchemaModelViewerControllerBase.)
	GetCaption	Returns the caption for the specified element node. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetChildren	Returns the list of child nodes for the specified parent node. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetExtender	Returns an extender for the extendee. (Inherited from SchemaModelViewerControllerBase.)
	GetExtenderNames	Returns the names for any available extenders for the extendee. (Inherited from SchemaModelViewerControllerBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetModelElement	Returns the model element that this node represents or under which it is a node. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetPathsFromCache	Returns the path from the Schema View node that is contained in the annotations of the specified model element. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetPathsFromGeneratorPaths(IModelElement, IList<IList<ISchemaModelViewerNode>>%, IList<IList<ISchemaModelViewerNode>>%, IList<IList<ISchemaModelViewerNode>>%)	Returns the Schema View node paths for the specified model element. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetPathsFromGeneratorPaths(IModelElement, IList<IList<ISchemaModelViewerNode>>, IList<IList<ISchemaModelViewerNode>>%, IList<IList<ISchemaModelViewerNode>>%, IList<IList<ISchemaModelViewerNode>>%)	Returns the Schema View node paths for the specified hierarchy generator node paths. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetPathsToElement	Gets the path to the element from the hierarchy generator. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetSelectionPathToElement	Gets the path that is used to select the element in Schema View from the hierarchy generator. (Inherited from SchemaModelViewerControllerBaseInternal.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Creates a Schema View persistence support object. (Inherited from SchemaModelViewerControllerBaseInternal.)
	InitializeRootNode	Adds the root node to Schema View. (Inherited from SchemaModelViewerControllerBaseInternal.)
	ListenToDataSchemaModelEvents	Listens to data schema model events. (Inherited from SchemaModelViewerControllerBase.)
	ListenToProjectEvents	Listens to project events. (Inherited from SchemaModelViewerControllerBase.)
	ListenToSchemaViewEvents	Listens to Schema View events. (Inherited from SchemaModelViewerControllerBase.)
	ListenToSolutionEvents	Creates a solution listener and listens to solution events. (Inherited from SchemaModelViewerControllerBase.)
	ListenToToolWindowEvents	Listens to events from the SchemaModelViewerService. (Inherited from SchemaModelViewerControllerBase.)
	LoadState	Load state. (Inherited from SchemaModelViewerControllerBaseInternal.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ModelChanged	(Inherited from SchemaModelViewerControllerBaseInternal.)
	ModelElementAdded	A model element was added to the store. (Inherited from SchemaModelViewerControllerBaseInternal.)
	ModelElementDeleted	A model element was deleted from the store. (Inherited from SchemaModelViewerControllerBaseInternal.)
	ModelElementUpdated	A model element was updated by the store. (Inherited from SchemaModelViewerControllerBaseInternal.)
	NodeCreated	Sets the sorter for the node to delegate to the hierarchy node. (Inherited from SchemaModelViewerControllerBaseInternal.)
	NodeInUse	Provides notification whether the given node is in use by the Schema View. (Inherited from SchemaModelViewerControllerBaseInternal.)
	OnAfterOpenProject	After the project has been opened, adds the root node to Schema View. (Inherited from SchemaModelViewerControllerBase.)
	OnBeforeCloseProject	Before the project closed, called to provide an opportunity to remove the project (root) node from Schema View. (Inherited from SchemaModelViewerControllerBase.)
	OnDatabaseSchemaViewInitialized	Initializes the controller with Schema View. (Inherited from SchemaModelViewerControllerBase.)
	OnDatabaseSchemaViewShown	Handles the Schema View shown event. (Inherited from SchemaModelViewerControllerBase.)
	OnDataSchemaModelRecycled	Handles the DataSchemaModel recycled event. (Inherited from SchemaModelViewerControllerBaseInternal.)
	OnDataSchemaModelRecycling	Handles the DataSchemaModel recycling event. (Inherited from SchemaModelViewerControllerBaseInternal.)
	OnProjectClosed	Handles the close of the project by disconnecting from events. (Inherited from SchemaModelViewerControllerBase.)
	OnProjectClosing	Calls SaveState() and calls the following virtual methods, in order: DisconnectFromSchemaViewEvents; DisconnectFromStoreEvents; DisconnectFromProjectEvents; DisconnectFromSolutionEvents; and DisconnectFromToolWindowEvents. (Inherited from SchemaModelViewerControllerBase.)
	OnProjectLoaded	Occurs when the model has finished deserialization. (Inherited from SchemaModelViewerControllerBaseInternal.)
	OnProjectRenamed	Project node was renamed. (Inherited from SchemaModelViewerControllerBase.)
	ReadStateValueAsInt	Reads an integer value from the persistent storage for Schema View. (Inherited from SchemaModelViewerControllerBaseInternal.)
	Refresh	Refreshes Schema View by removing old nodes and adding new ones. (Inherited from SchemaModelViewerControllerBaseInternal.)
	RemoveOurRootNode	Removes the root node. (Inherited from SchemaModelViewerControllerBaseInternal.)
	SaveState	Saves state for the Schema Model Viewer Controller. (Inherited from SchemaModelViewerControllerBaseInternal.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UninitializeRootNode	Removes the root node. (Inherited from SchemaModelViewerControllerBaseInternal.)
	WriteStateValue	Writes a value to the persistent storage for Schema View. (Inherited from SchemaModelViewerControllerBaseInternal.)

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.