IUIX_Inst::CreatePropSheets Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreatePropSheets Method}}
 
{{#customTitle:IUIX_Inst::CreatePropSheets Method}}
 +
{{#parentPage:PXV:IUIX_Inst#Methods|CreatePropSheets|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Creates new ''property sheets'' object of [[PXV:IUIX_PropSheets|IUIX_PropSheets]] interface.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreatePropSheets([in] IUIX_Obj* pParent, [in] BSTR pID, [in] BSTR pTitle, [in] LONG nPageNavWidth, [in] SIZE* pPageAreaSize, [in, optional] IUnknown* pSrc, [in, optional] IUnknown* pCtx, [in, optional] LONGLONG nStyle, [in, optional] BSTR pContextHelpID, [out, retval] IUIX_PropSheets** ppPropSheets);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreatePropSheets([in]                               IUIX_Obj*         pParent,
 +
                        [in]                               BSTR               pID,
 +
                        [in]                               BSTR               pTitle,
 +
                        [in]                               LONG               nPageNavWidth,
 +
                        [in]                               SIZE*             pPageAreaSize,
 +
                        [in, defaultvalue(NULL)]           IUnknown*         pSrc,
 +
                        [in, defaultvalue(NULL)]           IUnknown*         pCtx,
 +
                        [in, defaultvalue(0)]             LONGLONG           nStyle,
 +
                        [out, retval, defaultvalue(NULL)] IUIX_PropSheets** pPropSheets);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pParent''
+
;pParent
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in]  parent object of [[PXV:IUIX_Obj|IUIX_Obj]] interface.
;''pID''
+
;pID
:[in]  Value of BSTR.
+
:[in]  string ID of created object.
;''pTitle''
+
;pTitle
:[in]  Value of BSTR.
+
:[in]  window title.
;''nPageNavWidth''
+
;nPageNavWidth
:[in]  Value of LONG.
+
:[in]  width of ''navigation page'' in the window.
;''pPageAreaSize''
+
;pPageAreaSize
:[in]  Pointer to SIZE.
+
:[in]  size of area where pages (objects of [[PXV:IUIX_PropSheetPage|IUIX_PropSheetPage]] interface) will be displayed.
;''pSrc''
+
;pSrc
 
:[in, optional]  Pointer to IUnknown*.
 
:[in, optional]  Pointer to IUnknown*.
;''pCtx''
+
;pCtx
 
:[in, optional]  Pointer to IUnknown*.
 
:[in, optional]  Pointer to IUnknown*.
;''nStyle''
+
;nStyle
:[in, optionalValue of LONGLONG.
+
:[in, defaultvalue(0)specifies ''property sheets'' style with flags from [[PXV:UIX_PropSheetsStyleFlags|UIX_PropSheetsStyleFlags]] enumeration.
;''pContextHelpID''
+
;pPropSheets
:[in, optional] Value of BSTR.
+
:[out, retval, defaultvalue(NULL)return object of [[PXV:IUIX_PropSheets|IUIX_PropSheets]] interface.
;''ppPropSheets''
+
:[out, retval]  Pointer to [[PXV:IUIX_PropSheets|IUIX_PropSheets]].
+
  
 
== Return Value ==
 
== Return Value ==
Line 33: Line 43:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 04:24, 15 June 2015


Creates new property sheets object of IUIX_PropSheets interface.

Syntax

HRESULT CreatePropSheets([in]                               IUIX_Obj*          pParent,
                         [in]                               BSTR               pID,
                         [in]                               BSTR               pTitle,
                         [in]                               LONG               nPageNavWidth,
                         [in]                               SIZE*              pPageAreaSize,
                         [in, defaultvalue(NULL)]           IUnknown*          pSrc,
                         [in, defaultvalue(NULL)]           IUnknown*          pCtx,
                         [in, defaultvalue(0)]              LONGLONG           nStyle,
                         [out, retval, defaultvalue(NULL)]  IUIX_PropSheets**  pPropSheets);

Parameters

pParent
[in] parent object of IUIX_Obj interface.
pID
[in] string ID of created object.
pTitle
[in] window title.
nPageNavWidth
[in] width of navigation page in the window.
pPageAreaSize
[in] size of area where pages (objects of IUIX_PropSheetPage interface) will be displayed.
pSrc
[in, optional] Pointer to IUnknown*.
pCtx
[in, optional] Pointer to IUnknown*.
nStyle
[in, defaultvalue(0)] specifies property sheets style with flags from UIX_PropSheetsStyleFlags enumeration.
pPropSheets
[out, retval, defaultvalue(NULL)] return object of IUIX_PropSheets interface.

Return Value

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

See Also

IUIX_Inst