ViewAddInBase Class

Article
06/20/2017

Applies To: System Center 2016 - Virtual Machine Manager

The base class for an add-in that supplies a view to the console.

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.ViewAddInBase

Syntax

[AddInBaseAttribute]
public abstract class ViewAddInBase : VmmAddInBase

[AddInBaseAttribute]
public ref class ViewAddInBase abstract : VmmAddInBase

[<AbstractClass>]
[<AddInBaseAttribute>]
type ViewAddInBase = 
    class
        inherit VmmAddInBase
    end

<AddInBaseAttribute>
Public MustInherit Class ViewAddInBase
    Inherits VmmAddInBase

Constructors

	Name	Description
	ViewAddInBase()	Creates a new instance of the class with default values.

Properties

	Name	Description
	CurrentScopeObject	Gets the backing Virtual Machine Manager object of the currently selected console navigation tree item.
	CurrentScopeType	Gets the currently selected console navigation tree item’s scope type.
	PowerShellContext	Gets the PowerShell context object which provides scripting access.(Inherited from VmmAddInBase.)
	UserDetails	Gets the current user’s details object.(Inherited from VmmAddInBase.)

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.(Inherited from VmmAddInBase.)
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	CreateViewControl()	Called by the add-in framework to get the view control used by the console for this add-in.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetButtonLabelString()	Returns the string shown on the ribbon button label.(Inherited from VmmAddInBase.)
	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.(Inherited from VmmAddInBase.)
	OnHide()	Called after the add-in view is hidden from the console.
	OnLoad()	Called when the add-in first loads.(Inherited from VmmAddInBase.)
	OnShow()	Called before the add-in view is shown in the console.
	OnUnload()	Called when the add-in is unloaded.(Inherited from VmmAddInBase.)
	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.(Inherited from VmmAddInBase.)
	SetCurrentScope(AddInContextType, ContextObject)	Called by the add-in framework when the selected item in the console navigation tree has changed.
	SetParentWindow(IntPtr)	For internal use only. Called by the add-in framework to keep reference to the Virtual Machine Manager console window.(Inherited from VmmAddInBase.)
	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.(Inherited from VmmAddInBase.)
	SetUserDetails(UserDetails)	For internal use only. Called by the add-in framework to provide the current add-in reference to the current console user.(Inherited from VmmAddInBase.)
	ToString()	(Inherited from Object.)

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.