to_string method

to_string(save_format)

Exports the content of the node into a string in the specified format.

def to_string(self, save_format: aspose.words.SaveFormat):
    ...
ParameterTypeDescription
save_formatSaveFormat

Returns

The content of the node in the specified format.

to_string(save_options)

Exports the content of the node into a string using the specified save options.

def to_string(self, save_options: aspose.words.saving.SaveOptions):
    ...
ParameterTypeDescription
save_optionsSaveOptionsSpecifies the options that control how the node is saved.

Returns

The content of the node in the specified format.

Examples

Shows the difference between calling the get_text and to_string methods on a node.

doc = aw.Document()

builder = aw.DocumentBuilder(doc)
builder.insert_field("MERGEFIELD Field")

# get_text will retrieve the visible text as well as field codes and special characters.
self.assertEqual("\u0013MERGEFIELD Field\u0014«Field»\u0015\u000c", doc.get_text())

# to_string will give us the document's appearance if saved to a passed save format.
self.assertEqual("«Field»\r\n", doc.to_string(aw.SaveFormat.TEXT))

Shows how to extract the list labels of all paragraphs that are list items.

doc = aw.Document(MY_DIR + "Rendering.docx")
doc.update_list_labels()

paras = [node.as_paragraph() for node in doc.get_child_nodes(aw.NodeType.PARAGRAPH, True)]

# Find if we have the paragraph list. In our document, our list uses plain Arabic numbers,
# which start at three and ends at six.
for paragraph in paras:
    if paragraph.list_format.is_list_item:
        print(f"List item paragraph #{paras.index(paragraph)}")

        # This is the text we get when getting when we output this node to text format.
        # This text output will omit list labels. Strip any paragraph formatting characters.
        paragraph_text = paragraph.to_string(aw.SaveFormat.TEXT).strip()
        print(f"\tExported Text: {paragraph_text}")

        label = paragraph.list_label

        # This gets the position of the paragraph in the current level of the list. If we have a list with multiple levels,
        # this will tell us what position it is on that level.
        print(f"\tNumerical Id: {label.label_value}")

        # Combine them together to include the list label with the text in the output.
        print(f"\tList label combined with text: {label.label_string} {paragraph_text}")

Exports the content of a node to String in HTML format.

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

node = doc.last_section.body.last_paragraph

# When we call the "to_string" method using the html SaveFormat overload,
# it converts the node's contents to their raw html representation.
self.assertEqual('<p style="margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt">' +
                 '<span style="font-family:\'Times New Roman\'">Hello World!</span>' +
                 '</p>', node.to_string(aw.SaveFormat.HTML))

# We can also modify the result of this conversion using a SaveOptions object.
save_options = aw.saving.HtmlSaveOptions()
save_options.export_relative_font_size = True

self.assertEqual('<p style="margin-top:0pt; margin-bottom:8pt; line-height:108%">' +
                 '<span style="font-family:\'Times New Roman\'">Hello World!</span>' +
                 '</p>', node.to_string(save_options))

See Also

Node.remove method