PDF source

Identifies a source of PDF content from one or more input data streams. A PDF source element can be a single PDF document or a PDF package. It can contain other elements that describe content and/or properties to replace those in the source content. A PDF source element must be contained within a PDF result element and cannot contain another PDF source element.

When the source is a PDF package, the package files are included even if only some pages of the document (referred to as the cover sheet) are included in the assembly. Any child elements of the PDF source affecting the content only apply to the cover sheet and not to the package files. The PackageFiles element may be used to affect the content of a package file if it is a modifiable PDF document.

A PDF source element can be an XDP document that contains PDF content. The XDP format is described in the XFA Specification, version 2.2 at http://www.adobe.com/go/learn_lc_XFA.

<PDF

	source="pdf input name"

	sourceMatch=unspecified or "regular expression"

	pages="1-last" or "page range"

	bookmarkTitle=unspecified or ""

	access=unspecified or "PasswordAccessProfile name"

	baseDocument="true" or "false"

	includeInTOC="true" [if document is after TOC in result document]or "false"

	layerLabel=unspecified or ""

	matchMode="Include" or "Exclude"

	required="true" or "false"

	select="1-last" or "range specifier"

	sortLocale="en" or ""

	sortOrder="Ascending" or "Descending"

	<Package> or <NoPackage>[0..n]

	<PackageFiles> [0..n] or <NoPackageFiles> [0..1]

	(<Bookmarks source> and/or <Bookmarks filter> [0..n]) or

			<NoBookmarks> [0..1]

	(<Links source> and/or <Links filter>) [0..n] or <NoLinks> [0..1]

	<LinkAlias> [0..n]

	<NoThumbnails> [0..1]

	(<Comments source> and/or <Comments filter>) [0..n] or

			<NoComments> [0..1]

	<FileAttachments source> [0..n] or <NoFileAttachments> [0..1]

	<NoJavaScripts>[0..1]

	<PageSize> [0..1]

	<PageRotation> [0..1]

	<PageMargins> [0..2, where 2 is allowed for alternating pages]

	<PageLabel> [0..1] or <NoPageLabels> [0..1]

	<ArtBox> [0..2, where 2 is allowed for alternating pages]

	<BleedBox> [0..2, where 2 is allowed for alternating pages]

	<TrimBox> [0..2, where 2 is allowed for alternating pages]

	<Transform> [0..1]

	<Header>

		or <NoHeaders> [0..2, where 2 is allowed for alternating pages]

	<Footer> or <NoFooters> [0..2, where 2 is allowed for alternating pages]

	<Watermark>

		or <NoWatermarks> [0..2, where 2 is allowed for alternating pages]

	<Background>

		or <NoBackgrounds> [0..2, where 2 is allowed for alternating pages]

	<PageOverlay> [0..n]

	<PageUnderlay> [0..n]

	<NoForms> [0..1]

	<NoXFA> [0..1]

	<TargetLocale> [0..1]

</PDF>

Can be contained in any of the following elements: PDF result, PackageFiles filter, conversion, or result, PDFGroup, Bookmarks result, Bookmarks filter, Links result, Links filter, Comments result, Comments filter, FileAttachments result, Left, Right, Center, Watermark, Background, PageOverlay, PageUnderlay, Metadata result, PDFsFromBookmarks, and DocumentText.

Category

Document assembly

Attributes


Name	Description
source	Optional, but required if the sourceMatch attribute is not specified. A logical name associated with a single input data stream, or an ordered list of data streams. Each stream must contain a PDF document. If both source and sourceMatch attributes are specified, this attribute is only used if it matches a name entry in the inputs map.
sourceMatch	Optional, but required if the source attribute is not specified. The value of this attribute is a regular expression that selects source names, and their associated data streams, from the inputs map. The regular expression syntax is implemented in the java.util.regex class for Java. Depending on the matchMode attribute, the matched documents are either included or excluded in the assembled document. If more than one name matches, the names are sorted, as specified in the sortOrder and sortLocale attributes. This attribute is ignored if the source attribute is specified.
pages	Optional. Specifies which pages from the source document to include in the result document. The default value is 1-last, which signifies the entire document is included. (See Page and document ranges.)
access	Optional. Specifies the name of the PasswordAccessProfile element to apply when opening the document. This attribute is relevant if the source document is encrypted.
baseDocument	Optional. Identifies the base document and provides the initial structure that the Assembler service uses to set certain document-level properties of the result PDF document. These include document properties, form data, document-level JavaScript code, and viewer preferences. The result document can contain only one source identified as a base document. Documents other than the base document only contribute pages, document components (such as bookmarks, links, file attachments), page labels, page content, and page properties to the resulting document. Document-level components, such as file attachments, are only included from a document once, even if the document is specified multiple times. A file mapped to a baseDocument is always required in the inputs map for the Assembler service, even if the required attribute is set to "false". This attribute can have the following values: true - Identifies the parent PDF source element as the base document. false (default) - Does not identify the parent PDF source element as the base document, though a base document is always required. If none of the source documents in a PDF result are specified as the base document, the Assembler service determines the base document.
bookmarkTitle	Optional. Structures the appearance of bookmarks in the result document by specifying a bookmark title that identifies the source document bookmarks. The string can contain built-in keys. If this attribute is omitted, no bookmark title precedes the source document bookmarks.
includeInTOC	Optional. Controls whether the source document is included in a table of contents created in the result document. This attribute is ignored if the PDF result element lacks a TableOfContents element. This attribute can have the following values: true (default) - Source document bookmarks are included in the table of contents. false (default) - Source document bookmarks are not included. default value - The default value of this attribute depends upon the location of the TableOfContents element within the PDF result element. All PDF source elements that appear before the TableOfContents element are assigned a default value of false as for this attribute, and all PDF source elements that appear after use true as the default value.
layerLabel	Optional. Specifies the name for a top-level label under which all the layers of the source document are grouped. This label enables users of the document to distinguish between layers from different source documents and to avoid name conflicts.
matchMode	Optional. Specifies whether the match results in the source document being included or excluded from the document assembly. This attribute can have the following values: Include (default) - Includes the matched data streams. Exclude - Excludes the matched data streams.
required	Optional. The default (true) is to require that this PDF source element actually adds PDF content to the assembly. If set to false, then if no data streams are identified in the inputs map for this PDF source element, it adds no PDF content to the assembly and it is not an error.
select	Optional. Determines which documents are selected when an ordered list of input streams is provided. The default value is 1-last, indicating that all streams be selected. For the syntax of specifying ranges, see Page and document ranges.
sortLocale	Optional. Specifies the locale to use for sorting, according to sortOrder, names matched by the sourceMatch attribute. The value of this attribute should be a valid 2-character ISO language code (see ISO 639). Any two characters will pass schema validation; however, if the requested locale is not available, a ValidationException is thrown. The default value for this attribute is en (English).
sortOrder	Optional. If the regular expression specified in the sourceMatch attribute matches multiple documents, this attribute specifies the order in which those documents are sorted, to create an ordered list of documents. This attribute is not used if the source attribute is specified and it matches an entry in the inputs map. This attribute can have the following values: Ascending (default) - Matched documents are sorted in ascending order: A-Z. Descending - Matched documents are sorted in descending order: Z-A.

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