TCustomShellTreeView.GetBuiltinIconSize

Gets the size for a shell icon used in the control.

Declaration

Source position: shellctrls.pas line 116

Function result

TSize instance with the dimensions for the shell icon.

Description

GetBuiltinIconSize is an overridden TSize function used to get the dimensions for a shell icon displayed for a file system entry in the control. GetBuiltinIconSize re-implements the method from the TCustomTreeView ancestor, and does not call the inherited method.

The return value is a TSize instance with the Width (CX) and Height (CY) for the shell icon.

When UseBuiltinIcons is True, the internal member used for the icon size is checked. It is used when explicit values have been set for the Width and Height in the TSize instance. If the default values (0) are in Width and Height, the internal GetShellIcon routine is called to get the icon size used for Drive letter designations. It is assigned as the return value for the method, and stored in the internal member.

When UseBuiltinIcons is False, the return value always contains a TSize instance with both the Width (CX) and Height (CY) set to 0 (zero). The size may also be empty (0, 0) if an icon was not found or returned for the file system entry by the widgetset class instance. This can occur when the entry represented by ANode has been removed from the file system.

See also