VmmAddInBase Class

Article
06/20/2017

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
	VmmAddInBase()	Creates a new instance of this class with default values.

Properties

	Name	Description
	PowerShellContext	Gets the PowerShell context object which provides scripting access.
	UserDetails	Gets the current user’s details object.

Methods

	Name	Description
	AcquireLifetimeToken()	(Inherited from ContractBase.)
	CheckIfEnabledFor(IList<ContextObject>)	Determines if the ribbon button represented by this add-in is enabled for the provided context objects.
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetButtonLabelString()	Returns the string shown on the ribbon button label.
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetRemoteHashCode()	(Inherited from ContractBase.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	OnFinalRevoke()	Called by the N:System.Addin framework. Calls the OnUnload method.(Overrides ContractBase.OnFinalRevoke().)
	OnLoad()	Called when the add-in first loads.
	OnUnload()	Called when the add-in is unloaded.
	QueryContract(String)	(Inherited from ContractBase.)
	RemoteEquals(IContract)	(Inherited from ContractBase.)
	RemoteToString()	(Inherited from ContractBase.)
	Renewal(ILease)	(Inherited from ContractBase.)
	RevokeLifetimeToken(Int32)	(Inherited from ContractBase.)
	SetAdminConsoleWindowAsParentOf(Window)	This method can be called to set the parent of a window to the Virtual Machine Manager console window.
	SetParentWindow(IntPtr)	For internal use only. Called by the add-in framework to keep reference to the Virtual Machine Manager console window.
	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.
	SetUserDetails(UserDetails)	For internal use only. Called by the add-in framework to provide the current add-in reference to the current console user.
	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.

Share via