CR property

ControlChar.CR property

Carriage return character: “\x000d” or “\r”. Same as ControlChar.PARAGRAPH_BREAK.

@property
def CR(self) -> str:
    ...

Examples

Shows how to use control characters.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# Insert paragraphs with text with DocumentBuilder.
builder.writeln('Hello world!')
builder.writeln('Hello again!')
# Converting the document to text form reveals that control characters
# represent some of the document's structural elements, such as page breaks.
self.assertEqual(f'Hello world!{aw.ControlChar.CR}' + f'Hello again!{aw.ControlChar.CR}' + aw.ControlChar.PAGE_BREAK, doc.get_text())
# When converting a document to string form,
# we can omit some of the control characters with the Trim method.
self.assertEqual(f'Hello world!{aw.ControlChar.CR}' + 'Hello again!', doc.get_text().strip())

See Also

ControlChar.COLUMN_BREAK_CHAR property ControlChar.CR_LF property