SOAP API method PdfDocumentTextBlock_update
Parameters
Name | Type | Description |
---|---|---|
id * | string | The identifier (id) of the object that is updated |
text * | string | The text of the textblock. |
textflow * | Structure of type 'textflow' | The textflow of this textblock. |
fontname * | Structure of type 'fontname' | The font name for the textblock. |
fontsize * | Structure of type 'fontsize' | The font size of the textblock. |
fontstyle * | Structure of type 'fontstyle' | The font style for the textblock. |
fillcolor * | Structure of type 'fillcolor' | The fillcolor for this textblock. |
strokecolor * | Structure of type 'strokecolor' | The strokecolor for this textblock. |
charspacing * | Structure of type 'charspacing' | The charspacing for this textblock. |
horizscaling * | Structure of type 'horizscaling' | The horizontal scaling for this textblock. |
wordspacing * | Structure of type 'wordspacing' | The wordspacing for this textblock. |
textrendering * | Structure of type 'textrendering' | The textrendering for this textblock. |
textrise * | Structure of type 'textrise' | The textrise for this textblock. |
kerning * | Structure of type 'kerning' | The kerning for this textblock. |
margin * | Structure of type 'margin' | The margin for this textblock. |
overline * | Structure of type 'overline' | The overline for this textblock. |
strikeout * | Structure of type 'strikeout' | The strikeout for this textblock. |
underline * | Structure of type 'underline' | The underline for this textblock. |
monospace * | Structure of type 'monospace' | The monospace for this textblock. |
italicangle * | Structure of type 'italicangle' | The italicangle for this textblock. |
underlinewidth * | Structure of type 'underlinewidth' | The underline width for this textblock. |
underlineposition * | Structure of type 'underlineposition' | The underlineposition of this textblock. |
escapesequence * | Structure of type 'escapesequence' | The escapesequence of this textblock. |
alignchar * | Structure of type 'alignchar' | The aligncharacter of this textblock. |
encoding * | Structure of type 'encoding' | The encoding of this textblock. |
alignment * | Structure of type 'alignment' | The alignment of the textblock. |
verticalalign * | Structure of type 'verticalalign' | The vertical aligment of the textblock. |
fixedleading * | Structure of type 'fixedleading' | The fixedleading of the textblock. |
hortabsize * | Structure of type 'hortabsize' | The horizontal tabsize of the textblock. |
hortabmethod * | Structure of type 'hortabmethod' | The horizontal tab method of the textblock. |
lastalignment * | Structure of type 'lastalignment' | The last alignment of the textblock. |
leading * | Structure of type 'leading' | The leading of the textblock. |
parindent * | Structure of type 'parindent' | The parindent of the textblock. |
rightindent * | Structure of type 'rightindent' | The rightindent of the textblock. |
leftindent * | Structure of type 'leftindent' | The leftindent of the textblock. |
adjustmethod * | Structure of type 'adjustmethod' | The adjust method of the textblock. |
maxspacing * | Structure of type 'maxspacing' | The maxspacing of the textblock. |
minsspacing * | Structure of type 'minsspacing' | The minspacing of the textblock. |
spreadlimit * | Structure of type 'spreadlimit' | The spreadlimit of the textblock. |
nofitlimit * | Structure of type 'nofitlimit' | The nofitlimit of the textblock. |
shrinklimit * | Structure of type 'shrinklimit' | The shrinklimit of the textblock. |
linespreadlimit * | Structure of type 'linespreadlimit' | The linespreadlimit of the textblock. |
maxlines * | Structure of type 'maxlines' | The maxlines of the textblock. |
firstlinedist * | Structure of type 'firstlinedist' | The firstlinedist of the textblock. |
laslinedist * | Structure of type 'laslinedist' | The lastlinedist of the textblock. |
tabalingmentchar * | Structure of type 'tabalingmentchar' | The tab alignment character of the textblock. |
charref * | boolean | The charref setting of the textblock |
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 |
---|---|---|
pdfdocumenttextblock | Structure of type 'pdfdocumenttextblock' | All properties of the now updated pdfdocumenttextblock |
Structure 'textflow'
Name | Type | Description |
---|---|---|
value | boolean | The value of the boolean. |
source | string | The source of the datasource. |
Structure 'fontname'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'fontsize'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'fontstyle'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'fillcolor'
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 'strokecolor'
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 'charspacing'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'horizscaling'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'wordspacing'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'textrendering'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'textrise'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'kerning'
Name | Type | Description |
---|---|---|
value | boolean | The value of the boolean. |
source | string | The source of the datasource. |
Structure 'margin'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'overline'
Name | Type | Description |
---|---|---|
value | boolean | The value of the boolean. |
source | string | The source of the datasource. |
Structure 'strikeout'
Name | Type | Description |
---|---|---|
value | boolean | The value of the boolean. |
source | string | The source of the datasource. |
Structure 'underline'
Name | Type | Description |
---|---|---|
value | boolean | The value of the boolean. |
source | string | The source of the datasource. |
Structure 'monospace'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'italicangle'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'underlinewidth'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'underlineposition'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'escapesequence'
Name | Type | Description |
---|---|---|
value | boolean | The value of the boolean. |
source | string | The source of the datasource. |
Structure 'alignchar'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'encoding'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'alignment'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'verticalalign'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'fixedleading'
Name | Type | Description |
---|---|---|
value | boolean | The value of the boolean. |
source | string | The source of the datasource. |
Structure 'hortabsize'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
Structure 'hortabmethod'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'lastalignment'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'leading'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'parindent'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'rightindent'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'leftindent'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'adjustmethod'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'maxspacing'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'minsspacing'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'spreadlimit'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'nofitlimit'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'shrinklimit'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'linespreadlimit'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'maxlines'
Name | Type | Description |
---|---|---|
value | int | The value of the int. |
source | string | The source of the datasource. |
Structure 'firstlinedist'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'laslinedist'
Name | Type | Description |
---|---|---|
value | string | The value of the string. |
source | string | The source of the datasource. |
Structure 'tabalingmentchar'
Name | Type | Description |
---|---|---|
value | float | The value of the float. |
source | string | The source of the datasource. |
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 '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 |