ITOCNode interface
No description yet.
public interface ITOCNode
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| BoundingRectangle | Rect | get | |
| ChildCount | int | get | |
| Children | ITOCNode | get | |
| DisplayName | string | get | |
| HighlightKey | string | get | |
| HighlightRectangle | Rect | get | |
| IsComponent | bool | get | |
| Kind | TTOCObjectKind | get | |
| Name | string | get | |
| PageIndex | int | get |
BoundingRectangle
No description yet.
Rect GetState_BoundingRectangle();
Type: Rect · Access: read-only
The accessors are extension methods of ITOCNodeHelper (using EDP;).
ChildCount
No description yet.
int GetState_ChildCount();
Type: int · Access: read-only
Children
No description yet.
ITOCNode GetState_Children(int argIndex);
Type: ITOCNode · Access: read-only · Index: argIndex (int)
The accessors are extension methods of ITOCNodeHelper (using EDP;).
DisplayName
No description yet.
string GetState_DisplayName();
Type: string · Access: read-only
HighlightKey
No description yet.
string GetState_HighlightKey();
Type: string · Access: read-only
HighlightRectangle
No description yet.
Rect GetState_HighlightRectangle();
Type: Rect · Access: read-only
The accessors are extension methods of ITOCNodeHelper (using EDP;).
IsComponent
No description yet.
bool GetState_IsComponent();
Type: bool · Access: read-only
Kind
No description yet.
TTOCObjectKind GetState_Kind();
Type: TTOCObjectKind · Access: read-only
The accessors are extension methods of ITOCNodeHelper (using EDP;).
Name
No description yet.
string GetState_Name();
Type: string · Access: read-only
PageIndex
No description yet.
int GetState_PageIndex();
Type: int · Access: read-only
Methods
| Method | Returns | Description |
|---|---|---|
| AddAttribute | void | |
| AddChild | int | |
| FindChildByName | ITOCNode | |
| RemoveAttribute | void | |
| RemoveChild | void | |
| SortChildrenByName | void |
AddAttribute
No description yet.
void AddAttribute(string argttribute);
| Parameter | Type | Passing |
|---|---|---|
argttribute | string | value |
Returns: nothing (void)
AddChild
No description yet.
int AddChild(string argName, Rect argBoundingRectangle, Rect argHighlightRectangle, string argHighlightKey, int argPageIndex, bool argIsComponent, TTOCObjectKind argKind);
int AddChild(string argName, IRect argBoundingRectangle, IRect argHighlightRectangle, string argHighlightKey, int argPageIndex, bool argIsComponent, int argKind);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
argBoundingRectangle | Rect | value |
argHighlightRectangle | Rect | value |
argHighlightKey | string | value |
argPageIndex | int | value |
argIsComponent | bool | value |
argKind | TTOCObjectKind | value |
Returns: int
The first overload is an extension method of ITOCNodeHelper (using EDP;) with typed parameters; the second is declared by the interface.
FindChildByName
No description yet.
ITOCNode FindChildByName(string argName);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
Returns: ITOCNode
Extension method of ITOCNodeHelper (using EDP;).
RemoveAttribute
No description yet.
void RemoveAttribute(string argttribute);
| Parameter | Type | Passing |
|---|---|---|
argttribute | string | value |
Returns: nothing (void)
RemoveChild
No description yet.
void RemoveChild(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: nothing (void)
SortChildrenByName
No description yet.
void SortChildrenByName();
Returns: nothing (void)