LImageViewerCell::GetRulerAttributes

Summary

Gets the current attributes of the cell rulers.

Syntax

L_INT LImageViewerCell::GetRulerAttributes(pAttributes);

Parameters

LPRULERATTRIBS pAttributes

Pointer to a RULERATTRIBS structure to be updated with the current cell ruler attributes.

Returns

Comments

Before calling LImageViewerCell::GetRulerAttributes apply the following:

• Declare a variable of type RULERATTRIBS.
• Set RULERATTRIBS.uStructSize to sizeof(RULERATTRIBS).
• Set RULERATTRIBS.uMask to indicate the properties to be updated with the current values.
• Pass a pointer to the RULERATTRIBS structure to LImageViewerCell::GetRulerAttributes as the pAttributes parameter.

To set new cell properties, call LImageViewerCell::GetRulerAttributes.

For more information on the available attributes that can be used to control the shape of the ruler, 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.

See Also

Functions

• LImageViewerCell::SetRulerAttributes
• LImageViewer::Create
• LImageViewer::RemoveCell
• LImageViewer::InsertCell
• LImageViewer::GetCellCount
• LImageViewer::GetWindowHandle
• LImageViewerCell::SetCellBitmapList
• LImageViewerCell::SetCellTag
• LImageViewerCell::SetCellProperties
• LImageViewer::GetCellPosition
• LImageViewer::RepositionCell
• LImageViewerCell::GetCellBitmapList
• LImageViewer::GetCellBounds
• LImageViewerCell::FreezeCell
• LImageViewer::SetBounds
• LImageViewerCell::SelectCell
• LImageViewerCell::IsCellSelected
• LImageViewerCell::IsCellFrozen
• Class Members

Topics

• Image Viewer Cells
• Window Control/Image Viewer Functions: Annotations

Example

This example changes the ruler by showing the measurement unit next to it.

L_INT LImageViewerCell_GetRulerAttributesExample(LImageViewerCell& ImageViewerCell) 
{ 
   RULERATTRIBS RulerAttributes = {0}; 
   RulerAttributes.uFlags = RULERATTRIBS_ALL; 
   RulerAttributes.uStructSize = sizeof(RULERATTRIBS); 
   ImageViewerCell.GetRulerAttributes(&RulerAttributes); 
 
   RulerAttributes.bShowMeasurement = TRUE; 
 
   ImageViewerCell.SetRulerAttributes(&RulerAttributes); 
 
   return SUCCESS; 
}