In This Topic ▼

L_DispContainerSetRulerAttributes

Summary

Gets the current attributes of the cell rulers.

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetRulerAttributes(hCellWnd, pAttributes);

Parameters

L_HWND hCellWnd

A handle to the window that represent the cell which the function effect will be implemented on.

LPRULERATTRIBS pAttributes

Pointer to the RULERATTRIBS structure that contains the cell properties to set.

Returns

Value	Meaning
SUCCESS	The function was successful.
1	An error occurred. Refer to Return Codes.

Comments

Before calling L_DispContainerSetRulerAttributes apply the following:

Declare a variable of type RULERATTRIBS.
Set RULERATTRIBS.uStructSize to sizeof(RULERATTRIBS).
Specify the new property values in the appropriate members.
Pass a pointer to the RULERATTRIBS structure to L_DispContainerSetRulerAttributes as the pAttributes parameter.

To get the current properties set for a cell, call L_DispContainerGetRulerAttributes.

For more information on the actual properties that can be set, refer to the RULERATTRIBS structure.

Required DLLs and Libraries

LTIVW
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Example

This function changes the look of the cell ruler.

L_INT L_DispContainerSetRulerAttributeExample(HWND hCellWnd) 
{ 
   RULERATTRIBS RulerAttributes = {0}; 
   RulerAttributes.uFlags = RULERATTRIBS_ALL; 
   RulerAttributes.uStructSize = sizeof(RULERATTRIBS); 
   L_INT nRet = L_DispContainerGetRulerAttributes(hCellWnd, &RulerAttributes); 
 
   RulerAttributes.bShowMeasurement = TRUE; 
 
   nRet = L_DispContainerSetRulerAttributes(hCellWnd, &RulerAttributes); 
 
   return nRet; 
}