IComponentLinkEmbedControl
==========================

.. py:class:: ansys.stk.core.stkobjects.IComponentLinkEmbedControl

   Interface for a control which manages the linking or embedding of a component from the component browser.

.. py:currentmodule:: IComponentLinkEmbedControl

Overview
--------

.. tab-set::

    .. tab-item:: Methods

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.IComponentLinkEmbedControl.set_component`
              - Set the component by name.

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.IComponentLinkEmbedControl.reference_type`
              - Get or set the component reference type.
            * - :py:attr:`~ansys.stk.core.stkobjects.IComponentLinkEmbedControl.component`
              - Get the component interface.
            * - :py:attr:`~ansys.stk.core.stkobjects.IComponentLinkEmbedControl.supported_components`
              - Get the list of supported component names.


Import detail
-------------

.. code-block:: python

    from ansys.stk.core.stkobjects import IComponentLinkEmbedControl


Property detail
---------------

.. py:property:: reference_type
    :canonical: ansys.stk.core.stkobjects.IComponentLinkEmbedControl.reference_type
    :type: ComponentLinkEmbedControlReferenceType

    Get or set the component reference type.

.. py:property:: component
    :canonical: ansys.stk.core.stkobjects.IComponentLinkEmbedControl.component
    :type: IComponentInfo

    Get the component interface.

.. py:property:: supported_components
    :canonical: ansys.stk.core.stkobjects.IComponentLinkEmbedControl.supported_components
    :type: list

    Get the list of supported component names.


Method detail
-------------





.. py:method:: set_component(self, component_name: str) -> None
    :canonical: ansys.stk.core.stkobjects.IComponentLinkEmbedControl.set_component

    Set the component by name.

    :Parameters:

        **component_name** : :obj:`~str`


    :Returns:

        :obj:`~None`