auto_color property

Font.auto_color property

Returns the present calculated color of the text (black or white) to be used for ‘auto color’. If the color is not ‘auto’ then returns Font.color.

@property
def auto_color(self) -> aspose.pydrawing.Color:
    ...

Remarks

When text has ‘automatic color’, the actual color of text is calculated automatically so that it is readable against the background color. As you change the background color, the text color will automatically switch to black or white in MS Word to maximize legibility.

Examples

Shows how to improve readability by automatically selecting text color based on the brightness of its background.

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

# If a run's Font object does not specify text color, it will automatically
# select either black or white depending on the background color's color.
self.assertEqual(drawing.Color.empty().to_argb(), builder.font.color.to_argb())

# The default color for text is black. If the color of the background is dark, black text will be difficult to see.
# To solve this problem, the "auto_color" property will display this text in white.
builder.font.shading.background_pattern_color = drawing.Color.dark_blue

builder.writeln("The text color automatically chosen for this run is white.")

self.assertEqual(drawing.Color.white.to_argb(), doc.first_section.body.paragraphs[0].runs[0].font.auto_color.to_argb())

# If we change the background to a light color, black will be a more
# suitable text color than white so that the auto color will display it in black.
builder.font.shading.background_pattern_color = drawing.Color.light_blue

builder.writeln("The text color automatically chosen for this run is black.")

self.assertEqual(drawing.Color.black.to_argb(), doc.first_section.body.paragraphs[1].runs[0].font.auto_color.to_argb())

doc.save(ARTIFACTS_DIR + "Font.set_font_auto_color.docx")

auto_color property

Font.auto_color property

Remarks

Examples

See Also