ObjectDCL Banner

ListView_CalcColWidth Method

Description

This method calculates the minimum required width of a column to ensure the entire text will appear.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.
sColText
String specifying the widest text that may appear in a column.

Return Values

Returns the following according to the situation:

  • Integer specifying the width.
  • Nil if the control is not found or does not support this function.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ListView_CalcColWidth 
		MyControlReference [as Reference]
		sColText [as String])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_ListView_CalcColWidth
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		sColText [as String])

Applies For

ListView.

Example

CopyCode imageCopy Code
; Calculate the width to assign to a column
(setq rValue (Odcl_ListView_CalcColWidth MyProject_MyForm_MyControl "Phone Number"))

See Also

ListView_AddColumns, ListView_DeleteColumn, ListView_DeleteColumns, ListView_GetColumnCount, ListView_GetColumnImage, ListView_GetColumnItems, ListView_GetColWidth, ListView_SetColumnImage, ListView_SetColWidth, ListView_SortNumericItems, ListView_SortTextItems