Lucee Tag Reference
<cfdocumentsection>
Divides a PDF document into sections.
By using this tag in conjunction with a cfdocumentitem tag, each section can have unique headers, footers, and page numbers.
Body
This tag may have a body.
Example
<cfdocumentsection [authpassword=string] [authuser=string] [marginbottom=number] [marginleft=number] [marginright=number] [margintop=number] [mimetype=string] [name=string] [orientation=string] [src=string] [srcfile=string] [useragent=string]> [</cfdocumentsection>]
This tag is also supported within cfscript
<cfscript> documentsection [authpassword=string] [authuser=string] [marginbottom=number] [marginleft=number] [marginright=number] [margintop=number] [mimetype=string] [name=string] [orientation=string] [src=string] [srcfile=string] [useragent=string] { [...] } </cfscript>
Attributes
The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name | Type | Required | Description |
---|---|---|---|
authpassword | string | No | Password sent to the target URL for Basic Authentication. Combined with username to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication. |
authuser | string | No | User name sent to the target URL for Basic Authentication. Combined with password to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication. |
marginbottom | number | No | Specifies the bottom margin in inches (default) or centimeters. To specify the bottom margin in centimeters, include the unit="cm" attribute in the parent cfdocument tag. |
marginleft | number | No | Specifies the left margin in inches (default) or centimeters. To specify the left margin in centimeters, include the unit="cm" attribute in the parent cfdocument tag. |
marginright | number | No | Specifies the right margin in inches (default) or centimeters. To specify the right margin in centimeters, include the unit="cm" attribute in the parent cfdocument tag. |
margintop | number | No | Specifies the top margin in inches (default) or centimeters. To specify the top margin in centimeters, include the unit="cm" attribute in the parent cfdocument tag. |
mimetype | string | No | mimetype of the source (when attribute src or srcfile are defined) |
name | string | No | Bookmark name for the section |
orientation | string | No | is the orientation landscape or portrait |
src | string | No | define a url or or a relative path on the local system to a file that should be transferred to a pdf |
srcfile | string | No | define a absolute path to a file that should be transferred to a pdf |
useragent | string | No | Text to put in the HTTP User-Agent request header field. Used to identify the request client software. |