Back to API references

SOAP API method PdfDocumentImageBlock_update

Parameters

Name Type Description
id * string The identifier (id) of the object that is updated
showborder * boolean Should the border of the block be showed?.
rotate * Structure of type 'rotate' The rotation of the block.
orientate * Structure of type 'orientate' The orientation of the content.
position * Structure of type 'position' The position of the block.
boxsize * Structure of type 'boxsize' The box size of the block.
refpoint * Structure of type 'refpoint' The ref point of the block.
backgroundcolor * Structure of type 'backgroundcolor' The backgound color of the block.
bordercolor * Structure of type 'bordercolor' The border color of the block.
linewidth * Structure of type 'linewidth' The linewidth of the block.
status * Structure of type 'status' The status of the block.
fitmethod * Structure of type 'fitmethod' The fitmethod of the block.
condition * string Get the javascript condition used to determine if the block is shown in the document
* required parameters

Return values

Name Type Description
pdfdocumentimageblock Structure of type 'pdfdocumentimageblock' All properties of the now updated pdfdocumentimageblock

Structure 'rotate'

Name Type Description
value int The value of the int.
source string The source of the datasource.

Structure 'orientate'

Name Type Description
value string The value of the string.
source string The source of the datasource.

Structure 'position'

Name Type Description
x int The x position of the pdf position.
y int The y position of the pdf position.
source string The source of the datasource.

Structure 'boxsize'

Name Type Description
width int The width of the boxsize.
height int The height of the boxsize.
source string The source of the datasource.

Structure 'refpoint'

Name Type Description
left int The left of the boxsize.
bottom int The bottom of the boxsize.
source string The source of the datasource.

Structure 'backgroundcolor'

Name Type Description
hex string The hex of the pdfcolor.
cyan float The cyan of the pdfcolor.
magenta float The magenta of the pdfcolor.
yellow float The yellow of the pdfcolor.
key float The key of the pdfcolor.
red float The red of the pdfcolor.
blue float The blue of the pdfcolor.
green float The green of the pdfcolor.
gray float The gray of the pdfcolor.
source string The source of the datasource.

Structure 'bordercolor'

Name Type Description
hex string The hex of the pdfcolor.
cyan float The cyan of the pdfcolor.
magenta float The magenta of the pdfcolor.
yellow float The yellow of the pdfcolor.
key float The key of the pdfcolor.
red float The red of the pdfcolor.
blue float The blue of the pdfcolor.
green float The green of the pdfcolor.
gray float The gray of the pdfcolor.
source string The source of the datasource.

Structure 'linewidth'

Name Type Description
value string The value of the string.
source string The source of the datasource.

Structure 'status'

Name Type Description
value string The value of the string.
source string The source of the datasource.

Structure 'fitmethod'

Name Type Description
value string The value of the string.
source string The source of the datasource.

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