IIXC_Inst::Page_CreateEmpty Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method creates new [[PXV:IIXC_Page|page]] with specified attributes (width, height, and format).
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;Width
 
;Width
:[in]  Value of ULONG.
+
:[in]  Specifies the width of the new page.
 
;Height
 
;Height
:[in]  Value of ULONG.
+
:[in]  Specifies the height of the new page.
 
;Format
 
;Format
:[in]  Value of [[PXV:IXC_PageFormat|IXC_PageFormat]].
+
:[in]  Specifies internal [[PXV:IXC_PageFormat|format]] in which data will be stored into new page.
 
;defColor
 
;defColor
:[in]  Value of ULONG.
+
:[in]  Specifies color which will be used for filling entire page during creation.
 
;ppPage
 
;ppPage
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of created page will be stored.
  
 
== Return Value ==
 
== Return Value ==
Line 30: Line 30:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Inst|IIXC_Inst]].
+
:[[PXV:IIXC_Inst|IIXC_Inst]]
 +
:[[PXV:IIXC_Page|IIXC_Page]]
 +
:[[PXV:IIXC_Page_ConvertToFormat|IIXC_Page::ConvertToFormat]]
 +
:[[PXV:IIXC_Page_Format|IIXC_Page::Format]]
 +
:[[PXV:IXC_PageFormat|IXC_PageFormat]]

Revision as of 01:27, 29 April 2015


The method creates new page with specified attributes (width, height, and format).

Syntax

HRESULT Page_CreateEmpty([in]           ULONG           Width,
                         [in]           ULONG           Height,
                         [in]           IXC_PageFormat  Format,
                         [in]           ULONG           defColor,
                         [out, retval]  IIXC_Page**     ppPage);

Parameters

Width
[in] Specifies the width of the new page.
Height
[in] Specifies the height of the new page.
Format
[in] Specifies internal format in which data will be stored into new page.
defColor
[in] Specifies color which will be used for filling entire page during creation.
ppPage
[out, retval] Pointer to IIXC_Page of created page will be stored.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IIXC_Inst
IIXC_Page
IIXC_Page::ConvertToFormat
IIXC_Page::Format
IXC_PageFormat