Foxit PDF SDK
fsdk.Watermark Class Reference

Public Member Functions

def GetHeight ()
 Get the original height of current watermark. More...
 
def GetWidth ()
 Get the original width of current watermark. More...
 
def InsertToPage (page)
 Insert current watermark into a PDF page. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 

Detailed Description

This class is mainly used to construct a watermark with specified parameters, and then insert it to PDF page. The watermark object can be constructed from text, bitmap or image, and PDF page.

Member Function Documentation

◆ GetHeight()

def fsdk.Watermark.GetHeight ( )

Get the original height of current watermark.

The original size of a watermark is based on no scaling and no rotation.

Returns
Watermark height.

◆ GetWidth()

def fsdk.Watermark.GetWidth ( )

Get the original width of current watermark.

The original size of a watermark is based on no scaling and no rotation.

Returns
Watermark width.

◆ InsertToPage()

def fsdk.Watermark.InsertToPage (   page)

Insert current watermark into a PDF page.

If current watermark is treated as page content (which is specified by flags of WatermarkSettings when current watermark is constructed), Foxit PDF SDK will generate content for the input PDF page by default after the watermark is inserted successfully. In this case , if user wants to render the PDF page correctly after this function has been called successfully, user is recommended to call function fsdk.PDFPage.StartParse with parameter is_reparse true before rendering; otherwise, the page content may not be rendered as expected.

Parameters
[in]pageA PDF page, to which current watermark would be inserted. This page should belong to the same document as current watermark belongs to. And the page should have been already parsed.
Returns
true means success, while false means failure.

◆ IsEmpty()

def fsdk.Watermark.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.