Skip to content

TaskDialogIcon Enumeration

See Also

MainIcon Property | MainIconHandle Property | FooterIcon Property | FooterIconHandle Property

See Also

Description

Task Dialog Icons.

Members

  • xtpTaskIconNone

No icon is displayed in the task dialog.

  • xtpTaskIconWarning

An exclamation-point icon appears in the task dialog.

  • xtpTaskIconError

A stop-sign icon appears in the task dialog.

  • xtpTaskIconInformation

An icon consisting of a lowercase letter "i" in a circle appears in the task dialog.

  • xtpTaskIconShield

A shield icon appears in the task dialog.

  • xtpTaskIconQuestion

A question mark icon appears in the task dialog.

  • xtpTaskIconCustom

Display a custom icon stored in the MainIconHandle or FooterIconHandle properties.

The illustration below shows the task dialog using a custom Codejock icon:

Member Description
xtpTaskIconNone No icon is displayed in the task dialog.
xtpTaskIconWarning An exclamation-point icon appears in the task dialog.
xtpTaskIconError A stop-sign icon appears in the task dialog.
xtpTaskIconInformation An icon consisting of a lowercase letter "i" in a circle appears in the task dialog.
xtpTaskIconShield A shield icon appears in the task dialog.
xtpTaskIconQuestion A question mark icon appears in the task dialog.
xtpTaskIconCustom Display a custom icon stored in the MainIconHandle or FooterIconHandle properties.

Remarks

The FooterIcon and MainIcon both use flags from TaskDialogIcon to specify which icons are displayed in the main instruction area and footer area.

The following holds true for both FooterIcon and MainIcon:

To display the icon stored in MainIconHandle, MainIcon must be set to xtpTaskIconCustom and MainIconHandle must contain a valid handle to an icon that is to be displayed in the task dialog Main Instruction area. If MainIconHandle is NULL and MainIcon is set to xtpTaskIconCustom, no icon will be displayed.

MainIcon is set automatically to xtpTaskIconCustom when assigning a value to MainIconHandle.

To use a pre-defined icon, set MainIcon to any value in the TaskDialogIcon enumeration to display that icon next to the Main Instruction area of the task dialog.

See Also

MainIcon Property | MainIconHandle Property | FooterIcon Property | FooterIconHandle Property

Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.