Subpicture and Element Navigation Functions
- Last UpdatedNov 27, 2023
- 1 minute read
|
element_parent_get(elementHandle) |
||
|
The function returns handle to the parent subpicture of the given element. |
||
|
Input Parameters: |
||
|
elementHandle |
KcsElementHandle |
Handle to element |
|
Returned value: |
||
|
[0] |
KcsElementHandle |
Handle of parent subpicture. |
|
Exceptions: |
||
|
kcs_ArgumentError |
Parameter is not expected. |
|
|
kcs_HandleInvalid |
Specified handle is not valid. |
|
|
kcs_DrawingNotCurrent |
No drawing was current. |
|
|
kcs_NotFound |
Element has no parent. This exception is raised when an attempt is made to get the parent of a view. |
|
|
kcs_Error |
General error. |
|
|
element_child_first_get(<subpictureHandle>) |
||
|
The function returns handle to the first child of the given subpicture handle. If no argument is given, a handle to the first view in the drawing is returned. |
||
|
Input Parameters: |
||
|
subpictureHandle |
KcsElementHandle |
Handle to subpicture |
|
Returned value: |
||
|
[0] |
KcsElementHandle |
Handle of the first child element. |
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid parameters list. |
|
|
kcs_HandleInvalid |
Specified handle is not valid. |
|
|
kcs_DrawingNotCurrent |
No drawing was current. |
|
|
kcs_NotFound |
Element has no children. |
|
|
kcs_Error |
General error. |
|
|
element_sibling_next_get(elementHandle) |
||
|
The function returns handle to the next sibling of the given element. |
||
|
Input Parameters: |
||
|
elementHandle |
KcsElementHandle |
Handle to element |
|
Returned value: |
||
|
[0] |
KcsElementHandle |
Handle of the next sibling element. |
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid parameters list. |
|
|
kcs_HandleInvalid |
Specified handle is not valid. |
|
|
kcs_DrawingNotCurrent |
No drawing was current. |
|
|
kcs_NotFound |
There is no next sibling element. |
|
|
kcs_Error |
General error. |
|
|
Example: |
||
|
# Example: kcs_ex_draft30.py |
||