aspose.cells

Class RenderingWatermark

Watermark for rendering.

Constructor Summary
RenderingWatermark(text, renderingFont)
Creates instance of text watermark.
RenderingWatermark(imageData)
Creates instance of image watermark.
 
Property Getters/Setters Summary
functiongetFont()
Gets font of the watermark.
functiongetHAlignment()
function
           Gets or sets horizontal alignment of the watermark to the page. The value of the property is TextAlignmentType integer constant.
functiongetImage()
Gets image of the watermark.
functionisBackground()
function
           Indicates whether the watermark is placed behind page contents.
functiongetOffsetX()
function
setOffsetX(value)
           Gets or sets offset value to HAlignment
functiongetOffsetY()
function
setOffsetY(value)
           Gets or sets offset value to VAlignment
functiongetOpacity()
function
setOpacity(value)
           Gets or sets opacity of the watermark in range [0, 1].
functiongetRotation()
function
           Gets or sets roation of the watermark in degrees.
functiongetScaleToPagePercent()
function
           Gets or sets scale relative to target page in percent.
functiongetText()
Gets text of the watermark.
functiongetVAlignment()
function
           Gets or sets vertical alignment of the watermark to the page. The value of the property is TextAlignmentType integer constant.
 

    • Constructor Detail

      • RenderingWatermark

        function RenderingWatermark(text, renderingFont)
        Creates instance of text watermark.
        Parameters:
        text: String - watermark text
        renderingFont: RenderingFont - watermark font
      • RenderingWatermark

        function RenderingWatermark(imageData)
        Creates instance of image watermark.
        Parameters:
        imageData: byte[] -
    • Property Getters/Setters Detail

      • getRotation/setRotation : Number 

        function getRotation() / function setRotation(value)
        
        Gets or sets roation of the watermark in degrees.
      • getScaleToPagePercent/setScaleToPagePercent : Number 

        function getScaleToPagePercent() / function setScaleToPagePercent(value)
        
        Gets or sets scale relative to target page in percent.
      • getOpacity/setOpacity : Number 

        function getOpacity() / function setOpacity(value)
        
        Gets or sets opacity of the watermark in range [0, 1].
      • isBackground/setBackground : boolean 

        function isBackground() / function setBackground(value)
        
        Indicates whether the watermark is placed behind page contents.
      • getText : String 

        function getText()
        
        Gets text of the watermark.
      • getFont : RenderingFont 

        function getFont()
        
        Gets font of the watermark.
      • getImage : byte[] 

        function getImage()
        
        Gets image of the watermark.
      • getHAlignment/setHAlignment : Number 

        function getHAlignment() / function setHAlignment(value)
        
        Gets or sets horizontal alignment of the watermark to the page. The value of the property is TextAlignmentType integer constant. Only Left, Center, Right is valid. Default is Left.
      • getVAlignment/setVAlignment : Number 

        function getVAlignment() / function setVAlignment(value)
        
        Gets or sets vertical alignment of the watermark to the page. The value of the property is TextAlignmentType integer constant. Only Top, Center, Bottom is valid. Default is Top.
      • getOffsetX/setOffsetX : Number 

        function getOffsetX() / function setOffsetX(value)
        
        Gets or sets offset value to HAlignment
      • getOffsetY/setOffsetY : Number 

        function getOffsetY() / function setOffsetY(value)
        
        Gets or sets offset value to VAlignment