IIXC_Inst::Page_CreateEmpty Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Inst::Page_CreateEmpty Method}}
 
{{#customTitle:IIXC_Inst::Page_CreateEmpty Method}}
{{#parentPage:PXV:IIXC_Inst|Page_CreateEmpty Method|method}}
+
{{#parentPage:PXV:IIXC_Inst#Methods|Page_CreateEmpty|method}}
 
+
  
 
The method creates new [[PXV:IIXC_Page|page]] with specified attributes (width, height, and format).
 
The method creates new [[PXV:IIXC_Page|page]] with specified attributes (width, height, and format).
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Page_CreateEmpty([in]          ULONG          Width,
+
<pre class="brush:cpp;gutter:false">HRESULT Page_CreateEmpty([in]          ULONG          nWidth,
                         [in]          ULONG          Height,
+
                         [in]          ULONG          nHeight,
                         [in]          IXC_PageFormat  Format,
+
                         [in]          IXC_PageFormat  nFormat,
                         [in]          ULONG          defColor,
+
                         [in]          ULONG          nDefColor,
                         [out, retval]  IIXC_Page**    ppPage);</pre>
+
                         [out, retval]  IIXC_Page**    pPage);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Width
+
;nWidth
 
:[in]  Specifies the width of the new page.
 
:[in]  Specifies the width of the new page.
;Height
+
;nHeight
 
:[in]  Specifies the height of the new page.
 
:[in]  Specifies the height of the new page.
;Format
+
;nFormat
 
:[in]  Specifies internal [[PXV:IXC_PageFormat|format]] in which data will be stored into new page.
 
:[in]  Specifies internal [[PXV:IXC_PageFormat|format]] in which data will be stored into new page.
;defColor
+
;nDefColor
 
:[in]  Specifies color which will be used for filling entire page during creation.
 
:[in]  Specifies color which will be used for filling entire page during creation.
;ppPage
+
;pPage
 
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of created page will be stored.
 
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of created page will be stored.
  
Line 29: Line 29:
  
 
== 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]]
+

Latest revision as of 03:16, 15 June 2015

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

Syntax

HRESULT Page_CreateEmpty([in]           ULONG           nWidth,
                         [in]           ULONG           nHeight,
                         [in]           IXC_PageFormat  nFormat,
                         [in]           ULONG           nDefColor,
                         [out, retval]  IIXC_Page**     pPage);

Parameters

nWidth
[in] Specifies the width of the new page.
nHeight
[in] Specifies the height of the new page.
nFormat
[in] Specifies internal format in which data will be stored into new page.
nDefColor
[in] Specifies color which will be used for filling entire page during creation.
pPage
[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