PXC_BackgroundType Enumeration

From Tracker Software PDF SDK
Jump to: navigation, search
Line 17: Line 17:
 
== Constants ==
 
== Constants ==
 
;Background_Color
 
;Background_Color
:The background will take it's data from the [[PXV:IPXC_BackgroundParams_FillColor|Fill Color]] specified in the [[PXV:IPXC_BookmarkParams|IPXC_BookmarkParams]].
+
: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 background will take it's data from the [[PXV:IPXC_BackgroundParams_BackgroundFile|Background File]] specified in the [[PXV:IPXC_BookmarkParams|IPXC_BookmarkParams]]. Note that the specified file path should point to the existing valid image file.
+
: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 background will take it's data from the [[PXV:IPXC_BackgroundParams_BackgroundFile|Background File]] specified in the [[PXV:IPXC_BookmarkParams|IPXC_BookmarkParams]]. Note that the specified file path should point to the existing valid PDF file.
+
: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_BookmarkParams|IPXC_BookmarkParams]]
+
[[PXV:IPXC_BackgroundParams|IPXC_BackgroundParams]]
  
 
[[PXV:IPXC_BackgroundParams_FillColor|IPXC_BackgroundParams_FillColor]]
 
[[PXV:IPXC_BackgroundParams_FillColor|IPXC_BackgroundParams_FillColor]]
  
 
[[PXV:IPXC_BackgroundParams_BackgroundFile|IPXC_BackgroundParams_BackgroundFile]]
 
[[PXV:IPXC_BackgroundParams_BackgroundFile|IPXC_BackgroundParams_BackgroundFile]]

Revision as of 06:02, 4 May 2015


Specifies the flags for the type of the background which 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.

See Also

IPXC_BackgroundParams

IPXC_BackgroundParams_FillColor

IPXC_BackgroundParams_BackgroundFile