IPXC_Page::InsertNewAnnotFromDict Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Page::InsertNewAnnotFromDict Method}} | {{#customTitle:IPXC_Page::InsertNewAnnotFromDict Method}} | ||
| + | {{#parentPage:PXV:IPXC_Page#Methods|InsertNewAnnotFromDict|method}} | ||
| + | {{ToReview}} | ||
| − | + | Inserts new annotation with given variant dictionary into the given position with given Z-order. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertNewAnnotFromDict([in] IPXS_PDFVariant* pAnnotDict, [in, defaultvalue(NULL)] PXC_Rect* | + | <pre class="brush:cpp;gutter:false">HRESULT InsertNewAnnotFromDict([in] IPXS_PDFVariant* pAnnotDict, |
| + | [in, defaultvalue(NULL)] PXC_Rect* stLocation, | ||
| + | [in, defaultvalue(-1)] ULONG nPos, | ||
| + | [out, retval, defaultvalue(NULL)] IPXC_Annotation** pAnnot);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pAnnotDict |
| − | :[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | + | :[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the source variant dictionary for the annotation insertion. |
| − | ; | + | ;stLocation |
| − | :[in, defaultvalue(NULL)] Pointer to [[PXV:PXC_Rect|PXC_Rect]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the coordinates of the inserted annotation. |
| − | ; | + | ;nPos |
| − | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page. |
| − | ; | + | ;pAnnot |
| − | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]]. | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the resulting annotation. |
== Return Value == | == Return Value == | ||
| Line 21: | Line 27: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_Page|IPXC_Page]] | |
Latest revision as of 03:32, 15 June 2015
Inserts new annotation with given variant dictionary into the given position with given Z-order.
Syntax
HRESULT InsertNewAnnotFromDict([in] IPXS_PDFVariant* pAnnotDict,
[in, defaultvalue(NULL)] PXC_Rect* stLocation,
[in, defaultvalue(-1)] ULONG nPos,
[out, retval, defaultvalue(NULL)] IPXC_Annotation** pAnnot);
Parameters
- pAnnotDict
- [in] Pointer to IPXS_PDFVariant containing the source variant dictionary for the annotation insertion.
- stLocation
- [in, defaultvalue(NULL)] Pointer to PXC_Rect containing the coordinates of the inserted annotation.
- nPos
- [in, defaultvalue(-1)] Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page.
- pAnnot
- [out, retval, defaultvalue(NULL)] Pointer to IPXC_Annotation containing the resulting annotation.
Return Value
Returns S_OK if operation was successful or error code in other cases.
