WordRpt_SetReportLineSpacing
- Updated2023-02-21
- 1 minute(s) read
HRESULT WordRpt_SetReportLineSpacing (CAObjHandle documentHandle, WREnum_LineSpacing spaceBetweenLines);
Purpose
Sets the line spacing of the report as either single-spaced, double-spaced or 1.5 line-spaced. The exact spacing is determined by the font size of the largest characters in each paragraph.
 |
Note To set line spacing for only part of a document, use the LineSpacing attribute in the WordRpt_SetTextAttribute function. |
Parameters
| Input | ||||||||
| Name | Type | Description | ||||||
| documentHandle | CAObjHandle | A handle to the Word Document object. When it is no longer needed, this handle must be discarded using CA_DiscardObjHandle. |
||||||
| spaceBetweenLines | WREnum_LineSpacing | The space between lines of the document. 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