Back to API references

SOAP API method PdfDocumentPage_block

Description

A single block of the documentpage.

Parameters

Name Type Description
id * int Unique identifier (id) of the object PdfDocumentPage. The method only applies to the pdfdocumentpage with this id.
personalize_profile int Profile ID for which the object should be personalized
personalize_subprofile int Subprofile ID for which the object should be personalized
personalize_timestamp string The timestamp for the personalization
identifier * string
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
pdfdocumentimageblock Structure of type 'pdfdocumentimageblock'
pdfdocumenttextblock Structure of type 'pdfdocumenttextblock'
pdfdocumentpdfblock Structure of type 'pdfdocumentpdfblock'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'pdfdocumentimageblock'

Name Type Description
id string The ID of the documentblock.
name string The name of the block.
description string The description of the block.
showborder boolean Should the border of the block be showed?.
rotate DataSourceInt The rotation of the block.
orientate DataSourceString The orientation of the content.
position DataSourcePdfPosition The position of the block.
boxsize DataSourcePdfBoxSize The box size of the block.
refpoint DataSourcePdfRefPoint The ref point of the block.
backgroundcolor DataSourcePdfColor The backgound color of the block.
bordercolor DataSourcePdfColor The border color of the block.
linewidth DataSourceString The linewidth of the block.
status DataSourceString The status of the block.
fitmethod DataSourceString The fitmethod of the block.
condition string Get the javascript condition used to determine if the block is shown in the document

Structure 'pdfdocumenttextblock'

Name Type Description
text string The text of the textblock.
textflow DataSourceBoolean The textflow of this textblock.
fontname DataSourceString The font name for the textblock.
fontsize DataSourceFloat The font size of the textblock.
fontstyle DataSourceString The font style for the textblock.
fillcolor DataSourcePdfColor The fillcolor for this textblock.
strokecolor DataSourcePdfColor The strokecolor for this textblock.
charspacing DataSourceInt The charspacing for this textblock.
horizscaling DataSourceInt The horizontal scaling for this textblock.
wordspacing DataSourceInt The wordspacing for this textblock.
textrendering DataSourceFloat The textrendering for this textblock.
textrise DataSourceFloat The textrise for this textblock.
kerning DataSourceBoolean The kerning for this textblock.
margin DataSourceFloat The margin for this textblock.
overline DataSourceBoolean The overline for this textblock.
strikeout DataSourceBoolean The strikeout for this textblock.
underline DataSourceBoolean The underline for this textblock.
monospace DataSourceFloat The monospace for this textblock.
italicangle DataSourceFloat The italicangle for this textblock.
underlinewidth DataSourceFloat The underline width for this textblock.
underlineposition DataSourceFloat The underlineposition of this textblock.
escapesequence DataSourceBoolean The escapesequence of this textblock.
alignchar DataSourceString The aligncharacter of this textblock.
defaulttext DataSourceString The default text of this textblock.
encoding DataSourceString The encoding of this textblock.
alignment DataSourceString The alignment of the textblock.
verticalalign DataSourceString The vertical aligment of the textblock.
fixedleading DataSourceBoolean The fixedleading of the textblock.
hortabsize DataSourceFloat The horizontal tabsize of the textblock.
hortabmethod DataSourceString The horizontal tab method of the textblock.
lastalignment DataSourceString The last alignment of the textblock.
leading DataSourceInt The leading of the textblock.
parindent DataSourceInt The parindent of the textblock.
rightindent DataSourceInt The rightindent of the textblock.
leftindent DataSourceInt The leftindent of the textblock.
adjustmethod DataSourceString The adjust method of the textblock.
maxspacing DataSourceInt The maxspacing of the textblock.
minsspacing DataSourceInt The minspacing of the textblock.
spreadlimit DataSourceInt The spreadlimit of the textblock.
nofitlimit DataSourceInt The nofitlimit of the textblock.
shrinklimit DataSourceInt The shrinklimit of the textblock.
linespreadlimit DataSourceInt The linespreadlimit of the textblock.
maxlines DataSourceInt The maxlines of the textblock.
firstlinedist DataSourceString The firstlinedist of the textblock.
laslinedist DataSourceString The lastlinedist of the textblock.
tabalingmentchar DataSourceFloat The tab alignment character of the textblock.
charref boolean The charref setting of the textblock
id string The ID of the documentblock.
name string The name of the block.
description string The description of the block.
showborder boolean Should the border of the block be showed?.
rotate DataSourceInt The rotation of the block.
orientate DataSourceString The orientation of the content.
position DataSourcePdfPosition The position of the block.
boxsize DataSourcePdfBoxSize The box size of the block.
refpoint DataSourcePdfRefPoint The ref point of the block.
backgroundcolor DataSourcePdfColor The backgound color of the block.
bordercolor DataSourcePdfColor The border color of the block.
linewidth DataSourceString The linewidth of the block.
status DataSourceString The status of the block.
fitmethod DataSourceString The fitmethod of the block.
condition string Get the javascript condition used to determine if the block is shown in the document

Structure 'pdfdocumentpdfblock'

Name Type Description
id string The ID of the documentblock.
name string The name of the block.
description string The description of the block.
showborder boolean Should the border of the block be showed?.
rotate DataSourceInt The rotation of the block.
orientate DataSourceString The orientation of the content.
position DataSourcePdfPosition The position of the block.
boxsize DataSourcePdfBoxSize The box size of the block.
refpoint DataSourcePdfRefPoint The ref point of the block.
backgroundcolor DataSourcePdfColor The backgound color of the block.
bordercolor DataSourcePdfColor The border color of the block.
linewidth DataSourceString The linewidth of the block.
status DataSourceString The status of the block.
fitmethod DataSourceString The fitmethod of the block.
condition string Get the javascript condition used to determine if the block is shown in the document