Watermark

DDX Reference > DDX Language Elements > Watermark

Watermark

Provides styled text or a PDF file for placement over the existing page content. The Watermark element applies a watermark to all pages in the scope of its parent element, replacing any preexisting watermarks on those pages if the replaceExisting attribute has not been specified or is "true". In LiveCycle ES 8.0 and later, you can retain pre-existing watermarks when adding one new watermark. This is specified with the replaceExisting attribute. If replaceExisting is "false", a new Watermark will be added to the existing Watermark. There may still only be one watermark specified (added) per page. Transient results allow for the addition of multiple watermarks.

If the watermark content is provided in a PDF source element, the first page from the source document is used for the watermark.

Use the Background element to place content behind the existing page content.
<Watermark
	alternation="None" or "OddPages" or "EvenPages"
	fitToPage="true" or "false"
	horizontalAnchor="Left" or "Center" or "Right"
	horizontalOffset="0pt" or "length"
	opacity="100%" or "percentage"
	rotation="0" or "xs:integer"
	scale="100%" or "percentage"
	showOnScreen="true" or "false"
	showWhenPrinting="true" or "false"
	verticalAnchor="Top" or "Middle" or "Bottom"
	verticalOffset="0pt" or "length"
	replaceExisting="true" or "false"
>
	<StyledText> or < PDF source> [1]
	<TargetLocale> [0..1]
</Watermark>
Can be contained in the elements PDF result, PDF source, PDFGroup, TableOfContents, PackageFiles filter, select, or conversion, TableOfContentsPagePattern, BlankPage, and StyleProfile.

Category

Page content

Attributes

Name

Description

alternation

Optional. Specifies whether the element’s settings apply to all pages or to alternating pages. This attribute can have the following values:

None (default) - Settings apply to all pages.

OddPages - Settings apply to odd pages only.

EvenPages - Settings apply to even pages only.

Pages are considered odd or even depending on their ordinal page number in the result document.

fitToPage

Optional. Specifies whether to scale the watermark content to fit the page. This attribute can have the following values:

false (default) - Watermark content is scaled according to the scale attribute.

true - Watermark content is forced to fit the boundaries of the page size, by either expanding or shrinking the text. The scale attribute is ignored.

horizontalAnchor

Optional. Specifies a horizontal anchor point, relative to the PageMargins element of the page on which the watermark is placed. The placement relative to this anchor can be modified by the horizontalOffset attribute.

Left - Left page margin

Center (default) - Midpoint between the left and right margins

Right - Right margin

horizontalOffset

Optional. Offset from the horizontal anchor point specified in the horizontalAnchor attribute. A positive value moves the watermark right, while a negative value moves it left. (See Length values.)

opacity

Optional. Transparency of the watermark or background text. The value can be a decimal in the range of .0 to 1.0 or a percentage in the range of 0% to 100%. In the latter case, the percentage sign (%) is required.

replaceExisting

Optional. If set to false, then any pre-existing watermarks in the source PDF document will remain, and not be replaced by a specified watermark.

rotation

Optional. Rotation of the watermark upon the page. The valid range is -360 to 360 degrees.

scale

Optional. Scaling of the watermark. The valid range is 8% to 3200%. The value can be a decimal in the range of .0 to 1.0 or a percentage in the range of 0% to 100%. In the latter case, the percentage sign (%) is required.

showOnScreen

Optional. Controls whether the watermark or background is displayed when pages are viewed with an application such as Acrobat. This attribute can have the following values:

true (default) - The watermark is displayed.

false - The watermark is not displayed.

showWhenPrinting

Optional. Controls whether the watermark or background is included when pages are printed with an application such as Acrobat. This attribute can have the following values:

true (default) - The watermark is included.

false - The watermark is not included.

verticalAnchor

Optional. Specifies a vertical anchor point, relative to the PageMargins element of the page on which the watermark is placed. The placement relative to this anchor can be modified by the verticalOffset attribute.

Top - Top page margin

Middle (default) - Midpoint between the top and bottom margins.

Bottom - Bottom margin

verticalOffset

Optional. Offset from the vertical anchor point specified in the verticalAnchor attribute. A positive value moves the watermark up, while a negative value moves it down. (See Length values.)

Name	Description
alternation	Optional. Specifies whether the element’s settings apply to all pages or to alternating pages. This attribute can have the following values: None (default) - Settings apply to all pages. OddPages - Settings apply to odd pages only. EvenPages - Settings apply to even pages only. Pages are considered odd or even depending on their ordinal page number in the result document.
fitToPage	Optional. Specifies whether to scale the watermark content to fit the page. This attribute can have the following values: false (default) - Watermark content is scaled according to the scale attribute. true - Watermark content is forced to fit the boundaries of the page size, by either expanding or shrinking the text. The scale attribute is ignored.
horizontalAnchor	Optional. Specifies a horizontal anchor point, relative to the PageMargins element of the page on which the watermark is placed. The placement relative to this anchor can be modified by the horizontalOffset attribute. Left - Left page margin Center (default) - Midpoint between the left and right margins Right - Right margin
horizontalOffset	Optional. Offset from the horizontal anchor point specified in the horizontalAnchor attribute. A positive value moves the watermark right, while a negative value moves it left. (See Length values.)
opacity	Optional. Transparency of the watermark or background text. The value can be a decimal in the range of .0 to 1.0 or a percentage in the range of 0% to 100%. In the latter case, the percentage sign (%) is required.
replaceExisting	Optional. If set to false, then any pre-existing watermarks in the source PDF document will remain, and not be replaced by a specified watermark.
rotation	Optional. Rotation of the watermark upon the page. The valid range is -360 to 360 degrees.
scale	Optional. Scaling of the watermark. The valid range is 8% to 3200%. The value can be a decimal in the range of .0 to 1.0 or a percentage in the range of 0% to 100%. In the latter case, the percentage sign (%) is required.
showOnScreen	Optional. Controls whether the watermark or background is displayed when pages are viewed with an application such as Acrobat. This attribute can have the following values: true (default) - The watermark is displayed. false - The watermark is not displayed.
showWhenPrinting	Optional. Controls whether the watermark or background is included when pages are printed with an application such as Acrobat. This attribute can have the following values: true (default) - The watermark is included. false - The watermark is not included.
verticalAnchor	Optional. Specifies a vertical anchor point, relative to the PageMargins element of the page on which the watermark is placed. The placement relative to this anchor can be modified by the verticalOffset attribute. Top - Top page margin Middle (default) - Midpoint between the top and bottom margins. Bottom - Bottom margin
verticalOffset	Optional. Offset from the vertical anchor point specified in the verticalAnchor attribute. A positive value moves the watermark up, while a negative value moves it down. (See Length values.)

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/sdkHelp/ddxRefMain.163.123.html