IComponentLinkEmbedControl#

class ansys.stk.core.stkobjects.IComponentLinkEmbedControl#

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

Overview#

set_component

Set the component by name.

reference_type

Get or set the component reference type.

component

Get the component interface.

supported_components

Get the list of supported component names.

Import detail#

from ansys.stk.core.stkobjects import IComponentLinkEmbedControl

Property detail#

property IComponentLinkEmbedControl.reference_type: ComponentLinkEmbedControlReferenceType#

Get or set the component reference type.

property IComponentLinkEmbedControl.component: IComponentInfo#

Get the component interface.

property IComponentLinkEmbedControl.supported_components: list#

Get the list of supported component names.

Method detail#

IComponentLinkEmbedControl.set_component(self, component_name: str) None#

Set the component by name.

Parameters:

component_name : str

Returns:

None