snap_to_grid property

ParagraphFormat.snap_to_grid property

Specifies whether the current paragraph should use the document grid lines per page settings when laying out the contents in the paragraph.

@property
def snap_to_grid(self) -> bool:
    ...

@snap_to_grid.setter
def snap_to_grid(self, value: bool):
    ...

Examples

Shows how to specify a limit for the number of lines that each page may have.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# Enable pitching, and then use it to set the number of lines per page in this section.
# A large enough font size will push some lines down onto the next page to avoid overlapping characters.
builder.page_setup.layout_mode = aw.SectionLayoutMode.LINE_GRID
builder.page_setup.lines_per_page = 15
builder.paragraph_format.snap_to_grid = True
i = 0
while i < 30:
    builder.write('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ')
    i += 1
doc.save(file_name=ARTIFACTS_DIR + 'PageSetup.LinesPerPage.docx')

snap_to_grid property

ParagraphFormat.snap_to_grid property

Examples

See Also