IPXC_AnnotHandler::RotateAnnot Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_AnnotHandler::RotateAnnot Method}} | {{#customTitle:IPXC_AnnotHandler::RotateAnnot Method}} | ||
{{#parentPage:PXV:IPXC_AnnotHandler#Methods|RotateAnnot|method}} | {{#parentPage:PXV:IPXC_AnnotHandler#Methods|RotateAnnot|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Rotates the given [[PXV:IPXC_Annotaiton|annotation]] by the given angle. | |
== Syntax == | == Syntax == | ||
| Line 16: | Line 15: | ||
== Parameters == | == Parameters == | ||
;pAnnot | ;pAnnot | ||
| − | :[in] Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]]. | + | :[in] Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the annotation that will be rotated. |
;nAngle | ;nAngle | ||
| − | :[in] Value of float. | + | :[in] Value of float containing the rotation angle (for example 45.0f equals 45 degrees). |
;bAbsolute | ;bAbsolute | ||
| − | :[in] Value of VARIANT_BOOL. | + | :[in] Value of VARIANT_BOOL that defines whether the rotation angle should be added to the current rotation. If ''true'' then the angle won't be added. |
;stRotationPoint | ;stRotationPoint | ||
| − | :[in] Pointer to [[PXV:PXC_Point|PXC_Point]]. | + | :[in] Pointer to [[PXV:PXC_Point|PXC_Point]] containing the point of annotation's rotation. For example, to take the center point as a rotation point then the half of the annotation's width should be added to the annotation's left Rect side and the half of the annotation's height should be added to the annotation's bottom Rect side. |
== Return Value == | == Return Value == | ||
Revision as of 01:31, 4 December 2018
Rotates the given annotation by the given angle.
Syntax
HRESULT RotateAnnot([in] IPXC_Annotation* pAnnot,
[in] float nAngle,
[in] VARIANT_BOOL bAbsolute,
[in] PXC_Point* stRotationPoint);
Parameters
- pAnnot
- [in] Pointer to IPXC_Annotation containing the annotation that will be rotated.
- nAngle
- [in] Value of float containing the rotation angle (for example 45.0f equals 45 degrees).
- bAbsolute
- [in] Value of VARIANT_BOOL that defines whether the rotation angle should be added to the current rotation. If true then the angle won't be added.
- stRotationPoint
- [in] Pointer to PXC_Point containing the point of annotation's rotation. For example, to take the center point as a rotation point then the half of the annotation's width should be added to the annotation's left Rect side and the half of the annotation's height should be added to the annotation's bottom Rect side.
Return Value
Returns S_OK if operation was successful or error code in other cases.
