get_images method

get_images

Finds images according to specified search criteria.

The search is conducted in objects specified in Watermarker.searchable_objects.

Learn more about searching watermarks https://docs.groupdocs.com/display/watermarknet/Searching+watermarks.

def get_images(self, search_criteria):
    ...
Parameter Type Description
search_criteria ImageSearchCriteria The search criteria to use.

Returns: WatermarkableImageCollection: The collection of found images.

Example

from groupdocs.watermark import Watermarker
from groupdocs.watermark.watermarks import TextWatermark, Font, Color, SizingType

with Watermarker("./document.pdf") as watermarker:
    watermark = TextWatermark("PROTECTED", Font("Arial", 8.0))
    watermark.foreground_color = Color.red
    watermark.sizing_type = SizingType.SCALE_TO_PARENT_DIMENSIONS

    for image in watermarker.get_images():
        if image.width > 100 and image.height > 100:
            image.add(watermark)

    watermarker.save("./output.pdf")

get_images

Finds all images in the document.

The search is conducted in objects specified in Watermarker.searchable_objects.

Learn more about searching watermarks at https://docs.groupdocs.com/display/watermarknet/Searching+watermarks.

def get_images(self):
    ...

Returns: The collection of found images.

Example

from groupdocs.watermark import Watermarker
from groupdocs.watermark.watermarks import TextWatermark, Font, Color, SizingType
from groupdocs.watermark.options.pdf import PdfLoadOptions

def watermark_images_inside():
    with Watermarker("./document.pdf", PdfLoadOptions()) as watermarker:
        watermark = TextWatermark("PROTECTED", Font("Arial", 8.0))
        watermark.foreground_color = Color.red
        watermark.sizing_type = SizingType.SCALE_TO_PARENT_DIMENSIONS
        watermark.scale_factor = 1.0

        # Every raster image embedded in the document
        for image in watermarker.get_images():
            # Skip tiny images such as icons or bullets
            if image.width > 100 and image.height > 100:
                image.add(watermark)

        watermarker.save("./output.pdf")

See Also