DropCapPosition enumeration

DropCapPosition enumeration

Specifies the position for a drop cap text.

Members

Name Description
NONE The paragraph does not have a drop cap.
NORMAL The drop cap is positioned inside the text margin on the anchor paragraph.
MARGIN The drop cap is positioned outside the text margin on the anchor paragraph.

Examples

Shows how to create a drop cap.

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

# Insert one paragraph with a large letter that the text in the second and third paragraphs begins with.
builder.font.size = 54
builder.writeln("L")

builder.font.size = 18
builder.writeln("orem ipsum dolor sit amet, consectetur adipiscing elit, " +
                "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ")
builder.writeln("Ut enim ad minim veniam, quis nostrud exercitation " +
                "ullamco laboris nisi ut aliquip ex ea commodo consequat.")

# Currently, the second and third paragraphs will appear underneath the first.
# We can convert the first paragraph as a drop cap for the other paragraphs via its "ParagraphFormat" object.
# Set the "drop_cap_position" property to "DropCapPosition.MARGIN" to place the drop cap
# outside the left-hand side page margin if our text is left-to-right.
# Set the "drop_cap_position" property to "DropCapPosition.NORMAL" to place the drop cap within the page margins
# and to wrap the rest of the text around it.
# "DropCapPosition.None" is the default state for all paragraphs.
format = doc.first_section.body.first_paragraph.paragraph_format
format.drop_cap_position = drop_cap_position

doc.save(ARTIFACTS_DIR + "ParagraphFormat.drop_cap.docx")

See Also