Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 14: Line 14:
 
| class="op_param_name" | Type
 
| class="op_param_name" | Type
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies the type of data used for background generation.
 
Possible values are:
 
Possible values are:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
| class="op_enum_value" | '''0''' (Color) || ...
+
| class="op_enum_value" | '''0''' (Color) || The ''Color'' will be used.
 
|-
 
|-
| class="op_enum_value" | '''1''' (Image) || ...
+
| class="op_enum_value" | '''1''' (Image) || The image from the ''FileName'' path will be used.
 
|}
 
|}
 
Default value: <tt>'''0''' (Color)</tt>
 
Default value: <tt>'''0''' (Color)</tt>
Line 26: Line 26:
 
| class="op_param_name" | Color
 
| class="op_param_name" | Color
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies the color in string presentation that will be used if color ''Type'' is specified.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | PageNumber
 
| class="op_param_name" | PageNumber
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies the number of page in the file that is used as background.
 
Default value: <tt>'''1'''</tt>
 
Default value: <tt>'''1'''</tt>
 
|-
 
|-

Revision as of 02:59, 29 May 2015


Options Table

Name Type Value
Type Integer Specifies the type of data used for background generation.

Possible values are:

0 (Color) The Color will be used.
1 (Image) The image from the FileName path will be used.

Default value: 0 (Color)

Color String Specifies the color in string presentation that will be used if color Type is specified.

Default value: Empty String

PageNumber Integer Specifies the number of page in the file that is used as background.

Default value: 1

AbsoluteScale Double Specifies...

Default value: 1.0

FileName String Specifies...

Default value: Empty String

Rotation Double Specifies...

Default value: 0.0

Opacity Double Specifies...

Default value: 1.0

UseRelativeScale Boolean Specifies...

Default value: true

RelativeScale Double Specifies...

Default value: 1.0

HOffset Double Specifies...

Default value: 0.0

VOffset Double Specifies...

Default value: 0.0

VOffsetFrom Integer Specifies...

The list of possible values are shown in the table.

Default value: 1 (Center)

HOffsetFrom Integer Specifies...

The list of possible values are shown in the table.

Default value: 1 (Center)

VisibleOnView Boolean Specifies...

Default value: true

VisibleOnPrint Boolean Specifies...

Default value: true

PresetID String Specifies...

Default value: Empty String

PagesRange Dictionary Specifies...