WordRpt_WrapText
- Updated2023-02-21
- 1 minute(s) read
HRESULT WordRpt_WrapText (CAObjHandle imageHandle, int type, int side);
Purpose
Allows text to be wrapped around the specified image and sets the wrap type and side.
Parameters
| Input | ||||||||||||
| Name | Type | Description | ||||||||||
| imageHandle | CAObjHandle | A handle to the Word Shape object. When it is no longer needed, this handle must be discarded using CA_DiscardObjHandle. |
||||||||||
| type | int | Sets the wrap type of the text around the image. Can be one of the following constants:
|
||||||||||
| side | int | Sets a value that indicates whether the document text should wrap on both sides of the specified image, on either the left or right side only, or on the side that's farthest from the page margin. If the text wraps on only one side of the image, there is a text-free area between the other side of the image and the page margin. Can be one of the following constants:
|
||||||||||
Return Value
| Name | Type | Description |
| status | HRESULT | A value indicating whether an error occurred. Function failure is indicated by a negative error code. Error codes are defined in CVIversion\include\cviauto.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. You can use CA_GetAutomationErrorString to get the description of an error code. |
Additional Information
Library: Word Report
Include file: activex\word\WordReport.h
LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later