PXC_BackgroundType Enumeration
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:PXC_BackgroundType Enumeration}} | {{#customTitle:PXC_BackgroundType Enumeration}} | ||
| − | {{ | + | {{#parentPage:PXV:PXC_Enumerations|PXC_BackgroundType|enum}} |
{{ToReview}} | {{ToReview}} | ||
| − | Specifies the | + | Specifies the flags for the background type that should be used. |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">enum PXC_BackgroundType | <pre class="brush:cpp;gutter:false">enum PXC_BackgroundType | ||
{ | { | ||
| − | Background_Color = 0 | + | Background_Color = 0, |
| − | Background_Image = 1 | + | Background_Image = 1, |
| − | Background_PDF = 2 | + | Background_PDF = 2, |
}; | }; | ||
</pre> | </pre> | ||
| Line 17: | Line 18: | ||
== Constants == | == Constants == | ||
;Background_Color | ;Background_Color | ||
| − | :The | + | :The background will take it's data from the [[PXV:IPXC_BackgroundParams_FillColor|Fill Color]] specified in the [[PXV:IPXC_BackgroundParams|IPXC_BackgroundParams]]. |
;Background_Image | ;Background_Image | ||
| − | :The . | + | :The background will take it's data from the [[PXV:IPXC_BackgroundParams_BackgroundFile|Background File]] specified in the [[PXV:IPXC_BackgroundParams|IPXC_BackgroundParams]]. Note that the specified file path should point to the existing valid image file. |
;Background_PDF | ;Background_PDF | ||
| − | :The . | + | :The background will take it's data from the [[PXV:IPXC_BackgroundParams_BackgroundFile|Background File]] specified in the [[PXV:IPXC_BackgroundParams|IPXC_BackgroundParams]]. Note that the specified file path should point to the existing valid PDF file. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_BackgroundParams_BackgroundType|IPXC_BackgroundParams::BackgroundType]] | |
Latest revision as of 01:50, 25 May 2015
Specifies the flags for the background type that should be used.
Syntax
enum PXC_BackgroundType
{
Background_Color = 0,
Background_Image = 1,
Background_PDF = 2,
};
Constants
- Background_Color
- The background will take it's data from the Fill Color specified in the IPXC_BackgroundParams.
- Background_Image
- The background will take it's data from the Background File specified in the IPXC_BackgroundParams. Note that the specified file path should point to the existing valid image file.
- Background_PDF
- The background will take it's data from the Background File specified in the IPXC_BackgroundParams. Note that the specified file path should point to the existing valid PDF file.
