get_child method

get_child(node_type, index, is_deep)

Returns an Nth child node that matches the specified type.

def get_child(self, node_type: aspose.words.NodeType, index: int, is_deep: bool):
    ...

Parameter	Type	Description
node_type	NodeType	Specifies the type of the child node.
index	int	Zero based index of the child node to select. Negative indexes are also allowed and indicate access from the end, that is -1 means the last node.
is_deep	bool	`True` to select from all child nodes recursively; `False` to select only among immediate children. See remarks for more info.

Remarks

If index is out of range, a None is returned.

Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep =False and CompositeNode.get_child() is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by CompositeNode.get_child()(NodeType.RUN, 0, False).

Returns

The child node that matches the criteria or None if no matching node is found.

Examples

Shows how to apply the properties of a table’s style directly to the table’s elements.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

table = builder.start_table()
builder.insert_cell()
builder.write("Hello world!")
builder.end_table()

table_style = doc.styles.add(aw.StyleType.TABLE, "MyTableStyle1").as_table_style()
table_style.row_stripe = 3
table_style.cell_spacing = 5
table_style.shading.background_pattern_color = drawing.Color.antique_white
table_style.borders.color = drawing.Color.blue
table_style.borders.line_style = aw.LineStyle.DOT_DASH

table.style = table_style

# This method concerns table style properties such as the ones we set above.
doc.expand_table_styles_to_direct_formatting()

doc.save(ARTIFACTS_DIR + "Document.table_style_to_direct_formatting.docx")

Shows how to traverse through a composite node’s collection of child nodes.

doc = aw.Document()

# Add two runs and one shape as child nodes to the first paragraph of this document.
paragraph = doc.get_child(aw.NodeType.PARAGRAPH, 0, True).as_paragraph()
paragraph.append_child(aw.Run(doc, "Hello world! "))

shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.RECTANGLE)
shape.width = 200
shape.height = 200
# Note that the 'custom_node_id' is not saved to an output file and exists only during the node lifetime.
shape.custom_node_id = 100
shape.wrap_type = aw.drawing.WrapType.INLINE
paragraph.append_child(shape)

paragraph.append_child(aw.Run(doc, "Hello again!"))

# Iterate through the paragraph's collection of immediate children,
# and print any runs or shapes that we find within.
children = paragraph.get_child_nodes(aw.NodeType.ANY, False)

self.assertEqual(3, paragraph.get_child_nodes(aw.NodeType.ANY, False).count)

for child in children:
    if child.node_type == aw.NodeType.RUN:
        print("Run contents:")
        print(f"\t\"{child.get_text().strip()}\"")

    elif child.node_type == aw.NodeType.SHAPE:
        child_shape = child.as_shape()
        print("Shape:")
        print(f"\t{child_shape.shape_type}, {child_shape.width}x{child_shape.height}")

get_child method

get_child(node_type, index, is_deep)

Remarks

Returns

Examples

See Also