Share via


ViewAddInBase Class

 

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
System_CAPS_protmethod ViewAddInBase()

Creates a new instance of the class with default values.

Properties

Name Description
System_CAPS_pubproperty CurrentScopeObject

Gets the backing Virtual Machine Manager object of the currently selected console navigation tree item.

System_CAPS_pubproperty CurrentScopeType

Gets the currently selected console navigation tree item’s scope type.

System_CAPS_protproperty PowerShellContext

Gets the PowerShell context object which provides scripting access.(Inherited from VmmAddInBase.)

System_CAPS_pubproperty UserDetails

Gets the current user’s details object.(Inherited from VmmAddInBase.)

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.(Inherited from VmmAddInBase.)

System_CAPS_pubmethod CreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod CreateViewControl()

Called by the add-in framework to get the view control used by the console for this add-in.

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.(Inherited from VmmAddInBase.)

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.(Inherited from VmmAddInBase.)

System_CAPS_pubmethod OnHide()

Called after the add-in view is hidden from the console.

System_CAPS_pubmethod OnLoad()

Called when the add-in first loads.(Inherited from VmmAddInBase.)

System_CAPS_pubmethod OnShow()

Called before the add-in view is shown in the console.

System_CAPS_pubmethod OnUnload()

Called when the add-in is unloaded.(Inherited from VmmAddInBase.)

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.(Inherited from VmmAddInBase.)

System_CAPS_pubmethod SetCurrentScope(AddInContextType, ContextObject)

Called by the add-in framework when the selected item in the console navigation tree has changed.

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.(Inherited from VmmAddInBase.)

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.(Inherited from VmmAddInBase.)

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.(Inherited from VmmAddInBase.)

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

See Also

Microsoft.SystemCenter.VirtualMachineManager.UIAddIns Namespace

Return to top