IPXC_WatermarkParams Interface

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_WatermarkParams Interface}}
 
{{#customTitle:IPXC_WatermarkParams Interface}}
 +
{{#parentPage:PXV:PXC_Interfaces|IPXC_WatermarkParams|interface}}
  
−
The interface of object of PDF-XChange Editor SDK.
+
Used for filling the parameters of the Watermarks that will be placed using the [[PXV:IPXC_Document_PlaceWatermark|PlaceWatermark]] method.
  
 
== 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_WatermarkParams_End|End]]
 
| [[PXV:IPXC_WatermarkParams_End|End]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_WatermarkParams_HOffset|HOffset]]
−
| Gets/sets the end of the pages range where the watermark will be placed.
+
| [[PXV:IPXC_WatermarkParams_RenderMode|RenderMode]]
 +
| [[PXV:IPXC_WatermarkParams_Text|Text]]
 
|-
 
|-
 
| [[PXV:IPXC_WatermarkParams_FillColor|FillColor]]
 
| [[PXV:IPXC_WatermarkParams_FillColor|FillColor]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_WatermarkParams_ImageFile|ImageFile]]
−
| Gets/sets the fill color of the font which will be used for watermark text.
+
| [[PXV:IPXC_WatermarkParams_Rotation|Rotation]]
 +
| [[PXV:IPXC_WatermarkParams_TextAlign|TextAlign]]
 
|-
 
|-
 
| [[PXV:IPXC_WatermarkParams_Flags|Flags]]
 
| [[PXV:IPXC_WatermarkParams_Flags|Flags]]
−
| style="text-align: center" | R/W
 
−
| Gets/sets the watermark operation [[PXV:PXC_WatermarkFlags|flags]].
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_FontName|FontName]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets watermark text font name.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_FontSize|FontSize]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets watermark text font size.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_HAlign|HAlign]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets the horizontal align of the watermark on page.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_HOffset|HOffset]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets the horizontal offset of the watermark on page.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_ImageFile|ImageFile]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets the image file which will be used as watermark source.
 
−
|-
 
 
| [[PXV:IPXC_WatermarkParams_ImagePage|ImagePage]]
 
| [[PXV:IPXC_WatermarkParams_ImagePage|ImagePage]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_WatermarkParams_Scale|Scale]]
−
| Gets/sets the page number from the image file which will be used as watermark source.
+
| [[PXV:IPXC_WatermarkParams_UnderlineMode|UnderlineMode]]
 
|-
 
|-
 +
| [[PXV:IPXC_WatermarkParams_Font|Font]]
 
| [[PXV:IPXC_WatermarkParams_ImageSize|ImageSize]]
 
| [[PXV:IPXC_WatermarkParams_ImageSize|ImageSize]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_WatermarkParams_Start|Start]]
−
| Gets/sets the [[PXV:PXC_Size|size]] of the image file which will be used as watermark source.
+
| [[PXV:IPXC_WatermarkParams_VAlign|VAlign]]
 
|-
 
|-
 +
| [[PXV:IPXC_WatermarkParams_FontName|FontName]]
 
| [[PXV:IPXC_WatermarkParams_Opacity|Opacity]]
 
| [[PXV:IPXC_WatermarkParams_Opacity|Opacity]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_WatermarkParams_StrokeColor|StrokeColor]]
−
| Gets/sets the opacity of the watermark placed on page.
+
| [[PXV:IPXC_WatermarkParams_VOffset|VOffset]]
 
|-
 
|-
 +
| [[PXV:IPXC_WatermarkParams_FontSize|FontSize]]
 
| [[PXV:IPXC_WatermarkParams_RangeFlags|RangeFlags]]
 
| [[PXV:IPXC_WatermarkParams_RangeFlags|RangeFlags]]
−
| style="text-align: center" | R/W
 
−
| Gets/sets the pages range flags.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_RenderMode|RenderMode]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets the [[PXV:PXC_TextRenderingMode|text rendering mode]] of the watermark.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_Rotation|Rotation]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets watermark rotation.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_Scale|Scale]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets watermark scale.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_Start|Start]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets the start of the pages range where the watermark will be placed.
 
−
|-
 
−
| [[PXV:IPXC_WatermarkParams_StrokeColor|StrokeColor]]
 
−
| style="text-align: center" | R/W
 
−
| Gets/sets the stroke color of the watermark's text.
 
−
|-
 
 
| [[PXV:IPXC_WatermarkParams_StrokeWidth|StrokeWidth]]
 
| [[PXV:IPXC_WatermarkParams_StrokeWidth|StrokeWidth]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_WatermarkParams_WatermarkType|WatermarkType]]
−
| Gets/sets the stroke width of the watermark's text.
+
 
|-
 
|-
−
| [[PXV:IPXC_WatermarkParams_Text|Text]]
+
| [[PXV:IPXC_WatermarkParams_HAlign|HAlign]]
−
| style="text-align: center" | R/W
+
|  
−
| Gets/sets the watermark's text.
+
|  
−
|-
+
|  
−
| [[PXV:IPXC_WatermarkParams_TextAlign|TextAlign]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets the watermark's text align.
+
−
|-
+
−
| [[PXV:IPXC_WatermarkParams_UnderlineMode|UnderlineMode]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets the watermark's text underline mode.
+
−
|-
+
−
| [[PXV:IPXC_WatermarkParams_VAlign|VAlign]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets the vertical align of the watermark on page.
+
−
|-
+
−
| [[PXV:IPXC_WatermarkParams_VOffset|VOffset]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets the vertical offset of the watermark on page.
+
−
|-
+
−
| [[PXV:IPXC_WatermarkParams_WatermarkType|WatermarkType]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets the [[PXV:PXC_WatermarkType|type]] of the watermark.
+
 
|}
 
|}
 +
 +
== See Also ==
 +
[[PXV:IPXC_Document_PlaceWatermark|IPXC_Document::PlaceWatermark]], [[PXV:IPXC_Inst_CreateWatermarkParams|IPXC_Inst::CreateWatermarkParams]]

Latest revision as of 11:44, 24 September 2017

PDF Core Layer > Interfaces > IPXC_WatermarkParams Interface

Used for filling the parameters of the Watermarks that will be placed using the PlaceWatermark method.

Properties

End HOffset RenderMode Text
FillColor ImageFile Rotation TextAlign
Flags ImagePage Scale UnderlineMode
Font ImageSize Start VAlign
FontName Opacity StrokeColor VOffset
FontSize RangeFlags StrokeWidth WatermarkType
HAlign

See Also

IPXC_Document::PlaceWatermark, IPXC_Inst::CreateWatermarkParams

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXC_WatermarkParams&oldid=50908"