SftTree/NET 2.0 - Tree Control for Windows Forms

GetOptimalWidth Method, ColumnClass Class

Calculates the column's optimal width so that the cell contents in this column can be displayed without being clipped horizontally.

Class: ColumnClass
Namespace: Softelvdm.SftTreeNET
Assembly: Softelvdm.SftTreeNET

Syntax

public int GetOptimalWidth(
    int MaxScan,
    bool VisibleOnly,
    bool Headers,
    bool Items,
    bool Footers );

Public Function GetOptimalWidth(
    ByVal MaxScan As Integer,
    ByVal VisibleOnly As Boolean,
    ByVal Headers As Boolean,
    ByVal Items As Boolean,
    ByVal Footers As Boolean
  ) As Integer

Parameters

MaxScan

Defines the maximum number of items to scan to determine the optimal column width or 0 to scan all items.

VisibleOnly

Defines whether only visible items should be considered to determine the optimal column width. Visible items are items whose parent items are expanded.

Headers

Defines whether the column headers should be considered to determine the optimal column width. The default is True.

Items

Defines whether the items should be considered to determine the optimal column width. The default is True.

Footers

Defines whether the column footers should be considered to determine the optimal column width. The default is True.

Return Value

Returns the column's optimal width so that the cell contents in this column can be displayed without being clipped horizontally.

Comments

Calculates the column's optimal width so that the cell contents in this column can be displayed without being clipped horizontally.

This method calculates the optimal column width so that the column header, column footer and each cell in the item area can be completely displayed without being truncated or clipped. The ColumnClass.MakeOptimal method can be used to resize a column to its optimal width. The column width can be changed using the ColumnClass.Width property.

The ColumnsClass.MakeOptimal method can be used to set the optimal column width of all columns.

By changing tree control properties, the optimal column width may change. Adding items, setting new cell contents are a few of the actions that can affect the optimal column width. The column width may have to be set again to allow cells to be completely visible.

The tree control does not automatically adjust column widths.

Cells which merge into an adjacent column are not considered when calculating the optimal column width.

The last (or only) column may be an open-ended column. If the ColumnsClass.LastOpenended property is set to True, the last displayed column will always use the space remaining between the previous column and the right edge of the tree control window.

Calculating the optimal column width can be a time consuming operation, particularly if many items have been added to the tree control. The MaxScan parameter can be used to limit the maximum number of items to consider for optimal column width calculation. ColumnClass.MakeOptimal scans all items to determine the best column width, but can be limited to a specific number of items using the MaxScan parameter. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.

If items are not visible because their parent items are collapsed, these can be excluded from the optimal width calculation by setting the VisibleOnly parameter to True.

Individual cells can be excluded from the optimal width calculation by setting their CellClass.WidthIgnore property.

See Also ColumnClass Class | Classes | SftTree/NET 2.0