Inline class

Inline class

Base class for inline-level nodes that can have character formatting associated with them, but cannot have child nodes of their own. To learn more, visit the Logical Levels of Nodes in a Document documentation article.

Remarks

A class derived from Inline can be a child of Paragraph.

Inheritance: InlineNode

Properties

NameDescription
custom_node_idSpecifies custom node identifier.
(Inherited from Node)
documentGets the document to which this node belongs.
(Inherited from Node)
fontProvides access to the font formatting of this object.
is_compositeReturns True if this node can contain other nodes.
(Inherited from Node)
is_delete_revisionReturns true if this object was deleted in Microsoft Word while change tracking was enabled.
is_format_revisionReturns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
is_insert_revisionReturns true if this object was inserted in Microsoft Word while change tracking was enabled.
is_move_from_revisionReturns True if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
is_move_to_revisionReturns True if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
next_siblingGets the node immediately following this node.
(Inherited from Node)
node_typeGets the type of this node.
(Inherited from Node)
parent_nodeGets the immediate parent of this node.
(Inherited from Node)
parent_paragraphRetrieves the parent Paragraph of this node.
previous_siblingGets the node immediately preceding this node.
(Inherited from Node)
rangeReturns a Range object that represents the portion of a document that is contained in this node.
(Inherited from Node)

Methods

NameDescription
accept(visitor)Accepts a visitor.
(Inherited from Node)
clone(is_clone_children)Creates a duplicate of the node.
(Inherited from Node)
get_ancestor(ancestor_type)Gets the first ancestor of the specified object type.
(Inherited from Node)
get_ancestor(ancestor_type)Gets the first ancestor of the specified NodeType.
(Inherited from Node)
get_text()Gets the text of this node and of all its children.
(Inherited from Node)
next_pre_order(root_node)Gets next node according to the pre-order tree traversal algorithm.
(Inherited from Node)
node_type_to_string(node_type)A utility method that converts a node type enum value into a user friendly string.
(Inherited from Node)
previous_pre_order(root_node)Gets the previous node according to the pre-order tree traversal algorithm.
(Inherited from Node)
remove()Removes itself from the parent.
(Inherited from Node)
to_string(save_format)Exports the content of the node into a string in the specified format.
(Inherited from Node)
to_string(save_options)Exports the content of the node into a string using the specified save options.
(Inherited from Node)

Examples

Shows how to determine the revision type of an inline node.

doc = aw.Document(MY_DIR + "Revision runs.docx")

# When we edit the document while the "Track Changes" option, found in via Review -> Tracking,
# is turned on in Microsoft Word, the changes we apply count as revisions.
# When editing a document using Aspose.Words, we can begin tracking revisions by
# invoking the document's "start_track_revisions" method and stop tracking by using the "stop_track_revisions" method.
# We can either accept revisions to assimilate them into the document
# or reject them to change the proposed change effectively.
self.assertEqual(6, doc.revisions.count)

# The parent node of a revision is the run that the revision concerns. A Run is an Inline node.
run = doc.revisions[0].parent_node.as_run()

first_paragraph = run.parent_paragraph
runs = first_paragraph.runs

self.assertEqual(6, len(runs.to_array()))

# Below are five types of revisions that can flag an Inline node.
# 1 -  An "insert" revision:
# This revision occurs when we insert text while tracking changes.
self.assertTrue(runs[2].is_insert_revision)

# 2 -  A "format" revision:
# This revision occurs when we change the formatting of text while tracking changes.
self.assertTrue(runs[2].is_format_revision)

# 3 -  A "move from" revision:
# When we highlight text in Microsoft Word, and then drag it to a different place in the document
# while tracking changes, two revisions appear.
# The "move from" revision is a copy of the text originally before we moved it.
self.assertTrue(runs[4].is_move_from_revision)

# 4 -  A "move to" revision:
# The "move to" revision is the text that we moved in its new position in the document.
# "Move from" and "move to" revisions appear in pairs for every move revision we carry out.
# Accepting a move revision deletes the "move from" revision and its text,
# and keeps the text from the "move to" revision.
# Rejecting a move revision conversely keeps the "move from" revision and deletes the "move to" revision.
self.assertTrue(runs[1].is_move_to_revision)

# 5 -  A "delete" revision:
# This revision occurs when we delete text while tracking changes. When we delete text like this,
# it will stay in the document as a revision until we either accept the revision,
# which will delete the text for good, or reject the revision, which will keep the text we deleted where it was.
self.assertTrue(runs[5].is_delete_revision)

See Also