right_offset property

FieldAdvance.right_offset property

Gets or sets the number of points by which the text that follows the field should be moved right.

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

@right_offset.setter
def right_offset(self, value: str):
    ...

Examples

Shows how to insert an ADVANCE field, and edit its properties.

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

builder.write("This text is in its normal place.")

# Below are two ways of using the ADVANCE field to adjust the position of text that follows it.
# The effects of an ADVANCE field continue to be applied until the paragraph ends,
# or another ADVANCE field updates the offset/coordinate values.
# 1 -  Specify a directional offset:
field = builder.insert_field(aw.fields.FieldType.FIELD_ADVANCE, True).as_field_advance()
field.right_offset = "5"
field.up_offset = "5"

self.assertEqual(" ADVANCE  \\r 5 \\u 5", field.get_field_code())

builder.write("This text will be moved up and to the right.")

field = builder.insert_field(aw.fields.FieldType.FIELD_ADVANCE, True).as_field_advance()
field.down_offset = "5"
field.left_offset = "100"

self.assertEqual(" ADVANCE  \\d 5 \\l 100", field.get_field_code())

builder.writeln("This text is moved down and to the left, overlapping the previous text.")

# 2 -  Move text to a position specified by coordinates:
field = builder.insert_field(aw.fields.FieldType.FIELD_ADVANCE, True).as_field_advance()
field.horizontal_position = "-100"
field.vertical_position = "200"

self.assertEqual(" ADVANCE  \\x -100 \\y 200", field.get_field_code())

builder.write("This text is in a custom position.")

doc.save(ARTIFACTS_DIR + "Field.field_advance.docx")

right_offset property

FieldAdvance.right_offset property

Examples

See Also