SchemaModelViewerControllerBaseInternal Class

The abstract base class for a Schema View Controller used by internal implementors.

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
Assembly:  Microsoft.VisualStudio.Data.Schema.Package (in Microsoft.VisualStudio.Data.Schema.Package.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class SchemaModelViewerControllerBaseInternal _
    Inherits SchemaModelViewerControllerBase
[CLSCompliantAttribute(false)]
public abstract class SchemaModelViewerControllerBaseInternal : SchemaModelViewerControllerBase
[CLSCompliantAttribute(false)]
public ref class SchemaModelViewerControllerBaseInternal abstract : public SchemaModelViewerControllerBase
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type SchemaModelViewerControllerBaseInternal =  
    class
        inherit SchemaModelViewerControllerBase
    end
public abstract class SchemaModelViewerControllerBaseInternal extends SchemaModelViewerControllerBase

The SchemaModelViewerControllerBaseInternal type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Protected property EventsReceivedWhileToolWindowWasClosed Gets or sets the number of events handled while the tool window was closed. (Inherited from SchemaModelViewerControllerBase.)
Protected property HierarchyGenerator Gets or sets the schema hierarchy generator.
Public property ProjectNode Returns the associated database project node. (Inherited from SchemaModelViewerControllerBase.)
Protected property RefreshWhenToolWindowIsShown Gets or sets a value that indicates whether to refresh the tool window the next time that it is shown. (Inherited from SchemaModelViewerControllerBase.)
Protected property RootNode Gets or sets the root node. (Inherited from SchemaModelViewerControllerBase.)
Protected property SchemaView Gets or sets the Schema View reference. (Inherited from SchemaModelViewerControllerBase.)
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. (Inherited from SchemaModelViewerControllerBase.)
Protected property ToolWindowService Gets or sets the tool window service. (Inherited from SchemaModelViewerControllerBase.)

Top

Methods

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

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