insert method
insert(index, node)
Inserts a node into the collection at the specified index.
def insert(self, index: int, node: aspose.words.Node):
...
| Parameter | Type | Description |
|---|---|---|
| index | int | The zero-based index of the node. Negative indexes are allowed and indicate access from the back of the list. For example -1 means the last node, -2 means the second before last and so on. |
| node | Node | The node to insert. |
Remarks
The node is inserted as a child into the node object from which the collection was created.
If the index is equal to or greater than NodeCollection.count, the node is added at the end of the collection.
If the index is negative and its absolute value is greater than NodeCollection.count, the node is added at the end of the collection.
If the node being inserted was created from another document, you should use DocumentBase.import_node() to import the node to the current document. The imported node can then be inserted into the current document.
Exceptions
| exception | condition |
|---|---|
| RuntimeError (Proxy error(NotSupportedException)) | The NodeCollection is a “deep” collection. |
Examples
Shows how to work with a NodeCollection.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# Add text to the document by inserting Runs using a DocumentBuilder.
builder.write('Run 1. ')
builder.write('Run 2. ')
# Every invocation of the "Write" method creates a new Run,
# which then appears in the parent Paragraph's RunCollection.
runs = doc.first_section.body.first_paragraph.runs
self.assertEqual(2, runs.count)
# We can also insert a node into the RunCollection manually.
new_run = aw.Run(doc=doc, text='Run 3. ')
runs.insert(3, new_run)
self.assertTrue(runs.contains(new_run))
self.assertEqual('Run 1. Run 2. Run 3.', doc.get_text().strip())
# Access individual runs and remove them to remove their text from the document.
run = runs[1]
runs.remove(run)
self.assertEqual('Run 1. Run 3.', doc.get_text().strip())
self.assertIsNotNone(run)
self.assertFalse(runs.contains(run))
See Also
- module aspose.words
- class NodeCollection