SectionLayoutMode enumeration
SectionLayoutMode enumeration
Specifies the layout mode for a section allowing to define the document grid behavior.
Members
| Name | Description |
|---|---|
| DEFAULT | Specifies that no document grid shall be applied to the contents of the corresponding section in the document. |
| GRID | Specifies that the corresponding section shall have both the additional line pitch and character pitch added to each line and character within it in order to maintain a specific number of lines per page and characters per line. Characters will not be automatically aligned with gridlines on typing. |
| LINE_GRID | Specifies that the corresponding section shall have additional line pitch added to each line within it in order to maintain the specified number of lines per page. |
| SNAP_TO_CHARS | Specifies that the corresponding section shall have both the additional line pitch and character pitch added to each line and character within it in order to maintain a specific number of lines per page and characters per line. Characters will be automatically aligned with gridlines on typing. |
Examples
Shows how to specify a for the number of characters that each line may have.
doc = aw.Document()
builder = aw.DocumentBuilder(doc)
# Enable pitching, and then use it to set the number of characters per line in this section.
builder.page_setup.layout_mode = aw.SectionLayoutMode.GRID
builder.page_setup.characters_per_line = 10
# The number of characters also depends on the size of the font.
doc.styles.get_by_name("Normal").font.size = 20
self.assertEqual(8, doc.first_section.page_setup.characters_per_line)
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.")
doc.save(ARTIFACTS_DIR + "PageSetup.characters_per_line.docx")
Shows how to specify a limit for the number of lines that each page may have.
doc = aw.Document()
builder = aw.DocumentBuilder(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
for i in range(30):
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ")
doc.save(ARTIFACTS_DIR + "PageSetup.lines_per_page.docx")
See Also
- module aspose.words