Share via


VmmAddInBase Class

 

Applies To: System Center 2016 - Virtual Machine Manager

The base class for other add-in base classes.

Namespace:   Microsoft.SystemCenter.VirtualMachineManager.UIAddIns
Assembly:  Microsoft.SystemCenter.VirtualMachineManager.UIAddIns (in Microsoft.SystemCenter.VirtualMachineManager.UIAddIns.dll)

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.AddIn.Pipeline.ContractBase
      Microsoft.SystemCenter.VirtualMachineManager.UIAddIns.VmmAddInBase
        Microsoft.SystemCenter.VirtualMachineManager.UIAddIns.ActionAddInBase
        Microsoft.SystemCenter.VirtualMachineManager.UIAddIns.ViewAddInBase

Syntax

public abstract class VmmAddInBase : ContractBase, IWindowHelper
public ref class VmmAddInBase abstract : ContractBase, IWindowHelper
[<AbstractClass>]
type VmmAddInBase = 
    class
        inherit ContractBase
        interface IWindowHelper
    end
Public MustInherit Class VmmAddInBase
    Inherits ContractBase
    Implements IWindowHelper

Constructors

Name Description
System_CAPS_protmethod VmmAddInBase()

Creates a new instance of this class with default values.

Properties

Name Description
System_CAPS_protproperty PowerShellContext

Gets the PowerShell context object which provides scripting access.

System_CAPS_pubproperty UserDetails

Gets the current user’s details object.

Methods

Name Description
System_CAPS_pubmethod AcquireLifetimeToken()

(Inherited from ContractBase.)

System_CAPS_pubmethod CheckIfEnabledFor(IList<ContextObject>)

Determines if the ribbon button represented by this add-in is enabled for the provided context objects.

System_CAPS_pubmethod CreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetButtonLabelString()

Returns the string shown on the ribbon button label.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod GetRemoteHashCode()

(Inherited from ContractBase.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod InitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod OnFinalRevoke()

Called by the N:System.Addin framework. Calls the OnUnload method.(Overrides ContractBase.OnFinalRevoke().)

System_CAPS_pubmethod OnLoad()

Called when the add-in first loads.

System_CAPS_pubmethod OnUnload()

Called when the add-in is unloaded.

System_CAPS_pubmethod QueryContract(String)

(Inherited from ContractBase.)

System_CAPS_pubmethod RemoteEquals(IContract)

(Inherited from ContractBase.)

System_CAPS_pubmethod RemoteToString()

(Inherited from ContractBase.)

System_CAPS_pubmethod Renewal(ILease)

(Inherited from ContractBase.)

System_CAPS_pubmethod RevokeLifetimeToken(Int32)

(Inherited from ContractBase.)

System_CAPS_pubmethod SetAdminConsoleWindowAsParentOf(Window)

This method can be called to set the parent of a window to the Virtual Machine Manager console window.

System_CAPS_pubmethod SetParentWindow(IntPtr)

For internal use only. Called by the add-in framework to keep reference to the Virtual Machine Manager console window.

System_CAPS_pubmethod SetPowerShellContext(PowerShellContext)

For internal use only. Called by the add-in framework to provide the current add-in reference to the PowerShell context object instance.

System_CAPS_pubmethod SetUserDetails(UserDetails)

For internal use only. Called by the add-in framework to provide the current add-in reference to the current console user.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

This class will not be derived from directly, but provides common functionality and helper object instances that you will use for your add-in. The ActionAddInBase and ViewAddInBase base classes inherit from this class.

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.SystemCenter.VirtualMachineManager.UIAddIns Namespace

Return to top