OleComponent Members

Include Protected Members
Include Inherited Members

Basic implementation of a disposable IOleComponent

The OleComponent type exposes the following members.


  Name Description
Public method OleComponent Construct an instance of OleComponent. This overload will call FRegisterComponent automatically on construction.



  Name Description
Public method BeginTracking Makes this IOleComponent the tracking component with its associated IOleComponentManager.
Public methodStatic member CreateHostedComponent Creates a new OleComponent instance using Instance as the IOleComponentManager it needs to register itself.
Public method Dispose() Releases all resources used by the current instance of the DisposableObject class. (Inherited from DisposableObject.)
Protected method Dispose(Boolean) (Inherited from DisposableObject.)
Protected method DisposeManagedResources Disposes of this object, calling FRevokeComponent if our manager field is non-null and our componentCookie field is not 0. (Overrides DisposableObject.DisposeManagedResources().)
Protected method DisposeNativeResources (Inherited from DisposableObject.)
Public methodStatic member DoOleEvents
Public method EndTracking Makes this IOleComponent no longer the tracking component with its associated IOleComponentManager.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method FContinueMessageLoopCore Default implementation of FContinueMessageLoop. Simply raises the ContinueMessageLoop event if there are any listeners.
Protected method FDoIdleCore Default implementation of FDoIdle. Simply raises the DoIdle and DoPeriodicIdle events as appropriate (based on value of ) if there are any listeners.
Protected method Finalize (Inherited from DisposableObject.)
Protected method FPreTranslateMessageCore Default implemmentation of FPreTranslateMessage. Simply raises the PreTranslateMessage event if there are listeners.
Protected method FQueryTerminateCore Default implemmentation of FQueryTerminate. Simply raises the QueryTerminate event if there are listeners.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method HwndGetWindowCore Default implemmentation of HwndGetWindow. Simply raises the GetWindow event if there are listeners.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnActivationChangeCore Default implemmentation of OnActivationChange. Simply raises the ActivationChange event if there are listeners.
Protected method OnAppActivateCore Default implemmentation of OnAppActivate. Simply raises the AppActivate event if there are listeners.
Protected method OnChangeStateCore Default implemmentation of OnEnterState. Simply raises the approriate event based on what state changed (described in ComponentState.
Protected method OnLoseActivationCore Default implemmentation of OnLoseActivation. Simply raises the ActivationLost event if there are listeners.
Public method PushMessageLoop Pushes this component to the OleComonentManager as the message loop handler by calling FPushMessageLoop. Message loop blocks until an ContinueMessageLoop handler sets the ContinuePumping /// to false.
Protected method TerminateCore Default implemmentation of Terminate. Simply raises the Terminate event if there are listeners. Also calls Dispose and nulls out any reference to a IOleComponentManager that we may have been constructed with.
Protected method ThrowIfDisposed (Inherited from DisposableObject.)
Public method ToString Returns a String that represents the current Object. (Inherited from Object.)



  Name Description
Public property IsDisposed (Inherited from DisposableObject.)
Public property IsTrackingComponent Sets whether this component is the tracking component, accomplished by calling FSetTrackingComponent.
Public property PeriodicIdleTimePeriod Sets or retrieves the idle time period in milliseconds for this components idle callbacks.



  Name Description
Public event ActivationChange
Public event ActivationLost
Public event AppActivate
Public event ContinueMessageLoop
Public event Disposing (Inherited from DisposableObject.)
Public event DoIdle
Public event DoPeriodicIdle
Public event GetWindow
Public event ModalStateChanged
Public event PreTranslateMessage
Public event QueryTerminate
Public event RecordingStateChanged
Public event RedrawOffStateChanged
Public event Terminate
Public event WarningsOffStateChanged


Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IOleComponent.FContinueMessageLoop Called during each iteration of a message loop that the component pushed. Simply calls through to FContinueMessageLoopCore.
Explicit interface implemetationPrivate method IOleComponent.FDoIdle Called to give a component a chance to do idle time tasks. Component may periodically call FContinueIdle; if this method returns FALSE (0), component should terminate its idle time processing and return. Simply calls through to FDoIdleCore.
Explicit interface implemetationPrivate method IOleComponent.FPreTranslateMessage Host calls this method on the active component (if its registration info (ComponentRegistrationFlags) indicates it is interested in Pre-translate calls) to give the component a chance to process messages before they are translated and dispatched. The host need not call this method if no component is active. Simply calls through to FPreTranslateMessageCore.
Explicit interface implemetationPrivate method IOleComponent.FQueryTerminate Called when component manager wishes to know if the component is in a state in which it can terminate. Simply calls through to FQueryTerminateCore.
Explicit interface implemetationPrivate method IOleComponent.FReserved1 Reserved slot, not called.
Explicit interface implemetationPrivate method IOleComponent.HwndGetWindow Called to retrieve a window associated with the component, as specified by dwWhich which maps to a value in WindowType. Simply calls through to HwndGetWindowCore.
Explicit interface implemetationPrivate method IOleComponent.OnActivationChange Notify component when a new object is being activated. Simply calls through to OnActivationChangeCore.
Explicit interface implemetationPrivate method IOleComponent.OnAppActivate Notify component when the host application gains or loses activation. Simply calls through to OnAppActivateCore.
Explicit interface implemetationPrivate method IOleComponent.OnEnterState Notify component when app enters or exits the state given in uStateID. Simply calls through to OnChangeStateCore.
Explicit interface implemetationPrivate method IOleComponent.OnLoseActivation Notify the active component that it has lost its active status because the host or another component has become active. Simply calls through to OnLoseActivationCore.
Explicit interface implemetationPrivate method IOleComponent.Terminate Called when component manager wishes to terminate the component's registration. Component should revoke its registration with component manager, release references to component manager and perform any necessary cleanup. Simply calls through to TerminateCore.


See Also


OleComponent Class

Microsoft.VisualStudio.PlatformUI.OleComponentSupport Namespace