IPXC_BackgroundParams Interface

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_BackgroundParams Interface}}
 
{{#customTitle:IPXC_BackgroundParams Interface}}
 +
{{#parentPage:PXV:PXC_Interfaces|IPXC_BackgroundParams|interface}}
  
 
The interface of object of PDF-XChange Editor SDK.
 
The interface of object of PDF-XChange Editor SDK.
  
 
== Properties ==
 
== Properties ==
{| style="width: 100%" class="wikitable sortable collapsible"
+
{| class="wikitable properties"
|-
+
! style="text-align: left" scope="col" width="15%" | Property
+
! style="text-align: center" scope="col" width="5%" | Access Type
+
! style="text-align: left" scope="col"  class="unsortable" | Description
+
 
|-
 
|-
 
| [[PXV:IPXC_BackgroundParams_BackgroundFile|BackgroundFile]]
 
| [[PXV:IPXC_BackgroundParams_BackgroundFile|BackgroundFile]]
| style="text-align: center" | R/W
+
| [[PXV:IPXC_BackgroundParams_End|End]]
| Gets/sets the background file path.
+
| [[PXV:IPXC_BackgroundParams_HOffset|HOffset]]
 +
| [[PXV:IPXC_BackgroundParams_Scale|Scale]]
 
|-
 
|-
 
| [[PXV:IPXC_BackgroundParams_BackgroundPage|BackgroundPage]]
 
| [[PXV:IPXC_BackgroundParams_BackgroundPage|BackgroundPage]]
| style="text-align: center" | R/W
+
| [[PXV:IPXC_BackgroundParams_FillColor|FillColor]]
| Gets/sets the page from the file which will be used as background.
+
| [[PXV:IPXC_BackgroundParams_Opacity|Opacity]]
 +
| [[PXV:IPXC_BackgroundParams_Start|Start]]
 
|-
 
|-
 
| [[PXV:IPXC_BackgroundParams_BackgroundScale|BackgroundScale]]
 
| [[PXV:IPXC_BackgroundParams_BackgroundScale|BackgroundScale]]
| style="text-align: center" | R/W
+
| [[PXV:IPXC_BackgroundParams_Flags|Flags]]
| Gets/sets the scale of the source file page.
+
| [[PXV:IPXC_BackgroundParams_RangeFlags|RangeFlags]]
 +
| [[PXV:IPXC_BackgroundParams_VAlign|VAlign]]
 
|-
 
|-
 
| [[PXV:IPXC_BackgroundParams_BackgroundType|BackgroundType]]
 
| [[PXV:IPXC_BackgroundParams_BackgroundType|BackgroundType]]
| style="text-align: center" | R/W
 
| Gets/sets the [[PXV:PXC_BackgroundType|background type]].
 
|-
 
| [[PXV:IPXC_BackgroundParams_End|End]]
 
| style="text-align: center" | R/W
 
| Gets/sets the end of the pages range where the background will be placed.
 
|-
 
| [[PXV:IPXC_BackgroundParams_FillColor|FillColor]]
 
| style="text-align: center" | R/W
 
| Gets/sets the fill color which will be used as the page background.
 
|-
 
| [[PXV:IPXC_BackgroundParams_Flags|Flags]]
 
| style="text-align: center" | R/W
 
| Gets/sets background operation [[PXV:PXC_BackgroundFlags|flags]].
 
|-
 
 
| [[PXV:IPXC_BackgroundParams_HAlign|HAlign]]
 
| [[PXV:IPXC_BackgroundParams_HAlign|HAlign]]
| style="text-align: center" | R/W
 
| Gets/sets the horizontal align of the background on page.
 
|-
 
| [[PXV:IPXC_BackgroundParams_HOffset|HOffset]]
 
| style="text-align: center" | R/W
 
| Gets/sets the horizontal offset of the background on page.
 
|-
 
| [[PXV:IPXC_BackgroundParams_Opacity|Opacity]]
 
| style="text-align: center" | R/W
 
| Gets/sets the opacity of the background placed on page.
 
|-
 
| [[PXV:IPXC_BackgroundParams_RangeFlags|RangeFlags]]
 
| style="text-align: center" | R/W
 
| Gets/sets the pages range flags.
 
|-
 
 
| [[PXV:IPXC_BackgroundParams_Rotation|Rotation]]
 
| [[PXV:IPXC_BackgroundParams_Rotation|Rotation]]
| style="text-align: center" | R/W
 
| Gets/sets background rotation.
 
|-
 
| [[PXV:IPXC_BackgroundParams_Scale|Scale]]
 
| style="text-align: center" | R/W
 
| Gets/sets
 
|-
 
| [[PXV:IPXC_BackgroundParams_Start|Start]]
 
| style="text-align: center" | R/W
 
| Gets/sets the start of the pages range where the background will be placed.
 
|-
 
| [[PXV:IPXC_BackgroundParams_VAlign|VAlign]]
 
| style="text-align: center" | R/W
 
| Gets/sets
 
|-
 
 
| [[PXV:IPXC_BackgroundParams_VOffset|VOffset]]
 
| [[PXV:IPXC_BackgroundParams_VOffset|VOffset]]
| style="text-align: center" | R/W
 
| Gets/sets
 
 
|}
 
|}
 +
 +
== See Also ==
 +
[[PXV:IPXC_Document_PlaceBackgrounds|IPXC_Document::PlaceBackgrounds]], [[PXV:IPXC_Inst_CreateBackgroundParams|IPXC_Inst::CreateBackgroundParams]]

Latest revision as of 23:58, 30 November 2017

The interface of object of PDF-XChange Editor SDK.

Properties

BackgroundFile End HOffset Scale
BackgroundPage FillColor Opacity Start
BackgroundScale Flags RangeFlags VAlign
BackgroundType HAlign Rotation VOffset

See Also

IPXC_Document::PlaceBackgrounds, IPXC_Inst::CreateBackgroundParams