NamespaceSnapInBase Class

 

An abstract base class that provides functionality that is common to stand-alone snap-ins and extension snap-ins.

Namespace:   Microsoft.ManagementConsole
Assembly:  Microsoft.ManagementConsole (in Microsoft.ManagementConsole.dll)

Inheritance Hierarchy

System.Object
  Microsoft.ManagementConsole.SnapInBase
    Microsoft.ManagementConsole.NamespaceSnapInBase
      Microsoft.ManagementConsole.Advanced.NamespaceExtension
      Microsoft.ManagementConsole.SnapIn

Syntax

public abstract class NamespaceSnapInBase : SnapInBase
public ref class NamespaceSnapInBase abstract : SnapInBase
[<AbstractClass>]
type NamespaceSnapInBase = 
    class
        inherit SnapInBase
    end
Public MustInherit Class NamespaceSnapInBase
    Inherits SnapInBase

Properties

Name Description
System_CAPS_pubproperty Console

Gets the console object that exposes the functionality of the main MMC console window.

System_CAPS_protproperty Id

Gets the identifier for the instance of the snap-in. The identifier is unique across snap-in instances within a console. (Inherited from SnapInBase.)

System_CAPS_pubproperty InvokeRequired

Gets a value that indicates whether the caller must call the Invoke or the BeginInvoke methods when calling a method on a snap-in component. This distinction is necessary when the caller is on a different thread than the thread that the snap-in was created on. (Inherited from SnapInBase.)

System_CAPS_pubproperty IsModified

Gets or sets a flag that tells the MMC runtime whether the snap-in has data that needs to be saved.

System_CAPS_pubproperty LargeImages

Gets the list of 32 x 32 images for the snap-in and its elements.

System_CAPS_pubproperty SmallImages

Gets the list of 16 x 16 images for the snap-in and its elements.

System_CAPS_pubproperty Tag

Gets or sets an object that contains application-specific information that is associated with the snap-in.(Inherited from SnapInBase.)

Methods

Name Description
System_CAPS_pubmethod BeginInvoke(Delegate)

Executes the specified delegate asynchronously on the thread that the snap-in was created on.(Inherited from SnapInBase.)

System_CAPS_pubmethod BeginInvoke(Delegate, Object[])

Executes the specified delegate with its specified arguments on the main thread that the snap-in was created on. (Inherited from SnapInBase.)

System_CAPS_pubmethod EndInvoke(IAsyncResult)

Waits until the process that was started by calling BeginInvoke completes. This method then retrieves the return value of the asynchronous operation identified by the result parameter. (Inherited from SnapInBase.)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod Invoke(Delegate)

Executes the delegate on the main thread that the snap-in executes on. (Inherited from SnapInBase.)

System_CAPS_pubmethod Invoke(Delegate, Object[])

Executes the delegate on the main thread that the snap-in executes on. (Inherited from SnapInBase.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod OnInitialize()

Called when a snap-in is initialized. It allows derived classes to provide additional initialization. (Inherited from SnapInBase.)

System_CAPS_protmethod OnLoadCustomData(AsyncStatus, Byte[])

Passes data that is contained in the console file to the snap-in.

System_CAPS_protmethod OnSaveCustomData(SyncStatus)

Retrieves a serializable object that the snap-in can persist into a binary section in the console file.

System_CAPS_protmethod OnShutdown(AsyncStatus)

Called when the snap-in is shutting down. Once this call returns, actions which modify the console, such as adding nodes, or modifying view descriptions, are not honored. (Inherited from SnapInBase.)

System_CAPS_pubmethod RegisterCurrentThreadForUI()

Called on a background thread to register it as a candidate for showing pop-up UI. (Inherited from SnapInBase.)

System_CAPS_pubmethod ShowHelpTopic(String)

Displays a help topic. (Inherited from SnapInBase.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod UnregisterCurrentThreadForUI()

Called on a background thread to unregister it as a candidate for showing pop-up UI. (Inherited from SnapInBase.)

System_CAPS_pubmethod UpdateSnapInExtensions()

Updates MMC's internal cache of available extensions for the snap-in.

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

Microsoft.ManagementConsole Namespace

Return to top