SOAP API method PdfDocumentPage_block

Back to API references

Description
A single block of the documentpage.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object PdfDocumentPage. The method only applies to the pdfdocumentpage with this id.
Parameter 'personalize_profile' : int
Profile ID for which the object should be personalized
Parameter 'personalize_subprofile' : int
Subprofile ID for which the object should be personalized
Parameter 'personalize_timestamp' : string
The timestamp for the personalization
Parameter 'identifier' : string
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'pdfdocumentimageblock' : Structure of type 'pdfdocumentimageblock'
Return value 'pdfdocumenttextblock' : Structure of type 'pdfdocumenttextblock'
Return value 'pdfdocumentpdfblock' : Structure of type 'pdfdocumentpdfblock'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'pdfdocumentimageblock'
This structure pdfdocumentimageblock was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the documentblock.
Property 'name' : string
The name of the block.
Property 'description' : string
The description of the block.
Property 'showborder' : boolean
Should the border of the block be showed?.
Property 'rotate' : DataSourceInt
The rotation of the block.
Property 'orientate' : DataSourceString
The orientation of the content.
Property 'position' : DataSourcePdfPosition
The position of the block.
Property 'boxsize' : DataSourcePdfBoxSize
The box size of the block.
Property 'refpoint' : DataSourcePdfRefPoint
The ref point of the block.
Property 'backgroundcolor' : DataSourcePdfColor
The backgound color of the block.
Property 'bordercolor' : DataSourcePdfColor
The border color of the block.
Property 'linewidth' : DataSourceString
The linewidth of the block.
Property 'status' : DataSourceString
The status of the block.
Property 'fitmethod' : DataSourceString
The fitmethod of the block.
Property 'condition' : string
Get the javascript condition used to determine if the block is shown in the document

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

Structure 'pdfdocumentpdfblock'
This structure pdfdocumentpdfblock was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the documentblock.
Property 'name' : string
The name of the block.
Property 'description' : string
The description of the block.
Property 'showborder' : boolean
Should the border of the block be showed?.
Property 'rotate' : DataSourceInt
The rotation of the block.
Property 'orientate' : DataSourceString
The orientation of the content.
Property 'position' : DataSourcePdfPosition
The position of the block.
Property 'boxsize' : DataSourcePdfBoxSize
The box size of the block.
Property 'refpoint' : DataSourcePdfRefPoint
The ref point of the block.
Property 'backgroundcolor' : DataSourcePdfColor
The backgound color of the block.
Property 'bordercolor' : DataSourcePdfColor
The border color of the block.
Property 'linewidth' : DataSourceString
The linewidth of the block.
Property 'status' : DataSourceString
The status of the block.
Property 'fitmethod' : DataSourceString
The fitmethod of the block.
Property 'condition' : string
Get the javascript condition used to determine if the block is shown in the document