IPXC_Article::InsertBead Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Article::InsertBead Method}} | {{#customTitle:IPXC_Article::InsertBead Method}} | ||
| − | {{#parentPage:PXV:IPXC_Article|method | + | {{#parentPage:PXV:IPXC_Article#Methods|InsertBead|method}} |
| − | + | ||
| − | + | ||
| − | + | Inserts new bead into the article at the given page into the given position in the article's beads array. Note that the first bead will be inserted as an '''F''' value of the article's [[PXV:IPXS_PDFVariant|PDF object]]. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertBead([in] ULONG nPos, [in] ULONG nPageInx, [in] PXC_Rect* | + | <pre class="brush:cpp;gutter:false">HRESULT InsertBead([in] ULONG nPos, |
| + | [in] ULONG nPageInx, | ||
| + | [in] PXC_Rect* stRect);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nPos |
| − | :[in] | + | :[in] Position of the newly inserted bead in the article's beads array. |
| − | ; | + | ;nPageInx |
| − | :[in] | + | :[in] Index of the page where the bead would be inserted. |
| − | ; | + | ;stRect |
| − | :[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]]. | + | :[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the bound rectangle of the bead. |
== Return Value == | == Return Value == | ||
| Line 22: | Line 23: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_Article|IPXC_Article]] | |
Latest revision as of 02:20, 15 June 2015
Inserts new bead into the article at the given page into the given position in the article's beads array. Note that the first bead will be inserted as an F value of the article's PDF object.
Syntax
HRESULT InsertBead([in] ULONG nPos,
[in] ULONG nPageInx,
[in] PXC_Rect* stRect);
Parameters
- nPos
- [in] Position of the newly inserted bead in the article's beads array.
- nPageInx
- [in] Index of the page where the bead would be inserted.
- stRect
- [in] Pointer to PXC_Rect containing the bound rectangle of the bead.
Return Value
Returns S_OK if operation was successful or error code in other cases.
