.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.activex

.. highlight:: python



.. _wx.lib.activex.ActiveXCtrl:

==========================================================================================================================================
|phoenix_title|  **wx.lib.activex.ActiveXCtrl**
==========================================================================================================================================

A wx.Window for hosting ActiveX controls.  The COM interface of
the ActiveX control is accessible through the ctrl property of
this class, and this class is also set as the event sink for COM
events originating from the ActiveX control.  In other words, to
catch the COM events you merely have to derive from this class and
provide a method with the correct name.  See the comtypes package
documentation for more details.



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>ActiveXCtrl</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.activex.ActiveXCtrl_inheritance.svg" alt="Inheritance diagram of ActiveXCtrl" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.activex.ActiveXCtrl.html" title="A wx.Window for hosting ActiveX controls.  The COM interface of" alt="" coords="18,389,225,418"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="66,236,177,265"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="48,159,195,188"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node6" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.msw.PyAxBaseWindow`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.activex.ActiveXCtrl.__init__`                                     All parameters are like those used in normal wx.Windows with
:meth:`~wx.lib.activex.ActiveXCtrl.AddEventSink`                                 Add a new target to search for method names that match the COM
:meth:`~wx.lib.activex.ActiveXCtrl.GetCtrl`                                      Easy access to the COM interface for the ActiveX Control
:meth:`~wx.lib.activex.ActiveXCtrl.MSWTranslateMessage`                          MSWTranslateMessage(msg) -> bool
:meth:`~wx.lib.activex.ActiveXCtrl.OnDestroyWindow`                              
:meth:`~wx.lib.activex.ActiveXCtrl.OnKillFocus`                                  
:meth:`~wx.lib.activex.ActiveXCtrl.OnSetFocus`                                   
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.lib.activex.ActiveXCtrl.ctrl`                                         Easy access to the COM interface for the ActiveX Control
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: ActiveXCtrl(wx.msw.PyAxBaseWindow)

   A wx.Window for hosting ActiveX controls.  The COM interface of
   the ActiveX control is accessible through the ctrl property of
   this class, and this class is also set as the event sink for COM
   events originating from the ActiveX control.  In other words, to
   catch the COM events you merely have to derive from this class and
   provide a method with the correct name.  See the comtypes package
   documentation for more details.

   .. method:: __init__(self, parent, axID, wxid=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name="activeXCtrl")

      All parameters are like those used in normal wx.Windows with
      the addition of axID which is a string that is either a ProgID
      or a CLSID used to identify the ActiveX control.


   .. method:: AddEventSink(self, sink, interface=None)

      Add a new target to search for method names that match the COM
      Event names.


   .. method:: GetCtrl(self)

      Easy access to the COM interface for the ActiveX Control


   .. method:: MSWTranslateMessage(self, msg)

      MSWTranslateMessage(msg) -> bool


   .. method:: OnDestroyWindow(self, evt)


   .. method:: OnKillFocus(self, evt)


   .. method:: OnSetFocus(self, evt)


   .. attribute:: ctrl

      Easy access to the COM interface for the ActiveX Control