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 | |
---|---|---|
SchemaModelViewerControllerBase | Initializes a new instance of the SchemaModelViewerControllerBase class. |
Top
Properties
Name | Description | |
---|---|---|
EventsReceivedWhileToolWindowWasClosed | Gets or sets the number of events handled while the tool window was closed. | |
ProjectNode | Returns the associated database project node. | |
RefreshWhenToolWindowIsShown | Gets or sets a value that indicates whether to refresh the tool window the next time that it is shown. | |
RootNode | Gets or sets the root node. | |
SchemaView | Gets or sets the Schema View reference. | |
ToolWindowIsShowing | Gets a value that indicates whether the tool window to which this controller is attached (Schema View or dependency view) is shown. | |
ToolWindowService | Gets or sets the tool window service. |
Top
Methods
Name | Description | |
---|---|---|
CacheToolWindowService | Gets and caches the SchemaModelViewerService service. | |
CanBeDisplayed | Indicates whether the specified model element can be displayed in Schema View. | |
CanDeleteObjects | Determines whether the list of model element nodes can be deleted. | |
CanExtend | Returns true if this contributor can extend the extendee under the extender name that was specified. | |
DeleteObjects | ||
DisconnectFromDataSchemaModelEvents | Disconnects from schema model (store) events. | |
DisconnectFromProjectEvents | Disconnects from project events. | |
DisconnectFromSchemaViewEvents | Disconnect from Schema View events. Set cached Schema View property to null. | |
DisconnectFromSolutionEvents | Disconnects from solution events. | |
DisconnectFromToolWindowEvents | Disconnects from SchemaModelViewerService events and sets the cached tool window property to null. | |
Dispose() | Releases resources. | |
Dispose(Boolean) | Releases resources. | |
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. | |
GetCaption | Gets the caption for the specified element node. | |
GetChildren | Returns the list of child nodes for the specified parent node. | |
GetExtender | Returns an extender for the extendee. | |
GetExtenderNames | Returns the names for any available extenders for the extendee. | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetPathsToElement | Returns the path of a specified element in the hierarchy. | |
GetSelectionPathToElement | Returns the path for the specified element that is used when you navigate to the element in Schema View. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Initialize | Caches the project node. | |
InitializeRootNode | Called before OnAfterLoadProject and OnAfterOpenProject. | |
ListenToDataSchemaModelEvents | Listens to data schema model events. | |
ListenToProjectEvents | Listens to project events. | |
ListenToSchemaViewEvents | Listens to Schema View events. | |
ListenToSolutionEvents | Creates a solution listener and listens to solution events. | |
ListenToToolWindowEvents | Listens to events from the SchemaModelViewerService. | |
LoadState | Loads state information. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ModelChanged | ||
ModelElementAdded | Called when a model element was added to the store. | |
ModelElementDeleted | Called when a model element was deleted from the store. | |
ModelElementUpdated | Called when a model element was updated by the store. | |
NodeInUse | Called from Schema View to notify the controller that the node is displayed. | |
OnAfterOpenProject | After the project has been opened, adds the root node to Schema View. | |
OnBeforeCloseProject | Before the project closed, called to provide an opportunity to remove the project (root) node from Schema View. | |
OnDatabaseSchemaViewInitialized | Initializes the controller with Schema View. | |
OnDatabaseSchemaViewShown | Handles the Schema View shown event. | |
OnDataSchemaModelRecycled | Handles a DataSchemaModel recycled event. | |
OnDataSchemaModelRecycling | Handles a DataSchemaModel recycling event. | |
OnProjectClosed | Handles the close of the project by disconnecting from events. | |
OnProjectClosing | Calls SaveState() and calls the following virtual methods, in order: DisconnectFromSchemaViewEvents; DisconnectFromStoreEvents; DisconnectFromProjectEvents; DisconnectFromSolutionEvents; and DisconnectFromToolWindowEvents. | |
OnProjectLoaded | Event is raised when the model has finished deserialization. | |
OnProjectRenamed | Project node was renamed. | |
Refresh | Refreshes the hierarchy. | |
SaveState | Save state. By default, does nothing. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
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