IComponentPainterView interface
No description yet.
public interface IComponentPainterView
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Derived: IComponentPainterView2
Methods
| Method | Returns | Description |
|---|---|---|
| HideComponentTextualDescriptions | void | |
| HighLightComponentPins | void | |
| RegisterListener | void | |
| RenameSpecifiedPins | void | |
| SetComponent | void | The SetComponent method sets the ComponentPainter object to display the specific part of a component from the library with the specified library path. |
| SetComponentByHandle | void | The SetComponentByHandle method sets the ComponentPainter object to display the specific part of a component. |
| ShowAllPins | void | |
| ShowPinsAsSelected | void | |
| ShowSpecifiedPinsOnly | void |
HideComponentTextualDescriptions
No description yet.
void HideComponentTextualDescriptions();
Returns: nothing (void)
HighLightComponentPins
No description yet.
void HighLightComponentPins(string argPinNameList, int argHighlightColor, int argNonHighlightColor);
| Parameter | Type | Passing |
|---|---|---|
argPinNameList | string | value |
argHighlightColor | int | value |
argNonHighlightColor | int | value |
Returns: nothing (void)
RegisterListener
No description yet.
void RegisterListener(IComponentPinSelectionListener argPinSelectionListener);
void RegisterListener(object argPinSelectionListener);
| Parameter | Type | Passing |
|---|---|---|
argPinSelectionListener | IComponentPinSelectionListener | value |
Returns: nothing (void)
The first overload is an extension method of IComponentPainterViewHelper (using SCH;) with typed parameters; the second is declared by the interface.
RenameSpecifiedPins
No description yet.
void RenameSpecifiedPins(string argPinNamesParam);
| Parameter | Type | Passing |
|---|---|---|
argPinNamesParam | string | value |
Returns: nothing (void)
SetComponent
The SetComponent method sets the ComponentPainter object to display the specific part of a component from the library with the specified library path. Note a component can be a multi-part component and the first part is numbered 1 and so on.
void SetComponent(string argLibReference, string argLibraryPath, int argPartIndex, bool argHideTextualDescription);
| Parameter | Type | Passing |
|---|---|---|
argLibReference | string | value |
argLibraryPath | string | value |
argPartIndex | int | value |
argHideTextualDescription | bool | value |
Returns: nothing (void)
A component painter object can also be set with the component's handle of ISch_Component type.
SetComponentByHandle
The SetComponentByHandle method sets the ComponentPainter object to display the specific part of a component. Note a component can be a multi-part component and the first part is numbered 1 and so on.
void SetComponentByHandle(ISch_Component argHandle, int argPartIndex);
void SetComponentByHandle(object argHandle, int argPartIndex);
| Parameter | Type | Passing |
|---|---|---|
argHandle | ISch_Component | value |
argPartIndex | int | value |
Returns: nothing (void)
The first overload is an extension method of IComponentPainterViewHelper (using SCH;) with typed parameters; the second is declared by the interface.
A component painter object can also be set with the full path to a library and its component.
See also: IComponentPainterView.SetComponent
ShowAllPins
No description yet.
void ShowAllPins();
Returns: nothing (void)
ShowPinsAsSelected
No description yet.
void ShowPinsAsSelected(string argPinNameList);
| Parameter | Type | Passing |
|---|---|---|
argPinNameList | string | value |
Returns: nothing (void)
ShowSpecifiedPinsOnly
No description yet.
void ShowSpecifiedPinsOnly(string argPinNameList);
| Parameter | Type | Passing |
|---|---|---|
argPinNameList | string | value |
Returns: nothing (void)