paper_color property

ImageSaveOptions.paper_color property

Gets or sets the background (paper) color for the generated images. The default value is aspose.pydrawing.Color.white.

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

@paper_color.setter
def paper_color(self, value: aspose.pydrawing.Color):
    ...

Remarks

When rendering pages of a document that specifies its own background color, then the document background color will override the color specified by this property.

Examples

Renders a page of a Word document into an image with transparent or colored background.

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

builder.font.name = "Times New Roman"
builder.font.size = 24
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.")

builder.insert_image(IMAGE_DIR + "Logo.jpg")

# Create an "ImageSaveOptions" object which we can pass to the document's "save" method
# to modify the way in which that method renders the document into an image.
img_options = aw.saving.ImageSaveOptions(aw.SaveFormat.PNG)

# Set the "paper_color" property to a transparent color to apply a transparent
# background to the document while rendering it to an image.
img_options.paper_color = drawing.Color.transparent

doc.save(ARTIFACTS_DIR + "ImageSaveOptions.paper_color.transparent.png", img_options)

# Set the "paper_color" property to an opaque color to apply that color
# as the background of the document as we render it to an image.
img_options.paper_color = drawing.Color.light_coral

doc.save(ARTIFACTS_DIR + "ImageSaveOptions.paper_color.light_coral.png", img_options)

paper_color property

ImageSaveOptions.paper_color property

Remarks

Examples

See Also